bootkernel.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_BOOTKERNEL_H
#define INCLUDED_BOOTKERNEL_H

#include <nvcommon.h>
#include <bug.h>

#define KERNEL_CMDLINE_SIZE (2 * KB)

#define IMAGE_MAGIC "BOOT_IMAGE!"
#define IMAGE_MAGIC_SIZE 12
#define CMDLINE_BUF_SIZE 40

#define NATIVE_BOOT 1
#define VIRTUALIZED_BOOT 2

typedef enum {
    BootImageType_Linux = 1,
    BootImageType_Qnx = 2,
    BootImageType_Android = 3,
    BootImageType_Integrity = 4,
    BootImageType_Mods = 5,
    BootImageType_Ramdisk = 6,
    BootImageType_Hypervisor = 7,
    BootImageType_Force = 0x7FFFFFFF,
} BootImageType;

typedef enum {
    BootImage_CompressionNone = 0,
    BootImage_CompressionLz4 = 3,
    BootImage_Force = 0x7FFFFFFF,
} BootImage_Compression;

typedef enum {
    BootImageStreamValidation_No = 0,
    BootImageStreamValidation_Yes = 1,
    BootImageStreamValidation_Force = 0x7FFFFFFF,
} BootImageStreamValidation;

typedef enum {
    BootImageLoading_NoCompression_NoStreamValidation =
            (BootImageStreamValidation_No << 4) | BootImage_CompressionNone,
    BootImageLoading_NoCompression_StreamValidation =
            (BootImageStreamValidation_Yes << 4) | BootImage_CompressionNone,
    BootImageLoading_CompressionLz4_NoStreamValidation =
            (BootImageStreamValidation_No << 4) | BootImage_CompressionLz4,
    BootImageLoading_CompressionLz4_StreamValidation =
            (BootImageStreamValidation_Yes << 4) | BootImage_CompressionLz4,
    BootImageLoading_Force = 0x7FFFFFFF,
} BootImageLoading;

typedef enum {
    BootGuidType_Windows = 0,
    BootGuidType_Linux,
    BootGuidType_Qnx,
} BootGuidType;

#define RECOVERY_KERNEL_BIT (1 << 31)
#define UPDATE_KERNEL_BIT (1 << 29)

NvError
QbLoadAndBootKernel(
        const NvS8 *pKernelPartName,
        const NvS8 *pRamdiskPartName,
        const NvS8 *pDtbPartName);

NvError
QbLoadBootImages(
        const NvS8 *pKernName,
        const NvS8 *pRamdiskName,
        const NvS8 *pDtbPartName,
        NvUPtr *pBootAddrVirt,
        NvUPtr *pRamDiskAddrVirt,
        NvUPtr **pDtAddrVirt,
        NvU32 *pKernelUnCompressSize,
        NvU32 *pRamdiskUncompressSize);

void KernelCmdLine(NvU32 RatchetFuseBurnStatus);

#ifdef CONFIG_HYPERVISOR_SUPPORT

NvError QbStoreGuestCmdLine(void);

#ifdef CONFIG_SUPPORT_BOOTDATA

NvError AddBootDataToSysInfo(void);

#endif
#endif

void KernelDT(void);

void AppendBoardDT(void);

#ifdef CONFIG_SUPPORT_BOOTDATA

void AddBootDataToDT(void);
#endif

NvError QbDefaultLoadAndBootKernel(void);

NvError QbBoardLoadAndBootKernel(void);

NvError QbGetSerialNum(NvU8 **pSerialNum, NvU32 *DataSize);

NvBool QbIsHypervisorBoot(void);

NvBool QbIsAndroidBoot(void);

static inline void AdjustPointers(NvS32 *pRemains, NvS8 **pPtr, NvS32 len)
{
    if (!pRemains || !pPtr || (*pRemains <= len))
        BUG();

    *pRemains -= len;
    *pPtr += len;
}

NvError QbQueryMemInfo(NvU8 **pData, NvU32 *pDataSize, NvU64 ReserveMemSize);

void QbPerformHandOff(
        NvUPtr *pKernelRegs,
        NvU32 NumKernelRegs,
        NvUPtr KernelStartAddr);

extern BootImageType s_g_BootImageType;
#endif //INCLUDED_BOOTKERNEL_H