4545
Fork of mbed-dev by
hal/port_api.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)
- Committer:
- <>
- Date:
- Fri Sep 02 15:07:44 2016 +0100
- Revision:
- 144:ef7eb2e8f9f7
- Parent:
- 0:9b334a45a8ff
- Child:
- 149:156823d33999
This updates the lib to the mbed lib v125
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
<> | 144:ef7eb2e8f9f7 | 1 | /* mbed Microcontroller Library |
<> | 144:ef7eb2e8f9f7 | 2 | * Copyright (c) 2006-2013 ARM Limited |
<> | 144:ef7eb2e8f9f7 | 3 | * |
<> | 144:ef7eb2e8f9f7 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
<> | 144:ef7eb2e8f9f7 | 5 | * you may not use this file except in compliance with the License. |
<> | 144:ef7eb2e8f9f7 | 6 | * You may obtain a copy of the License at |
<> | 144:ef7eb2e8f9f7 | 7 | * |
<> | 144:ef7eb2e8f9f7 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
<> | 144:ef7eb2e8f9f7 | 9 | * |
<> | 144:ef7eb2e8f9f7 | 10 | * Unless required by applicable law or agreed to in writing, software |
<> | 144:ef7eb2e8f9f7 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
<> | 144:ef7eb2e8f9f7 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
<> | 144:ef7eb2e8f9f7 | 13 | * See the License for the specific language governing permissions and |
<> | 144:ef7eb2e8f9f7 | 14 | * limitations under the License. |
<> | 144:ef7eb2e8f9f7 | 15 | */ |
<> | 144:ef7eb2e8f9f7 | 16 | #ifndef MBED_PORTMAP_H |
<> | 144:ef7eb2e8f9f7 | 17 | #define MBED_PORTMAP_H |
<> | 144:ef7eb2e8f9f7 | 18 | |
<> | 144:ef7eb2e8f9f7 | 19 | #include "device.h" |
<> | 144:ef7eb2e8f9f7 | 20 | |
<> | 144:ef7eb2e8f9f7 | 21 | #if DEVICE_PORTIN || DEVICE_PORTOUT |
<> | 144:ef7eb2e8f9f7 | 22 | |
<> | 144:ef7eb2e8f9f7 | 23 | #ifdef __cplusplus |
<> | 144:ef7eb2e8f9f7 | 24 | extern "C" { |
<> | 144:ef7eb2e8f9f7 | 25 | #endif |
<> | 144:ef7eb2e8f9f7 | 26 | |
<> | 144:ef7eb2e8f9f7 | 27 | /** Port HAL structure. port_s is declared in the target's HAL |
<> | 144:ef7eb2e8f9f7 | 28 | */ |
<> | 144:ef7eb2e8f9f7 | 29 | typedef struct port_s port_t; |
<> | 144:ef7eb2e8f9f7 | 30 | |
<> | 144:ef7eb2e8f9f7 | 31 | /** |
<> | 144:ef7eb2e8f9f7 | 32 | * \defgroup hal_port Port HAL functions |
<> | 144:ef7eb2e8f9f7 | 33 | * @{ |
<> | 144:ef7eb2e8f9f7 | 34 | */ |
<> | 144:ef7eb2e8f9f7 | 35 | |
<> | 144:ef7eb2e8f9f7 | 36 | /** Get the pin name from the port's pin number |
<> | 144:ef7eb2e8f9f7 | 37 | * |
<> | 144:ef7eb2e8f9f7 | 38 | * @param port The port name |
<> | 144:ef7eb2e8f9f7 | 39 | * @param pin_n The pin number within the specified port |
<> | 144:ef7eb2e8f9f7 | 40 | * @return The pin name for the port's pin number |
<> | 144:ef7eb2e8f9f7 | 41 | */ |
<> | 144:ef7eb2e8f9f7 | 42 | PinName port_pin(PortName port, int pin_n); |
<> | 144:ef7eb2e8f9f7 | 43 | |
<> | 144:ef7eb2e8f9f7 | 44 | /** Initilize the port |
<> | 144:ef7eb2e8f9f7 | 45 | * |
<> | 144:ef7eb2e8f9f7 | 46 | * @param obj The port object to initialize |
<> | 144:ef7eb2e8f9f7 | 47 | * @param port The port name |
<> | 144:ef7eb2e8f9f7 | 48 | * @param mask The bitmask to identify which bits in the port should be included (0 - ignore) |
<> | 144:ef7eb2e8f9f7 | 49 | * @param dir The port direction |
<> | 144:ef7eb2e8f9f7 | 50 | */ |
<> | 144:ef7eb2e8f9f7 | 51 | void port_init(port_t *obj, PortName port, int mask, PinDirection dir); |
<> | 144:ef7eb2e8f9f7 | 52 | |
<> | 144:ef7eb2e8f9f7 | 53 | /** Set the input port mode |
<> | 144:ef7eb2e8f9f7 | 54 | * |
<> | 144:ef7eb2e8f9f7 | 55 | * @param obj The port object |
<> | 144:ef7eb2e8f9f7 | 56 | * @param mode THe port mode to be set |
<> | 144:ef7eb2e8f9f7 | 57 | */ |
<> | 144:ef7eb2e8f9f7 | 58 | void port_mode(port_t *obj, PinMode mode); |
<> | 144:ef7eb2e8f9f7 | 59 | |
<> | 144:ef7eb2e8f9f7 | 60 | /** Set port direction (in/out) |
<> | 144:ef7eb2e8f9f7 | 61 | * |
<> | 144:ef7eb2e8f9f7 | 62 | * @param obj The port object |
<> | 144:ef7eb2e8f9f7 | 63 | * @param dir The port direction to be set |
<> | 144:ef7eb2e8f9f7 | 64 | */ |
<> | 144:ef7eb2e8f9f7 | 65 | void port_dir(port_t *obj, PinDirection dir); |
<> | 144:ef7eb2e8f9f7 | 66 | |
<> | 144:ef7eb2e8f9f7 | 67 | /** Write value to the port |
<> | 144:ef7eb2e8f9f7 | 68 | * |
<> | 144:ef7eb2e8f9f7 | 69 | * @param obj The port object |
<> | 144:ef7eb2e8f9f7 | 70 | * @param value The value to be set |
<> | 144:ef7eb2e8f9f7 | 71 | */ |
<> | 144:ef7eb2e8f9f7 | 72 | void port_write(port_t *obj, int value); |
<> | 144:ef7eb2e8f9f7 | 73 | |
<> | 144:ef7eb2e8f9f7 | 74 | /** Read the current value on the port |
<> | 144:ef7eb2e8f9f7 | 75 | * |
<> | 144:ef7eb2e8f9f7 | 76 | * @param obj The port object |
<> | 144:ef7eb2e8f9f7 | 77 | * @return An integer with each bit corresponding to an associated port pin setting |
<> | 144:ef7eb2e8f9f7 | 78 | */ |
<> | 144:ef7eb2e8f9f7 | 79 | int port_read(port_t *obj); |
<> | 144:ef7eb2e8f9f7 | 80 | |
<> | 144:ef7eb2e8f9f7 | 81 | /**@}*/ |
<> | 144:ef7eb2e8f9f7 | 82 | |
<> | 144:ef7eb2e8f9f7 | 83 | #ifdef __cplusplus |
<> | 144:ef7eb2e8f9f7 | 84 | } |
<> | 144:ef7eb2e8f9f7 | 85 | #endif |
<> | 144:ef7eb2e8f9f7 | 86 | #endif |
<> | 144:ef7eb2e8f9f7 | 87 | |
<> | 144:ef7eb2e8f9f7 | 88 | #endif |