Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Defines

   Specifies the macros and defines used by the version APIs.

Macros

#define M2M_DRIVER_VERSION_MAJOR_NO   (1)
 
#define M2M_DRIVER_VERSION_MINOR_NO   (2)
 
#define M2M_DRIVER_VERSION_PATCH_NO   (0)
 
#define M2M_DRV_VERSION_SHIFT   (16)
 
#define M2M_FW_VERSION_SHIFT   (0)
 
#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_DRV_VER(ver_info_word)   ((uint16) ((ver_info_word) >> M2M_DRV_VERSION_SHIFT))
 
#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_GET_FW_VER(ver_info_word)   ((uint16) ((ver_info_word) >> M2M_FW_VERSION_SHIFT))
 
#define M2M_GET_HIF_BLOCK(hif_info)   ((uint8)(((hif_info) >> M2M_HIF_BLOCK_SHIFT) & M2M_HIF_BLOCK_MASK))
 
#define M2M_GET_HIF_INFO(hif_ver)   ((uint16)(((hif_ver) >> M2M_HIF_INFO_SHIFT) & M2M_HIF_INFO_MASK))
 
#define M2M_GET_HIF_LEVEL(hif_info)   ((uint16)(((hif_info) >> M2M_HIF_LEVEL_SHIFT) & M2M_HIF_LEVEL_MASK))
 
#define M2M_GET_HIF_MAJOR(hif_info)   ((uint8)(((hif_info) >> M2M_HIF_MAJOR_SHIFT) & M2M_HIF_MAJOR_MASK))
 
#define M2M_GET_HIF_MINOR(hif_info)   ((uint8)(((hif_info) >> M2M_HIF_MINOR_SHIFT) & M2M_HIF_MINOR_MASK))
 
#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_HIF_BLOCK_MASK   (0x3)
 
#define M2M_HIF_BLOCK_SHIFT   (14)
 
#define M2M_HIF_BLOCK_VALUE   (2)
 
#define M2M_HIF_INFO_MASK   (0xffff)
 
#define M2M_HIF_INFO_SHIFT   (0)
 
#define M2M_HIF_LEVEL
 
#define M2M_HIF_LEVEL_MASK   (0x3fff)
 
#define M2M_HIF_LEVEL_SHIFT   (0)
 
#define M2M_HIF_MAJOR_MASK   (0x3f)
 
#define M2M_HIF_MAJOR_SHIFT   (8)
 
#define M2M_HIF_MAJOR_VALUE   (1)
 
#define M2M_HIF_MINOR_MASK   (0xff)
 
#define M2M_HIF_MINOR_SHIFT   (0)
 
#define M2M_HIF_MINOR_VALUE   (5)
 
#define M2M_MAJOR_SHIFT   (8)
 
#define M2M_MAKE_HIF_INFO(hif_level)
 
#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 M2M_MIN_REQ_DRV_SVN_VERSION   (0)
 
#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_MINOR_SHIFT   (4)
 
#define M2M_PATCH_SHIFT   (0)
 
#define M2M_RELEASE_VERSION_MAJOR_NO   (19)
 
#define M2M_RELEASE_VERSION_MINOR_NO   (7)
 
#define M2M_RELEASE_VERSION_PATCH_NO   (3)
 
#define M2M_RELEASE_VERSION_SVN_VERSION   (SVN_REVISION)
 
#define REL_19_0_0_VER   M2M_MAKE_VERSION_INFO(19,0,0,18,1,1)
 
#define REL_19_1_0_VER   M2M_MAKE_VERSION_INFO(19,1,0,18,2,0)
 
#define REL_19_2_0_VER   M2M_MAKE_VERSION_INFO(19,2,0,19,2,0)
 
#define REL_19_2_1_VER   M2M_MAKE_VERSION_INFO(19,2,1,19,2,0)
 
#define REL_19_2_2_VER   M2M_MAKE_VERSION_INFO(19,2,2,19,2,0)
 
#define REL_19_3_0_VER   M2M_MAKE_VERSION_INFO(19,3,0,19,3,0)
 
