qbpartmgr.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2018, 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 INCLUDED_QBPARTMGR_H
#define INCLUDED_QBPARTMGR_H

#include <nvcommon.h>
#include <partition.h>
#include <device_id.h>
#include <kernel_dt_service.h>

#define MAX_PARTITIONS_INDEX    41
#define MAX_NUM_PARTITIONS      (MAX_PARTITIONS_INDEX - 1)
#define GPT_SIZE_IN_SECTORS 33
#define GUEST_BOOT_PARTITION_FLAG 0x80000000

#define PT_LEVEL_1 (1)
#define PT_LEVEL_2 (2)

typedef struct QbAllocPartArgsRec
{
    NvU64 StartLocation;
    NvU64 Size;
    NvU64 StartLogicalAddress;
    NvU64 NumLogicalBytes;
    NvU64 StartPhysicalAddress;
    NvU64 EndPhysicalAddress;
    NvU64 DeviceSize;
    NvPartMgrAllocPolicyType AllocationType;
    NvU32 Index;
    NvU32 AllocationAttribute;
    QbPartitionType PartitionType;
} QbAllocPartArgs;

NvError QbLoadAndInitPartMgr(void);

NvBool QbQueryThreeLevelPtInfo(void);

NvError
QbPartMgrInit(void);

void
QbPartMgrDeinit(void);

NvError
QbPartMgrLoadTable(
    QbDriver DeviceId,
    NvU32 DeviceInstance,
    NvU64 StartLogicalByte,
    NvU64 NumLogicalBytes,
    NvBool IsSigned,
    NvBool IsEncrypted);

/*
 * Query prefix used for specified boot chain and prepend it to the partition name.
 *
 * @param pPartName Buffer holding partition name, also gets updated with the prefix.
 * @param Size size of the buffer.
 * @param IsActiveChain Boolean flag telling whether to prepend prefix for active or inactive chain.
 *
 * @return NvSuccess if the partition table load was successful, or an appropriate error code.
 */
NvError
QbPrependBootChainPrefix(
        NvS8 *pPartName,
        NvU32 Size,
        NvBool IsActiveChain);

/*
 * Query partition name from partition type based on the boot chain type.
 *
 * @param PartType QbPartitionType for which partition name is to be queried.
 * @param IsActiveChain Boolean flag telling partition name required for active or inactive chain.
 * @param pPartName Buffer holding partition name, also gets updated with the boot chain prefix.
 * @param PartNameBufferSize size of the buffer.
 *
 * @return NvSuccess if the partition name is successfully populated, or an appropriate error code.
 */

NvError
QbGetPartNameFromType(
    QbPartitionType PartType,
    NvBool IsActiveChain,
    NvS8 *pPartName,
    NvS32 PartNameBufferSize);

NvError QbPartMgrQueryIvcChannelInfo(NvU32 PartId, NvU32 *pIvc);

NvError
QbPartMgrLoadAllPt(
    QbDriver DeviceId,
    NvU32 DeviceInstance);

NvError
QbPartMgrLoadSecondLevelPt(
    QbDriver DeviceId,
    NvU32 DeviceInstance);

void QbPartMgrLoadAllGuestPt(void);

#ifdef CONFIG_OS_LOADER

NvError QbUpdateGuestPartInfo(void);

NvError QbUpdateGuestPartTableWithSysInfo(void);

#endif

NvError
QbPartMgrCreateTableStart(NvU32 NumPartitions);

NvError
QbPartMgrCreateTableFinish(void);

NvError
QbPartMgrAddTableEntry(
    NvU32 PartId,
    char *pPartName,
    char *pGuestPartName,
    QbPartInfo PartInfo,
    QbAllocPartArgs PartArgs);

NvError
QbPartMgrSaveTable(
    QbDriver DeviceId,
    NvU32 DevInstance,
    NvBool SignTable,
    NvBool EncryptTable,
    NvS8 *FileName);

NvError
QbPartMgrGetIdByName(
    const char *PartitionName,
    NvU32 *PartitionId);

NvError
QbPartMgrGetIdByType(
    QbPartitionType PartitionType,
    NvU32 *PartitionId);

NvError
QbPartMgrGetNameById(
    NvU32 PartitionId,
    char *PartitionName);

NvError
QbPartMgrGetNameByIdFromBuffer(
    NvU32 PartitionId,
    char *PartitionName,
    QbPartitionTable QbPartTable);

NvError
QbPartMgrGetBootCompHdrPartId(
    NvU32 PartitionId,
    NvU32 *BootCompHdrPartId);

NvError
QbPartMgrGetPartInfo(
    NvU32 PartitionId,
    QbPartInfo *pPartInfo);

NvError
QbPartMgrGetPartInfoFromBuffer(
    NvU32 PartitionId,
    QbPartInfo *pPartInfo,
    QbPartitionTable QbPartTable);

NvU32
QbPartMgrGetNextId(
    NvU32 PartitionId);

NvU32
QbPartMgrGetNextIdFromBuffer(
    NvU32 PartitionId, QbPartitionTable QbPartTable);

NvU32
QbPartMgrGetNextIdForDeviceInstance(
    NvU32 DeviceId,
    NvU32 DeviceInstance,
    NvU32 PartitionId);

NvError
QbPartMgrGetNextDeviceInstance(
        NvU32 DeviceId,
        NvU32 DeviceInstance,
        NvU32 *NextDeviceId,
        NvU32 *NextDeviceInstance);

NvU32
QbPartMgrGetNumPartition(void);

#ifdef CONFIG_HYPERVISOR_SUPPORT

NvError QbQueryAssignedPartitions(
            NvU32 GuestId,
            NvU32 Level,
            QbPartitionChainType ChainType,
            QbPartitionTableEntry *pPtEntries,
            NvU32 NumPtEntries,
            NvU32 *pNumFilledEntries);

void QbInitGuestAssignmentTable(void);

NvU32 QbGetStorageServerId(void);

NvU32 QbGetUpdateServerId(void);

NvU32 QbGetMaxGuestId(void);

NvU32 QbGetNumAssignedPartitions(NvU32 GuestId);

#endif

NvError QbPartMgrShowPT(void);

NvError
QbDeviceGetPartitionIdByOffset(
        QbDriver DriverType,
        NvU32 Instance,
        NvU64 Offset,
        NvU32 *PartitionId);

#ifndef QB_BL_BUILD

NvError NvLoadPtFromFile(NvS8 *pPtImagePath);

NvError NvLoadPtFromFileToBuffer(NvS8 *pPtImagePath,
        NvBool IsSigned, QbPartitionTable **ppQbPartTable);

#else

NvError QbPartMgrQueryUpdateInfo(DtUpdateInfo *pDtUpdateInfo);

#endif

#endif /* #ifndef INCLUDED_QBPARTMGR_H */