Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/gpio_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_GPIO_API_H
kevman 0:38ceb79fef03 20 #define MBED_GPIO_API_H
kevman 0:38ceb79fef03 21
kevman 0:38ceb79fef03 22 #include <stdint.h>
kevman 0:38ceb79fef03 23 #include "device.h"
kevman 0:38ceb79fef03 24
kevman 0:38ceb79fef03 25 #ifdef __cplusplus
kevman 0:38ceb79fef03 26 extern "C" {
kevman 0:38ceb79fef03 27 #endif
kevman 0:38ceb79fef03 28
kevman 0:38ceb79fef03 29 /**
kevman 0:38ceb79fef03 30 * \defgroup hal_gpio GPIO HAL functions
kevman 0:38ceb79fef03 31 * @{
kevman 0:38ceb79fef03 32 */
kevman 0:38ceb79fef03 33
kevman 0:38ceb79fef03 34 /** Set the given pin as GPIO
kevman 0:38ceb79fef03 35 *
kevman 0:38ceb79fef03 36 * @param pin The pin to be set as GPIO
kevman 0:38ceb79fef03 37 * @return The GPIO port mask for this pin
kevman 0:38ceb79fef03 38 **/
kevman 0:38ceb79fef03 39 uint32_t gpio_set(PinName pin);
kevman 0:38ceb79fef03 40 /* Checks if gpio object is connected (pin was not initialized with NC)
kevman 0:38ceb79fef03 41 * @param pin The pin to be set as GPIO
kevman 0:38ceb79fef03 42 * @return 0 if port is initialized with NC
kevman 0:38ceb79fef03 43 **/
kevman 0:38ceb79fef03 44 int gpio_is_connected(const gpio_t *obj);
kevman 0:38ceb79fef03 45
kevman 0:38ceb79fef03 46 /** Initialize the GPIO pin
kevman 0:38ceb79fef03 47 *
kevman 0:38ceb79fef03 48 * @param obj The GPIO object to initialize
kevman 0:38ceb79fef03 49 * @param pin The GPIO pin to initialize
kevman 0:38ceb79fef03 50 */
kevman 0:38ceb79fef03 51 void gpio_init(gpio_t *obj, PinName pin);
kevman 0:38ceb79fef03 52
kevman 0:38ceb79fef03 53 /** Set the input pin mode
kevman 0:38ceb79fef03 54 *
kevman 0:38ceb79fef03 55 * @param obj The GPIO object
kevman 0:38ceb79fef03 56 * @param mode The pin mode to be set
kevman 0:38ceb79fef03 57 */
kevman 0:38ceb79fef03 58 void gpio_mode(gpio_t *obj, PinMode mode);
kevman 0:38ceb79fef03 59
kevman 0:38ceb79fef03 60 /** Set the pin direction
kevman 0:38ceb79fef03 61 *
kevman 0:38ceb79fef03 62 * @param obj The GPIO object
kevman 0:38ceb79fef03 63 * @param direction The pin direction to be set
kevman 0:38ceb79fef03 64 */
kevman 0:38ceb79fef03 65 void gpio_dir(gpio_t *obj, PinDirection direction);
kevman 0:38ceb79fef03 66
kevman 0:38ceb79fef03 67 /** Set the output value
kevman 0:38ceb79fef03 68 *
kevman 0:38ceb79fef03 69 * @param obj The GPIO object
kevman 0:38ceb79fef03 70 * @param value The value to be set
kevman 0:38ceb79fef03 71 */
kevman 0:38ceb79fef03 72 void gpio_write(gpio_t *obj, int value);
kevman 0:38ceb79fef03 73
kevman 0:38ceb79fef03 74 /** Read the input value
kevman 0:38ceb79fef03 75 *
kevman 0:38ceb79fef03 76 * @param obj The GPIO object
kevman 0:38ceb79fef03 77 * @return An integer value 1 or 0
kevman 0:38ceb79fef03 78 */
kevman 0:38ceb79fef03 79 int gpio_read(gpio_t *obj);
kevman 0:38ceb79fef03 80
kevman 0:38ceb79fef03 81 // the following functions are generic and implemented in the common gpio.c file
kevman 0:38ceb79fef03 82 // TODO: fix, will be moved to the common gpio header file
kevman 0:38ceb79fef03 83
kevman 0:38ceb79fef03 84 /** Init the input pin and set mode to PullDefault
kevman 0:38ceb79fef03 85 *
kevman 0:38ceb79fef03 86 * @param gpio The GPIO object
kevman 0:38ceb79fef03 87 * @param pin The pin name
kevman 0:38ceb79fef03 88 */
kevman 0:38ceb79fef03 89 void gpio_init_in(gpio_t *gpio, PinName pin);
kevman 0:38ceb79fef03 90
kevman 0:38ceb79fef03 91 /** Init the input pin and set the mode
kevman 0:38ceb79fef03 92 *
kevman 0:38ceb79fef03 93 * @param gpio The GPIO object
kevman 0:38ceb79fef03 94 * @param pin The pin name
kevman 0:38ceb79fef03 95 * @param mode The pin mode to be set
kevman 0:38ceb79fef03 96 */
kevman 0:38ceb79fef03 97 void gpio_init_in_ex(gpio_t *gpio, PinName pin, PinMode mode);
kevman 0:38ceb79fef03 98
kevman 0:38ceb79fef03 99 /** Init the output pin as an output, with predefined output value 0
kevman 0:38ceb79fef03 100 *
kevman 0:38ceb79fef03 101 * @param gpio The GPIO object
kevman 0:38ceb79fef03 102 * @param pin The pin name
kevman 0:38ceb79fef03 103 * @return An integer value 1 or 0
kevman 0:38ceb79fef03 104 */
kevman 0:38ceb79fef03 105 void gpio_init_out(gpio_t *gpio, PinName pin);
kevman 0:38ceb79fef03 106
kevman 0:38ceb79fef03 107 /** Init the pin as an output and set the output value
kevman 0:38ceb79fef03 108 *
kevman 0:38ceb79fef03 109 * @param gpio The GPIO object
kevman 0:38ceb79fef03 110 * @param pin The pin name
kevman 0:38ceb79fef03 111 * @param value The value to be set
kevman 0:38ceb79fef03 112 */
kevman 0:38ceb79fef03 113 void gpio_init_out_ex(gpio_t *gpio, PinName pin, int value);
kevman 0:38ceb79fef03 114
kevman 0:38ceb79fef03 115 /** Init the pin to be in/out
kevman 0:38ceb79fef03 116 *
kevman 0:38ceb79fef03 117 * @param gpio The GPIO object
kevman 0:38ceb79fef03 118 * @param pin The pin name
kevman 0:38ceb79fef03 119 * @param direction The pin direction to be set
kevman 0:38ceb79fef03 120 * @param mode The pin mode to be set
kevman 0:38ceb79fef03 121 * @param value The value to be set for an output pin
kevman 0:38ceb79fef03 122 */
kevman 0:38ceb79fef03 123 void gpio_init_inout(gpio_t *gpio, PinName pin, PinDirection direction, PinMode mode, int value);
kevman 0:38ceb79fef03 124
kevman 0:38ceb79fef03 125 /**@}*/
kevman 0:38ceb79fef03 126
kevman 0:38ceb79fef03 127 #ifdef __cplusplus
kevman 0:38ceb79fef03 128 }
kevman 0:38ceb79fef03 129 #endif
kevman 0:38ceb79fef03 130
kevman 0:38ceb79fef03 131 #endif
kevman 0:38ceb79fef03 132
kevman 0:38ceb79fef03 133 /** @}*/