USART#

usart_event_typedef_t#

usart_event_typedef_t

USART/UART Events.

power_mode_typedef_t#

power_mode_typedef_t

General power states.

usart_databits_typedef_t#

usart_databits_typedef_t

Databit selection.

usart_parity_typedef_t#

usart_parity_typedef_t

Parity selection.

usart_modem_control_typedef_t#

usart_modem_control_typedef_t

USART Modem control selection.

usart_stopbit_typedef_t#

usart_stopbit_typedef_t

Stop bits selection, used for asynchronous operation.

usart_hwflowcontol_typedef_t#

usart_hwflowcontol_typedef_t

Hardware Flow Control Selection.

usart_mode_typedef_t#

usart_mode_typedef_t

USART Mode selection.

usart_misc_control_typedef_t#

usart_misc_control_typedef_t

USART misc control selection.

sl_usart_signal_event_t#

typedef ARM_USART_SignalEvent_t sl_usart_signal_event_t

sl_usart_status_t#

typedef ARM_USART_STATUS sl_usart_status_t

sl_usart_power_state_t#

typedef ARM_POWER_STATE sl_usart_power_state_t

sl_usart_modem_control_t#

typedef ARM_USART_MODEM_CONTROL sl_usart_modem_control_t

sl_usart_modem_status_t#

typedef ARM_USART_MODEM_STATUS sl_usart_modem_status_t

sl_usart_capabilities_t#

typedef ARM_USART_CAPABILITIES sl_usart_capabilities_t

sl_usart_driver_t#

typedef ARM_DRIVER_USART sl_usart_driver_t

usart_resources_t#

typedef USART_RESOURCES usart_resources_t

sl_usart_handle_t#

typedef const void* sl_usart_handle_t

sl_si91x_usart_init#

sl_status_t sl_si91x_usart_init (usart_peripheral_t usart_instance, sl_usart_handle_t * usart_handle)

Initilize the USART/UART module.

This function will configure the clocks for USART/UART module and also initialization of the DMA for UART/USART, if DMA is enabled for data transfers.

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

• status 0 if successful, else error code as follows:

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

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

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

sl_si91x_usart_deinit#

sl_status_t sl_si91x_usart_deinit (sl_usart_handle_t usart_handle)

Uninitialize the USART/UART module.

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

Returns

• status 0 if successful, else error code as follows:

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

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

Note

• When USART/UART module is used in combination with other peripherals, while deinitializing in the application, refer to 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 below API to power down the particular power doamin if other periherals 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, refer to 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. Refer to rsi_power_save.h file for all power gates definitions.

sl_si91x_usart_register_event_callback#

sl_status_t sl_si91x_usart_register_event_callback (sl_usart_signal_event_t callback_event)

Register the user callback function.

If another callback is registered without unregistering previous callback then, it returns an error code, so it is mandatory to unregister the callback before registering to another callback.

• Pre-condition:

  • sl_si91x_usart_set_configuration

Returns

• status 0 if successful, else error code as follows:

  • SL_STATUS_OK (0x0000) - Success

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

  • SL_STATUS_BUSY (0x0004) - Driver is busy

sl_si91x_usart_unregister_event_callback#

void sl_si91x_usart_unregister_event_callback (void )

Unregister the user callback function.

Unregister the user callback function before regsitering new callback function.

Returns

• none

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)

This function registers the user callback function for multiple USART instances i.e., to use different instance (USART_O, UART_1, ULP_UART) this API need to use.

• Pre-condition:

  • sl_si91x_usart_set_configuration();

Returns

• status 0 if successful, else error code SL_STATUS_OK (0x0000) - Success
  SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer
  SL_STATUS_BUSY (0x0004) - Driver is busy
  

sl_si91x_usart_multiple_instance_unregister_event_callback#

void sl_si91x_usart_multiple_instance_unregister_event_callback (usart_peripheral_t usart_instance)

Unregister the user callback function in case of multiple USART instances.

Returns

• none

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)

Send the USART data when USART/UART is configured.

If DMA mode is set this function will configure the DMA channel and enables the DMA channel , then transfers the data pointed to it, else it fill the data to the transfer FIFO and transfer the data

• Pre-conditions:

  • sl_si91x_usart_init();

  • sl_si91x_usart_set_configuration();

Returns

