878ddf1f |
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 |
4acf8ce7 |
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 |
58f1099f |
25 | #define PCD_PEI_SERVICE_DRIVER_VERSION 2\r |
4acf8ce7 |
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 |
878ddf1f |
35 | //\r |
36 | // PPI Interface Implementation Declaration.\r |
37 | //\r |
00b7af13 |
38 | VOID\r |
878ddf1f |
39 | EFIAPI\r |
40 | PeiPcdSetSku (\r |
8a43e8dd |
41 | IN UINTN SkuId\r |
878ddf1f |
42 | )\r |
43 | ;\r |
44 | \r |
45 | \r |
46 | UINT8\r |
47 | EFIAPI\r |
48 | PeiPcdGet8 (\r |
8a43e8dd |
49 | IN UINTN TokenNumber\r |
878ddf1f |
50 | )\r |
51 | ;\r |
52 | \r |
53 | \r |
54 | UINT16\r |
55 | EFIAPI\r |
56 | PeiPcdGet16 (\r |
8a43e8dd |
57 | IN UINTN TokenNumber\r |
878ddf1f |
58 | )\r |
59 | ;\r |
60 | \r |
61 | \r |
62 | UINT32\r |
63 | EFIAPI\r |
64 | PeiPcdGet32 (\r |
8a43e8dd |
65 | IN UINTN TokenNumber\r |
878ddf1f |
66 | )\r |
67 | ;\r |
68 | \r |
69 | \r |
70 | UINT64\r |
71 | EFIAPI\r |
72 | PeiPcdGet64 (\r |
8a43e8dd |
73 | IN UINTN TokenNumber\r |
878ddf1f |
74 | )\r |
75 | ;\r |
76 | \r |
77 | \r |
78 | VOID *\r |
79 | EFIAPI\r |
80 | PeiPcdGetPtr (\r |
8a43e8dd |
81 | IN UINTN TokenNumber\r |
878ddf1f |
82 | )\r |
83 | ;\r |
84 | \r |
85 | \r |
86 | BOOLEAN\r |
87 | EFIAPI\r |
88 | PeiPcdGetBool (\r |
8a43e8dd |
89 | IN UINTN TokenNumber\r |
878ddf1f |
90 | )\r |
91 | ;\r |
92 | \r |
93 | \r |
94 | UINTN\r |
95 | EFIAPI\r |
96 | PeiPcdGetSize (\r |
8a43e8dd |
97 | IN UINTN TokenNumber\r |
878ddf1f |
98 | )\r |
99 | ;\r |
100 | \r |
101 | \r |
102 | UINT8\r |
103 | EFIAPI\r |
104 | PeiPcdGet8Ex (\r |
00b7af13 |
105 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
106 | IN UINTN TokenNumber\r |
878ddf1f |
107 | )\r |
108 | ;\r |
109 | \r |
110 | \r |
111 | UINT16\r |
112 | EFIAPI\r |
113 | PeiPcdGet16Ex (\r |
00b7af13 |
114 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
115 | IN UINTN TokenNumber\r |
878ddf1f |
116 | )\r |
117 | ;\r |
118 | \r |
119 | UINT32\r |
120 | EFIAPI\r |
121 | PeiPcdGet32Ex (\r |
00b7af13 |
122 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
123 | IN UINTN TokenNumber\r |
878ddf1f |
124 | )\r |
125 | ;\r |
126 | \r |
127 | \r |
128 | UINT64\r |
129 | EFIAPI\r |
130 | PeiPcdGet64Ex (\r |
00b7af13 |
131 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
132 | IN UINTN TokenNumber\r |
878ddf1f |
133 | )\r |
134 | ;\r |
135 | \r |
136 | \r |
137 | VOID *\r |
138 | EFIAPI\r |
139 | PeiPcdGetPtrEx (\r |
00b7af13 |
140 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
141 | IN UINTN TokenNumber\r |
878ddf1f |
142 | )\r |
143 | ;\r |
144 | \r |
145 | \r |
146 | BOOLEAN\r |
147 | EFIAPI\r |
148 | PeiPcdGetBoolEx (\r |
00b7af13 |
149 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
150 | IN UINTN TokenNumber\r |
878ddf1f |
151 | )\r |
152 | ;\r |
153 | \r |
154 | \r |
155 | UINTN\r |
156 | EFIAPI\r |
157 | PeiPcdGetSizeEx (\r |
00b7af13 |
158 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
159 | IN UINTN TokenNumber\r |
878ddf1f |
160 | )\r |
161 | ;\r |
162 | \r |
163 | \r |
164 | EFI_STATUS\r |
165 | EFIAPI\r |
166 | PeiPcdSet8 (\r |
8a43e8dd |
167 | IN UINTN TokenNumber,\r |
878ddf1f |
168 | IN UINT8 Value\r |
169 | )\r |
170 | ;\r |
171 | \r |
172 | \r |
173 | EFI_STATUS\r |
174 | EFIAPI\r |
175 | PeiPcdSet16 (\r |
8a43e8dd |
176 | IN UINTN TokenNumber,\r |
878ddf1f |
177 | IN UINT16 Value\r |
178 | )\r |
179 | ;\r |
180 | \r |
181 | \r |
182 | EFI_STATUS\r |
183 | EFIAPI\r |
184 | PeiPcdSet32 (\r |
8a43e8dd |
185 | IN UINTN TokenNumber,\r |
878ddf1f |
186 | IN UINT32 Value\r |
187 | )\r |
188 | ;\r |
189 | \r |
190 | \r |
191 | EFI_STATUS\r |
192 | EFIAPI\r |
193 | PeiPcdSet64 (\r |
8a43e8dd |
194 | IN UINTN TokenNumber,\r |
878ddf1f |
195 | IN UINT64 Value\r |
196 | )\r |
197 | ;\r |
198 | \r |
199 | EFI_STATUS\r |
200 | EFIAPI\r |
201 | PeiPcdSetPtr (\r |
1de04b4f |
202 | IN UINTN TokenNumber,\r |
203 | IN OUT UINTN *SizeOfBuffer,\r |
204 | IN VOID *Buffer\r |
878ddf1f |
205 | )\r |
206 | ;\r |
207 | \r |
208 | \r |
209 | EFI_STATUS\r |
210 | EFIAPI\r |
211 | PeiPcdSetBool (\r |
8a43e8dd |
212 | IN UINTN TokenNumber,\r |
878ddf1f |
213 | IN BOOLEAN Value\r |
214 | )\r |
215 | ;\r |
216 | \r |
217 | \r |
218 | EFI_STATUS\r |
219 | EFIAPI\r |
220 | PeiPcdSet8Ex (\r |
00b7af13 |
221 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
222 | IN UINTN TokenNumber,\r |
878ddf1f |
223 | IN UINT8 Value\r |
224 | )\r |
225 | ;\r |
226 | \r |
227 | EFI_STATUS\r |
228 | EFIAPI\r |
229 | PeiPcdSet16Ex (\r |
00b7af13 |
230 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
231 | IN UINTN TokenNumber,\r |
878ddf1f |
232 | IN UINT16 Value\r |
233 | )\r |
234 | ;\r |
235 | \r |
236 | \r |
237 | EFI_STATUS\r |
238 | EFIAPI\r |
239 | PeiPcdSet32Ex (\r |
00b7af13 |
240 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
241 | IN UINTN TokenNumber,\r |
878ddf1f |
242 | IN UINT32 Value\r |
243 | )\r |
244 | ;\r |
245 | \r |
246 | \r |
247 | EFI_STATUS\r |
248 | EFIAPI\r |
249 | PeiPcdSet64Ex (\r |
00b7af13 |
250 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
251 | IN UINTN TokenNumber,\r |
878ddf1f |
252 | IN UINT64 Value\r |
253 | )\r |
254 | ;\r |
255 | \r |
256 | \r |
257 | EFI_STATUS\r |
258 | EFIAPI\r |
259 | PeiPcdSetPtrEx (\r |
1de04b4f |
260 | IN CONST EFI_GUID *Guid,\r |
261 | IN UINTN TokenNumber,\r |
262 | IN OUT UINTN *SizeOfBuffer,\r |
263 | IN VOID *Buffer\r |
878ddf1f |
264 | )\r |
265 | ;\r |
266 | \r |
267 | \r |
268 | EFI_STATUS\r |
269 | EFIAPI\r |
270 | PeiPcdSetBoolEx (\r |
00b7af13 |
271 | IN CONST EFI_GUID *Guid,\r |
8a43e8dd |
272 | IN UINTN TokenNumber,\r |
878ddf1f |
273 | IN BOOLEAN Value\r |
274 | )\r |
275 | ;\r |
276 | \r |
277 | \r |
278 | \r |
279 | EFI_STATUS\r |
280 | EFIAPI\r |
4c114006 |
281 | PeiRegisterCallBackOnSet (\r |
00b7af13 |
282 | IN CONST EFI_GUID *Guid, OPTIONAL\r |
2a870f53 |
283 | IN UINTN TokenNumber,\r |
00b7af13 |
284 | IN PCD_PPI_CALLBACK CallBackFunction\r |
878ddf1f |
285 | )\r |
286 | ;\r |
287 | \r |
288 | \r |
289 | EFI_STATUS\r |
290 | EFIAPI\r |
291 | PcdUnRegisterCallBackOnSet (\r |
00b7af13 |
292 | IN CONST EFI_GUID *Guid, OPTIONAL\r |
2a870f53 |
293 | IN UINTN TokenNumber,\r |
00b7af13 |
294 | IN PCD_PPI_CALLBACK CallBackFunction\r |
878ddf1f |
295 | )\r |
296 | ;\r |
297 | \r |
298 | \r |
299 | EFI_STATUS\r |
300 | EFIAPI\r |
301 | PeiPcdGetNextToken (\r |
00b7af13 |
302 | IN CONST EFI_GUID *Guid, OPTIONAL\r |
8a43e8dd |
303 | IN OUT UINTN *TokenNumber\r |
878ddf1f |
304 | )\r |
305 | ;\r |
52e1905d |
306 | \r |
4276d5da |
307 | \r |
308 | EFI_STATUS\r |
309 | EFIAPI\r |
310 | PeiPcdGetNextTokenSpace (\r |
311 | IN CONST EFI_GUID **Guid\r |
312 | )\r |
313 | ;\r |
314 | \r |
c24ba2f6 |
315 | \r |
316 | /* Internal Function definitions */\r |
317 | \r |
318 | PEI_PCD_DATABASE *\r |
319 | GetPcdDatabase (\r |
320 | VOID\r |
321 | )\r |
322 | ;\r |
323 | \r |
324 | \r |
325 | EFI_STATUS\r |
326 | SetValueWorker (\r |
327 | IN UINTN TokenNumber,\r |
328 | IN VOID *Data,\r |
329 | IN UINTN Size\r |
330 | )\r |
331 | ;\r |
332 | \r |
333 | \r |
334 | EFI_STATUS\r |
335 | SetWorker (\r |
336 | IN UINTN TokenNumber,\r |
337 | IN VOID *Data,\r |
338 | IN OUT UINTN *Size,\r |
339 | IN BOOLEAN PtrType\r |
340 | )\r |
341 | ;\r |
342 | \r |
343 | \r |
344 | EFI_STATUS\r |
345 | ExSetValueWorker (\r |
346 | IN UINTN ExTokenNumber,\r |
347 | IN CONST EFI_GUID *Guid,\r |
348 | IN VOID *Data,\r |
349 | IN UINTN Size\r |
350 | )\r |
351 | ;\r |
352 | \r |
353 | \r |
354 | \r |
355 | EFI_STATUS\r |
356 | ExSetWorker (\r |
357 | IN UINTN ExTokenNumber,\r |
358 | IN CONST EFI_GUID *Guid,\r |
359 | IN VOID *Data,\r |
360 | IN OUT UINTN *Size,\r |
361 | IN BOOLEAN PtrType\r |
362 | )\r |
363 | ;\r |
364 | \r |
365 | \r |
366 | \r |
367 | VOID *\r |
368 | GetWorker (\r |
369 | IN UINTN TokenNumber,\r |
370 | IN UINTN GetSize\r |
371 | )\r |
372 | ;\r |
373 | \r |
374 | \r |
375 | \r |
376 | VOID *\r |
377 | ExGetWorker (\r |
378 | IN CONST EFI_GUID *Guid,\r |
379 | IN UINTN ExTokenNumber,\r |
380 | IN UINTN GetSize\r |
381 | )\r |
382 | ;\r |
383 | \r |
384 | typedef struct {\r |
385 | UINTN TokenNumber;\r |
386 | UINTN Size;\r |
387 | UINT32 LocalTokenNumberAlias;\r |
388 | } EX_PCD_ENTRY_ATTRIBUTE;\r |
389 | \r |
390 | \r |
391 | UINTN \r |
392 | GetExPcdTokenNumber (\r |
393 | IN CONST EFI_GUID *Guid,\r |
394 | IN UINTN ExTokenNumber\r |
395 | )\r |
396 | ;\r |
397 | \r |
398 | \r |
399 | \r |
400 | \r |
401 | EFI_STATUS\r |
402 | PeiRegisterCallBackWorker (\r |
403 | IN UINTN TokenNumber,\r |
404 | IN CONST GUID *Guid, OPTIONAL\r |
405 | IN PCD_PPI_CALLBACK CallBackFunction,\r |
406 | IN BOOLEAN Register\r |
407 | );\r |
408 | \r |
409 | \r |
410 | \r |
411 | \r |
412 | VOID\r |
413 | BuildPcdDatabase (\r |
414 | VOID\r |
415 | )\r |
416 | ;\r |
417 | \r |
418 | \r |
419 | \r |
420 | \r |
421 | UINTN\r |
422 | GetPtrTypeSize (\r |
423 | IN UINTN LocalTokenNumberTableIdx,\r |
424 | OUT UINTN *MaxSize,\r |
425 | IN PEI_PCD_DATABASE *Database\r |
426 | )\r |
427 | ;\r |
428 | \r |
429 | \r |
430 | \r |
431 | BOOLEAN\r |
432 | SetPtrTypeSize (\r |
433 | IN UINTN LocalTokenNumberTableIdx,\r |
434 | IN OUT UINTN *CurrentSize,\r |
435 | IN PEI_PCD_DATABASE *Database\r |
436 | )\r |
437 | ;\r |
438 | \r |
439 | \r |
52e1905d |
440 | extern EFI_GUID gPcdDataBaseHobGuid;\r |
441 | \r |
442 | extern EFI_GUID gPcdPeiCallbackFnTableHobGuid;\r |
443 | \r |
444 | extern PEI_PCD_DATABASE_INIT gPEIPcdDbInit;\r |
445 | \r |
878ddf1f |
446 | #endif\r |