mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/port_api.h@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
128:9bcdf88f62b0
Child:
172:65be27845400
Release 147 of the mbed library.

Who changed what in which revision?

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