[mirror_edk2.git] / MdePkg / Include / Library / DxePiLib.h

/** @file\r
  MDE PI library functions and macros\r
\r
  Copyright (c) 2007, Intel Corporation                                                         \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
#ifndef __PI_LIB_H__\r
#define __PI_LIB_H__\r
\r
#include <Pi/PiFirmwareFile.h>\r
\r
\r
/**\r
    Allocate and fill a buffer from the Firmware Section identified by a Firmware File GUID name and a Firmware \r
    Section type and instance number from any Firmware Volumes in the system.\r
  \r
    The function will read the first Firmware Section sepcifed by NameGuid, SectionType and Instance by searching\r
    for all Firmware Volumes in the system. \r
\r
    The search order for Firmware Volumes in the system is determistic but abitrary if no new Firmware Volume is installed\r
    into the system. The search order for the section specified by SectionType within a Firmware File is defined by\r
    EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization \r
    Shared Architectural Elements for detailes.\r
    \r
    If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section \r
    data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to \r
    read Firmware Section data from the Firmware File. If no such section specified is found to match , \r
    EFI_NOT_FOUND is returned.\r
\r
    The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
    by this function. This function can only be called at TPL_NOTIFY and below.\r
    \r
    If NameGuid is NULL, then ASSERT();\r
    If Buffer is NULL, then ASSERT();\r
    If Size is NULL, then ASSERT().\r
  \r
    @param  NameGuid             The GUID name of a Firmware File.\r
    @param  SectionType         The Firmware Section type.\r
    @param  Instance              The instance number of Firmware Section to read from starting from 0.\r
    @param  Buffer                  On output, Buffer contains the the data read from the section in the Firmware File found.\r
    @param  Size                    On output, the size of Buffer.\r
  \r
    @retval  EFI_SUCCESS        The image is found and data and size is returned.\r
    @retval  EFI_NOT_FOUND      The image specified by NameGuid and SectionType can't be found.\r
    @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
    @retval  EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
    @retval  EFI_ACCESS_DENIED  The firmware volume containing the searched Firmware File is configured to disallow reads.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
PiLibGetSectionFromAnyFv (\r
  IN  CONST EFI_GUID                *NameGuid,\r
  IN  EFI_SECTION_TYPE              SectionType,\r
  IN  UINTN                         Instance,\r
  OUT VOID                          **Buffer,\r
  OUT UINTN                         *Size\r
  )\r
;\r
\r
/**\r
    Allocate and fill a buffer from a Firmware Section identified by a Firmware File GUID name, a Firmware \r
    Section type and instance number from the same Firmware Volume with the caller's FFS.\r
  \r
    This functions first locates the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance for same Firmrware Volume\r
    which also contains the FFS of the caller in order to carry out the Firmware Volume read operation. \r
    The function then reads the Firmware Section found sepcifed by NameGuid, SectionType and Instance. \r
    \r
    The search order for the section specified by SectionType within a Firmware File is defined by\r
    EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization \r
    Shared Architectural Elements for detailes.\r
    \r
    If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section \r
    data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to \r
    read Firmware Section data from the Firmware File. If no such section specified is found to match , \r
    EFI_NOT_FOUND is returned.\r
    \r
    The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
    by this function. This function can be only called at TPL_NOTIFY and below.\r
    \r
    If FvHandle is NULL, then ASSERT ();\r
    If NameGuid is NULL, then ASSERT();\r
    If Buffer is NULL, then ASSERT();\r
    If Size is NULL, then ASSERT().\r
\r
    @param  NameGuid             The GUID name of a Firmware File.\r
    @param  SectionType         The Firmware Section type.\r
    @param  Instance              The instance number of Firmware Section to read from starting from 0.\r
    @param  Buffer                  On output, Buffer contains the the data read from the section in the Firmware File found.\r
    @param  Size                    On output, the size of Buffer.\r
  \r
    @retval  EFI_SUCCESS        The image is found and data and size is returned.\r
    @retval  EFI_UNSUPPORTED   FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
    @retval  EFI_NOT_FOUND      The image specified by NameGuid and SectionType can't be found.\r
    @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
    @retval  EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
    @retval  EFI_ACCESS_DENIED  The firmware volume containing the searched Firmware File is configured to disallow reads.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
PiLibGetSectionFromCurrentFv (\r
  IN  CONST EFI_GUID                *NameGuid,\r
  IN  EFI_SECTION_TYPE              SectionType,\r
  IN  UINTN                         Instance,\r
  OUT VOID                          **Buffer,\r
  OUT UINTN                         *Size\r
  )\r
;\r
\r
\r
/**\r
    Allocate and fill a buffer from the first Firmware Section in the same Firmware File as the caller of this function.\r
  \r
    The function will read the first Firmware Section found sepcifed by NameGuid and SectionType from the \r
    Firmware Volume specified by FvHandle. On this FvHandle, an EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance \r
    should be located succesfully in order to carry out the Firmware Volume operations.\r
    \r
    The search order for the section type specified by SectionType in the Firmware File is using a depth-first \r
    and left-to-right algorithm through all sections. The first section found to match SectionType will be returned. \r
    \r
    If SectionType is EFI_SECTION_PE32, EFI_SECTION_PE32 will be used as Firmware Section type \r
    to read Firmware Section data from the Firmware File. If no such section exists, the function will try \r
    to read a Firmware File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned.\r
    \r
    If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section \r
    data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to \r
    read Firmware Section data from the Firmware File. If no such section exists, the function will try to read a Firmware \r
    File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned.\r
    \r
    The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
    by this function. This function can only be called at TPL_NOTIFY and below.\r
    \r
    If Buffer is NULL, then ASSERT();\r
    If Size is NULL, then ASSERT().\r
  \r
    @param  SectionType         The Firmware Section type.\r
    @param  Instance            Instance number of a section.\r
    @param  Buffer                  On output, Buffer contains the the data read from the section in the Firmware File found.\r
    @param  Size                    On output, the size of Buffer.\r
  \r
    @retval  EFI_SUCCESS        The image is found and data and size is returned.\r
    @retval  EFI_NOT_FOUND      The image specified by NameGuid and SectionType can't be found.\r
    @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
    @retval  EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
    @retval  EFI_ACCESS_DENIED  The firmware volume containing the searched Firmware File is configured to disallow reads.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
PiLibGetSectionFromCurrentFfs (\r
  IN  EFI_SECTION_TYPE              SectionType,\r
  IN  UINTN                         Instance,\r
  OUT VOID                          **Buffer,\r
  OUT UINTN                         *Size\r
  )\r
;\r
\r
#endif\r
\r
Commit	Line	Data
1c280088	1	/** @file\r
	2	MDE PI library functions and macros\r
	3	\r
	4	Copyright (c) 2007, Intel Corporation \r
	5	All rights reserved. This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
	13	**/\r
	14	\r
	15	#ifndef __PI_LIB_H__\r
	16	#define __PI_LIB_H__\r
	17	\r
	18	#include <Pi/PiFirmwareFile.h>\r
	19	\r
