Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/port_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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