iPXE
Data Structures | Defines | Typedefs | Functions | Variables
LoadFile2.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_FILE2_PROTOCOL
 The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from arbitrary devices. More...

Defines

#define EFI_LOAD_FILE2_PROTOCOL_GUID
#define LOAD_FILE2_PROTOCOL   EFI_LOAD_FILE2_PROTOCOL_GUID
 Protocol Guid defined by UEFI2.1.

Typedefs

typedef struct
_EFI_LOAD_FILE2_PROTOCOL 
EFI_LOAD_FILE2_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_LOAD_FILE2 )(IN EFI_LOAD_FILE2_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 gEfiLoadFile2ProtocolGuid

Detailed Description

Load File protocol as defined in the UEFI 2.0 specification.

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 - 2008, 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 which 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 LoadFile2.h.


Define Documentation

Value:
{ \
    0x4006c0c1, 0xfcb3, 0x403e, {0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d } \
  }

Definition at line 26 of file LoadFile2.h.

Protocol Guid defined by UEFI2.1.

Definition at line 34 of file LoadFile2.h.


Typedef Documentation

Definition at line 36 of file LoadFile2.h.

Causes the driver to load a specified file.

Parameters:
ThisProtocol instance pointer.
FilePathThe device specific path of the file to load.
BootPolicyShould always be FALSE.
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 no the size of the requested file is returned in BufferSize.
Return values:
EFI_SUCCESSThe file was loaded.
EFI_UNSUPPORTEDBootPolicy is TRUE.
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 canceled.
EFI_BUFFER_TOO_SMALLThe BufferSize is too small to read the current directory entry. BufferSize has been updated with the size needed to complete the request.

Definition at line 70 of file LoadFile2.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation