MdePkg/Include/Protocol/LoadFile2.h

   1 /** @file
   2   Load File protocol as defined in the UEFI 2.0 specification.
   3
   4   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 - 2008, Intel Corporation. All rights reserved.<BR>
  11   This program and the accompanying materials
  12   are licensed and made available under the terms and conditions of the BSD License
  13   which accompanies this distribution.  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_FILE2_PROTOCOL_H__
  22 #define __EFI_LOAD_FILE2_PROTOCOL_H__
  23
  24 #define EFI_LOAD_FILE2_PROTOCOL_GUID \
  25   { \
  26     0x4006c0c1, 0xfcb3, 0x403e, {0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d } \
  27   }
  28
  29 ///
  30 /// Protocol Guid defined by UEFI2.1.
  31 ///
  32 #define LOAD_FILE2_PROTOCOL EFI_LOAD_FILE2_PROTOCOL_GUID
  33
  34 typedef struct _EFI_LOAD_FILE2_PROTOCOL EFI_LOAD_FILE2_PROTOCOL;
  35
  36
  37 /**
  38   Causes the driver to load a specified file.
  39
  40   @param  This       Protocol instance pointer.
  41   @param  FilePath   The device specific path of the file to load.
  42   @param  BootPolicy Should always be FALSE.
  43   @param  BufferSize On input the size of Buffer in bytes. On output with a return
  44                      code of EFI_SUCCESS, the amount of data transferred to
  45                      Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
  46                      the size of Buffer required to retrieve the requested file.
  47   @param  Buffer     The memory buffer to transfer the file to. IF Buffer is NULL,
  48                      then no the size of the requested file is returned in
  49                      BufferSize.
  50
  51   @retval EFI_SUCCESS           The file was loaded.
  52   @retval EFI_UNSUPPORTED       BootPolicy is TRUE.
  53   @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or
  54                                 BufferSize is NULL.
  55   @retval EFI_NO_MEDIA          No medium was present to load the file.
  56   @retval EFI_DEVICE_ERROR      The file was not loaded due to a device error.
  57   @retval EFI_NO_RESPONSE       The remote system did not respond.
  58   @retval EFI_NOT_FOUND         The file was not found
  59   @retval EFI_ABORTED           The file load process was manually canceled.
  60   @retval EFI_BUFFER_TOO_SMALL  The BufferSize is too small to read the current
  61                                 directory entry. BufferSize has been updated with
  62                                 the size needed to complete the request.
  63
  64
  65 **/
  66 typedef
  67 EFI_STATUS
  68 (EFIAPI *EFI_LOAD_FILE2)(
  69   IN EFI_LOAD_FILE2_PROTOCOL           *This,
  70   IN EFI_DEVICE_PATH_PROTOCOL         *FilePath,
  71   IN BOOLEAN                          BootPolicy,
  72   IN OUT UINTN                        *BufferSize,
  73   IN VOID                             *Buffer OPTIONAL
  74   );
  75
  76 ///
  77 /// The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from arbitrary devices.
  78 ///
  79 struct _EFI_LOAD_FILE2_PROTOCOL {
  80   EFI_LOAD_FILE2 LoadFile;
  81 };
  82
  83 extern EFI_GUID gEfiLoadFile2ProtocolGuid;
  84
  85 #endif