]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdePkg/Library/BasePcdLibNull/PcdLib.c
removed the comment for ModuleEditor and PackageEditor in this file
[mirror_edk2.git] / MdePkg / Library / BasePcdLibNull / PcdLib.c
... / ...
CommitLineData
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 SKU_ID Return the SKU ID that just be set.\r
26\r
27**/\r
28SKU_ID\r
29EFIAPI\r
30LibPcdSetSku (\r
31 IN SKU_ID 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER 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 PCD_TOKEN_NUMBER TokenNumber,\r
450 IN UINTN SizeOfBuffer,\r
451 IN VOID *Buffer\r
452 )\r
453{\r
454 ASSERT (Buffer != NULL);\r
455\r
456 return Buffer;\r
457}\r
458\r
459\r
460\r
461/**\r
462 Sets the Boolean value for the token specified by TokenNumber \r
463 to the value specified by Value. Value is returned.\r
464 \r
465 @param[in] TokenNumber The PCD token number to set a current value for.\r
466 @param[in] Value The boolean value to set.\r
467\r
468 @retval BOOLEAN Return the value been set.\r
469\r
470**/\r
471BOOLEAN\r
472EFIAPI\r
473LibPcdSetBool (\r
474 IN PCD_TOKEN_NUMBER TokenNumber,\r
475 IN BOOLEAN Value\r
476 )\r
477{\r
478 return Value;\r
479}\r
480\r
481\r
482\r
483/**\r
484 Sets the 8-bit value for the token specified by TokenNumber and \r
485 Guid to the value specified by Value. Value is returned.\r
486 If Guid is NULL, then ASSERT().\r
487 \r
488 @param[in] Guid Pointer to a 128-bit unique value that \r
489 designates which namespace to set a value from.\r
490 @param[in] TokenNumber The PCD token number to set a current value for.\r
491 @param[in] Value The 8-bit value to set.\r
492\r
493 @retval UINT8 Return the value been set.\r
494\r
495**/\r
496UINT8\r
497EFIAPI\r
498LibPcdSetEx8 (\r
499 IN CONST GUID *Guid,\r
500 IN PCD_TOKEN_NUMBER TokenNumber,\r
501 IN UINT8 Value\r
502 )\r
503{\r
504 ASSERT (Guid != NULL);\r
505\r
506 return Value;\r
507}\r
508\r
509\r
510\r
511/**\r
512 Sets the 16-bit value for the token specified by TokenNumber and \r
513 Guid to the value specified by Value. Value is returned.\r
514 If Guid is NULL, then ASSERT().\r
515 \r
516 @param[in] Guid Pointer to a 128-bit unique value that \r
517 designates which namespace to set a value from.\r
518 @param[in] TokenNumber The PCD token number to set a current value for.\r
519 @param[in] Value The 16-bit value to set.\r
520\r
521 @retval UINT8 Return the value been set.\r
522\r
523**/\r
524UINT16\r
525EFIAPI\r
526LibPcdSetEx16 (\r
527 IN CONST GUID *Guid,\r
528 IN PCD_TOKEN_NUMBER TokenNumber,\r
529 IN UINT16 Value\r
530 )\r
531{\r
532 ASSERT (Guid != NULL);\r
533\r
534 return Value;\r
535}\r
536\r
537\r
538\r
539/**\r
540 Sets the 32-bit value for the token specified by TokenNumber and \r
541 Guid to the value specified by Value. Value is returned.\r
542 If Guid is NULL, then ASSERT().\r
543 \r
544 @param[in] Guid Pointer to a 128-bit unique value that \r
545 designates which namespace to set a value from.\r
546 @param[in] TokenNumber The PCD token number to set a current value for.\r
547 @param[in] Value The 32-bit value to set.\r
548\r
549 @retval UINT32 Return the value been set.\r
550\r
551**/\r
552UINT32\r
553EFIAPI\r
554LibPcdSetEx32 (\r
555 IN CONST GUID *Guid,\r
556 IN PCD_TOKEN_NUMBER TokenNumber,\r
557 IN UINT32 Value\r
558 )\r
559{\r
560 ASSERT (Guid != NULL);\r
561\r
562 return Value;\r
563}\r
564\r
565\r
566\r
567/**\r
568 Sets the 64-bit value for the token specified by TokenNumber and \r
569 Guid to the value specified by Value. Value is returned.\r
570 If Guid is NULL, then ASSERT().\r
571 \r
572 @param[in] Guid Pointer to a 128-bit unique value that \r
573 designates which namespace to set a value from.\r
574 @param[in] TokenNumber The PCD token number to set a current value for.\r
575 @param[in] Value The 64-bit value to set.\r
576\r
577 @retval UINT64 Return the value been set.\r
578\r
579**/\r
580UINT64\r
581EFIAPI\r
582LibPcdSetEx64 (\r
583 IN CONST GUID *Guid,\r
584 IN PCD_TOKEN_NUMBER TokenNumber,\r
585 IN UINT64 Value\r
586 )\r
587{\r
588 ASSERT (Guid != NULL);\r
589\r
590 return Value;\r
591}\r
592\r
593\r
594\r
595/**\r
596 Sets a buffer for the token specified by TokenNumber and \r
597 Guid to the value specified by Value. Value is returned.\r
598 If Guid is NULL, then ASSERT().\r
599 If Value is NULL, then ASSERT().\r
600 \r
601 @param[in] Guid Pointer to a 128-bit unique value that \r
602 designates which namespace to set a value from.\r
603 @param[in] TokenNumber The PCD token number to set a current value for.\r
604 @param[in] Value The 8-bit value to set.\r
605\r
606 @retval VOID * Return the value been set.\r
607\r
608**/\r
609VOID *\r
610EFIAPI\r
611LibPcdSetExPtr (\r
612 IN CONST GUID *Guid,\r
613 IN PCD_TOKEN_NUMBER TokenNumber,\r
614 IN UINTN SizeOfBuffer,\r
615 IN VOID *Buffer\r
616 )\r
617{\r
618 ASSERT (Guid != NULL);\r
619 ASSERT (Buffer != NULL);\r
620\r
621 return Buffer;\r
622}\r
623\r
624\r
625\r
626/**\r
627 Sets the Boolean value for the token specified by TokenNumber and \r
628 Guid to the value specified by Value. Value is returned.\r
629 If Guid is NULL, then ASSERT().\r
630 \r
631 @param[in] Guid Pointer to a 128-bit unique value that \r
632 designates which namespace to set a value from.\r
633 @param[in] TokenNumber The PCD token number to set a current value for.\r
634 @param[in] Value The Boolean value to set.\r
635\r
636 @retval Boolean Return the value been set.\r
637\r
638**/\r
639BOOLEAN\r
640EFIAPI\r
641LibPcdSetExBool (\r
642 IN CONST GUID *Guid,\r
643 IN PCD_TOKEN_NUMBER TokenNumber,\r
644 IN BOOLEAN Value\r
645 )\r
646{\r
647 ASSERT (Guid != NULL);\r
648\r
649 return Value;\r
650}\r
651\r
652\r
653\r
654/**\r
655 When the token specified by TokenNumber and Guid is set, \r
656 then notification function specified by NotificationFunction is called. \r
657 If Guid is NULL, then the default token space is used. \r
658 If NotificationFunction is NULL, then ASSERT().\r
659\r
660 @param[in] Guid Pointer to a 128-bit unique value that designates which \r
661 namespace to set a value from. If NULL, then the default \r
662 token space is used.\r
663 @param[in] TokenNumber The PCD token number to monitor.\r
664 @param[in] NotificationFunction The function to call when the token \r
665 specified by Guid and TokenNumber is set.\r
666\r
667 @retval VOID\r
668\r
669**/\r
670VOID\r
671EFIAPI\r
672LibPcdCallbackOnSet (\r
673 IN CONST GUID *Guid, OPTIONAL\r
674 IN PCD_TOKEN_NUMBER TokenNumber,\r
675 IN PCD_CALLBACK NotificationFunction\r
676 )\r
677{\r
678 ASSERT (NotificationFunction != NULL);\r
679}\r
680\r
681\r
682\r
683/**\r
684 Disable a notification function that was established with LibPcdCallbackonSet().\r
685 If NotificationFunction is NULL, then ASSERT().\r
686\r
687 @param[in] Guid Specify the GUID token space.\r
688 @param[in] TokenNumber Specify the token number.\r
689 @param[in] NotificationFunction The callback function to be unregistered.\r
690\r
691 @retval VOID\r
692\r
693**/\r
694VOID\r
695EFIAPI\r
696LibPcdCancelCallback (\r
697 IN CONST GUID *Guid, OPTIONAL\r
698 IN PCD_TOKEN_NUMBER TokenNumber,\r
699 IN PCD_CALLBACK NotificationFunction\r
700 )\r
701{\r
702 ASSERT (NotificationFunction != NULL);\r
703}\r
704\r
705\r
706\r
707/**\r
708 Retrieves the next PCD token number from the token space specified by Guid. \r
709 If Guid is NULL, then the default token space is used. If TokenNumber is 0, \r
710 then the first token number is returned. Otherwise, the token number that \r
711 follows TokenNumber in the token space is returned. If TokenNumber is the last \r
712 token number in the token space, then 0 is returned. If TokenNumber is not 0 and \r
713 is not in the token space specified by Guid, then ASSERT().\r
714\r
715 @param[in] Pointer to a 128-bit unique value that designates which namespace \r
716 to set a value from. If NULL, then the default token space is used.\r
717 @param[in] The previous PCD token number. If 0, then retrieves the first PCD \r
718 token number.\r
719\r
720 @retval PCD_TOKEN_NUMBER The next valid token number.\r
721\r
722**/\r
723PCD_TOKEN_NUMBER\r
724EFIAPI\r
725LibPcdGetNextToken (\r
726 IN CONST GUID *Guid, OPTIONAL\r
727 IN OUT PCD_TOKEN_NUMBER TokenNumber\r
728 )\r
729{\r
730 return 0;\r
731}\r