b0d803fe	20	\r
	21	/**\r
	22	Allocate and fill a buffer from the Firmware Section identified by a Firmware File GUID name and a Firmware \r
166152e8	23	Section type and instance number from any Firmware Volumes in the system.\r
b0d803fe	24	\r
166152e8	25	The function will read the first Firmware Section sepcifed by NameGuid, SectionType and Instance by searching\r
166152e8	26	for all Firmware Volumes in the system. \r
b0d803fe	27	\r
	28	The search order for Firmware Volumes in the system is determistic but abitrary if no new Firmware Volume is installed\r
	29	into the system. The search order for the section specified by SectionType within a Firmware File is defined by\r
	30	EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization \r
	31	Shared Architectural Elements for detailes.\r
	32	\r
	33	If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section \r
	34	data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to \r
	35	read Firmware Section data from the Firmware File. If no such section specified is found to match , \r
	36	EFI_NOT_FOUND is returned.\r
	37	\r
	38	The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
	39	by this function. This function can only be called at TPL_NOTIFY and below.\r
	40	\r
	41	If NameGuid is NULL, then ASSERT();\r
	42	If Buffer is NULL, then ASSERT();\r
	43	If Size is NULL, then ASSERT().\r
	44	\r
	45	@param NameGuid The GUID name of a Firmware File.\r
	46	@param SectionType The Firmware Section type.\r
	47	@param Instance The instance number of Firmware Section to read from starting from 0.\r
	48	@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found.\r
	49	@param Size On output, the size of Buffer.\r
	50	\r
	51	@retval EFI_SUCCESS The image is found and data and size is returned.\r
	52	@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r
	53	@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
	54	@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
	55	@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r
	56	\r
f80b0830	57	**/\r
b0d803fe	58	EFI_STATUS\r
b0d803fe	59	EFIAPI\r
166152e8	60	PiLibGetSectionFromAnyFv (\r
b0d803fe	61	IN CONST EFI_GUID *NameGuid,\r
	62	IN EFI_SECTION_TYPE SectionType,\r
	63	IN UINTN Instance,\r
	64	OUT VOID **Buffer,\r
	65	OUT UINTN *Size\r
	66	)\r
	67	;\r
	68	\r
	69	/**\r
	70	Allocate and fill a buffer from a Firmware Section identified by a Firmware File GUID name, a Firmware \r
	71	Section type and instance number from the same Firmware Volume with the caller's FFS.\r
	72	\r
	73	This functions first locates the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance for same Firmrware Volume\r
	74	which also contains the FFS of the caller in order to carry out the Firmware Volume read operation. \r
	75	The function then reads the Firmware Section found sepcifed by NameGuid, SectionType and Instance. \r
	76	\r
	77	The search order for the section specified by SectionType within a Firmware File is defined by\r
	78	EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization \r
	79	Shared Architectural Elements for detailes.\r
	80	\r
	81	If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section \r
	82	data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to \r
	83	read Firmware Section data from the Firmware File. If no such section specified is found to match , \r
	84	EFI_NOT_FOUND is returned.\r
	85	\r
	86	The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
	87	by this function. This function can be only called at TPL_NOTIFY and below.\r
	88	\r
	89	If FvHandle is NULL, then ASSERT ();\r
	90	If NameGuid is NULL, then ASSERT();\r
	91	If Buffer is NULL, then ASSERT();\r
	92	If Size is NULL, then ASSERT().\r
	93	\r
	94	@param NameGuid The GUID name of a Firmware File.\r
	95	@param SectionType The Firmware Section type.\r
	96	@param Instance The instance number of Firmware Section to read from starting from 0.\r
	97	@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found.\r
	98	@param Size On output, the size of Buffer.\r
	99	\r
	100	@retval EFI_SUCCESS The image is found and data and size is returned.\r
	101	@retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
	102	@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r
	103	@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
	104	@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
	105	@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r
	106	\r
f80b0830	107	**/\r
b0d803fe	108	EFI_STATUS\r
b0d803fe	109	EFIAPI\r
166152e8	110	PiLibGetSectionFromCurrentFv (\r
b0d803fe	111	IN CONST EFI_GUID *NameGuid,\r
	112	IN EFI_SECTION_TYPE SectionType,\r
	113	IN UINTN Instance,\r
	114	OUT VOID **Buffer,\r
	115	OUT UINTN *Size\r
	116	)\r
	117	;\r
	118	\r
	119	\r
	120	/**\r
	121	Allocate and fill a buffer from the first Firmware Section in the same Firmware File as the caller of this function.\r
	122	\r
	123	The function will read the first Firmware Section found sepcifed by NameGuid and SectionType from the \r
	124	Firmware Volume specified by FvHandle. On this FvHandle, an EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance \r
	125	should be located succesfully in order to carry out the Firmware Volume operations.\r
	126	\r
	127	The search order for the section type specified by SectionType in the Firmware File is using a depth-first \r
	128	and left-to-right algorithm through all sections. The first section found to match SectionType will be returned. \r
	129	\r
	130	If SectionType is EFI_SECTION_PE32, EFI_SECTION_PE32 will be used as Firmware Section type \r
	131	to read Firmware Section data from the Firmware File. If no such section exists, the function will try \r
	132	to read a Firmware File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned.\r
	133	\r
	134	If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section \r
	135	data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to \r
	136	read Firmware Section data from the Firmware File. If no such section exists, the function will try to read a Firmware \r
	137	File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned.\r
	138	\r
	139	The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
	140	by this function. This function can only be called at TPL_NOTIFY and below.\r
	141	\r
b0d803fe	142	If Buffer is NULL, then ASSERT();\r
	143	If Size is NULL, then ASSERT().\r
	144	\r
b0d803fe	145	@param SectionType The Firmware Section type.\r
42eedea9	146	@param Instance Instance number of a section.\r
b0d803fe	147	@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found.\r
	148	@param Size On output, the size of Buffer.\r
	149	\r
	150	@retval EFI_SUCCESS The image is found and data and size is returned.\r
	151	@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r
	152	@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
	153	@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
	154	@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r
	155	\r
f80b0830	156	**/\r
b0d803fe	157	EFI_STATUS\r
b0d803fe	158	EFIAPI\r
166152e8	159	PiLibGetSectionFromCurrentFfs (\r
b0d803fe	160	IN EFI_SECTION_TYPE SectionType,\r
	161	IN UINTN Instance,\r
	162	OUT VOID **Buffer,\r
	163	OUT UINTN *Size\r
	164	)\r
	165	;\r
1c280088	166	\r
	167	#endif\r
	168	\r