libpynq  (release 5EID0-2023 version 0.3.0 of 2024-04-25 09:42 )
gpio.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2023 Eindhoven University of Technology
3 
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10 
11 The above copyright notice and this permission notice shall be included in all
12 copies or substantial portions of the Software.
13 
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 SOFTWARE.
21 */
22 #ifndef GPIO_H
23 #define GPIO_H
24 #include <pinmap.h>
25 #include <stdbool.h>
26 #include <stdint.h>
27 
88 typedef enum {
94 
98 typedef enum {
103 } gpio_level_t;
104 
108 extern void gpio_init(void);
113 extern void gpio_destroy(void);
114 
121 extern void gpio_reset_pin(const io_t pin);
122 
130 extern void gpio_set_direction(const io_t pin,
131  const gpio_direction_t direction);
132 
140 
148 extern void gpio_set_level(const io_t pin, const gpio_level_t level);
149 
156 extern gpio_level_t gpio_get_level(const io_t pin);
157 
161 extern void gpio_reset(void);
162 
168 extern bool gpio_is_initialized(void);
172 #endif // GPIO_H
GPIO_DIR_OUTPUT
@ GPIO_DIR_OUTPUT
Definition: gpio.h:92
gpio_direction_t
gpio_direction_t
Definition: gpio.h:88
gpio_set_level
void gpio_set_level(const io_t pin, const gpio_level_t level)
Set the level of the output IO pin. If the pin is configured as input, this function does nothing.
Definition: gpio.c:7
gpio_reset_pin
void gpio_reset_pin(const io_t pin)
Function is currently a no-op placeholder for arduino compatibility.
Definition: gpio.c:4
GPIO_LEVEL_LOW
@ GPIO_LEVEL_LOW
Definition: gpio.h:100
gpio_get_level
gpio_level_t gpio_get_level(const io_t pin)
Return the level of the IO pin.
Definition: gpio.c:8
gpio_set_direction
void gpio_set_direction(const io_t pin, const gpio_direction_t direction)
Set the IO pin as in input or output.
Definition: gpio.c:5
GPIO_DIR_INPUT
@ GPIO_DIR_INPUT
Definition: gpio.h:90
gpio_is_initialized
bool gpio_is_initialized(void)
Definition: gpio.c:35
gpio_level_t
gpio_level_t
Definition: gpio.h:98
pin
Definition: switchbox.c:99
gpio_init
void gpio_init(void)
Definition: gpio.c:2
pinmap.h
gpio_reset
void gpio_reset(void)
Reset all IO pins.
Definition: gpio.c:18
gpio_get_direction
gpio_direction_t gpio_get_direction(const io_t pin)
Returns the direction the set pin is initialized in.
Definition: gpio.c:6
GPIO_LEVEL_HIGH
@ GPIO_LEVEL_HIGH
Definition: gpio.h:102
io_t
io_t
Definition: pinmap.h:45
gpio_destroy
void gpio_destroy(void)
Definition: gpio.c:3