mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/port_api.h@181:57724642e740, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:09:33 2018 +0000
Revision:
181:57724642e740
Parent:
149:156823d33999
Child:
189:f392fc9709a3
mbed-dev library. Release version 159.

Who changed what in which revision?

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