general_api.h File Reference

This file contains the type definitions for WLAN general API structures, enums, and other types.

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.
 
union  HiGeneralCommandsIds_t
 General command message IDs.
 
struct  HiCapabilities_t
 Capabilities offered by the WLAN used in command HiStartupIndBody_t.
 
struct  HiOtpRegulSelModeInfo_t
 REGUL_SEL_MODE OTP field reported in command HiStartupIndBody_t.
 
struct  HiOtpPhyInfo_t
 OTP_PHY_INFO OTP field reported in command HiStartupIndBody_t.
 
struct  HiStartupIndBody_t
 Startup Indication message.
 
struct  HiConfigurationReqBody_t
 Configure the device.
 
struct  HiConfigurationCnfBody_t
 Confirmation message of CONFIGURATION command HiConfigurationReqBody_t.
 
struct  HiControlGpioReqBody_t
 Send a request to read or write a gpio identified by its label (that is defined in the PDS)
 
struct  HiControlGpioCnfBody_t
 Confirmation from request to read and write a gpio.
 
struct  HiRxStats_t
 RX stats from the GENERIC indication message HiGenericIndBody_t.
 
struct  HiGenericIndBody_t
 the Generic indication message.
 
struct  HiExceptionIndBody_t
 Exception indication message.
 
struct  HiErrorIndBody_t
 Error indication message.
 
struct  HiSetSlMacKeyReqBody_t
 Set the Secure Link MAC key.
 
struct  HiSetSlMacKeyCnfBody_t
 Confirmation for the Secure Link MAC key setting.
 
struct  HiSlExchangePubKeysReqBody_t
 Exchange Secure Link Public Keys.
 
struct  HiSlExchangePubKeysCnfBody_t
 Confirmation for exchange of Secure Link Public Keys.
 
struct  HiSlConfigureReqBody_t
 Configure Secure Link Layer.
 
struct  HiSlConfigureCnfBody_t
 Confirmation of Secure Link Layer configuration HiSlConfigureReqBody_t.
 
struct  HiPreventRollbackReqBody_t
 Prevent Rollback request.
 
struct  HiPreventRollbackCnfBody_t
 Confirmation of the Prevent Rollback request.

Typedefs

typedef HiMsgHdr_t HiShutDownReq_t
 SHUT_DOWN command.

Enumerations

enum  HiGeneralRequestsIds {
  HI_CONFIGURATION_REQ_ID =0x09,
  HI_CONTROL_GPIO_REQ_ID =0x26,
  HI_SET_SL_MAC_KEY_REQ_ID =0x27,
  HI_SL_EXCHANGE_PUB_KEYS_REQ_ID =0x28,
  HI_SL_CONFIGURE_REQ_ID =0x29,
  HI_PREVENT_ROLLBACK_REQ_ID =0x2a,
  HI_SHUT_DOWN_REQ_ID =0x32
}
 General request message IDs.
 
enum  HiGeneralConfirmationsIds {
  HI_CONFIGURATION_CNF_ID =0x09,
  HI_CONTROL_GPIO_CNF_ID =0x26,
  HI_SET_SL_MAC_KEY_CNF_ID =0x27,
  HI_SL_EXCHANGE_PUB_KEYS_CNF_ID =0x28,
  HI_SL_CONFIGURE_CNF_ID =0x29,
  HI_PREVENT_ROLLBACK_CNF_ID =0xe7
}
 General confirmation message IDs.
 
enum  HiGeneralIndicationsIds {
  HI_EXCEPTION_IND_ID =0xe0,
  HI_STARTUP_IND_ID =0xe1,
  HI_GENERIC_IND_ID =0xe3,
  HI_ERROR_IND_ID =0xe4
}
 General indications message IDs.
 
enum  HiStatus {
  HI_STATUS_SUCCESS = 0x0,
  HI_STATUS_FAILURE = 0x1,
  HI_INVALID_PARAMETER = 0x2,
  HI_STATUS_GPIO_WARNING = 0x3,
  HI_ERROR_UNSUPPORTED_MSG_ID = 0x4,
  SL_MAC_KEY_STATUS_SUCCESS = 0x5A,
  SL_MAC_KEY_STATUS_FAILED_KEY_ALREADY_BURNED = 0x6B,
  SL_MAC_KEY_STATUS_FAILED_RAM_MODE_NOT_ALLOWED = 0x7C,
  SL_MAC_KEY_STATUS_FAILED_UNKNOWN_MODE = 0x8D,
  SL_PUB_KEY_EXCHANGE_STATUS_SUCCESS = 0x9E,
  SL_PUB_KEY_EXCHANGE_STATUS_FAILED = 0xAF,
  PREVENT_ROLLBACK_CNF_SUCCESS = 0x1234,
  PREVENT_ROLLBACK_CNF_WRONG_MAGIC_WORD = 0x1256
}
 General confirmation possible values for returned 'Status' field.
 
enum  HiGpioMode {
  HI_GPIO_MODE_D0 = 0x0,
  HI_GPIO_MODE_D1 = 0x1,
  HI_GPIO_MODE_OD0 = 0x2,
  HI_GPIO_MODE_OD1 = 0x3,
  HI_GPIO_MODE_TRISTATE = 0x4,
  HI_GPIO_MODE_TOGGLE = 0x5,
  HI_GPIO_MODE_READ = 0x6
}
 Configure GPIO mode.
 
enum  HiGpioError {
  HI_GPIO_ERROR_0 = 0x0,
  HI_GPIO_ERROR_1 = 0x1,
  HI_GPIO_ERROR_2 = 0x2
}
 detailed error cause returned by CONTROL_GPIO confirmation message HiControlGpioCnfBody_t
 
enum  HiGenericIndicationType {
  HI_GENERIC_INDICATION_TYPE_RAW = 0x0,
  HI_GENERIC_INDICATION_TYPE_STRING = 0x1,
  HI_GENERIC_INDICATION_TYPE_RX_STATS = 0x2
}
 specifies the type of data reported by the indication message HiGenericIndBody_t
 
enum  WsmHiError {
  WSM_HI_ERROR_FIRMWARE_ROLLBACK = 0x0,
  WSM_HI_ERROR_FIRMWARE_DEBUG_ENABLED = 0x1,
  WSM_HI_ERROR_OUTDATED_SESSION_KEY = 0x2,
  WSM_HI_ERROR_INVALID_SESSION_KEY = 0x3,
  WSM_HI_ERROR_OOR_VOLTAGE = 0x4,
  WSM_HI_ERROR_PDS_VERSION = 0x5
}
 specifies the type of error reported by the indication message HiErrorIndBody_t
 
enum  SecureLinkState {
  SECURE_LINK_NA_MODE = 0x0,
  SECURE_LINK_UNTRUSTED_MODE = 0x1,
  SECURE_LINK_TRUSTED_MODE = 0x2,
  SECURE_LINK_TRUSTED_ACTIVE_ENFORCED = 0x3
}
 *Secure Link' device state
 
enum  SlMacKeyDest {
  SL_MAC_KEY_DEST_OTP = 0x78,
  SL_MAC_KEY_DEST_RAM = 0x87
}
 destination of the Secure Link MAC key, used by request message HiSetSlMacKeyReqBody_t
 
enum  SlConfigureSkeyInvld {
  SL_CONFIGURE_SKEY_INVLD_INVALIDATE = 0x87,
  SL_CONFIGURE_SKEY_INVLD_NOP = 0x00
}
 used in request message HiSlConfigureReqBody_t to trigger Session Key invalidation

This file contains the type definitions for WLAN general API structures, enums, and other types.

Definition in file general_api.h.