Synchronous Serial Interface#

ssi_event_typedef_t#

ssi_event_typedef_t

Enumeration for different SSI callback events.

ssi_peripheral_clock_mode_t#

ssi_peripheral_clock_mode_t

Enumeration for different SSI peripheral clock modes.

sl_ssi_instance_t#

sl_ssi_instance_t

Enumeration for different SSI peripheral device modes.

sl_ssi_slave_number_t#

sl_ssi_slave_number_t

Enumeration for SSI Slave numbers.

sl_ssi_power_state_t#

typedef ARM_POWER_STATE sl_ssi_power_state_t

renaming arm power state structure

sl_ssi_status_t#

typedef ARM_SPI_STATUS sl_ssi_status_t

renaming arm SPI status

sl_ssi_driver_t#

typedef ARM_DRIVER_SPI sl_ssi_driver_t

Renaming SSI driver structure.

sl_ssi_handle_t#

typedef const void* sl_ssi_handle_t

SSI Handle to be passed into APIs.

sl_ssi_signal_event_t#

typedef ARM_SPI_SignalEvent_t sl_ssi_signal_event_t

Callback typedef for SSI.

release#

uint8_t sl_ssi_version_t::release

Release version number.

major#

uint8_t sl_ssi_version_t::major

sqa version number

minor#

uint8_t sl_ssi_version_t::minor

dev version number

bit_width#

uint8_t sl_ssi_control_config_t::bit_width

bit width either 8 or 16 bit

device_mode#

uint32_t sl_ssi_control_config_t::device_mode

mode such as Master or Slave mode

clock_mode#

uint32_t sl_ssi_control_config_t::clock_mode

clock mode such as CPOL0 CPHA1

baud_rate#

uint32_t sl_ssi_control_config_t::baud_rate

baud rate for SSI

receive_sample_delay#

uint32_t sl_ssi_control_config_t::receive_sample_delay

Delay for receive input signal.

division_factor#

uint16_t sl_ssi_clock_config_t::division_factor

Clock Division Factor.

intf_pll_500_control_value#

uint16_t sl_ssi_clock_config_t::intf_pll_500_control_value

intf PLL control value

intf_pll_clock#

uint32_t sl_ssi_clock_config_t::intf_pll_clock

intf PLL clock frequency

intf_pll_reference_clock#

uint32_t sl_ssi_clock_config_t::intf_pll_reference_clock

intf PLL reference clock frequency

soc_pll_clock#

uint32_t sl_ssi_clock_config_t::soc_pll_clock

SoC PLL Clock frequency.

soc_pll_reference_clock#

uint32_t sl_ssi_clock_config_t::soc_pll_reference_clock

SoC PLL reference clock frequency.

soc_pll_mm_count_value#

uint8_t sl_ssi_clock_config_t::soc_pll_mm_count_value

SoC PLL count value.

sl_si91x_ssi_configure_clock#

sl_status_t sl_si91x_ssi_configure_clock (sl_ssi_clock_config_t * clock_config)

Configure the SSI clock.

Returns

• status 0 if successful, else error code as follow.

  • SL_STATUS_OK (0x0000) - Success, timer clock-source parameters configured properly

sl_si91x_ssi_init#

sl_status_t sl_si91x_ssi_init (sl_ssi_instance_t instance, sl_ssi_handle_t * ssi_handle)

Initialize the SSI master.

Returns

• status 0 if successful, else error code as follow.

  • SL_STATUS_OK (0x0000) - Success, otherwise fail error code as follow

sl_si91x_ssi_deinit#

sl_status_t sl_si91x_ssi_deinit (sl_ssi_handle_t ssi_handle)

Uninitialize the SSI primary.

Returns

• status 0 if successful, else error code as follow.

  • SL_STATUS_OK (0x0000) - Success, otherwise fail error code as follow

sl_si91x_ssi_set_configuration#

sl_status_t sl_si91x_ssi_set_configuration (sl_ssi_handle_t ssi_handle, sl_ssi_control_config_t * control_configuration, sl_ssi_slave_number_t slave_number)

Control the SPI interface.

Returns

• status 0 if successful, else error code as follow.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - invalid parameters

  • SL_STATUS_OK (0x0000) - Success

sl_si91x_ssi_receive_data#

sl_status_t sl_si91x_ssi_receive_data (sl_ssi_handle_t ssi_handle, void * data, uint32_t data_length)

Start receiving data from the SPI interface.

Returns

