iPXE
Data Structures | Defines | Typedefs | Functions | Variables
LoadFile.h File Reference

Load File protocol as defined in the UEFI 2.0 specification. More...

Go to the source code of this file.

Data Structures

struct  _EFI_LOAD_FILE_PROTOCOL
 The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from arbitrary devices. More...

Defines

#define EFI_LOAD_FILE_PROTOCOL_GUID
#define LOAD_FILE_PROTOCOL   EFI_LOAD_FILE_PROTOCOL_GUID
 Protocol Guid defined by EFI1.1.

Typedefs

typedef struct
_EFI_LOAD_FILE_PROTOCOL 
EFI_LOAD_FILE_PROTOCOL
typedef EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_INTERFACE
 Backward-compatible with EFI1.1.
typedef EFI_STATUS(EFIAPIEFI_LOAD_FILE )(IN EFI_LOAD_FILE_PROTOCOL *This, IN EFI_DEVICE_PATH_PROTOCOL *FilePath, IN BOOLEAN BootPolicy, IN OUT UINTN *BufferSize, IN VOID *Buffer OPTIONAL)
 Causes the driver to load a specified file.

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiLoadFileProtocolGuid

Detailed Description

Load File protocol as defined in the UEFI 2.0 specification.

The load file protocol exists to supports the addition of new boot devices, and to support booting from devices that do not map well to file system. Network boot is done via a LoadFile protocol.

UEFI 2.0 can boot from any device that produces a LoadFile protocol.

Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file LoadFile.h.


Define Documentation

Value:
{ \
    0x56EC3091, 0x954C, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \
  }

Definition at line 26 of file LoadFile.h.

Protocol Guid defined by EFI1.1.

Definition at line 34 of file LoadFile.h.


Typedef Documentation

Definition at line 36 of file LoadFile.h.

Backward-compatible with EFI1.1.

Definition at line 41 of file LoadFile.h.

Causes the driver to load a specified file.

Parameters:
ThisProtocol instance pointer.
FilePathThe device specific path of the file to load.
BootPolicyIf TRUE, indicates that the request originates from the boot manager is attempting to load FilePath as a boot selection. If FALSE, then FilePath must match as exact file to be loaded.
BufferSizeOn input the size of Buffer in bytes. On output with a return code of EFI_SUCCESS, the amount of data transferred to Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL, the size of Buffer required to retrieve the requested file.
BufferThe memory buffer to transfer the file to. IF Buffer is NULL, then the size of the requested file is returned in BufferSize.
Return values:
EFI_SUCCESSThe file was loaded.
EFI_UNSUPPORTEDThe device does not support the provided BootPolicy
EFI_INVALID_PARAMETERFilePath is not a valid device path, or BufferSize is NULL.
EFI_NO_MEDIANo medium was present to load the file.
EFI_DEVICE_ERRORThe file was not loaded due to a device error.
EFI_NO_RESPONSEThe remote system did not respond.
EFI_NOT_FOUNDThe file was not found.
EFI_ABORTEDThe file load process was manually cancelled.
EFI_WARN_FILE_SYSTEMThe resulting Buffer contains UEFI-compliant file system.

Definition at line 73 of file LoadFile.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation