伊生希 小林 / Mbed 2 deprecated cansat_main_copy

temp

Dependencies:   mbed SDFileSystem MS5607 ADXL345_I2C FATFileSystem

mbed/hal/gpio_api.h@0:c88c3b616c00, 2020-03-16 (annotated)

Committer:
IKobayashi
Date:
Mon Mar 16 23:37:42 2020 +0900
Revision:
0:c88c3b616c00
copy

Who changed what in which revision?

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