Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/hal/port_api.h@11:b3f2a8bdac4d, 2017-12-16 (annotated)

Committer:
Zaitsev
Date:
Sat Dec 16 10:26:48 2017 +0000
Revision:
11:b3f2a8bdac4d
Parent:
10:41552d038a69 
A copy for D.S;

Who changed what in which revision?

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