mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/port_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
149:156823d33999 
mbed library release version 165

Who changed what in which revision?

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