Knight KE / Mbed OS Game_Master

游戏王对战板，目前code还是空的

mbed-os/hal/gpio_api.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

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