iPXE
LoadFile.h
Go to the documentation of this file.
1 /** @file
2  Load File protocol as defined in the UEFI 2.0 specification.
3 
4  The load file protocol exists to supports the addition of new boot devices,
5  and to support booting from devices that do not map well to file system.
6  Network boot is done via a LoadFile protocol.
7 
8  UEFI 2.0 can boot from any device that produces a LoadFile protocol.
9 
10 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
11 This program and the accompanying materials are licensed and made available under
12 the terms and conditions of the BSD License that accompanies this distribution.
13 The full text of the license may be found at
14 http://opensource.org/licenses/bsd-license.php.
15 
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 
19 **/
20 
21 #ifndef __EFI_LOAD_FILE_PROTOCOL_H__
22 #define __EFI_LOAD_FILE_PROTOCOL_H__
23 
24 FILE_LICENCE ( BSD3 );
25 
26 #define EFI_LOAD_FILE_PROTOCOL_GUID \
27  { \
28  0x56EC3091, 0x954C, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \
29  }
30 
31 ///
32 /// Protocol Guid defined by EFI1.1.
33 ///
34 #define LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL_GUID
35 
37 
38 ///
39 /// Backward-compatible with EFI1.1
40 ///
42 
43 /**
44  Causes the driver to load a specified file.
45 
46  @param This Protocol instance pointer.
47  @param FilePath The device specific path of the file to load.
48  @param BootPolicy If TRUE, indicates that the request originates from the
49  boot manager is attempting to load FilePath as a boot
50  selection. If FALSE, then FilePath must match as exact file
51  to be loaded.
52  @param BufferSize On input the size of Buffer in bytes. On output with a return
53  code of EFI_SUCCESS, the amount of data transferred to
54  Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
55  the size of Buffer required to retrieve the requested file.
56  @param Buffer The memory buffer to transfer the file to. IF Buffer is NULL,
57  then the size of the requested file is returned in
58  BufferSize.
59 
60  @retval EFI_SUCCESS The file was loaded.
61  @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy
62  @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or
63  BufferSize is NULL.
64  @retval EFI_NO_MEDIA No medium was present to load the file.
65  @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.
66  @retval EFI_NO_RESPONSE The remote system did not respond.
67  @retval EFI_NOT_FOUND The file was not found.
68  @retval EFI_ABORTED The file load process was manually cancelled.
69  @retval EFI_WARN_FILE_SYSTEM The resulting Buffer contains UEFI-compliant file system.
70 **/
71 typedef
75  IN EFI_DEVICE_PATH_PROTOCOL *FilePath,
76  IN BOOLEAN BootPolicy,
79  );
80 
81 ///
82 /// The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from arbitrary devices.
83 ///
86 };
87 
89 
90 #endif
#define OPTIONAL
Passing the datum to the function is optional, and a NULL is passed if the value is not supplied.
Definition: Base.h:340
EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_INTERFACE
Backward-compatible with EFI1.1.
Definition: LoadFile.h:41
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
unsigned char BOOLEAN
Definition: ProcessorBind.h:61
UINT16_t BufferSize
Buffer size.
Definition: pxe_api.h:64
This protocol can be used on any device handle to obtain generic path/location information concerning...
Definition: DevicePath.h:51
EFI_STATUS(EFIAPI * EFI_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.
Definition: LoadFile.h:73
#define OUT
Definition: mlx_utils.h:29
The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from arbitrary devices.
Definition: LoadFile.h:84
EFI_GUID gEfiLoadFileProtocolGuid
#define EFIAPI
SEGOFF16_t Buffer
Buffer address.
Definition: pxe_api.h:65
UINT64 UINTN
Unsigned value of native width.
Definition: ProcessorBind.h:71
#define VOID
Undeclared type.
Definition: Base.h:319
#define IN
Definition: mlx_utils.h:28
EFI_LOAD_FILE LoadFile
Definition: LoadFile.h:85
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
FILE_LICENCE(BSD3)