CommonDefines

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

Detailed Description

Macro Definition Documentation

M2M_TIME_OUT_DELAY

#define M2M_TIME_OUT_DELAY   10000

M2M_SUCCESS

#define M2M_SUCCESS   ((sint8)0)

M2M_ERR_SEND

#define M2M_ERR_SEND   ((sint8)-1)

M2M_ERR_RCV

#define M2M_ERR_RCV   ((sint8)-2)

M2M_ERR_MEM_ALLOC

#define M2M_ERR_MEM_ALLOC   ((sint8)-3)

M2M_ERR_TIME_OUT

#define M2M_ERR_TIME_OUT   ((sint8)-4)

M2M_ERR_INIT

#define M2M_ERR_INIT   ((sint8)-5)

M2M_ERR_BUS_FAIL

#define M2M_ERR_BUS_FAIL   ((sint8)-6)

M2M_NOT_YET

#define M2M_NOT_YET   ((sint8)-7)

M2M_ERR_FIRMWARE

#define M2M_ERR_FIRMWARE   ((sint8)-8)

M2M_SPI_FAIL

#define M2M_SPI_FAIL   ((sint8)-9)

M2M_ERR_FIRMWARE_bURN

#define M2M_ERR_FIRMWARE_bURN   ((sint8)-10)

M2M_ACK

#define M2M_ACK   ((sint8)-11)

M2M_ERR_FAIL

#define M2M_ERR_FAIL   ((sint8)-12)

M2M_ERR_FW_VER_MISMATCH

#define M2M_ERR_FW_VER_MISMATCH   ((sint8)-13)

M2M_ERR_SCAN_IN_PROGRESS

#define M2M_ERR_SCAN_IN_PROGRESS   ((sint8)-14)

M2M_ERR_INVALID_ARG

#define M2M_ERR_INVALID_ARG   ((sint8)-15)

M2M_ERR_INVALID

#define M2M_ERR_INVALID   ((sint8)-16)

I2C_ERR_LARGE_ADDRESS

#define I2C_ERR_LARGE_ADDRESS   0xE1UL /*the address exceed the max addressing mode in i2c flash*/

I2C_ERR_TX_ABRT

#define I2C_ERR_TX_ABRT   0xE2UL /*NO ACK from slave*/

I2C_ERR_OVER_SIZE

#define I2C_ERR_OVER_SIZE   0xE3UL

ERR_PREFIX_NMIS

#define ERR_PREFIX_NMIS   0xE4UL /*wrong first four byte in flash NMIS*/

ERR_FIRMEWARE_EXCEED_SIZE

#define ERR_FIRMEWARE_EXCEED_SIZE   0xE5UL /*Total size of firmware exceed the max size 256k*/

PROGRAM_START

#define PROGRAM_START   0x26961735UL

BOOT_SUCCESS

#define BOOT_SUCCESS   0x10add09eUL

BOOT_START

#define BOOT_START   0x12345678UL

NBIT31

#define NBIT31   (0x80000000)

NBIT30

#define NBIT30   (0x40000000)

NBIT29

#define NBIT29   (0x20000000)

NBIT28

#define NBIT28   (0x10000000)

NBIT27

#define NBIT27   (0x08000000)

NBIT26

#define NBIT26   (0x04000000)

NBIT25

#define NBIT25   (0x02000000)

NBIT24

#define NBIT24   (0x01000000)

NBIT23

#define NBIT23   (0x00800000)

NBIT22

#define NBIT22   (0x00400000)

NBIT21

#define NBIT21   (0x00200000)

NBIT20

#define NBIT20   (0x00100000)

NBIT19

#define NBIT19   (0x00080000)

NBIT18

#define NBIT18   (0x00040000)

NBIT17

#define NBIT17   (0x00020000)

NBIT16

#define NBIT16   (0x00010000)

NBIT15

#define NBIT15   (0x00008000)

NBIT14

#define NBIT14   (0x00004000)

NBIT13

#define NBIT13   (0x00002000)

NBIT12

#define NBIT12   (0x00001000)

NBIT11

#define NBIT11   (0x00000800)

NBIT10

#define NBIT10   (0x00000400)

NBIT9

#define NBIT9   (0x00000200)

NBIT8

#define NBIT8   (0x00000100)

NBIT7

#define NBIT7   (0x00000080)

NBIT6

#define NBIT6   (0x00000040)

NBIT5

#define NBIT5   (0x00000020)

NBIT4

#define NBIT4   (0x00000010)

NBIT3

#define NBIT3   (0x00000008)

NBIT2

#define NBIT2   (0x00000004)

NBIT1

#define NBIT1   (0x00000002)

NBIT0

#define NBIT0   (0x00000001)

M2M_MAX

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

M2M_SEL

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

WORD_ALIGN

#define WORD_ALIGN

(

val

)

(((val) & 0x03) ? ((val) + 4 - ((val) & 0x03)) : (val))

DATA_PKT_OFFSET

#define DATA_PKT_OFFSET   4

BYTE_0

#define BYTE_0

(

word

)

((uint8)(((word) >> 0 ) & 0x000000FFUL))

BYTE_1

#define BYTE_1

(

word

)

((uint8)(((word) >> 8 ) & 0x000000FFUL))

BYTE_2

#define BYTE_2

(

word

)

((uint8)(((word) >> 16) & 0x000000FFUL))

BYTE_3

#define BYTE_3

(

word

)

((uint8)(((word) >> 24) & 0x000000FFUL))