2 A emptry template implementation of PCD Library.
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
22 @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
23 set values associated with a PCD token.
25 @retval SKU_ID Return the SKU ID that just be set.
40 Returns the 8-bit value for the token specified by TokenNumber.
42 @param[in] The PCD token number to retrieve a current value for.
44 @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber.
59 Returns the 16-bit value for the token specified by TokenNumber.
61 @param[in] The PCD token number to retrieve a current value for.
63 @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber.
78 Returns the 32-bit value for the token specified by TokenNumber.
80 @param[in] TokenNumber The PCD token number to retrieve a current value for.
82 @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.
97 Returns the 64-bit value for the token specified by TokenNumber.
99 @param[in] TokenNumber The PCD token number to retrieve a current value for.
101 @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.
116 Returns the pointer to the buffer of the token specified by TokenNumber.
118 @param[in] TokenNumber The PCD token number to retrieve a current value for.
120 @retval VOID* Returns the pointer to the token specified by TokenNumber.
135 Returns the Boolean value of the token specified by TokenNumber.
137 @param[in] TokenNumber The PCD token number to retrieve a current value for.
139 @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber.
154 Returns the size of the token specified by TokenNumber.
156 @param[in] TokenNumber The PCD token number to retrieve a current value for.
158 @retval UINTN Returns the size of the token specified by TokenNumber.
173 Returns the 8-bit value for the token specified by TokenNumber and Guid.
174 If Guid is NULL, then ASSERT().
176 @param[in] Guid Pointer to a 128-bit unique value that designates
177 which namespace to retrieve a value from.
178 @param[in] TokenNumber The PCD token number to retrieve a current value for.
180 @retval UINT8 Return the UINT8.
190 ASSERT (Guid
!= NULL
);
198 Returns the 16-bit value for the token specified by TokenNumber and Guid.
199 If Guid is NULL, then ASSERT().
201 @param[in] Guid Pointer to a 128-bit unique value that designates
202 which namespace to retrieve a value from.
203 @param[in] TokenNumber The PCD token number to retrieve a current value for.
205 @retval UINT16 Return the UINT16.
215 ASSERT (Guid
!= NULL
);
223 Returns the 32-bit value for the token specified by TokenNumber and Guid.
224 If Guid is NULL, then ASSERT().
226 @param[in] Guid Pointer to a 128-bit unique value that designates
227 which namespace to retrieve a value from.
228 @param[in] TokenNumber The PCD token number to retrieve a current value for.
230 @retval UINT32 Return the UINT32.
240 ASSERT (Guid
!= NULL
);
248 Returns the 64-bit value for the token specified by TokenNumber and Guid.
249 If Guid is NULL, then ASSERT().
251 @param[in] Guid Pointer to a 128-bit unique value that designates
252 which namespace to retrieve a value from.
253 @param[in] TokenNumber The PCD token number to retrieve a current value for.
255 @retval UINT64 Return the UINT64.
265 ASSERT (Guid
!= NULL
);
273 Returns the pointer to the buffer of the token specified by TokenNumber and Guid.
274 If Guid is NULL, then ASSERT().
276 @param[in] Guid Pointer to a 128-bit unique value that designates
277 which namespace to retrieve a value from.
278 @param[in] TokenNumber The PCD token number to retrieve a current value for.
280 @retval VOID* Return the VOID* pointer.
290 ASSERT (Guid
!= NULL
);
298 Returns the Boolean value of the token specified by TokenNumber and Guid.
299 If Guid is NULL, then ASSERT().
301 @param[in] Guid Pointer to a 128-bit unique value that designates
302 which namespace to retrieve a value from.
303 @param[in] TokenNumber The PCD token number to retrieve a current value for.
305 @retval BOOLEAN Return the BOOLEAN.
315 ASSERT (Guid
!= NULL
);
323 Returns the size of the token specified by TokenNumber and Guid.
324 If Guid is NULL, then ASSERT().
326 @param[in] Guid Pointer to a 128-bit unique value that designates
327 which namespace to retrieve a value from.
328 @param[in] TokenNumber The PCD token number to retrieve a current value for.
330 @retval UINTN Return the size.
340 ASSERT (Guid
!= NULL
);
348 Sets the 8-bit value for the token specified by TokenNumber
349 to the value specified by Value. Value is returned.
351 @param[in] TokenNumber The PCD token number to set a current value for.
352 @param[in] Value The 8-bit value to set.
354 @retval UINT8 Return the value been set.
360 IN UINTN TokenNumber
,
370 Sets the 16-bit value for the token specified by TokenNumber
371 to the value specified by Value. Value is returned.
373 @param[in] TokenNumber The PCD token number to set a current value for.
374 @param[in] Value The 16-bit value to set.
376 @retval UINT16 Return the value been set.
382 IN UINTN TokenNumber
,
392 Sets the 32-bit value for the token specified by TokenNumber
393 to the value specified by Value. Value is returned.
395 @param[in] TokenNumber The PCD token number to set a current value for.
396 @param[in] Value The 32-bit value to set.
398 @retval UINT32 Return the value been set.
404 IN UINTN TokenNumber
,
414 Sets the 64-bit value for the token specified by TokenNumber
415 to the value specified by Value. Value is returned.
417 @param[in] TokenNumber The PCD token number to set a current value for.
418 @param[in] Value The 64-bit value to set.
420 @retval UINT64 Return the value been set.
426 IN UINTN TokenNumber
,
436 Sets a buffer for the token specified by TokenNumber to
437 the value specified by Buffer and SizeOfValue. Buffer to
438 be set is returned. The content of the buffer could be
439 overwritten if a Callback on SET is registered with this
442 If SizeOfValue is greater than the maximum
443 size support by TokenNumber, then set SizeOfValue to the
444 maximum size supported by TokenNumber and return NULL to
445 indicate that the set operation was not actually performed.
447 If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
449 @param[in] TokenNumber The PCD token number to set a current value for.
450 @param[in,out] SizeOfBuffer The size, in bytes, of Buffer.
451 @param[in] Value A pointer to the buffer to set.
453 @retval VOID* Return the pointer for the buffer been set.
459 IN UINTN TokenNumber
,
460 IN OUT UINTN
*SizeOfBuffer
,
464 ASSERT (Buffer
!= NULL
);
472 Sets the Boolean value for the token specified by TokenNumber
473 to the value specified by Value. Value is returned.
475 @param[in] TokenNumber The PCD token number to set a current value for.
476 @param[in] Value The boolean value to set.
478 @retval BOOLEAN Return the value been set.
484 IN UINTN TokenNumber
,
494 Sets the 8-bit value for the token specified by TokenNumber and
495 Guid to the value specified by Value. Value is returned.
496 If Guid is NULL, then ASSERT().
498 @param[in] Guid Pointer to a 128-bit unique value that
499 designates which namespace to set a value from.
500 @param[in] TokenNumber The PCD token number to set a current value for.
501 @param[in] Value The 8-bit value to set.
503 @retval UINT8 Return the value been set.
510 IN UINTN TokenNumber
,
514 ASSERT (Guid
!= NULL
);
522 Sets the 16-bit value for the token specified by TokenNumber and
523 Guid to the value specified by Value. Value is returned.
524 If Guid is NULL, then ASSERT().
526 @param[in] Guid Pointer to a 128-bit unique value that
527 designates which namespace to set a value from.
528 @param[in] TokenNumber The PCD token number to set a current value for.
529 @param[in] Value The 16-bit value to set.
531 @retval UINT8 Return the value been set.
538 IN UINTN TokenNumber
,
542 ASSERT (Guid
!= NULL
);
550 Sets the 32-bit value for the token specified by TokenNumber and
551 Guid to the value specified by Value. Value is returned.
552 If Guid is NULL, then ASSERT().
554 @param[in] Guid Pointer to a 128-bit unique value that
555 designates which namespace to set a value from.
556 @param[in] TokenNumber The PCD token number to set a current value for.
557 @param[in] Value The 32-bit value to set.
559 @retval UINT32 Return the value been set.
566 IN UINTN TokenNumber
,
570 ASSERT (Guid
!= NULL
);
578 Sets the 64-bit value for the token specified by TokenNumber and
579 Guid to the value specified by Value. Value is returned.
580 If Guid is NULL, then ASSERT().
582 @param[in] Guid Pointer to a 128-bit unique value that
583 designates which namespace to set a value from.
584 @param[in] TokenNumber The PCD token number to set a current value for.
585 @param[in] Value The 64-bit value to set.
587 @retval UINT64 Return the value been set.
594 IN UINTN TokenNumber
,
598 ASSERT (Guid
!= NULL
);
606 Sets a buffer for the token specified by TokenNumber to the value specified by
607 Buffer and SizeOfValue. Buffer is returned. If SizeOfValue is greater than
608 the maximum size support by TokenNumber, then set SizeOfValue to the maximum size
609 supported by TokenNumber and return NULL to indicate that the set operation
610 was not actually performed.
612 If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
614 @param[in] Guid Pointer to a 128-bit unique value that
615 designates which namespace to set a value from.
616 @param[in] TokenNumber The PCD token number to set a current value for.
617 @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
618 @param[in] Buffer A pointer to the buffer to set.
620 @retval VOID * Return the pinter to the buffer been set.
627 IN UINTN TokenNumber
,
628 IN OUT UINTN
*SizeOfBuffer
,
632 ASSERT (Guid
!= NULL
);
633 ASSERT (Buffer
!= NULL
);
641 Sets the Boolean value for the token specified by TokenNumber and
642 Guid to the value specified by Value. Value is returned.
643 If Guid is NULL, then ASSERT().
645 @param[in] Guid Pointer to a 128-bit unique value that
646 designates which namespace to set a value from.
647 @param[in] TokenNumber The PCD token number to set a current value for.
648 @param[in] Value The Boolean value to set.
650 @retval Boolean Return the value been set.
657 IN UINTN TokenNumber
,
661 ASSERT (Guid
!= NULL
);
669 When the token specified by TokenNumber and Guid is set,
670 then notification function specified by NotificationFunction is called.
671 If Guid is NULL, then the default token space is used.
672 If NotificationFunction is NULL, then ASSERT().
674 @param[in] Guid Pointer to a 128-bit unique value that designates which
675 namespace to set a value from. If NULL, then the default
677 @param[in] TokenNumber The PCD token number to monitor.
678 @param[in] NotificationFunction The function to call when the token
679 specified by Guid and TokenNumber is set.
686 LibPcdCallbackOnSet (
687 IN CONST GUID
*Guid
, OPTIONAL
688 IN UINTN TokenNumber
,
689 IN PCD_CALLBACK NotificationFunction
692 ASSERT (NotificationFunction
!= NULL
);
698 Disable a notification function that was established with LibPcdCallbackonSet().
699 If NotificationFunction is NULL, then ASSERT().
701 @param[in] Guid Specify the GUID token space.
702 @param[in] TokenNumber Specify the token number.
703 @param[in] NotificationFunction The callback function to be unregistered.
710 LibPcdCancelCallback (
711 IN CONST GUID
*Guid
, OPTIONAL
712 IN UINTN TokenNumber
,
713 IN PCD_CALLBACK NotificationFunction
716 ASSERT (NotificationFunction
!= NULL
);
722 Retrieves the next PCD token number from the token space specified by Guid.
723 If Guid is NULL, then the default token space is used. If TokenNumber is 0,
724 then the first token number is returned. Otherwise, the token number that
725 follows TokenNumber in the token space is returned. If TokenNumber is the last
726 token number in the token space, then 0 is returned. If TokenNumber is not 0 and
727 is not in the token space specified by Guid, then ASSERT().
729 @param[in] Pointer to a 128-bit unique value that designates which namespace
730 to set a value from. If NULL, then the default token space is used.
731 @param[in] The previous PCD token number. If 0, then retrieves the first PCD
734 @retval UINTN The next valid token number.
740 IN CONST GUID
*Guid
, OPTIONAL
750 Retrieves the next PCD token space from a token space specified by Guid.
751 Guid of NULL is reserved to mark the default local token namespace on the current
752 platform. If Guid is NULL, then the GUID of the first non-local token space of the
753 current platform is returned. If Guid is the last non-local token space,
754 then NULL is returned.
756 If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
760 @param[in] Pointer to a 128-bit unique value that designates from which namespace
763 @retval CONST GUID * The next valid token namespace.
768 LibPcdGetNextTokenSpace (