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

/** @file\r
Private functions used by PCD DXE driver.\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_DXE_SERVICE_DRIVER_VERSION      1\r
\r
//\r
// PCD_DXE_DATABASE_GENTOOL_VERSION is defined in Autogen.h\r
// and generated by PCD Database generation tool.\r
//\r
#if (PCD_DXE_SERVICE_PEIM_VERSION != PCD_DXE_DATABASE_GENTOOL_VERSION)\r
  #error "Please make sure the version of PCD Service DXE Driver and PCD DXE Database Generation Tool matches"\r
#endif\r
\r
\r
typedef struct {\r
  LIST_ENTRY              Node;\r
  PCD_PROTOCOL_CALLBACK   CallbackFn;\r
} CALLBACK_FN_ENTRY;\r
\r
#define CR_FNENTRY_FROM_LISTNODE(Record, Type, Field) _CR(Record, Type, Field)\r
\r
//\r
// Internal Functions\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
ExSetWorker (\r
  IN UINTN                ExTokenNumber,\r
  IN CONST EFI_GUID       *Guid,\r
  VOID                    *Data,\r
  UINTN                   Size,\r
  BOOLEAN                 PtrType\r
  )\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 UINTN                  ExTokenNumber,\r
  IN UINTN                  GetSize\r
  ) \r
;\r
\r
UINT32\r
GetSkuEnabledTokenNumber (\r
  UINT32 LocalTokenNumber,\r
  UINTN  Size,\r
  BOOLEAN IsPeiDb\r
  ) \r
;\r
\r
EFI_STATUS\r
GetHiiVariable (\r
  IN  EFI_GUID      *VariableGuid,\r
  IN  UINT16        *VariableName,\r
  OUT VOID          **VariableData,\r
  OUT UINTN         *VariableSize\r
  )\r
;\r
\r
EFI_STATUS\r
DxeRegisterCallBackWorker (\r
  IN  UINTN                   TokenNumber,\r
  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
  IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
);\r
\r
EFI_STATUS\r
DxeUnRegisterCallBackWorker (\r
  IN  UINTN                   TokenNumber,\r
  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
  IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
);\r
\r
VOID\r
BuildPcdDxeDataBase (\r
  VOID\r
);\r
\r
\r
UINTN           \r
GetExPcdTokenNumber (\r
  IN CONST EFI_GUID             *Guid,\r
  IN UINTN                      ExTokenNumber\r
  )\r
;\r
//\r
// Protocol Interface function declaration.\r
//\r
VOID\r
EFIAPI\r
DxePcdSetSku (\r
  IN  UINTN                  SkuId\r
  )\r
;\r
\r
\r
UINT8\r
EFIAPI\r
DxePcdGet8 (\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
UINT16\r
EFIAPI\r
DxePcdGet16 (\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
UINT32\r
EFIAPI\r
DxePcdGet32 (\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
UINT64\r
EFIAPI\r
DxePcdGet64 (\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
VOID *\r
EFIAPI\r
DxePcdGetPtr (\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
BOOLEAN\r
EFIAPI\r
DxePcdGetBool (\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
UINTN\r
EFIAPI\r
DxePcdGetSize (\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
UINT8\r
EFIAPI\r
DxePcdGet8Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
UINT16\r
EFIAPI\r
DxePcdGet16Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
UINT32\r
EFIAPI\r
DxePcdGet32Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
\r
UINT64\r
EFIAPI\r
DxePcdGet64Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
\r
VOID *\r
EFIAPI\r
DxePcdGetPtrEx (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
BOOLEAN\r
EFIAPI\r
DxePcdGetBoolEx (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
UINTN\r
EFIAPI\r
DxePcdGetSizeEx (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSet8 (\r
  IN UINTN             TokenNumber,\r
  IN UINT8             Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSet16 (\r
  IN UINTN             TokenNumber,\r
  IN UINT16             Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSet32 (\r
  IN UINTN             TokenNumber,\r
  IN UINT32             Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSet64 (\r
  IN UINTN             TokenNumber,\r
  IN UINT64            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSetPtr (\r
  IN UINTN             TokenNumber,\r
  IN UINTN             SizeOfBuffer,\r
  IN VOID              *Buffer\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSetBool (\r
  IN UINTN             TokenNumber,\r
  IN BOOLEAN           Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSet8Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber,\r
  IN UINT8             Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSet16Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber,\r
  IN UINT16            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSet32Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber,\r
  IN UINT32             Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSet64Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN             TokenNumber,\r
  IN UINT64            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSetPtrEx (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber,\r
  IN UINTN             SizeOfBuffer,\r
  IN VOID              *Buffer\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdSetBoolEx (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber,\r
  IN BOOLEAN           Value\r
  )\r
;\r
\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxeRegisterCallBackOnSet (\r
  IN  UINTN                   TokenNumber,\r
  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
  IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxeUnRegisterCallBackOnSet (\r
  IN  UINTN                   TokenNumber,\r
  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
  IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DxePcdGetNextToken (\r
  IN CONST EFI_GUID               *Guid, OPTIONAL\r
  IN OUT   UINTN                  *TokenNumber\r
  )\r
;\r
\r
UINTN           \r
ExGetNextTokeNumber (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber,\r
  IN EFI_GUID          *GuidTable,\r
  IN UINTN             SizeOfGuidTable,\r
  IN DYNAMICEX_MAPPING *ExMapTable,\r
  IN UINTN             SizeOfExMapTable\r
  )\r
;\r
\r
extern EFI_GUID gPcdDataBaseHobGuid;\r
\r
extern PCD_DATABASE * mPcdDatabase;\r
\r
extern DXE_PCD_DATABASE_INIT gDXEPcdDbInit;\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	Private functions used by PCD DXE driver.\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_DXE_SERVICE_DRIVER_VERSION 1\r
	26	\r
	27	//\r
	28	// PCD_DXE_DATABASE_GENTOOL_VERSION is defined in Autogen.h\r
	29	// and generated by PCD Database generation tool.\r
	30	//\r
	31	#if (PCD_DXE_SERVICE_PEIM_VERSION != PCD_DXE_DATABASE_GENTOOL_VERSION)\r
	32	#error "Please make sure the version of PCD Service DXE Driver and PCD DXE Database Generation Tool matches"\r
	33	#endif\r
	34	\r
	35	\r
	36	typedef struct {\r
	37	LIST_ENTRY Node;\r
	38	PCD_PROTOCOL_CALLBACK CallbackFn;\r
	39	} CALLBACK_FN_ENTRY;\r
	40	\r
	41	#define CR_FNENTRY_FROM_LISTNODE(Record, Type, Field) _CR(Record, Type, Field)\r
	42	\r
	43	//\r
	44	// Internal Functions\r
	45	//\r
	46	\r
	47	EFI_STATUS\r
	48	SetWorker (\r
	49	IN UINTN TokenNumber,\r
	50	IN VOID *Data,\r
	51	IN UINTN Size,\r
	52	IN BOOLEAN PtrType\r
	53	)\r
	54	;\r
	55	\r
	56	EFI_STATUS\r
	57	ExSetWorker (\r
	58	IN UINTN ExTokenNumber,\r
	59	IN CONST EFI_GUID *Guid,\r
	60	VOID *Data,\r
	61	UINTN Size,\r
	62	BOOLEAN PtrType\r
	63	)\r
	64	;\r
	65	\r
	66	\r
	67	VOID *\r
	68	GetWorker (\r
	69	UINTN TokenNumber,\r
	70	UINTN GetSize\r
	71	)\r
	72	;\r
	73	\r
	74	VOID *\r
	75	ExGetWorker (\r
	76	IN CONST EFI_GUID *Guid,\r
	77	IN UINTN ExTokenNumber,\r
	78	IN UINTN GetSize\r
	79	) \r
	80	;\r
	81	\r
	82	UINT32\r
	83	GetSkuEnabledTokenNumber (\r
	84	UINT32 LocalTokenNumber,\r
	85	UINTN Size,\r
	86	BOOLEAN IsPeiDb\r
	87	) \r
	88	;\r
	89	\r
	90	EFI_STATUS\r
	91	GetHiiVariable (\r
	92	IN EFI_GUID *VariableGuid,\r
	93	IN UINT16 *VariableName,\r
	94	OUT VOID **VariableData,\r
	95	OUT UINTN *VariableSize\r
	96	)\r
	97	;\r
	98	\r
	99	EFI_STATUS\r
	100	DxeRegisterCallBackWorker (\r
	101	IN UINTN TokenNumber,\r
	102	IN CONST EFI_GUID *Guid, OPTIONAL\r
	103	IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
	104	);\r
	105	\r
	106	EFI_STATUS\r
	107	DxeUnRegisterCallBackWorker (\r
	108	IN UINTN TokenNumber,\r
	109	IN CONST EFI_GUID *Guid, OPTIONAL\r
	110	IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
	111	);\r
	112	\r
	113	VOID\r
	114	BuildPcdDxeDataBase (\r
	115	VOID\r
	116	);\r
	117	\r
	118	\r
	119	UINTN \r
	120	GetExPcdTokenNumber (\r
	121	IN CONST EFI_GUID *Guid,\r
	122	IN UINTN ExTokenNumber\r
	123	)\r
	124	;\r
	125	//\r
	126	// Protocol Interface function declaration.\r
	127	//\r
	128	VOID\r
	129	EFIAPI\r
	130	DxePcdSetSku (\r
	131	IN UINTN SkuId\r
	132	)\r
	133	;\r
	134	\r
	135	\r
	136	UINT8\r
	137	EFIAPI\r
	138	DxePcdGet8 (\r
	139	IN UINTN TokenNumber\r
	140	)\r
	141	;\r
	142	\r
	143	\r
	144	UINT16\r
	145	EFIAPI\r
	146	DxePcdGet16 (\r
	147	IN UINTN TokenNumber\r
	148	)\r
	149	;\r
	150	\r
	151	\r
	152	UINT32\r
	153	EFIAPI\r
	154	DxePcdGet32 (\r
	155	IN UINTN TokenNumber\r
	156	)\r
	157	;\r
	158	\r
	159	\r
	160	UINT64\r
	161	EFIAPI\r
	162	DxePcdGet64 (\r
	163	IN UINTN TokenNumber\r
	164	)\r
	165	;\r
	166	\r
	167	\r
	168	VOID *\r
	169	EFIAPI\r
	170	DxePcdGetPtr (\r
	171	IN UINTN TokenNumber\r
	172	)\r
	173	;\r
	174	\r
	175	\r
	176	BOOLEAN\r
	177	EFIAPI\r
	178	DxePcdGetBool (\r
	179	IN UINTN TokenNumber\r
	180	)\r
	181	;\r
	182	\r
	183	\r
	184	UINTN\r
	185	EFIAPI\r
	186	DxePcdGetSize (\r
	187	IN UINTN TokenNumber\r
	188	)\r
	189	;\r
	190	\r
	191	\r
	192	UINT8\r
	193	EFIAPI\r
	194	DxePcdGet8Ex (\r
	195	IN CONST EFI_GUID *Guid,\r
	196	IN UINTN TokenNumber\r
	197	)\r
	198	;\r
	199	\r
	200	\r
	201	UINT16\r
	202	EFIAPI\r
	203	DxePcdGet16Ex (\r
	204	IN CONST EFI_GUID *Guid,\r
	205	IN UINTN TokenNumber\r
	206	)\r
	207	;\r
	208	\r
	209	\r
	210	UINT32\r
	211	EFIAPI\r
	212	DxePcdGet32Ex (\r
	213	IN CONST EFI_GUID *Guid,\r
	214	IN UINTN TokenNumber\r
	215	)\r
	216	;\r
	217	\r
	218	\r
	219	\r
	220	UINT64\r
	221	EFIAPI\r
	222	DxePcdGet64Ex (\r
	223	IN CONST EFI_GUID *Guid,\r
	224	IN UINTN TokenNumber\r
	225	)\r
	226	;\r
	227	\r
	228	\r
	229	\r
	230	VOID *\r
	231	EFIAPI\r
	232	DxePcdGetPtrEx (\r
	233	IN CONST EFI_GUID *Guid,\r
	234	IN UINTN TokenNumber\r
	235	)\r
	236	;\r
	237	\r
	238	\r
	239	BOOLEAN\r
	240	EFIAPI\r
	241	DxePcdGetBoolEx (\r
	242	IN CONST EFI_GUID *Guid,\r
	243	IN UINTN TokenNumber\r
	244	)\r
	245	;\r
	246	\r
	247	\r
	248	UINTN\r
	249	EFIAPI\r
	250	DxePcdGetSizeEx (\r
	251	IN CONST EFI_GUID *Guid,\r
	252	IN UINTN TokenNumber\r
	253	)\r
	254	;\r
	255	\r
	256	\r
	257	EFI_STATUS\r
	258	EFIAPI\r
	259	DxePcdSet8 (\r
	260	IN UINTN TokenNumber,\r
	261	IN UINT8 Value\r
	262	)\r
	263	;\r
	264	\r
	265	\r
	266	EFI_STATUS\r
	267	EFIAPI\r
	268	DxePcdSet16 (\r
	269	IN UINTN TokenNumber,\r
	270	IN UINT16 Value\r
	271	)\r
	272	;\r
	273	\r
	274	\r
	275	EFI_STATUS\r
	276	EFIAPI\r
	277	DxePcdSet32 (\r
	278	IN UINTN TokenNumber,\r
	279	IN UINT32 Value\r
	280	)\r
	281	;\r
	282	\r
	283	\r
	284	EFI_STATUS\r
	285	EFIAPI\r
	286	DxePcdSet64 (\r
	287	IN UINTN TokenNumber,\r
	288	IN UINT64 Value\r
	289	)\r
	290	;\r
	291	\r
	292	\r
	293	EFI_STATUS\r
	294	EFIAPI\r
	295	DxePcdSetPtr (\r
	296	IN UINTN TokenNumber,\r
	297	IN UINTN SizeOfBuffer,\r
	298	IN VOID *Buffer\r
	299	)\r
	300	;\r
	301	\r
	302	\r
	303	EFI_STATUS\r
	304	EFIAPI\r
	305	DxePcdSetBool (\r
	306	IN UINTN TokenNumber,\r
	307	IN BOOLEAN Value\r
	308	)\r
	309	;\r
	310	\r
	311	\r
	312	EFI_STATUS\r
	313	EFIAPI\r
	314	DxePcdSet8Ex (\r
	315	IN CONST EFI_GUID *Guid,\r
	316	IN UINTN TokenNumber,\r
	317	IN UINT8 Value\r
	318	)\r
	319	;\r
	320	\r
	321	\r
	322	EFI_STATUS\r
	323	EFIAPI\r
	324	DxePcdSet16Ex (\r
	325	IN CONST EFI_GUID *Guid,\r
	326	IN UINTN TokenNumber,\r
	327	IN UINT16 Value\r
	328	)\r
	329	;\r
	330	\r
	331	\r
	332	EFI_STATUS\r
	333	EFIAPI\r
	334	DxePcdSet32Ex (\r
	335	IN CONST EFI_GUID *Guid,\r
	336	IN UINTN TokenNumber,\r
	337	IN UINT32 Value\r
	338	)\r
	339	;\r
	340	\r
	341	\r
	342	EFI_STATUS\r
	343	EFIAPI\r
	344	DxePcdSet64Ex (\r
	345	IN CONST EFI_GUID *Guid,\r
	346	IN UINTN TokenNumber,\r
	347	IN UINT64 Value\r
	348	)\r
	349	;\r
	350	\r
	351	\r
	352	EFI_STATUS\r
	353	EFIAPI\r
	354	DxePcdSetPtrEx (\r
	355	IN CONST EFI_GUID *Guid,\r
	356	IN UINTN TokenNumber,\r
	357	IN UINTN SizeOfBuffer,\r
	358	IN VOID *Buffer\r
	359	)\r
	360	;\r
	361	\r
	362	\r
	363	EFI_STATUS\r
	364	EFIAPI\r
	365	DxePcdSetBoolEx (\r
	366	IN CONST EFI_GUID *Guid,\r
	367	IN UINTN TokenNumber,\r
	368	IN BOOLEAN Value\r
	369	)\r
	370	;\r
	371	\r
	372	\r
	373	\r
	374	EFI_STATUS\r
	375	EFIAPI\r
	376	DxeRegisterCallBackOnSet (\r
	377	IN UINTN TokenNumber,\r
	378	IN CONST EFI_GUID *Guid, OPTIONAL\r
	379	IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
	380	)\r
	381	;\r
	382	\r
	383	\r
	384	EFI_STATUS\r
	385	EFIAPI\r
	386	DxeUnRegisterCallBackOnSet (\r
	387	IN UINTN TokenNumber,\r
	388	IN CONST EFI_GUID *Guid, OPTIONAL\r
	389	IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
	390	)\r
	391	;\r
	392	\r
	393	\r
	394	EFI_STATUS\r
	395	EFIAPI\r
	396	DxePcdGetNextToken (\r
	397	IN CONST EFI_GUID *Guid, OPTIONAL\r
	398	IN OUT UINTN *TokenNumber\r
	399	)\r
	400	;\r
	401	\r
	402	UINTN \r
	403	ExGetNextTokeNumber (\r
	404	IN CONST EFI_GUID *Guid,\r
	405	IN UINTN TokenNumber,\r
	406	IN EFI_GUID *GuidTable,\r
	407	IN UINTN SizeOfGuidTable,\r
	408	IN DYNAMICEX_MAPPING *ExMapTable,\r
	409	IN UINTN SizeOfExMapTable\r
	410	)\r
	411	;\r
	412	\r
	413	extern EFI_GUID gPcdDataBaseHobGuid;\r
	414	\r
	415	extern PCD_DATABASE * mPcdDatabase;\r
	416	\r
	417	extern DXE_PCD_DATABASE_INIT gDXEPcdDbInit;\r
	418	\r
	419	#endif\r