Functions | |
__STATIC_INLINE void | UARTParityModeSet (uint32_t ui32Base, uint32_t ui32Parity) |
Sets the type of parity. More... | |
__STATIC_INLINE uint32_t | UARTParityModeGet (uint32_t ui32Base) |
Gets the type of parity currently being used. More... | |
__STATIC_INLINE void | UARTFIFOLevelSet (uint32_t ui32Base, uint32_t ui32TxLevel, uint32_t ui32RxLevel) |
Sets the FIFO level at which interrupts are generated. More... | |
void | UARTFIFOLevelGet (uint32_t ui32Base, uint32_t *pui32TxLevel, uint32_t *pui32RxLevel) |
Gets the FIFO level at which interrupts are generated. More... | |
void | UARTConfigSetExpClk (uint32_t ui32Base, uint32_t ui32UARTClk, uint32_t ui32Baud, uint32_t ui32Config) |
Sets the configuration of a UART. More... | |
void | UARTConfigGetExpClk (uint32_t ui32Base, uint32_t ui32UARTClk, uint32_t *pui32Baud, uint32_t *pui32Config) |
Gets the current configuration of a UART. More... | |
__STATIC_INLINE void | UARTEnable (uint32_t ui32Base) |
Enables transmitting and receiving. More... | |
void | UARTDisable (uint32_t ui32Base) |
Disables transmitting and receiving. More... | |
__STATIC_INLINE void | UARTFIFOEnable (uint32_t ui32Base) |
Enables the transmit and receive FIFOs. More... | |
__STATIC_INLINE void | UARTFIFODisable (uint32_t ui32Base) |
Disables the transmit and receive FIFOs. More... | |
__STATIC_INLINE void | UARTTxIntModeSet (uint32_t ui32Base, uint32_t ui32Mode) |
Sets the operating mode for the UART transmit interrupt. More... | |
__STATIC_INLINE uint32_t | UARTTxIntModeGet (uint32_t ui32Base) |
Returns the current operating mode for the UART transmit interrupt. More... | |
__STATIC_INLINE bool | UARTCharsAvail (uint32_t ui32Base) |
Determines if there are any characters in the receive FIFO. More... | |
__STATIC_INLINE bool | UARTSpaceAvail (uint32_t ui32Base) |
Determines if there is any space in the transmit FIFO. More... | |
int32_t | UARTCharGetNonBlocking (uint32_t ui32Base) |
Receives a character from the specified port. More... | |
int32_t | UARTCharGet (uint32_t ui32Base) |
Waits for a character from the specified port. More... | |
bool | UARTCharPutNonBlocking (uint32_t ui32Base, uint8_t ui8Data) |
Sends a character to the specified port. More... | |
void | UARTCharPut (uint32_t ui32Base, uint8_t ui8Data) |
Waits to send a character from the specified port. More... | |
__STATIC_INLINE bool | UARTBusy (uint32_t ui32Base) |
Determines whether the UART transmitter is busy or not. More... | |
__STATIC_INLINE void | UARTBreakCtl (uint32_t ui32Base, bool bBreakState) |
Causes a BREAK to be sent. More... | |
void | UARTIntRegister (uint32_t ui32Base, void(*pfnHandler)(void)) |
Registers an interrupt handler for a UART interrupt. More... | |
void | UARTIntUnregister (uint32_t ui32Base) |
Unregisters an interrupt handler for a UART interrupt. More... | |
__STATIC_INLINE void | UARTIntEnable (uint32_t ui32Base, uint32_t ui32IntFlags) |
Enables individual UART interrupt sources. More... | |
__STATIC_INLINE void | UARTIntDisable (uint32_t ui32Base, uint32_t ui32IntFlags) |
Disables individual UART interrupt sources. More... | |
__STATIC_INLINE uint32_t | UARTIntStatus (uint32_t ui32Base, bool bMasked) |
Gets the current interrupt status. More... | |
__STATIC_INLINE void | UARTIntClear (uint32_t ui32Base, uint32_t ui32IntFlags) |
Clears UART interrupt sources. More... | |
__STATIC_INLINE void | UARTDMAEnable (uint32_t ui32Base, uint32_t ui32DMAFlags) |
Enable UART DMA operation. More... | |
__STATIC_INLINE void | UARTDMADisable (uint32_t ui32Base, uint32_t ui32DMAFlags) |
Disable UART DMA operation. More... | |
__STATIC_INLINE uint32_t | UARTRxErrorGet (uint32_t ui32Base) |
Gets current receiver errors. More... | |
__STATIC_INLINE void | UARTRxErrorClear (uint32_t ui32Base) |
Clears all reported receiver errors. More... | |
__STATIC_INLINE void UARTBreakCtl | ( | uint32_t | ui32Base, |
bool | bBreakState | ||
) |
Causes a BREAK to be sent.
ui32Base | is the base address of the UART port. |
bBreakState | controls the output level.
|
__STATIC_INLINE bool UARTBusy | ( | uint32_t | ui32Base | ) |
Determines whether the UART transmitter is busy or not.
Allows the caller to determine whether all transmitted bytes have cleared the transmitter hardware. If false
is returned, the transmit FIFO is empty and all bits of the last transmitted character, including all stop bits, have left the hardware shift register.
ui32Base | is the base address of the UART port. |
true
: UART is transmitting.false
: All transmissions are complete. int32_t UARTCharGet | ( | uint32_t | ui32Base | ) |
Waits for a character from the specified port.
This function gets a character from the receive FIFO for the specified port. If there are no characters available, this function waits until a character is received before returning.
ui32Base | is the base address of the UART port. |
int32_t
. int32_t UARTCharGetNonBlocking | ( | uint32_t | ui32Base | ) |
Receives a character from the specified port.
This function gets a character from the receive FIFO for the specified port.
ui32Base | is the base address of the UART port. |
int32_t
. A -1
is returned if there are no characters present in the receive FIFO.void UARTCharPut | ( | uint32_t | ui32Base, |
uint8_t | ui8Data | ||
) |
Waits to send a character from the specified port.
This function sends the character ui8Data
to the transmit FIFO for the specified port. If there is no space available in the transmit FIFO, this function waits until there is space available before returning.
ui32Base | is the base address of the UART port. |
ui8Data | is the character to be transmitted. |
bool UARTCharPutNonBlocking | ( | uint32_t | ui32Base, |
uint8_t | ui8Data | ||
) |
Sends a character to the specified port.
This function writes the character ui8Data
to the transmit FIFO for the specified port. This function does not block, so if there is no space available, then a false
is returned, and the application must retry the function later.
ui32Base | is the base address of the UART port. |
ui8Data | is the character to be transmitted. |
true
: The character was successfully placed in the transmit FIFO.false
: There was no space available in the transmit FIFO. Try again later. __STATIC_INLINE bool UARTCharsAvail | ( | uint32_t | ui32Base | ) |
Determines if there are any characters in the receive FIFO.
This function returns a flag indicating whether or not there is data available in the receive FIFO.
ui32Base | is the base address of the UART port. |
true
: There is data in the receive FIFO.false
: There is no data in the receive FIFO. void UARTConfigGetExpClk | ( | uint32_t | ui32Base, |
uint32_t | ui32UARTClk, | ||
uint32_t * | pui32Baud, | ||
uint32_t * | pui32Config | ||
) |
Gets the current configuration of a UART.
The baud rate and data format for the UART is determined, given an explicitly provided peripheral clock (hence the ExpClk suffix). The returned baud rate is the actual baud rate; it may not be the exact baud rate requested or an "official" baud rate. The data format returned in pui32Config
is enumerated the same as the ui32Config
parameter of UARTConfigSetExpClk().
ui32Base | is the base address of the UART port. |
ui32UARTClk | is the rate of the clock supplied to the UART module. |
pui32Baud | is a pointer to storage for the baud rate. |
pui32Config | is a pointer to storage for the data format. |
void UARTConfigSetExpClk | ( | uint32_t | ui32Base, |
uint32_t | ui32UARTClk, | ||
uint32_t | ui32Baud, | ||
uint32_t | ui32Config | ||
) |
Sets the configuration of a UART.
This function configures the UART for operation in the specified data format.
ui32Base | is the base address of the UART port. |
ui32UARTClk | is the rate of the clock supplied to the UART module. |
ui32Baud | is the desired baud rate. |
ui32Config | is the data format for the port. The parameter is the bitwise OR of three values:
|
void UARTDisable | ( | uint32_t | ui32Base | ) |
Disables transmitting and receiving.
This function clears the UARTEN, TXE, and RXE bits, waits for the end of transmission of the current character, and flushes the transmit FIFO.
ui32Base | is the base address of the UART port. |
Definition at line 179 of file uart.c.
Referenced by UARTConfigSetExpClk().
__STATIC_INLINE void UARTDMADisable | ( | uint32_t | ui32Base, |
uint32_t | ui32DMAFlags | ||
) |
Disable UART DMA operation.
This function is used to disable UART DMA features that were enabled by UARTDMAEnable(). The specified UART DMA features are disabled.
ui32Base | is the base address of the UART port. |
ui32DMAFlags | is a bit mask of the DMA features to disable. The parameter is the bitwise OR of any of the following values:
|
__STATIC_INLINE void UARTDMAEnable | ( | uint32_t | ui32Base, |
uint32_t | ui32DMAFlags | ||
) |
Enable UART DMA operation.
The specified UART DMA features are enabled. The UART can be configured to use DMA for transmit or receive, and to disable receive if an error occurs.
ui32Base | is the base address of the UART port. |
ui32DMAFlags | is a bit mask of the DMA features to enable. The parameter is the bitwise OR of any of the following values:
|
__STATIC_INLINE void UARTEnable | ( | uint32_t | ui32Base | ) |
__STATIC_INLINE void UARTFIFODisable | ( | uint32_t | ui32Base | ) |
__STATIC_INLINE void UARTFIFOEnable | ( | uint32_t | ui32Base | ) |
void UARTFIFOLevelGet | ( | uint32_t | ui32Base, |
uint32_t * | pui32TxLevel, | ||
uint32_t * | pui32RxLevel | ||
) |
Gets the FIFO level at which interrupts are generated.
This function gets the FIFO level at which transmit and receive interrupts are generated.
ui32Base | is the base address of the UART port. |
pui32TxLevel | is a pointer to storage for the transmit FIFO level, returned as one of: |
pui32RxLevel | is a pointer to storage for the receive FIFO level, returned as one of: |
__STATIC_INLINE void UARTFIFOLevelSet | ( | uint32_t | ui32Base, |
uint32_t | ui32TxLevel, | ||
uint32_t | ui32RxLevel | ||
) |
Sets the FIFO level at which interrupts are generated.
This function sets the FIFO level at which transmit and receive interrupts are generated.
ui32Base | is the base address of the UART port. |
ui32TxLevel | is the transmit FIFO interrupt level, specified as one of: |
ui32RxLevel | is the receive FIFO interrupt level, specified as one of: |
__STATIC_INLINE void UARTIntClear | ( | uint32_t | ui32Base, |
uint32_t | ui32IntFlags | ||
) |
Clears UART interrupt sources.
The specified UART interrupt sources are cleared, so that they no longer assert. This function must be called in the interrupt handler to keep the interrupt from being recognized again immediately upon exit.
ui32Base | is the base address of the UART port. |
ui32IntFlags | is a bit mask of the interrupt sources to be cleared.
|
__STATIC_INLINE void UARTIntDisable | ( | uint32_t | ui32Base, |
uint32_t | ui32IntFlags | ||
) |
Disables individual UART interrupt sources.
This function disables the indicated UART interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.
ui32Base | is the base address of the UART port. |
ui32IntFlags | is the bit mask of the interrupt sources to be disabled.
|
__STATIC_INLINE void UARTIntEnable | ( | uint32_t | ui32Base, |
uint32_t | ui32IntFlags | ||
) |
Enables individual UART interrupt sources.
This function enables the indicated UART interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.
ui32Base | is the base address of the UART port. |
ui32IntFlags | is the bit mask of the interrupt sources to be enabled. The parameter is the bitwise OR of any of the following:
|
void UARTIntRegister | ( | uint32_t | ui32Base, |
void(*)(void) | pfnHandler | ||
) |
Registers an interrupt handler for a UART interrupt.
This function does the actual registering of the interrupt handler. This function enables the global interrupt in the interrupt controller; specific UART interrupts must be enabled via UARTIntEnable(). It is the interrupt handler's responsibility to clear the interrupt source.
ui32Base | is the base address of the UART port. |
pfnHandler | is a pointer to the function to be called when the UART interrupt occurs. |
__STATIC_INLINE uint32_t UARTIntStatus | ( | uint32_t | ui32Base, |
bool | bMasked | ||
) |
Gets the current interrupt status.
This function returns the interrupt status for the specified UART. Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned.
ui32Base | is the base address of the UART port. |
bMasked | selects either raw or masked interrupt.
|
void UARTIntUnregister | ( | uint32_t | ui32Base | ) |
Unregisters an interrupt handler for a UART interrupt.
This function does the actual unregistering of the interrupt handler. It clears the handler to be called when a UART interrupt occurs. This function also masks off the interrupt in the interrupt controller so that the interrupt handler no longer is called.
ui32Base | is the base address of the UART port. |
__STATIC_INLINE uint32_t UARTParityModeGet | ( | uint32_t | ui32Base | ) |
Gets the type of parity currently being used.
This function gets the type of parity used for transmitting data and expected when receiving data.
ui32Base | is the base address of the UART port. |
__STATIC_INLINE void UARTParityModeSet | ( | uint32_t | ui32Base, |
uint32_t | ui32Parity | ||
) |
Sets the type of parity.
This function sets the type of parity to use for transmitting and expect when receiving.
ui32Base | is the base address of the UART port. |
ui32Parity | specifies the type of parity to use. The last two allow direct control of the parity bit; it is always either one or zero based on the mode. |
__STATIC_INLINE void UARTRxErrorClear | ( | uint32_t | ui32Base | ) |
Clears all reported receiver errors.
This function is used to clear all receiver error conditions reported via UARTRxErrorGet(). If using the overrun, framing error, parity error or break interrupts, this function must be called after clearing the interrupt to ensure that later errors of the same type trigger another interrupt.
ui32Base | is the base address of the UART port. |
__STATIC_INLINE uint32_t UARTRxErrorGet | ( | uint32_t | ui32Base | ) |
Gets current receiver errors.
This function returns the current state of each of the 4 receiver error sources. The returned errors are equivalent to the four error bits returned via the previous call to UARTCharGet() or UARTCharGetNonBlocking() with the exception that the overrun error is set immediately the overrun occurs rather than when a character is next read.
ui32Base | is the base address of the UART port. |
__STATIC_INLINE bool UARTSpaceAvail | ( | uint32_t | ui32Base | ) |
Determines if there is any space in the transmit FIFO.
This function returns a flag indicating whether or not there is space available in the transmit FIFO.
ui32Base | is the base address of the UART port. |
true
: There is space available in the transmit FIFO.false
: There is no space available in the transmit FIFO. __STATIC_INLINE uint32_t UARTTxIntModeGet | ( | uint32_t | ui32Base | ) |
Returns the current operating mode for the UART transmit interrupt.
This function returns the current operating mode for the UART transmit interrupt.
ui32Base | is the base address of the UART port. |
__STATIC_INLINE void UARTTxIntModeSet | ( | uint32_t | ui32Base, |
uint32_t | ui32Mode | ||
) |
Sets the operating mode for the UART transmit interrupt.
This function allows the mode of the UART transmit interrupt to be set. By default, the transmit interrupt is asserted when the FIFO level falls past a threshold set via a call to UARTFIFOLevelSet(). Alternatively, if this function is called with ui32Mode
set to UART_TXINT_MODE_EOT, the transmit interrupt is asserted once the transmitter is completely idle - the transmit FIFO is empty and all bits, including any stop bits, have cleared the transmitter.
ui32Base | is the base address of the UART port. |
ui32Mode | is the operating mode for the transmit interrupt.
|
#define UART_BUSY 0x00000001 |
Definition at line 193 of file uart.h.
Referenced by UARTBusy().
#define UART_CONFIG_PAR_EVEN 0x00000006 |
Definition at line 131 of file uart.h.
Referenced by UARTParityModeSet().
#define UART_CONFIG_PAR_NONE 0x00000000 |
Definition at line 130 of file uart.h.
Referenced by UARTParityModeSet().
#define UART_CONFIG_PAR_ODD 0x00000002 |
Definition at line 132 of file uart.h.
Referenced by UARTParityModeSet().
#define UART_CONFIG_PAR_ONE 0x00000082 |
Definition at line 133 of file uart.h.
Referenced by UARTParityModeSet().
#define UART_CONFIG_PAR_ZERO 0x00000086 |
Definition at line 134 of file uart.h.
Referenced by UARTParityModeSet().
#define UART_FIFO_RX1_8 0x00000000 |
Definition at line 154 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_FIFO_RX2_8 0x00000008 |
Definition at line 155 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_FIFO_RX4_8 0x00000010 |
Definition at line 156 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_FIFO_RX6_8 0x00000018 |
Definition at line 157 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_FIFO_RX7_8 0x00000020 |
Definition at line 158 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_FIFO_TX1_8 0x00000000 |
Definition at line 142 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_FIFO_TX2_8 0x00000001 |
Definition at line 143 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_FIFO_TX4_8 0x00000002 |
Definition at line 144 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_FIFO_TX6_8 0x00000003 |
Definition at line 145 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_FIFO_TX7_8 0x00000004 |
Definition at line 146 of file uart.h.
Referenced by UARTFIFOLevelSet().
#define UART_IDLE 0x00000000 |
Definition at line 194 of file uart.h.
Referenced by UARTBusy().
#define UART_TXINT_MODE_EOT 0x00000010 |
Definition at line 186 of file uart.h.
Referenced by UARTTxIntModeGet(), and UARTTxIntModeSet().
#define UART_TXINT_MODE_FIFO 0x00000000 |
Definition at line 185 of file uart.h.
Referenced by UARTTxIntModeGet(), and UARTTxIntModeSet().