mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-11-26 12:05:36 +01:00
158 lines
4.5 KiB
C
158 lines
4.5 KiB
C
/*
|
|
* BootOptions.h
|
|
*
|
|
* Created on: 16 Apr 2020
|
|
* Author: jief
|
|
*/
|
|
|
|
#ifndef PLATFORM_BOOTOPTIONS_H_
|
|
#define PLATFORM_BOOTOPTIONS_H_
|
|
|
|
extern "C" {
|
|
#include <Protocol/DevicePath.h>
|
|
}
|
|
|
|
typedef struct {
|
|
///
|
|
/// XXXX in BootXXXX.
|
|
///
|
|
UINT16 BootNum;
|
|
///
|
|
/// Pointer to raw EFI_LOAD_OPTION (BootXXXX) variable content.
|
|
///
|
|
void *Variable;
|
|
///
|
|
/// Variable size in bytes.
|
|
///
|
|
UINTN VariableSize;
|
|
///
|
|
/// BootOption Attributes (first 4 bytes from Variable).
|
|
///
|
|
UINT32 Attributes;
|
|
///
|
|
/// BootOption FilePathListLength (next 2 bytes from Variable).
|
|
///
|
|
UINT16 FilePathListLength;
|
|
///
|
|
/// Null terminated BootOption Description (pointer to 6th byte of Variable).
|
|
///
|
|
CONST CHAR16 *Description;
|
|
///
|
|
/// Size in bytes of BootOption Description.
|
|
///
|
|
UINTN DescriptionSize;
|
|
///
|
|
/// Pointer to BootOption FilePathList.
|
|
///
|
|
EFI_DEVICE_PATH_PROTOCOL *FilePathList;
|
|
///
|
|
/// Pointer to BootOption OptionalData.
|
|
///
|
|
UINT8 *OptionalData;
|
|
///
|
|
/// BootOption OptionalData size in bytes.
|
|
///
|
|
UINTN OptionalDataSize;
|
|
} BO_BOOT_OPTION;
|
|
|
|
|
|
/** Finds and returns pointer to specified DevPath node in DevicePath or NULL. */
|
|
EFI_DEVICE_PATH_PROTOCOL *
|
|
Clover_FindDevicePathNodeWithType (
|
|
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
|
|
IN UINT8 Type,
|
|
IN UINT8 SubType OPTIONAL
|
|
);
|
|
|
|
//Parses BootXXXX (XXXX = BootNum) var (from BootOption->Variable) and returns it in BootOption.
|
|
EFI_STATUS
|
|
ParseBootOption (OUT BO_BOOT_OPTION *BootOption);
|
|
|
|
/** Prints BootXXXX vars found listed in BootOrder, plus print others if AllBootOptions == true. */
|
|
void
|
|
PrintBootOptions (
|
|
IN XBool AllBootOptions
|
|
);
|
|
|
|
/** Prints BootOrder with DBG. */
|
|
void
|
|
PrintBootOrder (
|
|
IN UINT16 BootOrder[],
|
|
IN UINTN BootOrderLen
|
|
);
|
|
|
|
/** Reads BootXXXX (XXXX = BootNum) var, parses it and returns in BootOption.
|
|
* Caller is responsible for releasing BootOption->Variable with FreePool().
|
|
*/
|
|
EFI_STATUS
|
|
GetBootOption (
|
|
IN UINT16 BootNum,
|
|
OUT BO_BOOT_OPTION *BootOption
|
|
);
|
|
|
|
/** Returns gEfiGlobalVariableGuid:BootOrder as UINT16 array and it's length (num of elements).
|
|
* Caller is responsible for releasing BootOrder mem (FreePool()).
|
|
*/
|
|
EFI_STATUS
|
|
GetBootOrder (
|
|
OUT UINT16 *BootOrder[],
|
|
OUT UINTN *BootOrderLen
|
|
);
|
|
|
|
/** Searches BootXXXX vars for entry that points to given FileDeviceHandle/FileName
|
|
* and returns BootNum (XXXX in BootXXXX variable name) and BootIndex (index in BootOrder)
|
|
* if found.
|
|
*/
|
|
EFI_STATUS
|
|
FindBootOptionForFile (
|
|
IN EFI_HANDLE FileDeviceHandle,
|
|
IN CHAR16 *FileName,
|
|
OUT UINT16 *BootNum,
|
|
OUT UINTN *BootIndex
|
|
);
|
|
|
|
/** Adds new boot option for given file system device handle FileDeviceHandle, file path FileName
|
|
* and Description, to be BootIndex in the list of options (0 based).
|
|
* If UseShortForm == true, then only the hard drive media dev path will be used instead
|
|
* of full device path.
|
|
* Long (full) form:
|
|
* PciRoot(0x0)/Pci(0x1f,0x2)/Sata(0x1,0x0)/HD(1,GPT,96004846-a018-49ad-bc9f-4e5a340adc4b,0x800,0x64000)/\EFI\BOOT\File.efi
|
|
* Short form:
|
|
* HD(1,GPT,96004846-a018-49ad-bc9f-4e5a340adc4b,0x800,0x64000)/\EFI\BOOT\File.efi
|
|
*/
|
|
EFI_STATUS
|
|
AddBootOptionForFile (
|
|
IN EFI_HANDLE FileDeviceHandle,
|
|
IN CONST XStringW &FileName,
|
|
IN XBool UseShortForm,
|
|
IN CONST CHAR16 *Description,
|
|
IN UINT8 *OptionalData,
|
|
IN UINTN OptionalDataSize,
|
|
IN UINTN BootIndex,
|
|
OUT UINT16 *BootNum
|
|
);
|
|
|
|
/** Deletes boot option specified with BootNum (XXXX in BootXXXX var name). */
|
|
EFI_STATUS
|
|
DeleteBootOption (
|
|
IN UINT16 BootNum
|
|
);
|
|
|
|
|
|
/** Deletes boot option for file specified with FileDeviceHandle and FileName. */
|
|
EFI_STATUS
|
|
DeleteBootOptionForFile (
|
|
IN EFI_HANDLE FileDeviceHandle,
|
|
IN CONST XStringW& FileName
|
|
);
|
|
|
|
/** Deletes all boot option that points to a file which contains FileName in it's path. */
|
|
EFI_STATUS
|
|
DeleteBootOptionsContainingFile (
|
|
IN CHAR16 *FileName
|
|
);
|
|
|
|
|
|
|
|
#endif /* PLATFORM_BOOTOPTIONS_H_ */
|