ducommon.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 DUCOMMON_H_
#define DUCOMMON_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stddef.h>
 
#define DU_UID_COMMON       (0U)
 
#define DU_UID_TRANSPORT    (1U)
 
#define DU_UID_LINK         (2U)
 
#define DU_UID_TII          (3U)
 
#define DU_UID_MASTER       (4U)
 
#define DU_UID_BHC          (5U)
 
#define DU_UID_RPE          (6U)
 
#define DU_UID_CCHECK       (7U)
 
#define DU_UID_AUTH         (8U)
 
#define DU_UID_CONTENT      (9U)
 
#define DU_UID_DECOMP       (10U)
 
typedef uint32_t DU_RCODE;
 
#define DU_ECODE(uid, suid, err) DU_ERR_CODE(uid, suid, err)
 
#define DU_ERR_UID_OFFSET (24U)
 
#define DU_ERR_UID_MASK ((uint32_t) 0xFFU)
 
#define DU_ERR_SUID_OFFSET (20U)
 
#define DU_ERR_SUID_MASK ((uint32_t) 0xFU)
 
#define DU_ERR_MASK ((uint32_t) 0xFFFFFU)
 
#define DU_ERR_CODE(uid, suid, err) \
    (DU_RCODE)((((uid)  & DU_ERR_UID_MASK)  << DU_ERR_UID_OFFSET)  | \
               (((suid) & DU_ERR_SUID_MASK) << DU_ERR_SUID_OFFSET) | \
               ((err)   & DU_ERR_MASK))
 
#define DU_ECODE_GET_UID(rcode)  (((rcode) >> 24U) & 0xFFU)
 
#define DU_ECODE_GET_SUID(rcode) (((rcode) >> 20U) & 0xFU)
 
#define DU_ECODE_GET_ERR(rcode)  ((rcode) & 0xFFFFFU)
 
#define DU_OK (DU_RCODE)(0U)
 
// Common error codes used by shared components only
#define DUCOMMON_ECODE(err)            DU_ECODE(DU_UID_COMMON, 0U, (err))
 
#define DUCOMMON_ERR_GENERIC           DUCOMMON_ECODE(1U)
#define DUCOMMON_ERR_INVALID_ARGUMENT  DUCOMMON_ECODE(2U)
#define DUCOMMON_ERR_NOT_FOUND         DUCOMMON_ECODE(3U)
#define DUCOMMON_ERR_BUFFER_TOO_SMALL  DUCOMMON_ECODE(4U)
#define DUCOMMON_ERR_SYNTAX            DUCOMMON_ECODE(5U)
 
#define DU_STR_LONG_BUF_SIZE  (128U)
 
#define DU_STR_SHORT_BUF_SIZE (32U)
 
#define DU_PATH_MAX           (512U)
 
#define DU_MAX_CMD_LEN        (512U)
 
#define DU_1KB   (1024U)
 
#define DU_2KB   (2U * DU_1KB)
 
#define DU_4KB   (4U * DU_1KB)
 
#define DU_8KB   (8U * DU_1KB)
 
#define DU_16KB  (16U * DU_1KB)
 
#define DU_32KB  (32U * DU_1KB)
 
#define DU_64KB  (64U * DU_1KB)
 
#define DU_128KB (128U * DU_1KB)
 
#define DU_256KB (256U * DU_1KB)
 
#define DU_512KB (512U * DU_1KB)
 
#define DU_1MB   (1024U * DU_1KB)
 
 
typedef enum DU_RUN_LEVEL
{
    RL_DORMANT = 0U,
    RL_MONITOR,
    RL_TELECAST,
    RL_XFER,
    RL_BG_APPLY,
    RL_FULL_APPLY,
    RL_UNRESTRICTED,
    RL_INVALID,
} DU_RUN_LEVEL;
 
#define DU_RUNLEVEL_STR_MAX_SIZE      (16U)
 
#ifdef __cplusplus
}
#endif
 
#endif // DUCOMMON_H_