Microchip® Advanced Software Framework

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

Macros

#define BOOT_START   0x12345678UL
 
#define BOOT_START   0x12345678UL
 
#define BOOT_SUCCESS   0x10add09eUL
 
#define BOOT_SUCCESS   0x10add09eUL
 
#define BYTE_0(word)   ((uint8)(((word) >> 0) & 0x000000FFUL))
 
#define BYTE_0(word)   ((uint8)(((word) >> 0) & 0x000000FFUL))
 
#define BYTE_1(word)   ((uint8)(((word) >> 8) & 0x000000FFUL))
 
#define BYTE_1(word)   ((uint8)(((word) >> 8) & 0x000000FFUL))
 
#define BYTE_2(word)   ((uint8)(((word) >> 16) & 0x000000FFUL))
 
#define BYTE_2(word)   ((uint8)(((word) >> 16) & 0x000000FFUL))
 
#define BYTE_3(word)   ((uint8)(((word) >> 24) & 0x000000FFUL))
 
#define BYTE_3(word)   ((uint8)(((word) >> 24) & 0x000000FFUL))
 
#define DATA_PKT_OFFSET   4
 
#define DATA_PKT_OFFSET   4
 
#define ERR_FIRMWARE_EXCEED_SIZE   0xE5UL
 
#define ERR_FIRMWARE_EXCEED_SIZE   0xE5UL
 
#define ERR_PREFIX_NMIS   0xE4UL
 
#define ERR_PREFIX_NMIS   0xE4UL
 
#define I2C_ERR_LARGE_ADDRESS   0xE1UL
 
#define I2C_ERR_LARGE_ADDRESS   0xE1UL
 
#define I2C_ERR_OVER_SIZE   0xE3UL
 
#define I2C_ERR_OVER_SIZE   0xE3UL
 
#define I2C_ERR_TX_ABRT   0xE2UL
 
#define I2C_ERR_TX_ABRT   0xE2UL
 
#define M2M_ACK   ((sint8)-11)
 
#define M2M_ACK   ((sint8)-11)
 
#define M2M_ERR_BUS_FAIL   ((sint8)-6)
 
#define M2M_ERR_BUS_FAIL   ((sint8)-6)
 
#define M2M_ERR_FAIL   ((sint8)-12)
 
#define M2M_ERR_FAIL   ((sint8)-12)
 
#define M2M_ERR_FIRMWARE   ((sint8)-8)
 
#define M2M_ERR_FIRMWARE   ((sint8)-8)
 
#define M2M_ERR_FIRMWARE_bURN   ((sint8)-10)
 
#define M2M_ERR_FIRMWARE_bURN   ((sint8)-10)
 
#define M2M_ERR_FW_VER_MISMATCH   ((sint8)-13)
 
#define M2M_ERR_FW_VER_MISMATCH   ((sint8)-13)
 
#define M2M_ERR_INIT   ((sint8)-5)
 
#define M2M_ERR_INIT   ((sint8)-5)
 
#define M2M_ERR_INVALID   ((sint8)-16)
 
#define M2M_ERR_INVALID   ((sint8)-16)
 
#define M2M_ERR_INVALID_ARG   ((sint8)-15)
 
#define M2M_ERR_INVALID_ARG   ((sint8)-15)
 
#define M2M_ERR_MEM_ALLOC   ((sint8)-3)
 
#define M2M_ERR_MEM_ALLOC   ((sint8)-3)
 
#define M2M_ERR_RCV   ((sint8)-2)
 
#define M2M_ERR_RCV   ((sint8)-2)
 
#define M2M_ERR_SCAN_IN_PROGRESS   ((sint8)-14)
 
#define M2M_ERR_SCAN_IN_PROGRESS   ((sint8)-14)
 
#define M2M_ERR_SEND   ((sint8)-1)
 
#define M2M_ERR_SEND   ((sint8)-1)
 
#define M2M_ERR_TIME_OUT   ((sint8)-4)
 
#define M2M_ERR_TIME_OUT   ((sint8)-4)
 
#define M2M_MAX(A, B)   ((A) > (B) ? (A) : (B))
 
#define M2M_MAX(A, B)   ((A) > (B) ? (A) : (B))
 
#define M2M_NOT_YET   ((sint8)-7)
 
#define M2M_NOT_YET   ((sint8)-7)
 
#define M2M_SEL(x, m1, m2, m3)   ((x>1)?((x>2)?(m3):(m2)):(m1))
 