• status 0 if successful, else error code SL_STATUS_INVALID_PARAMETER (0x0021) - The parameter is invalid argument SL_STATUS_FAIL (0x0001) - Fail , Data transfer failed SL_STATUS_BUSY (0x0004) - Busy ,already data transfer is going on SL_STATUS _OK (0X000) - Success ,UART/USART initialization done properly

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 the data in async mode when USART/UART is configured.

This function returns immediately(non blocking) and data transfer happens asyncronously. Once the data transfer compeletes, registered user callback get invoked

• Pre-conditions:

  • sl_si91x_usart_init();

  • sl_si91x_usart_set_configuration();

Returns

• status 0 if successful, else error code SL_STATUS_INVALID_PARAMETER (0x0021) - The parameter is invalid argument SL_STATUS_FAIL (0x0001) - Fail , Data transfer failed SL_STATUS_BUSY (0x0004) - Busy ,already data transfer is going on SL_STATUS _OK (0X000) - Success ,UART/USART initialization done properly

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 the data when USART/UART is configured.

If DMA mode is set, it 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

• status 0 if successful, else error code as follows:

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

  • SL_STATUS_FAIL (0x0001) - Fail, Data transfer failed

  • SL_STATUS_BUSY (0x0004) - Busy, already data transfer is going on

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

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 the data in async mode when USART/UART is configured.

This function returns immediately(Non blocking) and data reception happens asyncronously. Once the data reception compeletes, registered user callback get invoked

• Pre-conditions:

  • sl_si91x_usart_init();

  • sl_si91x_usart_set_configuration();

Returns

• status 0 if successful, else error code SL_STATUS_INVALID_PARAMETER (0x0021) - The parameter is invalid argument SL_STATUS_FAIL (0x0001) - Fail , Data transfer failed SL_STATUS_BUSY (0x0004) - Busy ,already data transfer is going on SL_STATUS _OK (0X000) - Success ,UART/USART initialization done properly

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 the data when USART in Synchronous mode is enabled.

This function sends and receives the data to and from usart transmitter and receiver in synchronous mode of operation. Configure the DMA channel and enables the DMA channel, if DMA mode is set and transfer's the data pointed to it else transfer the data from fifo.

• Pre-conditions:

  • sl_si91x_usart_init

  • sl_si91x_usart_set_configuration

Returns

• status 0 if successful, else error code as follows:

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

  • SL_STATUS_FAIL (0x0001) - Fail, Data transfer failed

  • SL_STATUS_BUSY (0x0004) - Busy, already data transfer is going on

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

Note

• This function to be used in USART mode only, i.e., synchronous mode only 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 will return the USART data transferred count.

Returns

• return the no 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 will return the USART/UART data received count

Returns

• return the no 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 configure 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 particular instance. When this macros are enabled configuration are taken directly from the UC and this parameter is not considered.

Returns

• status 0 if successful, else error code

  • SL_STATUS_BUSY (0x0004) - Busy ,already data transfer is going on

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

  • SL_STATUS_INVALID_MODE (0x0024) - USART Invalid mode of operation

  • SL_STATUS_NOT_SUPPORTED(0x000F) - Feature not supported

  • SL_STATUS _OK (0X000) - Success ,UART/USART initialization done properly

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)

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 will return USART/UART transfer and receive status Returns

• usart line status tx busy ,rx_busy, tx_underflow ,rx overflow, rx break, rx framing error rx parity error

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)

This function will set the USART modem control line.

Returns

• status 0 if successful, else error code

  • SL_STATUS_NOT_SUPPORTED(0x000F) - Feature not supported

  • SL_STATUS _OK (0x000) - Success ,UART/USART initialization done properly

sl_si91x_usart_get_modem_status#

sl_usart_modem_status_t sl_si91x_usart_get_modem_status (sl_usart_handle_t usart_handle)

This function return USART modem control status.

Returns

• usart modem status states are active or not

sl_si91x_usart_get_version#

sl_usart_version_t sl_si91x_usart_get_version (void )

This function is used to know the USART version.

Returns

• sl_usart_version_t type version

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)

Get the USART configurations set in the module such as baudrate, parity bit stop bits etc.

Returns

• status 0 if successful, else error code

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

  • SL_STATUS _OK (0x000) - Success ,UART/USART configurations retrieved successfully \