no-OS
xilinx_gpio.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * @file xilinx/xilinx_gpio.h
3  * @brief Header containing extra types used in the gpio driver
4  * @author scuciurean (sergiu.cuciurean@analog.com)
5 ********************************************************************************
6  * Copyright 2019(c) Analog Devices, Inc.
7  *
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  * - Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * - Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  * - Neither the name of Analog Devices, Inc. nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  * - The use of this software may or may not infringe the patent rights
22  * of one or more patent holders. This license does not release you
23  * from the requirement that you obtain separate licenses from these
24  * patent holders to use this software.
25  * - Use of the software either in source or binary form, must be run
26  * on or directly connected to an Analog Devices Inc. component.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
29  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
30  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
31  * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
32  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33  * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
34  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 *******************************************************************************/
39 
40 #ifndef XILINX_GPIO_H_
41 #define XILINX_GPIO_H_
42 
43 /******************************************************************************/
44 /***************************** Include Files **********************************/
45 /******************************************************************************/
46 
47 #include <stdint.h>
48 #include <stdbool.h>
49 
50 /******************************************************************************/
51 /*************************** Types Declarations *******************************/
52 /******************************************************************************/
53 
63 };
64 
74  uint32_t device_id;
75 };
76 
81 struct xil_gpio_desc {
85  void *config;
87  void *instance;
88 };
89 
93 extern const struct no_os_gpio_platform_ops xil_gpio_ops;
94 
95 #endif
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_OUT
#define NO_OS_GPIO_OUT
Definition: no_os_gpio.h:53
no_os_get_time
struct no_os_time no_os_get_time(void)
Get current time.
Definition: xilinx_delay.c:87
xil_gpio_get_optional
int32_t xil_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: xilinx_gpio.c:175
GPIO_PS
@ GPIO_PS
Definition: xilinx_gpio.h:62
no_os_delay.h
Header file of Delay functions.
xil_gpio_ops
const struct no_os_gpio_platform_ops xil_gpio_ops
Xilinx platform specific GPIO platform ops structure.
Definition: xilinx_gpio.c:455
xil_gpio_desc::type
enum xil_gpio_type type
Definition: xilinx_gpio.h:83
xil_gpio_get_value
int32_t xil_gpio_get_value(struct no_os_gpio_desc *desc, uint8_t *value)
Get the value of the specified GPIO.
Definition: xilinx_gpio.c:415
xil_gpio_type
xil_gpio_type
Xilinx platform architecture sections.
Definition: xilinx_gpio.h:58
no_os_gpio_init_param::number
int32_t number
Definition: no_os_gpio.h:89
xil_gpio_init_param::device_id
uint32_t device_id
Definition: xilinx_gpio.h:74
no_os_axi_io.h
Header file of AXI IO.
no_os_time
Structure holding time data (seconds, microseconds).
Definition: no_os_delay.h:53
xil_gpio_direction_output
int32_t xil_gpio_direction_output(struct no_os_gpio_desc *desc, uint8_t value)
Enable the output direction of the specified GPIO.
Definition: xilinx_gpio.c:256
NO_OS_GPIO_IN
#define NO_OS_GPIO_IN
Definition: no_os_gpio.h:54
xil_gpio_desc::instance
void * instance
Definition: xilinx_gpio.h:87
no_os_error.h
Error codes definition.
xil_gpio_set_value
int32_t xil_gpio_set_value(struct no_os_gpio_desc *desc, uint8_t value)
Set the value of the specified GPIO.
Definition: xilinx_gpio.c:367
xil_gpio_desc::config
void * config
Definition: xilinx_gpio.h:85
xilinx_gpio.h
no_os_div_u64_rem
uint64_t no_os_div_u64_rem(uint64_t dividend, uint32_t divisor, uint32_t *remainder)
xil_gpio_get_direction
int32_t xil_gpio_get_direction(struct no_os_gpio_desc *desc, uint8_t *direction)
Get the direction of the specified GPIO.
Definition: xilinx_gpio.c:321
no_os_gpio_desc
Structure holding the GPIO descriptor.
Definition: no_os_gpio.h:102
xil_gpio_ops
const struct no_os_gpio_platform_ops xil_gpio_ops
Xilinx platform specific gpio platform ops structure.
Definition: xilinx_gpio.c:455
no_os_axi_io_write
int32_t no_os_axi_io_write(uint32_t base, uint32_t offset, uint32_t data)
AXI IO Xilinx specific write function.
Definition: xilinx_axi_io.c:73
no_os_time::us
unsigned int us
Definition: no_os_delay.h:54
no_os_mdelay
void no_os_mdelay(uint32_t msecs)
Generate miliseconds delay.
Definition: xilinx_delay.c:74
NULL
#define NULL
Definition: wrapper.h:64
no_os_time::s
unsigned int s
Definition: no_os_delay.h:54
no_os_udelay
void no_os_udelay(uint32_t usecs)
Generate microseconds delay.
Definition: xilinx_delay.c:60
xil_gpio_init_param
Structure holding the initialization parameters for Xilinx platform specific GPIO parameters.
Definition: xilinx_gpio.h:70
xil_gpio_remove
int32_t xil_gpio_remove(struct no_os_gpio_desc *desc)
Free the resources allocated by no_os_gpio_get().
Definition: xilinx_gpio.c:191
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.h
Header file of GPIO Interface.
GPIO_PL
@ GPIO_PL
Definition: xilinx_gpio.h:60
_gpio_init
int32_t _gpio_init(struct no_os_gpio_desc *desc, const struct no_os_gpio_init_param *param)
Prepare the GPIO decriptor.
Definition: xilinx_gpio.c:68
no_os_util.h
Header file of utility functions.
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
xil_gpio_get
int32_t xil_gpio_get(struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
Obtain the GPIO decriptor.
Definition: xilinx_gpio.c:140
no_os_gpio_desc::number
int32_t number
Definition: no_os_gpio.h:106
xil_gpio_init_param::type
enum xil_gpio_type type
Definition: xilinx_gpio.h:72
xil_gpio_direction_input
int32_t xil_gpio_direction_input(struct no_os_gpio_desc *desc)
Enable the input direction of the specified GPIO.
Definition: xilinx_gpio.c:207
xil_gpio_desc
Xilinx platform specific GPIO descriptor.
Definition: xilinx_gpio.h:81
no_os_axi_io_read
int32_t no_os_axi_io_read(uint32_t base, uint32_t offset, uint32_t *data)
AXI IO Xilinx specific read function.
Definition: xilinx_axi_io.c:59
no_os_div_u64
uint64_t no_os_div_u64(uint64_t dividend, uint32_t divisor)