Retire HiiLibGetNextLanguage() API from HII Library class.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Image / Image.h

/** @file\r
  Data structure and functions to load and unload PeImage.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
#ifndef _IMAGE_H_\r
#define _IMAGE_H_\r
\r
#define LOADED_IMAGE_PRIVATE_DATA_SIGNATURE   SIGNATURE_32('l','d','r','i')\r
\r
typedef struct {\r
    UINTN                       Signature;\r
	/// Image handle\r
    EFI_HANDLE                  Handle;   \r
	/// Image type\r
    UINTN                       Type;           \r
	/// If entrypoint has been called\r
    BOOLEAN                     Started;        \r
	/// The image's entry point\r
    EFI_IMAGE_ENTRY_POINT       EntryPoint;     \r
	/// loaded image protocol\r
    EFI_LOADED_IMAGE_PROTOCOL   Info;           \r
	/// Location in memory\r
    EFI_PHYSICAL_ADDRESS        ImageBasePage;  \r
	/// Number of pages\r
    UINTN                       NumberOfPages;  \r
	/// Original fixup data\r
    CHAR8                       *FixupData;     \r
	/// Tpl of started image\r
    EFI_TPL                     Tpl;            \r
	/// Status returned by started image\r
    EFI_STATUS                  Status;         \r
	/// Size of ExitData from started image\r
    UINTN                       ExitDataSize;   \r
	/// Pointer to exit data from started image\r
    VOID                        *ExitData;      \r
	/// Pointer to pool allocation for context save/retore\r
    VOID                        *JumpBuffer;    \r
	/// Pointer to buffer for context save/retore\r
    BASE_LIBRARY_JUMP_BUFFER    *JumpContext;  \r
	/// Machine type from PE image\r
    UINT16                      Machine;        \r
	/// EBC Protocol pointer\r
    EFI_EBC_PROTOCOL            *Ebc;           \r
	/// Runtime image list\r
    EFI_RUNTIME_IMAGE_ENTRY     *RuntimeData;   \r
	/// Pointer to Loaded Image Device Path Protocl\r
    EFI_DEVICE_PATH_PROTOCOL    *LoadedImageDevicePath;  \r
	/// PeCoffLoader ImageContext\r
    PE_COFF_LOADER_IMAGE_CONTEXT  ImageContext; \r
\r
} LOADED_IMAGE_PRIVATE_DATA;\r
\r
#define LOADED_IMAGE_PRIVATE_DATA_FROM_THIS(a) \\r
          CR(a, LOADED_IMAGE_PRIVATE_DATA, Info, LOADED_IMAGE_PRIVATE_DATA_SIGNATURE)\r
\r
\r
//\r
// Private Data Types\r
//\r
#define IMAGE_FILE_HANDLE_SIGNATURE       SIGNATURE_32('i','m','g','f')\r
typedef struct {\r
  UINTN               Signature;\r
  BOOLEAN             FreeBuffer;\r
  VOID                *Source;\r
  UINTN               SourceSize;\r
} IMAGE_FILE_HANDLE;\r
\r
\r
/**\r
  Opens a file for (simple) reading.  The simple read abstraction\r
  will access the file either from a memory copy, from a file\r
  system interface, or from the load file interface.\r
\r
  @param  BootPolicy             Policy for Open Image File.\r
  @param  SourceBuffer           Pointer to the memory location containing copy\r
                                 of the image to be loaded.\r
  @param  SourceSize             The size in bytes of SourceBuffer.\r
  @param  FilePath               The specific file path from which the image is\r
                                 loaded\r
  @param  DeviceHandle           Pointer to the return device handle.\r
  @param  ImageFileHandle        Pointer to the image file handle.\r
  @param  AuthenticationStatus   Pointer to a caller-allocated UINT32 in which\r
                                 the authentication status is returned.\r
\r
  @retval EFI_SUCCESS            Image file successfully opened.\r
  @retval EFI_LOAD_ERROR         If the caller passed a copy of the file, and\r
                                 SourceSize is 0.\r
  @retval EFI_INVALID_PARAMETER  File path is not valid.\r
  @retval EFI_NOT_FOUND          File not found.\r
\r
**/\r
EFI_STATUS\r
CoreOpenImageFile (\r
  IN BOOLEAN                        BootPolicy,\r
  IN VOID                           *SourceBuffer   OPTIONAL,\r
  IN UINTN                          SourceSize,\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL   **FilePath,\r
  OUT EFI_HANDLE                    *DeviceHandle,\r
  IN IMAGE_FILE_HANDLE              *ImageFileHandle,\r
  OUT UINT32                        *AuthenticationStatus\r
  );\r
\r
\r
\r
/**\r
  Read image file (specified by UserHandle) into user specified buffer with specified offset\r
  and length.\r
\r
  @param  UserHandle             Image file handle\r
  @param  Offset                 Offset to the source file\r
  @param  ReadSize               For input, pointer of size to read; For output,\r
                                 pointer of size actually read.\r
  @param  Buffer                 Buffer to write into\r
\r
  @retval EFI_SUCCESS            Successfully read the specified part of file\r
                                 into buffer.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CoreReadImageFile (\r
  IN     VOID    *UserHandle,\r
  IN     UINTN   Offset,\r
  IN OUT UINTN   *ReadSize,\r
  OUT    VOID    *Buffer\r
  );\r
\r
\r
\r
#endif\r