Defines

Modules
	CommonDefines

Macros
#define	M2M_MAJOR_SHIFT   (8)
#define	M2M_MINOR_SHIFT   (4)
#define	M2M_PATCH_SHIFT   (0)
#define	M2M_DRV_VERSION_SHIFT   (16)
#define	M2M_FW_VERSION_SHIFT   (0)
#define	M2M_GET_MAJOR(ver_info_hword)   ((uint8)((ver_info_hword) >> M2M_MAJOR_SHIFT) & 0xff)
#define	M2M_GET_MINOR(ver_info_hword)   ((uint8)((ver_info_hword) >> M2M_MINOR_SHIFT) & 0x0f)
#define	M2M_GET_PATCH(ver_info_hword)   ((uint8)((ver_info_hword) >> M2M_PATCH_SHIFT) & 0x0f)
#define	M2M_GET_FW_VER(ver_info_word)   ((uint16) ((ver_info_word) >> M2M_FW_VERSION_SHIFT))
#define	M2M_GET_DRV_VER(ver_info_word)   ((uint16) ((ver_info_word) >> M2M_DRV_VERSION_SHIFT))
#define	M2M_GET_DRV_MAJOR(ver_info_word)   M2M_GET_MAJOR(M2M_GET_DRV_VER(ver_info_word))
#define	M2M_GET_DRV_MINOR(ver_info_word)   M2M_GET_MINOR(M2M_GET_DRV_VER(ver_info_word))
#define	M2M_GET_DRV_PATCH(ver_info_word)   M2M_GET_PATCH(M2M_GET_DRV_VER(ver_info_word))
#define	M2M_GET_FW_MAJOR(ver_info_word)   M2M_GET_MAJOR(M2M_GET_FW_VER(ver_info_word))
#define	M2M_GET_FW_MINOR(ver_info_word)   M2M_GET_MINOR(M2M_GET_FW_VER(ver_info_word))
#define	M2M_GET_FW_PATCH(ver_info_word)   M2M_GET_PATCH(M2M_GET_FW_VER(ver_info_word))
#define	M2M_MAKE_VERSION(major, minor, patch)
#define	M2M_MAKE_VERSION_INFO(fw_major, fw_minor, fw_patch, drv_major, drv_minor, drv_patch)
#define	REL_19_5_2_VER   M2M_MAKE_VERSION_INFO(19,5,2,19,3,0)
#define	REL_19_5_1_VER   M2M_MAKE_VERSION_INFO(19,5,1,19,3,0)
#define	REL_19_5_0_VER   M2M_MAKE_VERSION_INFO(19,5,0,19,3,0)
#define	REL_19_4_6_VER   M2M_MAKE_VERSION_INFO(19,4,6,19,3,0)
#define	REL_19_4_5_VER   M2M_MAKE_VERSION_INFO(19,4,5,19,3,0)
#define	REL_19_4_4_VER   M2M_MAKE_VERSION_INFO(19,4,4,19,3,0)
#define	REL_19_4_3_VER   M2M_MAKE_VERSION_INFO(19,4,3,19,3,0)
#define	REL_19_4_2_VER   M2M_MAKE_VERSION_INFO(19,4,2,19,3,0)
#define	REL_19_4_1_VER   M2M_MAKE_VERSION_INFO(19,4,1,19,3,0)
#define	REL_19_4_0_VER   M2M_MAKE_VERSION_INFO(19,4,0,19,3,0)
#define	REL_19_3_1_VER   M2M_MAKE_VERSION_INFO(19,3,1,19,3,0)
#define	REL_19_3_0_VER   M2M_MAKE_VERSION_INFO(19,3,0,19,3,0)
#define	REL_19_2_2_VER   M2M_MAKE_VERSION_INFO(19,2,2,19,2,0)
#define	REL_19_2_1_VER   M2M_MAKE_VERSION_INFO(19,2,1,19,2,0)
#define	REL_19_2_0_VER   M2M_MAKE_VERSION_INFO(19,2,0,19,2,0)
#define	REL_19_1_0_VER   M2M_MAKE_VERSION_INFO(19,1,0,18,2,0)
#define	REL_19_0_0_VER   M2M_MAKE_VERSION_INFO(19,0,0,18,1,1)
#define	M2M_RELEASE_VERSION_MAJOR_NO   (19)
#define	M2M_RELEASE_VERSION_MINOR_NO   (5)
#define	M2M_RELEASE_VERSION_PATCH_NO   (2)
#define	M2M_RELEASE_VERSION_SVN_VERSION   (SVN_REVISION)
#define	M2M_MIN_REQ_DRV_VERSION_MAJOR_NO   (19)
#define	M2M_MIN_REQ_DRV_VERSION_MINOR_NO   (3)
#define	M2M_MIN_REQ_DRV_VERSION_PATCH_NO   (0)
#define	M2M_MIN_REQ_DRV_SVN_VERSION   (0)
#define	M2M_BUFFER_MAX_SIZE   (1600UL - 4)
#define	M2M_MAC_ADDRES_LEN   6
#define	M2M_ETHERNET_HDR_OFFSET   34
#define	M2M_ETHERNET_HDR_LEN   14
#define	M2M_MAX_SSID_LEN   33
#define	M2M_MAX_PSK_LEN   65
#define	M2M_MIN_PSK_LEN   9
#define	M2M_DEVICE_NAME_MAX   48
#define	M2M_LISTEN_INTERVAL   1
#define	MAX_HIDDEN_SITES   4
#define	M2M_1X_USR_NAME_MAX   21
#define	M2M_1X_PWD_MAX   41
#define	M2M_CUST_IE_LEN_MAX   252
#define	PWR_DEFAULT   PWR_HIGH
#define	M2M_CONFIG_CMD_BASE   1
#define	M2M_STA_CMD_BASE   40
#define	M2M_AP_CMD_BASE   70
#define	M2M_P2P_CMD_BASE   90
#define	M2M_SERVER_CMD_BASE   100
#define	M2M_OTA_CMD_BASE   100
#define	M2M_CRYPTO_CMD_BASE   1
#define	M2M_MAX_GRP_NUM_REQ   (127)
#define	WEP_40_KEY_STRING_SIZE   ((uint8)10)
#define	WEP_104_KEY_STRING_SIZE   ((uint8)26)
#define	WEP_KEY_MAX_INDEX   ((uint8)4)
#define	M2M_SHA256_CONTEXT_BUFF_LEN   (128)
#define	M2M_SCAN_DEFAULT_NUM_SLOTS   (2)
#define	M2M_SCAN_DEFAULT_SLOT_TIME   (30)
#define	M2M_SCAN_DEFAULT_NUM_PROBE   (2)
#define	TLS_FILE_NAME_MAX   48
#define	TLS_SRV_SEC_MAX_FILES   8
#define	TLS_SRV_SEC_START_PATTERN_LEN   8
#define	OTA_STATUS_VALID   (0x12526285)
#define	OTA_STATUS_INVALID   (0x23987718)
#define	OTA_MAGIC_VALUE   (0x1ABCDEF9)
#define	M2M_MAGIC_APP   (0xef522f61UL)
#define	OTA_FORMAT_VER_0   (0) /*Till 19.2.2 format*/
#define	OTA_FORMAT_VER_1   (1) /*starting from 19.3.0 CRC is used and sequence number is used*/
#define	OTA_SHA256_DIGEST_SIZE   (32)
#define	TLS_CRL_DATA_MAX_LEN   64
#define	TLS_CRL_MAX_ENTRIES   10
#define	TLS_CRL_TYPE_NONE   0
#define	TLS_CRL_TYPE_CERT_HASH   1

