[mirror_edk2.git] / EdkModulePkg / Universal / PCD / Pei / Service.h

/** @file\r
Private functions used by PCD PEIM.\r
\r
Copyright (c) 2006, 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
Module Name: Service.h\r
\r
**/\r
\r
#ifndef _SERVICE_H\r
#define _SERVICE_H\r
\r
//\r
// Please make sure the PCD Serivce PEIM Version is consistent with\r
// the version of PCD Database generation tool\r
//\r
#define PCD_PEI_SERVICE_DRIVER_VERSION      1\r
\r
//\r
// PCD_PEI_DATABASE_GENTOOL_VERSION is defined in Autogen.h\r
// and generated by PCD Database generation tool.\r
//\r
#if (PCD_PEI_SERVICE_PEIM_VERSION != PCD_PEI_DATABASE_GENTOOL_VERSION)\r
  #error "Please make sure the version of PCD Service PEIM and PCD PEI Database Generation Tool matches"\r
#endif\r
\r
/* Internal Function definitions */\r
\r
PEI_PCD_DATABASE *\r
GetPcdDatabase (\r
  VOID\r
  )\r
;\r
\r
EFI_STATUS\r
SetWorker (\r
  IN PCD_TOKEN_NUMBER   TokenNumber,\r
  IN VOID               *Data,\r
  IN UINTN              Size,\r
  IN BOOLEAN            PtrType\r
  )\r
;\r
\r
EFI_STATUS\r
ExSetWorker (\r
  IN PCD_TOKEN_NUMBER     ExTokenNumber,\r
  IN CONST EFI_GUID       *Guid,\r
  IN VOID                 *Data,\r
  IN UINTN                Size,\r
  IN BOOLEAN              PtrType\r
  )\r
;\r
\r
VOID *\r
GetWorker (\r
  IN PCD_TOKEN_NUMBER     TokenNumber,\r
  IN UINTN                GetSize\r
  )\r
;\r
\r
VOID *\r
ExGetWorker (\r
  IN CONST EFI_GUID   *Guid,\r
  IN PCD_TOKEN_NUMBER ExTokenNumber,\r
  IN UINTN            GetSize\r
  )\r
;\r
\r
typedef struct {\r
  UINTN   TokenNumber;\r
  UINTN   Size;\r
  UINT32  LocalTokenNumberAlias;\r
} EX_PCD_ENTRY_ATTRIBUTE;\r
\r
\r
PCD_TOKEN_NUMBER\r
GetExPcdTokenNumber (\r
  IN CONST EFI_GUID             *Guid,\r
  IN PCD_TOKEN_NUMBER           ExTokenNumber\r
  )\r
;\r
\r
\r
\r
\r
EFI_STATUS\r
PeiRegisterCallBackWorker (\r
  IN  PCD_TOKEN_NUMBER   TokenNumber,\r
  IN  CONST GUID         *Guid, OPTIONAL\r
  IN  PCD_PPI_CALLBACK   CallBackFunction,\r
  IN  BOOLEAN            Register\r
);\r
\r
\r
\r
\r
VOID\r
BuildPcdDatabase (\r
  VOID\r
  )\r
;\r
\r
\r
//\r
// PPI Interface Implementation Declaration.\r
//\r
VOID\r
EFIAPI\r
PeiPcdSetSku (\r
  IN  SKU_ID                  SkuId\r
  )\r
