|
Break detected |
|
Receive framing error |
|
No error |
|
Receive overrun error |
|
Receive parity error |
|
A change in modem status |
|
Data has been received |
|
A receive error was detected |
|
A receive timeout occurred |
|
Data has been sent |
|
1 byte trigger level |
|
4 byte trigger level |
|
8 byte trigger level |
|
14 byte trigger level |
|
1 stop bit |
|
2 stop bits |
|
5 data bits |
|
6 data bits |
|
7 data bits |
|
8 data bits |
|
Even Parity |
|
No Parity |
|
Odd Parity |
|
CTS signal changed state |
|
Current state of CTS signal |
|
DCD signal changed state |
|
Current state of DCD signal |
|
DSR signal changed state |
|
Current state of DSR signal |
|
Ringing has stopped |
|
Ring signal is active |
|
Assert DTR signal |
|
Assert out1 signal |
|
Assert out2 signal |
|
Assert RTS signal |
|
Enable data interrupts |
|
Enable FIFOs |
|
Enable local loopback |
|
Enable modem interrupts |
|
Reset the receive FIFO |
|
Reset the transmit FIFO |
|
Enable status interrupt |
|
Set a break condition |
|
This data type defines a handler which the application must define when using interrupt mode. The handler will be called from the driver in an interrupt context to handle application specific processing.
|
|
Initializes a specific XUartNs550 instance such that it is ready to be used. The data format of the device is setup for 8 data bits, 1 stop bit, and no parity by default. The baud rate is set to a default value specified by Config->DefaultBaudRate if set, otherwise it is set to 19.2K baud. If the device has FIFOs (16550), they are enabled and the a receive FIFO threshold is set for 8 bytes. The default operating mode of the driver is polled mode.
|
|
This function zeros the statistics for the given instance.
|
|
Gets the data format for the specified UART. The data format includes the baud rate, number of data bits, number of stop bits, and parity.
|
|
This function gets the receive FIFO trigger level. The receive trigger level indicates the number of bytes in the receive FIFO that cause a receive data event (interrupt) to be generated.
|
|
This function returns the last errors that have occurred in the specified UART. It also clears the errors such that they cannot be retrieved again. The errors include parity error, receive overrun error, framing error, and break detection. The last errors is an accumulation of the errors each time an error is discovered in the driver. A status is checked for each received byte and this status is accumulated in the last errors. If this function is called after receiving a buffer of data, it will indicate any errors that occurred for the bytes of the buffer. It does not indicate which bytes contained errors.
|
|
This function gets the modem status from the specified UART. The modem status indicates any changes of the modem signals. This function allows the modem status to be read in a polled mode. The modem status is updated whenever it is read such that reading it twice may not yield the same results.
|
|
Gets the options for the specified driver instance. The options are implemented as bit masks such that multiple options may be enabled or disabled simulataneously.
|
|
This functions returns a snapshot of the current statistics in the area provided.
|
|
Initializes a specific XUartNs550 instance such that it is ready to be used. The data format of the device is setup for 8 data bits, 1 stop bit, and no parity by default. The baud rate is set to a default value specified by XPAR_DEFAULT_BAUD_RATE if the symbol is defined, otherwise it is set to 19.2K baud. If the device has FIFOs (16550), they are enabled and the a receive FIFO threshold is set for 8 bytes. The default operating mode of the driver is polled mode.
|
|
This function is the interrupt handler for the 16450/16550 UART driver. It must be connected to an interrupt system by the user such that it is called when an interrupt for any 16450/16550 UART occurs. This function does not save or restore the processor context such that the user must ensure this occurs.
|
|
This function determines if the specified UART is sending data. If the transmitter register is not empty, it is sending data.
|
|
Looks up the device configuration based on the unique device ID. A table contains the configuration info for each device in the system.
|
|
This function will attempt to receive a specified number of bytes of data from the UART and store it into the specified buffer. This function is designed for either polled or interrupt driven modes. It is non-blocking such that it will return if no data has already received by the UART. In a polled mode, this function will only receive as much data as the UART can buffer, either in the receiver or in the FIFO if present and enabled. The application may need to call it repeatedly to receive a buffer. Polled mode is the default mode of operation for the driver. In interrupt mode, this function will start receiving and then the interrupt handler of the driver will continue receiving data until the buffer has been received. A callback function, as specified by the application, will be called to indicate the completion of receiving the buffer or when any receive errors or timeouts occur. Interrupt mode must be enabled using the SetOptions function.
|
|
This functions runs a self-test on the driver and hardware device. This self test performs a local loopback and verifies data can be sent and received. The statistics are cleared at the end of the test. The time for this test to execute is proportional to the baud rate that has been set prior to calling this function.
|
|
This functions sends the specified buffer of data using the UART in either polled or interrupt driven modes. This function is non-blocking such that it will return before the data has been sent by the UART. If the UART is busy sending data, it will return and indicate zero bytes were sent. In a polled mode, this function will only send as much data as the UART can buffer, either in the transmitter or in the FIFO if present and enabled. The application may need to call it repeatedly to send a buffer. In interrupt mode, this function will start sending the specified buffer and then the interrupt handler of the driver will continue sending data until the buffer has been sent. A callback function, as specified by the application, will be called to indicate the completion of sending the buffer.
This function and the XUartNs550_SetOptions() function modify shared data such that there may be a need for mutual exclusion in a multithreaded environment and if XUartNs550_SetOptions() if called from a handler. |
|
Sets the data format for the specified UART. The data format includes the baud rate, number of data bits, number of stop bits, and parity. It is the caller's responsibility to ensure that the UART is not sending or receiving data when this function is called.
The baud rates tested include: 1200, 2400, 4800, 9600, 19200, 38400, 57600 and 115200. |
|
This functions sets the receive FIFO trigger level. The receive trigger level specifies the number of bytes in the receive FIFO that cause a receive data event (interrupt) to be generated. The FIFOs must be enabled to set the trigger level.
|
|
This function sets the handler that will be called when an event (interrupt) occurs in the driver. The purpose of the handler is to allow application specific processing to be performed.
There is no assert on the CallBackRef since the driver doesn't know what it is (nor should it) |
|
Sets the options for the specified driver instance. The options are implemented as bit masks such that multiple options may be enabled or disabled simultaneously. The GetOptions function may be called to retrieve the currently enabled options. The result is ORed in the desired new settings to be enabled and ANDed with the inverse to clear the settings to be disabled. The resulting value is then used as the options for the SetOption function call.
|
Copyright © 1995-2009 Xilinx, Inc. All rights reserved.