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 if (*SizeOfBuffer
> 0) {
465 ASSERT (Buffer
!= NULL
);
474 Sets the Boolean value for the token specified by TokenNumber
475 to the value specified by Value. Value is returned.
477 @param[in] TokenNumber The PCD token number to set a current value for.
478 @param[in] Value The boolean value to set.
480 @retval BOOLEAN Return the value been set.
486 IN UINTN TokenNumber
,
496 Sets the 8-bit value for the token specified by TokenNumber and
497 Guid to the value specified by Value. Value is returned.
498 If Guid is NULL, then ASSERT().
500 @param[in] Guid Pointer to a 128-bit unique value that
501 designates which namespace to set a value from.
502 @param[in] TokenNumber The PCD token number to set a current value for.
503 @param[in] Value The 8-bit value to set.
505 @retval UINT8 Return the value been set.
512 IN UINTN TokenNumber
,
516 ASSERT (Guid
!= NULL
);
524 Sets the 16-bit value for the token specified by TokenNumber and
525 Guid to the value specified by Value. Value is returned.
526 If Guid is NULL, then ASSERT().
528 @param[in] Guid Pointer to a 128-bit unique value that
529 designates which namespace to set a value from.
530 @param[in] TokenNumber The PCD token number to set a current value for.
531 @param[in] Value The 16-bit value to set.
533 @retval UINT8 Return the value been set.
540 IN UINTN TokenNumber
,
544 ASSERT (Guid
!= NULL
);
552 Sets the 32-bit value for the token specified by TokenNumber and
553 Guid to the value specified by Value. Value is returned.
554 If Guid is NULL, then ASSERT().
556 @param[in] Guid Pointer to a 128-bit unique value that
557 designates which namespace to set a value from.
558 @param[in] TokenNumber The PCD token number to set a current value for.
559 @param[in] Value The 32-bit value to set.
561 @retval UINT32 Return the value been set.
568 IN UINTN TokenNumber
,
572 ASSERT (Guid
!= NULL
);
580 Sets the 64-bit value for the token specified by TokenNumber and
581 Guid to the value specified by Value. Value is returned.
582 If Guid is NULL, then ASSERT().
584 @param[in] Guid Pointer to a 128-bit unique value that
585 designates which namespace to set a value from.
586 @param[in] TokenNumber The PCD token number to set a current value for.
587 @param[in] Value The 64-bit value to set.
589 @retval UINT64 Return the value been set.
596 IN UINTN TokenNumber
,
600 ASSERT (Guid
!= NULL
);
608 Sets a buffer for the token specified by TokenNumber to the value specified by
609 Buffer and SizeOfValue. Buffer is returned. If SizeOfValue is greater than
610 the maximum size support by TokenNumber, then set SizeOfValue to the maximum size
611 supported by TokenNumber and return NULL to indicate that the set operation
612 was not actually performed.
614 If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
616 @param[in] Guid Pointer to a 128-bit unique value that
617 designates which namespace to set a value from.
618 @param[in] TokenNumber The PCD token number to set a current value for.
619 @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
620 @param[in] Buffer A pointer to the buffer to set.
622 @retval VOID * Return the pinter to the buffer been set.
629 IN UINTN TokenNumber
,
630 IN OUT UINTN
*SizeOfBuffer
,
634 ASSERT (Guid
!= NULL
);
636 if (*SizeOfBuffer
> 0) {
637 ASSERT (Buffer
!= NULL
);
646 Sets the Boolean value for the token specified by TokenNumber and
647 Guid to the value specified by Value. Value is returned.
648 If Guid is NULL, then ASSERT().
650 @param[in] Guid Pointer to a 128-bit unique value that
651 designates which namespace to set a value from.
652 @param[in] TokenNumber The PCD token number to set a current value for.
653 @param[in] Value The Boolean value to set.
655 @retval Boolean Return the value been set.
662 IN UINTN TokenNumber
,
666 ASSERT (Guid
!= NULL
);
674 When the token specified by TokenNumber and Guid is set,
675 then notification function specified by NotificationFunction is called.
676 If Guid is NULL, then the default token space is used.
677 If NotificationFunction is NULL, then ASSERT().
679 @param[in] Guid Pointer to a 128-bit unique value that designates which
680 namespace to set a value from. If NULL, then the default
682 @param[in] TokenNumber The PCD token number to monitor.
683 @param[in] NotificationFunction The function to call when the token
684 specified by Guid and TokenNumber is set.
691 LibPcdCallbackOnSet (
692 IN CONST GUID
*Guid
, OPTIONAL
693 IN UINTN TokenNumber
,
694 IN PCD_CALLBACK NotificationFunction
697 ASSERT (NotificationFunction
!= NULL
);
703 Disable a notification function that was established with LibPcdCallbackonSet().
704 If NotificationFunction is NULL, then ASSERT().
706 @param[in] Guid Specify the GUID token space.
707 @param[in] TokenNumber Specify the token number.
708 @param[in] NotificationFunction The callback function to be unregistered.
715 LibPcdCancelCallback (
716 IN CONST GUID
*Guid
, OPTIONAL
717 IN UINTN TokenNumber
,
718 IN PCD_CALLBACK NotificationFunction
721 ASSERT (NotificationFunction
!= NULL
);
727 Retrieves the next PCD token number from the token space specified by Guid.
728 If Guid is NULL, then the default token space is used. If TokenNumber is 0,
729 then the first token number is returned. Otherwise, the token number that
730 follows TokenNumber in the token space is returned. If TokenNumber is the last
731 token number in the token space, then 0 is returned. If TokenNumber is not 0 and
732 is not in the token space specified by Guid, then ASSERT().
734 @param[in] Pointer to a 128-bit unique value that designates which namespace
735 to set a value from. If NULL, then the default token space is used.
736 @param[in] The previous PCD token number. If 0, then retrieves the first PCD
739 @retval UINTN The next valid token number.
745 IN CONST GUID
*Guid
, OPTIONAL
755 Retrieves the next PCD token space from a token space specified by Guid.
756 Guid of NULL is reserved to mark the default local token namespace on the current
757 platform. If Guid is NULL, then the GUID of the first non-local token space of the
758 current platform is returned. If Guid is the last non-local token space,
759 then NULL is returned.
761 If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
765 @param[in] Pointer to a 128-bit unique value that designates from which namespace
768 @retval CONST GUID * The next valid token namespace.
773 LibPcdGetNextTokenSpace (