projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 1e39deb2 | 1 | /*++\r |
| 2 | \r | |
| f57387d5 HT |
3 | Copyright (c) 2008, Intel Corporation. All rights reserved.<BR>\r |
| 4 | This program and the accompanying materials \r | |
| 1e39deb2 | 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 | LoadFile2.h\r | |
| 15 | \r | |
| 16 | Abstract:\r | |
| 17 | \r | |
| 18 | Load File2 protocol as defined in the UEFI specification.\r | |
| 19 | \r | |
| 20 | Load File2 protocol exists to support to obtain files from arbitrary devices\r | |
| 21 | but are not used as boot options.\r | |
| 22 | \r | |
| 23 | --*/\r | |
| 24 | \r | |
| 25 | #ifndef _LOAD_FILE2_H_\r | |
| 26 | #define _LOAD_FILE2_H_\r | |
| 27 | \r | |
| 28 | #define EFI_LOAD_FILE2_PROTOCOL_GUID \\r | |
| 29 | { \\r | |
| 30 | 0x4006c0c1, 0xfcb3, 0x403e, {0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d} \\r | |
| 31 | }\r | |
| 32 | \r | |
| 33 | EFI_FORWARD_DECLARATION (EFI_LOAD_FILE2_PROTOCOL);\r | |
| 34 | \r | |
| 35 | typedef\r | |
| 36 | EFI_STATUS\r | |
| 37 | (EFIAPI *EFI_LOAD_FILE2_LOAD_FILE) (\r | |
| 38 | IN EFI_LOAD_FILE2_PROTOCOL * This,\r | |
| 39 | IN EFI_DEVICE_PATH_PROTOCOL * FilePath,\r | |
| 40 | IN BOOLEAN BootPolicy,\r | |
| 41 | IN OUT UINTN *BufferSize,\r | |
| 42 | IN VOID *Buffer OPTIONAL\r | |
| 43 | )\r | |
| 44 | /*++\r | |
| 45 | \r | |
| 46 | Routine Description:\r | |
| 47 | Causes the driver to load a specified file.\r | |
| 48 | \r | |
| 49 | Arguments:\r | |
| 50 | This - Protocol instance pointer.\r | |
| 51 | FilePath - The device specific path of the file to load.\r | |
| 52 | BootPolicy - Should always be FALSE.\r | |
| 53 | BufferSize - On input the size of Buffer in bytes. On output with a return\r | |
| 54 | code of EFI_SUCCESS, the amount of data transferred to \r | |
| 55 | Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,\r | |
| 56 | the size of Buffer required to retrieve the requested file.\r | |
| 57 | Buffer - The memory buffer to transfer the file to. IF Buffer is NULL,\r | |
| 58 | then no the size of the requested file is returned in \r | |
| 59 | BufferSize.\r | |
| 60 | \r | |
| 61 | Returns:\r | |
| 62 | EFI_SUCCESS - The file was loaded.\r | |
| 63 | EFI_UNSUPPORTED - BootPolicy is TRUE.\r | |
| 64 | EFI_INVALID_PARAMETER - FilePath is not a valid device path, or \r | |
| 65 | BufferSize is NULL.\r | |
| 66 | EFI_NO_MEDIA - No medium was present to load the file.\r | |
| 67 | EFI_DEVICE_ERROR - The file was not loaded due to a device error.\r | |
| 68 | EFI_NO_RESPONSE - The remote system did not respond.\r | |
| 69 | EFI_NOT_FOUND - The file was not found\r | |
| 70 | EFI_ABORTED - The file load process was manually cancelled.\r | |
| 71 | EFI_BUFFER_TOO_SMALL - The BufferSize is too small to read the current \r | |
| 72 | directory entry. BufferSize has been updated with\r | |
| 73 | the size needed to complete the request.\r | |
| 74 | \r | |
| 75 | --*/\r | |
| 76 | ;\r | |
| 77 | \r | |
| 78 | struct _EFI_LOAD_FILE2_PROTOCOL {\r | |
| 79 | EFI_LOAD_FILE2_LOAD_FILE LoadFile;\r | |
| 80 | };\r | |
| 81 | \r | |
| 82 | extern EFI_GUID gEfiLoadFile2ProtocolGuid;\r | |
| 83 | \r | |
| 84 | #endif\r |