]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Library/BasePcdLibNull/PcdLib.c
Initial import.
[mirror_edk2.git] / MdePkg / Library / BasePcdLibNull / PcdLib.c
CommitLineData
878ddf1f 1/** @file\r
2 A emptry template implementation of PCD Library.\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 Module Name: PcdLib.c\r
14\r
15**/\r
16\r
17\r
18\r
19/**\r
20 Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.\r
21\r
22 @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and \r
23 set values associated with a PCD token.\r
24\r
25 @retval UINTN Return the SKU ID that just be set.\r
26\r
27**/\r
28UINTN\r
29EFIAPI\r
30LibPcdSetSku (\r
31 IN UINTN SkuId\r
32 )\r
33{\r
34 return SkuId;\r
35}\r
36\r
37\r
38\r
39/**\r
40 Returns the 8-bit value for the token specified by TokenNumber. \r
41\r
42 @param[in] The PCD token number to retrieve a current value for.\r
43\r
44 @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
45\r
46**/\r
47UINT8\r
48EFIAPI\r
49LibPcdGet8 (\r
50 IN UINTN TokenNumber\r
51 )\r
52{\r
53 return 0;\r
54}\r
55\r
56\r
57\r
58/**\r
59 Returns the 16-bit value for the token specified by TokenNumber. \r
60\r
61 @param[in] The PCD token number to retrieve a current value for.\r
62\r
63 @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
64\r
65**/\r
66UINT16\r
67EFIAPI\r
68LibPcdGet16 (\r
69 IN UINTN TokenNumber\r
70 )\r
71{\r
72 return 0;\r
73}\r
74\r
75\r
76\r
77/**\r
78 Returns the 32-bit value for the token specified by TokenNumber. \r
79\r
80 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
81\r
82 @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.\r
83\r
84**/\r
85UINT32\r
86EFIAPI\r
87LibPcdGet32 (\r
88 IN UINTN TokenNumber\r
89 )\r
90{\r
91 return 0;\r
92}\r
93\r
94\r
95\r
96/**\r
97 Returns the 64-bit value for the token specified by TokenNumber.\r
98\r
99 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
100\r
101 @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.\r
102\r
103**/\r
104UINT64\r
105EFIAPI\r
106LibPcdGet64 (\r
107 IN UINTN TokenNumber\r
108 )\r
109{\r
110 return 0;\r
111}\r
112\r
113\r
114\r
115/**\r
116 Returns the pointer to the buffer of the token specified by TokenNumber.\r
117\r
118 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
119\r
120 @retval VOID* Returns the pointer to the token specified by TokenNumber.\r
121\r
122**/\r
123VOID *\r
124EFIAPI\r
125LibPcdGetPtr (\r
126 IN UINTN TokenNumber\r
127 )\r
128{\r
129 return 0;\r
130}\r
131\r
132\r
133\r
134/**\r
135 Returns the Boolean value of the token specified by TokenNumber. \r
136\r
137 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
138\r
139 @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber. \r
140\r
141**/\r
142BOOLEAN \r
143EFIAPI\r
144LibPcdGetBool (\r
145 IN UINTN TokenNumber\r
146 )\r
147{\r
148 return 0;\r
149}\r
150\r
151\r
152\r
153/**\r
154 Returns the size of the token specified by TokenNumber. \r
155\r
156 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
157\r
158 @retval UINTN Returns the size of the token specified by TokenNumber. \r
159\r
160**/\r
161UINTN\r
162EFIAPI\r
163LibPcdGetSize (\r
164 IN UINTN TokenNumber\r
165 )\r
166{\r
167 return 0;\r
168}\r
169\r
170\r
171\r
172/**\r
173 Returns the 8-bit value for the token specified by TokenNumber and Guid.\r
174 If Guid is NULL, then ASSERT(). \r
175\r
176 @param[in] Guid Pointer to a 128-bit unique value that designates \r
177 which namespace to retrieve a value from.\r
178 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
179\r
180 @retval UINT8 Return the UINT8.\r
181\r
182**/\r
183UINT8\r
184EFIAPI\r
185LibPcdGetEx8 (\r
186 IN CONST GUID *Guid,\r
187 IN UINTN TokenNumber\r
188 )\r
189{\r
190 ASSERT (Guid != NULL);\r
191\r
192 return 0;\r
193}\r
194\r
195\r
196\r
197/**\r
198 Returns the 16-bit value for the token specified by TokenNumber and Guid.\r
199 If Guid is NULL, then ASSERT(). \r
200\r
201 @param[in] Guid Pointer to a 128-bit unique value that designates \r
202 which namespace to retrieve a value from.\r
203 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
204\r
205 @retval UINT16 Return the UINT16.\r
206\r
207**/\r
208UINT16\r
209EFIAPI\r
210LibPcdGetEx16 (\r
211 IN CONST GUID *Guid,\r
212 IN UINTN TokenNumber\r
213 )\r
214{\r
215 ASSERT (Guid != NULL);\r
216\r
217 return 0;\r
218}\r
219\r
220\r
221\r
222/**\r
223 Returns the 32-bit value for the token specified by TokenNumber and Guid.\r
224 If Guid is NULL, then ASSERT(). \r
225\r
226 @param[in] Guid Pointer to a 128-bit unique value that designates \r
227 which namespace to retrieve a value from.\r
228 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
229\r
230 @retval UINT32 Return the UINT32.\r
231\r
232**/\r
233UINT32\r
234EFIAPI\r
235LibPcdGetEx32 (\r
236 IN CONST GUID *Guid,\r
237 IN UINTN TokenNumber\r
238 )\r
239{\r
240 ASSERT (Guid != NULL);\r
241\r
242 return 0;\r
243}\r
244\r
245\r
246\r
247/**\r
248 Returns the 64-bit value for the token specified by TokenNumber and Guid.\r
249 If Guid is NULL, then ASSERT(). \r
250\r
251 @param[in] Guid Pointer to a 128-bit unique value that designates \r
252 which namespace to retrieve a value from.\r
253 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
254\r
255 @retval UINT64 Return the UINT64.\r
256\r
257**/\r
258UINT64\r
259EFIAPI\r
260LibPcdGetEx64 (\r
261 IN CONST GUID *Guid,\r
262 IN UINTN TokenNumber\r
263 )\r
264{\r
265 ASSERT (Guid != NULL);\r
266\r
267 return 0;\r
268}\r
269\r
270\r
271\r
272/**\r
273 Returns the pointer to the buffer of the token specified by TokenNumber and Guid.\r
274 If Guid is NULL, then ASSERT(). \r
275\r
276 @param[in] Guid Pointer to a 128-bit unique value that designates \r
277 which namespace to retrieve a value from.\r
278 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
279\r
280 @retval VOID* Return the VOID* pointer.\r
281\r
282**/\r
283VOID *\r
284EFIAPI\r
285LibPcdGetExPtr (\r
286 IN CONST GUID *Guid,\r
287 IN UINTN TokenNumber\r
288 )\r
289{\r
290 ASSERT (Guid != NULL);\r
291\r
292 return 0;\r
293}\r
294\r
295\r
296\r
297/**\r
298 Returns the Boolean value of the token specified by TokenNumber and Guid. \r
299 If Guid is NULL, then ASSERT(). \r
300\r
301 @param[in] Guid Pointer to a 128-bit unique value that designates \r
302 which namespace to retrieve a value from.\r
303 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
304\r
305 @retval BOOLEAN Return the BOOLEAN.\r
306\r
307**/\r
308BOOLEAN\r
309EFIAPI\r
310LibPcdGetExBool (\r
311 IN CONST GUID *Guid,\r
312 IN UINTN TokenNumber\r
313 )\r
314{\r
315 ASSERT (Guid != NULL);\r
316\r
317 return 0;\r
318}\r
319\r
320\r
321\r
322/**\r
323 Returns the size of the token specified by TokenNumber and Guid. \r
324 If Guid is NULL, then ASSERT(). \r
325\r
326 @param[in] Guid Pointer to a 128-bit unique value that designates \r
327 which namespace to retrieve a value from.\r
328 @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
329\r
330 @retval UINTN Return the size.\r
331\r
332**/\r
333UINTN\r
334EFIAPI\r
335LibPcdGetExSize (\r
336 IN CONST GUID *Guid,\r
337 IN UINTN TokenNumber\r
338 )\r
339{\r
340 ASSERT (Guid != NULL);\r
341\r
342 return 0;\r
343}\r
344\r
345\r
346\r
347/**\r
348 Sets the 8-bit value for the token specified by TokenNumber \r
349 to the value specified by Value. Value is returned.\r
350 \r
351 @param[in] TokenNumber The PCD token number to set a current value for.\r
352 @param[in] Value The 8-bit value to set.\r
353\r
354 @retval UINT8 Return the value been set.\r
355\r
356**/\r
357UINT8\r
358EFIAPI\r
359LibPcdSet8 (\r
360 IN UINTN TokenNumber,\r
361 IN UINT8 Value\r
362 )\r
363{\r
364 return Value;\r
365}\r
366\r
367\r
368\r
369/**\r
370 Sets the 16-bit value for the token specified by TokenNumber \r
371 to the value specified by Value. Value is returned.\r
372 \r
373 @param[in] TokenNumber The PCD token number to set a current value for.\r
374 @param[in] Value The 16-bit value to set.\r
375\r
376 @retval UINT16 Return the value been set.\r
377\r
378**/\r
379UINT16\r
380EFIAPI\r
381LibPcdSet16 (\r
382 IN UINTN TokenNumber,\r
383 IN UINT16 Value\r
384 )\r
385{\r
386 return Value;\r
387}\r
388\r
389\r
390\r
391/**\r
392 Sets the 32-bit value for the token specified by TokenNumber \r
393 to the value specified by Value. Value is returned.\r
394 \r
395 @param[in] TokenNumber The PCD token number to set a current value for.\r
396 @param[in] Value The 32-bit value to set.\r
397\r
398 @retval UINT32 Return the value been set.\r
399\r
400**/\r
401UINT32\r
402EFIAPI\r
403LibPcdSet32 (\r
404 IN UINTN TokenNumber,\r
405 IN UINT32 Value\r
406 )\r
407{\r
408 return Value;\r
409}\r
410\r
411\r
412\r
413/**\r
414 Sets the 64-bit value for the token specified by TokenNumber \r
415 to the value specified by Value. Value is returned.\r
416 \r
417 @param[in] TokenNumber The PCD token number to set a current value for.\r
418 @param[in] Value The 64-bit value to set.\r
419\r
420 @retval UINT64 Return the value been set.\r
421\r
422**/\r
423UINT64\r
424EFIAPI\r
425LibPcdSet64 (\r
426 IN UINTN TokenNumber,\r
427 IN UINT64 Value\r
428 )\r
429{\r
430 return Value;\r
431}\r
432\r
433\r
434\r
435/**\r
436 Sets a buffer for the token specified by TokenNumber to \r
437 the value specified by Value. Value is returned.\r
438 If Value is NULL, then ASSERT().\r
439 \r
440 @param[in] TokenNumber The PCD token number to set a current value for.\r
441 @param[in] Value A pointer to the buffer to set.\r
442\r
443 @retval VOID* Return the pointer for the buffer been set.\r
444\r
445**/\r
446VOID *\r
447EFIAPI\r
448LibPcdSetPtr (\r
449 IN UINTN TokenNumber,\r
450 IN CONST VOID *Value\r
451 )\r
452{\r
453 ASSERT (Value != NULL);\r
454 //\r
455 // Remove the CONST\r
456 //\r
457 return (VOID *)Value;\r
458}\r
459\r
460\r
461\r
462/**\r
463 Sets the Boolean value for the token specified by TokenNumber \r
464 to the value specified by Value. Value is returned.\r
465 \r
466 @param[in] TokenNumber The PCD token number to set a current value for.\r
467 @param[in] Value The boolean value to set.\r
468\r
469 @retval BOOLEAN Return the value been set.\r
470\r
471**/\r
472BOOLEAN\r
473EFIAPI\r
474LibPcdSetBool (\r
475 IN UINTN TokenNumber,\r
476 IN BOOLEAN Value\r
477 )\r
478{\r
479 return Value;\r
480}\r
481\r
482\r
483\r
484/**\r
485 Sets the 8-bit value for the token specified by TokenNumber and \r
486 Guid to the value specified by Value. Value is returned.\r
487 If Guid is NULL, then ASSERT().\r
488 \r
489 @param[in] Guid Pointer to a 128-bit unique value that \r
490 designates which namespace to set a value from.\r
491 @param[in] TokenNumber The PCD token number to set a current value for.\r
492 @param[in] Value The 8-bit value to set.\r
493\r
494 @retval UINT8 Return the value been set.\r
495\r
496**/\r
497UINT8\r
498EFIAPI\r
499LibPcdSetEx8 (\r
500 IN CONST GUID *Guid,\r
501 IN UINTN TokenNumber,\r
502 IN UINT8 Value\r
503 )\r
504{\r
505 ASSERT (Guid != NULL);\r
506\r
507 return Value;\r
508}\r
509\r
510\r
511\r
512/**\r
513 Sets the 16-bit value for the token specified by TokenNumber and \r
514 Guid to the value specified by Value. Value is returned.\r
515 If Guid is NULL, then ASSERT().\r
516 \r
517 @param[in] Guid Pointer to a 128-bit unique value that \r
518 designates which namespace to set a value from.\r
519 @param[in] TokenNumber The PCD token number to set a current value for.\r
520 @param[in] Value The 16-bit value to set.\r
521\r
522 @retval UINT8 Return the value been set.\r
523\r
524**/\r
525UINT16\r
526EFIAPI\r
527LibPcdSetEx16 (\r
528 IN CONST GUID *Guid,\r
529 IN UINTN TokenNumber,\r
530 IN UINT16 Value\r
531 )\r
532{\r
533 ASSERT (Guid != NULL);\r
534\r
535 return Value;\r
536}\r
537\r
538\r
539\r
540/**\r
541 Sets the 32-bit value for the token specified by TokenNumber and \r
542 Guid to the value specified by Value. Value is returned.\r
543 If Guid is NULL, then ASSERT().\r
544 \r
545 @param[in] Guid Pointer to a 128-bit unique value that \r
546 designates which namespace to set a value from.\r
547 @param[in] TokenNumber The PCD token number to set a current value for.\r
548 @param[in] Value The 32-bit value to set.\r
549\r
550 @retval UINT32 Return the value been set.\r
551\r
552**/\r
553UINT32\r
554EFIAPI\r
555LibPcdSetEx32 (\r
556 IN CONST GUID *Guid,\r
557 IN UINTN TokenNumber,\r
558 IN UINT32 Value\r
559 )\r
560{\r
561 ASSERT (Guid != NULL);\r
562\r
563 return Value;\r
564}\r
565\r
566\r
567\r
568/**\r
569 Sets the 64-bit value for the token specified by TokenNumber and \r
570 Guid to the value specified by Value. Value is returned.\r
571 If Guid is NULL, then ASSERT().\r
572 \r
573 @param[in] Guid Pointer to a 128-bit unique value that \r
574 designates which namespace to set a value from.\r
575 @param[in] TokenNumber The PCD token number to set a current value for.\r
576 @param[in] Value The 64-bit value to set.\r
577\r
578 @retval UINT64 Return the value been set.\r
579\r
580**/\r
581UINT64\r
582EFIAPI\r
583LibPcdSetEx64 (\r
584 IN CONST GUID *Guid,\r
585 IN UINTN TokenNumber,\r
586 IN UINT64 Value\r
587 )\r
588{\r
589 ASSERT (Guid != NULL);\r
590\r
591 return Value;\r
592}\r
593\r
594\r
595\r
596/**\r
597 Sets a buffer for the token specified by TokenNumber and \r
598 Guid to the value specified by Value. Value is returned.\r
599 If Guid is NULL, then ASSERT().\r
600 If Value is NULL, then ASSERT().\r
601 \r
602 @param[in] Guid Pointer to a 128-bit unique value that \r
603 designates which namespace to set a value from.\r
604 @param[in] TokenNumber The PCD token number to set a current value for.\r
605 @param[in] Value The 8-bit value to set.\r
606\r
607 @retval VOID * Return the value been set.\r
608\r
609**/\r
610VOID *\r
611EFIAPI\r
612LibPcdSetExPtr (\r
613 IN CONST GUID *Guid,\r
614 IN UINTN TokenNumber,\r
615 IN CONST VOID *Value\r
616 )\r
617{\r
618 //\r
619 // Remove the CONST\r
620 //\r
621 ASSERT (Guid != NULL);\r
622 ASSERT (Value != NULL);\r
623\r
624 return (VOID *)Value;\r
625}\r
626\r
627\r
628\r
629/**\r
630 Sets the Boolean value for the token specified by TokenNumber and \r
631 Guid to the value specified by Value. Value is returned.\r
632 If Guid is NULL, then ASSERT().\r
633 \r
634 @param[in] Guid Pointer to a 128-bit unique value that \r
635 designates which namespace to set a value from.\r
636 @param[in] TokenNumber The PCD token number to set a current value for.\r
637 @param[in] Value The Boolean value to set.\r
638\r
639 @retval Boolean Return the value been set.\r
640\r
641**/\r
642BOOLEAN\r
643EFIAPI\r
644LibPcdSetExBool (\r
645 IN CONST GUID *Guid,\r
646 IN UINTN TokenNumber,\r
647 IN BOOLEAN Value\r
648 )\r
649{\r
650 ASSERT (Guid != NULL);\r
651\r
652 return Value;\r
653}\r
654\r
655\r
656\r
657/**\r
658 When the token specified by TokenNumber and Guid is set, \r
659 then notification function specified by NotificationFunction is called. \r
660 If Guid is NULL, then the default token space is used. \r
661 If NotificationFunction is NULL, then ASSERT().\r
662\r
663 @param[in] Guid Pointer to a 128-bit unique value that designates which \r
664 namespace to set a value from. If NULL, then the default \r
665 token space is used.\r
666 @param[in] TokenNumber The PCD token number to monitor.\r
667 @param[in] NotificationFunction The function to call when the token \r
668 specified by Guid and TokenNumber is set.\r
669\r
670 @retval VOID\r
671\r
672**/\r
673VOID\r
674EFIAPI\r
675LibPcdCallbackOnSet (\r
676 IN CONST GUID *Guid, OPTIONAL\r
677 IN UINTN TokenNumber,\r
678 IN PCD_CALLBACK NotificationFunction\r
679 )\r
680{\r
681 ASSERT (NotificationFunction != NULL);\r
682}\r
683\r
684\r
685\r
686/**\r
687 Disable a notification function that was established with LibPcdCallbackonSet().\r
688 If NotificationFunction is NULL, then ASSERT().\r
689\r
690 @param[in] Guid Specify the GUID token space.\r
691 @param[in] TokenNumber Specify the token number.\r
692 @param[in] NotificationFunction The callback function to be unregistered.\r
693\r
694 @retval VOID\r
695\r
696**/\r
697VOID\r
698EFIAPI\r
699LibPcdCancelCallback (\r
700 IN CONST GUID *Guid, OPTIONAL\r
701 IN UINTN TokenNumber,\r
702 IN PCD_CALLBACK NotificationFunction\r
703 )\r
704{\r
705 ASSERT (NotificationFunction != NULL);\r
706}\r
707\r
708\r
709\r
710/**\r
711 Retrieves the next PCD token number from the token space specified by Guid. \r
712 If Guid is NULL, then the default token space is used. If TokenNumber is 0, \r
713 then the first token number is returned. Otherwise, the token number that \r
714 follows TokenNumber in the token space is returned. If TokenNumber is the last \r
715 token number in the token space, then 0 is returned. If TokenNumber is not 0 and \r
716 is not in the token space specified by Guid, then ASSERT().\r
717\r
718 @param[in] Pointer to a 128-bit unique value that designates which namespace \r
719 to set a value from. If NULL, then the default token space is used.\r
720 @param[in] The previous PCD token number. If 0, then retrieves the first PCD \r
721 token number.\r
722\r
723 @retval UINTN The next valid token number.\r
724\r
725**/\r
726UINTN\r
727EFIAPI\r
728LibPcdGetNextToken (\r
729 IN CONST GUID *Guid, OPTIONAL\r
730 IN OUT UINTN *TokenNumber\r
731 )\r
732{\r
733 return 0;\r
734}\r