ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

hal/port_api.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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