[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
// Offset of StateByte\r
//\r
#define PCD_STATEBYTE_HIIENABLE           0x01\r
#define PCD_STATEBYTE_SKUENABLE           0x02\r
#define PCD_STATEBYTE_VPDENABLE           0x04\r
#define PCD_STATEBYTE_SKUDATAARRAYENABLE  0x08\r
#define PCD_STATEBYTE_DATUMTYPE           0x70\r
#define PCD_STATEBYTE_EXTENDEDGUIDPRESENT 0x80\r
\r
#define PCD_DATUMTYPE_OFFSET 4\r
\r
//\r
// The definitions for interpreting DatumType\r
//\r
#define PCD_BYTE8   (0x00 << PCD_DATUMTYPE_OFFSET)\r
#define PCD_BYTE16  (0x01 << PCD_DATUMTYPE_OFFSET)\r
#define PCD_BYTE32  (0x02 << PCD_DATUMTYPE_OFFSET)\r
#define PCD_BYTE64  (0x03 << PCD_DATUMTYPE_OFFSET)\r
#define PCD_POINTER (0x04 << PCD_DATUMTYPE_OFFSET)\r
#define PCD_BOOLEAN (0x05 << PCD_DATUMTYPE_OFFSET)\r
\r
extern GUID gEfiPcdImageHobGuid;\r
\r
/* Internal Function definitions */\r
\r
VOID\r
PeiGetPcdEntryWorker (\r
  IN UINTN Token,\r
  IN CONST GUID       *Guid,  OPTIONAL\r
  IN PCD_DATA_TYPE    Type,\r
  OUT VOID            *Data\r
  );\r
\r
EFI_STATUS\r
PeiSetPcdEntryWorker (\r
  IN UINTN Token,\r
  IN CONST GUID       *Guid,  OPTIONAL\r
  IN PCD_DATA_TYPE    Type,\r
  IN VOID       *Data\r
  );\r
\r
UINTN\r
PeiGetPcdEntrySizeWorker (\r
  IN UINTN Token,\r
  IN CONST GUID       *Guid  OPTIONAL\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
EFI_STATUS\r
PeiSetSku (\r
  UINTN Id\r
);\r
\r
EFI_STATUS\r
PeiGetNextTokenWorker (\r
  IN OUT UINTN *Token,\r
  IN CONST GUID           *Guid     OPTIONAL\r
  );\r
\r
UINT8 *\r
LocatePcdImage (\r
  VOID\r
);\r
\r
VOID\r
BuildPcdDatabase (\r
  UINT8 *PcdImageOnFlash\r
  )\r
;\r
\r
\r
extern EFI_GUID gPcdImageFileGuid;\r
\r
//\r
// PPI Interface Implementation Declaration.\r
//\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetSku (\r
  IN  UINTN                  SkuId\r
  )\r
;\r
\r
\r
UINT8\r
EFIAPI\r
PeiPcdGet8 (\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
UINT16\r
EFIAPI\r
PeiPcdGet16 (\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
UINT32\r
EFIAPI\r
PeiPcdGet32 (\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
UINT64\r
EFIAPI\r
PeiPcdGet64 (\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
VOID *\r
EFIAPI\r
PeiPcdGetPtr (\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
BOOLEAN\r
EFIAPI\r
PeiPcdGetBool (\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
UINTN\r
EFIAPI\r
PeiPcdGetSize (\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
UINT8\r
EFIAPI\r
PeiPcdGet8Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
UINT16\r
EFIAPI\r
PeiPcdGet16Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
UINT32\r
EFIAPI\r
PeiPcdGet32Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
UINT64\r
EFIAPI\r
PeiPcdGet64Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
VOID *\r
EFIAPI\r
PeiPcdGetPtrEx (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
BOOLEAN\r
EFIAPI\r
PeiPcdGetBoolEx (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
UINTN\r
EFIAPI\r
PeiPcdGetSizeEx (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet8 (\r
  IN UINTN  TokenNumber,\r
  IN UINT8             Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet16 (\r
  IN UINTN  TokenNumber,\r
  IN UINT16            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet32 (\r
  IN UINTN  TokenNumber,\r
  IN UINT32            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet64 (\r
  IN UINTN  TokenNumber,\r
  IN UINT64            Value\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetPtr (\r
  IN UINTN  TokenNumber,\r
  IN CONST VOID        *Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetBool (\r
  IN UINTN  TokenNumber,\r
  IN BOOLEAN           Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet8Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber,\r
  IN UINT8             Value\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet16Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber,\r
  IN UINT16            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet32Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber,\r
  IN UINT32            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSet64Ex (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber,\r
  IN UINT64            Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetPtrEx (\r
  IN CONST EFI_GUID        *Guid,\r
  IN UINTN  TokenNumber,\r
  IN CONST VOID        *Value\r
  )\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiPcdSetBoolEx (\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
PcdRegisterCallBackOnSet (\r
  IN  UINTN        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  UINTN        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  UINTN    *TokenNumber\r
  )\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	// Offset of StateByte\r
	23	//\r
	24	#define PCD_STATEBYTE_HIIENABLE 0x01\r
	25	#define PCD_STATEBYTE_SKUENABLE 0x02\r
	26	#define PCD_STATEBYTE_VPDENABLE 0x04\r
	27	#define PCD_STATEBYTE_SKUDATAARRAYENABLE 0x08\r
	28	#define PCD_STATEBYTE_DATUMTYPE 0x70\r
	29	#define PCD_STATEBYTE_EXTENDEDGUIDPRESENT 0x80\r
	30	\r
	31	#define PCD_DATUMTYPE_OFFSET 4\r
	32	\r
	33	//\r
	34	// The definitions for interpreting DatumType\r
	35	//\r
	36	#define PCD_BYTE8 (0x00 << PCD_DATUMTYPE_OFFSET)\r
	37	#define PCD_BYTE16 (0x01 << PCD_DATUMTYPE_OFFSET)\r
	38	#define PCD_BYTE32 (0x02 << PCD_DATUMTYPE_OFFSET)\r
	39	#define PCD_BYTE64 (0x03 << PCD_DATUMTYPE_OFFSET)\r
	40	#define PCD_POINTER (0x04 << PCD_DATUMTYPE_OFFSET)\r
	41	#define PCD_BOOLEAN (0x05 << PCD_DATUMTYPE_OFFSET)\r
	42	\r
	43	extern GUID gEfiPcdImageHobGuid;\r
	44	\r
	45	/* Internal Function definitions */\r
	46	\r
	47	VOID\r
	48	PeiGetPcdEntryWorker (\r
	49	IN UINTN Token,\r
	50	IN CONST GUID *Guid, OPTIONAL\r
	51	IN PCD_DATA_TYPE Type,\r
	52	OUT VOID *Data\r
	53	);\r
	54	\r
	55	EFI_STATUS\r
	56	PeiSetPcdEntryWorker (\r
	57	IN UINTN Token,\r
	58	IN CONST GUID *Guid, OPTIONAL\r
	59	IN PCD_DATA_TYPE Type,\r
	60	IN VOID *Data\r
	61	);\r
	62	\r
	63	UINTN\r
	64	PeiGetPcdEntrySizeWorker (\r
	65	IN UINTN Token,\r
	66	IN CONST GUID *Guid OPTIONAL\r
	67	);\r
	68	\r
	69	EFI_STATUS\r
	70	PeiRegisterCallBackWorker (\r
	71	IN UINTN TokenNumber,\r
	72	IN CONST GUID *Guid, OPTIONAL\r
	73	IN PCD_PPI_CALLBACK CallBackFunction,\r
	74	IN BOOLEAN Register\r
	75	);\r
	76	\r
	77	EFI_STATUS\r
	78	PeiSetSku (\r
	79	UINTN Id\r
	80	);\r
	81	\r
	82	EFI_STATUS\r
	83	PeiGetNextTokenWorker (\r
	84	IN OUT UINTN *Token,\r
	85	IN CONST GUID *Guid OPTIONAL\r
	86	);\r
	87	\r
	88	UINT8 *\r
	89	LocatePcdImage (\r
	90	VOID\r
	91	);\r
	92	\r
	93	VOID\r
	94	BuildPcdDatabase (\r
	95	UINT8 *PcdImageOnFlash\r
	96	)\r
	97	;\r
	98	\r
	99	\r
	100	extern EFI_GUID gPcdImageFileGuid;\r
	101	\r
	102	//\r
	103	// PPI Interface Implementation Declaration.\r
	104	//\r
	105	EFI_STATUS\r
	106	EFIAPI\r
	107	PeiPcdSetSku (\r
	108	IN UINTN SkuId\r
	109	)\r
	110	;\r
	111	\r
	112	\r
	113	UINT8\r
	114	EFIAPI\r
	115	PeiPcdGet8 (\r
	116	IN UINTN TokenNumber\r
	117	)\r
	118	;\r
	119	\r
	120	\r
	121	UINT16\r
	122	EFIAPI\r
	123	PeiPcdGet16 (\r
	124	IN UINTN TokenNumber\r
	125	)\r
	126	;\r
	127	\r
	128	\r
	129	UINT32\r
	130	EFIAPI\r
	131	PeiPcdGet32 (\r
	132	IN UINTN TokenNumber\r
	133	)\r
	134	;\r
	135	\r
	136	\r
	137	UINT64\r
	138	EFIAPI\r
	139	PeiPcdGet64 (\r
	140	IN UINTN TokenNumber\r
	141	)\r
	142	;\r
	143	\r
	144	\r
	145	VOID *\r
	146	EFIAPI\r
	147	PeiPcdGetPtr (\r
	148	IN UINTN TokenNumber\r
	149	)\r
	150	;\r
	151	\r
	152	\r
	153	BOOLEAN\r
	154	EFIAPI\r
	155	PeiPcdGetBool (\r
	156	IN UINTN TokenNumber\r
	157	)\r
	158	;\r
	159	\r
	160	\r
	161	UINTN\r
	162	EFIAPI\r
	163	PeiPcdGetSize (\r
	164	IN UINTN TokenNumber\r
	165	)\r
	166	;\r
	167	\r
	168	\r
	169	UINT8\r
	170	EFIAPI\r
	171	PeiPcdGet8Ex (\r
	172	IN CONST EFI_GUID *Guid,\r
	173	IN UINTN TokenNumber\r
	174	)\r
	175	;\r
	176	\r
	177	\r
	178	UINT16\r
	179	EFIAPI\r
	180	PeiPcdGet16Ex (\r
	181	IN CONST EFI_GUID *Guid,\r
	182	IN UINTN TokenNumber\r
	183	)\r
	184	;\r
	185	\r
	186	UINT32\r
	187	EFIAPI\r
	188	PeiPcdGet32Ex (\r
	189	IN CONST EFI_GUID *Guid,\r
	190	IN UINTN TokenNumber\r
	191	)\r
	192	;\r
	193	\r
	194	\r
	195	UINT64\r
	196	EFIAPI\r
	197	PeiPcdGet64Ex (\r
	198	IN CONST EFI_GUID *Guid,\r
	199	IN UINTN TokenNumber\r
	200	)\r
	201	;\r
	202	\r
	203	\r
	204	VOID *\r
	205	EFIAPI\r
	206	PeiPcdGetPtrEx (\r
	207	IN CONST EFI_GUID *Guid,\r
	208	IN UINTN TokenNumber\r
	209	)\r
	210	;\r
	211	\r
	212	\r
	213	BOOLEAN\r
	214	EFIAPI\r
	215	PeiPcdGetBoolEx (\r
	216	IN CONST EFI_GUID *Guid,\r
	217	IN UINTN TokenNumber\r
	218	)\r
	219	;\r
	220	\r
	221	\r
	222	UINTN\r
	223	EFIAPI\r
	224	PeiPcdGetSizeEx (\r
	225	IN CONST EFI_GUID *Guid,\r
	226	IN UINTN TokenNumber\r
	227	)\r
	228	;\r
	229	\r
	230	\r
	231	EFI_STATUS\r
	232	EFIAPI\r
	233	PeiPcdSet8 (\r
	234	IN UINTN TokenNumber,\r
	235	IN UINT8 Value\r
	236	)\r
	237	;\r
	238	\r
	239	\r
	240	EFI_STATUS\r
	241	EFIAPI\r
	242	PeiPcdSet16 (\r
	243	IN UINTN TokenNumber,\r
	244	IN UINT16 Value\r
	245	)\r
	246	;\r
	247	\r
	248	\r
	249	EFI_STATUS\r
	250	EFIAPI\r
	251	PeiPcdSet32 (\r
	252	IN UINTN TokenNumber,\r
	253	IN UINT32 Value\r
	254	)\r
	255	;\r
	256	\r
	257	\r
	258	EFI_STATUS\r
	259	EFIAPI\r
	260	PeiPcdSet64 (\r
	261	IN UINTN TokenNumber,\r
	262	IN UINT64 Value\r
	263	)\r
	264	;\r
	265	\r
	266	EFI_STATUS\r
	267	EFIAPI\r
	268	PeiPcdSetPtr (\r
	269	IN UINTN TokenNumber,\r
	270	IN CONST VOID *Value\r
	271	)\r
	272	;\r
	273	\r
	274	\r
	275	EFI_STATUS\r
	276	EFIAPI\r
	277	PeiPcdSetBool (\r
	278	IN UINTN 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 UINTN 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 UINTN 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 UINTN 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 UINTN 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 UINTN TokenNumber,\r
	328	IN CONST VOID *Value\r
	329	)\r
	330	;\r
	331	\r
	332	\r
	333	EFI_STATUS\r
	334	EFIAPI\r
	335	PeiPcdSetBoolEx (\r
	336	IN CONST EFI_GUID *Guid,\r
	337	IN UINTN TokenNumber,\r
	338	IN BOOLEAN Value\r
	339	)\r
	340	;\r
	341	\r
	342	\r
	343	\r
	344	EFI_STATUS\r
	345	EFIAPI\r
	346	PcdRegisterCallBackOnSet (\r
	347	IN UINTN TokenNumber,\r
	348	IN CONST EFI_GUID *Guid, OPTIONAL\r
	349	IN PCD_PPI_CALLBACK CallBackFunction\r
	350	)\r
	351	;\r
	352	\r
	353	\r
	354	EFI_STATUS\r
	355	EFIAPI\r
	356	PcdUnRegisterCallBackOnSet (\r
	357	IN UINTN TokenNumber,\r
	358	IN CONST EFI_GUID *Guid, OPTIONAL\r
	359	IN PCD_PPI_CALLBACK CallBackFunction\r
	360	)\r
	361	;\r
	362	\r
	363	\r
	364	EFI_STATUS\r
	365	EFIAPI\r
	366	PeiPcdGetNextToken (\r
	367	IN CONST EFI_GUID *Guid, OPTIONAL\r
	368	IN OUT UINTN *TokenNumber\r
	369	)\r
	370	;\r
	371	#endif\r