Enumerations
enum	tenuM2mDefaultConnErrcode { M2M_DEFAULT_CONN_INPROGRESS = ((sint8)-23), M2M_DEFAULT_CONN_FAIL, M2M_DEFAULT_CONN_SCAN_MISMATCH, M2M_DEFAULT_CONN_EMPTY_LIST }

Detailed Description

Macro Definition Documentation

M2M_MAJOR_SHIFT

#define M2M_MAJOR_SHIFT   (8)

M2M_MINOR_SHIFT

#define M2M_MINOR_SHIFT   (4)

M2M_PATCH_SHIFT

#define M2M_PATCH_SHIFT   (0)

M2M_DRV_VERSION_SHIFT

#define M2M_DRV_VERSION_SHIFT   (16)

M2M_FW_VERSION_SHIFT

#define M2M_FW_VERSION_SHIFT   (0)

M2M_GET_MAJOR

#define M2M_GET_MAJOR

(

ver_info_hword

)

((uint8)((ver_info_hword) >> M2M_MAJOR_SHIFT) & 0xff)

M2M_GET_MINOR

#define M2M_GET_MINOR

(

ver_info_hword

)

((uint8)((ver_info_hword) >> M2M_MINOR_SHIFT) & 0x0f)

M2M_GET_PATCH

#define M2M_GET_PATCH

(

ver_info_hword

)

((uint8)((ver_info_hword) >> M2M_PATCH_SHIFT) & 0x0f)

M2M_GET_FW_VER

#define M2M_GET_FW_VER

(

ver_info_word

)

