Data Structures

Here are the data structures with brief descriptions:

[detail level 12]

_scanitem	Store the scan list and then later populate when creating the database
adv_data	Advertising data structure
adv_element	Advertisement data element
at_ble_addr_t	Blue-tooth Low Energy address Type
at_ble_char_presentation_t	Characteristic presentation format
at_ble_characteristic_changed_t
at_ble_characteristic_found_t
at_ble_characteristic_read_response_t
at_ble_characteristic_t	Characteristic structure
at_ble_characteristic_write_response_t
at_ble_conn_param_update_done_t
at_ble_conn_param_update_request_t
at_ble_connected_t	AT_BLE_CONNECTED message format
at_ble_connection_params_t	Connection parameters
at_ble_CSRK_t	Connection Signature Resolution Key
at_ble_descriptor_found_t
at_ble_disconnected_t
at_ble_discovery_complete_t
at_ble_encryption_request_t
at_ble_encryption_status_changed_t
at_ble_event_parameter_t
at_ble_gap_deviceinfo_t
at_ble_gap_irk_t	Identity Resolving Key
at_ble_gap_whitelist_t	White-list structure
at_ble_included_service_found_t
at_ble_included_service_t	Service Definition
at_ble_indication_confirmed_t
at_ble_indication_received_t
at_ble_IRK_t
at_ble_l2cap_rx_t
at_ble_LTK_t	Long Term Key
at_ble_max_PA_gain_value_t
at_ble_notification_received_t
at_ble_pair_done_t	Pairing done message
at_ble_pair_features_t	Pairing Features
at_ble_pair_key_request_t
at_ble_pair_request_t
at_ble_prf_date_time_t	Time profile information
at_ble_prf_server_error_ind_t	Message structure used to inform APP that an error has occurred in the profile server role task
at_ble_primary_service_found_t
at_ble_rand_addr_changed_t
at_ble_read_authorize_request_t
at_ble_resolv_rand_addr_status_t
at_ble_rx_power_value_t
at_ble_scan_info_t
at_ble_scan_report_t
at_ble_service_changed_notification_confirmed_t
at_ble_signature_info_t
at_ble_slave_sec_request_t
at_ble_spcp_t	Slave preferred connection parameters
at_ble_tx_power_set_t
at_ble_tx_power_value_t
at_ble_uuid_t	UUID type
at_ble_wifiprov_complete_ind
at_ble_wifiprov_scan_mode_change_ind_t
at_ble_write_authorize_request_t
at_key_info_t
att_desired_type	Desired UUID
att_info_data	Attribute data holder
att_uuid_type	UUID with different length Structure
bd_addr	BD Address structure
ble_custom_event_cb
ble_custom_event_cb_t	All BLE Custom event callback types
credentials
device_info
EcDomainParam
EcPoint
EFUSEProdStruct
event
gapc_con_max_PA_gain_get_ind
gapc_con_rssi_ind
gapc_con_tx_pow_get_ind
gapc_con_tx_pow_set_ind
gatt_lls_char_handler
gatt_service_handler	GATT service handles
gatt_txps_char_handler
genclk_config	Hardware representation of a set of generic clock parameters
in_addr	IPv4 address representation
llm_le_set_adv_data_cmd	LLM LE Set Advertising Data Command parameters structure
llm_le_set_adv_param_cmd	LLM LE Set Advertising Parameters Command parameters structure
llm_le_set_scan_param_cmd	LLM LE Set Scan Parameters Command parameters structure
llm_le_set_scan_rsp_data_cmd	LLM LE Set Scan Response Data Command parameters structure
peers_info
plf_params_t
fw_version
pll_config	Hardware-specific representation of PLL configuration
prf_date_time	Time profile information
prf_server_error_ind	Message structure used to inform APP that an error has occurred in the profile server role task
s_interrupt_source	Describes a PIO interrupt source, including the PIO instance triggering the interrupt and the associated interrupt handler
sam_uart_opt	Option list for UART peripheral initialization
sam_usart_opt_t
scan_rsp_data	Scan response data structure
sha256ctxt
sockaddr	Generic socket address structure
sockaddr_in	Socket address structure for IPV4 addresses. Used to specify socket address information to connect to. Can be cast to sockaddr structure
str_watched_event
StructCPtr	Structure of pointers to constant 64-, 32-, 16- and 8-bit unsigned integers
StructCVPtr	Structure of pointers to constant volatile 64-, 32-, 16- and 8-bit unsigned integers
StructPtr	Structure of pointers to 64-, 32-, 16- and 8-bit unsigned integers
StructVPtr	Structure of pointers to volatile 64-, 32-, 16- and 8-bit unsigned integers
tcc_module
tstr1xAuthCredentials
tstrAcceptReply
tstrAuth1xMschap2
tstrAuth1xTls
tstrAuthPsk
tstrAuthWep
tstrBindCmd
tstrBindReply
tstrCloseCmd
tstrConnectAlpnReply	Connect Reply, contains sock number, error value and index of negotiated application protocol
tstrConnectCmd
tstrConnectReply	Connect Reply, contains sock number and error value
tstrDnsReply	DNS Reply, contains hostName and HostIP
tstrEccReqInfo
tstrEcdhReqInfo
tstrECDomainParam	ECC Curve Domain Parameters
tstrEcdsaSignReqInfo
tstrEcdsaVerifyReqInfo
tstrECPoint	Elliptic Curve point representation
tstrEllipticCurve	Definition of an elliptic curve
tstrEthInitParam	Structure to hold Ethernet interface parameters. Structure is to be defined and have its attributes set, based on the application's functionality before a call is made to initialize the wi-fi operations by calling the m2m_wifi_init function. Part of the wi-fi configuration structure tstrWifiInitParam. Applications shouldn't need to define this structure, if the bypass mode is not defined
tstrFlashMapEntry
tstrGpRegs
tstrHifContext
tstrHifHdr	Structure to hold HIF header
tstrI2cMasterInitParam	I2C master configuration parameters
tstrListenCmd
tstrListenReply
tstrM2MAPConfig	This structure holds the configuration parameters for the AP mode. It should be set by the application when it requests to enable the AP operation mode. The AP mode currently supports only OPEN and WEP security
tstrM2MAPConfigExt	AP Configuration Extension
tstrM2MAPModeConfig	AP Configuration
tstrM2mBatteryVoltage	This struct stores the battery voltage
tstrM2mBleApiMsg	This struct contains a BLE message
tstrM2MBLEInfo	BLE Result
tstrM2mClientState	This struct contains the information for the PS Client state
tstrM2mConnCredCmn	Wi-Fi Connect Credentials Common section
tstrM2mConnCredHdr	Wi-Fi Connect Credentials Header
tstrM2MConnInfo	This struct contains the connection information
tstrM2MDefaultConnResp	This struct contains the response error of m2m_default_connect
tstrM2MDeviceNameConfig	This struct contains the Device Name of the WINC. It is used mainly for Wi-Fi Direct device discovery and WPS device information
tstrM2mEnableLogs	This struct stores logging information
tstrM2MGainTable	This struct contains the information of the gain table index from flash to be used
tstrM2MGainTableRsp	This struct contains response when the firmware has failed to configure the gains from flash
tstrM2MGenericResp	Generic success/error response
tstrM2MIPConfig	This struct contains the static IP configuration
tstrM2mIpCtrlBuf	Structure holding the incoming buffer's data size information, indicating the data size of the buffer and the remaining buffer's data size. The data of the buffer which holds the packet sent to the host when in the bypass mode, is placed in the tstrEthInitParam::au8ethRcvBuf attribute. This following information is retrieved in the host when an event M2M_WIFI_RESP_ETHERNET_RX_PACKET is received in the Wi-Fi callback function tpfAppWifiCb
tstrM2mIpRsvdPkt	This struct contains the size and data offset for the received packet
tstrM2mLsnInt	This struct contains the Listen Interval. It is the value of the Wi-Fi StA Listen Interval when power save is enabled. It is given in units of Beacon period. It is the number of Beacon periods the WINC can sleep before it wakes up to receive data buffered for it in the AP
tstrM2MMulticastMac	This struct contains the information from the Multicast filter
tstrM2MP2PConnect	This struct contains the Listen Channel for P2P connect
tstrM2MProvisionInfo	This struct contains the provisioning information obtained from the HTTP Provisioning server
tstrM2MProvisionModeConfig	This struct contains the provisioning mode configuration
tstrM2mPsType	This struct contains the Power Save configuration
tstrM2mPwrMode
tstrM2mPwrState	This struct stores the Power Save modes
tstrM2mReqScanResult	The Wi-Fi Scan results list is stored in firmware. This struct contains the index by which the application can request a certain scan result
tstrM2mRev	Structure holding firmware version parameters and build date/time
tstrM2MScan	This struct contains the Wi-Fi scan request
tstrM2mScanDone	This struct contains the Wi-Fi scan result
tstrM2MScanOption	This struct contains the configuration options for Wi-Fi scan
tstrM2MScanRegion	This struct contains the Wi-Fi information for the channel regions
tstrM2Mservercmd	This struct contains the information for the PS Server command
tstrM2mServerInit	This struct contains the information for the PS Server initialization
tstrM2mSetMacAddress	This struct contains the MAC address to be used. The WINC loads the mac address from the efuse by default to the WINC configuration memory, however, the application can overwrite the configuration memory with the mac address indicated from the Host
tstrM2mSha256Ctxt	SHA256 context data
tstrM2mSlpReqTime	This struct contains the sleep time for the Power Save request
tstrM2MSNTPConfig	SNTP Client Configuration
tstrM2MStopScanOption	This struct holds additional configuration options for Wi-Fi scan
tstrM2mTxPwrLevel	This struct stores the Tx Power levels
tstrM2mWifi1xHdr	Wi-Fi Authentication 802.1x header for parameters. The parameters (Domain, UserName, PrivateKey/Password) are appended to this structure
tstrM2mWifiApId	Specify an access point (by SSID)
tstrM2mWifiAuthInfoHdr	Generic Wi-Fi authentication information to be sent in a separate HIF message of type M2M_WIFI_IND_CONN_PARAM (preceding M2M_WIFI_REQ_CONN)
tstrM2mWifiConnectLegacy_1_2	Wi-Fi Connect Request IMPORTANT: This structure is required only for legacy M2M_WIFI_REQ_CONNECT messages. For general usage, this structure is replaced by tstrM2mWifiConnHdr
tstrM2mWifiConnHdr	Wi-Fi Connect Request (new format) for use with M2M_WIFI_REQ_CONN. This structure is sent across the HIF along with the relevant auth details. One of: tstrM2mWifiPsk tstrM2mWifiWep tstrM2mWifi1xHdr If further authentication details need to be sent (such as client certificate for 1x TLS), they are sent with header tstrM2mWifiAuthInfoHdr in a preceding HIF message of type M2M_WIFI_IND_CONN_PARAM
tstrM2MWifiMonitorModeCtrl	This struct contains the Wi-Fi Monitor Mode Filter. It sets the filtering criteria for WLAN packets when monitoring mode is enabled. The received packets matching the filtering parameters, are passed directly to the application
tstrM2mWifiPsk
tstrM2mWifiPskInfo	Passphrase and PSK for WPA(2) PSK
tstrM2mWiFiRoaming	Roaming related information
tstrM2MWifiRxPacketInfo	This struct contains the Wi-Fi RX Frame Header. The M2M application has the ability to allow Wi-Fi monitoring mode for receiving all Wi-Fi Raw frames matching a well defined filtering criteria. When a target Wi-Fi packet is received, the header information are extracted and assigned in this structure
tstrM2mWifiscanResult	This struct contains the information corresponding to an AP in the scan result list identified by its order (index) in the list
tstrM2MWifiSecInfoLegacy_1_2	Authentication credentials to connect to a Wi-Fi network. IMPORTANT: This structure is required only for legacy M2M_WIFI_REQ_CONNECT messages
tstrM2mWifiStateChanged	This struct contains the Wi-Fi connection state
tstrM2MWifiTxPacketInfo	This struct contains the Wi-Fi TX Packet Info. The M2M Application has the ability to compose raw Wi-Fi frames (under the application responsibility). When transmitting a Wi-Fi packet, the application must supply the firmware with this structure for sending the target frame
tstrM2mWifiWep	WEP security key header
tstrM2mWifiWepParams
tstrM2mWifiWepParamsLegacy_1_2	WEP security key parameters. IMPORTANT: This structure is required only for legacy M2M_WIFI_REQ_CONNECT messages
tstrM2MWPSConnect	This struct stores the WPS configuration parameters
tstrM2MWPSInfo	WPS Result
tstrNetworkId
tstrNmBusCapabilities	Structure holding bus capabilities information
tstrNmI2cDefault	Structure holding I2C default operation parameters
tstrNmI2cSpecial	Structure holding I2C special operation parameters
tstrNmSpiRw	Structure holding SPI R/W parameters
tstrNmUartDefault	Structure holding UART default operation parameters
tstrOtaControlSec	Control Section Structure. The Control Section is used to define the working image and the validity of the roll-back image and its offset, also both firmware versions are kept in this structure
tstrOtaInitHdr	This struct contains the OTA image header
tstrOtaUpdateInfo	This struct contains the OTA update information
tstrOtaUpdateStatusResp	This struct contains the OTA update status
tstrPerphInitParam	Peripheral module initialization parameters
tstrPingCmd
tstrPingReply
tstrPrng	M2M Request PRNG
tstrRecvCmd
tstrRecvReply
tstrRootCertEcdsaKeyInfo	Info about a ECDSA public key
tstrRootCertEntryHeader	Header of a root certificate entry in flash
tstrRootCertFlashHeader	Header of the root certificate flash storage area
tstrRootCertPubKeyInfo	Info about the public key contained in a root certificate
tstrRootCertRsaKeyInfo	Info about a RSA public key
tstrSendCmd
tstrSendReply	Send Reply, contains socket number and number of sent bytes
tstrSetSocketOptCmd
tstrSockAddr
tstrSockErr	Detail about socket failures. Used with get_error_detail
tstrSocket
tstrSocketAcceptMsg	Socket accept status
tstrSocketBindMsg	Socket bind status
tstrSocketConnectMsg	Socket connect status
tstrSocketListenMsg	Socket listen status
tstrSocketRecvMsg	Socket recv status
tstrSslSetActiveCsList
tstrSSLSetSockOptCmd
tstrSSLSocketCreateCmd
tstrSystemTime	This struct contains the system time
tstrTimer
tstrTlsSrvChunkHdr
tstrTlsSrvSecFileEntry	This struct contains a TLS certificate
tstrTlsSrvSecHdr	This struct contains a set of TLS certificates
tstrWakeTimer
tstrWifiInitParam	Structure, holding the Wi-fi configuration attributes such as the wi-fi callback , monitoring mode callback and Ethernet parameter initialization structure.
tuniM2MWifiAuthLegacy_1_2	Wi-Fi Security Parameters for all supported security modes. IMPORTANT: This structure is required only for legacy M2M_WIFI_REQ_CONNECT messages
uart_config_optical
uart_rs232_options	Input parameters when initializing RS232 and similar modes
Union16	16-bit union
Union32	32-bit union
Union64	64-bit union
UnionCPtr	Union of pointers to constant 64-, 32-, 16- and 8-bit unsigned integers
UnionCVPtr	Union of pointers to constant volatile 64-, 32-, 16- and 8-bit unsigned integers
UnionPtr	Union of pointers to 64-, 32-, 16- and 8-bit unsigned integers
UnionVPtr	Union of pointers to volatile 64-, 32-, 16- and 8-bit unsigned integers
usart_iso7816_opt_t
usart_spi_opt_t
wifiprov_scanlist_ind