#define REL_19_3_1_VER   M2M_MAKE_VERSION_INFO(19,3,1,19,3,0)
 
#define REL_19_4_0_VER   M2M_MAKE_VERSION_INFO(19,4,0,19,3,0)
 
#define REL_19_4_1_VER   M2M_MAKE_VERSION_INFO(19,4,1,19,3,0)
 
#define REL_19_4_2_VER   M2M_MAKE_VERSION_INFO(19,4,2,19,3,0)
 
#define REL_19_4_3_VER   M2M_MAKE_VERSION_INFO(19,4,3,19,3,0)
 
#define REL_19_4_4_VER   M2M_MAKE_VERSION_INFO(19,4,4,19,3,0)
 
#define REL_19_4_5_VER   M2M_MAKE_VERSION_INFO(19,4,5,19,3,0)
 
#define REL_19_4_6_VER   M2M_MAKE_VERSION_INFO(19,4,6,19,3,0)
 
#define REL_19_5_0_VER   M2M_MAKE_VERSION_INFO(19,5,0,19,3,0)
 
#define REL_19_5_1_VER   M2M_MAKE_VERSION_INFO(19,5,1,19,3,0)
 
#define REL_19_5_2_VER   M2M_MAKE_VERSION_INFO(19,5,2,19,3,0)
 
#define REL_19_5_3_VER   M2M_MAKE_VERSION_INFO(19,5,3,19,3,0)
 
#define REL_19_6_0_VER   M2M_MAKE_VERSION_INFO(19,6,0,19,3,0)
 
#define REL_19_6_4_VER   M2M_MAKE_VERSION_INFO(19,6,4,19,3,0)
 
#define REL_19_7_0_VER   M2M_MAKE_VERSION_INFO(19,7,0,19,3,0)
 
#define REL_19_7_1_VER   M2M_MAKE_VERSION_INFO(19,7,1,19,3,0)
 
#define REL_19_7_2_VER   M2M_MAKE_VERSION_INFO(19,7,2,19,3,0)
 
#define REL_19_7_3_VER   M2M_MAKE_VERSION_INFO(19,7,3,19,3,0)
 

#define M2M_DRIVER_VERSION_MAJOR_NO   (1)

Driver Major release version number.

#define M2M_DRIVER_VERSION_MINOR_NO   (2)

Driver Minor release version number.

#define M2M_DRIVER_VERSION_PATCH_NO   (0)

Driver patch release version number.

#define M2M_DRV_VERSION_SHIFT   (16)
#define M2M_FW_VERSION_SHIFT   (0)
#define M2M_GET_DRV_MAJOR (   ver_info_word)    M2M_GET_MAJOR(M2M_GET_DRV_VER(ver_info_word))

Referenced by nm_get_firmware_info().

#define M2M_GET_DRV_MINOR (   ver_info_word)    M2M_GET_MINOR(M2M_GET_DRV_VER(ver_info_word))

Referenced by nm_get_firmware_info().

#define M2M_GET_DRV_PATCH (   ver_info_word)    M2M_GET_PATCH(M2M_GET_DRV_VER(ver_info_word))

Referenced by nm_get_firmware_info().

#define M2M_GET_DRV_VER (   ver_info_word)    ((uint16) ((ver_info_word) >> M2M_DRV_VERSION_SHIFT))
#define M2M_GET_FW_MAJOR (   ver_info_word)    M2M_GET_MAJOR(M2M_GET_FW_VER(ver_info_word))

Referenced by nm_get_firmware_info().

#define M2M_GET_FW_MINOR (   ver_info_word)    M2M_GET_MINOR(M2M_GET_FW_VER(ver_info_word))

Referenced by nm_get_firmware_info().

#define M2M_GET_FW_PATCH (   ver_info_word)    M2M_GET_PATCH(M2M_GET_FW_VER(ver_info_word))

Referenced by nm_get_firmware_info().