;\r
\r
\r
UINT8\r
EFIAPI\r
PeiPcdGet8 (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
UINT16\r
EFIAPI\r
PeiPcdGet16 (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
UINT32\r
EFIAPI\r
PeiPcdGet32 (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
UINT64\r
EFIAPI\r
PeiPcdGet64 (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
VOID *\r
EFIAPI\r
PeiPcdGetPtr (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
BOOLEAN\r
EFIAPI\r
PeiPcdGetBool (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
UINTN\r
EFIAPI\r
PeiPcdGetSize (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
UINT8\r
EFIAPI\r
PeiPcdGet8Ex (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
UINT16\r
EFIAPI\r
PeiPcdGet16Ex (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
UINT32\r
EFIAPI\r
PeiPcdGet32Ex (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
UINT64\r
EFIAPI\r
PeiPcdGet64Ex (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
VOID *\r
EFIAPI\r
PeiPcdGetPtrEx (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
BOOLEAN\r
EFIAPI\r
PeiPcdGetBoolEx (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
UINTN\r
EFIAPI\r
PeiPcdGetSizeEx (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet8 (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT8             Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet16 (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT16            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet32 (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT32            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet64 (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT64            Value\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetPtr (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINTN             SizeOfBuffer,\r
  IN VOID              *Buffer\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetBool (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN BOOLEAN           Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet8Ex (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT8             Value\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet16Ex (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT16            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet32Ex (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT32            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet64Ex (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT64            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetPtrEx (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINTN             SizeOfBuffer,\r
  IN VOID              *Buffer\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetBoolEx (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN BOOLEAN           Value\r
  )\r
;\r
\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiRegisterCallBackOnSet (\r
  IN  PCD_TOKEN_NUMBER        TokenNumber,\r
  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
  IN  PCD_PPI_CALLBACK        CallBackFunction\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PcdUnRegisterCallBackOnSet (\r
  IN  PCD_TOKEN_NUMBER        TokenNumber,\r
  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
  IN  PCD_PPI_CALLBACK        CallBackFunction\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdGetNextToken (\r
  IN CONST EFI_GUID           *Guid, OPTIONAL\r
  IN OUT  PCD_TOKEN_NUMBER    *TokenNumber\r
  )\r
;\r
\r
extern EFI_GUID gPcdDataBaseHobGuid;\r
\r
extern EFI_GUID gPcdPeiCallbackFnTableHobGuid;\r
\r
extern PEI_PCD_DATABASE_INIT gPEIPcdDbInit;\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	Private functions used by PCD PEIM.\r
	3	\r
	4	Copyright (c) 2006, 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	Module Name: Service.h\r
	15	\r
	16	**/\r
	17	\r
	18	#ifndef _SERVICE_H\r
	19	#define _SERVICE_H\r
	20	\r
	21	//\r
	22	// Please make sure the PCD Serivce PEIM Version is consistent with\r
	23	// the version of PCD Database generation tool\r
	24	//\r
	25	#define PCD_PEI_SERVICE_DRIVER_VERSION 1\r
	26	\r
	27	//\r
	28	// PCD_PEI_DATABASE_GENTOOL_VERSION is defined in Autogen.h\r
	29	// and generated by PCD Database generation tool.\r
	30	//\r
	31	#if (PCD_PEI_SERVICE_PEIM_VERSION != PCD_PEI_DATABASE_GENTOOL_VERSION)\r
	32	#error "Please make sure the version of PCD Service PEIM and PCD PEI Database Generation Tool matches"\r
	33	#endif\r
	34	\r
	35	/* Internal Function definitions */\r
	36	\r
	37	PEI_PCD_DATABASE *\r
	38	GetPcdDatabase (\r
	39	VOID\r
	40	)\r
	41	;\r
	42	\r
	43	EFI_STATUS\r
	44	SetWorker (\r
	45	IN PCD_TOKEN_NUMBER TokenNumber,\r
	46	IN VOID *Data,\r
	47	IN UINTN Size,\r
	48	IN BOOLEAN PtrType\r
	49	)\r
	50	;\r
	51	\r
	52	EFI_STATUS\r
	53	ExSetWorker (\r
	54	IN PCD_TOKEN_NUMBER ExTokenNumber,\r
	55	IN CONST EFI_GUID *Guid,\r
	56	IN VOID *Data,\r
	57	IN UINTN Size,\r
	58	IN BOOLEAN PtrType\r
	59	)\r
	60	;\r
	61	\r
	62	VOID *\r
	63	GetWorker (\r
	64	IN PCD_TOKEN_NUMBER TokenNumber,\r
	65	IN UINTN GetSize\r
	66	)\r
	67	;\r
	68	\r
	69	VOID *\r
	70	ExGetWorker (\r
	71	IN CONST EFI_GUID *Guid,\r
	72	IN PCD_TOKEN_NUMBER ExTokenNumber,\r
	73	IN UINTN GetSize\r
	74	)\r
	75	;\r
	76	\r
	77	typedef struct {\r
	78	UINTN TokenNumber;\r
	79	UINTN Size;\r
	80	UINT32 LocalTokenNumberAlias;\r
	81	} EX_PCD_ENTRY_ATTRIBUTE;\r
	82	\r
	83	\r
	84	PCD_TOKEN_NUMBER\r
	85	GetExPcdTokenNumber (\r
	86	IN CONST EFI_GUID *Guid,\r
	87	IN PCD_TOKEN_NUMBER ExTokenNumber\r
	88	)\r
	89	;\r
	90	\r
	91	\r
	92	\r
	93	\r
	94	EFI_STATUS\r
	95	PeiRegisterCallBackWorker (\r
	96	IN PCD_TOKEN_NUMBER TokenNumber,\r
	97	IN CONST GUID *Guid, OPTIONAL\r
	98	IN PCD_PPI_CALLBACK CallBackFunction,\r
	99	IN BOOLEAN Register\r
	100	);\r
	101	\r
	102	\r
	103	\r
	104	\r
	105	VOID\r
	106	BuildPcdDatabase (\r
	107	VOID\r
	108	)\r
	109	;\r
	110	\r
	111	\r
	112	//\r
	113	// PPI Interface Implementation Declaration.\r
	114	//\r
	115	VOID\r
	116	EFIAPI\r
	117	PeiPcdSetSku (\r
	118	IN SKU_ID SkuId\r
	119	)\r
	120	;\r
	121	\r
	122	\r
	123	UINT8\r
	124	EFIAPI\r
	125	PeiPcdGet8 (\r
	126	IN PCD_TOKEN_NUMBER TokenNumber\r
	127	)\r
	128	;\r
	129	\r
	130	\r
	131	UINT16\r
	132	EFIAPI\r
	133	PeiPcdGet16 (\r
	134	IN PCD_TOKEN_NUMBER TokenNumber\r
	135	)\r
	136	;\r
	137	\r
	138	\r
	139	UINT32\r
	140	EFIAPI\r
	141	PeiPcdGet32 (\r
	142	IN PCD_TOKEN_NUMBER TokenNumber\r
	143	)\r
	144	;\r
	145	\r
	146	\r
	147	UINT64\r
	148	EFIAPI\r
	149	PeiPcdGet64 (\r
	150	IN PCD_TOKEN_NUMBER TokenNumber\r
	151	)\r
	152	;\r
	153	\r
	154	\r
	155	VOID *\r
	156	EFIAPI\r
	157	PeiPcdGetPtr (\r
	158	IN PCD_TOKEN_NUMBER TokenNumber\r
	159	)\r
	160	;\r
	161	\r
	162	\r
	163	BOOLEAN\r
	164	EFIAPI\r
	165	PeiPcdGetBool (\r
	166	IN PCD_TOKEN_NUMBER TokenNumber\r
	167	)\r
	168	;\r
	169	\r
	170	\r
	171	UINTN\r
	172	EFIAPI\r
	173	PeiPcdGetSize (\r
	174	IN PCD_TOKEN_NUMBER TokenNumber\r
	175	)\r
	176	;\r
	177	\r
	178	\r
	179	UINT8\r
	180	EFIAPI\r
	181	PeiPcdGet8Ex (\r
	182	IN CONST EFI_GUID *Guid,\r
	183	IN PCD_TOKEN_NUMBER TokenNumber\r
	184	)\r
	185	;\r
	186	\r
	187	\r
	188	UINT16\r
	189	EFIAPI\r
	190	PeiPcdGet16Ex (\r
	191	IN CONST EFI_GUID *Guid,\r
	192	IN PCD_TOKEN_NUMBER TokenNumber\r
	193	)\r
	194	;\r
	195	\r
	196	UINT32\r
	197	EFIAPI\r
	198	PeiPcdGet32Ex (\r
	199	IN CONST EFI_GUID *Guid,\r
	200	IN PCD_TOKEN_NUMBER TokenNumber\r
	201	)\r
	202	;\r
	203	\r
	204	\r
	205	UINT64\r
	206	EFIAPI\r
	207	PeiPcdGet64Ex (\r
	208	IN CONST EFI_GUID *Guid,\r
	209	IN PCD_TOKEN_NUMBER TokenNumber\r
	210	)\r
	211	;\r
	212	\r
	213	\r
	214	VOID *\r
	215	EFIAPI\r
	216	PeiPcdGetPtrEx (\r
	217	IN CONST EFI_GUID *Guid,\r
	218	IN PCD_TOKEN_NUMBER TokenNumber\r
	219	)\r
	220	;\r
	221	\r
	222	\r
	223	BOOLEAN\r
	224	EFIAPI\r
	225	PeiPcdGetBoolEx (\r
	226	IN CONST EFI_GUID *Guid,\r
	227	IN PCD_TOKEN_NUMBER TokenNumber\r
	228	)\r
	229	;\r
	230	\r
	231	\r
	232	UINTN\r
	233	EFIAPI\r
	234	PeiPcdGetSizeEx (\r
	235	IN CONST EFI_GUID *Guid,\r
	236	IN PCD_TOKEN_NUMBER TokenNumber\r
	237	)\r
	238	;\r
	239	\r
	240	\r
	241	EFI_STATUS\r
	242	EFIAPI\r
	243	PeiPcdSet8 (\r
	244	IN PCD_TOKEN_NUMBER TokenNumber,\r
	245	IN UINT8 Value\r
	246	)\r
	247	;\r
	248	\r
	249	\r
	250	EFI_STATUS\r
	251	EFIAPI\r
	252	PeiPcdSet16 (\r
	253	IN PCD_TOKEN_NUMBER TokenNumber,\r
	254	IN UINT16 Value\r
	255	)\r
	256	;\r
	257	\r
	258	\r
	259	EFI_STATUS\r
	260	EFIAPI\r
	261	PeiPcdSet32 (\r
	262	IN PCD_TOKEN_NUMBER TokenNumber,\r
	263	IN UINT32 Value\r
	264	)\r
	265	;\r
	266	\r
	267	\r
	268	EFI_STATUS\r
	269	EFIAPI\r
	270	PeiPcdSet64 (\r
	271	IN PCD_TOKEN_NUMBER TokenNumber,\r
	272	IN UINT64 Value\r
	273	)\r
	274	;\r
	275	\r
	276	EFI_STATUS\r
	277	EFIAPI\r
	278	PeiPcdSetPtr (\r
	279	IN PCD_TOKEN_NUMBER TokenNumber,\r
	280	IN UINTN SizeOfBuffer,\r
	281	IN VOID *Buffer\r
	282	)\r
	283	;\r
	284	\r
	285	\r
	286	EFI_STATUS\r
	287	EFIAPI\r
	288	PeiPcdSetBool (\r
	289	IN PCD_TOKEN_NUMBER TokenNumber,\r
	290	IN BOOLEAN Value\r
	291	)\r
	292	;\r
	293	\r
	294	\r
	295	EFI_STATUS\r
	296	EFIAPI\r
	297	PeiPcdSet8Ex (\r
	298	IN CONST EFI_GUID *Guid,\r
	299	IN PCD_TOKEN_NUMBER TokenNumber,\r
	300	IN UINT8 Value\r
	301	)\r
	302	;\r
	303	\r
	304	EFI_STATUS\r
	305	EFIAPI\r
	306	PeiPcdSet16Ex (\r
	307	IN CONST EFI_GUID *Guid,\r
	308	IN PCD_TOKEN_NUMBER TokenNumber,\r
	309	IN UINT16 Value\r
	310	)\r
	311	;\r
	312	\r
	313	\r
	314	EFI_STATUS\r
	315	EFIAPI\r
	316	PeiPcdSet32Ex (\r
	317	IN CONST EFI_GUID *Guid,\r
	318	IN PCD_TOKEN_NUMBER TokenNumber,\r
	319	IN UINT32 Value\r
	320	)\r
	321	;\r
	322	\r
	323	\r
	324	EFI_STATUS\r
	325	EFIAPI\r
	326	PeiPcdSet64Ex (\r
	327	IN CONST EFI_GUID *Guid,\r
	328	IN PCD_TOKEN_NUMBER TokenNumber,\r
	329	IN UINT64 Value\r
	330	)\r
	331	;\r
	332	\r
	333	\r
	334	EFI_STATUS\r
	335	EFIAPI\r
	336	PeiPcdSetPtrEx (\r
	337	IN CONST EFI_GUID *Guid,\r
	338	IN PCD_TOKEN_NUMBER TokenNumber,\r
	339	IN UINTN SizeOfBuffer,\r
	340	IN VOID *Buffer\r
	341	)\r
	342	;\r
	343	\r
	344	\r
	345	EFI_STATUS\r
	346	EFIAPI\r
	347	PeiPcdSetBoolEx (\r
	348	IN CONST EFI_GUID *Guid,\r
	349	IN PCD_TOKEN_NUMBER TokenNumber,\r
	350	IN BOOLEAN Value\r
	351	)\r
	352	;\r
	353	\r
	354	\r
	355	\r
	356	EFI_STATUS\r
	357	EFIAPI\r
	358	PeiRegisterCallBackOnSet (\r
	359	IN PCD_TOKEN_NUMBER TokenNumber,\r
	360	IN CONST EFI_GUID *Guid, OPTIONAL\r
	361	IN PCD_PPI_CALLBACK CallBackFunction\r
	362	)\r
	363	;\r
	364	\r
	365	\r
	366	EFI_STATUS\r
	367	EFIAPI\r
	368	PcdUnRegisterCallBackOnSet (\r
	369	IN PCD_TOKEN_NUMBER TokenNumber,\r
	370	IN CONST EFI_GUID *Guid, OPTIONAL\r
	371	IN PCD_PPI_CALLBACK CallBackFunction\r
	372	)\r
	373	;\r
	374	\r
	375	\r
	376	EFI_STATUS\r
	377	EFIAPI\r
	378	PeiPcdGetNextToken (\r
	379	IN CONST EFI_GUID *Guid, OPTIONAL\r
	380	IN OUT PCD_TOKEN_NUMBER *TokenNumber\r
	381	)\r
	382	;\r
	383	\r
	384	extern EFI_GUID gPcdDataBaseHobGuid;\r
	385	\r
	386	extern EFI_GUID gPcdPeiCallbackFnTableHobGuid;\r
	387	\r
	388	extern PEI_PCD_DATABASE_INIT gPEIPcdDbInit;\r
	389	\r
	390	#endif\r