no-OS
|
Header file of GPIO Interface. More...
#include <stdint.h>
Go to the source code of this file.
Classes | |
struct | gpio_init_param |
Structure holding the parameters for GPIO initialization. More... | |
struct | gpio_desc |
Structure holding the GPIO descriptor. More... | |
struct | gpio_platform_ops |
Structure holding gpio function pointers that point to the platform specific function. More... | |
Macros | |
#define | GPIO_OUT 0x01 |
#define | GPIO_IN 0x00 |
Typedefs | |
typedef struct gpio_init_param | gpio_init_param |
typedef struct gpio_desc | gpio_desc |
Enumerations | |
enum | gpio_pull_up { NO_OS_PULL_NONE, NO_OS_PULL_UP, NO_OS_PULL_DOWN, NO_OS_PULL_UP_WEAK, NO_OS_PULL_DOWN_WEAK } |
Enum that holds the possible pull up/ pull down resistor configuration. More... | |
enum | gpio_values { GPIO_LOW, GPIO_HIGH, GPIO_HIGH_Z } |
Enum that holds the possible output states of a GPIO. More... | |
Functions | |
int32_t | gpio_get (struct gpio_desc **desc, const struct gpio_init_param *param) |
Obtain the GPIO decriptor. More... | |
int32_t | gpio_get_optional (struct gpio_desc **desc, const struct gpio_init_param *param) |
Get the value of an optional GPIO. More... | |
int32_t | gpio_remove (struct gpio_desc *desc) |
Free the resources allocated by gpio_get(). More... | |
int32_t | gpio_direction_input (struct gpio_desc *desc) |
Enable the input direction of the specified GPIO. More... | |
int32_t | gpio_direction_output (struct gpio_desc *desc, uint8_t value) |
Enable the output direction of the specified GPIO. More... | |
int32_t | gpio_get_direction (struct gpio_desc *desc, uint8_t *direction) |
Get the direction of the specified GPIO. More... | |
int32_t | gpio_set_value (struct gpio_desc *desc, uint8_t value) |
Set the value of the specified GPIO. More... | |
int32_t | gpio_get_value (struct gpio_desc *desc, uint8_t *value) |
Get the value of the specified GPIO. More... | |
Header file of GPIO Interface.
Copyright 2019(c) Analog Devices, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#define GPIO_IN 0x00 |
#define GPIO_OUT 0x01 |
typedef struct gpio_init_param gpio_init_param |
enum gpio_pull_up |
enum gpio_values |
int32_t gpio_direction_input | ( | struct gpio_desc * | desc | ) |
Enable the input direction of the specified GPIO.
desc | - The GPIO descriptor. |
int32_t gpio_direction_output | ( | struct gpio_desc * | desc, |
uint8_t | value | ||
) |
Enable the output direction of the specified GPIO.
desc | - The GPIO descriptor. |
value | - The value. Example: GPIO_HIGH GPIO_LOW |
int32_t gpio_get | ( | struct gpio_desc ** | desc, |
const struct gpio_init_param * | param | ||
) |
Obtain the GPIO decriptor.
desc | - The GPIO descriptor. |
param | - GPIO Initialization parameters. |
int32_t gpio_get_direction | ( | struct gpio_desc * | desc, |
uint8_t * | direction | ||
) |
Get the direction of the specified GPIO.
desc | - The GPIO descriptor. |
direction | - The direction. Example: GPIO_OUT GPIO_IN |
int32_t gpio_get_optional | ( | struct gpio_desc ** | desc, |
const struct gpio_init_param * | param | ||
) |
Get the value of an optional GPIO.
desc | - The GPIO descriptor. |
param | - GPIO Initialization parameters. |
int32_t gpio_get_value | ( | struct gpio_desc * | desc, |
uint8_t * | value | ||
) |
Get the value of the specified GPIO.
desc | - The GPIO descriptor. |
value | - The value. Example: GPIO_HIGH GPIO_LOW |
int32_t gpio_remove | ( | struct gpio_desc * | desc | ) |
Free the resources allocated by gpio_get().
desc | - The GPIO descriptor. |
int32_t gpio_set_value | ( | struct gpio_desc * | desc, |
uint8_t | value | ||
) |
Set the value of the specified GPIO.
desc | - The GPIO descriptor. |
value | - The value. Example: GPIO_HIGH GPIO_LOW |