ducc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2022, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
 
#ifndef DUCC_H_
#define DUCC_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include "ducommon.h"
#include "dutransport.h"
 
/* ---------------------- Types --------------------------------------------- */
typedef uint32_t DUCC_Error;
#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)
 
typedef uint32_t DUCC_PendingAction;
#define PA_NONE       (0U)
#define PA_RUNLEVEL   (1U)
#define PA_USERACTION (2U)
 
typedef uint32_t DUCC_State;
#define STATE_DORMANT            (0U)
 
#define STATE_NO_CONNECTIVITY    (1U)
 
#define STATE_UP_TO_DATE         (2U)
 
#define STATE_UPDATE_AVAILABLE   (3U)
 
#define STATE_UPDATE_IN_PROGRESS (4U)
 
#define STATE_UPDATE_FAILED      (5U)
 
#define STATE_FATAL_ERROR        (6U)
#define NUM_DUCC_STATES          (7U)
 
typedef uint32_t DUCC_Locale;
#define DUCC_LOC_US (0U)
 
typedef uint32_t DUCC_Image;
#define DUCC_IMG_CURRENT (0U)
 
#define DUCC_IMG_PENDING (1U)
 
#define PR_NONE      (101U)
 
#define PR_MAX       (100U)
 
#define FILEPATH_MAX (512U)
 
#define DUCC_USERACTION_DEFAULT_SELECTION (0)
 
typedef struct DUCC *PDUCC;
 
typedef struct DUCC_Status
{
    DUCC_State         state;
    uint32_t           progress;
    DUCC_PendingAction pendingAction;
    uint32_t           pendingActionArgs;
} DUCC_Status;
 
typedef void (*DUCCCallback)(void *pObj,
                             const DUCC_Status *pStatus);
 
typedef struct optionEntry
{
    uint32_t userActionID;
    uint32_t contentOffset;
    uint32_t contentLen;
} optionEntry;
 
typedef struct optionBuffer
{
    uint32_t     numEntries;
    optionEntry *pEntry;
} optionBuffer;
 
typedef struct versionEntry
{
    uint32_t nameOffset;
    uint32_t nameLen;
    uint32_t versionOffset;
    uint32_t versionLen;
} versionEntry;
 
typedef struct versionBuffer
{
    uint32_t      numEntries;
    versionEntry *pEntry;
} versionBuffer;
 
typedef struct infoEntry
{
    uint32_t nameOffset;
    uint32_t nameLen;
    uint32_t contentOffset;
    uint32_t contentLen;
} infoEntry;
 
typedef struct infoBuffer
{
    uint32_t   numEntries;
    infoEntry *pEntry;
} infoBuffer;
 
/* -------------------- Function Declarations ------------------------------ */
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
);
#ifdef __cplusplus
}
#endif
 
#endif