#define M2M_SEL(x, m1, m2, m3)   ((x>1)?((x>2)?(m3):(m2)):(m1))
 
#define M2M_SPI_FAIL   ((sint8)-9)
 
#define M2M_SPI_FAIL   ((sint8)-9)
 
#define M2M_SUCCESS   ((sint8)0)
 
#define M2M_SUCCESS   ((sint8)0)
 
#define M2M_TIME_OUT_DELAY   10000
 
#define M2M_TIME_OUT_DELAY   10000
 
#define NBIT0   (0x00000001)
 
#define NBIT0   (0x00000001)
 
#define NBIT1   (0x00000002)
 
#define NBIT1   (0x00000002)
 
#define NBIT10   (0x00000400)
 
#define NBIT10   (0x00000400)
 
#define NBIT11   (0x00000800)
 
#define NBIT11   (0x00000800)
 
#define NBIT12   (0x00001000)
 
#define NBIT12   (0x00001000)
 
#define NBIT13   (0x00002000)
 
#define NBIT13   (0x00002000)
 
#define NBIT14   (0x00004000)
 
#define NBIT14   (0x00004000)
 
#define NBIT15   (0x00008000)
 
#define NBIT15   (0x00008000)
 
#define NBIT16   (0x00010000)
 
#define NBIT16   (0x00010000)
 
#define NBIT17   (0x00020000)
 
#define NBIT17   (0x00020000)
 
#define NBIT18   (0x00040000)
 
#define NBIT18   (0x00040000)
 
#define NBIT19   (0x00080000)
 
#define NBIT19   (0x00080000)
 
#define NBIT2   (0x00000004)
 
#define NBIT2   (0x00000004)
 
#define NBIT20   (0x00100000)
 
#define NBIT20   (0x00100000)
 
#define NBIT21   (0x00200000)
 
#define NBIT21   (0x00200000)
 
#define NBIT22   (0x00400000)
 
#define NBIT22   (0x00400000)
 
#define NBIT23   (0x00800000)
 
#define NBIT23   (0x00800000)
 
#define NBIT24   (0x01000000)
 
#define NBIT24   (0x01000000)
 
#define NBIT25   (0x02000000)
 
#define NBIT25   (0x02000000)
 
#define NBIT26   (0x04000000)
 
#define NBIT26   (0x04000000)
 
#define NBIT27   (0x08000000)
 
#define NBIT27   (0x08000000)
 
#define NBIT28   (0x10000000)
 
#define NBIT28   (0x10000000)
 
#define NBIT29   (0x20000000)
 
#define NBIT29   (0x20000000)
 
#define NBIT3   (0x00000008)
 
#define NBIT3   (0x00000008)
 
#define NBIT30   (0x40000000)
 
#define NBIT30   (0x40000000)
 
#define NBIT31   (0x80000000)
 
#define NBIT31   (0x80000000)
 
#define NBIT4   (0x00000010)
 
#define NBIT4   (0x00000010)
 
#define NBIT5   (0x00000020)
 
#define NBIT5   (0x00000020)
 
#define NBIT6   (0x00000040)
 
#define NBIT6   (0x00000040)
 
#define NBIT7   (0x00000080)
 
#define NBIT7   (0x00000080)
 
#define NBIT8   (0x00000100)
 
#define NBIT8   (0x00000100)
 
#define NBIT9   (0x00000200)
 
#define NBIT9   (0x00000200)
 
#define PROGRAM_START   0x26961735UL
 
#define PROGRAM_START   0x26961735UL
 
#define WORD_ALIGN(val)   (((val) & 0x03) ? ((val) + 4 - ((val) & 0x03)) : (val))
 
#define WORD_ALIGN(val)   (((val) & 0x03) ? ((val) + 4 - ((val) & 0x03)) : (val))
 

#define BOOT_START   0x12345678UL
#define BOOT_START   0x12345678UL
#define BOOT_SUCCESS   0x10add09eUL
#define BOOT_SUCCESS   0x10add09eUL
#define BYTE_0 (   word)    ((uint8)(((word) >> 0) & 0x000000FFUL))

Most significant byte of 32bit word (LE)

#define BYTE_0 (   word)    ((uint8)(((word) >> 0) & 0x000000FFUL))

Most significant byte of 32bit word (LE)

#define BYTE_1 (   word)    ((uint8)(((word) >> 8) & 0x000000FFUL))

Second most significant byte of 32bit word (LE)

#define BYTE_1 (   word)    ((uint8)(((word) >> 8) & 0x000000FFUL))