((uint16) ((ver_info_word) >> M2M_FW_VERSION_SHIFT))

M2M_GET_DRV_VER

#define M2M_GET_DRV_VER

(

ver_info_word

)

((uint16) ((ver_info_word) >> M2M_DRV_VERSION_SHIFT))

M2M_GET_DRV_MAJOR

#define M2M_GET_DRV_MAJOR

(

ver_info_word

)

M2M_GET_MAJOR(M2M_GET_DRV_VER(ver_info_word))

M2M_GET_DRV_MINOR

#define M2M_GET_DRV_MINOR

(

ver_info_word

)

M2M_GET_MINOR(M2M_GET_DRV_VER(ver_info_word))

M2M_GET_DRV_PATCH

#define M2M_GET_DRV_PATCH

(

ver_info_word

)

M2M_GET_PATCH(M2M_GET_DRV_VER(ver_info_word))

M2M_GET_FW_MAJOR

#define M2M_GET_FW_MAJOR

(

ver_info_word

)

M2M_GET_MAJOR(M2M_GET_FW_VER(ver_info_word))

M2M_GET_FW_MINOR

#define M2M_GET_FW_MINOR

(

ver_info_word

)

M2M_GET_MINOR(M2M_GET_FW_VER(ver_info_word))

M2M_GET_FW_PATCH

#define M2M_GET_FW_PATCH

(

ver_info_word

)

M2M_GET_PATCH(M2M_GET_FW_VER(ver_info_word))

M2M_MAKE_VERSION

#define M2M_MAKE_VERSION	(		major,
			minor,
			patch
	)

Value:

( \
    ((uint16)((major)  & 0xff)  << M2M_MAJOR_SHIFT) | \
    ((uint16)((minor)  & 0x0f)  << M2M_MINOR_SHIFT) | \
    ((uint16)((patch)  & 0x0f)  << M2M_PATCH_SHIFT))

M2M_MAKE_VERSION_INFO

#define M2M_MAKE_VERSION_INFO	(		fw_major,
			fw_minor,
			fw_patch,
			drv_major,
			drv_minor,
			drv_patch
	)

Value:

( \
    ( ((uint32)M2M_MAKE_VERSION((fw_major),  (fw_minor),  (fw_patch)))  << M2M_FW_VERSION_SHIFT) | \
    ( ((uint32)M2M_MAKE_VERSION((drv_major), (drv_minor), (drv_patch))) << M2M_DRV_VERSION_SHIFT))

REL_19_5_2_VER

#define REL_19_5_2_VER   M2M_MAKE_VERSION_INFO(19,5,2,19,3,0)

REL_19_5_1_VER

#define REL_19_5_1_VER   M2M_MAKE_VERSION_INFO(19,5,1,19,3,0)

REL_19_5_0_VER

#define REL_19_5_0_VER   M2M_MAKE_VERSION_INFO(19,5,0,19,3,0)

REL_19_4_6_VER

#define REL_19_4_6_VER   M2M_MAKE_VERSION_INFO(19,4,6,19,3,0)

REL_19_4_5_VER

#define REL_19_4_5_VER   M2M_MAKE_VERSION_INFO(19,4,5,19,3,0)

REL_19_4_4_VER

#define REL_19_4_4_VER   M2M_MAKE_VERSION_INFO(19,4,4,19,3,0)

REL_19_4_3_VER

#define REL_19_4_3_VER   M2M_MAKE_VERSION_INFO(19,4,3,19,3,0)

REL_19_4_2_VER

#define REL_19_4_2_VER   M2M_MAKE_VERSION_INFO(19,4,2,19,3,0)

REL_19_4_1_VER

#define REL_19_4_1_VER   M2M_MAKE_VERSION_INFO(19,4,1,19,3,0)

REL_19_4_0_VER

#define REL_19_4_0_VER   M2M_MAKE_VERSION_INFO(19,4,0,19,3,0)

REL_19_3_1_VER

#define REL_19_3_1_VER   M2M_MAKE_VERSION_INFO(19,3,1,19,3,0)

REL_19_3_0_VER

#define REL_19_3_0_VER   M2M_MAKE_VERSION_INFO(19,3,0,19,3,0)

REL_19_2_2_VER

#define REL_19_2_2_VER   M2M_MAKE_VERSION_INFO(19,2,2,19,2,0)

REL_19_2_1_VER

#define REL_19_2_1_VER   M2M_MAKE_VERSION_INFO(19,2,1,19,2,0)

REL_19_2_0_VER

#define REL_19_2_0_VER   M2M_MAKE_VERSION_INFO(19,2,0,19,2,0)

REL_19_1_0_VER