#define M2M_GET_FW_VER (   ver_info_word)    ((uint16) ((ver_info_word) >> M2M_FW_VERSION_SHIFT))
#define M2M_GET_HIF_INFO (   hif_ver)    ((uint16)(((hif_ver) >> M2M_HIF_INFO_SHIFT) & M2M_HIF_INFO_MASK))
#define M2M_GET_HIF_LEVEL (   hif_info)    ((uint16)(((hif_info) >> M2M_HIF_LEVEL_SHIFT) & M2M_HIF_LEVEL_MASK))
#define M2M_GET_HIF_MAJOR (   hif_info)    ((uint8)(((hif_info) >> M2M_HIF_MAJOR_SHIFT) & M2M_HIF_MAJOR_MASK))
#define M2M_GET_HIF_MINOR (   hif_info)    ((uint8)(((hif_info) >> M2M_HIF_MINOR_SHIFT) & M2M_HIF_MINOR_MASK))
#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_HIF_BLOCK_MASK   (0x3)
#define M2M_HIF_BLOCK_SHIFT   (14)
#define M2M_HIF_BLOCK_VALUE   (2)
#define M2M_HIF_INFO_MASK   (0xffff)
#define M2M_HIF_INFO_SHIFT   (0)
#define M2M_HIF_LEVEL
Value:
( \
)
#define M2M_HIF_MAJOR_MASK
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:114
#define M2M_HIF_MINOR_SHIFT
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:115
#define M2M_HIF_MINOR_MASK
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:116
#define M2M_HIF_MAJOR_VALUE
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:135
#define M2M_HIF_MAJOR_SHIFT
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:113
#define M2M_HIF_MINOR_VALUE
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:138

HIF Level (Major/Minor) for Drv/Fw compatibility.

#define M2M_HIF_LEVEL_MASK   (0x3fff)
#define M2M_HIF_LEVEL_SHIFT   (0)
#define M2M_HIF_MAJOR_MASK   (0x3f)
#define M2M_HIF_MAJOR_SHIFT   (8)
#define M2M_HIF_MAJOR_VALUE   (1)

Drv/Fw major compatibility check.

Referenced by hif_check_compatibility(), and m2m_wifi_init_start().

#define M2M_HIF_MINOR_MASK   (0xff)
#define M2M_HIF_MINOR_SHIFT   (0)
#define M2M_HIF_MINOR_VALUE   (5)

Drv/Fw minor compatibility check.

Referenced by m2m_wifi_init_start().

#define M2M_MAJOR_SHIFT   (8)
#define M2M_MAKE_HIF_INFO (   hif_level)
Value:
( \
(((uint16)(hif_level) & M2M_HIF_LEVEL_MASK) << M2M_HIF_LEVEL_SHIFT) | \
#define M2M_HIF_LEVEL_MASK
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:110
#define M2M_HIF_BLOCK_SHIFT
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:107
#define M2M_HIF_BLOCK_MASK
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:108
#define M2M_HIF_LEVEL_SHIFT
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:109
#define M2M_HIF_BLOCK_VALUE
Definition: winc3400/wifi_drv/driver/include/m2m_types.h:132
unsigned short uint16
Range of values between 0 to 65535.
Definition: wilc/bsp/include/nm_bsp.h:109
#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))
#define M2M_PATCH_SHIFT
Definition: winc1500/host_drv/driver/include/m2m_types.h:65
#define M2M_MINOR_SHIFT
Definition: winc1500/host_drv/driver/include/m2m_types.h:64
#define M2M_MAJOR_SHIFT
Definition: winc1500/host_drv/driver/include/m2m_types.h:63
unsigned short uint16
Range of values between 0 to 65535.
Definition: wilc/bsp/include/nm_bsp.h:109

Referenced by nm_get_firmware_full_info(), nm_get_firmware_info(), and nm_get_ota_firmware_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))
#define M2M_DRV_VERSION_SHIFT
Definition: winc1500/host_drv/driver/include/m2m_types.h:67
#define M2M_MAKE_VERSION(major, minor, patch)
Definition: winc1500/host_drv/driver/include/m2m_types.h:85
#define M2M_FW_VERSION_SHIFT
Definition: winc1500/host_drv/driver/include/m2m_types.h:68
unsigned long uint32
Range of values between 0 to 4294967295.
Definition: wilc/bsp/include/nm_bsp.h:116

