MESSAGE_CONSTRUCTION

interface message formating

Data Structures

struct  sl_wfx_header_t
 General Message header structure.
 
struct  sl_wfx_generic_message_t
 Generic message structure for all requests, confirmations and indications.
 
struct  sl_wfx_generic_confirmation_t
 Generic confirmation message with the body reduced to the status field.

Detailed Description

interface message formating

The WLAN API handles 3 types of messages. REQUEST, CONFIRMATION and INDICATION

msc_inline_mscgraph_3

WLAN can send an INDICATION message to the host at any time.
Host can send REQUEST to the WLAN and the WLAN will always answer to it (either immediately or after a while) with a CONFIRMATION.

A message is composed of a header and a body (see sl_wfx_generic_msg_t). In the rest of the API description, only the body is detailed for each message.


Data Structure Documentation

◆ sl_wfx_header_t

struct sl_wfx_header_t

General Message header structure.

Definition at line 111 of file wfm_general_api.h.

Data Fields
uint8_t id Contains the message Id indexed by sl_wfx_general_commands_ids_t or sl_wfx_message_ids_t.
uint8_t info TODO comment missing.
uint16_t length Message length in bytes including this uint16_t.

Maximum value is 8188 but maximum Request size is FW dependent and reported in the sl_wfx_startup_ind_body_t::size_inp_ch_buf.

◆ sl_wfx_generic_message_t

struct sl_wfx_generic_message_t

Generic message structure for all requests, confirmations and indications.

Definition at line 122 of file wfm_general_api.h.

Data Fields
uint8_t body[] variable size payload of the message
sl_wfx_header_t header 4 bytes header

◆ sl_wfx_generic_confirmation_t

struct sl_wfx_generic_confirmation_t

Generic confirmation message with the body reduced to the status field.

This structure is not related to a specific confirmation ID.
It is a global simplified structure that can be used to easily access the header and status fields.

All confirmation bodies start with a status word and in a lot of them it is followed by other data (not present in this structure).

Definition at line 135 of file wfm_general_api.h.

Data Fields
sl_wfx_header_t header 4 bytes header
uint32_t status See enum sl_wfx_status_t and (wsm_status or wfm_status)