Generic SPI#

gspi_event_typedef_t#

gspi_event_typedef_t

Enumeration for different GSPI callback events.

This enumeration defines the possible events that can trigger a GSPI callback. Each event corresponds to a specific condition or state in the GSPI operation.

sl_gspi_power_state_t#

sl_gspi_power_state_t

Enumeration for GSPI power states.

This enumeration defines the possible power states for the GSPI peripheral. Each state corresponds to a specific power mode that the GSPI can operate in.

Enumeration for GSPI power states.

clock_mode_typedef_t#

clock_mode_typedef_t

Enumeration for GSPI clock modes.

This enumeration defines the possible clock modes for the GSPI peripheral. Each mode corresponds to a specific combination of clock polarity (CPOL) and clock phase (CPHA).

master_mode_typedef_t#

master_mode_typedef_t

Enumeration for GSPI primary modes.

This enumeration defines the possible primary modes for the GSPI peripheral. Each mode indicates whether the GSPI is active or inactive in primary mode.

slave_select_mode_typedef_t#

slave_select_mode_typedef_t

Enumeration for GSPI secondary select modes.

This enumeration defines the possible secondary select modes for the GSPI peripheral. Each mode indicates how the secondary select (SS) signal is managed in primary mode.

sl_gspi_instance_t#

sl_gspi_instance_t

Enumeration for GSPI Primary instance.

This enumeration defines the GSPI Primary instance. It currently has one member, with a provision for future expansion.

sl_gspi_slave_number_t#

sl_gspi_slave_number_t

Enumeration for GSPI slave numbers.

This enumeration defines the possible slave numbers for the GSPI peripheral. Each value represents a specific slave device connected to the GSPI.

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)

This API is no longer supported due to the restriction on peripheral drivers to configuring clocks.

To configure the clock for the GSPI module.

This API sets the clock for the GSPI peripheral. It configures the PLL clock and SOC clock according to the values set by the user in the clock configuration structure.

Returns

• Status code indicating the result:

  • SL_STATUS_OK - Success.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_gspi_init#

sl_status_t sl_si91x_gspi_init (sl_gspi_instance_t instance, sl_gspi_handle_t * gspi_handle)

To initialize the GSPI module.

This API initializes the GSPI module. If DMA is enabled, it also initializes the DMA module. The API takes the address of a pointer to store the GSPI primary handle, which can be used for subsequent function calls.

Returns

• Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_BUSY - Driver is busy.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_gspi_deinit#

sl_status_t sl_si91x_gspi_deinit (sl_gspi_handle_t gspi_handle)

To uninitialize the GSPI module.

This API uninitializes the GSPI module. If DMA is enabled, it also uninitializes the DMA module.

• Pre-condition:

  • sl_si91x_gspi_init must be called before this function.

Returns

• Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_NULL_POINTER - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

Note

• When the GSPI module is used in combination with other peripherals, see the notes below while deinitializing in the application:

  1. Whenever sl_si91x_gspi_deinit() is called, it will disable the clock for the peripheral. To power off the peripheral, you must power down the power domain (PERI_EFUSE), which contains different peripherals mentioned below: USART, UART, I2C, SSI Primary, SSI Secondary, Generic-SPI Primary, I2S Primary, I2S Secondary, Micro-DMA Controller, Config Timer, Random-Number Generator, CRC Accelerator, SIO, QEI, MCPWM, and EFUSE. Use the following API to power down the particular power domain if other peripherals 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, see the Power architecture section in the Hardware Reference Manual. For example, ULP_UART has a separate power domain ULPSS_PWRGATE_ULP_UART, which can be powered down independently. Refer to the rsi_power_save.h file for all power gate 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)

To configure the GSPI module.

The GSPI control and configuration options are listed below:

• swap_read (enable/disable)

• swap_write (enable/disable)

• bit_width (1-16 bits)

• clock_mode (mode0/mode3)