Referenced by wait_for_bootrom().

#define M2M_MIN_REQ_DRV_SVN_VERSION   (0)

Driver svn version.

#define M2M_MIN_REQ_DRV_VERSION_MAJOR_NO   (19)

Driver Major release version number.

Referenced by wait_for_bootrom().

#define M2M_MIN_REQ_DRV_VERSION_MINOR_NO   (3)

Driver Minor release version number.

Referenced by wait_for_bootrom().

#define M2M_MIN_REQ_DRV_VERSION_PATCH_NO   (0)

Driver patch release version number.

Referenced by wait_for_bootrom().

#define M2M_MINOR_SHIFT   (4)
#define M2M_PATCH_SHIFT   (0)
#define M2M_RELEASE_VERSION_MAJOR_NO   (19)
#define M2M_RELEASE_VERSION_MINOR_NO   (7)
#define M2M_RELEASE_VERSION_PATCH_NO   (3)
#define M2M_RELEASE_VERSION_SVN_VERSION   (SVN_REVISION)

Firmware SVN release version number.

#define REL_19_0_0_VER   M2M_MAKE_VERSION_INFO(19,0,0,18,1,1)
#define REL_19_1_0_VER   M2M_MAKE_VERSION_INFO(19,1,0,18,2,0)
#define REL_19_2_0_VER   M2M_MAKE_VERSION_INFO(19,2,0,19,2,0)
#define REL_19_2_1_VER   M2M_MAKE_VERSION_INFO(19,2,1,19,2,0)
#define REL_19_2_2_VER   M2M_MAKE_VERSION_INFO(19,2,2,19,2,0)
#define REL_19_3_0_VER   M2M_MAKE_VERSION_INFO(19,3,0,19,3,0)
#define REL_19_3_1_VER   M2M_MAKE_VERSION_INFO(19,3,1,19,3,0)
#define REL_19_4_0_VER   M2M_MAKE_VERSION_INFO(19,4,0,19,3,0)
#define REL_19_4_1_VER   M2M_MAKE_VERSION_INFO(19,4,1,19,3,0)
#define REL_19_4_2_VER   M2M_MAKE_VERSION_INFO(19,4,2,19,3,0)
#define REL_19_4_3_VER   M2M_MAKE_VERSION_INFO(19,4,3,19,3,0)
#define REL_19_4_4_VER   M2M_MAKE_VERSION_INFO(19,4,4,19,3,0)
#define REL_19_4_5_VER   M2M_MAKE_VERSION_INFO(19,4,5,19,3,0)
#define REL_19_4_6_VER   M2M_MAKE_VERSION_INFO(19,4,6,19,3,0)
#define REL_19_5_0_VER   M2M_MAKE_VERSION_INFO(19,5,0,19,3,0)
#define REL_19_5_1_VER   M2M_MAKE_VERSION_INFO(19,5,1,19,3,0)
#define REL_19_5_2_VER   M2M_MAKE_VERSION_INFO(19,5,2,19,3,0)
#define REL_19_5_3_VER   M2M_MAKE_VERSION_INFO(19,5,3,19,3,0)
#define REL_19_6_0_VER   M2M_MAKE_VERSION_INFO(19,6,0,19,3,0)
#define REL_19_6_4_VER   M2M_MAKE_VERSION_INFO(19,6,4,19,3,0)
#define REL_19_7_0_VER   M2M_MAKE_VERSION_INFO(19,7,0,19,3,0)
#define REL_19_7_1_VER   M2M_MAKE_VERSION_INFO(19,7,1,19,3,0)
#define REL_19_7_2_VER   M2M_MAKE_VERSION_INFO(19,7,2,19,3,0)
#define REL_19_7_3_VER   M2M_MAKE_VERSION_INFO(19,7,3,19,3,0)