PSoC 6 Peripheral Driver Library

General Description

Functions

void Cy_SCB_UART_Interrupt (CySCB_Type *base, cy_stc_scb_uart_context_t *context)
 This is the interrupt function for the SCB configured in the UART mode. More...
 
__STATIC_INLINE void Cy_SCB_UART_RegisterCallback (CySCB_Type const *base, cy_cb_scb_uart_handle_events_t callback, cy_stc_scb_uart_context_t *context)
 Registers a callback function that notifies that UART Callback Events occurred in the Cy_SCB_UART_Interrupt. More...
 

Function Documentation

◆ Cy_SCB_UART_Interrupt()

void Cy_SCB_UART_Interrupt ( CySCB_Type base,
cy_stc_scb_uart_context_t context 
)

This is the interrupt function for the SCB configured in the UART mode.

This function must be called inside a user-defined interrupt service routine to make Cy_SCB_UART_Transmit and Cy_SCB_UART_Receive work. The ring buffer operation that enabled by calling Cy_SCB_UART_StartRingBuffer also requires interrupt processing.

Parameters
baseThe pointer to the UART SCB instance.
contextThe pointer to the context structure cy_stc_scb_uart_context_t allocated by the user. The structure is used during the UART operation for internal configuration and data retention. The user must not modify anything in this structure.

◆ Cy_SCB_UART_RegisterCallback()

__STATIC_INLINE void Cy_SCB_UART_RegisterCallback ( CySCB_Type const *  base,
cy_cb_scb_uart_handle_events_t  callback,
cy_stc_scb_uart_context_t context 
)

Registers a callback function that notifies that UART Callback Events occurred in the Cy_SCB_UART_Interrupt.

Parameters
baseThe pointer to the UART SCB instance.
callbackThe pointer to the callback function. See cy_cb_scb_uart_handle_events_t for the function prototype.
contextThe pointer to the context structure cy_stc_scb_uart_context_t allocated by the user. The structure is used during the UART operation for internal configuration and data retention. The user should not modify anything in this structure.
Note
To remove the callback, pass NULL as the pointer to the callback function.