GPDMA#

sl_gpdma_callback_code_t#

sl_gpdma_callback_code_t

Enumeration that holds 8-bit codes used by the callback_type parameter in the sl_si91x_gpdma_unregister_callbacks function.

This enumeration defines the 8-bit codes for different types of DMA callbacks that can be unregistered.

sl_gpdma_callback_t#

typedef void(* sl_gpdma_callback_t) () )()

Callback function type.

sl_si91x_gpdma_descriptor_t#

typedef RSI_GPDMA_DESC_T sl_si91x_gpdma_descriptor_t

GPDMA descriptor structure.

sl_si91x_gpdma_data_context_t#

typedef GPDMA_DATACONTEXT_T sl_si91x_gpdma_data_context_t

GPDMA data context structure.

sl_si91x_gpdma_descriptor_config_t#

typedef sl_si91x_gpdma_descriptor_t sl_si91x_gpdma_descriptor_config_t

GPDMA descriptor configuration structure.

sl_si91x_gpdma_handle_t#

typedef RSI_GPDMA_HANDLE_T sl_si91x_gpdma_handle_t

GPDMA handle type.

sl_si91x_gpdma_channel_config_t#

typedef RSI_GPDMA_CHA_CFG_T sl_si91x_gpdma_channel_config_t

GPDMA channel configuration structure.

sl_si91x_gpdma_init_t#

typedef RSI_GPDMA_INIT_T sl_si91x_gpdma_init_t

GPDMA initialization structure.

sl_si91x_gpdma_transfer_complete_cb#

typedef gpdmaTransferCompleteCB sl_si91x_gpdma_transfer_complete_cb

GPDMA transfer complete callback type.

sl_si91x_gpdma_init#

sl_status_t sl_si91x_gpdma_init ()

To initialize the GPDMA peripheral.

This API

1. Enables the GPDMA clock

2. Clears GPDMA NVIC interrupt

3. Enables GPDMA NVIC interrupt

4. Masks GPDMA interruptsAssigns

5. Clears GPDMA interrupts

Returns

• sl_status_t Initialization status:

  • SL_STATUS_OK - Initialization success.

  • SL_STATUS_NOT_INITIALIZED - Initialization failed.

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

sl_si91x_gpdma_allocate_channel#

sl_status_t sl_si91x_gpdma_allocate_channel (uint32_t * channel_no, uint32_t priority, uint32_t max_transfer_size)

To allocate a GPDMA channel for the transfer.

This API checks the available GPDMA channels and allocates one. It sets the priority of the allocated channel and assigns the channel number to the channel_no variable. If no channel is available, it will return SL_GPDMA_NO_CHANNEL_AVAILABLE.

Note: Users can also initialize the desired channel number, and this API checks whether the desired channel is available and allocates the channel if available. If users want the driver to allocate an available channel, channel_no should be initialized to 0.

• Pre-condition:

  • sl_si91x_dma_init must be called prior.

Returns

• sl_status_t Channel allocation status:

  • SL_STATUS_OK - Channel allocated.

  • SL_STATUS_NOT_INITIALIZED - GPDMA not initialized.

  • SL_STATUS_INVALID_PARAMETER - Channel number is invalid.

  • SL_STATUS_GPDMA_NO_CHANNEL_AVAILABLE - All GPDMA channels are allocated.

  • SL_STATUS_GPDMA_CHANNEL_ALREADY_ALLOCATED - The desired channel is already allocated.

  • SL_STATUS_BUSY - Channel is busy.

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

sl_si91x_gpdma_deallocate_channel#

sl_status_t sl_si91x_gpdma_deallocate_channel (uint32_t channel_no)

To deallocate the GPDMA channel.

This API deallocates the GPDMA channel if there is no ongoing transfer on the channel. Deallocating the channel will also unregister the callbacks for transfer complete and error.

• Pre-conditions:

  • sl_si91x_gpdma_init must be called prior.

  • sl_si91x_gpdma_allocate_channel must be called prior.

Returns

• sl_status_t Channel deallocation status:

  • SL_STATUS_OK - Channel deallocated.

  • SL_STATUS_BUSY - Cannot deallocate channel due to an ongoing transfer.

  • SL_STATUS_NOT_INITIALIZED - GPDMA not initialized.

  • SL_STATUS_INVALID_PARAMETER - Channel number is invalid.

  • SL_STATUS_GPDMA_CHANNEL_ALREADY_UNALLOCATED - Channel already deallocated For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_gpdma_register_callbacks#

