OrgACRN
/
slimbootloader
mirror of https://github.com/slimbootloader/slimbootloader.git
1
0
Fork 0
Code Issues Releases Wiki Activity
slimbootloader/PayloadPkg/OsLoader/OsLoader.h

460 lines
12 KiB
C
Raw Blame History

/** @file
Copyright (c) 2017 - 2019, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __LINUX_LOADER_H__
#define __LINUX_LOADER_H__
#include <Library/LiteFvLib.h>
#include <Library/PartitionLib.h>
#include <Library/TimerLib.h>
#include <Library/FileSystemLib.h>
#include <Library/PayloadMemoryAllocationLib.h>
#include <Library/DebugPrintErrorLevelLib.h>
#include <Library/DecompressLib.h>
#include <Library/PayloadLib.h>
#include <Library/ShellLib.h>
#include <Library/IasImageLib.h>
#include <Library/MultibootLib.h>
#include <Library/MediaAccessLib.h>
#include <Library/PayloadEntryLib.h>
#include <Library/LitePeCoffLib.h>
#include <Library/HobLib.h>
#include <Library/PrintLib.h>
#include <Library/Crc32Lib.h>
#include <Library/PcdLib.h>
#include <Library/BootOptionLib.h>
#include <Library/TpmLib.h>
#include <Library/VariableLib.h>
#include <Library/MmcTuningLib.h>
#include <Library/ShellExtensionLib.h>
#include <Library/LoaderPerformanceLib.h>
#include <Library/RpmbLib.h>
#include <Library/GraphicsLib.h>
#include <Library/SerialPortLib.h>
#include <Library/ConsoleInLib.h>
#include <Library/ConsoleOutLib.h>
#include <Library/ConfigDataLib.h>
#include <Library/AbSupportLib.h>
#include <Library/SblParameterLib.h>
#include <Library/TrustyBootLib.h>
#include <Library/UsbInitLib.h>
#include <Library/UsbKbLib.h>
#include <Library/ElfLib.h>
#include <Library/LinuxLib.h>
#include <Library/ContainerLib.h>
#include <Guid/SeedInfoHobGuid.h>
#include <Guid/OsConfigDataHobGuid.h>
#include <Guid/OsBootOptionGuid.h>
#include <Library/SeedListInfoLib.h>
#include <Guid/GraphicsInfoHob.h>
#include <Guid/LoaderPlatformInfoGuid.h>
#include <Guid/BootLoaderVersionGuid.h>
#include <Guid/LoaderPlatformInfoGuid.h>
#include <Service/PlatformService.h>
#include <IndustryStandard/Mbr.h>
#include <Uefi/UefiGpt.h>
#include "BlockIoTest.h"
#include <ConfigDataCommonDefs.h>
#include "PreOsChecker.h"
#define MKHI_BOOTLOADER_SEED_LEN 64
#define DEFAULT_COMMAND_LINE "console=ttyS0,115200\0"
#define BOOT_PARAMS_BASE 0x00090000
#define LINUX_KERNEL_BASE 0x00100000
#define CMDLINE_OFFSET 0xF000
#define CMDLINE_LENGTH_MAX 0x800
#define EOF "<eof>"
#define GPT_PART_ENTRIES_MAX 4
#define LOADED_IMAGE_IAS BIT0
#define LOADED_IMAGE_MULTIBOOT BIT1
#define LOADED_IMAGE_LINUX BIT2
#define LOADED_IMAGE_PE32 BIT3
#define LOADED_IMAGE_FV BIT4
#define LOADED_IMAGE_CONTAINER BIT5
#define MAX_EXTRA_FILE_NUMBER 16
#define MAX_BOOT_MENU_ENTRY 8
#define MAX_STR_SLICE_LEN 16
typedef struct {
UINT32 Pos;
UINT32 Len;
CHAR8 Buf[MAX_STR_SLICE_LEN];
} STR_SLICE;
typedef struct {
STR_SLICE Name;
STR_SLICE Command;
STR_SLICE Kernel;
STR_SLICE InitRd;
} MENU_ENTRY;
typedef struct {
UINT32 Default;
UINT32 Timeout;
} CFG_SETTING;
typedef struct {
UINT32 EntryNum;
CFG_SETTING Settings;
MENU_ENTRY MenuEntry[MAX_BOOT_MENU_ENTRY];
} LINUX_BOOT_CFG;
typedef struct {
IMAGE_DATA BootFile;
IMAGE_DATA CmdFile;
IMAGE_DATA InitrdFile;
UINT16 Reserved;
UINT16 ExtraBlobNumber;
IMAGE_DATA ExtraBlob[MAX_EXTRA_FILE_NUMBER];
BOOT_PARAMS *BootParams;
} LINUX_IMAGE;
typedef struct {
IMAGE_DATA BootFile;
IMAGE_DATA CmdFile;
} COMMON_IMAGE;
typedef union {
COMMON_IMAGE Common;
MULTIBOOT_IMAGE MultiBoot;
LINUX_IMAGE Linux;
} LOADED_IMAGE_TYPE;
typedef struct {
UINT8 Flags;
UINT8 LoadImageType;
UINT16 Reserved;
IMAGE_DATA IasImage;
EFI_HANDLE HwPartHandle;
LOADED_IMAGE_TYPE Image;
UINT8 ImageHash[SHA256_DIGEST_SIZE];
} LOADED_IMAGE;
/**
OS Loader module entry point. Can also be used to get the
base address of the OS Loader's location in memory.
**/
VOID
_ModuleEntryPoint (
VOID
);
/**
Print out the Multiboot information block.
@param[in] Mi The Multiboot information block to be printed.
**/
VOID
DumpMbInfo (
IN CONST MULTIBOOT_INFO *Mi
);
/**
Print out the Multiboot boot state.
@param[in] BootState The Multiboot boot state pointer.
**/
VOID
DumpMbBootState (
IN CONST IA32_BOOT_STATE *BootState
);
/**
Dumps the content of the buffer starting from Address.
@param[in] Address Start address of buffer to dump
@param[in] Length Size of the buffer to dump
**/
VOID
DumpBuffer (
IN CHAR8 *Address,
IN UINT32 Length
);
/**
Print the OS boot option list.
@param[in] OsBootOptionList the OS boot option list
**/
VOID
PrintBootOptions (
OS_BOOT_OPTION_LIST *OsBootOptionList
);
/**
Get a pointer of Loaded Image which has specific LoadImageType
This function will return the pointer address of a Loaded Image with given
LoadImageType.
@param[in] LoadedImageHandle Loaded Image handle
@param[in] LoadImageType Load Image Type Index
@param[out] LoadedImage Loaded Image
@retval EFI_SUCCESS Found a Loaded Image from the handle successfully
@retval EFI_INVALID_PARAMETER If Loaded Image handle is invalid
@retval EFI_NOT_FOUND Not found a Loaded Image from the handle
**/
EFI_STATUS
EFIAPI
GetLoadedImageByType (
IN EFI_HANDLE LoadedImageHandle,
IN LOAD_IMAGE_TYPE LoadImageType,
OUT LOADED_IMAGE **LoadedImage
);
/**
Free all temporary resources used for Boot Image
This function will clean up all temporary resources used to load Boot Image.
@param[in] LoadedImageHandle Loaded Image handle
@retval none
**/
VOID
EFIAPI
UnloadBootImages (
IN EFI_HANDLE LoadedImageHandle
);
/**
Load Image from boot media.
This function will initialize OS boot device, and load image based on
boot option, the loaded image info will be saved in LoadedImage.
@param[in] BootOption Current boot option
@param[in] HwPartHandle Hardware partition handle
@param[in] FsHandle FileSystem handle
@param[out] LoadedImageHandle Loaded Image handle
@retval RETURN_SUCCESS If image was loaded successfully
@retval Others If image was not loaded.
**/
EFI_STATUS
EFIAPI
LoadBootImages (
IN OS_BOOT_OPTION *OsBootOption,
IN EFI_HANDLE HwPartHandle,
IN EFI_HANDLE FsHandle,
OUT EFI_HANDLE *LoadedImageHandle
);
/**
Wrapper function to print LinuxLoader Measure Point information.
**/
VOID
PrintLinuxMeasurePoint (
VOID
);
/**
Get command line arguments from the config file.
This function will read command line arguments and put
it into Buffer.
@param[out] Buffer Buffer to get command line arguments
@param[in] BufferLen Buffer size
@param[in] File Pointer to the config file
@param[in] FileLen File size
@retval Number of bytes read from the config file.
**/
UINTN
GetFromConfigFile (
OUT UINT8 *Buffer,
IN UINT32 BufferLen,
IN UINT8 *File,
IN UINT32 FileLen
);
/**
Update OS boot parameters
This function will append reqired command line parameters,
and update mem map info.
@param[in] BootOption Current boot option
@param[in,out] LoadedImage Normal OS boot image
@param[in,out] LoadedTrustyImage Trusty OS image
@param[in,out] LoadedExtraImages Extra OS images
@retval RETURN_SUCCESS If update OS parameter success
@retval Others Failed to update OS parameters
**/
EFI_STATUS
UpdateOsParameters (
IN OS_BOOT_OPTION *BootOption,
IN OUT LOADED_IMAGE *LoadedImage,
IN OUT LOADED_IMAGE *LoadedTrustyImage,
IN OUT LOADED_IMAGE *LoadedExtraImages
);
/**
Get the boot option index to start to boot with.
@param[in] OsBootOptionList the OS boot option list
@param[in] BootOptionIndex Previous boot option index.
@retval New boot option index
**/
UINT8
GetCurrentBootOption (
IN OS_BOOT_OPTION_LIST *OsBootOptionList,
IN UINT8 BootOptionIndex
);
/**
Get the next boot option index to boot with.
@param[in] OsBootOptionList the OS boot option list
@param[in] BootOptionIndex Current boot option index.
@retval New boot option index
**/
UINT8
GetNextBootOption (
IN OS_BOOT_OPTION_LIST *OsBootOptionList,
IN UINT8 BootOptionIndex
);
/**
ASM function that goes into kernel image.
@param KernelStart Pointer to the start of kernel.
@param KernelBootParams Pointer to the boot parameter structure.
**/
VOID
EFIAPI
JumpToKernel (
VOID *KernelStart,
VOID *KernelBootParams
);
/**
Seed Sanity check to check seed HOB validity before passing to OS.
This is needed to ensure that only the correct seeds are passed from Stage2 HOB buffer
to OS based on the Image type( OS, Trusty flags) for current target boot index[0].
1.native android (AOS loader) without Trusty OS (evmm) = only rpmb needed
2.native android (AOS loader) with Trusty OS = dseed + rpmb
3.Clear linux without Trusty = useed + dseed
4.Clear Linux with Trusty (no AOS loader) = all (useed/dseed/rpmb keys)
5.ACRN = all
@param[in] CurrentBootOption Current boot option
@param[in,out] SeedList Pointer to the Seed list
@retval EFI_SUCCESS Successfully checked the seed validity.
@retval EFI_NOT_FOUND Couldnt retrieve seeds or couldnt find bootoptionslist.
**/
EFI_STATUS
SeedSanityCheck (
IN OS_BOOT_OPTION *CurrentBootOption,
IN OUT LOADER_SEED_LIST *SeedList
);
/**
Check the eMMC storage serial number validity.
If card serial number != SPI flash serial number, then
save the new serial number from the card to SPI flash and
warm reset the platform.
@retval EFI_SUCCESS Successfully checked and saved the serial number.
@retval EFI_NOT_FOUND Couldnt retrieve serial number either from card or flash.
@retval EFI_DEVICE_ERROR Couldnt save the new serial number to SPI flash.
**/
EFI_STATUS
EmmcSerialNumCheck (
VOID
);
/**
Provision the RPMB key into RPMB partition.
Currently, there is only eMMC RPMB support. So this flow works
only if DeviceType = eMMC.
@param[in] CurrentBootOption Current boot option
@param[in] SeedList Pointer to the Seed list
@retval EFI_SUCCESS Successfully provisioned the RPMB key.
@retval EFI_NOT_FOUND Couldn't find PlatformService->CfgData or PlatformInfo
or SeedList not found.
@retval EFI_UNSUPPORTED RpmbProvisioning CfgData flag not enabled or SeedList
feature not enabled.
@retval EFI_OUT_OF_RESOURCES Couldn't allocate memory.
@retval Others Error occurred inside RPMB library.
**/
EFI_STATUS
RpmbKeyProvisioning (
IN OS_BOOT_OPTION *CurrentBootOption,
IN LOADER_SEED_LIST *SeedList
);
/**
Parse the Linux boot configuration file.
@param[in] CfgBuffer The configuration buffer.
@param[out] LinuxBootCfg The pointer to hold the parse results.
**/
VOID
ParseLinuxBootConfig (
IN CHAR8 *CfgBuffer,
OUT LINUX_BOOT_CFG *LinuxBootCfg
);
/**
Print Linux boot options.
@param[in] CfgBuffer The configuration buffer.
@param[out] LinuxBootCfg The pointer to hold the parse results.
**/
VOID
PrintLinuxBootConfig (
CHAR8 *CfgBuffer,
LINUX_BOOT_CFG *LinuxBootCfg
);
/**
Get Linux boot option from user input.
@param[in] CfgBuffer The configuration buffer.
@param[out] LinuxBootCfg The pointer to hold the parse results.
@retval 0 based boot option index.
**/
UINT32
GetLinuxBootOption (
CHAR8 *CfgBuffer,
LINUX_BOOT_CFG *LinuxBootCfg
);
#endif
Reference in New Issue View Git Blame Copy Permalink