Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/hal/port_api.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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