USART#

usart_event_typedef_t#

usart_event_typedef_t

Enumeration for USART/UART events.

This enumeration defines the various events that can occur in the USART/UART interface. Each event corresponds to a specific condition or status change in the USART/UART operation.

power_mode_typedef_t#

power_mode_typedef_t

Enumeration for general power states used in this peripheral.

This enumeration defines the various power states that can be used to control the power mode of the peripheral. Each state corresponds to a specific power configuration.

usart_databits_typedef_t#

usart_databits_typedef_t

Enumeration for USART data bits configuration.

This enumeration defines the possible data bit configurations for the USART interface. The user can select the appropriate data bit setting based on their application requirements.

usart_parity_typedef_t#

usart_parity_typedef_t

Enumeration for USART parity selection.

This enumeration defines the possible parity configurations for the USART interface. The user can select the appropriate parity setting based on their application requirements.

usart_modem_control_typedef_t#

usart_modem_control_typedef_t

Enumeration for USART modem control selection.

This enumeration defines the possible modem control configurations for the USART interface. The user can select the appropriate modem control setting based on their application requirements.

usart_stopbit_typedef_t#

usart_stopbit_typedef_t

Enumeration for USART stop bits selection.

This enumeration defines the possible stop bit configurations for the USART interface, used for asynchronous operation. The user can select the appropriate stop bit setting based on their application requirements.

usart_hwflowcontol_typedef_t#

usart_hwflowcontol_typedef_t

Enumeration for hardware flow control selection.

This enumeration defines the possible hardware flow control configurations for the USART interface. The user can select the appropriate flow control setting based on their application requirements.

usart_mode_typedef_t#

usart_mode_typedef_t

Enumeration for USART mode selection.

This enumeration defines the possible modes of operation for the USART interface. It is crucial to tailor the communication channel to the specific requirements of a system.

usart_misc_control_typedef_t#

usart_misc_control_typedef_t

Enumeration for USART miscellaneous control selection.

Note

• UART provides the underlying serial communication, while IrDA enables the wireless transmission of that data using infrared light.

This enumeration defines the various miscellaneous control options available for the USART interface. These controls allow for fine-tuning and managing specific USART operations.

sl_usart_signal_event_t#

typedef ARM_USART_SignalEvent_t sl_usart_signal_event_t

Alias for ARM_USART_SignalEvent_t type.

sl_usart_status_t#

typedef ARM_USART_STATUS sl_usart_status_t

Alias for ARM_USART_Status type.

sl_usart_power_state_t#

typedef ARM_POWER_STATE sl_usart_power_state_t

Alias for ARM_POWER_STATE type.

sl_usart_modem_control_t#

typedef ARM_USART_MODEM_CONTROL sl_usart_modem_control_t

Alias for ARM_USART_MODEM_CONTROL type.

sl_usart_modem_status_t#

typedef ARM_USART_MODEM_STATUS sl_usart_modem_status_t

Alias for ARM_USART_MODEM_STATUS type.

sl_usart_capabilities_t#

typedef ARM_USART_CAPABILITIES sl_usart_capabilities_t

Alias for ARM_USART_CAPABILITIES type.

sl_usart_driver_t#

typedef ARM_DRIVER_USART sl_usart_driver_t

Alias for ARM_DRIVER_USART type.

usart_resources_t#

typedef USART_RESOURCES usart_resources_t

Alias for USART_RESOURCES type.

sl_usart_handle_t#

typedef const void* sl_usart_handle_t

Alias for a constant void pointer type, used as a handle for USART resources.

sl_si91x_usart_init#

sl_status_t sl_si91x_usart_init (usart_peripheral_t usart_instance, sl_usart_handle_t * usart_handle)

To initialize the USART/UART module.

