Command and Control Client Library.
Control and interact using 'libnvducc'.
Definition in file ducc.h.
Go to the source code of this file.
Data Structures | |
| struct | DUCC_Status |
| Defines the DRIVE Update status structure returned from library function call. More... | |
| struct | optionEntry |
| Defines the entry inside option buffer header. More... | |
| struct | optionBuffer |
| Buffer for storing options. More... | |
| struct | versionEntry |
| Defines the entry inside version buffer header. More... | |
| struct | versionBuffer |
| Refer to optionBuffer struct memory layout. More... | |
| struct | infoEntry |
| Defines the entry inside info buffer header. More... | |
| struct | infoBuffer |
| Refer to optionBuffer struct memory layout. More... | |
Macros | |
| #define | DUCC_Success (0x00000000U) |
| #define | ERR_NotImplemented (0x00010000U) |
| #define | ERR_InvalidArgument (0x00010001U) |
| #define | ERR_NoPendingIMG (0x00010002U) |
| #define | ERR_PathNotExist (0x00010003U) |
| #define | ERR_OperationNotPermitted (0x00010004U) |
| #define | ERR_BufferTooSmall (0x00010005U) |
| #define | ERR_OperationRestrictedByConfig (0x00010006U) |
| #define | ERR_Busy (0x00010007U) |
| #define | ERR_UnableConnect (0x00020000U) |
| #define | ERR_ConnectionLost (0x00020001U) |
| #define | ERR_NoActiveConnection (0x00020002U) |
| #define | ERR_InvalidResponse (0x00020003U) |
| #define | PA_NONE (0U) |
| #define | PA_RUNLEVEL (1U) |
| #define | PA_USERACTION (2U) |
| #define | STATE_DORMANT (0U) |
| DRIVE Update is dormant and not connected. More... | |
| #define | STATE_NO_CONNECTIVITY (1U) |
| OTA is unable to connect to the cloud. More... | |
| #define | STATE_UP_TO_DATE (2U) |
| OTA is connected to the cloud. More... | |
| #define | STATE_UPDATE_AVAILABLE (3U) |
| OTA is connected to the cloud. More... | |
| #define | STATE_UPDATE_IN_PROGRESS (4U) |
| Update Installation is either in progress or paused awaiting user action or specified RunLevel. More... | |
| #define | STATE_UPDATE_FAILED (5U) |
| Last update failed and the cloud does not have any alternative updates to try or re-try. More... | |
| #define | STATE_FATAL_ERROR (6U) |
| Last update failed in a way which DOTA cannot recover. More... | |
| #define | NUM_DUCC_STATES (7U) |
| #define | DUCC_LOC_US (0U) |
| Defines the US locale. More... | |
| #define | DUCC_IMG_CURRENT (0U) |
| Defines the currently installed image state. More... | |
| #define | DUCC_IMG_PENDING (1U) |
| Defines the image pending installation state. More... | |
| #define | PR_NONE (101U) |
| Indicates no progress or progress not defined. More... | |
| #define | PR_MAX (100U) |
| Indicates progress number when it reaches 100%. More... | |
| #define | FILEPATH_MAX (512U) |
| Defines the max length of the file path. More... | |
| #define | DUCC_USERACTION_DEFAULT_SELECTION (0) |
| Default option for user actions, which will accept any terms or otherwise continue the installation process whenever applicable. More... | |
Typedefs | |
| typedef uint32_t | DUCC_Error |
| Defines the return codes of DRIVE Update C&C library function calls. More... | |
| typedef uint32_t | DUCC_PendingAction |
| Type of pending actions defined by DRIVE Update C&C interface. More... | |
| typedef uint32_t | DUCC_State |
| States defined by DRIVE Update C&C interface. More... | |
| typedef uint32_t | DUCC_Locale |
| Defines the locales used to get content. More... | |
| typedef uint32_t | DUCC_Image |
| Defines the image installation states. More... | |
| typedef struct DUCC * | PDUCC |
| Defines the DRIVE Update C&C handle. More... | |
| typedef struct DUCC_Status | DUCC_Status |
| Defines the DRIVE Update status structure returned from library function call. More... | |
| typedef void(* | DUCCCallback) (void *pObj, const DUCC_Status *pStatus) |
| Callback function when status changed. More... | |
| typedef struct optionEntry | optionEntry |
| Defines the entry inside option buffer header. More... | |
| typedef struct optionBuffer | optionBuffer |
| Buffer for storing options. More... | |
| typedef struct versionEntry | versionEntry |
| Defines the entry inside version buffer header. More... | |
| typedef struct versionBuffer | versionBuffer |
| Refer to optionBuffer struct memory layout. More... | |
| typedef struct infoEntry | infoEntry |
| Defines the entry inside info buffer header. More... | |
| typedef struct infoBuffer | infoBuffer |
| Refer to optionBuffer struct memory layout. More... | |
Functions | |
| DUCC_Error | DUCC_Init (DUTR_TR_TYPE trType, DUTR_SEC_TYPE seType, const PDUTR_TR_PARAM pTrParam, const PDUTR_SEC_PARAM pSeParam, PDUCC *ppDucc) |
| DUCC_Error | DUCC_Get_API_Version (PDUCC pDuccInfo, uint32_t *pVersion) |
| DUCC_Error | DUCC_Get_Current_RunLevel (PDUCC pDuccInfo, DU_RUN_LEVEL *pRunLevel) |
| DUCC_Error | DUCC_Request_RunLevel (PDUCC pDuccInfo, DU_RUN_LEVEL reqRunLevel) |
| DUCC_Error | DUCC_Get_Current_Status (PDUCC pDuccInfo, DUCC_Status *pStatus) |
| DUCC_Error | DUCC_Get_Versions (PDUCC pDuccInfo, DUCC_Image image, versionBuffer *pVersionBuf, uint32_t *pVersionBufsize) |
| DUCC_Error | DUCC_Close (PDUCC pDuccInfo) |