2 Implementation of PcdLib class library for DXE phase.
4 Copyright (c) 2006, Intel Corporation<BR>
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.
14 Module Name: DxePcdLib.c
18 static PCD_PROTOCOL
*mPcd
;
21 The constructor function caches the PCD_PROTOCOL pointer.
23 @param[in] ImageHandle The firmware allocated handle for the EFI image.
24 @param[in] SystemTable A pointer to the EFI System Table.
26 @retval EFI_SUCCESS The constructor always return EFI_SUCCESS.
32 IN EFI_HANDLE ImageHandle
,
33 IN EFI_SYSTEM_TABLE
*SystemTable
38 Status
= gBS
->LocateProtocol (&gPcdProtocolGuid
, NULL
, (VOID
**)&mPcd
);
39 ASSERT_EFI_ERROR (Status
);
46 Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
48 @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
49 set values associated with a PCD token.
51 @retval SKU_ID Return the SKU ID that just be set.
60 ASSERT (SkuId
< 0x100);
70 Returns the 8-bit value for the token specified by TokenNumber.
72 @param[in] The PCD token number to retrieve a current value for.
74 @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber.
83 return mPcd
->Get8 (TokenNumber
);
89 Returns the 16-bit value for the token specified by TokenNumber.
91 @param[in] The PCD token number to retrieve a current value for.
93 @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber.
102 return mPcd
->Get16 (TokenNumber
);
108 Returns the 32-bit value for the token specified by TokenNumber.
110 @param[in] TokenNumber The PCD token number to retrieve a current value for.
112 @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.
121 return mPcd
->Get32 (TokenNumber
);
127 Returns the 64-bit value for the token specified by TokenNumber.
129 @param[in] TokenNumber The PCD token number to retrieve a current value for.
131 @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.
140 return mPcd
->Get64 (TokenNumber
);
146 Returns the pointer to the buffer of the token specified by TokenNumber.
148 @param[in] TokenNumber The PCD token number to retrieve a current value for.
150 @retval VOID* Returns the pointer to the token specified by TokenNumber.
159 return mPcd
->GetPtr (TokenNumber
);
165 Returns the Boolean value of the token specified by TokenNumber.
167 @param[in] TokenNumber The PCD token number to retrieve a current value for.
169 @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber.
178 return mPcd
->GetBool (TokenNumber
);
184 Returns the size of the token specified by TokenNumber.
186 @param[in] TokenNumber The PCD token number to retrieve a current value for.
188 @retval UINTN Returns the size of the token specified by TokenNumber.
197 return mPcd
->GetSize (TokenNumber
);
203 Returns the 8-bit value for the token specified by TokenNumber and Guid.
204 If Guid is NULL, then ASSERT().
206 @param[in] Guid Pointer to a 128-bit unique value that designates
207 which namespace to retrieve a value from.
208 @param[in] TokenNumber The PCD token number to retrieve a current value for.
210 @retval UINT8 Return the UINT8.
220 ASSERT (Guid
!= NULL
);
222 return mPcd
->Get8Ex (Guid
, TokenNumber
);
227 Returns the 16-bit value for the token specified by TokenNumber and Guid.
228 If Guid is NULL, then ASSERT().
230 @param[in] Guid Pointer to a 128-bit unique value that designates
231 which namespace to retrieve a value from.
232 @param[in] TokenNumber The PCD token number to retrieve a current value for.
234 @retval UINT16 Return the UINT16.
244 ASSERT (Guid
!= NULL
);
246 return mPcd
->Get16Ex (Guid
, TokenNumber
);
251 Returns the 32-bit value for the token specified by TokenNumber and Guid.
252 If Guid is NULL, then ASSERT().
254 @param[in] Guid Pointer to a 128-bit unique value that designates
255 which namespace to retrieve a value from.
256 @param[in] TokenNumber The PCD token number to retrieve a current value for.
258 @retval UINT32 Return the UINT32.
268 ASSERT (Guid
!= NULL
);
270 return mPcd
->Get32Ex (Guid
, TokenNumber
);
276 Returns the 64-bit value for the token specified by TokenNumber and Guid.
277 If Guid is NULL, then ASSERT().
279 @param[in] Guid Pointer to a 128-bit unique value that designates
280 which namespace to retrieve a value from.
281 @param[in] TokenNumber The PCD token number to retrieve a current value for.
283 @retval UINT64 Return the UINT64.
293 ASSERT (Guid
!= NULL
);
295 return mPcd
->Get64Ex (Guid
, TokenNumber
);
301 Returns the pointer to the token specified by TokenNumber and Guid.
302 If Guid is NULL, then ASSERT().
304 @param[in] Guid Pointer to a 128-bit unique value that designates
305 which namespace to retrieve a value from.
306 @param[in] TokenNumber The PCD token number to retrieve a current value for.
308 @retval VOID* Return the VOID* pointer.
318 ASSERT (Guid
!= NULL
);
320 return mPcd
->GetPtrEx (Guid
, TokenNumber
);
326 Returns the Boolean value of the token specified by TokenNumber and Guid.
327 If Guid is NULL, then ASSERT().
329 @param[in] Guid Pointer to a 128-bit unique value that designates
330 which namespace to retrieve a value from.
331 @param[in] TokenNumber The PCD token number to retrieve a current value for.
333 @retval BOOLEAN Return the BOOLEAN.
343 ASSERT (Guid
!= NULL
);
345 return mPcd
->GetBoolEx (Guid
, TokenNumber
);
351 Returns the size of the token specified by TokenNumber and Guid.
352 If Guid is NULL, then ASSERT().
354 @param[in] Guid Pointer to a 128-bit unique value that designates
355 which namespace to retrieve a value from.
356 @param[in] TokenNumber The PCD token number to retrieve a current value for.
358 @retval UINTN Return the size.
368 ASSERT (Guid
!= NULL
);
370 return mPcd
->GetSizeEx (Guid
, TokenNumber
);
376 Sets the 8-bit value for the token specified by TokenNumber
377 to the value specified by Value. Value is returned.
379 @param[in] TokenNumber The PCD token number to set a current value for.
380 @param[in] Value The 8-bit value to set.
382 @retval UINT8 Return the value been set.
388 IN UINTN TokenNumber
,
394 Status
= mPcd
->Set8 (TokenNumber
, Value
);
396 ASSERT_EFI_ERROR (Status
);
404 Sets the 16-bit value for the token specified by TokenNumber
405 to the value specified by Value. Value is returned.
407 @param[in] TokenNumber The PCD token number to set a current value for.
408 @param[in] Value The 16-bit value to set.
410 @retval UINT16 Return the value been set.
416 IN UINTN TokenNumber
,
422 Status
= mPcd
->Set16 (TokenNumber
, Value
);
424 ASSERT_EFI_ERROR (Status
);
432 Sets the 32-bit value for the token specified by TokenNumber
433 to the value specified by Value. Value is returned.
435 @param[in] TokenNumber The PCD token number to set a current value for.
436 @param[in] Value The 32-bit value to set.
438 @retval UINT32 Return the value been set.
444 IN UINTN TokenNumber
,
449 Status
= mPcd
->Set32 (TokenNumber
, Value
);
451 ASSERT_EFI_ERROR (Status
);
459 Sets the 64-bit value for the token specified by TokenNumber
460 to the value specified by Value. Value is returned.
462 @param[in] TokenNumber The PCD token number to set a current value for.
463 @param[in] Value The 64-bit value to set.
465 @retval UINT64 Return the value been set.
471 IN UINTN TokenNumber
,
477 Status
= mPcd
->Set64 (TokenNumber
, Value
);
479 ASSERT_EFI_ERROR (Status
);
487 Sets a buffer for the token specified by TokenNumber to
488 the value specified by Buffer and SizeOfValue. Buffer to
489 be set is returned. The content of the buffer could be
490 overwritten if a Callback on SET is registered with this
493 If SizeOfValue is greater than the maximum
494 size support by TokenNumber, then set SizeOfValue to the
495 maximum size supported by TokenNumber and return NULL to
496 indicate that the set operation was not actually performed.
498 If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
500 @param[in] TokenNumber The PCD token number to set a current value for.
501 @param[in,out] SizeOfBuffer The size, in bytes, of Buffer.
502 @param[in] Value A pointer to the buffer to set.
504 @retval VOID* Return the pointer for the buffer been set.
511 IN UINTN TokenNumber
,
512 IN OUT UINTN
*SizeOfBuffer
,
519 if (*SizeOfBuffer
> 0) {
520 ASSERT (Buffer
!= NULL
);
523 Size
= LibPcdGetSize (TokenNumber
);
525 if (*SizeOfBuffer
> Size
) {
526 *SizeOfBuffer
= Size
;
530 Status
= mPcd
->SetPtr (TokenNumber
, *SizeOfBuffer
, Buffer
);
532 ASSERT_EFI_ERROR (Status
);
540 Sets the Boolean value for the token specified by TokenNumber
541 to the value specified by Value. Value is returned.
543 @param[in] TokenNumber The PCD token number to set a current value for.
544 @param[in] Value The boolean value to set.
546 @retval BOOLEAN Return the value been set.
552 IN UINTN TokenNumber
,
558 Status
= mPcd
->SetBool (TokenNumber
, Value
);
560 ASSERT_EFI_ERROR (Status
);
568 Sets the 8-bit value for the token specified by TokenNumber and
569 Guid to the value specified by Value. Value is returned.
570 If Guid is NULL, then ASSERT().
572 @param[in] Guid Pointer to a 128-bit unique value that
573 designates which namespace to set a value from.
574 @param[in] TokenNumber The PCD token number to set a current value for.
575 @param[in] Value The 8-bit value to set.
577 @retval UINT8 Return the value been set.
584 IN UINTN TokenNumber
,
590 ASSERT (Guid
!= NULL
);
592 Status
= mPcd
->Set8Ex (Guid
, TokenNumber
, Value
);
594 ASSERT_EFI_ERROR (Status
);
602 Sets the 16-bit value for the token specified by TokenNumber and
603 Guid to the value specified by Value. Value is returned.
604 If Guid is NULL, then ASSERT().
606 @param[in] Guid Pointer to a 128-bit unique value that
607 designates which namespace to set a value from.
608 @param[in] TokenNumber The PCD token number to set a current value for.
609 @param[in] Value The 16-bit value to set.
611 @retval UINT8 Return the value been set.
618 IN UINTN TokenNumber
,
624 ASSERT (Guid
!= NULL
);
626 Status
= mPcd
->Set16Ex (Guid
, TokenNumber
, Value
);
628 ASSERT_EFI_ERROR (Status
);
636 Sets the 32-bit value for the token specified by TokenNumber and
637 Guid to the value specified by Value. Value is returned.
638 If Guid is NULL, then ASSERT().
640 @param[in] Guid Pointer to a 128-bit unique value that
641 designates which namespace to set a value from.
642 @param[in] TokenNumber The PCD token number to set a current value for.
643 @param[in] Value The 32-bit value to set.
645 @retval UINT32 Return the value been set.
652 IN UINTN TokenNumber
,
658 ASSERT (Guid
!= NULL
);
660 Status
= mPcd
->Set32Ex (Guid
, TokenNumber
, Value
);
662 ASSERT_EFI_ERROR (Status
);
670 Sets the 64-bit value for the token specified by TokenNumber and
671 Guid to the value specified by Value. Value is returned.
672 If Guid is NULL, then ASSERT().
674 @param[in] Guid Pointer to a 128-bit unique value that
675 designates which namespace to set a value from.
676 @param[in] TokenNumber The PCD token number to set a current value for.
677 @param[in] Value The 64-bit value to set.
679 @retval UINT64 Return the value been set.
686 IN UINTN TokenNumber
,
692 ASSERT (Guid
!= NULL
);
694 Status
= mPcd
->Set64Ex (Guid
, TokenNumber
, Value
);
696 ASSERT_EFI_ERROR (Status
);
704 Sets a buffer for the token specified by TokenNumber to the value specified by
705 Buffer and SizeOfValue. Buffer is returned. If SizeOfValue is greater than
706 the maximum size support by TokenNumber, then set SizeOfValue to the maximum size
707 supported by TokenNumber and return NULL to indicate that the set operation
708 was not actually performed.
710 If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
712 @param[in] Guid Pointer to a 128-bit unique value that
713 designates which namespace to set a value from.
714 @param[in] TokenNumber The PCD token number to set a current value for.
715 @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
716 @param[in] Buffer A pointer to the buffer to set.
718 @retval VOID * Return the pinter to the buffer been set.
725 IN UINTN TokenNumber
,
726 IN OUT UINTN
*SizeOfBuffer
,
733 ASSERT (Guid
!= NULL
);
735 ASSERT (SizeOfBuffer
!= NULL
);
737 if (*SizeOfBuffer
> 0) {
738 ASSERT (Buffer
!= NULL
);
742 Size
= LibPcdGetExSize (Guid
, TokenNumber
);
743 if (*SizeOfBuffer
> Size
) {
744 *SizeOfBuffer
= Size
;
748 Status
= mPcd
->SetPtrEx (Guid
, TokenNumber
, *SizeOfBuffer
, Buffer
);
750 ASSERT_EFI_ERROR (Status
);
758 Sets the Boolean value for the token specified by TokenNumber and
759 Guid to the value specified by Value. Value is returned.
760 If Guid is NULL, then ASSERT().
762 @param[in] Guid Pointer to a 128-bit unique value that
763 designates which namespace to set a value from.
764 @param[in] TokenNumber The PCD token number to set a current value for.
765 @param[in] Value The Boolean value to set.
767 @retval Boolean Return the value been set.
774 IN UINTN TokenNumber
,
780 ASSERT (Guid
!= NULL
);
782 Status
= mPcd
->SetBoolEx (Guid
, TokenNumber
, Value
);
784 ASSERT_EFI_ERROR (Status
);
792 When the token specified by TokenNumber and Guid is set,
793 then notification function specified by NotificationFunction is called.
794 If Guid is NULL, then the default token space is used.
795 If NotificationFunction is NULL, then ASSERT().
797 @param[in] Guid Pointer to a 128-bit unique value that designates which
798 namespace to set a value from. If NULL, then the default
800 @param[in] TokenNumber The PCD token number to monitor.
801 @param[in] NotificationFunction The function to call when the token
802 specified by Guid and TokenNumber is set.
809 LibPcdCallbackOnSet (
810 IN CONST GUID
*Guid
, OPTIONAL
811 IN UINTN TokenNumber
,
812 IN PCD_CALLBACK NotificationFunction
817 ASSERT (NotificationFunction
!= NULL
);
819 Status
= mPcd
->CallbackOnSet (TokenNumber
, Guid
, NotificationFunction
);
821 ASSERT_EFI_ERROR (Status
);
829 Disable a notification function that was established with LibPcdCallbackonSet().
830 If NotificationFunction is NULL, then ASSERT().
832 @param[in] Guid Specify the GUID token space.
833 @param[in] TokenNumber Specify the token number.
834 @param[in] NotificationFunction The callback function to be unregistered.
841 LibPcdCancelCallback (
842 IN CONST GUID
*Guid
, OPTIONAL
843 IN UINTN TokenNumber
,
844 IN PCD_CALLBACK NotificationFunction
849 ASSERT (NotificationFunction
!= NULL
);
851 Status
= mPcd
->CancelCallback (TokenNumber
, Guid
, NotificationFunction
);
853 ASSERT_EFI_ERROR (Status
);
861 Retrieves the next PCD token number from the token space specified by Guid.
862 If Guid is NULL, then the default token space is used. If TokenNumber is 0,
863 then the first token number is returned. Otherwise, the token number that
864 follows TokenNumber in the token space is returned. If TokenNumber is the last
865 token number in the token space, then 0 is returned. If TokenNumber is not 0 and
866 is not in the token space specified by Guid, then ASSERT().
868 @param[in] Pointer to a 128-bit unique value that designates which namespace
869 to set a value from. If NULL, then the default token space is used.
870 @param[in] The previous PCD token number. If 0, then retrieves the first PCD
873 @retval UINTN The next valid token number.
879 IN CONST GUID
*Guid
, OPTIONAL
885 Status
= mPcd
->GetNextToken (Guid
, &TokenNumber
);
887 ASSERT_EFI_ERROR (Status
);
895 Retrieves the next PCD token space from a token space specified by Guid.
896 Guid of NULL is reserved to mark the default local token namespace on the current
897 platform. If Guid is NULL, then the GUID of the first non-local token space of the
898 current platform is returned. If Guid is the last non-local token space,
899 then NULL is returned.
901 If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
905 @param[in] Pointer to a 128-bit unique value that designates from which namespace
908 @retval CONST GUID * The next valid token namespace.
913 LibPcdGetNextTokenSpace (
919 Status
= mPcd
->GetNextTokenSpace (&Guid
);
921 ASSERT_EFI_ERROR (Status
);
923 return (GUID
*) Guid
;