This function configures the clocks for the USART/UART module and also initializes the DMA for UART/USART if DMA is enabled for data transfers.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, UART/USART initialization done properly.

  • SL_STATUS_FAIL (0x0001) - Function failed, UART/USART initialization failed.

  • SL_STATUS_NULL_POINTER (0x0022) - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_usart_deinit#

sl_status_t sl_si91x_usart_deinit (sl_usart_handle_t usart_handle)

To uninitialize the USART/UART module.

This function will disable the clocks for the USART/UART module and also de-initialize the DMA for UART/USART if DMA is enabled for data transfers.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, UART/USART deinitialization done properly.

  • SL_STATUS_FAIL (0x0001) - Fail, UART/USART deinitialization failed.

For more information on status codes, see SL STATUS DOCUMENTATION.

Note

• When the USART/UART module is used in combination with other peripherals, while deinitializing in the application, see the notes below:

  1. Whenever sl_si91x_usart_deinit() gets called, it will disable the clock for the peripheral. To power off the peripheral, we have to power down the power domain (PERI_EFUSE) which contains the different peripherals mentioned below: i.e., USART, UART, I2C, SSI Master, SSI Slave, Generic-SPI Master, I2S Master, I2S Slave, Micro-DMA Controller, Config Timer, Random-Number Generator, CRC Accelerator, SIO, QEI, MCPWM, and EFUSE. Use the below API to power down the particular power domain if other peripherals are not being used: sl_si91x_peri_efuse_power_down(power_down);

  2. A few peripherals (ULP Peripherals, UULP Peripherals, GPDMA, and SDIO-SPI) have separate domains; those can be powered down independently. For additional details, see the Power architecture section in the Hardware Reference Manual. Here, ULP_UART has a separate power domain ULPSS_PWRGATE_ULP_UART, which can be powered down independently. See the rsi_power_save.h file for all power gate definitions.

sl_si91x_usart_register_event_callback#

sl_status_t sl_si91x_usart_register_event_callback (sl_usart_signal_event_t callback_event)

To register the user callback function for USART events.

This API registers a user-defined callback function for USART events. If another callback is registered without unregistering the previous callback, it returns an error code. Therefore, it is mandatory to unregister the callback before registering another callback.

• Pre-condition:

  • sl_si91x_usart_set_configuration must be called prior.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

  • SL_STATUS_BUSY (0x0004) - Driver is busy.

  • SL_STATUS_NULL_POINTER (0x0022) - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_usart_unregister_event_callback#

void sl_si91x_usart_unregister_event_callback (void )

To unregister the user callback function for USART events.

This API unregisters a user-defined callback function for USART events. It is mandatory to unregister the current callback before registering a new one.

sl_si91x_usart_multiple_instance_register_event_callback#

sl_status_t sl_si91x_usart_multiple_instance_register_event_callback (usart_peripheral_t usart_instance, sl_usart_signal_event_t callback_event)

To register the user callback function for multiple USART instances.

This function registers a user-defined callback function for multiple USART instances (e.g., USART_0, UART_1, ULP_UART). This API should be used to handle different USART instances.

• Pre-condition:

  • sl_si91x_usart_set_configuration must be called prior.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

  • SL_STATUS_BUSY (0x0004) - Driver is busy.

  • SL_STATUS_NULL_POINTER (0x0022) - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_usart_multiple_instance_unregister_event_callback#

void sl_si91x_usart_multiple_instance_unregister_event_callback (usart_peripheral_t usart_instance)

To unregister the user callback function for multiple USART instances.

This function unregisters a user-defined callback function for multiple USART instances (e.g., USART_0, UART_1, ULP_UART). This API should be used to handle different USART instances.

sl_si91x_usart_send_data#

sl_status_t sl_si91x_usart_send_data (sl_usart_handle_t usart_handle, const void * data, uint32_t data_length)

To send the USART data when USART/UART is configured.

If DMA mode is set, this function will configure the DMA channel and enable the DMA channel, then transfer the data pointed to it. Otherwise, it fills the data to the transfer FIFO and transfers the data.