Second most significant byte of 32bit word (LE)

#define BYTE_2 (   word)    ((uint8)(((word) >> 16) & 0x000000FFUL))

Third most significant byte of 32bit word (LE)

#define BYTE_2 (   word)    ((uint8)(((word) >> 16) & 0x000000FFUL))

Third most significant byte of 32bit word (LE)

#define BYTE_3 (   word)    ((uint8)(((word) >> 24) & 0x000000FFUL))

Least significant byte of 32bit word (LE)

#define BYTE_3 (   word)    ((uint8)(((word) >> 24) & 0x000000FFUL))

Least significant byte of 32bit word (LE)

#define DATA_PKT_OFFSET   4
#define DATA_PKT_OFFSET   4
#define ERR_FIRMWARE_EXCEED_SIZE   0xE5UL

Total size of firmware exceeds the max size 256k.

#define ERR_FIRMWARE_EXCEED_SIZE   0xE5UL

Total size of firmware exceeds the max size 256k.

#define ERR_PREFIX_NMIS   0xE4UL

Wrong first four bytes in flash NMIS.

#define ERR_PREFIX_NMIS   0xE4UL

Wrong first four bytes in flash NMIS.

#define I2C_ERR_LARGE_ADDRESS   0xE1UL

The address exceeds the max addressing mode in I2C flash.

#define I2C_ERR_LARGE_ADDRESS   0xE1UL

The address exceeds the max addressing mode in I2C flash.

#define I2C_ERR_OVER_SIZE   0xE3UL
#define I2C_ERR_OVER_SIZE   0xE3UL
#define I2C_ERR_TX_ABRT   0xE2UL

NO ACK from slave.

#define I2C_ERR_TX_ABRT   0xE2UL

NO ACK from slave.

#define M2M_ACK   ((sint8)-11)
#define M2M_ACK   ((sint8)-11)
#define M2M_ERR_BUS_FAIL   ((sint8)-6)
#define M2M_ERR_BUS_FAIL   ((sint8)-6)
#define M2M_ERR_FAIL   ((sint8)-12)
#define M2M_ERR_FAIL   ((sint8)-12)
#define M2M_ERR_FIRMWARE   ((sint8)-8)
#define M2M_ERR_FIRMWARE   ((sint8)-8)
#define M2M_ERR_FIRMWARE_bURN   ((sint8)-10)
#define M2M_ERR_FIRMWARE_bURN   ((sint8)-10)
#define M2M_ERR_FW_VER_MISMATCH   ((sint8)-13)
#define M2M_ERR_FW_VER_MISMATCH   ((sint8)-13)
#define M2M_ERR_INIT   ((sint8)-5)
#define M2M_ERR_INIT   ((sint8)-5)
#define M2M_ERR_INVALID   ((sint8)-16)

Referenced by m2m_ota_host_file_erase(), and nm_get_ota_firmware_info().

#define M2M_ERR_INVALID   ((sint8)-16)
#define M2M_ERR_INVALID_ARG   ((sint8)-15)

Referenced by hexstr_2_bytes(), m2m_flash_erase_sector(), m2m_flash_read(), m2m_flash_write(), m2m_ota_host_file_read_hif(), m2m_ota_host_file_read_spi(), m2m_ping_req(), m2m_ssl_retrieve_hash(), m2m_ssl_retrieve_next_for_verifying(), m2m_wifi_1x_get_option(), m2m_wifi_1x_set_option(), m2m_wifi_connect_1x_mschap2(), m2m_wifi_connect_1x_tls(), m2m_wifi_connect_open(), m2m_wifi_connect_prepare_msg(), m2m_wifi_connect_psk(), m2m_wifi_connect_sc(), m2m_wifi_connect_wep(), m2m_wifi_delete_sc(), m2m_wifi_enable_roaming(), m2m_wifi_enable_XO_during_sleep(), m2m_wifi_request_scan(), m2m_wifi_request_scan_passive(), m2m_wifi_request_scan_ssid_list(), m2m_wifi_set_stop_scan_on_first(), nm_get_ota_firmware_info(), and spi_flexible_flash_find_section().

