SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / Library / DxeDeferImageLoadLib / DxeDeferImageLoadLib.h

/** @file\r
  The internal header file includes the common header files, defines\r
  internal structure and functions used by DeferImageLoadLib.\r
\r
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __DEFER_IMAGE_LOAD_LIB_H__\r
#define __DEFER_IMAGE_LOAD_LIB_H__\r
\r
#include <PiDxe.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/SecurityManagementLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/PcdLib.h>\r
\r
#include <Protocol/FirmwareVolume2.h>\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/DeferredImageLoad.h>\r
#include <Protocol/UserCredential.h>\r
#include <Protocol/UserManager.h>\r
\r
#include <Guid/GlobalVariable.h>\r
\r
//\r
// Image type definitions.\r
//\r
#define IMAGE_UNKNOWN                         0x00000001\r
#define IMAGE_FROM_FV                         0x00000002\r
#define IMAGE_FROM_OPTION_ROM                 0x00000004\r
#define IMAGE_FROM_REMOVABLE_MEDIA            0x00000008\r
#define IMAGE_FROM_FIXED_MEDIA                0x00000010\r
\r
//\r
// The struct to save the deferred image information.\r
//\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL          *ImageDevicePath;\r
  VOID                              *Image;\r
  UINTN                             ImageSize;\r
  BOOLEAN                           BootOption;\r
} DEFERRED_IMAGE_INFO;\r
\r
//\r
// The table to save the deferred image item.\r
//\r
typedef struct {\r
  UINTN                             Count;         ///< deferred image count\r
  DEFERRED_IMAGE_INFO               *ImageInfo;    ///< deferred image item\r
} DEFERRED_IMAGE_TABLE;\r
\r
/**\r
  Returns information about a deferred image.\r
\r
  This function returns information about a single deferred image. The deferred images are\r
  numbered consecutively, starting with 0.  If there is no image which corresponds to\r
  ImageIndex, then EFI_NOT_FOUND is returned. All deferred images may be returned by\r
  iteratively calling this function until EFI_NOT_FOUND is returned.\r
  Image may be NULL and ImageSize set to 0 if the decision to defer execution was made\r
  because of the location of the executable image, rather than its actual contents.\r
\r
  @param[in]  This              Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL.\r
  @param[in]  ImageIndex        Zero-based index of the deferred index.\r
  @param[out] ImageDevicePath   On return, points to a pointer to the device path of the image.\r
                                The device path should not be freed by the caller.\r
  @param[out] Image             On return, points to the first byte of the image or NULL if the\r
                                image is not available. The image should not be freed by the caller\r
                                unless LoadImage() has been called successfully.\r
  @param[out] ImageSize         On return, the size of the image, or 0 if the image is not available.\r
  @param[out] BootOption        On return, points to TRUE if the image was intended as a boot option\r
                                or FALSE if it was not intended as a boot option.\r
\r
  @retval EFI_SUCCESS           Image information returned successfully.\r
  @retval EFI_NOT_FOUND         ImageIndex does not refer to a valid image.\r
  @retval EFI_INVALID_PARAMETER ImageDevicePath is NULL or Image is NULL or ImageSize is NULL or\r
                                BootOption is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetDefferedImageInfo (\r
  IN     EFI_DEFERRED_IMAGE_LOAD_PROTOCOL  *This,\r
  IN     UINTN                             ImageIndex,\r
     OUT EFI_DEVICE_PATH_PROTOCOL          **ImageDevicePath,\r
     OUT VOID                              **Image,\r
     OUT UINTN                             *ImageSize,\r
     OUT BOOLEAN                           *BootOption\r
  );\r
\r
#endif\r