Add in the 1st version of ECP.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2832 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
104
EdkCompatibilityPkg/Foundation/Library/Dxe/Include/GetImage.h
Normal file
104
EdkCompatibilityPkg/Foundation/Library/Dxe/Include/GetImage.h
Normal file
@ -0,0 +1,104 @@
|
||||
/*++
|
||||
|
||||
Copyright (c) 2006 - 2007, Intel Corporation
|
||||
All rights reserved. This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
http://opensource.org/licenses/bsd-license.php
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
Module Name:
|
||||
|
||||
GetImage.h
|
||||
|
||||
Abstract:
|
||||
|
||||
Image data retrieval support for common use.
|
||||
|
||||
--*/
|
||||
|
||||
#ifndef _GET_IMAGE_H_
|
||||
#define _GET_IMAGE_H_
|
||||
#include "EfiImageFormat.h"
|
||||
|
||||
EFI_STATUS
|
||||
GetImage (
|
||||
IN EFI_GUID *NameGuid,
|
||||
IN EFI_SECTION_TYPE SectionType,
|
||||
OUT VOID **Buffer,
|
||||
OUT UINTN *Size
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description:
|
||||
Enumerate all the FVs, and fill Buffer with the SectionType section content in NameGuid file.
|
||||
|
||||
Note:
|
||||
1. when SectionType is EFI_SECTION_PE32, it tries to read NameGuid file after failure on
|
||||
reading EFI_SECTION_PE32 section.
|
||||
2. when SectionType is EFI_SECTION_TE, it tries to get EFI_SECTION_PE32 section after failure on
|
||||
reading EFI_SECTION_TE section. If it's failed again, it tries to read NameGuid file.
|
||||
3. Callee allocates memory, which caller is responsible to free.
|
||||
|
||||
Arguments:
|
||||
|
||||
NameGuid - Pointer to EFI_GUID, which is file name.
|
||||
SectionType - Required section type.
|
||||
Buffer - Pointer to a pointer in which the read content is returned.
|
||||
Caller is responsible to free Buffer.
|
||||
Size - Pointer to a UINTN, which indicates the size of returned *Buffer.
|
||||
|
||||
Returns:
|
||||
EFI_NOT_FOUND - Required content can not be found.
|
||||
EFI_SUCCESS - Required content can be found, but whether the Buffer is filled
|
||||
with section content or not depends on the Buffer and Size.
|
||||
--*/
|
||||
;
|
||||
|
||||
EFI_STATUS
|
||||
GetImageEx (
|
||||
IN EFI_HANDLE ImageHandle,
|
||||
IN EFI_GUID *NameGuid,
|
||||
IN EFI_SECTION_TYPE SectionType,
|
||||
OUT VOID **Buffer,
|
||||
OUT UINTN *Size,
|
||||
BOOLEAN WithinImageFv
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description:
|
||||
Search FVs, and fill Buffer with the SectionType section content in NameGuid file.
|
||||
If ImageHandle is not NULL, the FV from which the ImageHandle is loaded is searched
|
||||
first. If WithinImageFv is TRUE, only the FV from which the ImageHandle is loaded
|
||||
is searched. If ImageHandle is NULL or WithinImageFv is FALSE, all FVs in the system
|
||||
is searched.
|
||||
|
||||
Note:
|
||||
1. when SectionType is EFI_SECTION_PE32, it tries to read NameGuid file after failure on
|
||||
reading EFI_SECTION_PE32 section.
|
||||
2. when SectionType is EFI_SECTION_TE, it tries to get EFI_SECTION_PE32 section after failure on
|
||||
reading EFI_SECTION_TE section. If it's failed again, it tries to read NameGuid file.
|
||||
3. Callee allocates memory, which caller is responsible to free.
|
||||
|
||||
Arguments:
|
||||
|
||||
ImageHandle - The caller's driver image handle.
|
||||
NameGuid - Pointer to EFI_GUID, which is file name.
|
||||
SectionType - Required section type.
|
||||
Buffer - Pointer to a pointer in which the read content is returned.
|
||||
Caller is responsible to free Buffer.
|
||||
Size - Pointer to a UINTN, which indicates the size of returned *Buffer.
|
||||
WithinImageFv - Whether the search only performs on the FV from which the caller's
|
||||
driver image is loaded.
|
||||
|
||||
Returns:
|
||||
EFI_INVALID_PARAMETER - ImageHandle is NULL and WithinImageFv is TRUE.
|
||||
EFI_NOT_FOUND - Required content can not be found.
|
||||
EFI_SUCCESS - Required content can be found, but whether the Buffer is filled
|
||||
with section content or not depends on the Buffer and Size.
|
||||
--*/
|
||||
;
|
||||
|
||||
#endif //_GET_IMAGE_H_
|
Reference in New Issue
Block a user