|
Macros | |
| #define | FLASH_ERR_INTERNAL (-7) |
| #define | FLASH_ERR_LOCAL_ACCESS (-2) |
| #define | FLASH_ERR_PARAM (-1) |
| #define | FLASH_ERR_SIZE (-4) |
| #define | FLASH_ERR_UNINIT (-6) |
| #define | FLASH_ERR_WINC_ACCESS (-3) |
| #define | FLASH_ERR_WINC_CONFLICT (-5) |
| #define | FLASH_SUCCESS 0 |
| #define | FLASH_UPDATEIMAGE_OPTION_SWITCH NBIT2 |
| #define | FLASH_UPDATEIMAGE_OPTION_UPDATE NBIT0 |
| #define | FLASH_UPDATEIMAGE_OPTION_VALIDATE NBIT1 |
Detailed Description
Macro Definition Documentation
◆ FLASH_ERR_INTERNAL
| #define FLASH_ERR_INTERNAL (-7) |
Return error. The module hit an internal error, such as insufficient heap memory.
Definition at line 82 of file m2m_flash.h.
◆ FLASH_ERR_LOCAL_ACCESS
| #define FLASH_ERR_LOCAL_ACCESS (-2) |
Return error. An MCU application function of type tpfDataAccessFn returned failure.
Definition at line 69 of file m2m_flash.h.
◆ FLASH_ERR_PARAM
| #define FLASH_ERR_PARAM (-1) |
Return error. The parameters provided by the MCU application failed sanity checks.
Definition at line 67 of file m2m_flash.h.
◆ FLASH_ERR_SIZE
| #define FLASH_ERR_SIZE (-4) |
Return error. The transfer destination location was too small for the size of data to be transferred.
Definition at line 73 of file m2m_flash.h.
◆ FLASH_ERR_UNINIT
| #define FLASH_ERR_UNINIT (-6) |
Return error. The MCU application did not call m2m_flash_init during Wi-Fi initialization.
Definition at line 80 of file m2m_flash.h.
◆ FLASH_ERR_WINC_ACCESS
| #define FLASH_ERR_WINC_ACCESS (-3) |
Return error. There was an error while accessing WINC flash, or contents of WINC flash were not as expected.
Definition at line 71 of file m2m_flash.h.
◆ FLASH_ERR_WINC_CONFLICT
| #define FLASH_ERR_WINC_CONFLICT (-5) |
Return error. The data provided by the MCU application caused a failure. For example:
- An item could not be added to a WINC flash store because the identifier matched an existing item.
- An item could not be read or removed from a WINC flash store because the identifier did not match an existing item.
- A firmware image could not be written to WINC flash because it did not match the format of WINC firmware images.
Definition at line 78 of file m2m_flash.h.
◆ FLASH_SUCCESS
| #define FLASH_SUCCESS 0 |
Return success, transfer succeeded.
Definition at line 65 of file m2m_flash.h.
◆ FLASH_UPDATEIMAGE_OPTION_SWITCH
| #define FLASH_UPDATEIMAGE_OPTION_SWITCH NBIT2 |
Bit 2 of u8Options parameter of m2m_flash_updateimage.
Request to switch the WINC active/inactive partitions. Use this to switch to a new image or to revert to an old one. The switch only succeeds if the image has been marked valid.
Definition at line 62 of file m2m_flash.h.
◆ FLASH_UPDATEIMAGE_OPTION_UPDATE
| #define FLASH_UPDATEIMAGE_OPTION_UPDATE NBIT0 |
Bit 0 of u8Options parameter of m2m_flash_updateimage.
Request to write new firmware image to WINC inactive partition.
Definition at line 54 of file m2m_flash.h.
◆ FLASH_UPDATEIMAGE_OPTION_VALIDATE
| #define FLASH_UPDATEIMAGE_OPTION_VALIDATE NBIT1 |
Bit 1 of u8Options parameter of m2m_flash_updateimage.
Request to mark image in WINC inactive partition as valid. If set along with FLASH_UPDATEIMAGE_OPTION_UPDATE, the image is not marked valid if the writing fails.
Definition at line 58 of file m2m_flash.h.