Specifies the enums and Data Structures used by the OTA APIs.
|
enum | tenuM2mOtaCmd {
M2M_OTA_REQ_NOTIF_SET_URL = M2M_OTA_CMD_BASE,
M2M_OTA_REQ_NOTIF_CHECK_FOR_UPDATE,
M2M_OTA_REQ_NOTIF_SCHED,
M2M_OTA_REQ_START_UPDATE,
M2M_OTA_REQ_SWITCH_FIRMWARE,
M2M_OTA_REQ_ROLLBACK,
M2M_OTA_REQ_ABORT,
M2M_OTA_RESP_NOTIF_UPDATE_INFO,
M2M_OTA_RESP_UPDATE_STATUS,
M2M_OTA_REQ_TEST,
M2M_OTA_MAX_ALL
} |
| This enum contains all the WINC commands used for OTA operation. More...
|
|
enum | tenuOtaError {
OTA_SUCCESS = (0),
OTA_ERR_WORKING_IMAGE_LOAD_FAIL = ((sint8) -1),
OTA_ERR_INVALID_CONTROL_SEC = ((sint8) -2),
M2M_ERR_OTA_SWITCH_FAIL = ((sint8) -3),
M2M_ERR_OTA_START_UPDATE_FAIL = ((sint8) -4),
M2M_ERR_OTA_ROLLBACK_FAIL = ((sint8) -5),
M2M_ERR_OTA_INVALID_FLASH_SIZE = ((sint8) -6),
M2M_ERR_OTA_INVALID_ARG = ((sint8) -7),
M2M_ERR_OTA_INPROGRESS = ((sint8) -8)
} |
| OTA Error codes. More...
|
|
enum | tenuOtaUpdateStatus {
OTA_STATUS_SUCCESS = 0,
OTA_STATUS_FAIL = 1,
OTA_STATUS_INVALID_ARG = 2,
OTA_STATUS_INVALID_RB_IMAGE = 3,
OTA_STATUS_INVALID_FLASH_SIZE = 4,
OTA_STATUS_ALREADY_ENABLED = 5,
OTA_STATUS_UPDATE_INPROGRESS = 6,
OTA_STATUS_IMAGE_VERIF_FAILED = 7,
OTA_STATUS_CONNECTION_ERROR = 8,
OTA_STATUS_SERVER_ERROR = 9,
OTA_STATUS_ABORTED = 10
} |
| This struct contains the OTA return status. More...
|
|
enum | tenuOtaUpdateStatusType {
DL_STATUS = 1,
SW_STATUS = 2,
RB_STATUS = 3,
AB_STATUS = 4
} |
| This struct contains the OTA update status type. More...
|
|
This enum contains all the WINC commands used for OTA operation.
Enumerator |
---|
M2M_OTA_REQ_NOTIF_SET_URL |
Reserved. Do not use.
|
M2M_OTA_REQ_NOTIF_CHECK_FOR_UPDATE |
Reserved. Do not use.
|
M2M_OTA_REQ_NOTIF_SCHED |
Reserved. Do not use.
|
M2M_OTA_REQ_START_UPDATE |
Request to start an OTA update.
|
M2M_OTA_REQ_SWITCH_FIRMWARE |
Request to switch firmware.
|
M2M_OTA_REQ_ROLLBACK |
Request to perform an OTA rollback.
|
M2M_OTA_REQ_ABORT |
Request to abort OTA.
|
M2M_OTA_RESP_NOTIF_UPDATE_INFO |
Reserved. Do not use.
|
M2M_OTA_RESP_UPDATE_STATUS |
Response to indicate the OTA update status.
|
M2M_OTA_REQ_TEST |
Reserved. Do not use.
|
M2M_OTA_MAX_ALL |
|
OTA Error codes.
Enumerator |
---|
OTA_SUCCESS |
OTA Success status
|
OTA_ERR_WORKING_IMAGE_LOAD_FAIL |
Failure to load the firmware image
|
OTA_ERR_INVALID_CONTROL_SEC |
Control structure is corrupted
|
M2M_ERR_OTA_SWITCH_FAIL |
Switching to the updated image failed as may be the image is invalid
|
M2M_ERR_OTA_START_UPDATE_FAIL |
OTA update fail due to multiple reasons:
- Connection failure
- Image integrity fail
|
M2M_ERR_OTA_ROLLBACK_FAIL |
Roll-back failed due to Roll-back image is not valid
|
M2M_ERR_OTA_INVALID_FLASH_SIZE |
The OTA Support at least 4MB flash size, this error code will appear if the current flash is less than 4M
|
M2M_ERR_OTA_INVALID_ARG |
Invalid argument in any OTA Function
|
M2M_ERR_OTA_INPROGRESS |
Ota still in progress
|
This struct contains the OTA return status.
Enumerator |
---|
OTA_STATUS_SUCCESS |
OTA Success with no errors.
|
OTA_STATUS_FAIL |
OTA generic fail.
|
OTA_STATUS_INVALID_ARG |
Invalid or malformed download URL.
|
OTA_STATUS_INVALID_RB_IMAGE |
Invalid rollback image.
|
OTA_STATUS_INVALID_FLASH_SIZE |
Flash size on device is not enough for OTA.
|
OTA_STATUS_ALREADY_ENABLED |
An OTA operation is already enabled.
|
OTA_STATUS_UPDATE_INPROGRESS |
An OTA operation update is in progress.
|
OTA_STATUS_IMAGE_VERIF_FAILED |
OTA Verification failed.
|
OTA_STATUS_CONNECTION_ERROR |
OTA connection error.
|
OTA_STATUS_SERVER_ERROR |
OTA server Error (file not found or else ...)
|
OTA_STATUS_ABORTED |
OTA download has been aborted by the application.
|
This struct contains the OTA update status type.
Enumerator |
---|
DL_STATUS |
Download OTA file status
|
SW_STATUS |
Switching to the upgrade firmware status
|
RB_STATUS |
Roll-back status
|
AB_STATUS |
Abort status
|