Enda Kilgarriff / platform_drivers

Update platform drivers

inc/gpio.h@10:b5115cd6b916, 2020-06-17 (annotated)

Committer:
EndaKilgarriff
Date:
Wed Jun 17 14:54:14 2020 +0000
Revision:
10:b5115cd6b916
Parent:
9:9e247b9c9abf 
Roll back delay.cpp to previous version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mahphalke 8:70fc373a5f46 1 /***************************************************************************//**
mahphalke 8:70fc373a5f46 2 * @file gpio.h
EndaKilgarriff 9:9e247b9c9abf 3 * @brief Header file of GPIO Interface
mahphalke 8:70fc373a5f46 4 * @author DBogdan (dragos.bogdan@analog.com)
mahphalke 8:70fc373a5f46 5 ********************************************************************************
mahphalke 8:70fc373a5f46 6 * Copyright 2019(c) Analog Devices, Inc.
mahphalke 8:70fc373a5f46 7 *
mahphalke 8:70fc373a5f46 8 * All rights reserved.
mahphalke 8:70fc373a5f46 9 *
mahphalke 8:70fc373a5f46 10 * Redistribution and use in source and binary forms, with or without
mahphalke 8:70fc373a5f46 11 * modification, are permitted provided that the following conditions are met:
mahphalke 8:70fc373a5f46 12 * - Redistributions of source code must retain the above copyright
mahphalke 8:70fc373a5f46 13 * notice, this list of conditions and the following disclaimer.
mahphalke 8:70fc373a5f46 14 * - Redistributions in binary form must reproduce the above copyright
mahphalke 8:70fc373a5f46 15 * notice, this list of conditions and the following disclaimer in
mahphalke 8:70fc373a5f46 16 * the documentation and/or other materials provided with the
mahphalke 8:70fc373a5f46 17 * distribution.
mahphalke 8:70fc373a5f46 18 * - Neither the name of Analog Devices, Inc. nor the names of its
mahphalke 8:70fc373a5f46 19 * contributors may be used to endorse or promote products derived
mahphalke 8:70fc373a5f46 20 * from this software without specific prior written permission.
mahphalke 8:70fc373a5f46 21 * - The use of this software may or may not infringe the patent rights
mahphalke 8:70fc373a5f46 22 * of one or more patent holders. This license does not release you
mahphalke 8:70fc373a5f46 23 * from the requirement that you obtain separate licenses from these
mahphalke 8:70fc373a5f46 24 * patent holders to use this software.
mahphalke 8:70fc373a5f46 25 * - Use of the software either in source or binary form, must be run
mahphalke 8:70fc373a5f46 26 * on or directly connected to an Analog Devices Inc. component.
mahphalke 8:70fc373a5f46 27 *
mahphalke 8:70fc373a5f46 28 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
mahphalke 8:70fc373a5f46 29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
mahphalke 8:70fc373a5f46 30 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
mahphalke 8:70fc373a5f46 31 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
mahphalke 8:70fc373a5f46 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
mahphalke 8:70fc373a5f46 33 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
mahphalke 8:70fc373a5f46 34 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mahphalke 8:70fc373a5f46 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mahphalke 8:70fc373a5f46 36 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mahphalke 8:70fc373a5f46 37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mahphalke 8:70fc373a5f46 38 *******************************************************************************/
mahphalke 8:70fc373a5f46 39
mahphalke 8:70fc373a5f46 40 #ifndef GPIO_H_
mahphalke 8:70fc373a5f46 41 #define GPIO_H_
mahphalke 8:70fc373a5f46 42
mahphalke 8:70fc373a5f46 43 /******************************************************************************/
mahphalke 8:70fc373a5f46 44 /***************************** Include Files **********************************/
mahphalke 8:70fc373a5f46 45 /******************************************************************************/
mahphalke 8:70fc373a5f46 46
mahphalke 8:70fc373a5f46 47 #include <stdint.h>
mahphalke 8:70fc373a5f46 48
mahphalke 8:70fc373a5f46 49 /******************************************************************************/
mahphalke 8:70fc373a5f46 50 /********************** Macros and Constants Definitions **********************/
mahphalke 8:70fc373a5f46 51 /******************************************************************************/
mahphalke 8:70fc373a5f46 52
mahphalke 8:70fc373a5f46 53 #define GPIO_OUT 0x01
mahphalke 8:70fc373a5f46 54 #define GPIO_IN 0x00
mahphalke 8:70fc373a5f46 55
mahphalke 8:70fc373a5f46 56 #define GPIO_HIGH 0x01
mahphalke 8:70fc373a5f46 57 #define GPIO_LOW 0x00
mahphalke 8:70fc373a5f46 58
mahphalke 8:70fc373a5f46 59 /******************************************************************************/
mahphalke 8:70fc373a5f46 60 /*************************** Types Declarations *******************************/
mahphalke 8:70fc373a5f46 61 /******************************************************************************/
mahphalke 8:70fc373a5f46 62
EndaKilgarriff 9:9e247b9c9abf 63 /**
EndaKilgarriff 9:9e247b9c9abf 64 * @struct gpio_init_param
EndaKilgarriff 9:9e247b9c9abf 65 * @brief Structure holding the parameters for GPIO initialization.
EndaKilgarriff 9:9e247b9c9abf 66 */
mahphalke 8:70fc373a5f46 67 typedef struct gpio_init_param {
EndaKilgarriff 9:9e247b9c9abf 68 /** GPIO number */
mahphalke 8:70fc373a5f46 69 uint8_t number;
EndaKilgarriff 9:9e247b9c9abf 70 /** GPIO extra parameters (device specific) */
mahphalke 8:70fc373a5f46 71 void *extra;
mahphalke 8:70fc373a5f46 72 } gpio_init_param;
mahphalke 8:70fc373a5f46 73
EndaKilgarriff 9:9e247b9c9abf 74 /**
EndaKilgarriff 9:9e247b9c9abf 75 * @struct gpio_desc
EndaKilgarriff 9:9e247b9c9abf 76 * @brief Structure holding the GPIO descriptor.
EndaKilgarriff 9:9e247b9c9abf 77 */
mahphalke 8:70fc373a5f46 78 typedef struct gpio_desc {
EndaKilgarriff 9:9e247b9c9abf 79 /** GPIO number */
mahphalke 8:70fc373a5f46 80 uint8_t number;
EndaKilgarriff 9:9e247b9c9abf 81 /** GPIO extra parameters (device specific) */
mahphalke 8:70fc373a5f46 82 void *extra;
mahphalke 8:70fc373a5f46 83 } gpio_desc;
mahphalke 8:70fc373a5f46 84
mahphalke 8:70fc373a5f46 85 /******************************************************************************/
mahphalke 8:70fc373a5f46 86 /************************ Functions Declarations ******************************/
mahphalke 8:70fc373a5f46 87 /******************************************************************************/
mahphalke 8:70fc373a5f46 88
mahphalke 8:70fc373a5f46 89 /* Obtain the GPIO decriptor. */
mahphalke 8:70fc373a5f46 90 int32_t gpio_get(struct gpio_desc **desc,
EndaKilgarriff 9:9e247b9c9abf 91 const struct gpio_init_param *param);
EndaKilgarriff 9:9e247b9c9abf 92
EndaKilgarriff 9:9e247b9c9abf 93 /* Obtain optional GPIO descriptor. */
EndaKilgarriff 9:9e247b9c9abf 94 int32_t gpio_get_optional(struct gpio_desc **desc,
EndaKilgarriff 9:9e247b9c9abf 95 const struct gpio_init_param *param);
mahphalke 8:70fc373a5f46 96
mahphalke 8:70fc373a5f46 97 /* Free the resources allocated by gpio_get() */
mahphalke 8:70fc373a5f46 98 int32_t gpio_remove(struct gpio_desc *desc);
mahphalke 8:70fc373a5f46 99
mahphalke 8:70fc373a5f46 100 /* Enable the input direction of the specified GPIO. */
mahphalke 8:70fc373a5f46 101 int32_t gpio_direction_input(struct gpio_desc *desc);
mahphalke 8:70fc373a5f46 102
mahphalke 8:70fc373a5f46 103 /* Enable the output direction of the specified GPIO. */
mahphalke 8:70fc373a5f46 104 int32_t gpio_direction_output(struct gpio_desc *desc,
mahphalke 8:70fc373a5f46 105 uint8_t value);
mahphalke 8:70fc373a5f46 106
mahphalke 8:70fc373a5f46 107 /* Get the direction of the specified GPIO. */
mahphalke 8:70fc373a5f46 108 int32_t gpio_get_direction(struct gpio_desc *desc,
mahphalke 8:70fc373a5f46 109 uint8_t *direction);
mahphalke 8:70fc373a5f46 110
mahphalke 8:70fc373a5f46 111 /* Set the value of the specified GPIO. */
mahphalke 8:70fc373a5f46 112 int32_t gpio_set_value(struct gpio_desc *desc,
mahphalke 8:70fc373a5f46 113 uint8_t value);
mahphalke 8:70fc373a5f46 114
mahphalke 8:70fc373a5f46 115 /* Get the value of the specified GPIO. */
mahphalke 8:70fc373a5f46 116 int32_t gpio_get_value(struct gpio_desc *desc,
mahphalke 8:70fc373a5f46 117 uint8_t *value);
mahphalke 8:70fc373a5f46 118
mahphalke 8:70fc373a5f46 119 #endif // GPIO_H_