#define REL_19_1_0_VER   M2M_MAKE_VERSION_INFO(19,1,0,18,2,0)

REL_19_0_0_VER

#define REL_19_0_0_VER   M2M_MAKE_VERSION_INFO(19,0,0,18,1,1)

M2M_RELEASE_VERSION_MAJOR_NO

#define M2M_RELEASE_VERSION_MAJOR_NO   (19)

Firmware Major release version number.

M2M_RELEASE_VERSION_MINOR_NO

#define M2M_RELEASE_VERSION_MINOR_NO   (5)

Firmware Minor release version number.

M2M_RELEASE_VERSION_PATCH_NO

#define M2M_RELEASE_VERSION_PATCH_NO   (2)

Firmware patch release version number.

M2M_RELEASE_VERSION_SVN_VERSION

#define M2M_RELEASE_VERSION_SVN_VERSION   (SVN_REVISION)

Firmware SVN release version number.

M2M_MIN_REQ_DRV_VERSION_MAJOR_NO

#define M2M_MIN_REQ_DRV_VERSION_MAJOR_NO   (19)

Driver Major release version number.

M2M_MIN_REQ_DRV_VERSION_MINOR_NO

#define M2M_MIN_REQ_DRV_VERSION_MINOR_NO   (3)

Driver Minor release version number.

M2M_MIN_REQ_DRV_VERSION_PATCH_NO

#define M2M_MIN_REQ_DRV_VERSION_PATCH_NO   (0)

Driver patch release version number.

M2M_MIN_REQ_DRV_SVN_VERSION

#define M2M_MIN_REQ_DRV_SVN_VERSION   (0)

Driver svn version.

M2M_BUFFER_MAX_SIZE

#define M2M_BUFFER_MAX_SIZE   (1600UL - 4)

Maximum size for the shared packet buffer.

M2M_MAC_ADDRES_LEN

#define M2M_MAC_ADDRES_LEN   6

The size fo 802 MAC address.

M2M_ETHERNET_HDR_OFFSET

#define M2M_ETHERNET_HDR_OFFSET   34

The offset of the Ethernet header within the WLAN Tx Buffer.

M2M_ETHERNET_HDR_LEN

#define M2M_ETHERNET_HDR_LEN   14

Length of the Etherenet header in bytes.

M2M_MAX_SSID_LEN

#define M2M_MAX_SSID_LEN   33

Maximum size for the Wi-Fi SSID including the NULL termination.

M2M_MAX_PSK_LEN

#define M2M_MAX_PSK_LEN   65

Maximum size for the WPA PSK including the NULL termination.

M2M_MIN_PSK_LEN

#define M2M_MIN_PSK_LEN   9

Maximum size for the WPA PSK including the NULL termination.

M2M_DEVICE_NAME_MAX

#define M2M_DEVICE_NAME_MAX   48

Maximum Size for the device name including the NULL termination.

M2M_LISTEN_INTERVAL

#define M2M_LISTEN_INTERVAL   1

The STA uses the Listen Interval parameter to indicate to the AP how many beacon intervals it shall sleep before it retrieves the queued frames from the AP.

MAX_HIDDEN_SITES

#define MAX_HIDDEN_SITES   4

max number of hidden SSID suuported by scan request

M2M_1X_USR_NAME_MAX

#define M2M_1X_USR_NAME_MAX   21

The maximum size of the user name including the NULL termination. It is used for RADIUS authentication in case of connecting the device to an AP secured with WPA-Enterprise.

M2M_1X_PWD_MAX

#define M2M_1X_PWD_MAX   41

The maximum size of the password including the NULL termination. It is used for RADIUS authentication in case of connecting the device to an AP secured with WPA-Enterprise.

M2M_CUST_IE_LEN_MAX

#define M2M_CUST_IE_LEN_MAX   252

The maximum size of IE (Information Element).

PWR_DEFAULT

#define PWR_DEFAULT   PWR_HIGH

M2M_CONFIG_CMD_BASE

#define M2M_CONFIG_CMD_BASE   1

The base value of all the host configuration commands opcodes.

M2M_STA_CMD_BASE

#define M2M_STA_CMD_BASE   40

The base value of all the station mode host commands opcodes.

M2M_AP_CMD_BASE

#define M2M_AP_CMD_BASE   70

The base value of all the Access Point mode host commands opcodes.

M2M_P2P_CMD_BASE

#define M2M_P2P_CMD_BASE   90

The base value of all the P2P mode host commands opcodes.

M2M_SERVER_CMD_BASE

#define M2M_SERVER_CMD_BASE   100

The base value of all the power save mode host commands codes.

M2M_OTA_CMD_BASE

