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