1*f334afcfSToomas Soome /** @file 2*f334afcfSToomas Soome Load File protocol as defined in the UEFI 2.0 specification. 3*f334afcfSToomas Soome 4*f334afcfSToomas Soome Load file protocol exists to supports the addition of new boot devices, 5*f334afcfSToomas Soome and to support booting from devices that do not map well to file system. 6*f334afcfSToomas Soome Network boot is done via a LoadFile protocol. 7*f334afcfSToomas Soome 8*f334afcfSToomas Soome UEFI 2.0 can boot from any device that produces a LoadFile protocol. 9*f334afcfSToomas Soome 10*f334afcfSToomas Soome Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> 11*f334afcfSToomas Soome SPDX-License-Identifier: BSD-2-Clause-Patent 12*f334afcfSToomas Soome 13*f334afcfSToomas Soome **/ 14*f334afcfSToomas Soome 15*f334afcfSToomas Soome #ifndef __EFI_LOAD_FILE2_PROTOCOL_H__ 16*f334afcfSToomas Soome #define __EFI_LOAD_FILE2_PROTOCOL_H__ 17*f334afcfSToomas Soome 18*f334afcfSToomas Soome #define EFI_LOAD_FILE2_PROTOCOL_GUID \ 19*f334afcfSToomas Soome { \ 20*f334afcfSToomas Soome 0x4006c0c1, 0xfcb3, 0x403e, {0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d } \ 21*f334afcfSToomas Soome } 22*f334afcfSToomas Soome 23*f334afcfSToomas Soome /// 24*f334afcfSToomas Soome /// Protocol Guid defined by UEFI2.1. 25*f334afcfSToomas Soome /// 26*f334afcfSToomas Soome #define LOAD_FILE2_PROTOCOL EFI_LOAD_FILE2_PROTOCOL_GUID 27*f334afcfSToomas Soome 28*f334afcfSToomas Soome typedef struct _EFI_LOAD_FILE2_PROTOCOL EFI_LOAD_FILE2_PROTOCOL; 29*f334afcfSToomas Soome 30*f334afcfSToomas Soome /** 31*f334afcfSToomas Soome Causes the driver to load a specified file. 32*f334afcfSToomas Soome 33*f334afcfSToomas Soome @param This Protocol instance pointer. 34*f334afcfSToomas Soome @param FilePath The device specific path of the file to load. 35*f334afcfSToomas Soome @param BootPolicy Should always be FALSE. 36*f334afcfSToomas Soome @param BufferSize On input the size of Buffer in bytes. On output with a return 37*f334afcfSToomas Soome code of EFI_SUCCESS, the amount of data transferred to 38*f334afcfSToomas Soome Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL, 39*f334afcfSToomas Soome the size of Buffer required to retrieve the requested file. 40*f334afcfSToomas Soome @param Buffer The memory buffer to transfer the file to. IF Buffer is NULL, 41*f334afcfSToomas Soome then no the size of the requested file is returned in 42*f334afcfSToomas Soome BufferSize. 43*f334afcfSToomas Soome 44*f334afcfSToomas Soome @retval EFI_SUCCESS The file was loaded. 45*f334afcfSToomas Soome @retval EFI_UNSUPPORTED BootPolicy is TRUE. 46*f334afcfSToomas Soome @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or 47*f334afcfSToomas Soome BufferSize is NULL. 48*f334afcfSToomas Soome @retval EFI_NO_MEDIA No medium was present to load the file. 49*f334afcfSToomas Soome @retval EFI_DEVICE_ERROR The file was not loaded due to a device error. 50*f334afcfSToomas Soome @retval EFI_NO_RESPONSE The remote system did not respond. 51*f334afcfSToomas Soome @retval EFI_NOT_FOUND The file was not found 52*f334afcfSToomas Soome @retval EFI_ABORTED The file load process was manually canceled. 53*f334afcfSToomas Soome @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to read the current 54*f334afcfSToomas Soome directory entry. BufferSize has been updated with 55*f334afcfSToomas Soome the size needed to complete the request. 56*f334afcfSToomas Soome 57*f334afcfSToomas Soome 58*f334afcfSToomas Soome **/ 59*f334afcfSToomas Soome typedef 60*f334afcfSToomas Soome EFI_STATUS 61*f334afcfSToomas Soome (EFIAPI *EFI_LOAD_FILE2)( 62*f334afcfSToomas Soome IN EFI_LOAD_FILE2_PROTOCOL *This, 63*f334afcfSToomas Soome IN EFI_DEVICE_PATH_PROTOCOL *FilePath, 64*f334afcfSToomas Soome IN BOOLEAN BootPolicy, 65*f334afcfSToomas Soome IN OUT UINTN *BufferSize, 66*f334afcfSToomas Soome IN VOID *Buffer OPTIONAL 67*f334afcfSToomas Soome ); 68*f334afcfSToomas Soome 69*f334afcfSToomas Soome /// 70*f334afcfSToomas Soome /// The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from arbitrary devices. 71*f334afcfSToomas Soome /// 72*f334afcfSToomas Soome struct _EFI_LOAD_FILE2_PROTOCOL { 73*f334afcfSToomas Soome EFI_LOAD_FILE2 LoadFile; 74*f334afcfSToomas Soome }; 75*f334afcfSToomas Soome 76*f334afcfSToomas Soome extern EFI_GUID gEfiLoadFile2ProtocolGuid; 77*f334afcfSToomas Soome 78*f334afcfSToomas Soome #endif 79