#define M2M_OTA_CMD_BASE   100

The base value of all the OTA mode host commands opcodes. The OTA Have special group so can extended from 1-M2M_MAX_GRP_NUM_REQ

M2M_CRYPTO_CMD_BASE

#define M2M_CRYPTO_CMD_BASE   1

The base value of all the crypto mode host commands opcodes. The crypto Have special group so can extended from 1-M2M_MAX_GRP_NUM_REQ

M2M_MAX_GRP_NUM_REQ

#define M2M_MAX_GRP_NUM_REQ   (127)

max number of request in one group equal to 127 as the last bit reserved for config or data pkt

WEP_40_KEY_STRING_SIZE

#define WEP_40_KEY_STRING_SIZE   ((uint8)10)

Indicate the wep key size in bytes for 40 bit string passphrase.

WEP_104_KEY_STRING_SIZE

#define WEP_104_KEY_STRING_SIZE   ((uint8)26)

Indicate the wep key size in bytes for 104 bit string passphrase.

WEP_KEY_MAX_INDEX

#define WEP_KEY_MAX_INDEX   ((uint8)4)

Indicate the max key index value for WEP authentication

M2M_SHA256_CONTEXT_BUFF_LEN

#define M2M_SHA256_CONTEXT_BUFF_LEN   (128)

sha256 context size

M2M_SCAN_DEFAULT_NUM_SLOTS

#define M2M_SCAN_DEFAULT_NUM_SLOTS   (2)

The default. number of scan slots performed by the WINC board.

M2M_SCAN_DEFAULT_SLOT_TIME

#define M2M_SCAN_DEFAULT_SLOT_TIME   (30)

The default. duration in miliseconds of a scan slots performed by the WINC board.

M2M_SCAN_DEFAULT_NUM_PROBE

#define M2M_SCAN_DEFAULT_NUM_PROBE   (2)

The default. number of scan slots performed by the WINC board.

TLS_FILE_NAME_MAX

#define TLS_FILE_NAME_MAX   48

Maximum length for each TLS certificate file name including null terminator.

TLS_SRV_SEC_MAX_FILES

#define TLS_SRV_SEC_MAX_FILES   8

Maximum number of certificates allowed in TLS_SRV section.

TLS_SRV_SEC_START_PATTERN_LEN

#define TLS_SRV_SEC_START_PATTERN_LEN   8

Length of certificate struct start pattern.

OTA_STATUS_VALID

#define OTA_STATUS_VALID   (0x12526285)

Magic value updated in the Control structure in case of ROLLACK image Valid

OTA_STATUS_INVALID

#define OTA_STATUS_INVALID   (0x23987718)

Magic value updated in the Control structure in case of ROLLACK image InValid

OTA_MAGIC_VALUE

#define OTA_MAGIC_VALUE   (0x1ABCDEF9)

Magic value set at the beginning of the OTA image header

M2M_MAGIC_APP

#define M2M_MAGIC_APP   (0xef522f61UL)

Magic value set at the beginning of the Cortus OTA image header

OTA_FORMAT_VER_0

#define OTA_FORMAT_VER_0   (0) /*Till 19.2.2 format*/

OTA_FORMAT_VER_1

#define OTA_FORMAT_VER_1   (1) /*starting from 19.3.0 CRC is used and sequence number is used*/

Control structure format version

OTA_SHA256_DIGEST_SIZE

#define OTA_SHA256_DIGEST_SIZE   (32)

Sha256 digest size in the OTA image, the sha256 digest is set at the beginning of image before the OTA header

TLS_CRL_DATA_MAX_LEN

#define TLS_CRL_DATA_MAX_LEN   64

TLS_CRL_MAX_ENTRIES

#define TLS_CRL_MAX_ENTRIES   10

TLS_CRL_TYPE_NONE

#define TLS_CRL_TYPE_NONE   0

TLS_CRL_TYPE_CERT_HASH

#define TLS_CRL_TYPE_CERT_HASH   1

Enumeration Type Documentation

tenuM2mDefaultConnErrcode

enum tenuM2mDefaultConnErrcode

Enumerator
M2M_DEFAULT_CONN_INPROGRESS	A failure that indicates that a default connection or forced connection is in progress
M2M_DEFAULT_CONN_FAIL	A failure response that indicates that the winc failed to connect to the cached network
M2M_DEFAULT_CONN_SCAN_MISMATCH	A failure response that indicates that no one of the cached networks was found in the scan results, as a result to the function call m2m_default_connect.
M2M_DEFAULT_CONN_EMPTY_LIST	A failure response that indicates an empty network list as a result to the function call m2m_default_connect.