Functions | |
__STATIC_INLINE uint32_t | Cy_SCB_UART_Put (CySCB_Type *base, uint32_t data) |
Places a single data element in the UART TX FIFO. More... | |
__STATIC_INLINE uint32_t | Cy_SCB_UART_PutArray (CySCB_Type *base, void *buffer, uint32_t size) |
Places an array of data in the UART TX FIFO. More... | |
__STATIC_INLINE void | Cy_SCB_UART_PutArrayBlocking (CySCB_Type *base, void *buffer, uint32_t size) |
Places an array of data in the UART TX FIFO. More... | |
__STATIC_INLINE void | Cy_SCB_UART_PutString (CySCB_Type *base, char_t const string[]) |
Places a NULL terminated string in the UART TX FIFO. More... | |
void | Cy_SCB_UART_SendBreakBlocking (CySCB_Type *base, uint32_t breakWidth) |
Sends a break condition (logic low) of specified width on UART TX line. More... | |
__STATIC_INLINE uint32_t | Cy_SCB_UART_Get (CySCB_Type const *base) |
Reads a single data element from the UART RX FIFO. More... | |
__STATIC_INLINE uint32_t | Cy_SCB_UART_GetArray (CySCB_Type const *base, void *buffer, uint32_t size) |
Reads an array of data out of the UART RX FIFO. More... | |
__STATIC_INLINE void | Cy_SCB_UART_GetArrayBlocking (CySCB_Type const *base, void *buffer, uint32_t size) |
Reads an array of data out of the UART RX FIFO. More... | |
__STATIC_INLINE uint32_t | Cy_SCB_UART_GetTxFifoStatus (CySCB_Type const *base) |
Returns the current status of the TX FIFO. More... | |
__STATIC_INLINE void | Cy_SCB_UART_ClearTxFifoStatus (CySCB_Type *base, uint32_t clearMask) |
Clears the selected statuses of the TX FIFO. More... | |
__STATIC_INLINE uint32_t | Cy_SCB_UART_GetRxFifoStatus (CySCB_Type const *base) |
Returns the current status of the RX FIFO. More... | |
__STATIC_INLINE void | Cy_SCB_UART_ClearRxFifoStatus (CySCB_Type *base, uint32_t clearMask) |
Clears the selected statuses of the RX FIFO. More... | |
__STATIC_INLINE uint32_t | Cy_SCB_UART_GetNumInTxFifo (CySCB_Type const *base) |
Returns the number of data elements in the UART TX FIFO. More... | |
__STATIC_INLINE bool | Cy_SCB_UART_IsTxComplete (CySCB_Type const *base) |
Checks whether the TX FIFO and Shifter are empty and there is no more data to send. More... | |
__STATIC_INLINE uint32_t | Cy_SCB_UART_GetNumInRxFifo (CySCB_Type const *base) |
Returns the number of data elements in the UART RX FIFO. More... | |
__STATIC_INLINE void | Cy_SCB_UART_ClearRxFifo (CySCB_Type *base) |
Clears all data out of the UART RX FIFO. More... | |
__STATIC_INLINE void | Cy_SCB_UART_ClearTxFifo (CySCB_Type *base) |
Clears all data out of the UART TX FIFO. More... | |
__STATIC_INLINE uint32_t Cy_SCB_UART_Put | ( | CySCB_Type * | base, |
uint32_t | data | ||
) |
Places a single data element in the UART TX FIFO.
This function does not block and returns how many data elements were placed in the TX FIFO.
base | The pointer to the UART SCB instance. |
data | Data to put in the TX FIFO. The element size is defined by the data type, which depends on the configured data width. |
__STATIC_INLINE uint32_t Cy_SCB_UART_PutArray | ( | CySCB_Type * | base, |
void * | buffer, | ||
uint32_t | size | ||
) |
Places an array of data in the UART TX FIFO.
This function does not block. It returns how many data elements were placed in the TX FIFO.
base | The pointer to the UART SCB instance. |
buffer | The pointer to data to place in the TX FIFO. The element size is defined by the data type, which depends on the configured TX data width. |
size | The number of data elements to TX. |
__STATIC_INLINE void Cy_SCB_UART_PutArrayBlocking | ( | CySCB_Type * | base, |
void * | buffer, | ||
uint32_t | size | ||
) |
Places an array of data in the UART TX FIFO.
This function blocks until the number of data elements specified by the size is placed in the TX FIFO.
base | The pointer to the UART SCB instance. |
buffer | The pointer to data to place in the TX FIFO. The element size is defined by the data type, which depends on the configured data width. |
size | The number of data elements to write into the TX FIFO. |
__STATIC_INLINE void Cy_SCB_UART_PutString | ( | CySCB_Type * | base, |
char_t const | string[] | ||
) |
Places a NULL terminated string in the UART TX FIFO.
This function blocks until the entire string is placed in the TX FIFO.
base | The pointer to the UART SCB instance. |
string | The pointer to the null terminated string array. |
void Cy_SCB_UART_SendBreakBlocking | ( | CySCB_Type * | base, |
uint32_t | breakWidth | ||
) |
Sends a break condition (logic low) of specified width on UART TX line.
Blocks until break is completed. Only call this function when UART TX FIFO and shifter are empty.
base | The pointer to the UART SCB instance. |
breakWidth | Width of break condition. Valid range is the TX data width (4 to 16 bits) |
__STATIC_INLINE uint32_t Cy_SCB_UART_Get | ( | CySCB_Type const * | base | ) |
Reads a single data element from the UART RX FIFO.
This function does not check whether the RX FIFO has data before reading it. If the RX FIFO is empty, the function returns CY_SCB_UART_RX_NO_DATA.
base | The pointer to the UART SCB instance. |
__STATIC_INLINE uint32_t Cy_SCB_UART_GetArray | ( | CySCB_Type const * | base, |
void * | buffer, | ||
uint32_t | size | ||
) |
Reads an array of data out of the UART RX FIFO.
This function does not block. It returns how many data elements were read from the RX FIFO.
base | The pointer to the UART SCB instance. |
buffer | The pointer to the location to place the data read from the RX FIFO. The element size is defined by the data type, which depends on the configured data width. |
size | The number of data elements to read from the RX FIFO. |
__STATIC_INLINE void Cy_SCB_UART_GetArrayBlocking | ( | CySCB_Type const * | base, |
void * | buffer, | ||
uint32_t | size | ||
) |
Reads an array of data out of the UART RX FIFO.
This function blocks until the number of data elements specified by the size has been read from the RX FIFO.
base | The pointer to the UART SCB instance. |
buffer | The pointer to the location to place the data read from the RX FIFO. The element size is defined by the data type, which depends on the configured data width. |
size | The number of data elements to read from the RX FIFO. |
__STATIC_INLINE uint32_t Cy_SCB_UART_GetTxFifoStatus | ( | CySCB_Type const * | base | ) |
Returns the current status of the TX FIFO.
base | The pointer to the UART SCB instance. |
__STATIC_INLINE void Cy_SCB_UART_ClearTxFifoStatus | ( | CySCB_Type * | base, |
uint32_t | clearMask | ||
) |
Clears the selected statuses of the TX FIFO.
base | The pointer to the UART SCB instance. |
clearMask | The mask whose statuses to clear. See UART TX FIFO Statuses for the set of constants. |
__STATIC_INLINE uint32_t Cy_SCB_UART_GetRxFifoStatus | ( | CySCB_Type const * | base | ) |
Returns the current status of the RX FIFO.
base | The pointer to the UART SCB instance. |
__STATIC_INLINE void Cy_SCB_UART_ClearRxFifoStatus | ( | CySCB_Type * | base, |
uint32_t | clearMask | ||
) |
Clears the selected statuses of the RX FIFO.
base | The pointer to the UART SCB instance. |
clearMask | The mask whose statuses to clear. See UART RX FIFO status. for the set of constants. |
__STATIC_INLINE uint32_t Cy_SCB_UART_GetNumInTxFifo | ( | CySCB_Type const * | base | ) |
Returns the number of data elements in the UART TX FIFO.
base | The pointer to the UART SCB instance. |
__STATIC_INLINE bool Cy_SCB_UART_IsTxComplete | ( | CySCB_Type const * | base | ) |
Checks whether the TX FIFO and Shifter are empty and there is no more data to send.
base | Pointer to the UART SCB instance. |
__STATIC_INLINE uint32_t Cy_SCB_UART_GetNumInRxFifo | ( | CySCB_Type const * | base | ) |
Returns the number of data elements in the UART RX FIFO.
base | The pointer to the UART SCB instance. |
__STATIC_INLINE void Cy_SCB_UART_ClearRxFifo | ( | CySCB_Type * | base | ) |
Clears all data out of the UART RX FIFO.
base | The pointer to the UART SCB instance. |
__STATIC_INLINE void Cy_SCB_UART_ClearTxFifo | ( | CySCB_Type * | base | ) |
Clears all data out of the UART TX FIFO.
base | The pointer to the UART SCB instance. |