2 Private functions used by PCD DXE driver.s
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.
14 Module Name: Service.c
21 // Build Tool will generate DXE_PCD_DB_INIT_VALUE in Autogen.h
22 // Compression Algorithm will take care of the size optimization.
25 PCD_DATABASE
* mPcdDatabase
;
27 LIST_ENTRY
*mCallbackFnTable
;
35 UINT32
*LocalTokenNumberTable
;
44 VARIABLE_HEAD
*VariableHead
;
50 UINT16 StringTableIdx
;
51 UINT32 LocalTokenNumber
;
54 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
55 // We have to decrement TokenNumber by 1 to make it usable
56 // as the array index.
60 ASSERT (TokenNumber
< PCD_TOTAL_TOKEN_NUMBER
);
62 Size
= DxePcdGetSize (TokenNumber
+ 1);
63 ASSERT (GetSize
== Size
|| GetSize
== 0);
66 IsPeiDb
= (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
) ? TRUE
: FALSE
;
68 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
69 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
71 SizeTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.SizeTable
:
72 mPcdDatabase
->DxeDb
.Init
.SizeTable
;
74 TokenNumber
= IsPeiDb
? TokenNumber
:
75 TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
77 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
79 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
80 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
, IsPeiDb
);
83 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
84 StringTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.StringTable
:
85 mPcdDatabase
->DxeDb
.Init
.StringTable
;
87 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
89 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
91 VpdHead
= (VPD_HEAD
*) ((UINT8
*) PcdDb
+ Offset
);
92 return (VOID
*) (UINTN
) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
95 GuidTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.GuidTable
:
96 mPcdDatabase
->DxeDb
.Init
.GuidTable
;
98 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
100 Guid
= &(GuidTable
[VariableHead
->GuidTableIndex
]);
101 Name
= &(StringTable
[VariableHead
->StringIndex
]);
103 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
104 if (Status
== EFI_SUCCESS
) {
105 ASSERT (DataSize
>= (UINTN
) (VariableHead
->Offset
+ Size
));
106 return (UINT8
*) Data
+ VariableHead
->Offset
;
109 // Return the default value specified by Platform Integrator
111 return (VOID
*) ((UINT8
*) PcdDb
+ VariableHead
->DefaultValueOffset
);
114 case PCD_TYPE_STRING
:
115 StringTableIdx
= (UINT16
) *((UINT8
*) PcdDb
+ Offset
);
116 return (VOID
*) &StringTable
[StringTableIdx
];
119 return (VOID
*) ((UINT8
*) PcdDb
+ Offset
);
137 DxeRegisterCallBackWorker (
138 IN UINTN TokenNumber
,
139 IN CONST GUID
*Guid
, OPTIONAL
140 IN PCD_PROTOCOL_CALLBACK CallBackFunction
143 CALLBACK_FN_ENTRY
*FnTableEntry
;
144 LIST_ENTRY
*ListHead
;
145 LIST_ENTRY
*ListNode
;
148 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) TokenNumber
);
152 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
153 // We have to decrement TokenNumber by 1 to make it usable
154 // as the array index.
158 ListHead
= &mCallbackFnTable
[TokenNumber
];
159 ListNode
= GetFirstNode (ListHead
);
161 while (ListNode
!= ListHead
) {
162 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
164 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
166 // We only allow a Callback function to be register once
167 // for a TokenNumber. So just return EFI_SUCCESS
171 ListNode
= GetNextNode (ListHead
, ListNode
);
174 FnTableEntry
= AllocatePool (sizeof(CALLBACK_FN_ENTRY
));
175 ASSERT (FnTableEntry
!= NULL
);
177 FnTableEntry
->CallbackFn
= CallBackFunction
;
178 InsertTailList (ListHead
, &FnTableEntry
->Node
);
187 DxeUnRegisterCallBackWorker (
188 IN UINTN TokenNumber
,
189 IN CONST GUID
*Guid
, OPTIONAL
190 IN PCD_PROTOCOL_CALLBACK CallBackFunction
193 CALLBACK_FN_ENTRY
*FnTableEntry
;
194 LIST_ENTRY
*ListHead
;
195 LIST_ENTRY
*ListNode
;
198 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) TokenNumber
);
202 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
203 // We have to decrement TokenNumber by 1 to make it usable
204 // as the array index.
208 ListHead
= &mCallbackFnTable
[TokenNumber
];
209 ListNode
= GetFirstNode (ListHead
);
211 while (ListNode
!= ListHead
) {
212 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
214 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
216 // We only allow a Callback function to be register once
217 // for a TokenNumber. So we can safely remove the Node from
218 // the Link List and return EFI_SUCCESS.
220 RemoveEntryList (ListNode
);
221 FreePool (FnTableEntry
);
225 ListNode
= GetNextNode (ListHead
, ListNode
);
228 return EFI_INVALID_PARAMETER
;
234 ExGetNextTokeNumber (
235 IN CONST EFI_GUID
*Guid
,
236 IN UINTN TokenNumber
,
237 IN EFI_GUID
*GuidTable
,
238 IN UINTN SizeOfGuidTable
,
239 IN DYNAMICEX_MAPPING
*ExMapTable
,
240 IN UINTN SizeOfExMapTable
248 MatchGuid
= ScanGuid (GuidTable
, SizeOfGuidTable
, Guid
);
249 if (MatchGuid
== NULL
) {
250 return PCD_INVALID_TOKEN_NUMBER
;
254 GuidTableIdx
= MatchGuid
- GuidTable
;
255 for (Idx
= 0; Idx
< SizeOfExMapTable
; Idx
++) {
256 if (ExMapTable
[Idx
].ExGuidIndex
== GuidTableIdx
) {
263 if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
264 return ExMapTable
[Idx
].ExTokenNumber
;
267 for ( ; Idx
< SizeOfExMapTable
; Idx
++) {
268 if (ExMapTable
[Idx
].ExTokenNumber
== TokenNumber
) {
270 if (Idx
== SizeOfExMapTable
) {
272 // Exceed the length of ExMap Table
274 return PCD_INVALID_TOKEN_NUMBER
;
275 } else if (ExMapTable
[Idx
].ExGuidIndex
== GuidTableIdx
) {
277 // Found the next match
279 return ExMapTable
[Idx
].ExTokenNumber
;
282 // Guid has been changed. It is the next Token Space Guid.
283 // We should flag no more TokenNumber.
285 return PCD_INVALID_TOKEN_NUMBER
;
291 return PCD_INVALID_TOKEN_NUMBER
;
298 BuildPcdDxeDataBase (
302 PEI_PCD_DATABASE
*PeiDatabase
;
303 EFI_HOB_GUID_TYPE
*GuidHob
;
306 mPcdDatabase
= AllocateZeroPool (sizeof(PCD_DATABASE
));
307 ASSERT (mPcdDatabase
!= NULL
);
309 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
311 if (GuidHob
!= NULL
) {
314 // We will copy over the PEI phase's PCD Database.
316 // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
317 // should not be included at all. So the GuidHob could
318 // be NULL. If it is NULL, we just copy over the DXE Default
319 // Value to PCD Database.
322 PeiDatabase
= (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
324 // Copy PCD Entries refereneced in PEI phase to PCD DATABASE
326 CopyMem (&mPcdDatabase
->PeiDb
, PeiDatabase
, sizeof (PEI_PCD_DATABASE
));
330 // Copy PCD Entries with default value to PCD DATABASE
332 CopyMem (&mPcdDatabase
->DxeDb
.Init
, &gDXEPcdDbInit
, sizeof(DXE_PCD_DATABASE_INIT
));
336 // Initialized the Callback Function Table
339 if (PCD_TOTAL_TOKEN_NUMBER
!= 0) {
340 mCallbackFnTable
= AllocateZeroPool (PCD_TOTAL_TOKEN_NUMBER
* sizeof (LIST_ENTRY
));
343 for (Idx
= 0; Idx
< PCD_TOTAL_TOKEN_NUMBER
; Idx
++) {
344 InitializeListHead (&mCallbackFnTable
[Idx
]);
354 IN EFI_GUID
*VariableGuid
,
355 IN UINT16
*VariableName
,
356 OUT VOID
** VariableData
,
357 OUT UINTN
*VariableSize
367 Status
= EfiGetVariable (
368 (UINT16
*)VariableName
,
375 if (Status
== EFI_BUFFER_TOO_SMALL
) {
377 Buffer
= AllocatePool (Size
);
379 ASSERT (Buffer
!= NULL
);
381 Status
= EfiGetVariable (
389 ASSERT (Status
== EFI_SUCCESS
);
392 *VariableData
= Buffer
;
393 *VariableSize
= Size
;
401 GetSkuEnabledTokenNumber (
402 UINT32 LocalTokenNumber
,
411 SKU_ID
*PhaseSkuIdTable
;
414 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
416 PcdDb
= IsPeiDb
? (UINT8
*) &mPcdDatabase
->PeiDb
: (UINT8
*) &mPcdDatabase
->DxeDb
;
418 SkuHead
= (SKU_HEAD
*) (PcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
419 Value
= (UINT8
*) (PcdDb
+ SkuHead
->SkuDataStartOffset
);
421 PhaseSkuIdTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.SkuIdTable
:
422 mPcdDatabase
->DxeDb
.Init
.SkuIdTable
;
424 SkuIdTable
= &PhaseSkuIdTable
[SkuHead
->SkuIdTableOffset
];
426 for (i
= 0; i
< SkuIdTable
[0]; i
++) {
427 if (mPcdDatabase
->PeiDb
.Init
.SystemSkuId
== SkuIdTable
[i
+ 1]) {
431 ASSERT (i
< SkuIdTable
[0]);
433 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
435 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[i
]);
436 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_VPD
);
439 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[i
]);
440 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_HII
);
444 return (UINT32
) (Value
- PcdDb
);
461 InvokeCallbackOnSet (
462 UINT32 ExTokenNumber
,
463 CONST EFI_GUID
*Guid
, OPTIONAL
469 CALLBACK_FN_ENTRY
*FnTableEntry
;
470 LIST_ENTRY
*ListHead
;
471 LIST_ENTRY
*ListNode
;
474 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
475 // We have to decrement TokenNumber by 1 to make it usable
476 // as the array index.
480 ListHead
= &mCallbackFnTable
[TokenNumber
];
481 ListNode
= GetFirstNode (ListHead
);
483 while (ListNode
!= ListHead
) {
484 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
486 FnTableEntry
->CallbackFn(Guid
,
487 (Guid
== NULL
) ? TokenNumber
: ExTokenNumber
,
491 ListNode
= GetNextNode (ListHead
, ListNode
);
508 UINT32
*LocalTokenNumberTable
;
510 UINT32 LocalTokenNumber
;
515 UINTN VariableOffset
;
517 VARIABLE_HEAD
*VariableHead
;
522 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
523 // We have to decrement TokenNumber by 1 to make it usable
524 // as the array index.
528 ASSERT (TokenNumber
< PCD_TOTAL_TOKEN_NUMBER
);
531 ASSERT (Size
<= DxePcdGetSize (TokenNumber
+ 1));
533 ASSERT (Size
== DxePcdGetSize (TokenNumber
+ 1));
536 IsPeiDb
= (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
) ? TRUE
: FALSE
;
538 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
539 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
541 if ((TokenNumber
< PEI_NEX_TOKEN_NUMBER
) ||
542 (TokenNumber
>= PEI_LOCAL_TOKEN_NUMBER
|| TokenNumber
< (PEI_LOCAL_TOKEN_NUMBER
+ DXE_NEX_TOKEN_NUMBER
))) {
543 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, Size
);
546 TokenNumber
= IsPeiDb
? TokenNumber
547 : TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
549 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
551 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
552 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
, IsPeiDb
);
555 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
557 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
559 StringTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.StringTable
:
560 mPcdDatabase
->DxeDb
.Init
.StringTable
;
562 InternalData
= PcdDb
+ Offset
;
564 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
567 return EFI_INVALID_PARAMETER
;
569 case PCD_TYPE_STRING
:
570 CopyMem (&StringTable
[*((UINT16
*)InternalData
)], Data
, Size
);
575 // Bug Bug: Please implement this
577 GuidTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.GuidTable
:
578 mPcdDatabase
->DxeDb
.Init
.GuidTable
;
580 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
582 Guid
= &(GuidTable
[VariableHead
->GuidTableIndex
]);
583 Name
= &(StringTable
[VariableHead
->StringIndex
]);
584 VariableOffset
= VariableHead
->Offset
;
586 return SetHiiVariable (Guid
, Name
, Data
, Size
, VariableOffset
);
590 CopyMem (InternalData
, Data
, Size
);
596 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
600 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
604 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
608 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
613 return EFI_NOT_FOUND
;
622 return EFI_NOT_FOUND
;
631 IN CONST EFI_GUID
*Guid
,
632 IN UINTN ExTokenNumber
,
636 return GetWorker(GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
), GetSize
);
645 IN UINTN ExTokenNumber
,
646 IN CONST EFI_GUID
*Guid
,
654 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
);
656 InvokeCallbackOnSet ((UINT32
) ExTokenNumber
, Guid
, TokenNumber
, Data
, SetSize
);
658 SetWorker (TokenNumber
, Data
, SetSize
, PtrType
);
669 IN EFI_GUID
*VariableGuid
,
670 IN UINT16
*VariableName
,
683 Status
= EfiGetVariable (
684 (UINT16
*)VariableName
,
691 if (Status
== EFI_BUFFER_TOO_SMALL
) {
693 Buffer
= AllocatePool (Size
);
695 ASSERT (Buffer
!= NULL
);
697 Status
= EfiGetVariable (
705 ASSERT_EFI_ERROR (Status
);
707 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
711 Attribute
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
;
712 Size
= DataSize
+ Offset
;
713 Buffer
= AllocateZeroPool (Size
);
714 ASSERT (Buffer
!= NULL
);
715 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
719 return EfiSetVariable (
734 GetExPcdTokenNumber (
735 IN CONST EFI_GUID
*Guid
,
736 IN UINT32 ExTokenNumber
740 DYNAMICEX_MAPPING
*ExMap
;
745 ExMap
= mPcdDatabase
->PeiDb
.Init
.ExMapTable
;
746 GuidTable
= mPcdDatabase
->PeiDb
.Init
.GuidTable
;
748 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->PeiDb
.Init
.GuidTable
), Guid
);
749 ASSERT (MatchGuid
!= NULL
);
751 MatchGuidIdx
= MatchGuid
- GuidTable
;
753 for (i
= 0; i
< PEI_EXMAPPING_TABLE_SIZE
; i
++) {
754 if ((ExTokenNumber
== ExMap
[i
].ExTokenNumber
) &&
755 (MatchGuidIdx
== ExMap
[i
].ExGuidIndex
)) {
756 return ExMap
[i
].LocalTokenNumber
;
761 ExMap
= mPcdDatabase
->DxeDb
.Init
.ExMapTable
;
762 GuidTable
= mPcdDatabase
->DxeDb
.Init
.GuidTable
;
764 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->DxeDb
.Init
.GuidTable
), Guid
);
765 ASSERT (MatchGuid
!= NULL
);
767 MatchGuidIdx
= MatchGuid
- GuidTable
;
769 for (i
= 0; i
< DXE_EXMAPPING_TABLE_SIZE
; i
++) {
770 if ((ExTokenNumber
== ExMap
[i
].ExTokenNumber
) &&
771 (MatchGuidIdx
== ExMap
[i
].ExGuidIndex
)) {
772 return ExMap
[i
].LocalTokenNumber
+ PEI_LOCAL_TOKEN_NUMBER
;