Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/hal/gpio_api.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ommpy 0:d383e2dee0f7 1
ommpy 0:d383e2dee0f7 2 /** \addtogroup hal */
ommpy 0:d383e2dee0f7 3 /** @{*/
ommpy 0:d383e2dee0f7 4 /* mbed Microcontroller Library
ommpy 0:d383e2dee0f7 5 * Copyright (c) 2006-2013 ARM Limited
ommpy 0:d383e2dee0f7 6 * SPDX-License-Identifier: Apache-2.0
ommpy 0:d383e2dee0f7 7 *
ommpy 0:d383e2dee0f7 8 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 9 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 10 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 11 *
ommpy 0:d383e2dee0f7 12 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 13 *
ommpy 0:d383e2dee0f7 14 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 15 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 17 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 18 * limitations under the License.
ommpy 0:d383e2dee0f7 19 */
ommpy 0:d383e2dee0f7 20 #ifndef MBED_GPIO_API_H
ommpy 0:d383e2dee0f7 21 #define MBED_GPIO_API_H
ommpy 0:d383e2dee0f7 22
ommpy 0:d383e2dee0f7 23 #include <stdint.h>
ommpy 0:d383e2dee0f7 24 #include "device.h"
ommpy 0:d383e2dee0f7 25
ommpy 0:d383e2dee0f7 26 #ifdef __cplusplus
ommpy 0:d383e2dee0f7 27 extern "C" {
ommpy 0:d383e2dee0f7 28 #endif
ommpy 0:d383e2dee0f7 29
ommpy 0:d383e2dee0f7 30 /**
ommpy 0:d383e2dee0f7 31 * \defgroup hal_gpio GPIO HAL functions
ommpy 0:d383e2dee0f7 32 * @{
ommpy 0:d383e2dee0f7 33 */
ommpy 0:d383e2dee0f7 34
ommpy 0:d383e2dee0f7 35 /** Set the given pin as GPIO
ommpy 0:d383e2dee0f7 36 *
ommpy 0:d383e2dee0f7 37 * @param pin The pin to be set as GPIO
ommpy 0:d383e2dee0f7 38 * @return The GPIO port mask for this pin
ommpy 0:d383e2dee0f7 39 **/
ommpy 0:d383e2dee0f7 40 uint32_t gpio_set(PinName pin);
ommpy 0:d383e2dee0f7 41 /* Checks if gpio object is connected (pin was not initialized with NC)
ommpy 0:d383e2dee0f7 42 * @param pin The pin to be set as GPIO
ommpy 0:d383e2dee0f7 43 * @return 0 if port is initialized with NC
ommpy 0:d383e2dee0f7 44 **/
ommpy 0:d383e2dee0f7 45 int gpio_is_connected(const gpio_t *obj);
ommpy 0:d383e2dee0f7 46
ommpy 0:d383e2dee0f7 47 /** Initialize the GPIO pin
ommpy 0:d383e2dee0f7 48 *
ommpy 0:d383e2dee0f7 49 * @param obj The GPIO object to initialize
ommpy 0:d383e2dee0f7 50 * @param pin The GPIO pin to initialize
ommpy 0:d383e2dee0f7 51 */
ommpy 0:d383e2dee0f7 52 void gpio_init(gpio_t *obj, PinName pin);
ommpy 0:d383e2dee0f7 53
ommpy 0:d383e2dee0f7 54 /** Set the input pin mode
ommpy 0:d383e2dee0f7 55 *
ommpy 0:d383e2dee0f7 56 * @param obj The GPIO object
ommpy 0:d383e2dee0f7 57 * @param mode The pin mode to be set
ommpy 0:d383e2dee0f7 58 */
ommpy 0:d383e2dee0f7 59 void gpio_mode(gpio_t *obj, PinMode mode);
ommpy 0:d383e2dee0f7 60
ommpy 0:d383e2dee0f7 61 /** Set the pin direction
ommpy 0:d383e2dee0f7 62 *
ommpy 0:d383e2dee0f7 63 * @param obj The GPIO object
ommpy 0:d383e2dee0f7 64 * @param direction The pin direction to be set
ommpy 0:d383e2dee0f7 65 */
ommpy 0:d383e2dee0f7 66 void gpio_dir(gpio_t *obj, PinDirection direction);
ommpy 0:d383e2dee0f7 67
ommpy 0:d383e2dee0f7 68 /** Set the output value
ommpy 0:d383e2dee0f7 69 *
ommpy 0:d383e2dee0f7 70 * @param obj The GPIO object
ommpy 0:d383e2dee0f7 71 * @param value The value to be set
ommpy 0:d383e2dee0f7 72 */
ommpy 0:d383e2dee0f7 73 void gpio_write(gpio_t *obj, int value);
ommpy 0:d383e2dee0f7 74
ommpy 0:d383e2dee0f7 75 /** Read the input value
ommpy 0:d383e2dee0f7 76 *
ommpy 0:d383e2dee0f7 77 * @param obj The GPIO object
ommpy 0:d383e2dee0f7 78 * @return An integer value 1 or 0
ommpy 0:d383e2dee0f7 79 */
ommpy 0:d383e2dee0f7 80 int gpio_read(gpio_t *obj);
ommpy 0:d383e2dee0f7 81
ommpy 0:d383e2dee0f7 82 // the following functions are generic and implemented in the common gpio.c file
ommpy 0:d383e2dee0f7 83 // TODO: fix, will be moved to the common gpio header file
ommpy 0:d383e2dee0f7 84
ommpy 0:d383e2dee0f7 85 /** Init the input pin and set mode to PullDefault
ommpy 0:d383e2dee0f7 86 *
ommpy 0:d383e2dee0f7 87 * @param gpio The GPIO object
ommpy 0:d383e2dee0f7 88 * @param pin The pin name
ommpy 0:d383e2dee0f7 89 */
ommpy 0:d383e2dee0f7 90 void gpio_init_in(gpio_t *gpio, PinName pin);
ommpy 0:d383e2dee0f7 91
ommpy 0:d383e2dee0f7 92 /** Init the input pin and set the mode
ommpy 0:d383e2dee0f7 93 *
ommpy 0:d383e2dee0f7 94 * @param gpio The GPIO object
ommpy 0:d383e2dee0f7 95 * @param pin The pin name
ommpy 0:d383e2dee0f7 96 * @param mode The pin mode to be set
ommpy 0:d383e2dee0f7 97 */
ommpy 0:d383e2dee0f7 98 void gpio_init_in_ex(gpio_t *gpio, PinName pin, PinMode mode);
ommpy 0:d383e2dee0f7 99
ommpy 0:d383e2dee0f7 100 /** Init the output pin as an output, with predefined output value 0
ommpy 0:d383e2dee0f7 101 *
ommpy 0:d383e2dee0f7 102 * @param gpio The GPIO object
ommpy 0:d383e2dee0f7 103 * @param pin The pin name
ommpy 0:d383e2dee0f7 104 * @return An integer value 1 or 0
ommpy 0:d383e2dee0f7 105 */
ommpy 0:d383e2dee0f7 106 void gpio_init_out(gpio_t *gpio, PinName pin);
ommpy 0:d383e2dee0f7 107
ommpy 0:d383e2dee0f7 108 /** Init the pin as an output and set the output value
ommpy 0:d383e2dee0f7 109 *
ommpy 0:d383e2dee0f7 110 * @param gpio The GPIO object
ommpy 0:d383e2dee0f7 111 * @param pin The pin name
ommpy 0:d383e2dee0f7 112 * @param value The value to be set
ommpy 0:d383e2dee0f7 113 */
ommpy 0:d383e2dee0f7 114 void gpio_init_out_ex(gpio_t *gpio, PinName pin, int value);
ommpy 0:d383e2dee0f7 115
ommpy 0:d383e2dee0f7 116 /** Init the pin to be in/out
ommpy 0:d383e2dee0f7 117 *
ommpy 0:d383e2dee0f7 118 * @param gpio The GPIO object
ommpy 0:d383e2dee0f7 119 * @param pin The pin name
ommpy 0:d383e2dee0f7 120 * @param direction The pin direction to be set
ommpy 0:d383e2dee0f7 121 * @param mode The pin mode to be set
ommpy 0:d383e2dee0f7 122 * @param value The value to be set for an output pin
ommpy 0:d383e2dee0f7 123 */
ommpy 0:d383e2dee0f7 124 void gpio_init_inout(gpio_t *gpio, PinName pin, PinDirection direction, PinMode mode, int value);
ommpy 0:d383e2dee0f7 125
ommpy 0:d383e2dee0f7 126 /**@}*/
ommpy 0:d383e2dee0f7 127
ommpy 0:d383e2dee0f7 128 #ifdef __cplusplus
ommpy 0:d383e2dee0f7 129 }
ommpy 0:d383e2dee0f7 130 #endif
ommpy 0:d383e2dee0f7 131
ommpy 0:d383e2dee0f7 132 #endif
ommpy 0:d383e2dee0f7 133
ommpy 0:d383e2dee0f7 134 /** @}*/