no-OS
uart_extra.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * @file xilinx/uart_extra.h
3  * @brief Header containing types used in the uart driver.
4  * @author Cristian Pop (cristian.pop@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 UART_EXTRA_H_
41 #define UART_EXTRA_H_
42 
43 /******************************************************************************/
44 /***************************** Include Files **********************************/
45 /******************************************************************************/
46 
47 /******************************************************************************/
48 /********************** Macros and Constants Definitions **********************/
49 /******************************************************************************/
50 
51 #define UART_BUFF_LENGTH 256
52 
53 /******************************************************************************/
54 /*************************** Types Declarations *******************************/
55 /******************************************************************************/
56 
66 };
67 
77  uint32_t irq_id;
80 };
81 
86 struct xil_uart_desc {
90  uint32_t irq_id;
96  uint32_t fifo_read_offset;
100  uint32_t bytes_received;
104  void *instance;
105 };
106 
107 #endif
xil_uart_desc::fifo
struct no_os_fifo_element * fifo
Definition: uart_extra.h:94
xil_uart_desc::irq_desc
struct no_os_irq_ctrl_desc * irq_desc
Definition: uart_extra.h:92
xil_uart_init_param::type
enum xil_uart_type type
Definition: uart_extra.h:75
xil_uart_desc::buff
char buff[UART_BUFF_LENGTH]
Definition: uart_extra.h:98
xil_uart_desc
Xilinx platform specific UART descriptor.
Definition: uart_extra.h:86
xil_uart_desc::bytes_received
uint32_t bytes_received
Definition: uart_extra.h:100
xil_uart_init_param::irq_id
uint32_t irq_id
Definition: uart_extra.h:77
xil_uart_desc::type
enum xil_uart_type type
Definition: uart_extra.h:88
xil_uart_desc::total_error_count
uint32_t total_error_count
Definition: uart_extra.h:102
xil_uart_type
xil_uart_type
Xilinx platform architecture sections.
Definition: uart_extra.h:61
UART_PS
@ UART_PS
Definition: uart_extra.h:65
xil_uart_init_param
Structure holding the initialization parameters for Xilinx platform specific UART parameters.
Definition: uart_extra.h:73
UART_BUFF_LENGTH
#define UART_BUFF_LENGTH
Definition: uart_extra.h:51
xil_uart_init_param::irq_desc
struct no_os_irq_ctrl_desc * irq_desc
Definition: uart_extra.h:79
UART_PL
@ UART_PL
Definition: uart_extra.h:63
no_os_fifo_element
Structure holding the fifo element parameters.
Definition: no_os_fifo.h:56
xil_uart_desc::instance
void * instance
Definition: uart_extra.h:104
xil_uart_desc::fifo_read_offset
uint32_t fifo_read_offset
Definition: uart_extra.h:96
xil_uart_desc::irq_id
uint32_t irq_id
Definition: uart_extra.h:90
no_os_irq_ctrl_desc
Definition: no_os_irq.h:119