#define M2M_ERR_INVALID_ARG   ((sint8)-15)
#define M2M_ERR_MEM_ALLOC   ((sint8)-3)
#define M2M_ERR_MEM_ALLOC   ((sint8)-3)
#define M2M_ERR_RCV   ((sint8)-2)
#define M2M_ERR_RCV   ((sint8)-2)
#define M2M_ERR_SCAN_IN_PROGRESS   ((sint8)-14)
#define M2M_ERR_SCAN_IN_PROGRESS   ((sint8)-14)
#define M2M_ERR_SEND   ((sint8)-1)
#define M2M_ERR_SEND   ((sint8)-1)
#define M2M_ERR_TIME_OUT   ((sint8)-4)
#define M2M_ERR_TIME_OUT   ((sint8)-4)
#define M2M_MAX (   A,
  B 
)    ((A) > (B) ? (A) : (B))

Maximum of two values

#define M2M_MAX (   A,
  B 
)    ((A) > (B) ? (A) : (B))

Maximum of two values

#define M2M_NOT_YET   ((sint8)-7)
#define M2M_NOT_YET   ((sint8)-7)
#define M2M_SEL (   x,
  m1,
  m2,
  m3 
)    ((x>1)?((x>2)?(m3):(m2)):(m1))

Choose one of three values

#define M2M_SEL (   x,
  m1,
  m2,
  m3 
)    ((x>1)?((x>2)?(m3):(m2)):(m1))

Choose one of three values

#define M2M_SPI_FAIL   ((sint8)-9)
#define M2M_SPI_FAIL   ((sint8)-9)
#define M2M_SUCCESS   ((sint8)0)
#define M2M_SUCCESS   ((sint8)0)
#define M2M_TIME_OUT_DELAY   10000
#define M2M_TIME_OUT_DELAY   10000
#define NBIT0   (0x00000001)
#define NBIT0   (0x00000001)
#define NBIT1   (0x00000002)
#define NBIT1   (0x00000002)
#define NBIT10   (0x00000400)
#define NBIT10   (0x00000400)
#define NBIT11   (0x00000800)
#define NBIT11   (0x00000800)
#define NBIT12   (0x00001000)
#define NBIT12   (0x00001000)
#define NBIT13   (0x00002000)
#define NBIT13   (0x00002000)
#define NBIT14   (0x00004000)
#define NBIT14   (0x00004000)
#define NBIT15   (0x00008000)
#define NBIT15   (0x00008000)
#define NBIT16   (0x00010000)
#define NBIT16   (0x00010000)
#define NBIT17   (0x00020000)
#define NBIT17   (0x00020000)
#define NBIT18   (0x00040000)
#define NBIT18   (0x00040000)
#define NBIT19   (0x00080000)
#define NBIT19   (0x00080000)
#define NBIT2   (0x00000004)
#define NBIT2   (0x00000004)
#define NBIT20   (0x00100000)
#define NBIT20   (0x00100000)
#define NBIT21   (0x00200000)
#define NBIT21   (0x00200000)
#define NBIT22   (0x00400000)
#define NBIT22   (0x00400000)
#define NBIT23   (0x00800000)
#define NBIT23   (0x00800000)
#define NBIT24   (0x01000000)
#define NBIT24   (0x01000000)
#define NBIT25   (0x02000000)
#define NBIT25   (0x02000000)
#define NBIT26   (0x04000000)
#define NBIT26   (0x04000000)
#define NBIT27   (0x08000000)
#define NBIT27   (0x08000000)
#define NBIT28   (0x10000000)
#define NBIT28   (0x10000000)
#define NBIT29   (0x20000000)
#define NBIT29   (0x20000000)
#define NBIT3   (0x00000008)
#define NBIT3   (0x00000008)
#define NBIT30   (0x40000000)
#define NBIT30   (0x40000000)
#define NBIT31   (0x80000000)
#define NBIT31   (0x80000000)
#define NBIT4   (0x00000010)
#define NBIT4   (0x00000010)
#define NBIT5   (0x00000020)
#define NBIT5   (0x00000020)
#define NBIT6   (0x00000040)
#define NBIT6   (0x00000040)
#define NBIT7   (0x00000080)
#define NBIT7   (0x00000080)
#define NBIT8   (0x00000100)
#define NBIT8   (0x00000100)
#define NBIT9   (0x00000200)
#define NBIT9   (0x00000200)
#define PROGRAM_START   0x26961735UL
#define PROGRAM_START   0x26961735UL
#define WORD_ALIGN (   val)    (((val) & 0x03) ? ((val) + 4 - ((val) & 0x03)) : (val))

Align to next multiple of 4

#define WORD_ALIGN (   val)    (((val) & 0x03) ? ((val) + 4 - ((val) & 0x03)) : (val))

Align to next multiple of 4

Generated on Sat Mar 5 2022 00:30:44 for SAM4S by   doxygen 1.8.5