uartns550
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Typedefs Macros Groups Pages
xuartns550.c File Reference

Overview

Required functions for the 16450/16550 UART driver.

Refer to the header file xuartns550.h for more detailed information.

MODIFICATION HISTORY:
Ver   Who  Date     Changes


1.00a ecm 08/16/01 First release 1.00b jhl 03/11/02 Repartitioned driver for smaller files. 1.00b rmm 05/14/03 Fixed diab compiler warnings relating to asserts. 1.01a jvb 12/13/05 I changed Initialize() into CfgInitialize(), and made CfgInitialize() take a pointer to a config structure instead of a device id. I moved Initialize() into xgpio_sinit.c, and had Initialize() call CfgInitialize() after it retrieved the config structure using the device id. I removed include of xparameters.h along with any dependencies on xparameters.h and the _g.c config table. 1.11a sv 03/20/07 Updated to use the new coding guidelines. 2.00a ktn 10/20/09 Converted all register accesses to 32 bit access. Updated to use HAL Processor APIs. _m is removed from the name of all the macro definitions. XUartNs550_mClearStats macro is removed, XUartNs550_ClearStats function should be used in its place. 2.01a bss 01/13/12 Removed unnecessary read of the LCR register in the XUartNs550_CfgInitialize function. Removed compiler warnings for unused variables in the XUartNs550_StubHandler. 3.3 nsk 04/13/15 Fixed Clock Divisor Enhancement. (CR 857013) 3.4 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR# 867425. Changed the prototype of XUartNs550_CfgInitialize API. 3.7 sd 03/02/20 Update the macro names. 3.15 vn 09/09/26 Align Doxygen comments with AMD standards

#include "xstatus.h"
#include "xuartns550.h"
#include "xuartns550_i.h"
#include "xil_io.h"

Macros

Baud rate error tolerance

Maximum percentage error allowed between the actual baud rate generated using the specified clock and the desired baud rate.

#define XUN_MAX_BAUD_ERROR_RATE   3
 Maximum percent error allowed. More...
 

Functions

int XUartNs550_CfgInitialize (XUartNs550 *InstancePtr, XUartNs550_Config *Config, UINTPTR EffectiveAddr)
 Initializes a specific XUartNs550 instance for use. More...
 
unsigned int XUartNs550_Send (XUartNs550 *InstancePtr, u8 *BufferPtr, unsigned int NumBytes)
 Sends the specified buffer of data using the UART. More...
 
unsigned int XUartNs550_Recv (XUartNs550 *InstancePtr, u8 *BufferPtr, unsigned int NumBytes)
 Attempts to receive a specified number of bytes of data from the UART. More...
 
unsigned int XUartNs550_SendBuffer (XUartNs550 *InstancePtr)
 Sends the previously specified buffer using the instance variables. More...
 
unsigned int XUartNs550_ReceiveBuffer (XUartNs550 *InstancePtr)
 Receives a buffer previously specified by setting up the instance variables of the instance. More...
 
int XUartNs550_SetBaudRate (XUartNs550 *InstancePtr, u32 BaudRate)
 Sets the baud rate for the specified UART. More...