interface message formating

Data Structures
struct	MsginfoBytes_t
	2 bytes view of the Message header information element

union	MsginfoUnion_t
	Different views of the Message header (HiMsgHdr_t) information element.

struct	HiMsgHdr_t
	General Message header structure.

struct	HiGenericMsg_t
	General message structure for all requests, confirmations and indications.

struct	HiGenericCnf_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

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 HiGenericMsg_t). In the rest of the API description, only the body is detailed for each message.

Data Structure Documentation

◆ MsginfoBytes_t

struct MsginfoBytes_t

2 bytes view of the Message header information element

Definition at line 78 of file general_api.h.

Data Fields
uint8_t	MsgId	Subset of ::U16msginfo_t containing the message Id indexed by HiGeneralCommandsIds_t, ::HiWsmCommandsIds_t or ::HI_WFM_COMMANDS_IDS.
uint8_t	MsgInfo	Subset of ::U16msginfo_t .

◆ MsginfoUnion_t

union MsginfoUnion_t

Different views of the Message header (HiMsgHdr_t) information element.

Definition at line 87 of file general_api.h.

Data Fields
U16msginfo_t	b	Message information bitfield view.
MsginfoBytes_t	t	View of ::U16msginfo_t as 2 bytes.
uint16_t	U16MsgInfo	View of ::U16msginfo_t as a 16 bits word.

◆ HiMsgHdr_t

struct HiMsgHdr_t

General Message header structure.

Definition at line 97 of file general_api.h.

Data Fields
uint16_t	MsgLen	Message length in bytes including this uint16_t. Maximum value is 8188 but maximum Request size is FW dependent and reported in the HiStartupIndBody_t::SizeInpChBuf.
MsginfoUnion_t	s	::U16msginfo_t

◆ HiGenericMsg_t

struct HiGenericMsg_t

General message structure for all requests, confirmations and indications.

Definition at line 106 of file general_api.h.

Data Fields
uint8_t	Body[1]	variable size payload of the message
HiMsgHdr_t	Header	4 bytes header

◆ HiGenericCnf_t

struct HiGenericCnf_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 120 of file general_api.h.

Data Fields
HiMsgHdr_t	Header	4 bytes header
uint32_t	Status	See enum HiStatus and ::WsmStatus or WfmStatus.

MESSAGE_CONSTRUCTION