sl_status_t sl_si91x_gpdma_register_callbacks (uint32_t channel_no, sl_gpdma_callback_pointer_t * callback_t)

To register the GPDMA callbacks (transfer complete & error).

This API registers the GPDMA callbacks for transfer complete and error events. The user must update the sl_dma_callback_t structure and pass its address to this function. A separate callback can be present for transfer complete and error for each channel.

• Pre-conditions:

  • sl_si91x_gpdma_init must be called prior.

  • sl_si91x_gpdma_allocate_channel must be called prior.

Returns

• sl_status_t Callback registration status:

  • SL_STATUS_OK - Callback registered successfully.

  • SL_STATUS_NOT_INITIALIZED - GPDMA peripheral not initialized.

  • SL_STATUS_INVALID_PARAMETER - Invalid channel number.

  • SL_STATUS_NULL_POINTER - Callback pointer is NULL.

  • SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED - Given channel is not allocated.

  • SL_STATUS_BUSY - channel is busy.

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

sl_si91x_gpdma_unregister_callbacks#

sl_status_t sl_si91x_gpdma_unregister_callbacks (uint32_t channel_no, uint8_t callback_type)

To unregister the GPDMA callbacks (transfer complete and error).

This API unregisters the DMA callbacks for transfer complete and error events. Users need to update the 8-bit variable callback_type and pass it to the function. Each bit is mapped to a specific callback.

• Pre-conditions:

  • sl_si91x_gpdma_init must be called prior.

  • sl_si91x_gpdma_allocate_channel must be called prior.

  • sl_si91x_gpdma_register_callbacks must be called prior.

Returns

• sl_status_t Callback unregistration status:

  • SL_STATUS_OK - Callback unregistered successfully.

  • SL_STATUS_NOT_INITIALIZED - GPDMA peripheral not initialized.

  • SL_STATUS_INVALID_PARAMETER - Invalid channel number or callback type.

  • SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED - Given channel is not allocated.

  • SL_STATUS_BUSY - Channel is busy.

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

sl_si91x_gpdma_transfer#

sl_status_t sl_si91x_gpdma_transfer (uint32_t channel, void * src, void * dest)

To start a simple memory-to-memory DMA transfer.

This API configures the DMA channel descriptor and initiates a simple memory-to-memory DMA transfer. Users need to pass the source address and destination address of the transfer along with the channel number.

• Pre-conditions:

  • sl_si91x_gpdma_init must be called prior.

  • sl_si91x_gpdma_allocate_channel must be called prior.

  • sl_si91x_gpdma_register_callbacks must be called prior.

Returns

• sl_status_t DMA transfer status:

  • SL_STATUS_OK - Transfer success.

  • SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED - Given channel is not allocated.

  • SL_STATUS_NOT_INITIALIZED - GPDMA peripheral not initialized.

  • SL_STATUS_SUSPENDED - Transfer initialization failed.

  • SL_STATUS_INVALID_PARAMETER - Channel number is invalid or source or destination is NULL.

  • SL_STATUS_BUSY - Channel is busy.

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

sl_si91x_gpdma_stop_transfer#

sl_status_t sl_si91x_gpdma_stop_transfer (uint32_t channel_no)

To stop the GPDMA transfer.

This API stops any active transfer on the channel by disabling the GPDMA channel. If there is no active transfer on the channel, this function returns SL_STATUS_IDLE.

• Pre-conditions:

  • sl_si91x_gpdma_init must be called prior.

  • sl_si91x_gpdma_allocate_channel must be called prior.

  • sl_si91x_gpdma_transfer must be called prior.

Returns

• sl_status_t DMA transfer status:

  • SL_STATUS_OK - Transfer stopped successfully.

  • SL_STATUS_IDLE - There is no active transfer on the channel.

  • SL_STATUS_NOT_INITIALIZED - GPDMA peripheral not initialized.

  • SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED - Given channel is not allocated.

  • SL_STATUS_INVALID_PARAMETER - Invalid channel number.

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

sl_si91x_gpdma_allocate_descriptor#

sl_status_t sl_si91x_gpdma_allocate_descriptor (sl_si91x_gpdma_descriptor_t * pDesc_memory, uint32_t transfer_size, uint32_t channel_number)

Allocates a GPDMA descriptor with default config for given channel based on tranfer size.

This function allocates GPDMA descriptor in the provided memory location, fills the descriptors with default values, and attaches it to the given channel. The descriptor is configured for the specified transfer size and channel number.

Returns

