no-OS
no_os_gpio.h
Go to the documentation of this file.
1 /***************************************************************************/
40 #ifndef _NO_OS_GPIO_H_
41 #define _NO_OS_GPIO_H_
42 
43 /******************************************************************************/
44 /***************************** Include Files **********************************/
45 /******************************************************************************/
46 
47 #include <stdint.h>
48 
49 /******************************************************************************/
50 /********************** Macros and Constants Definitions **********************/
51 /******************************************************************************/
52 
53 #define NO_OS_GPIO_OUT 0x01
54 #define NO_OS_GPIO_IN 0x00
55 
56 /******************************************************************************/
57 /*************************** Types Declarations *******************************/
58 /******************************************************************************/
59 
66 
79 };
80 
87  int32_t port;
89  int32_t number;
95  void *extra;
96 };
97 
104  int32_t port;
106  int32_t number;
112  void *extra;
113 };
114 
126 };
127 
135  int32_t (*gpio_ops_get)(struct no_os_gpio_desc **,
136  const struct no_os_gpio_init_param *);
139  const struct no_os_gpio_init_param *);
141  int32_t (*gpio_ops_remove)(struct no_os_gpio_desc *);
145  int32_t (*gpio_ops_direction_output)(struct no_os_gpio_desc *, uint8_t);
147  int32_t (*gpio_ops_get_direction)(struct no_os_gpio_desc *, uint8_t *);
149  int32_t (*gpio_ops_set_value)(struct no_os_gpio_desc *, uint8_t);
151  int32_t (*gpio_ops_get_value)(struct no_os_gpio_desc *, uint8_t *);
152 };
153 
154 /******************************************************************************/
155 /************************ Functions Declarations ******************************/
156 /******************************************************************************/
157 
158 /* Obtain the GPIO decriptor. */
159 int32_t no_os_gpio_get(struct no_os_gpio_desc **desc,
160  const struct no_os_gpio_init_param *param);
161 
162 /* Obtain optional GPIO descriptor. */
163 int32_t no_os_gpio_get_optional(struct no_os_gpio_desc **desc,
164  const struct no_os_gpio_init_param *param);
165 
166 /* Free the resources allocated by no_os_gpio_get(). */
167 int32_t no_os_gpio_remove(struct no_os_gpio_desc *desc);
168 
169 /* Enable the input direction of the specified GPIO. */
170 int32_t no_os_gpio_direction_input(struct no_os_gpio_desc *desc);
171 
172 /* Enable the output direction of the specified GPIO. */
173 int32_t no_os_gpio_direction_output(struct no_os_gpio_desc *desc,
174  uint8_t value);
175 
176 /* Get the direction of the specified GPIO. */
177 int32_t no_os_gpio_get_direction(struct no_os_gpio_desc *desc,
178  uint8_t *direction);
179 
180 /* Set the value of the specified GPIO. */
181 int32_t no_os_gpio_set_value(struct no_os_gpio_desc *desc,
182  uint8_t value);
183 
184 /* Get the value of the specified GPIO. */
185 int32_t no_os_gpio_get_value(struct no_os_gpio_desc *desc,
186  uint8_t *value);
187 
188 #endif // _NO_OS_GPIO_H_
no_os_gpio_platform_ops::gpio_ops_direction_input
int32_t(* gpio_ops_direction_input)(struct no_os_gpio_desc *)
Definition: no_os_gpio.h:143
NO_OS_PULL_DOWN
@ NO_OS_PULL_DOWN
Definition: no_os_gpio.h:76
no_os_gpio_desc::extra
void * extra
Definition: no_os_gpio.h:112
no_os_gpio_init_param
Structure holding the parameters for GPIO initialization.
Definition: no_os_gpio.h:85
no_os_gpio_platform_ops::gpio_ops_get_value
int32_t(* gpio_ops_get_value)(struct no_os_gpio_desc *, uint8_t *)
Definition: no_os_gpio.h:151
no_os_gpio_init_param::pull
enum no_os_gpio_pull_up pull
Definition: no_os_gpio.h:91
NO_OS_GPIO_HIGH_Z
@ NO_OS_GPIO_HIGH_Z
Definition: no_os_gpio.h:125
no_os_gpio_get_value
int32_t no_os_gpio_get_value(struct no_os_gpio_desc *desc, uint8_t *value)
Get the value of the specified GPIO.
Definition: no_os_gpio.c:177
no_os_gpio_init_param::port
int32_t port
Definition: no_os_gpio.h:87
NO_OS_PULL_UP_WEAK
@ NO_OS_PULL_UP_WEAK
Definition: no_os_gpio.h:77
NO_OS_GPIO_HIGH
@ NO_OS_GPIO_HIGH
Definition: no_os_gpio.h:123
no_os_gpio_init_param::number
int32_t number
Definition: no_os_gpio.h:89
NO_OS_PULL_DOWN_WEAK
@ NO_OS_PULL_DOWN_WEAK
Definition: no_os_gpio.h:78
no_os_gpio_direction_input
int32_t no_os_gpio_direction_input(struct no_os_gpio_desc *desc)
Enable the input direction of the specified GPIO.
Definition: no_os_gpio.c:108
NO_OS_PULL_NONE
@ NO_OS_PULL_NONE
Definition: no_os_gpio.h:72
no_os_gpio_init_param::platform_ops
const struct no_os_gpio_platform_ops * platform_ops
Definition: no_os_gpio.h:93
NO_OS_GPIO_LOW
@ NO_OS_GPIO_LOW
Definition: no_os_gpio.h:121
no_os_gpio_desc::platform_ops
const struct no_os_gpio_platform_ops * platform_ops
Definition: no_os_gpio.h:110
no_os_gpio_platform_ops::gpio_ops_remove
int32_t(* gpio_ops_remove)(struct no_os_gpio_desc *)
Definition: no_os_gpio.h:141
no_os_gpio_remove
int32_t no_os_gpio_remove(struct no_os_gpio_desc *desc)
Free the resources allocated by no_os_gpio_get().
Definition: no_os_gpio.c:95
no_os_gpio_desc::port
int32_t port
Definition: no_os_gpio.h:104
no_os_gpio_desc
Structure holding the GPIO descriptor.
Definition: no_os_gpio.h:102
no_os_gpio_get
int32_t no_os_gpio_get(struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
Obtain the GPIO decriptor.
Definition: no_os_gpio.c:55
no_os_gpio_pull_up
no_os_gpio_pull_up
Enum that holds the possible pull up/ pull down resistor configuration.
Definition: no_os_gpio.h:71
no_os_gpio_get_direction
int32_t no_os_gpio_get_direction(struct no_os_gpio_desc *desc, uint8_t *direction)
Get the direction of the specified GPIO.
Definition: no_os_gpio.c:142
no_os_gpio_values
no_os_gpio_values
Enum that holds the possible output states of a GPIO.
Definition: no_os_gpio.h:119
no_os_gpio_desc::pull
enum no_os_gpio_pull_up pull
Definition: no_os_gpio.h:108
no_os_gpio_set_value
int32_t no_os_gpio_set_value(struct no_os_gpio_desc *desc, uint8_t value)
Set the value of the specified GPIO.
Definition: no_os_gpio.c:160
NO_OS_PULL_UP
@ NO_OS_PULL_UP
Definition: no_os_gpio.h:74
no_os_gpio_platform_ops
Structure holding gpio function pointers that point to the platform specific function.
Definition: no_os_gpio.h:133
no_os_gpio_init_param::extra
void * extra
Definition: no_os_gpio.h:95
no_os_gpio_platform_ops::gpio_ops_get_direction
int32_t(* gpio_ops_get_direction)(struct no_os_gpio_desc *, uint8_t *)
Definition: no_os_gpio.h:147
no_os_gpio_platform_ops::gpio_ops_get
int32_t(* gpio_ops_get)(struct no_os_gpio_desc **, const struct no_os_gpio_init_param *)
Definition: no_os_gpio.h:135
no_os_gpio_platform_ops::gpio_ops_get_optional
int32_t(* gpio_ops_get_optional)(struct no_os_gpio_desc **, const struct no_os_gpio_init_param *)
Definition: no_os_gpio.h:138
no_os_gpio_direction_output
int32_t no_os_gpio_direction_output(struct no_os_gpio_desc *desc, uint8_t value)
Enable the output direction of the specified GPIO.
Definition: no_os_gpio.c:124
no_os_gpio_desc::number
int32_t number
Definition: no_os_gpio.h:106
no_os_gpio_platform_ops::gpio_ops_direction_output
int32_t(* gpio_ops_direction_output)(struct no_os_gpio_desc *, uint8_t)
Definition: no_os_gpio.h:145
no_os_gpio_platform_ops::gpio_ops_set_value
int32_t(* gpio_ops_set_value)(struct no_os_gpio_desc *, uint8_t)
Definition: no_os_gpio.h:149
no_os_gpio_get_optional
int32_t no_os_gpio_get_optional(struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
Get the value of an optional GPIO.
Definition: no_os_gpio.c:75