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