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)

Initialize USART/UART interface.

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)

Deinit USART/UART interface.

This function will disable the clocks for USART/UART module and also deinitialize 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

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.

• Pre-conditions:

  • 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 )

Un-register the user callback function.

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)

Start sending data to USART transmitter.

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

• 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_receive_data#

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

Start receiving data from USART receiver.

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 the 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_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)

Start sending/receiving data to/from USART transmitter/receiver.

This function will configure the DMA channel and enable the DMA channel, DMA if DMA mode is set and transfer's the data pointed to it.

• 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)

Get the USART/UART transfer data count.

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)

Get the USART/UART received data count.

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)

Configure the different configurations of USART Interface.

This function configure the USART in different configurations such as USART mode, Data Bits, Parity, stop bits, flow control and baud rate.

Returns

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

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

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

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

  • SL_STATUS_NOT_SUPPORTED (0x000F) - Feature not supported

  • SL_STATUS_OK (0x0000) - 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)

This is an internal function used to configure the different configurations of USART Interface, this API will not pick the configurations from USART UC.

This function configure the USART in different configurations such as USART mode, Data Bits, Parity, stop bits, flow control and baud rate.

Returns

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

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

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

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

  • SL_STATUS_NOT_SUPPORTED (0x000F) - Feature not supported

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

sl_si91x_usart_get_status#

sl_usart_status_t sl_si91x_usart_get_status (sl_usart_handle_t usart_handle)

Get USART 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)

Set USART Modem Control line state.

This function will set the USART modem control line.

Returns

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

  • SL_STATUS_NOT_SUPPORTED (0x000F) - Feature not supported

  • SL_STATUS_OK (0x0000) - 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)

Get USART Modem Control line state.

This function returns 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 )

Get the USART version.

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.

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

Returns

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

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

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