Generic SPI#

gspi_event_typedef_t#

gspi_event_typedef_t

Enumeration for different GSPI callback events.

sl_gspi_power_state_t#

sl_gspi_power_state_t

Enumeration for GSPI power state.

clock_mode_typedef_t#

clock_mode_typedef_t

Enumeration for GSPI clock modes.

master_mode_typedef_t#

master_mode_typedef_t

Enumeration for GSPI master modes.

slave_select_mode_typedef_t#

slave_select_mode_typedef_t

Enumeration for GSPI secondary select mode.

sl_gspi_instance_t#

sl_gspi_instance_t

Enumeration for GSPI Master instance, enum for one member, future provision is provided.

sl_gspi_slave_number_t#

sl_gspi_slave_number_t

Enumeration for GSPI secondary numbers.

sl_gspi_signal_event_t#

typedef ARM_SPI_SignalEvent_t sl_gspi_signal_event_t

Renamed signal event structure.

sl_gspi_status_t#

typedef ARM_SPI_STATUS sl_gspi_status_t

Renamed status structure.

sl_gspi_driver_t#

typedef ARM_DRIVER_SPI sl_gspi_driver_t

Renamed GSPI driver structure.

sl_gspi_handle_t#

typedef const void* sl_gspi_handle_t

Created GSPI handle type.

sl_si91x_gspi_configure_clock#

sl_status_t sl_si91x_gspi_configure_clock (sl_gspi_clock_config_t * clock_configuration)

Set the clock for the GSPI peripheral, Configures the PLL clock and SOC clock with the value set by the user in the clock configuration structure.

Returns

• status

  • SL_STATUS_OK (0x0000) - Success

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_FAIL (0x0001) - The function has failed

  • SL_STATUS_NOT_INITIALIZED (0x0011) - Clock is not initialized

sl_si91x_gspi_init#

sl_status_t sl_si91x_gspi_init (sl_gspi_instance_t instance, sl_gspi_handle_t * gspi_handle)

Initialize the GSPI.

If the DMA is enabled, it also initializes the DMA. Pass the address of the pointer for storing the GSPI master handle, which can be used in the future for other function calls.

• Pre-conditions:

  • sl_si91x_gspi_configure_clock

Returns

• status

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_BUSY (0x0004) - Driver is busy

sl_si91x_gspi_deinit#

sl_status_t sl_si91x_gspi_deinit (sl_gspi_handle_t gspi_handle)

Uninitialize the GSPI.

If the DMA is enabled, it also uninitializes the DMA.

• Pre-conditions:

  • sl_si91x_gspi_init

Returns

• status

  • SL_STATUS_OK (0x0000) - Success

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

sl_si91x_gspi_set_configuration#

sl_status_t sl_si91x_gspi_set_configuration (sl_gspi_handle_t gspi_handle, sl_gspi_control_config_t * control_configuration)

Control and configure the GSPI.

• The configurations are listed below:

  • swap_read (enable/disable)

  • swap_write (enable/disable)

  • bit_width (8_bit/16_bit)

  • clock_mode (mode0/mode3)

  • slave_select_mode (hw_output/sw)

  • bitrate

• Pre-conditions:

  • sl_si91x_gspi_configure_clock

  • sl_si91x_gspi_init

Returns

• status

  • SL_STATUS_OK (0x0000) - Success

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_FAIL (0x0001) - The function has failed

  • SL_STATUS_NOT_SUPPORTED (0x000F) - Parameter is not supported

  • SL_STATUS_BUSY (0x0004) - Driver is busy

  • SL_STATUS_INVALID_MODE (0x0024) - Secondary select Mode is invalid

  • SL_STATUS_INVALID_TYPE (0x0026) - SPI frame format is not valid

  • SL_STATUS_INVALID_RANGE (0x0028) - Data bits (frame length) are not in range

sl_si91x_gspi_receive_data#

sl_status_t sl_si91x_gspi_receive_data (sl_gspi_handle_t gspi_handle, void * data, uint32_t data_length)

Receive data from the secondary device.

If DMA is enabled, it configures the DMA channel and required parameters. When the received data is equal to data_length passed in this function, a callback event is generated which can be registered using sl_si91x_gspi_register_event_callback

• Pre-conditions:

  • sl_si91x_gspi_configure_clock

  • sl_si91x_gspi_init

  • sl_si91x_gspi_set_configuration

  • sl_si91x_gspi_set_slave_number

Returns

• status

  • SL_STATUS_OK (0x0000) - Success

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_FAIL (0x0001) - The function has failed

  • SL_STATUS_BUSY (0x0004) - Driver is busy

sl_si91x_gspi_send_data#

sl_status_t sl_si91x_gspi_send_data (sl_gspi_handle_t gspi_handle, const void * data, uint32_t data_length)

Send data to the secondary device.

If DMA is enabled, it configures the DMA channel and required parameters. When the send data is equal to data_length passed in this function, a callback event is generated which can be registered using sl_si91x_gspi_register_event_callback

