projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 3eb9473e | 1 | /*++\r |
| 2 | \r | |
| f57387d5 HT |
3 | Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>\r |
| 4 | This program and the accompanying materials \r | |
| 3eb9473e | 5 | are licensed and made available under the terms and conditions of the BSD License \r |
| 6 | which accompanies this distribution. The full text of the license may be found at \r | |
| 7 | http://opensource.org/licenses/bsd-license.php \r | |
| 8 | \r | |
| 9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
| 10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
| 11 | \r | |
| 12 | Module Name:\r | |
| 13 | \r | |
| 14 | LoadFile.h\r | |
| 15 | \r | |
| 16 | Abstract:\r | |
| 17 | \r | |
| 18 | Load File protocol as defined in the EFI 1.0 specification.\r | |
| 19 | \r | |
| 20 | Load file protocol exists to supports the addition of new boot devices, \r | |
| 21 | and to support booting from devices that do not map well to file system. \r | |
| 22 | Network boot is done via a LoadFile protocol.\r | |
| 23 | \r | |
| 24 | EFI 1.0 can boot from any device that produces a LoadFile protocol.\r | |
| 25 | \r | |
| 26 | --*/\r | |
| 27 | \r | |
| 28 | #ifndef _LOAD_FILE_H_\r | |
| 29 | #define _LOAD_FILE_H_\r | |
| 30 | \r | |
| 31 | #define LOAD_FILE_PROTOCOL_GUID \\r | |
| 32 | { \\r | |
| 7ccf38a3 | 33 | 0x56EC3091, 0x954C, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B} \\r |
| 3eb9473e | 34 | }\r |
| 35 | \r | |
| 36 | EFI_FORWARD_DECLARATION (EFI_LOAD_FILE_PROTOCOL);\r | |
| 37 | \r | |
| 38 | typedef\r | |
| 39 | EFI_STATUS\r | |
| 40 | (EFIAPI *EFI_LOAD_FILE) (\r | |
| 41 | IN EFI_LOAD_FILE_PROTOCOL * This,\r | |
| 42 | IN EFI_DEVICE_PATH_PROTOCOL * FilePath,\r | |
| 43 | IN BOOLEAN BootPolicy,\r | |
| 44 | IN OUT UINTN *BufferSize,\r | |
| 45 | IN VOID *Buffer OPTIONAL\r | |
| 46 | )\r | |
| 47 | /*++\r | |
| 48 | \r | |
| 49 | Routine Description:\r | |
| 50 | Causes the driver to load a specified file.\r | |
| 51 | \r | |
| 52 | Arguments:\r | |
| 53 | This - Protocol instance pointer.\r | |
| 54 | FilePath - The device specific path of the file to load.\r | |
| 55 | BootPolicy - If TRUE, indicates that the request originates from the \r | |
| 56 | boot manager is attempting to load FilePath as a boot\r | |
| 57 | selection. If FALSE, then FilePath must match as exact file\r | |
| 58 | to be loaded.\r | |
| 59 | BufferSize - On input the size of Buffer in bytes. On output with a return\r | |
| 60 | code of EFI_SUCCESS, the amount of data transferred to \r | |
| 61 | Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,\r | |
| 62 | the size of Buffer required to retrieve the requested file.\r | |
| 63 | Buffer - The memory buffer to transfer the file to. IF Buffer is NULL,\r | |
| 64 | then no the size of the requested file is returned in \r | |
| 65 | BufferSize.\r | |
| 66 | \r | |
| 67 | Returns:\r | |
| 68 | EFI_SUCCESS - The file was loaded.\r | |
| 69 | EFI_UNSUPPORTED - The device does not support the provided BootPolicy\r | |
| 70 | EFI_INVALID_PARAMETER - FilePath is not a valid device path, or \r | |
| 71 | BufferSize is NULL.\r | |
| 72 | EFI_NO_MEDIA - No medium was present to load the file.\r | |
| 73 | EFI_DEVICE_ERROR - The file was not loaded due to a device error.\r | |
| 74 | EFI_NO_RESPONSE - The remote system did not respond.\r | |
| 75 | EFI_NOT_FOUND - The file was not found\r | |
| 76 | EFI_ABORTED - The file load process was manually cancelled.\r | |
| 77 | \r | |
| 78 | --*/\r | |
| 79 | ;\r | |
| 80 | \r | |
| e5bce275 | 81 | struct _EFI_LOAD_FILE_PROTOCOL {\r |
| 3eb9473e | 82 | EFI_LOAD_FILE LoadFile;\r |
| e5bce275 | 83 | };\r |
| 3eb9473e | 84 | \r |
| 85 | extern EFI_GUID gEfiLoadFileProtocolGuid;\r | |
| 86 | \r | |
| 87 | #endif\r |