• Pre-conditions:

  • sl_si91x_usart_init();

  • sl_si91x_usart_set_configuration();

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, data transfer completed.

  • SL_STATUS_FAIL (0x0001) - Function failed, data transfer failed.

  • SL_STATUS_BUSY (0x0004) - Busy, data transfer is already in progress.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Invalid parameter.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_usart_async_send_data#

sl_status_t sl_si91x_usart_async_send_data (sl_usart_handle_t usart_handle, const void * data, uint32_t data_length)

To send data in async mode when USART/UART is configured.

This function returns immediately (non-blocking) and data transfer happens asynchronously. Once the data transfer completes, the registered user callback gets invoked.

• Pre-conditions:

  • sl_si91x_usart_init();

  • sl_si91x_usart_set_configuration();

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, data transfer completed.

  • SL_STATUS_FAIL (0x0001) - Function failed, data transfer failed.

  • SL_STATUS_BUSY (0x0004) - Busy, data transfer is already in progress.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Invalid parameter.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_usart_receive_data#

sl_status_t sl_si91x_usart_receive_data (sl_usart_handle_t usart_handle, void * data, uint32_t data_length)

To receive data when USART/UART is configured.

If DMA mode is set, this function configures the DMA channel, enables the DMA channel, and receives data via DMA. If DMA mode is not set, it receives the data from FIFO.

• Pre-conditions:

  • sl_si91x_usart_init

  • sl_si91x_usart_set_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, data received successfully.

  • SL_STATUS_FAIL (0x0001) - Function failed, data transfer failed.

  • SL_STATUS_BUSY (0x0004) - Busy, data transfer is already in progress.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Invalid parameter.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_usart_async_receive_data#

sl_status_t sl_si91x_usart_async_receive_data (sl_usart_handle_t usart_handle, void * data, uint32_t data_length)

To receive data in async mode when USART/UART is configured.

This function returns immediately (non-blocking) and data reception happens asynchronously. Once the data reception completes, the registered user callback gets invoked.

• Pre-conditions:

  • sl_si91x_usart_init();

  • sl_si91x_usart_set_configuration();

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, data received successfully.

  • SL_STATUS_FAIL (0x0001) - Function failed, data transfer failed.

  • SL_STATUS_BUSY (0x0004) - Busy, data transfer is already in progress.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Invalid parameter.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_usart_transfer_data#

sl_status_t sl_si91x_usart_transfer_data (sl_usart_handle_t usart_handle, const void * data_out, void * data_in, uint32_t data_length)

To send and receive data when USART in Synchronous mode is enabled.

This function sends and receives data to and from the USART transmitter and receiver in synchronous mode of operation. It configures the DMA channel and enables the DMA channel, if DMA mode is set, and transfers the data pointed to it; otherwise, it transfers the data from FIFO.

• Pre-conditions:

  • sl_si91x_usart_init

  • sl_si91x_usart_set_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, data transfer completed.

  • SL_STATUS_FAIL (0x0001) - Function failed, data transfer failed.

  • SL_STATUS_BUSY (0x0004) - Busy, data transfer is already in progress.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Invalid parameter.

For more information on status codes, see SL STATUS DOCUMENTATION.

Note

• This function is to be used in USART mode only (i.e., synchronous mode). In asynchronous mode, use sl_si91x_usart_receive_data() and sl_si91x_usart_send_data().

sl_si91x_usart_get_tx_data_count#

uint32_t sl_si91x_usart_get_tx_data_count (sl_usart_handle_t usart_handle)

To get the TX data count of USART/UART.

This function returns the number of bytes transferred by the USART/UART. It can be used to check the progress of data transmission.

Returns

• uint32_t The number of bytes transferred.

sl_si91x_usart_get_rx_data_count#

uint32_t sl_si91x_usart_get_rx_data_count (sl_usart_handle_t usart_handle)

