2 PCD Library Class Interface Declarations
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.
21 #define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)
23 #define PcdToken(TokenName) _PCD_TOKEN_##TokenName
27 // Feature Flag is in the form of a global constant
29 #define FeaturePcdGet(TokenName) _PCD_VALUE_##TokenName
33 // Fixed is fixed at build time
35 #define FixedPcdGet8(TokenName) _PCD_VALUE_##TokenName
36 #define FixedPcdGet16(TokenName) _PCD_VALUE_##TokenName
37 #define FixedPcdGet32(TokenName) _PCD_VALUE_##TokenName
38 #define FixedPcdGet64(TokenName) _PCD_VALUE_##TokenName
39 #define FixedPcdGetBool(TokenName) _PCD_VALUE_##TokenName
43 // BugBug: This works for strings, but not constants.
45 #define FixedPcdGetPtr(TokenName) ((VOID *)_PCD_VALUE_##TokenName)
49 // (Binary) Patch is in the form of a global variable
51 #define PatchPcdGet8(TokenName) _gPcd_BinaryPatch_##TokenName
52 #define PatchPcdGet16(TokenName) _gPcd_BinaryPatch_##TokenName
53 #define PatchPcdGet32(TokenName) _gPcd_BinaryPatch_##TokenName
54 #define PatchPcdGet64(TokenName) _gPcd_BinaryPatch_##TokenName
55 #define PatchPcdGetBool(TokenName) _gPcd_BinaryPatch_##TokenName
56 #define PatchPcdGetPtr(TokenName) ((VOID *)_gPcd_BinaryPatch_##TokenName)
58 #define PatchPcdSet8(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))
59 #define PatchPcdSet16(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))
60 #define PatchPcdSet32(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))
61 #define PatchPcdSet64(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))
62 #define PatchPcdSetBool(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))
63 #define PatchPcdSetPtr(TokenName, Size, Buffer) \
64 CopyMem (_gPcd_BinaryPatch_##TokenName, (Buffer), (Size))
67 // Dynamic is via the protocol with only the TokenNumber as argument
68 // It can also be Patch or Fixed type based on a build option
70 #define PcdGet8(TokenName) _PCD_GET_MODE_8_##TokenName
71 #define PcdGet16(TokenName) _PCD_GET_MODE_16_##TokenName
72 #define PcdGet32(TokenName) _PCD_GET_MODE_32_##TokenName
73 #define PcdGet64(TokenName) _PCD_GET_MODE_64_##TokenName
74 #define PcdGetPtr(TokenName) _PCD_GET_MODE_PTR_##TokenName
75 #define PcdGetBool(TokenName) _PCD_GET_MODE_BOOL_##TokenName
80 #define PcdSet8(TokenName, Value) _PCD_SET_MODE_8_##TokenName ((Value))
81 #define PcdSet16(TokenName, Value) _PCD_SET_MODE_16_##TokenName ((Value))
82 #define PcdSet32(TokenName, Value) _PCD_SET_MODE_32_##TokenName ((Value))
83 #define PcdSet64(TokenName, Value) _PCD_SET_MODE_64_##TokenName ((Value))
84 #define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \
85 _PCD_SET_MODE_PTR_##TokenName ((SizeOfBuffer), (Buffer))
86 #define PcdSetBool(TokenName, Value) _PCD_SET_MODE_BOOL_##TokenName ((Value))
89 // Dynamic Ex is to support binary distribution
91 #define PcdGetEx8(Guid, TokenName) LibPcdGetEx8 ((Guid), _PCD_TOKEN_##TokenName)
92 #define PcdGetEx16(Guid, TokenName) LibPcdGetEx16 ((Guid), _PCD_TOKEN_##TokenName)
93 #define PcdGetEx32(Guid, TokenName) LibPcdGetEx32 ((Guid), _PCD_TOKEN_##TokenName)
94 #define PcdGetEx64(Guid, TokenName) LibPcdGetEx64 ((Guid), _PCD_TOKEN_##TokenName)
95 #define PcdGetExPtr(Guid, TokenName) LibPcdGetExPtr ((Guid), _PCD_TOKEN_##TokenName)
96 #define PcdGetExBool(Guid, TokenName) LibPcdGetExBool ((Guid), _PCD_TOKEN_##TokenName)
101 #define PcdSetEx8(Guid, TokenName, Value) LibPcdSetEx8 ((Guid), _PCD_TOKEN_##TokenName, (Value))
102 #define PcdSetEx16(Guid, TokenName, Value) LibPcdSetEx16 ((Guid), _PCD_TOKEN_##TokenName, (Value))
103 #define PcdSetEx32(Guid, TokenName, Value) LibPcdSetEx32 ((Guid), _PCD_TOKEN_##TokenName, (Value))
104 #define PcdSetEx64(Guid, TokenName, Value) LibPcdSetEx64 ((Guid), _PCD_TOKEN_##TokenName, (Value))
105 #define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer) \
106 LibPcdSetExPtr ((Guid), _PCD_TOKEN_##TokenName, (SizeOfBuffer), (Buffer))
107 #define PcdSetExBool(Guid, TokenName, Value) \
108 LibPcdSetExBool((Guid), _PCD_TOKEN_##TokenName, (Value))
112 Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
114 @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
115 set values associated with a PCD token.
117 @retval SKU_ID Return the SKU ID that just be set.
128 Returns the 8-bit value for the token specified by TokenNumber.
130 @param[in] The PCD token number to retrieve a current value for.
132 @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber.
143 Returns the 16-bit value for the token specified by TokenNumber.
145 @param[in] The PCD token number to retrieve a current value for.
147 @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber.
158 Returns the 32-bit value for the token specified by TokenNumber.
160 @param[in] TokenNumber The PCD token number to retrieve a current value for.
162 @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.
173 Returns the 64-bit value for the token specified by TokenNumber.
175 @param[in] TokenNumber The PCD token number to retrieve a current value for.
177 @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.
188 Returns the pointer to the buffer of the token specified by TokenNumber.
190 @param[in] TokenNumber The PCD token number to retrieve a current value for.
192 @retval VOID* Returns the pointer to the token specified by TokenNumber.
203 Returns the Boolean value of the token specified by TokenNumber.
205 @param[in] TokenNumber The PCD token number to retrieve a current value for.
207 @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber.
218 Returns the size of the token specified by TokenNumber.
220 @param[in] TokenNumber The PCD token number to retrieve a current value for.
222 @retval UINTN Returns the size of the token specified by TokenNumber.
233 Returns the 8-bit value for the token specified by TokenNumber and Guid.
234 If Guid is NULL, then ASSERT().
236 @param[in] Guid Pointer to a 128-bit unique value that designates
237 which namespace to retrieve a value from.
238 @param[in] TokenNumber The PCD token number to retrieve a current value for.
240 @retval UINT8 Return the UINT8.
252 Returns the 16-bit value for the token specified by TokenNumber and Guid.
253 If Guid is NULL, then ASSERT().
255 @param[in] Guid Pointer to a 128-bit unique value that designates
256 which namespace to retrieve a value from.
257 @param[in] TokenNumber The PCD token number to retrieve a current value for.
259 @retval UINT16 Return the UINT16.
271 Returns the 32-bit value for the token specified by TokenNumber and Guid.
272 If Guid is NULL, then ASSERT().
274 @param[in] Guid Pointer to a 128-bit unique value that designates
275 which namespace to retrieve a value from.
276 @param[in] TokenNumber The PCD token number to retrieve a current value for.
278 @retval UINT32 Return the UINT32.
290 Returns the 64-bit value for the token specified by TokenNumber and Guid.
291 If Guid is NULL, then ASSERT().
293 @param[in] Guid Pointer to a 128-bit unique value that designates
294 which namespace to retrieve a value from.
295 @param[in] TokenNumber The PCD token number to retrieve a current value for.
297 @retval UINT64 Return the UINT64.
309 Returns the pointer to the buffer of token specified by TokenNumber and Guid.
310 If Guid is NULL, then ASSERT().
312 @param[in] Guid Pointer to a 128-bit unique value that designates
313 which namespace to retrieve a value from.
314 @param[in] TokenNumber The PCD token number to retrieve a current value for.
316 @retval VOID* Return the VOID* pointer.
328 Returns the Boolean value of the token specified by TokenNumber and Guid.
329 If Guid is NULL, then ASSERT().
331 @param[in] Guid Pointer to a 128-bit unique value that designates
332 which namespace to retrieve a value from.
333 @param[in] TokenNumber The PCD token number to retrieve a current value for.
335 @retval BOOLEAN Return the BOOLEAN.
347 Returns the size of the token specified by TokenNumber and Guid.
348 If Guid is NULL, then ASSERT().
350 @param[in] Guid Pointer to a 128-bit unique value that designates
351 which namespace to retrieve a value from.
352 @param[in] TokenNumber The PCD token number to retrieve a current value for.
354 @retval UINTN Return the size.
366 Sets the 8-bit value for the token specified by TokenNumber
367 to the value specified by Value. Value is returned.
369 @param[in] TokenNumber The PCD token number to set a current value for.
370 @param[in] Value The 8-bit value to set.
372 @retval UINT8 Return the value been set.
378 IN UINTN TokenNumber
,
384 Sets the 16-bit value for the token specified by TokenNumber
385 to the value specified by Value. Value is returned.
387 @param[in] TokenNumber The PCD token number to set a current value for.
388 @param[in] Value The 16-bit value to set.
390 @retval UINT16 Return the value been set.
396 IN UINTN TokenNumber
,
402 Sets the 32-bit value for the token specified by TokenNumber
403 to the value specified by Value. Value is returned.
405 @param[in] TokenNumber The PCD token number to set a current value for.
406 @param[in] Value The 32-bit value to set.
408 @retval UINT32 Return the value been set.
414 IN UINTN TokenNumber
,
420 Sets the 64-bit value for the token specified by TokenNumber
421 to the value specified by Value. Value is returned.
423 @param[in] TokenNumber The PCD token number to set a current value for.
424 @param[in] Value The 64-bit value to set.
426 @retval UINT64 Return the value been set.
432 IN UINTN TokenNumber
,
438 Sets a buffer for the token specified by TokenNumber to the value
439 specified by Buffer and SizeOfValue. Buffer is returned.
440 If SizeOfValue is greater than the maximum size support by TokenNumber,
441 then set SizeOfValue to the maximum size supported by TokenNumber and
442 return NULL to indicate that the set operation was not actually performed.
444 If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to the
445 maximum size supported by TokenName and NULL must be returned.
447 If SizeOfValue is NULL, then ASSERT().
448 If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
450 @param[in] TokenNumber The PCD token number to set a current value for.
451 @param[in,out] SizeOfBuffer The size, in bytes, of Buffer.
452 @param[in] Value A pointer to the buffer to set.
454 @retval VOID* Return the pointer for the buffer been set.
460 IN UINTN TokenNumber
,
461 IN OUT UINTN
*SizeOfBuffer
,
467 Sets the Boolean value for the token specified by TokenNumber
468 to the value specified by Value. Value is returned.
470 @param[in] TokenNumber The PCD token number to set a current value for.
471 @param[in] Value The boolean value to set.
473 @retval BOOLEAN Return the value been set.
479 IN UINTN TokenNumber
,
485 Sets the 8-bit value for the token specified by TokenNumber and
486 Guid to the value specified by Value. Value is returned.
487 If Guid is NULL, then ASSERT().
489 @param[in] Guid Pointer to a 128-bit unique value that
490 designates which namespace to set a value from.
491 @param[in] TokenNumber The PCD token number to set a current value for.
492 @param[in] Value The 8-bit value to set.
494 @retval UINT8 Return the value been set.
501 IN UINTN TokenNumber
,
507 Sets the 16-bit value for the token specified by TokenNumber and
508 Guid to the value specified by Value. Value is returned.
509 If Guid is NULL, then ASSERT().
511 @param[in] Guid Pointer to a 128-bit unique value that
512 designates which namespace to set a value from.
513 @param[in] TokenNumber The PCD token number to set a current value for.
514 @param[in] Value The 16-bit value to set.
516 @retval UINT8 Return the value been set.
523 IN UINTN TokenNumber
,
529 Sets the 32-bit value for the token specified by TokenNumber and
530 Guid to the value specified by Value. Value is returned.
531 If Guid is NULL, then ASSERT().
533 @param[in] Guid Pointer to a 128-bit unique value that
534 designates which namespace to set a value from.
535 @param[in] TokenNumber The PCD token number to set a current value for.
536 @param[in] Value The 32-bit value to set.
538 @retval UINT32 Return the value been set.
545 IN UINTN TokenNumber
,
551 Sets the 64-bit value for the token specified by TokenNumber and
552 Guid to the value specified by Value. Value is returned.
553 If Guid is NULL, then ASSERT().
555 @param[in] Guid Pointer to a 128-bit unique value that
556 designates which namespace to set a value from.
557 @param[in] TokenNumber The PCD token number to set a current value for.
558 @param[in] Value The 64-bit value to set.
560 @retval UINT64 Return the value been set.
567 IN UINTN TokenNumber
,
573 Sets a buffer for the token specified by TokenNumber to the value specified by
574 Buffer and SizeOfValue. Buffer is returned. If SizeOfValue is greater than
575 the maximum size support by TokenNumber, then set SizeOfValue to the maximum size
576 supported by TokenNumber and return NULL to indicate that the set operation
577 was not actually performed.
579 If Guid is NULL, then ASSERT().
580 If SizeOfValue is NULL, then ASSERT().
581 If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
583 @param[in] Guid Pointer to a 128-bit unique value that
584 designates which namespace to set a value from.
585 @param[in] TokenNumber The PCD token number to set a current value for.
586 @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
587 @param[in] Buffer A pointer to the buffer to set.
589 @retval VOID * Return the pinter to the buffer been set.
596 IN UINTN TokenNumber
,
597 IN OUT UINTN
*SizeOfBuffer
,
603 Sets the Boolean value for the token specified by TokenNumber and
604 Guid to the value specified by Value. Value is returned.
605 If Guid is NULL, then ASSERT().
607 @param[in] Guid Pointer to a 128-bit unique value that
608 designates which namespace to set a value from.
609 @param[in] TokenNumber The PCD token number to set a current value for.
610 @param[in] Value The Boolean value to set.
612 @retval Boolean Return the value been set.
619 IN UINTN TokenNumber
,
625 When the token specified by TokenNumber and Guid is set,
626 then notification function specified by NotificationFunction is called.
627 If Guid is NULL, then the default token space is used.
628 If NotificationFunction is NULL, then ASSERT().
630 @param[in] CallBackGuid The PCD token GUID being set.
631 @param[in] CallBackToken The PCD token number being set.
632 @param[in] TokenData A pointer to the token data being set.
633 @param[in] TokenDataSize The size, in bytes, of the data being set.
640 (EFIAPI
*PCD_CALLBACK
) (
641 IN CONST GUID
*CallBackGuid
, OPTIONAL
642 IN UINTN CallBackToken
,
643 IN OUT VOID
*TokenData
,
644 IN UINTN TokenDataSize
649 When the token specified by TokenNumber and Guid is set,
650 then notification function specified by NotificationFunction is called.
651 If Guid is NULL, then the default token space is used.
652 If NotificationFunction is NULL, then ASSERT().
654 @param[in] Guid Pointer to a 128-bit unique value that designates which
655 namespace to set a value from. If NULL, then the default
657 @param[in] TokenNumber The PCD token number to monitor.
658 @param[in] NotificationFunction The function to call when the token
659 specified by Guid and TokenNumber is set.
666 LibPcdCallbackOnSet (
667 IN CONST GUID
*Guid
, OPTIONAL
668 IN UINTN TokenNumber
,
669 IN PCD_CALLBACK NotificationFunction
674 Disable a notification function that was established with LibPcdCallbackonSet().
676 @param[in] Guid Specify the GUID token space.
677 @param[in] TokenNumber Specify the token number.
678 @param[in] NotificationFunction The callback function to be unregistered.
685 LibPcdCancelCallback (
686 IN CONST GUID
*Guid
, OPTIONAL
687 IN UINTN TokenNumber
,
688 IN PCD_CALLBACK NotificationFunction
693 Retrieves the next PCD token number from the token space specified by Guid.
694 If Guid is NULL, then the default token space is used. If TokenNumber is 0,
695 then the first token number is returned. Otherwise, the token number that
696 follows TokenNumber in the token space is returned. If TokenNumber is the last
697 token number in the token space, then 0 is returned. If TokenNumber is not 0 and
698 is not in the token space specified by Guid, then ASSERT().
700 @param[in] Pointer to a 128-bit unique value that designates which namespace
701 to set a value from. If NULL, then the default token space is used.
702 @param[in] The previous PCD token number. If 0, then retrieves the first PCD
705 @retval UINTN The next valid token number.
711 IN CONST GUID
*Guid
, OPTIONAL
718 Retrieves the next PCD token space from a token space specified by Guid.
719 Guid of NULL is reserved to mark the default local token namespace on the current
720 platform. If Guid is NULL, then the GUID of the first non-local token space of the
721 current platform is returned. If Guid is the last non-local token space,
722 then NULL is returned.
724 If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
728 @param[in] Pointer to a 128-bit unique value that designates from which namespace
731 @retval CONST GUID * The next valid token namespace.
737 LibPcdGetNextTokenSpace (