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
[PCD_TOTAL_TOKEN_NUMBER
];
31 PCD_TOKEN_NUMBER TokenNumber
,
35 UINT32
*LocalTokenNumberTable
;
44 VARIABLE_HEAD
*VariableHead
;
50 UINT16 StringTableIdx
;
51 UINT32 LocalTokenNumber
;
54 ASSERT (TokenNumber
< PCD_TOTAL_TOKEN_NUMBER
);
56 Size
= DxePcdGetSize (TokenNumber
);
57 ASSERT (GetSize
== Size
|| GetSize
== 0);
60 IsPeiDb
= (TokenNumber
<= PEI_LOCAL_TOKEN_NUMBER
) ? TRUE
: FALSE
;
62 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
63 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
65 SizeTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.SizeTable
:
66 mPcdDatabase
->DxeDb
.Init
.SizeTable
;
68 TokenNumber
= IsPeiDb
? TokenNumber
:
69 TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
71 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
73 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
74 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
, IsPeiDb
);
77 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
78 StringTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.StringTable
:
79 mPcdDatabase
->DxeDb
.Init
.StringTable
;
81 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
83 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
85 VpdHead
= (VPD_HEAD
*) ((UINT8
*) PcdDb
+ Offset
);
86 return (VOID
*) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
89 GuidTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.GuidTable
:
90 mPcdDatabase
->DxeDb
.Init
.GuidTable
;
92 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
94 Guid
= &(GuidTable
[VariableHead
->GuidTableIndex
]);
95 Name
= &(StringTable
[VariableHead
->StringIndex
]);
97 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
98 ASSERT_EFI_ERROR (Status
);
99 ASSERT (DataSize
>= (UINTN
) (VariableHead
->Offset
+ Size
));
101 return (UINT8
*) Data
+ VariableHead
->Offset
;
103 case PCD_TYPE_STRING
:
104 StringTableIdx
= (UINT16
) *((UINT8
*) PcdDb
+ Offset
);
105 return (VOID
*) &StringTable
[StringTableIdx
];
108 return (VOID
*) ((UINT8
*) PcdDb
+ Offset
);
126 DxeRegisterCallBackWorker (
127 IN PCD_TOKEN_NUMBER TokenNumber
,
128 IN CONST GUID
*Guid
, OPTIONAL
129 IN PCD_PROTOCOL_CALLBACK CallBackFunction
132 CALLBACK_FN_ENTRY
*FnTableEntry
;
133 LIST_ENTRY
*ListHead
;
134 LIST_ENTRY
*ListNode
;
137 TokenNumber
= GetExPcdTokenNumber (Guid
, TokenNumber
);
140 ListHead
= &mCallbackFnTable
[TokenNumber
];
141 ListNode
= GetFirstNode (ListHead
);
143 while (ListNode
!= ListHead
) {
144 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
146 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
148 // We only allow a Callback function to be register once
149 // for a TokenNumber. So just return EFI_SUCCESS
153 ListNode
= GetNextNode (ListHead
, ListNode
);
156 FnTableEntry
= AllocatePool (sizeof(CALLBACK_FN_ENTRY
));
157 ASSERT (FnTableEntry
!= NULL
);
159 FnTableEntry
->CallbackFn
= CallBackFunction
;
160 InsertTailList (ListHead
, &FnTableEntry
->Node
);
169 DxeUnRegisterCallBackWorker (
170 IN PCD_TOKEN_NUMBER TokenNumber
,
171 IN CONST GUID
*Guid
, OPTIONAL
172 IN PCD_PROTOCOL_CALLBACK CallBackFunction
175 CALLBACK_FN_ENTRY
*FnTableEntry
;
176 LIST_ENTRY
*ListHead
;
177 LIST_ENTRY
*ListNode
;
180 TokenNumber
= GetExPcdTokenNumber (Guid
, TokenNumber
);
183 ListHead
= &mCallbackFnTable
[TokenNumber
];
184 ListNode
= GetFirstNode (ListHead
);
186 while (ListNode
!= ListHead
) {
187 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
189 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
191 // We only allow a Callback function to be register once
192 // for a TokenNumber. So we can safely remove the Node from
193 // the Link List and return EFI_SUCCESS.
195 RemoveEntryList (ListNode
);
196 FreePool (FnTableEntry
);
200 ListNode
= GetNextNode (ListHead
, ListNode
);
203 return EFI_INVALID_PARAMETER
;
209 ExGetNextTokeNumber (
210 IN CONST EFI_GUID
*Guid
,
211 IN PCD_TOKEN_NUMBER TokenNumber
,
212 IN EFI_GUID
*GuidTable
,
213 IN UINTN SizeOfGuidTable
,
214 IN DYNAMICEX_MAPPING
*ExMapTable
,
215 IN UINTN SizeOfExMapTable
223 MatchGuid
= ScanGuid (GuidTable
, SizeOfGuidTable
, Guid
);
224 if (MatchGuid
== NULL
) {
225 return PCD_INVALID_TOKEN_NUMBER
;
229 GuidTableIdx
= MatchGuid
- GuidTable
;
230 for (Idx
= 0; Idx
< SizeOfExMapTable
; Idx
++) {
231 if (ExMapTable
[Idx
].ExGuidIndex
== GuidTableIdx
) {
238 if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
239 return ExMapTable
[Idx
].ExTokenNumber
;
242 for ( ; Idx
< SizeOfExMapTable
; Idx
++) {
243 if (ExMapTable
[Idx
].ExTokenNumber
== TokenNumber
) {
245 if (Idx
== SizeOfExMapTable
) {
247 // Exceed the length of ExMap Table
249 return PCD_INVALID_TOKEN_NUMBER
;
250 } else if (ExMapTable
[Idx
].ExGuidIndex
== GuidTableIdx
) {
252 // Found the next match
254 return ExMapTable
[Idx
].ExTokenNumber
;
257 // Guid has been changed. It is the next Token Space Guid.
258 // We should flag no more TokenNumber.
260 return PCD_INVALID_TOKEN_NUMBER
;
266 return PCD_INVALID_TOKEN_NUMBER
;
273 BuildPcdDxeDataBase (
277 PEI_PCD_DATABASE
*PeiDatabase
;
278 EFI_HOB_GUID_TYPE
*GuidHob
;
281 mPcdDatabase
= AllocateZeroPool (sizeof(PCD_DATABASE
));
282 ASSERT (mPcdDatabase
!= NULL
);
284 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
286 if (GuidHob
!= NULL
) {
289 // We will copy over the PEI phase's PCD Database.
291 // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
292 // should not be included at all. So the GuidHob could
293 // be NULL. If it is NULL, we just copy over the DXE Default
294 // Value to PCD Database.
297 PeiDatabase
= (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
299 // Copy PCD Entries refereneced in PEI phase to PCD DATABASE
301 CopyMem (&mPcdDatabase
->PeiDb
, PeiDatabase
, sizeof (PEI_PCD_DATABASE
));
305 // Copy PCD Entries with default value to PCD DATABASE
307 CopyMem (&mPcdDatabase
->DxeDb
.Init
, &gDXEPcdDbInit
, sizeof(DXE_PCD_DATABASE_INIT
));
311 // Initialized the Callback Function Table
313 for (Idx
= 0; Idx
< PCD_TOTAL_TOKEN_NUMBER
; Idx
++) {
314 InitializeListHead (&mCallbackFnTable
[Idx
]);
324 IN EFI_GUID
*VariableGuid
,
325 IN UINT16
*VariableName
,
326 OUT VOID
** VariableData
,
327 OUT UINTN
*VariableSize
334 Status
= EfiGetVariable (
335 (UINT16
*)VariableName
,
341 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
343 Buffer
= AllocatePool (Size
);
345 ASSERT (Buffer
!= NULL
);
347 Status
= EfiGetVariable (
361 GetSkuEnabledTokenNumber (
362 UINT32 LocalTokenNumber
,
371 SKU_ID
*PhaseSkuIdTable
;
374 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
376 PcdDb
= IsPeiDb
? (UINT8
*) &mPcdDatabase
->PeiDb
: (UINT8
*) &mPcdDatabase
->DxeDb
;
378 SkuHead
= (SKU_HEAD
*) (PcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
379 Value
= (UINT8
*) (PcdDb
+ SkuHead
->SkuDataStartOffset
);
381 PhaseSkuIdTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.SkuIdTable
:
382 mPcdDatabase
->DxeDb
.Init
.SkuIdTable
;
384 SkuIdTable
= &PhaseSkuIdTable
[SkuHead
->SkuIdTableOffset
];
386 for (i
= 0; i
< SkuIdTable
[0]; i
++) {
387 if (mPcdDatabase
->PeiDb
.Init
.SystemSkuId
== SkuIdTable
[i
+ 1]) {
391 ASSERT (i
< SkuIdTable
[0]);
393 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
395 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[i
]);
396 return ((Value
- PcdDb
) | PCD_TYPE_VPD
);
399 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[i
]);
400 return ((Value
- PcdDb
) | PCD_TYPE_HII
);
404 return (Value
- PcdDb
);
421 InvokeCallbackOnSet (
422 UINT32 ExTokenNumber
,
423 CONST EFI_GUID
*Guid
, OPTIONAL
429 CALLBACK_FN_ENTRY
*FnTableEntry
;
430 LIST_ENTRY
*ListHead
;
431 LIST_ENTRY
*ListNode
;
433 ListHead
= &mCallbackFnTable
[TokenNumber
];
434 ListNode
= GetFirstNode (ListHead
);
436 while (ListNode
!= ListHead
) {
437 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
439 FnTableEntry
->CallbackFn(Guid
,
440 (Guid
== NULL
) ? TokenNumber
: ExTokenNumber
,
444 ListNode
= GetNextNode (ListHead
, ListNode
);
455 PCD_TOKEN_NUMBER TokenNumber
,
461 UINT32
*LocalTokenNumberTable
;
463 UINT32 LocalTokenNumber
;
469 VARIABLE_HEAD
*VariableHead
;
474 ASSERT (TokenNumber
< PCD_TOTAL_TOKEN_NUMBER
);
477 ASSERT (Size
<= DxePcdGetSize (TokenNumber
));
479 ASSERT (Size
== DxePcdGetSize (TokenNumber
));
482 IsPeiDb
= (TokenNumber
<= PEI_LOCAL_TOKEN_NUMBER
) ? TRUE
: FALSE
;
484 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
485 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
487 if ((TokenNumber
< PEI_NEX_TOKEN_NUMBER
) ||
488 (TokenNumber
>= PEI_LOCAL_TOKEN_NUMBER
|| TokenNumber
< (PEI_LOCAL_TOKEN_NUMBER
+ DXE_NEX_TOKEN_NUMBER
))) {
489 InvokeCallbackOnSet (0, NULL
, TokenNumber
, Data
, Size
);
492 TokenNumber
= IsPeiDb
? TokenNumber
493 : TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
495 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
497 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
498 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
, IsPeiDb
);
501 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
503 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
505 StringTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.StringTable
:
506 mPcdDatabase
->DxeDb
.Init
.StringTable
;
508 InternalData
= PcdDb
+ Offset
;
510 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
513 return EFI_INVALID_PARAMETER
;
515 case PCD_TYPE_STRING
:
516 CopyMem (&StringTable
[*((UINT16
*)InternalData
)], Data
, Size
);
521 // Bug Bug: Please implement this
523 GuidTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.GuidTable
:
524 mPcdDatabase
->DxeDb
.Init
.GuidTable
;
526 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
528 Guid
= &(GuidTable
[VariableHead
->GuidTableIndex
]);
529 Name
= &(StringTable
[VariableHead
->StringIndex
]);
535 CopyMem (InternalData
, Data
, Size
);
541 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
545 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
549 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
553 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
558 return EFI_NOT_FOUND
;
567 return EFI_NOT_FOUND
;
576 IN CONST EFI_GUID
*Guid
,
577 IN UINTN ExTokenNumber
,
581 return GetWorker(GetExPcdTokenNumber (Guid
, ExTokenNumber
), GetSize
);
590 IN PCD_TOKEN_NUMBER ExTokenNumber
,
591 IN CONST EFI_GUID
*Guid
,
597 PCD_TOKEN_NUMBER TokenNumber
;
599 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
601 InvokeCallbackOnSet (ExTokenNumber
, Guid
, TokenNumber
, Data
, SetSize
);
603 SetWorker (TokenNumber
, Data
, SetSize
, PtrType
);
614 IN EFI_GUID
*VariableGuid
,
615 IN UINT16
*VariableName
,
628 Status
= EfiGetVariable (
629 (UINT16
*)VariableName
,
636 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
638 Buffer
= AllocatePool (Size
);
640 ASSERT (Buffer
!= NULL
);
642 Status
= EfiGetVariable (
651 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
653 return EfiSetVariable (
668 GetExPcdTokenNumber (
669 IN CONST EFI_GUID
*Guid
,
670 IN PCD_TOKEN_NUMBER ExTokenNumber
674 DYNAMICEX_MAPPING
*ExMap
;
679 ExMap
= mPcdDatabase
->PeiDb
.Init
.ExMapTable
;
680 GuidTable
= mPcdDatabase
->PeiDb
.Init
.GuidTable
;
682 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->PeiDb
.Init
.GuidTable
), Guid
);
683 ASSERT (MatchGuid
!= NULL
);
685 MatchGuidIdx
= MatchGuid
- GuidTable
;
687 for (i
= 0; i
< PEI_EXMAPPING_TABLE_SIZE
; i
++) {
688 if ((ExTokenNumber
== ExMap
[i
].ExTokenNumber
) &&
689 (MatchGuidIdx
== ExMap
[i
].ExGuidIndex
)) {
690 return ExMap
[i
].LocalTokenNumber
;
695 ExMap
= mPcdDatabase
->DxeDb
.Init
.ExMapTable
;
696 GuidTable
= mPcdDatabase
->DxeDb
.Init
.GuidTable
;
698 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->DxeDb
.Init
.GuidTable
), Guid
);
699 ASSERT (MatchGuid
!= NULL
);
701 MatchGuidIdx
= MatchGuid
- GuidTable
;
703 for (i
= 0; i
< DXE_EXMAPPING_TABLE_SIZE
; i
++) {
704 if ((ExTokenNumber
== ExMap
[i
].ExTokenNumber
) &&
705 (MatchGuidIdx
== ExMap
[i
].ExGuidIndex
)) {
706 return ExMap
[i
].LocalTokenNumber
+ PEI_LOCAL_TOKEN_NUMBER
;