Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/port_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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