• Pre-conditions:

  • sl_si91x_gspi_configure_clock

  • sl_si91x_gspi_init

  • sl_si91x_gspi_set_configuration

  • sl_si91x_gspi_set_slave_number

Returns

• status

  • SL_STATUS_OK (0x0000) - Success

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_FAIL (0x0001) - The function has failed

  • SL_STATUS_BUSY (0x0004) - Driver is busy

sl_si91x_gspi_transfer_data#

sl_status_t sl_si91x_gspi_transfer_data (sl_gspi_handle_t gspi_handle, const void * data_out, void * data_in, uint32_t data_length)

Send and receive data to the secondary device simultaneously.

If DMA is enabled, it configures the DMA channel and required parameters. When the received data and send data is equal to data_length passed in this function, a callback event is generated which can be registered using sl_si91x_gspi_register_event_callback

• Pre-conditions:

  • sl_si91x_gspi_configure_clock

  • sl_si91x_gspi_init

  • sl_si91x_gspi_set_configuration

  • sl_si91x_gspi_set_slave_number

Returns

• status

  • SL_STATUS_OK (0x0000) - Success

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_FAIL (0x0001) - The function has failed

  • SL_STATUS_BUSY (0x0004) - Driver is busy

sl_si91x_gspi_set_master_state#

sl_status_t sl_si91x_gspi_set_master_state (sl_gspi_handle_t gspi_handle, boolean_t value)

Set the main state, i.e., activate/de-activate the main.

• Pre-conditions:

  • sl_si91x_gspi_configure_clock

  • sl_si91x_gspi_init

Returns

• status

  • SL_STATUS_OK (0x0000) - Success

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

  • SL_STATUS_BUSY (0x0004) - Driver is busy

  • SL_STATUS_INVALID_MODE (0x0024) - Mode is invalid (Fails to activate master)

sl_si91x_gspi_register_event_callback#

sl_status_t sl_si91x_gspi_register_event_callback (sl_gspi_handle_t gspi_handle, sl_gspi_signal_event_t callback_event)

Register the user callback function.

At the time of events, the function passed in the parameter is called with the respective event as the parameter. Before calling this function again, it is mandatory to call the sl_si91x_gspi_unregister_event_callback function to unregister the callback, otherwise it returns SL_STATUS_BUSY error code.

Returns

• status

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

void sl_si91x_gspi_unregister_event_callback (void )

Un-register the user callback function.

It is mandatory to call this function before registering the callback again.

• Pre-conditions:

  • sl_si91x_gspi_register_event_callback

Returns

• none

sl_si91x_gspi_get_version#

sl_gspi_version_t sl_si91x_gspi_get_version (void )

Get the GSPI version.

It returns the API version of GSPI.

Returns

• (sl_gspi_version_t) type structure

sl_si91x_gspi_get_status#

sl_gspi_status_t sl_si91x_gspi_get_status (sl_gspi_handle_t gspi_handle)

Get the transfer status GSPI.

It returns the sl_gspi_status_t type structure. The members are:

• Busy

• Data Lost

• Mode Fault It is generally used to poll the busy status of GSPI Master.

• Pre-conditions:

  • sl_si91x_gspi_configure_clock

  • sl_si91x_gspi_init

  • sl_si91x_gspi_set_configuration

Returns

• sl_gspi_status_t type structure

sl_si91x_gspi_get_rx_data_count#

uint32_t sl_si91x_gspi_get_rx_data_count (sl_gspi_handle_t gspi_handle)

Get data receive count of the GSPI.

If a receive operation is started, this function can be used to get number of data bytes received.

• Pre-conditions:

  • sl_si91x_gspi_configure_clock

  • sl_si91x_gspi_init

  • sl_si91x_gspi_set_configuration

Returns

• uint32_t value of the RX data count

sl_si91x_gspi_get_tx_data_count#

uint32_t sl_si91x_gspi_get_tx_data_count (void )

Get the transmit data count of GSPI.

If a send operation is started, this function can be used to get number of data bytes send.

• Pre-conditions:

  • sl_si91x_gspi_configure_clock

  • sl_si91x_gspi_init

  • sl_si91x_gspi_set_configuration

Returns

• uint32_t value of the tx data count

sl_si91x_gspi_get_clock_division_factor#

int32_t sl_si91x_gspi_get_clock_division_factor (sl_gspi_handle_t gspi_handle)

Fetch the clock division factor.

Returns

• factor (int32_t) The value of the clock division factor

sl_si91x_gspi_get_frame_length#

uint32_t sl_si91x_gspi_get_frame_length (void )

Fetch the frame length, i.e., bit width.

The frame length ranges between 1 and 15.

Returns

• frame_length (uint32_t) The value of the frame length

sl_si91x_gspi_set_slave_number#

__STATIC_INLINE sl_status_t sl_si91x_gspi_set_slave_number (uint8_t number)

Set the secondary number in multi-secondary operation.

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

Returns

• none