dus_common_data.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
#ifndef DUS_COMMON_DATA_H_
#define DUS_COMMON_DATA_H_
 
#include <stdint.h>
 
/* Common definitions */
 
#define DUS_IVC_MEMPOOL_DATA_VERSION (0x1)
 
/* Definations of the chain/command/operation/magic */
// CHAIN_TYPE
#define CHAIN_A         (0U)
#define CHAIN_B         (1U)
#define CHAIN_C         (2U)
#define CHAIN_INVALID   (3U)
// For persist partition in L1PT
#define CHAIN_PERSIST   (0xFFU)
typedef uint8_t CHAIN_TYPE;
 
// IVC_CMD
#define CMD_APPLY_PAYLOAD               (0U)
#define CMD_MARK_BOOTABLE               (1U)
#define CMD_APPLY_PAYLOAD_PERSISTENT    (2U)
#define CMD_BRBCT_UPDATE                (3U)
#define CMD_GET_CONTENT                 (4U)
#define CMD_RELOAD_PT                   (5U)
#define CMD_GET_PARTS_INFO              (6U)
#define CMD_GET_SERVER_LOG              (7U)
#define CMD_GET_PT_LOG                  (8U)
#define CMD_MAX                         (9U)
typedef uint32_t CMD_TYPE;
 
// PAYLOAD_OPERATION
#define PAYLOAD_DISCARD             (0U)
#define PAYLOAD_REPLACE             (1U)
#define PAYLOAD_COPY                (2U)
#define PAYLOAD_PATCH               (3U)
#define PAYLOAD_BRBCT_UPDATE        (4U)
#define PAYLOAD_MARK_BOOTABLE       (5U)
#define PAYLOAD_PERSISTENT_UPDATE   (6U)
#define PAYLOAD_OPERATION_MAX   (0xFFU)
typedef uint8_t PAYLOAD_TYPE;
 
// Mempool direction
#define MEMPOOL_DIRECTION_CLIENT_TO_SERVER (0U)
#define MEMPOOL_DIRECTION_SERVER_TO_CLIENT (1U)
 
// Magic Number definitions in big-endian presentation
#define MAGIC_NVDUCMD   (0x00444d435544564eU)
#define MAGIC_NVDURET   (0x005445525544564eU)
#define MAGIC_NVDUMEM   (0x004d454d5544564eU)
#define MAGIC_NVDUPLD   (0x00444c505544564eU)
 
#define DUS_PARTITION_LEVEL_1 (1U)
#define DUS_PARTITION_LEVEL_2 (2U)
#define DUS_PARTITION_LEVEL_3 (3U)
 
//  (A/B/C) + '_' + guest ID + '_' + container name (24, gpt partition) + '_' + partition name (24)
// and up align 8 bytes
#define DUS_PART_NAME_LENGTH (64U)
 
#define DUS_GUEST_ID_MASK                   ((1U << 5) - 1U)
 
#define DUS_GPT_CONTAINER                   (0x10000000U)
 
#define DUS_MAX_PARTITION_NUM (300U)
 
#define DUS_STORAGE_TYPE_QSPI     (0U)
#define DUS_STORAGE_TYPE_EMMC     (1U)
#define DUS_STORAGE_TYPE_UFS      (2U)
#define DUS_STORAGE_TYPE_INVALID  (0xFFFFU)
 
typedef struct __attribute__((packed)) DUS_IVC_TX
{
    // Magic number: NVDUCMD = 0x00444d435544564eU
    uint64_t    magic;
    // Version Number
    uint8_t     version;
    // Reserve1: [9, 31]
    uint8_t     reserved1[23];
    // Command ID
    uint32_t    cmd;
    // Chain ID
    uint8_t     chain;
    // Length of send data(mempool data length)
    uint32_t    lengthOfMempool;
    // Reserved2: [41, 63]
    uint8_t     reserved2[23];
 
} DUS_IVC_TX;
 
typedef struct __attribute__((packed)) DUS_IVC_RX
{
    // Magic char: NVDURET 0x005445525544564eU
    uint64_t    magic;
    // Version Number
    uint8_t     version;
    // Return code for the previous command
    uint32_t    retCode;
    // Length of Ret data(mempool data length)
    uint32_t    lengthOfMempool;
    // Message info
    uint8_t     msg[47];
} DUS_IVC_RX;
 
typedef union DUS_IVC_DATA
{
    DUS_IVC_TX tx;
    DUS_IVC_RX rx;
} DUS_IVC_DATA;
 
typedef struct __attribute__((packed)) DUS_MEMPOOL_HEADER
{
    // Magic: NVDUMEM 0x004d454d5544564eU
    uint64_t    magic;
    // Version
    uint8_t     version;
    // Direction: 0x0 for DUS data input, 0x1 for DUS data output
    uint8_t     direction;
    // Reserved;
    uint8_t     reserved[22];
} DUS_MEMPOOL_HEADER;
 
typedef struct __attribute__((packed)) DUS_PAYLOAD_HEADER
{
    // Magic: NVDUPLD 0x00444c505544564eU
    uint64_t    magic;
    // Version
    uint8_t     version;
    // Length of the payload (Exclude Signature) in bytes
    uint32_t    payloadLength;
    // Signed
    uint8_t     isSigned;
    // Operation code
    uint8_t     operationCode;
} DUS_PAYLOAD_HEADER;
 
 
typedef struct __attribute__((packed)) DUS_PART_INFO
{
    uint32_t partitionAttr;
    char partName[DUS_PART_NAME_LENGTH];
    uint64_t partitionSize;
    char containerPartName[DUS_PART_NAME_LENGTH];
    uint32_t  partitionLevel;
    uint32_t  blockSize;
    uint32_t  storageType;
} DUS_PART_INFO;
 
typedef struct __attribute__((packed)) DUS_ALL_PART_INFO
{
    uint32_t numPartitions;
    DUS_PART_INFO partInfo[DUS_MAX_PARTITION_NUM];
} DUS_ALL_PART_INFO;
 
#endif // DUS_COMMON_DATA_H_