• slave_select_mode (hw_output/sw)

• bitrate

Note

• Swap Read and Swap Write can be used only if the bit_width is configured as 16.

• Pre-conditions:

  • sl_si91x_gspi_init

Returns

• Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_FAIL - Function failed.

  • SL_STATUS_BUSY - Driver is busy.

  • SL_STATUS_NOT_SUPPORTED - Parameter is not supported.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - The parameter is a null pointer.

  • SL_STATUS_INVALID_MODE - Secondary select mode is invalid.

  • SL_STATUS_INVALID_TYPE - SPI frame format is not valid.

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

For more information on status codes, see SL STATUS DOCUMENTATION.

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)

To 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 the 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_init

  • sl_si91x_gspi_set_configuration

  • sl_si91x_gspi_set_slave_number

Returns

• Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_FAIL - Function failed.

  • SL_STATUS_BUSY - Driver is busy.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

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)

To send data to the secondary device.

If DMA is enabled, it configures the DMA channel and required parameters. When the sent data is equal to the 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_init

  • sl_si91x_gspi_set_configuration

  • sl_si91x_gspi_set_slave_number

Returns

• Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_FAIL - Function failed.

  • SL_STATUS_BUSY - Driver is busy.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

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)

To send and receive data to and from the secondary device simultaneously.

If DMA is enabled, it configures the DMA channel and required parameters. When the received data and sent data are equal to the 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_init

  • sl_si91x_gspi_set_configuration

  • sl_si91x_gspi_set_slave_number

Returns

• Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_FAIL - Function failed.

  • SL_STATUS_BUSY - Driver is busy.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_gspi_set_master_state#

sl_status_t sl_si91x_gspi_set_master_state (sl_gspi_handle_t gspi_handle, boolean_t value)

To set the primary state as active or inactive.

Sets the primary state (i.e., activate/deactivate). If the primary is not required in the application for a specific time, it can be turned on/off at runtime by using this API.

• Pre-conditions:

  • sl_si91x_gspi_init

Returns

• Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_BUSY - Driver is busy.

  • SL_STATUS_NULL_POINTER - The parameter is a null pointer.

  • SL_STATUS_INVALID_MODE - Mode is invalid (fails to activate primary).

For more information on status codes, see SL STATUS DOCUMENTATION.

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)

To register the user callback function for GSPI events.

At the time of the event, 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 code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_BUSY - Driver is busy.

  • SL_STATUS_NULL_POINTER - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_gspi_unregister_event_callback#

void sl_si91x_gspi_unregister_event_callback (void )

To unregister the user callback function for GSPI events.

This API unregisters the user callback function that was previously registered using sl_si91x_gspi_register_event_callback. It is mandatory to call this function before registering the callback again to avoid conflicts.

• Pre-condition:

  • sl_si91x_gspi_register_event_callback

sl_si91x_gspi_get_version#

sl_gspi_version_t sl_si91x_gspi_get_version (void )

To fetch the GSPI version.

This API reads and returns the current API version of GSPI.

Returns

• sl_gspi_version_t type structure containing the version information.

sl_si91x_gspi_get_status#

sl_gspi_status_t sl_si91x_gspi_get_status (sl_gspi_handle_t gspi_handle)

To get the transfer status of GSPI.

This API 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 the GSPI Primary.

• Pre-conditions:

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

To fetch the data receive count of the GSPI.

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

• Pre-conditions:

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

To get the transmit data count of GSPI.

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

• Pre-conditions:

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

To fetch the clock division factor.

The clock division factor is calculated based on the configured peripheral clock. It determines 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 )

To fetch the frame length, i.e., bit width.

This API fetches the frame length. 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)

To set the secondary number in multi-secondary operation.

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

Returns

• Status code indicating the result:

  • SL_STATUS_OK - Success

  • SL_STATUS_INVALID_PARAMETER - Invalid parameter

For more information on status codes, see SL STATUS DOCUMENTATION.