• sl_status_t

  • SL_STATUS_OK: Descriptor successfully allocated and initialized.

  • SL_STATUS_GPDMA_DESCRIPTOR_MEMORY_BUFFER_NOT_SUFFICIENT: descriptor memory buffer size is not sufficient.

  • SL_STATUS_GPDMA_DESCRIPTOR_MEMORY_BUFFER_ALREADY_ALLOCATED : descriptor memory buffer already allocated to given channel.

  • SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED: Given channel is not allocated.

  • SL_STATUS_INVALID_PARAMETER: Invalid input parameters.

  • SL_STATUS_BUSY - Channel is busy. For more information on status codes, see SL STATUS DOCUMENTATION.

sl_Si91x_gpdma_deallocate_descriptor#

sl_status_t sl_Si91x_gpdma_deallocate_descriptor (uint32_t channel_number)

Deallocates a DMA descriptor for the specified channel number.

This function deallocates a previously allocated DMA descriptor associated with the given channel number.

• Pre-condition:

  • sl_si91x_gpdma_init must be called prior.

  • sl_si91x_gpdma_allocate_descriptor must be called prior.

Returns

• sl_status_t SL_STATUS_OK if the descriptor was successfully deallocated, SL_STATUS_INVALID_PARAMETER if the channel number is invalid, SL_STATUS_BUSY if the transfer is still in progress in given channel, SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED given channel is not allocated,

Note

• The channel must be disabled before calling this function to avoid unpredictable behavior. For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_gpdma_build_descriptor#

sl_status_t sl_si91x_gpdma_build_descriptor (sl_si91x_gpdma_descriptor_t * pDescriptor_memory, sl_si91x_gpdma_descriptor_config_t * pDesc_config, uint32_t transfer_size, uint32_t channel_number)

Builds a GPDMA descriptor with the specified configuration.

This function initializes a GPDMA descriptor with the provided configuration. The descriptor can then be used for GPDMA operations.

Returns

• Status of the operation.

  • SL_STATUS_OK: If the descriptor was successfully built.

  • SL_STATUS_INVALID_PARAMETER: If any of the input parameters are invalid.

  • SL_STATUS_GPDMA_DESCRIPTOR_MEMORY_BUFFER_NOT_SUFFICIENT: descriptor memory buffer size is not sufficient.

  • SL_STATUS_GPDMA_DESCRIPTOR_MEMORY_BUFFER_ALREADY_ALLOCATED : descriptor memory buffer already allocated to given channel.

  • SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED: Given channel is not allocated.

  • SL_STATUS_BUSY - Channel is busy. For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_gpdma_allocate_fifo#

sl_status_t sl_si91x_gpdma_allocate_fifo (uint32_t channel_no, uint32_t fifo_size)

Allocates a FIFO buffer of the specified size to a GPDMA channel.

This function allocates a FIFO (First In, First Out) buffer of the specified size to the selected GPDMA channel.

Returns

• Status of the operation.

  • SL_STATUS_OK: If the FIFO was successfully allocated.

  • SL_STATUS_INVALID_PARAMETER: If the channel number is invalid or the FIFO size is not supported.

  • SL_STATUS_GPDMA_FIFO_MEMORY_NOT_AVAILABLE: If the FIFO memory is not available.

  • SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED: Given channel is not allocated.

  • SL_STATUS_BUSY - Channel is busy.

Note

• The availability of channels and maximum FIFO size may vary based on hardware configuration. For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_get_channel_fifo_size#

sl_status_t sl_si91x_get_channel_fifo_size (uint32_t channel_no, uint32_t * fifo_size)

Gets the FIFO size of a specified GPDMA channel.

This function retrieves the FIFO buffer size configured for the specified GPDMA channel.

Returns

• sl_status_t SL_STATUS_OK if successful, SL_STATUS_INVALID_PARAMETER if channel number is invalid, SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED if given channel is not allocated.

Note

• The channel number should be within the valid range of available GPDMA channels.

sl_si91x_gpdma_get_channel_status#

sl_status_t sl_si91x_gpdma_get_channel_status (uint32_t channel_number)

Gets the current status of a specified GPDMA channel.

This function retrieves the status of the specified GPDMA channel.

Returns

• status of the operation.

  • SL_STATUS_OK: If the channel is free.

  • SL_STATUS_BUSY: If the transfer is in progress for given channel.

  • SL_STATUS_GPDMA_CHANNEL_NOT_ALLOCATED: If the channel is not allocated.

  • SL_STATUS_GPDMA_CHANNEL_ALREADY_ALLOCATED: If the channel is already allocated.