123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439 |
- /*++
- Copyright (c) 2014 Minoca Corp. All Rights Reserved
- Module Name:
- bootlib.h
- Abstract:
- This header contains definitions for the Boot Library.
- Author:
- Evan Green 19-Feb-2014
- --*/
- //
- // ------------------------------------------------------------------- Includes
- //
- //
- // ---------------------------------------------------------------- Definitions
- //
- //
- // ------------------------------------------------------ Data Type Definitions
- //
- /*++
- Structure Description:
- This structure defines an open volume in the boot environment.
- Members:
- Parameters - Stores the block device's settings.
- DiskHandle - Stores a handle to device provided by the firmware.
- FileSystemHandle - Stores the handle returned when the file system mounted
- the device.
- --*/
- typedef struct _BOOT_VOLUME {
- BLOCK_DEVICE_PARAMETERS Parameters;
- HANDLE DiskHandle;
- PVOID FileSystemHandle;
- } BOOT_VOLUME, *PBOOT_VOLUME;
- //
- // -------------------------------------------------------------------- Globals
- //
- extern MEMORY_DESCRIPTOR_LIST BoMemoryMap;
- extern ULONGLONG BoEncodedVersion;
- extern ULONGLONG BoVersionSerial;
- extern ULONGLONG BoBuildTime;
- extern PSTR BoBuildString;
- extern PSTR BoProductName;
- //
- // Store a pointer to an enumerated firmware debug device.
- //
- extern PDEBUG_DEVICE_DESCRIPTION BoFirmwareDebugDevice;
- //
- // -------------------------------------------------------- Function Prototypes
- //
- //
- // Functions implemented by the application called by the boot library
- //
- PVOID
- BoExpandHeap (
- PMEMORY_HEAP Heap,
- UINTN Size,
- UINTN Tag
- );
- /*++
- Routine Description:
- This routine is called when the heap wants to expand and get more space.
- Arguments:
- Heap - Supplies a pointer to the heap to allocate from.
- Size - Supplies the size of the allocation request, in bytes.
- Tag - Supplies a 32-bit tag to associate with this allocation for debugging
- purposes. These are usually four ASCII characters so as to stand out
- when a poor developer is looking at a raw memory dump. It could also be
- a return address.
- Return Value:
- Returns a pointer to the allocation if successful, or NULL if the
- allocation failed.
- --*/
- //
- // Initialization functions
- //
- VOID
- BoInitializeProcessor (
- VOID
- );
- /*++
- Routine Description:
- This routine performs very early architecture specific initialization. It
- runs before the debugger is online.
- Arguments:
- None.
- Return Value:
- None.
- --*/
- KSTATUS
- BoHlBootInitialize (
- PDEBUG_DEVICE_DESCRIPTION *DebugDevice,
- PHARDWARE_MODULE_GET_ACPI_TABLE GetAcpiTableFunction
- );
- /*++
- Routine Description:
- This routine initializes the boot hardware library.
- Arguments:
- DebugDevice - Supplies a pointer where a pointer to the debug device
- description will be returned on success.
- GetAcpiTableFunction - Supplies an optional pointer to a function used to
- get ACPI tables. If not supplied a default hardware module service
- will be used that always returns NULL.
- Return Value:
- Status code.
- --*/
- VOID
- BoHlTestUsbDebugInterface (
- VOID
- );
- /*++
- Routine Description:
- This routine runs the interface test on a USB debug interface if debugging
- the USB transport itself.
- Arguments:
- None.
- Return Value:
- None.
- --*/
- //
- // Memory Functions
- //
- PVOID
- BoAllocateMemory (
- UINTN Size
- );
- /*++
- Routine Description:
- This routine allocates memory in the loader. This memory is marked as
- loader temporary, meaning it will get unmapped and reclaimed during kernel
- initialization.
- Arguments:
- Size - Supplies the size of the desired allocation, in bytes.
- Return Value:
- Returns a physical pointer to the allocation on success, or NULL on failure.
- --*/
- VOID
- BoFreeMemory (
- PVOID Allocation
- );
- /*++
- Routine Description:
- This routine frees memory allocated in the boot environment.
- Arguments:
- Allocation - Supplies a pointer to the memory allocation being freed.
- Return Value:
- None.
- --*/
- //
- // File I/O functions
- //
- KSTATUS
- BoOpenBootVolume (
- ULONG BootDriveNumber,
- ULONGLONG PartitionOffset,
- PBOOT_ENTRY BootEntry,
- PBOOT_VOLUME *VolumeHandle
- );
- /*++
- Routine Description:
- This routine opens a handle to the boot volume device, which is the device
- this boot application was loaded from.
- Arguments:
- BootDriveNumber - Supplies the drive number of the boot device, for PC/AT
- systems.
- PartitionOffset - Supplies the offset in sectors to the start of the boot
- partition, for PC/AT systems.
- BootEntry - Supplies an optional pointer to the boot entry, for EFI systems.
- VolumeHandle - Supplies a pointer where a handle to the open volume will
- be returned on success.
- Return Value:
- Status code.
- --*/
- KSTATUS
- BoCloseVolume (
- PBOOT_VOLUME VolumeHandle
- );
- /*++
- Routine Description:
- This routine closes a disk handle.
- Arguments:
- VolumeHandle - Supplies the volume handle returned when the volume was
- opened.
- Return Value:
- Status code.
- --*/
- KSTATUS
- BoOpenVolume (
- UCHAR PartitionId[FIRMWARE_PARTITION_ID_SIZE],
- PBOOT_VOLUME *Volume
- );
- /*++
- Routine Description:
- This routine closes a disk handle.
- Arguments:
- PartitionId - Supplies the ID of the partition to open.
- Volume - Supplies a pointer where a handle to the open volume will
- be returned on success.
- Return Value:
- Status code.
- --*/
- KSTATUS
- BoLookupPath (
- PBOOT_VOLUME Volume,
- PFILE_ID StartingDirectory,
- PSTR Path,
- PFILE_PROPERTIES FileProperties
- );
- /*++
- Routine Description:
- This routine attempts to look up the given file path.
- Arguments:
- Volume - Supplies a pointer to the volume token.
- StartingDirectory - Supplies an optional pointer to a file ID containing
- the directory to start path traversal from. If NULL, path lookup will
- start with the root of the volume.
- Path - Supplies a pointer to the path string to look up.
- FileProperties - Supplies a pointer where the properties for the file will
- be returned on success.
- Return Value:
- STATUS_SUCCESS on success.
- STATUS_PATH_NOT_FOUND if the given file path does not exist.
- Other error codes on other failures.
- --*/
- KSTATUS
- BoLoadFile (
- PBOOT_VOLUME Volume,
- PFILE_ID Directory,
- PSTR FileName,
- PVOID *FilePhysical,
- PUINTN FileSize,
- PULONGLONG ModificationDate
- );
- /*++
- Routine Description:
- This routine loads a file from disk into memory.
- Arguments:
- Volume - Supplies a pointer to the mounted volume to read the file from.
- Directory - Supplies an optional pointer to the ID of the directory to
- start path traversal from. If NULL, the root of the volume will be used.
- FileName - Supplies the name of the file to load.
- FilePhysical - Supplies a pointer where the file buffer's physical address
- will be returned. This routine will allocate the buffer to hold the
- file. If this parameter is NULL, the status code will reflect whether
- or not the file could be opened, but the file contents will not be
- loaded.
- FileSize - Supplies a pointer where the size of the file in bytes will be
- returned.
- ModificationDate - Supplies an optional pointer where the modification
- date of the file will be returned on success.
- Return Value:
- Status code.
- --*/
- KSTATUS
- BoStoreFile (
- PBOOT_VOLUME Volume,
- FILE_ID Directory,
- PSTR FileName,
- ULONG FileNameLength,
- PVOID FilePhysical,
- UINTN FileSize,
- ULONGLONG ModificationDate
- );
- /*++
- Routine Description:
- This routine stores a file buffer to disk.
- Arguments:
- Volume - Supplies a pointer to the mounted volume to read the file from.
- Directory - Supplies the file ID of the directory the file resides in.
- FileName - Supplies the name of the file to store.
- FileNameLength - Supplies the length of the file name buffer in bytes,
- including the null terminator.
- FilePhysical - Supplies a pointer to the buffer containing the file
- contents.
- FileSize - Supplies the size of the file buffer in bytes. The file will be
- truncated to this size if it previously existed and was larger.
- ModificationDate - Supplies the modification date to set.
- Return Value:
- Status code.
- --*/
|