Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/hal/gpio_api.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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