• status 0 if successful, else error code as follow.

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

  • SL_STATUS_OK (0x0000) - Success

sl_si91x_ssi_send_data#

sl_status_t sl_si91x_ssi_send_data (sl_ssi_handle_t ssi_handle, const void * data, uint32_t data_length)

Start sending data from SPI interface.

Returns

• status 0 if successful, else error code as follow.

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

  • SL_STATUS_OK (0x0000) - Success

sl_si91x_ssi_transfer_data#

sl_status_t sl_si91x_ssi_transfer_data (sl_ssi_handle_t ssi_handle, const void * data_out, void * data_in, uint32_t data_length)

Start sending/receiving bi-directional full duplex data to/from SPI secondary.

Returns

• status 0 if successful, else error code as follow.

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

  • SL_STATUS_OK (0x0000) - Success, otherwise error code as follow on failure.

sl_si91x_ssi_get_status#

sl_ssi_status_t sl_si91x_ssi_get_status (sl_ssi_handle_t ssi_handle)

Get the SSI status.

Returns

• busy, data lost or mode fault returns as a bit field.

sl_si91x_ssi_get_version#

sl_ssi_version_t sl_si91x_ssi_get_version (void )

Get the driver version.

Returns

• driver version.

sl_si91x_ssi_get_rx_data_count#

uint32_t sl_si91x_ssi_get_rx_data_count (sl_ssi_handle_t ssi_handle)

Get RX transferred data count with connected device.

Returns

• transferred data count

sl_si91x_ssi_get_tx_data_count#

uint32_t sl_si91x_ssi_get_tx_data_count (sl_ssi_handle_t ssi_handle)

Get TX transferred data count with connected device.

Returns

• transferred data count

sl_si91x_ssi_register_event_callback#

sl_status_t sl_si91x_ssi_register_event_callback (sl_ssi_handle_t ssi_handle, sl_ssi_signal_event_t callback_event)

Register the user event callback.

It registers the callback, i.e., stores the callback function address and pass to the variable that is called in Interrupt Handler. If another callback is registered without unregistering previous callback then, it returns an error code as follow, so it is mandatory to unregister the callback before registering another callback.

Returns

• status 0 if successful, else error code as follow.

  • SL_STATUS_BUSY (0x0004) - The callback is already registered, unregister previous callback before registering new one.

  • SL_STATUS_OK (0x0000) - Success

sl_si91x_ssi_unregister_event_callback#

void sl_si91x_ssi_unregister_event_callback (void )

Unregister the user event callback.

It unregisters the callback, i.e., clears the callback function address and passes a NULL value to the variable.

sl_si91x_ssi_get_clock_division_factor#

uint32_t sl_si91x_ssi_get_clock_division_factor (sl_ssi_handle_t ssi_handle)

Get the clock division factor.

Returns

• factor(int32_t) Clock division factor

sl_si91x_ssi_get_frame_length#

uint32_t sl_si91x_ssi_get_frame_length (sl_ssi_handle_t ssi_handle)

Get the frame length (bit width).

Returns

• frame_length (uint32_t) Frame length

sl_si91x_ssi_get_tx_fifo_threshold#

uint32_t sl_si91x_ssi_get_tx_fifo_threshold (sl_ssi_handle_t ssi_handle)

To fetch the transfer fifo threshold value, this value controls the level of entries at which the transmit FIFO controller triggers an interrupt.

Returns

• Transfer fifo threshold (uint32_t) The value of transfer fifo threshold

sl_si91x_ssi_get_rx_fifo_threshold#

uint32_t sl_si91x_ssi_get_rx_fifo_threshold (sl_ssi_handle_t ssi_handle)

To fetch the receiver fifo threshold value, this value controls the level of entries at which the receive FIFO controller triggers an interrupt.

Returns

• Receiver fifo threshold (uint32_t) The value of receiver fifo threshold

sl_si91x_ssi_get_receiver_sample_delay#

uint32_t sl_si91x_ssi_get_receiver_sample_delay (sl_ssi_handle_t ssi_handle)

To fetch the receiver sample delay value, it used to delay the sample of the rxd input signal.

Each value represents a single ssi_clk delay on the sample of the rxd signal.

Returns

• Receiver sample delay (uint32_t) The value of receiver sample delay

sl_si91x_ssi_set_slave_number#

__STATIC_INLINE sl_status_t sl_si91x_ssi_set_slave_number (uint8_t number)

Set the secondary number in multi-secondary operation.

For single secondary also, this API needs to be called before transferring the data.

Returns

• none