[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / ReadOnlyVariable2ToReadOnlyVariableThunk / ReadOnlyVariable2ToReadOnlyVariableThunk.c

/** @file\r
Module produce EFI_PEI_READ_ONLY_VARIABLE2_PPI on top of EFI_PEI_READ_ONLY_VARIABLE_PPI.\r
UEFI PI Spec supersedes Intel's Framework Specs. \r
EFI_PEI_READ_ONLY_VARIABLE_PPI defined in Intel Framework Pkg is replaced by EFI_PEI_READ_ONLY_VARIABLE2_PPI\r
in MdePkg.\r
This module produces EFI_PEI_READ_ONLY_VARIABLE2_PPI on top of EFI_PEI_READ_ONLY_VARIABLE_PPI. \r
This module is used on platform when both of these two conditions are true:\r
1) Framework module produces EFI_PEI_READ_ONLY_VARIABLE_PPI is present.\r
2) The platform has PI modules that only consumes EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
\r
This module can't be used together with ReadOnlyVariableToReadOnlyVariable2Thunk module.\r
\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
Module Name:\r
\r
**/\r
\r
#include <PiPei.h>\r
#include <Ppi/ReadOnlyVariable2.h>\r
#include <Ppi/ReadOnlyVariable.h>\r
#include <Ppi/ReadOnlyVariableThunkPresent.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/PeiServicesLib.h>\r
\r
//\r
// Function Prototypes\r
//\r
EFI_STATUS\r
EFIAPI\r
PeiGetVariable (\r
  IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
  IN CONST  CHAR16                          *VariableName,\r
  IN CONST  EFI_GUID                        *VariableGuid,\r
  OUT       UINT32                          *Attributes,\r
  IN OUT    UINTN                           *DataSize,\r
  OUT       VOID                            *Data\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
PeiGetNextVariableName (\r
  IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
  IN OUT UINTN                              *VariableNameSize,\r
  IN OUT CHAR16                             *VariableName,\r
  IN OUT EFI_GUID                           *VariableGuid\r
  );\r
\r
//\r
// Module globals\r
//\r
EFI_PEI_READ_ONLY_VARIABLE2_PPI mVariablePpi = {\r
  PeiGetVariable,\r
  PeiGetNextVariableName\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR     mPpiListVariable = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiReadOnlyVariable2PpiGuid,\r
  &mVariablePpi\r
};\r
\r
\r
EFI_PEI_PPI_DESCRIPTOR     mReadOnlyVariableThunkPresent = {\r
    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
    &gPeiReadonlyVariableThunkPresentPpiGuid,\r
    NULL\r
};\r
\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeReadOnlyVariable2 (\r
  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Provide the functionality of the variable services.\r
\r
Arguments:\r
\r
  FfsHeadher  - The FFS file header\r
  PeiServices - General purpose services available to every PEIM.\r
\r
Returns:\r
\r
  Status -  EFI_SUCCESS if the interface could be successfully\r
            installed\r
\r
--*/\r
{\r
  VOID        *Interface;\r
  EFI_STATUS  Status;\r
  //\r
  // This thunk module can only be used together with a PI PEI core, as we \r
  // assume PeiServices Pointer Table can be located in a standard way defined\r
  // in PI spec.\r
  //\r
  ASSERT ((*PeiServices)->Hdr.Revision >= 0x00010000);\r
\r
  //\r
  // Make sure ReadOnlyVariable2ToReadOnlyVariable module is not present. If so, the call chain will form a\r
  // infinite loop: ReadOnlyVariable2 -> ReadOnlyVariable -> ReadOnlyVariable2 -> ....\r
  //\r
  Status = PeiServicesLocatePpi (&gPeiReadonlyVariableThunkPresentPpiGuid, 0, NULL, &Interface);\r
  ASSERT (Status == EFI_NOT_FOUND);\r
  \r
  Status = PeiServicesInstallPpi (&mReadOnlyVariableThunkPresent);\r
  ASSERT_EFI_ERROR (Status);\r
  \r
  //\r
  // Publish the variable capability to other modules\r
  //\r
  return PeiServicesInstallPpi (&mPpiListVariable);\r
}\r
\r
/**\r
  Provide the read variable functionality of the variable services.\r
\r
  @param  PeiServices           General purpose services available to every PEIM.\r
  @param  VariableName          The variable name\r
  @param  VendorGuid            The vendor's GUID\r
  @param  Attributes            Pointer to the attribute\r
  @param  DataSize              Size of data\r
  @param  Data                  Pointer to data\r
\r
  @retval EFI_SUCCESS           The interface could be successfully installed\r
  @retval EFI_NOT_FOUND         The variable could not be discovered\r
  @retval EFI_BUFFER_TOO_SMALL  The caller buffer is not large enough\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiGetVariable (\r
  IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
  IN CONST  CHAR16                          *VariableName,\r
  IN CONST  EFI_GUID                        *VariableGuid,\r
  OUT       UINT32                          *Attributes,\r
  IN OUT    UINTN                           *DataSize,\r
  OUT       VOID                            *Data\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  EFI_PEI_READ_ONLY_VARIABLE_PPI *ReadOnlyVariable;\r
\r
  Status = PeiServicesLocatePpi (\r
             &gEfiPeiReadOnlyVariablePpiGuid,\r
             0,\r
             NULL,\r
             (VOID **)&ReadOnlyVariable\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return ReadOnlyVariable->PeiGetVariable (\r
                             GetPeiServicesTablePointer (),\r
                             (CHAR16 *)VariableName,\r
                             (EFI_GUID *)VariableGuid,\r
                             Attributes,\r
                             DataSize,\r
                             Data\r
                             );\r
}\r
\r
/**\r
  Provide the get next variable functionality of the variable services.\r
\r
  @param  PeiServices           General purpose services available to every PEIM.\r
  @param  VariabvleNameSize     The variable name's size.\r
  @param  VariableName          A pointer to the variable's name.\r
  @param  VariableGuid          A pointer to the EFI_GUID structure.\r
  @param  VariableNameSize      Size of the variable name\r
  @param  VariableName          The variable name\r
  @param  VendorGuid            The vendor's GUID\r
\r
  @retval EFI_SUCCESS           The interface could be successfully installed\r
  @retval EFI_NOT_FOUND         The variable could not be discovered\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiGetNextVariableName (\r
  IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
  IN OUT UINTN                              *VariableNameSize,\r
  IN OUT CHAR16                             *VariableName,\r
  IN OUT EFI_GUID                           *VariableGuid\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  EFI_PEI_READ_ONLY_VARIABLE_PPI *ReadOnlyVariable;\r
\r
  Status = PeiServicesLocatePpi (\r
             &gEfiPeiReadOnlyVariablePpiGuid,\r
             0,\r
             NULL,\r
             (VOID **)&ReadOnlyVariable\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return ReadOnlyVariable->PeiGetNextVariableName (\r
                             GetPeiServicesTablePointer (),\r
                             VariableNameSize,\r
                             VariableName,\r
                             VariableGuid\r
                             );\r
}\r
Commit	Line	Data
6c45955b	1	/** @file\r
	2	Module produce EFI_PEI_READ_ONLY_VARIABLE2_PPI on top of EFI_PEI_READ_ONLY_VARIABLE_PPI.\r
	3	UEFI PI Spec supersedes Intel's Framework Specs. \r
	4	EFI_PEI_READ_ONLY_VARIABLE_PPI defined in Intel Framework Pkg is replaced by EFI_PEI_READ_ONLY_VARIABLE2_PPI\r
	5	in MdePkg.\r
	6	This module produces EFI_PEI_READ_ONLY_VARIABLE2_PPI on top of EFI_PEI_READ_ONLY_VARIABLE_PPI. \r
	7	This module is used on platform when both of these two conditions are true:\r
	8	1) Framework module produces EFI_PEI_READ_ONLY_VARIABLE_PPI is present.\r
	9	2) The platform has PI modules that only consumes EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
	10	\r
	11	This module can't be used together with ReadOnlyVariableToReadOnlyVariable2Thunk module.\r
	12	\r
4259256b	13	\r
	14	Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
	15	All rights reserved. This program and the accompanying materials\r
	16	are licensed and made available under the terms and conditions of the BSD License\r
	17	which accompanies this distribution. The full text of the license may be found at\r
	18	http://opensource.org/licenses/bsd-license.php\r
	19	\r
	20	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	21	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	22	Module Name:\r
	23	\r
6c45955b	24	**/\r
4259256b	25	\r
	26	#include <PiPei.h>\r
	27	#include <Ppi/ReadOnlyVariable2.h>\r
	28	#include <Ppi/ReadOnlyVariable.h>\r
6c45955b	29	#include <Ppi/ReadOnlyVariableThunkPresent.h>\r
4259256b	30	#include <Library/DebugLib.h>\r
	31	#include <Library/PeiServicesTablePointerLib.h>\r
	32	#include <Library/PeiServicesLib.h>\r
	33	\r
	34	//\r
	35	// Function Prototypes\r
	36	//\r
	37	EFI_STATUS\r
	38	EFIAPI\r
	39	PeiGetVariable (\r
	40	IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
	41	IN CONST CHAR16 *VariableName,\r
	42	IN CONST EFI_GUID *VariableGuid,\r
	43	OUT UINT32 *Attributes,\r
	44	IN OUT UINTN *DataSize,\r
	45	OUT VOID *Data\r
	46	);\r
	47	\r
	48	EFI_STATUS\r
	49	EFIAPI\r
	50	PeiGetNextVariableName (\r
	51	IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
	52	IN OUT UINTN *VariableNameSize,\r
	53	IN OUT CHAR16 *VariableName,\r
	54	IN OUT EFI_GUID *VariableGuid\r
	55	);\r
	56	\r
	57	//\r
	58	// Module globals\r
	59	//\r
	60	EFI_PEI_READ_ONLY_VARIABLE2_PPI mVariablePpi = {\r
	61	PeiGetVariable,\r
	62	PeiGetNextVariableName\r
	63	};\r
	64	\r
	65	EFI_PEI_PPI_DESCRIPTOR mPpiListVariable = {\r
	66	(EFI_PEI_PPI_DESCRIPTOR_PPI \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	67	&gEfiPeiReadOnlyVariable2PpiGuid,\r
	68	&mVariablePpi\r
	69	};\r
	70	\r
6c45955b	71	\r
	72	EFI_PEI_PPI_DESCRIPTOR mReadOnlyVariableThunkPresent = {\r
	73	(EFI_PEI_PPI_DESCRIPTOR_PPI \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	74	&gPeiReadonlyVariableThunkPresentPpiGuid,\r
	75	NULL\r
f21c3770	76	};\r
6c45955b	77	\r
4259256b	78	EFI_STATUS\r
	79	EFIAPI\r
	80	PeimInitializeReadOnlyVariable2 (\r
	81	IN EFI_FFS_FILE_HEADER *FfsHeader,\r
	82	IN EFI_PEI_SERVICES **PeiServices\r
	83	)\r
	84	/*++\r
	85	\r
	86	Routine Description:\r
	87	\r
	88	Provide the functionality of the variable services.\r
	89	\r
	90	Arguments:\r
	91	\r
	92	FfsHeadher - The FFS file header\r
	93	PeiServices - General purpose services available to every PEIM.\r
	94	\r
	95	Returns:\r
	96	\r
	97	Status - EFI_SUCCESS if the interface could be successfully\r
	98	installed\r
	99	\r
	100	--*/\r
	101	{\r
6c45955b	102	VOID *Interface;\r
6c45955b	103	EFI_STATUS Status;\r
9d5eaca4	104	//\r
	105	// This thunk module can only be used together with a PI PEI core, as we \r
	106	// assume PeiServices Pointer Table can be located in a standard way defined\r
	107	// in PI spec.\r
	108	//\r
	109	ASSERT ((*PeiServices)->Hdr.Revision >= 0x00010000);\r
6c45955b	110	\r
	111	//\r
	112	// Make sure ReadOnlyVariable2ToReadOnlyVariable module is not present. If so, the call chain will form a\r
	113	// infinite loop: ReadOnlyVariable2 -> ReadOnlyVariable -> ReadOnlyVariable2 -> ....\r
	114	//\r
	115	Status = PeiServicesLocatePpi (&gPeiReadonlyVariableThunkPresentPpiGuid, 0, NULL, &Interface);\r
	116	ASSERT (Status == EFI_NOT_FOUND);\r
	117	\r
f21c3770	118	Status = PeiServicesInstallPpi (&mReadOnlyVariableThunkPresent);\r
	119	ASSERT_EFI_ERROR (Status);\r
	120	\r
4259256b	121	//\r
	122	// Publish the variable capability to other modules\r
	123	//\r
	124	return PeiServicesInstallPpi (&mPpiListVariable);\r
	125	}\r
	126	\r
2be3c946	127	/**\r
	128	Provide the read variable functionality of the variable services.\r
	129	\r
	130	@param PeiServices General purpose services available to every PEIM.\r
	131	@param VariableName The variable name\r
	132	@param VendorGuid The vendor's GUID\r
	133	@param Attributes Pointer to the attribute\r
	134	@param DataSize Size of data\r
	135	@param Data Pointer to data\r
	136	\r
	137	@retval EFI_SUCCESS The interface could be successfully installed\r
	138	@retval EFI_NOT_FOUND The variable could not be discovered\r
	139	@retval EFI_BUFFER_TOO_SMALL The caller buffer is not large enough\r
	140	\r
	141	**/\r
4259256b	142	EFI_STATUS\r
	143	EFIAPI\r
	144	PeiGetVariable (\r
	145	IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
	146	IN CONST CHAR16 *VariableName,\r
	147	IN CONST EFI_GUID *VariableGuid,\r
	148	OUT UINT32 *Attributes,\r
	149	IN OUT UINTN *DataSize,\r
	150	OUT VOID *Data\r
	151	)\r
4259256b	152	{\r
	153	EFI_STATUS Status;\r
	154	EFI_PEI_READ_ONLY_VARIABLE_PPI *ReadOnlyVariable;\r
	155	\r
	156	Status = PeiServicesLocatePpi (\r
	157	&gEfiPeiReadOnlyVariablePpiGuid,\r
	158	0,\r
	159	NULL,\r
	160	(VOID **)&ReadOnlyVariable\r
	161	);\r
	162	ASSERT_EFI_ERROR (Status);\r
	163	\r
	164	return ReadOnlyVariable->PeiGetVariable (\r
	165	GetPeiServicesTablePointer (),\r
	166	(CHAR16 *)VariableName,\r
	167	(EFI_GUID *)VariableGuid,\r
	168	Attributes,\r
	169	DataSize,\r
	170	Data\r
	171	);\r
	172	}\r
	173	\r
2be3c946	174	/**\r
	175	Provide the get next variable functionality of the variable services.\r
	176	\r
	177	@param PeiServices General purpose services available to every PEIM.\r
	178	@param VariabvleNameSize The variable name's size.\r
	179	@param VariableName A pointer to the variable's name.\r
	180	@param VariableGuid A pointer to the EFI_GUID structure.\r
	181	@param VariableNameSize Size of the variable name\r
	182	@param VariableName The variable name\r
	183	@param VendorGuid The vendor's GUID\r
	184	\r
	185	@retval EFI_SUCCESS The interface could be successfully installed\r
	186	@retval EFI_NOT_FOUND The variable could not be discovered\r
	187	\r
	188	**/\r
4259256b	189	EFI_STATUS\r
	190	EFIAPI\r
	191	PeiGetNextVariableName (\r
	192	IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
	193	IN OUT UINTN *VariableNameSize,\r
	194	IN OUT CHAR16 *VariableName,\r
	195	IN OUT EFI_GUID *VariableGuid\r
	196	)\r
4259256b	197	{\r
	198	EFI_STATUS Status;\r
	199	EFI_PEI_READ_ONLY_VARIABLE_PPI *ReadOnlyVariable;\r
	200	\r
	201	Status = PeiServicesLocatePpi (\r
	202	&gEfiPeiReadOnlyVariablePpiGuid,\r
	203	0,\r
	204	NULL,\r
	205	(VOID **)&ReadOnlyVariable\r
	206	);\r
	207	ASSERT_EFI_ERROR (Status);\r
	208	\r
	209	return ReadOnlyVariable->PeiGetNextVariableName (\r
	210	GetPeiServicesTablePointer (),\r
	211	VariableNameSize,\r
	212	VariableName,\r
	213	VariableGuid\r
	214	);\r
	215	}\r