BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/port_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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