GENERAL_DRIVER_APIDRIVER_API

Functions

sl_status_t sl_wfx_send_configuration (const char *pds_data, uint32_t pds_data_length)
 Function to send PDS chunks.
 
sl_status_t sl_wfx_control_gpio (uint8_t gpio_label, uint8_t gpio_mode, uint32_t *value)
 Send a request to read or write a GPIO.
 
sl_status_t sl_wfx_prevent_rollback (uint32_t magic_word)
 Prevent Rollback request.
 
sl_status_t sl_wfx_shutdown (void)
 Shutdown the Wi-Fi chip.

Function Documentation

◆ sl_wfx_control_gpio()

sl_status_t sl_wfx_control_gpio ( uint8_t  gpio_label,
uint8_t  gpio_mode,
uint32_t *  value 
)

Send a request to read or write a GPIO.

Parameters
gpio_labelis the GPIO label to control (defined in the PDS)
gpio_modedefines how to read or set the GPIO
valuereturns the read value or the detailed error cause
Returns
SL_SUCCESS if the request has been sent correctly, SL_ERROR otherwise

Definition at line 1098 of file sl_wfx.c.

References sl_wfx_control_gpio_req_body_t::gpio_label, sl_wfx_control_gpio_req_body_t::gpio_mode, SL_WFX_CONTROL_GPIO_REQ_ID, sl_wfx_send_command(), sl_wfx_generic_confirmation_t::status, and WFM_STATUS_SUCCESS.

◆ sl_wfx_prevent_rollback()

sl_status_t sl_wfx_prevent_rollback ( uint32_t  magic_word)

Prevent Rollback request.

Parameters
magic_wordUsed to prevent mistakenly sent request to burn the OTP
Returns
SL_SUCCESS if the setting is applied correctly, SL_ERROR otherwise

Definition at line 1125 of file sl_wfx.c.

References sl_wfx_prevent_rollback_req_body_t::magic_word, SL_WFX_PREVENT_ROLLBACK_REQ_ID, and sl_wfx_send_command().

◆ sl_wfx_send_configuration()

sl_status_t sl_wfx_send_configuration ( const char *  pds_data,
uint32_t  pds_data_length 
)

Function to send PDS chunks.

Parameters
pds_dataData to be sent in the compressed PDS format
pds_data_lengthSize of the data to be sent
Returns
SL_SUCCESS if the configuration has been sent correctly, SL_ERROR otherwise
Note
The PDS (Platform Data Set) file contains the WF200 settings

Definition at line 1054 of file sl_wfx.c.

References sl_wfx_generic_message_t::body, sl_wfx_configuration_req_body_t::length, sl_wfx_configuration_req_body_t::pds_data, sl_wfx_allocate_command_buffer(), SL_WFX_CONFIGURATION_REQ_ID, sl_wfx_send_request(), and WFM_STATUS_SUCCESS.

Referenced by sl_wfx_init(), and sl_wfx_set_antenna_config().

◆ sl_wfx_shutdown()

sl_status_t sl_wfx_shutdown ( void  )

Shutdown the Wi-Fi chip.

Returns
SL_SUCCESS if the Wi-Fi chip has been shutdown correctly, SL_ERROR otherwise
Note
Send the shutdown command, clear the WUP bit and the GPIO WUP to enable the Wi-Fi chips to go to sleep

Definition at line 1143 of file sl_wfx.c.

References sl_wfx_allocate_command_buffer(), sl_wfx_send_request(), sl_wfx_set_wake_up_bit(), and SL_WFX_SHUT_DOWN_REQ_ID.

Referenced by sl_wfx_deinit().