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 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
*) (UINTN
) (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 UINTN 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
, (UINT32
) 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 UINTN 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
, (UINT32
) 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 UINTN 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
314 if (PCD_TOTAL_TOKEN_NUMBER
!= 0) {
315 mCallbackFnTable
= AllocateZeroPool (PCD_TOTAL_TOKEN_NUMBER
* sizeof (LIST_ENTRY
));
318 for (Idx
= 0; Idx
< PCD_TOTAL_TOKEN_NUMBER
; Idx
++) {
319 InitializeListHead (&mCallbackFnTable
[Idx
]);
329 IN EFI_GUID
*VariableGuid
,
330 IN UINT16
*VariableName
,
331 OUT VOID
** VariableData
,
332 OUT UINTN
*VariableSize
339 Status
= EfiGetVariable (
340 (UINT16
*)VariableName
,
346 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
348 Buffer
= AllocatePool (Size
);
350 ASSERT (Buffer
!= NULL
);
352 Status
= EfiGetVariable (
366 GetSkuEnabledTokenNumber (
367 UINT32 LocalTokenNumber
,
376 SKU_ID
*PhaseSkuIdTable
;
379 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
381 PcdDb
= IsPeiDb
? (UINT8
*) &mPcdDatabase
->PeiDb
: (UINT8
*) &mPcdDatabase
->DxeDb
;
383 SkuHead
= (SKU_HEAD
*) (PcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
384 Value
= (UINT8
*) (PcdDb
+ SkuHead
->SkuDataStartOffset
);
386 PhaseSkuIdTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.SkuIdTable
:
387 mPcdDatabase
->DxeDb
.Init
.SkuIdTable
;
389 SkuIdTable
= &PhaseSkuIdTable
[SkuHead
->SkuIdTableOffset
];
391 for (i
= 0; i
< SkuIdTable
[0]; i
++) {
392 if (mPcdDatabase
->PeiDb
.Init
.SystemSkuId
== SkuIdTable
[i
+ 1]) {
396 ASSERT (i
< SkuIdTable
[0]);
398 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
400 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[i
]);
401 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_VPD
);
404 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[i
]);
405 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_HII
);
409 return (UINT32
) (Value
- PcdDb
);
426 InvokeCallbackOnSet (
427 UINT32 ExTokenNumber
,
428 CONST EFI_GUID
*Guid
, OPTIONAL
434 CALLBACK_FN_ENTRY
*FnTableEntry
;
435 LIST_ENTRY
*ListHead
;
436 LIST_ENTRY
*ListNode
;
438 ListHead
= &mCallbackFnTable
[TokenNumber
];
439 ListNode
= GetFirstNode (ListHead
);
441 while (ListNode
!= ListHead
) {
442 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
444 FnTableEntry
->CallbackFn(Guid
,
445 (Guid
== NULL
) ? TokenNumber
: ExTokenNumber
,
449 ListNode
= GetNextNode (ListHead
, ListNode
);
466 UINT32
*LocalTokenNumberTable
;
468 UINT32 LocalTokenNumber
;
474 VARIABLE_HEAD
*VariableHead
;
479 ASSERT (TokenNumber
< PCD_TOTAL_TOKEN_NUMBER
);
482 ASSERT (Size
<= DxePcdGetSize (TokenNumber
));
484 ASSERT (Size
== DxePcdGetSize (TokenNumber
));
487 IsPeiDb
= (TokenNumber
<= PEI_LOCAL_TOKEN_NUMBER
) ? TRUE
: FALSE
;
489 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
490 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
492 if ((TokenNumber
< PEI_NEX_TOKEN_NUMBER
) ||
493 (TokenNumber
>= PEI_LOCAL_TOKEN_NUMBER
|| TokenNumber
< (PEI_LOCAL_TOKEN_NUMBER
+ DXE_NEX_TOKEN_NUMBER
))) {
494 InvokeCallbackOnSet (0, NULL
, TokenNumber
, Data
, Size
);
497 TokenNumber
= IsPeiDb
? TokenNumber
498 : TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
500 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
502 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
503 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
, IsPeiDb
);
506 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
508 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
510 StringTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.StringTable
:
511 mPcdDatabase
->DxeDb
.Init
.StringTable
;
513 InternalData
= PcdDb
+ Offset
;
515 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
518 return EFI_INVALID_PARAMETER
;
520 case PCD_TYPE_STRING
:
521 CopyMem (&StringTable
[*((UINT16
*)InternalData
)], Data
, Size
);
526 // Bug Bug: Please implement this
528 GuidTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.GuidTable
:
529 mPcdDatabase
->DxeDb
.Init
.GuidTable
;
531 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
533 Guid
= &(GuidTable
[VariableHead
->GuidTableIndex
]);
534 Name
= &(StringTable
[VariableHead
->StringIndex
]);
540 CopyMem (InternalData
, Data
, Size
);
546 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
550 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
554 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
558 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
563 return EFI_NOT_FOUND
;
572 return EFI_NOT_FOUND
;
581 IN CONST EFI_GUID
*Guid
,
582 IN UINTN ExTokenNumber
,
586 return GetWorker(GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
), GetSize
);
595 IN UINTN ExTokenNumber
,
596 IN CONST EFI_GUID
*Guid
,
604 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
);
606 InvokeCallbackOnSet ((UINT32
) ExTokenNumber
, Guid
, TokenNumber
, Data
, SetSize
);
608 SetWorker (TokenNumber
, Data
, SetSize
, PtrType
);
619 IN EFI_GUID
*VariableGuid
,
620 IN UINT16
*VariableName
,
633 Status
= EfiGetVariable (
634 (UINT16
*)VariableName
,
641 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
643 Buffer
= AllocatePool (Size
);
645 ASSERT (Buffer
!= NULL
);
647 Status
= EfiGetVariable (
656 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
658 return EfiSetVariable (
673 GetExPcdTokenNumber (
674 IN CONST EFI_GUID
*Guid
,
675 IN UINT32 ExTokenNumber
679 DYNAMICEX_MAPPING
*ExMap
;
684 ExMap
= mPcdDatabase
->PeiDb
.Init
.ExMapTable
;
685 GuidTable
= mPcdDatabase
->PeiDb
.Init
.GuidTable
;
687 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->PeiDb
.Init
.GuidTable
), Guid
);
688 ASSERT (MatchGuid
!= NULL
);
690 MatchGuidIdx
= MatchGuid
- GuidTable
;
692 for (i
= 0; i
< PEI_EXMAPPING_TABLE_SIZE
; i
++) {
693 if ((ExTokenNumber
== ExMap
[i
].ExTokenNumber
) &&
694 (MatchGuidIdx
== ExMap
[i
].ExGuidIndex
)) {
695 return ExMap
[i
].LocalTokenNumber
;
700 ExMap
= mPcdDatabase
->DxeDb
.Init
.ExMapTable
;
701 GuidTable
= mPcdDatabase
->DxeDb
.Init
.GuidTable
;
703 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->DxeDb
.Init
.GuidTable
), Guid
);
704 ASSERT (MatchGuid
!= NULL
);
706 MatchGuidIdx
= MatchGuid
- GuidTable
;
708 for (i
= 0; i
< DXE_EXMAPPING_TABLE_SIZE
; i
++) {
709 if ((ExTokenNumber
== ExMap
[i
].ExTokenNumber
) &&
710 (MatchGuidIdx
== ExMap
[i
].ExGuidIndex
)) {
711 return ExMap
[i
].LocalTokenNumber
+ PEI_LOCAL_TOKEN_NUMBER
;