To get the RX data count of USART/UART.

This function returns the number of bytes received by the USART/UART. It can be used to check the progress of data reception.

Returns

• uint32_t The number of bytes received.

sl_si91x_usart_set_configuration#

sl_status_t sl_si91x_usart_set_configuration (sl_usart_handle_t usart_handle, sl_si91x_usart_control_config_t * control_configuration)

To control and configure the USART/UART module in different configurations.

This function configures the USART in different configurations such as USART mode, data bits, parity, stop bits, flow control, and baud rate.

Note

• control_configuration - This parameter is used to pass the respective peripheral configuration when
  USART_UC, UART_UC, ULP_UART_UC macros are disabled for a particular instance. When these macros are enabled, configurations are taken directly from the UC and this parameter is not considered.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, UART/USART initialization done properly.

  • SL_STATUS_BUSY (0x0004) - Busy, data transfer is already in progress.

  • SL_STATUS_NOT_SUPPORTED (0x000F) - Feature not supported.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - The parameter is an invalid argument.

  • SL_STATUS_INVALID_MODE (0x0024) - USART invalid mode of operation.

For more information on status codes, see SL STATUS DOCUMENTATION.

sli_si91x_usart_set_non_uc_configuration#

sl_status_t sli_si91x_usart_set_non_uc_configuration (sl_usart_handle_t usart_handle, sl_si91x_usart_control_config_t * control_configuration)

To configure the USART interface with non-UC configurations.

This internal function configures the USART interface with different configurations, such as USART mode, data bits, parity, stop bits, flow control, and baud rate. This API will not pick the configurations from USART UC.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, UART/USART initialization done properly.

  • SL_STATUS_BUSY (0x0004) - Busy, data transfer is already in progress.

  • SL_STATUS_NOT_SUPPORTED (0x000F) - Feature not supported.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - The parameter is an invalid argument.

  • SL_STATUS_INVALID_MODE (0x0024) - USART invalid mode of operation.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_usart_get_status#

sl_usart_status_t sl_si91x_usart_get_status (sl_usart_handle_t usart_handle)

To get the USART/UART status.

This function returns the USART/UART transfer and receive status. It provides information about the current state of the USART/UART, including:

• TX busy

• RX busy

• TX underflow

• RX overflow

• RX break

• RX framing error

• RX parity error

Returns

• sl_usart_status_t The status of the USART/UART.

sl_si91x_usart_set_modem_control#

sl_status_t sl_si91x_usart_set_modem_control (sl_usart_handle_t usart_handle, sl_usart_modem_control_t control)

To set the USART modem control line.

This function sets the USART modem control line based on the provided control parameter.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, UART/USART initialization done properly.

  • SL_STATUS_NOT_SUPPORTED (0x000F) - Feature not supported.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_usart_get_modem_status#

sl_usart_modem_status_t sl_si91x_usart_get_modem_status (sl_usart_handle_t usart_handle)

To get the USART modem control status.

This function returns the status of the USART modem control lines, indicating whether the states are active or not.

Returns

• sl_usart_modem_status_t The status of the USART modem control lines.

sl_si91x_usart_get_version#

sl_usart_version_t sl_si91x_usart_get_version (void )

To get the USART version.

This function returns the version information of the USART driver. It can be used to check the driver version for compatibility and debugging purposes.

Returns

• sl_usart_version_t The version information of the USART driver.

sl_si91x_usart_get_configurations#

sl_status_t sl_si91x_usart_get_configurations (uint8_t usart_module, sl_si91x_usart_control_config_t * usart_config)

To get the USART configurations set in the module, such as baud rate, parity bit, stop bits, etc.

This function retrieves the current configurations of the specified USART module.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, UART/USART configurations retrieved successfully.

  • SL_STATUS_NULL_POINTER (0x0022) - Invalid NULL pointer received as argument.

For more information on status codes, see SL STATUS DOCUMENTATION.