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.

swap_read#

boolean_t sl_gspi_control_config_t::swap_read

true to enable and false to disable swap read

swap_write#

boolean_t sl_gspi_control_config_t::swap_write

true to enable and false to disable swap write

bit_width#

uint8_t sl_gspi_control_config_t::bit_width

Bit width either 8 bit or 16 bit.

clock_mode#

uint32_t sl_gspi_control_config_t::clock_mode

Mode 0 or Mode 3 of GSPI.

slave_select_mode#

uint32_t sl_gspi_control_config_t::slave_select_mode

Secondary select mode either software of hardware output.

bitrate#

uint32_t sl_gspi_control_config_t::bitrate

Bitrate for setting the clock division factor.

soc_pll_mm_count_value#

uint8_t sl_gspi_clock_config_t::soc_pll_mm_count_value

SoC PLL count value.

intf_pll_500_control_value#

uint16_t sl_gspi_clock_config_t::intf_pll_500_control_value

Int PLL control value.

intf_pll_clock#

uint32_t sl_gspi_clock_config_t::intf_pll_clock

Intf PLL clock frequency.

intf_pll_reference_clock#

uint32_t sl_gspi_clock_config_t::intf_pll_reference_clock

Intf PLL reference clock frequency.

soc_pll_clock#

uint32_t sl_gspi_clock_config_t::soc_pll_clock

SoC PLL clock frequency.

soc_pll_reference_clock#

uint32_t sl_gspi_clock_config_t::soc_pll_reference_clock

SoC PLL reference clock frequency.

division_factor#

uint16_t sl_gspi_clock_config_t::division_factor

Clock Division Factor.

release#

uint8_t sl_gspi_version_t::release

Release version number.

major#

uint8_t sl_gspi_version_t::major

sqa version number

minor#

uint8_t sl_gspi_version_t::minor

dev version number

sl_si91x_gspi_configure_clock#

sl_status_t sl_si91x_gspi_configure_clock (sl_gspi_clock_config_t * clock_configuration)

This API will configure the clock for GSPI module.

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)

This API will initializes the GSPI.

as partof GSPI initialization if the DMA is enabled, it also initializes the DMA module. Passing the address of the pointer for storing the GSPI master handle, which can be used in the future for other function calls.

• Pre-condition:

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

This API will Uninitialize the GSPI.

This will Uninitialize the GSPI and if the DMA is enabled, it also uninitializes the DMA module.

• Pre-condition:

  • sl_si91x_gspi_init

Returns

• status

  • SL_STATUS_OK (0x0000) - Success

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

Note

• When the GSPI module is used in combination with other peripherals, while de-initializing in the application, refer to the notes below:

  1. Whenever sl_si91x_gspi_deinit() gets called, it will power down the domain (PERI_EFUSE) which contains different peripherals mentioned below: 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. Since deinit power downs the PERI_EFUSE doamin, it's recommended to call the sl_si91x_gspi_deinit() API at the end of the application.

  2. Few peripherlas (ULP Peripherals, UULP Peripherals, GPDMA and SDIO-SPI) have seperate domains that can be powered down indepedently. For additional details, refer to the Power architecture section in the Hardware Reference Manual e.g., To power down ULP UART, use the API below: RSI_PS_M4ssPeriPowerDown(ULPSS_PWRGATE_ULP_UART); Here, ULP_UART has seperate power domain ULPSS_PWRGATE_ULP_UART, which can be power down indepedently. Refer to the rsi_power_save.h file for all power gates definitions.

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)

This API will be used to configure the GSPI module.

The GSPI control and configuration options are listed below:

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

This API will receives 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)

This API will 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)

This API will 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)

This API will set the master state as active or de-active.

Set the main state, i.e., activate/de-activate. If the master is not required in the application for a specific time, it can be turned on/off in runtime by using this API.

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

This API will 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 )

This API will Un-register the user callback function.

Note

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

• Pre-condition:

  • sl_si91x_gspi_register_event_callback

Returns

• none

sl_si91x_gspi_get_version#

sl_gspi_version_t sl_si91x_gspi_get_version (void )

This API will Gets the GSPI version.

This will read the current API vesion of GSPI and It returns same. 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)

This API will Get the transfer status GSPI.

It returns the sl_gspi_status_t type structure. The members are:

• Busy

• Data Lost

• Mode Fault It is 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)

This API will 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 )

This API will Get the transmit data count of GSPI.

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

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

This API will fetch the clock division factor.

The clock division factor is calculated on the based of peripheral clock configured. It decides the baud rate of GSPI. 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 )

This API will Fetch the frame length, i.e., bit width.

This will get the frame length and 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)

This API will 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