git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9078 6f19259b-4bc3-4df7-8a09-765794883524
		
			
				
	
	
		
			1403 lines
		
	
	
		
			41 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			1403 lines
		
	
	
		
			41 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /** @file
 | |
|     Help functions used by PCD DXE driver.
 | |
| 
 | |
| Copyright (c) 2006 - 2007, Intel Corporation
 | |
| All rights reserved. This program and the accompanying materials
 | |
| are licensed and made available under the terms and conditions of the BSD License
 | |
| which accompanies this distribution.  The full text of the license may be found at
 | |
| http://opensource.org/licenses/bsd-license.php
 | |
| 
 | |
| THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 | |
| WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 | |
| 
 | |
| **/
 | |
| 
 | |
| #include "Service.h"
 | |
| 
 | |
| PCD_DATABASE * mPcdDatabase;
 | |
| 
 | |
| LIST_ENTRY *mCallbackFnTable;
 | |
| 
 | |
| /**
 | |
|   Get the PCD entry pointer in PCD database.
 | |
|   
 | |
|   This routine will visit PCD database to find the PCD entry according to given
 | |
|   token number. The given token number is autogened by build tools and it will be 
 | |
|   translated to local token number. Local token number contains PCD's type and 
 | |
|   offset of PCD entry in PCD database.
 | |
| 
 | |
|   @param TokenNumber     Token's number, it is autogened by build tools
 | |
|   @param GetSize         The size of token's value
 | |
| 
 | |
|   @return PCD entry pointer in PCD database
 | |
| 
 | |
| **/
 | |
| VOID *
 | |
| GetWorker (
 | |
|   IN UINTN             TokenNumber,
 | |
|   IN UINTN             GetSize
 | |
|   )
 | |
| {
 | |
|   UINT32              *LocalTokenNumberTable;
 | |
|   EFI_GUID            *GuidTable;
 | |
|   UINT8               *StringTable;
 | |
|   EFI_GUID            *Guid;
 | |
|   UINT16              *Name;
 | |
|   VARIABLE_HEAD       *VariableHead;
 | |
|   UINT8               *VaraiableDefaultBuffer;
 | |
|   UINT8               *Data;
 | |
|   VPD_HEAD            *VpdHead;
 | |
|   UINT8               *PcdDb;
 | |
|   VOID                *RetPtr;
 | |
|   UINTN               MaxSize;
 | |
|   UINTN               TmpTokenNumber;
 | |
|   UINTN               DataSize;
 | |
|   EFI_STATUS          Status;
 | |
|   UINT32              LocalTokenNumber;
 | |
|   UINT32              Offset;
 | |
|   UINT16              StringTableIdx;      
 | |
|   BOOLEAN             IsPeiDb;
 | |
| 
 | |
|   //
 | |
|   // Aquire lock to prevent reentrance from TPL_CALLBACK level
 | |
|   //
 | |
|   EfiAcquireLock (&mPcdDatabaseLock);
 | |
| 
 | |
|   RetPtr = NULL;
 | |
|   //
 | |
|   // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
 | |
|   // We have to decrement TokenNumber by 1 to make it usable
 | |
|   // as the array index.
 | |
|   //
 | |
|   TokenNumber--;
 | |
| 
 | |
|   TmpTokenNumber = TokenNumber;
 | |
|   
 | |
|   //
 | |
|   // PCD_TOTAL_TOKEN_NUMBER is a auto-generated constant.
 | |
|   // It could be zero. EBC compiler is very choosy. It may
 | |
|   // report warning. So we add 1 in each size of the 
 | |
|   // comparison.
 | |
|   //
 | |
|   ASSERT (TokenNumber + 1 < PCD_TOTAL_TOKEN_NUMBER + 1);
 | |
| 
 | |
|   ASSERT ((GetSize == DxePcdGetSize (TokenNumber + 1)) || (GetSize == 0));
 | |
| 
 | |
|   // EBC compiler is very choosy. It may report warning about comparison
 | |
|   // between UINTN and 0 . So we add 1 in each size of the 
 | |
|   // comparison.
 | |
|   IsPeiDb = (BOOLEAN) ((TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1) ? TRUE : FALSE);
 | |
| 
 | |
|   LocalTokenNumberTable  = IsPeiDb ? mPcdDatabase->PeiDb.Init.LocalTokenNumberTable : 
 | |
|                                      mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;
 | |
| 
 | |
|   TokenNumber            = IsPeiDb ? TokenNumber :
 | |
|                                      TokenNumber - PEI_LOCAL_TOKEN_NUMBER;
 | |
| 
 | |
|   LocalTokenNumber = LocalTokenNumberTable[TokenNumber];
 | |
|   
 | |
|   if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {
 | |
|     if (GetSize == 0) {
 | |
|       GetPtrTypeSize (TmpTokenNumber, &MaxSize);
 | |
|     } else {
 | |
|       MaxSize = GetSize;
 | |
|     }
 | |
|     LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, MaxSize, IsPeiDb);
 | |
|   }
 | |
| 
 | |
|   PcdDb = IsPeiDb ? ((UINT8 *) &mPcdDatabase->PeiDb) : ((UINT8 *) &mPcdDatabase->DxeDb);
 | |
|                                     
 | |
|   if (IsPeiDb) {
 | |
|     StringTable = (UINT8 *) (&mPcdDatabase->PeiDb.Init.StringTable[0]);
 | |
|   } else {
 | |
|     StringTable = (UINT8 *) (&mPcdDatabase->DxeDb.Init.StringTable[0]);
 | |
|   }
 | |
|                                       
 | |
|   
 | |
|   Offset     = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
 | |
|   
 | |
|   switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
 | |
|     case PCD_TYPE_VPD:
 | |
|       VpdHead = (VPD_HEAD *) ((UINT8 *) PcdDb + Offset);
 | |
|       RetPtr = (VOID *) (UINTN) (FixedPcdGet32(PcdVpdBaseAddress) + VpdHead->Offset);
 | |
|       break;
 | |
|       
 | |
|     case PCD_TYPE_HII:
 | |
|       if (IsPeiDb) {
 | |
|         GuidTable = (EFI_GUID *) (&mPcdDatabase->PeiDb.Init.GuidTable[0]);
 | |
|       } else {
 | |
|         GuidTable = (EFI_GUID *) (&mPcdDatabase->DxeDb.Init.GuidTable[0]);
 | |
|       }
 | |
|                               
 | |
|       VariableHead = (VARIABLE_HEAD *) (PcdDb + Offset);
 | |
|       
 | |
|       Guid = GuidTable + VariableHead->GuidTableIndex;
 | |
|       Name = (UINT16*)(StringTable + VariableHead->StringIndex);
 | |
|       VaraiableDefaultBuffer = (UINT8 *) PcdDb + VariableHead->DefaultValueOffset;
 | |
| 
 | |
|       Status = GetHiiVariable (Guid, Name, &Data, &DataSize);
 | |
|       if (Status == EFI_SUCCESS) {
 | |
|         if (GetSize == 0) {
 | |
|           //
 | |
|           // It is a pointer type. So get the MaxSize reserved for
 | |
|           // this PCD entry.
 | |
|           //
 | |
|           GetPtrTypeSize (TmpTokenNumber, &GetSize);
 | |
|         }
 | |
|         CopyMem (VaraiableDefaultBuffer, Data + VariableHead->Offset, GetSize);
 | |
|         FreePool (Data);
 | |
|       }
 | |
|       //
 | |
|       // If the operation is successful, we copy the data
 | |
|       // to the default value buffer in the PCD Database.
 | |
|       // So that we can free the Data allocated in GetHiiVariable.
 | |
|       //
 | |
|       //
 | |
|       // If the operation is not successful, 
 | |
|       // Return 1) either the default value specified by Platform Integrator 
 | |
|       //        2) Or the value Set by a PCD set operation.
 | |
|       //
 | |
|       RetPtr = (VOID *) VaraiableDefaultBuffer;
 | |
|       break;
 | |
| 
 | |
|     case PCD_TYPE_STRING:
 | |
|       StringTableIdx = *(UINT16*)((UINT8 *) PcdDb + Offset);
 | |
|       RetPtr = (VOID *) (StringTable + StringTableIdx);
 | |
|       break;
 | |
| 
 | |
|     case PCD_TYPE_DATA:
 | |
|       RetPtr = (VOID *) ((UINT8 *) PcdDb + Offset);
 | |
|       break;
 | |
| 
 | |
|     default:
 | |
|       ASSERT (FALSE);
 | |
|       break;
 | |
|       
 | |
|   }
 | |
| 
 | |
|   EfiReleaseLock (&mPcdDatabaseLock);
 | |
|   
 | |
|   return RetPtr;
 | |
|   
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Register the callback function for a PCD entry.
 | |
| 
 | |
|   This routine will register a callback function to a PCD entry by given token number
 | |
|   and token space guid.
 | |
|   
 | |
|   @param TokenNumber        PCD token's number, it is autogened by build tools.
 | |
|   @param Guid               PCD token space's guid, 
 | |
|                             if not NULL, this PCD is dynamicEx type PCD.
 | |
|   @param CallBackFunction   Callback function pointer
 | |
| 
 | |
|   @return EFI_SUCCESS Always success for registering callback function.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| DxeRegisterCallBackWorker (
 | |
|   IN  UINTN                   TokenNumber,
 | |
|   IN  CONST EFI_GUID          *Guid, OPTIONAL
 | |
|   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction
 | |
| )
 | |
| {
 | |
|   CALLBACK_FN_ENTRY       *FnTableEntry;
 | |
|   LIST_ENTRY              *ListHead;
 | |
|   LIST_ENTRY              *ListNode;
 | |
| 
 | |
|   if (Guid != NULL) {
 | |
|     TokenNumber = GetExPcdTokenNumber (Guid, (UINT32) TokenNumber);
 | |
|   }
 | |
| 
 | |
|   //
 | |
|   // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
 | |
|   // We have to decrement TokenNumber by 1 to make it usable
 | |
|   // as the array index.
 | |
|   //
 | |
|   TokenNumber--;
 | |
| 
 | |
|   ListHead = &mCallbackFnTable[TokenNumber];
 | |
|   ListNode = GetFirstNode (ListHead);
 | |
| 
 | |
|   while (ListNode != ListHead) {
 | |
|     FnTableEntry = CR_FNENTRY_FROM_LISTNODE(ListNode, CALLBACK_FN_ENTRY, Node);
 | |
| 
 | |
|     if (FnTableEntry->CallbackFn == CallBackFunction) {
 | |
|       //
 | |
|       // We only allow a Callback function to be register once
 | |
|       // for a TokenNumber. So just return EFI_SUCCESS
 | |
|       //
 | |
|       return EFI_SUCCESS;
 | |
|     }
 | |
|     ListNode = GetNextNode (ListHead, ListNode);
 | |
|   }
 | |
| 
 | |
|   FnTableEntry = AllocatePool (sizeof(CALLBACK_FN_ENTRY));
 | |
|   ASSERT (FnTableEntry != NULL);
 | |
| 
 | |
|   FnTableEntry->CallbackFn = CallBackFunction;
 | |
|   InsertTailList (ListHead, &FnTableEntry->Node);
 | |
|   
 | |
|   return EFI_SUCCESS;
 | |
| }
 | |
| 
 | |
| /**
 | |
|   UnRegister the callback function for a PCD entry.
 | |
| 
 | |
|   This routine will unregister a callback function to a PCD entry by given token number
 | |
|   and token space guid.
 | |
| 
 | |
|   @param TokenNumber        PCD token's number, it is autogened by build tools.
 | |
|   @param Guid               PCD token space's guid.
 | |
|                             if not NULL, this PCD is dynamicEx type PCD.
 | |
|   @param CallBackFunction   Callback function pointer
 | |
| 
 | |
|   @retval EFI_SUCCESS               Callback function is success to be unregister.
 | |
|   @retval EFI_INVALID_PARAMETER     Can not find the PCD entry by given token number.
 | |
| **/
 | |
| EFI_STATUS
 | |
| DxeUnRegisterCallBackWorker (
 | |
|   IN  UINTN                   TokenNumber,
 | |
|   IN  CONST EFI_GUID          *Guid, OPTIONAL
 | |
|   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction
 | |
| )
 | |
| {
 | |
|   CALLBACK_FN_ENTRY       *FnTableEntry;
 | |
|   LIST_ENTRY              *ListHead;
 | |
|   LIST_ENTRY              *ListNode;
 | |
| 
 | |
|   if (Guid != NULL) {
 | |
|     TokenNumber = GetExPcdTokenNumber (Guid, (UINT32) TokenNumber);
 | |
|   }
 | |
| 
 | |
|   //
 | |
|   // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
 | |
|   // We have to decrement TokenNumber by 1 to make it usable
 | |
|   // as the array index.
 | |
|   //
 | |
|   TokenNumber--;
 | |
| 
 | |
|   ListHead = &mCallbackFnTable[TokenNumber];
 | |
|   ListNode = GetFirstNode (ListHead);
 | |
| 
 | |
|   while (ListNode != ListHead) {
 | |
|     FnTableEntry = CR_FNENTRY_FROM_LISTNODE(ListNode, CALLBACK_FN_ENTRY, Node);
 | |
| 
 | |
|     if (FnTableEntry->CallbackFn == CallBackFunction) {
 | |
|       //
 | |
|       // We only allow a Callback function to be register once
 | |
|       // for a TokenNumber. So we can safely remove the Node from
 | |
|       // the Link List and return EFI_SUCCESS.
 | |
|       //
 | |
|       RemoveEntryList (ListNode);
 | |
|       FreePool (FnTableEntry);
 | |
|       
 | |
|       return EFI_SUCCESS;
 | |
|     }
 | |
|     ListNode = GetNextNode (ListHead, ListNode);
 | |
|   }
 | |
| 
 | |
|   return EFI_INVALID_PARAMETER;
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Get next token number in given token space.
 | |
|   
 | |
|   This routine is used for dynamicEx type PCD. It will firstly scan token space
 | |
|   table to get token space according to given token space guid. Then scan given 
 | |
|   token number in found token space, if found, then return next token number in 
 | |
|   this token space.
 | |
| 
 | |
|   @param Guid            Token space guid. Next token number will be scaned in 
 | |
|                          this token space.
 | |
|   @param TokenNumber     Token number. 
 | |
|                          If PCD_INVALID_TOKEN_NUMBER, return first token number in 
 | |
|                          token space table.
 | |
|                          If not PCD_INVALID_TOKEN_NUMBER, return next token number
 | |
|                          in token space table.
 | |
|   @param GuidTable       Token space guid table. It will be used for scan token space
 | |
|                          by given token space guid.
 | |
|   @param SizeOfGuidTable The size of guid table.
 | |
|   @param ExMapTable      DynamicEx token number mapping table.
 | |
|   @param SizeOfExMapTable The size of dynamicEx token number mapping table.
 | |
| 
 | |
|   @retval EFI_NOT_FOUND  Can not given token space or token number.
 | |
|   @retval EFI_SUCCESS    Success to get next token number.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| ExGetNextTokeNumber (
 | |
|   IN      CONST EFI_GUID         *Guid,
 | |
|   IN OUT  UINTN                  *TokenNumber,
 | |
|   IN      EFI_GUID               *GuidTable,
 | |
|   IN      UINTN                  SizeOfGuidTable,
 | |
|   IN      DYNAMICEX_MAPPING      *ExMapTable,
 | |
|   IN      UINTN                  SizeOfExMapTable
 | |
|   )
 | |
| {
 | |
|   EFI_GUID         *MatchGuid;
 | |
|   UINTN            Index;
 | |
|   UINTN            GuidTableIdx;
 | |
|   BOOLEAN          Found;
 | |
| 
 | |
|   //
 | |
|   // Scan token space guid 
 | |
|   // 
 | |
|   MatchGuid = ScanGuid (GuidTable, SizeOfGuidTable, Guid);
 | |
|   if (MatchGuid == NULL) {
 | |
|     return EFI_NOT_FOUND;
 | |
|   }
 | |
| 
 | |
|   //
 | |
|   // Find the token space table in dynamicEx mapping table.
 | |
|   //
 | |
|   Found = FALSE;
 | |
|   GuidTableIdx = MatchGuid - GuidTable;
 | |
|   for (Index = 0; Index < SizeOfExMapTable; Index++) {
 | |
|     if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {
 | |
|       Found = TRUE;
 | |
|       break;
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   if (Found) {
 | |
|     //
 | |
|     // If given token number is PCD_INVALID_TOKEN_NUMBER, then return the first
 | |
|     // token number in found token space.
 | |
|     //
 | |
|     if (*TokenNumber == PCD_INVALID_TOKEN_NUMBER) {
 | |
|       *TokenNumber = ExMapTable[Index].ExTokenNumber;
 | |
|       return EFI_SUCCESS;
 | |
|     }
 | |
| 
 | |
|     for ( ; Index < SizeOfExMapTable; Index++) {
 | |
|       if (ExMapTable[Index].ExTokenNumber == *TokenNumber) {
 | |
|         Index ++;
 | |
|         if (Index == SizeOfExMapTable) {
 | |
|           //
 | |
|           // Exceed the length of ExMap Table
 | |
|           //
 | |
|           *TokenNumber = PCD_INVALID_TOKEN_NUMBER;
 | |
|           return EFI_SUCCESS;
 | |
|         } else if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {
 | |
|           //
 | |
|           // Found the next match
 | |
|           //
 | |
|           *TokenNumber = ExMapTable[Index].ExTokenNumber;
 | |
|           return EFI_SUCCESS;
 | |
|         } else {
 | |
|           //
 | |
|           // Guid has been changed. It is the next Token Space Guid.
 | |
|           // We should flag no more TokenNumber.
 | |
|           //
 | |
|           *TokenNumber = PCD_INVALID_TOKEN_NUMBER;
 | |
|           return EFI_SUCCESS;
 | |
|         }
 | |
|       }
 | |
|     }
 | |
|   }
 | |
|   
 | |
|   return EFI_NOT_FOUND;
 | |
| }
 | |
| 
 | |
| 
 | |
| /**
 | |
|   Initialize the PCD database in DXE phase.
 | |
|   
 | |
|   PCD database in DXE phase also contains PCD database in PEI phase which is copied
 | |
|   from GUID Hob.
 | |
| 
 | |
| **/
 | |
| VOID
 | |
| BuildPcdDxeDataBase (
 | |
|   VOID
 | |
|   )
 | |
| {
 | |
|   PEI_PCD_DATABASE    *PeiDatabase;
 | |
|   EFI_HOB_GUID_TYPE   *GuidHob;
 | |
|   UINTN               Index;
 | |
| 
 | |
|   mPcdDatabase = AllocateZeroPool (sizeof(PCD_DATABASE));
 | |
|   ASSERT (mPcdDatabase != NULL);
 | |
| 
 | |
|   GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);
 | |
|   if (GuidHob != NULL) {
 | |
| 
 | |
|     //
 | |
|     // We will copy over the PEI phase's PCD Database.
 | |
|     // 
 | |
|     // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
 | |
|     // should not be included at all. So the GuidHob could
 | |
|     // be NULL. If it is NULL, we just copy over the DXE Default
 | |
|     // Value to PCD Database.
 | |
|     //
 | |
|     
 | |
|     PeiDatabase = (PEI_PCD_DATABASE *) GET_GUID_HOB_DATA (GuidHob);
 | |
|     //
 | |
|     // Copy PCD Entries refereneced in PEI phase to PCD DATABASE
 | |
|     //
 | |
|     CopyMem (&mPcdDatabase->PeiDb, PeiDatabase, sizeof (PEI_PCD_DATABASE));
 | |
|   }
 | |
| 
 | |
|   //
 | |
|   // Copy PCD Entries with default value to PCD DATABASE
 | |
|   //
 | |
|   CopyMem (&mPcdDatabase->DxeDb.Init, &gDXEPcdDbInit, sizeof(DXE_PCD_DATABASE_INIT));
 | |
| 
 | |
| 
 | |
|   //
 | |
|   // Initialized the Callback Function Table
 | |
|   //
 | |
| 
 | |
|   mCallbackFnTable = AllocateZeroPool (PCD_TOTAL_TOKEN_NUMBER * sizeof (LIST_ENTRY));
 | |
|   ASSERT(mCallbackFnTable != NULL);
 | |
|   
 | |
|   // EBC compiler is very choosy. It may report warning about comparison
 | |
|   // between UINTN and 0 . So we add 1 in each size of the 
 | |
|   // comparison.
 | |
|   for (Index = 0; Index + 1 < PCD_TOTAL_TOKEN_NUMBER + 1; Index++) {
 | |
|     InitializeListHead (&mCallbackFnTable[Index]);
 | |
|   }
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Get Variable which contains HII type PCD entry.
 | |
| 
 | |
|   @param VariableGuid    Variable's guid
 | |
|   @param VariableName    Variable's unicode name string
 | |
|   @param VariableData    Variable's data pointer, 
 | |
|   @param VariableSize    Variable's size.
 | |
| 
 | |
|   @return the status of gRT->GetVariable
 | |
| **/
 | |
| EFI_STATUS
 | |
| GetHiiVariable (
 | |
|   IN  EFI_GUID      *VariableGuid,
 | |
|   IN  UINT16        *VariableName,
 | |
|   OUT UINT8         **VariableData,
 | |
|   OUT UINTN         *VariableSize
 | |
|   )
 | |
| {
 | |
|   UINTN      Size;
 | |
|   EFI_STATUS Status;
 | |
|   UINT8      *Buffer;
 | |
| 
 | |
|   Size = 0;
 | |
|   Buffer = NULL;
 | |
|   
 | |
|   //
 | |
|   // Firstly get the real size of HII variable
 | |
|   //
 | |
|   Status = gRT->GetVariable (
 | |
|     (UINT16 *)VariableName,
 | |
|     VariableGuid,
 | |
|     NULL,
 | |
|     &Size,
 | |
|     Buffer
 | |
|     );
 | |
|   
 | |
|   //
 | |
|   // Allocate buffer to hold whole variable data according to variable size.
 | |
|   //
 | |
|   if (Status == EFI_BUFFER_TOO_SMALL) {
 | |
|     Buffer = (UINT8 *) AllocatePool (Size);
 | |
| 
 | |
|     ASSERT (Buffer != NULL);
 | |
| 
 | |
|     Status = gRT->GetVariable (
 | |
|       VariableName,
 | |
|       VariableGuid,
 | |
|       NULL,
 | |
|       &Size,
 | |
|       Buffer
 | |
|       );
 | |
| 
 | |
|     ASSERT (Status == EFI_SUCCESS);
 | |
|     *VariableData = Buffer;
 | |
|     *VariableSize = Size;
 | |
|   }
 | |
| 
 | |
|   return Status;
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Find the local token number according to system SKU ID.
 | |
| 
 | |
|   @param LocalTokenNumber PCD token number
 | |
|   @param Size             The size of PCD entry.
 | |
|   @param IsPeiDb          If TRUE, the PCD entry is initialized in PEI phase.
 | |
|                           If False, the PCD entry is initialized in DXE phase.
 | |
| 
 | |
|   @return Token number according to system SKU ID.
 | |
| 
 | |
| **/
 | |
| UINT32
 | |
| GetSkuEnabledTokenNumber (
 | |
|   UINT32    LocalTokenNumber,
 | |
|   UINTN     Size,
 | |
|   BOOLEAN   IsPeiDb
 | |
|   ) 
 | |
| {
 | |
|   SKU_HEAD              *SkuHead;
 | |
|   SKU_ID                *SkuIdTable;
 | |
|   INTN                  Index;
 | |
|   UINT8                 *Value;
 | |
|   SKU_ID                *PhaseSkuIdTable;
 | |
|   UINT8                 *PcdDb;
 | |
| 
 | |
|   ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0);
 | |
| 
 | |
|   PcdDb = IsPeiDb ? (UINT8 *) &mPcdDatabase->PeiDb : (UINT8 *) &mPcdDatabase->DxeDb;
 | |
| 
 | |
|   SkuHead     = (SKU_HEAD *) (PcdDb + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));
 | |
|   Value       = (UINT8 *) (PcdDb + SkuHead->SkuDataStartOffset); 
 | |
| 
 | |
|   PhaseSkuIdTable = IsPeiDb ? mPcdDatabase->PeiDb.Init.SkuIdTable :
 | |
|                               mPcdDatabase->DxeDb.Init.SkuIdTable;
 | |
|                               
 | |
|   SkuIdTable  = &PhaseSkuIdTable[SkuHead->SkuIdTableOffset];
 | |
|         
 | |
|   //
 | |
|   // Find the current system's SKU ID entry in SKU ID table.
 | |
|   //
 | |
|   for (Index = 0; Index < SkuIdTable[0]; Index++) {
 | |
|     if (mPcdDatabase->PeiDb.Init.SystemSkuId == SkuIdTable[Index + 1]) {
 | |
|       break;
 | |
|     }
 | |
|   }
 | |
|   ASSERT (Index < SkuIdTable[0]);
 | |
| 
 | |
|   switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
 | |
|     case PCD_TYPE_VPD:
 | |
|       Value = (UINT8 *) &(((VPD_HEAD *) Value)[Index]);
 | |
|       return (UINT32) ((Value - PcdDb) | PCD_TYPE_VPD);
 | |
| 
 | |
|     case PCD_TYPE_HII:
 | |
|       Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[Index]);
 | |
|       return (UINT32) ((Value - PcdDb) | PCD_TYPE_HII);
 | |
| 
 | |
|     case PCD_TYPE_STRING:
 | |
|       Value = (UINT8 *) &(((STRING_HEAD *) Value)[Index]);
 | |
|       return (UINT32) ((Value - PcdDb) | PCD_TYPE_STRING);
 | |
|       
 | |
|     case PCD_TYPE_DATA:
 | |
|       Value += Size * Index;
 | |
|       return (UINT32) (Value - PcdDb);
 | |
| 
 | |
|     default:
 | |
|       ASSERT (FALSE);
 | |
|   }
 | |
| 
 | |
|   ASSERT (FALSE);
 | |
| 
 | |
|   return 0;
 | |
|   
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Invoke the callback function when dynamic PCD entry was set, if this PCD entry 
 | |
|   has registered callback function.
 | |
| 
 | |
|   @param ExTokenNumber   DynamicEx PCD's token number, if this PCD entry is dyanmicEx
 | |
|                          type PCD.
 | |
|   @param Guid            DynamicEx PCD's guid, if this PCD entry is dynamicEx type
 | |
|                          PCD.
 | |
|   @param TokenNumber     PCD token number generated by build tools.
 | |
|   @param Data            Value want to be set for this PCD entry
 | |
|   @param Size            The size of value
 | |
| 
 | |
| **/
 | |
| VOID
 | |
| InvokeCallbackOnSet (
 | |
|   UINT32            ExTokenNumber,
 | |
|   CONST EFI_GUID    *Guid, OPTIONAL
 | |
|   UINTN             TokenNumber,
 | |
|   VOID              *Data,
 | |
|   UINTN             Size
 | |
|   )
 | |
| {
 | |
|   CALLBACK_FN_ENTRY       *FnTableEntry;
 | |
|   LIST_ENTRY              *ListHead;
 | |
|   LIST_ENTRY              *ListNode;
 | |
| 
 | |
|   //
 | |
|   // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
 | |
|   // We have to decrement TokenNumber by 1 to make it usable
 | |
|   // as the array index.
 | |
|   //
 | |
|   TokenNumber--;
 | |
|   
 | |
|   ListHead = &mCallbackFnTable[TokenNumber];
 | |
|   ListNode = GetFirstNode (ListHead);
 | |
| 
 | |
|   while (ListNode != ListHead) {
 | |
|     FnTableEntry = CR_FNENTRY_FROM_LISTNODE(ListNode, CALLBACK_FN_ENTRY, Node);
 | |
| 
 | |
|     FnTableEntry->CallbackFn(Guid, 
 | |
|                     (Guid == NULL) ? TokenNumber : ExTokenNumber,
 | |
|                     Data,
 | |
|                     Size);
 | |
|     
 | |
|     ListNode = GetNextNode (ListHead, ListNode);
 | |
|   }
 | |
|   
 | |
|   return;
 | |
| }
 | |
| 
 | |
| 
 | |
| /**
 | |
|   Wrapper function for setting non-pointer type value for a PCD entry.
 | |
| 
 | |
|   @param TokenNumber     Pcd token number autogenerated by build tools.
 | |
|   @param Data            Value want to be set for PCD entry
 | |
|   @param Size            Size of value.
 | |
| 
 | |
|   @return status of SetWorker.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| SetValueWorker (
 | |
|   IN UINTN                   TokenNumber,
 | |
|   IN VOID                    *Data,
 | |
|   IN UINTN                   Size
 | |
|   )
 | |
| {
 | |
|   return SetWorker (TokenNumber, Data, &Size, FALSE);
 | |
| }
 | |
| 
 | |
| 
 | |
| /**
 | |
|   Set value for an PCD entry
 | |
| 
 | |
|   @param TokenNumber     Pcd token number autogenerated by build tools.
 | |
|   @param Data            Value want to be set for PCD entry
 | |
|   @param Size            Size of value.
 | |
|   @param PtrType         If TRUE, the type of PCD entry's value is Pointer.
 | |
|                          If False, the type of PCD entry's value is not Pointer.
 | |
| 
 | |
|   @retval EFI_INVALID_PARAMETER  If this PCD type is VPD, VPD PCD can not be set.
 | |
|   @retval EFI_INVALID_PARAMETER  If Size can not be set to size table.
 | |
|   @retval EFI_NOT_FOUND          If value type of PCD entry is intergrate, but not in
 | |
|                                  range of UINT8, UINT16, UINT32, UINT64
 | |
|   @retval EFI_NOT_FOUND          Can not find the PCD type according to token number.                                
 | |
| **/
 | |
| EFI_STATUS
 | |
| SetWorker (
 | |
|   IN          UINTN                   TokenNumber,
 | |
|   IN          VOID                    *Data,
 | |
|   IN OUT      UINTN                   *Size,
 | |
|   IN          BOOLEAN                 PtrType
 | |
|   )
 | |
| {
 | |
|   UINT32              *LocalTokenNumberTable;
 | |
|   BOOLEAN             IsPeiDb;
 | |
|   UINT32              LocalTokenNumber;
 | |
|   EFI_GUID            *GuidTable;
 | |
|   UINT8               *StringTable;
 | |
|   EFI_GUID            *Guid;
 | |
|   UINT16              *Name;
 | |
|   UINTN               VariableOffset;
 | |
|   VOID                *InternalData;
 | |
|   VARIABLE_HEAD       *VariableHead;
 | |
|   UINTN               Offset;
 | |
|   UINT8               *PcdDb;
 | |
|   EFI_STATUS          Status;
 | |
|   UINTN               MaxSize;
 | |
|   UINTN               TmpTokenNumber;
 | |
| 
 | |
|   //
 | |
|   // Aquire lock to prevent reentrance from TPL_CALLBACK level
 | |
|   //
 | |
|   EfiAcquireLock (&mPcdDatabaseLock);
 | |
| 
 | |
|   //
 | |
|   // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
 | |
|   // We have to decrement TokenNumber by 1 to make it usable
 | |
|   // as the array index.
 | |
|   //
 | |
|   TokenNumber--;
 | |
| 
 | |
|   TmpTokenNumber = TokenNumber;
 | |
|   
 | |
|   //
 | |
|   // EBC compiler is very choosy. It may report warning about comparison
 | |
|   // between UINTN and 0 . So we add 1 in each size of the 
 | |
|   // comparison.
 | |
|   //
 | |
|   ASSERT (TokenNumber + 1 < PCD_TOTAL_TOKEN_NUMBER + 1);
 | |
| 
 | |
|   if (!PtrType) {
 | |
|     ASSERT (*Size == DxePcdGetSize (TokenNumber + 1));
 | |
|   }
 | |
|   
 | |
|   //
 | |
|   // EBC compiler is very choosy. It may report warning about comparison
 | |
|   // between UINTN and 0 . So we add 1 in each size of the 
 | |
|   // comparison.
 | |
|   //
 | |
|   IsPeiDb = (BOOLEAN) ((TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1) ? TRUE : FALSE);
 | |
| 
 | |
|   LocalTokenNumberTable  = IsPeiDb ? mPcdDatabase->PeiDb.Init.LocalTokenNumberTable : 
 | |
|                                      mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;
 | |
| 
 | |
|   //
 | |
|   // EBC compiler is very choosy. It may report warning about comparison
 | |
|   // between UINTN and 0 . So we add 1 in each size of the 
 | |
|   // comparison.
 | |
|   //
 | |
|   if ((TokenNumber + 1 < PEI_NEX_TOKEN_NUMBER + 1) ||
 | |
|       (TokenNumber + 1 >= PEI_LOCAL_TOKEN_NUMBER + 1 || TokenNumber + 1 < (PEI_LOCAL_TOKEN_NUMBER + DXE_NEX_TOKEN_NUMBER + 1))) {
 | |
|     InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);
 | |
|   }
 | |
| 
 | |
|   TokenNumber = IsPeiDb ? TokenNumber
 | |
|                         : TokenNumber - PEI_LOCAL_TOKEN_NUMBER;
 | |
| 
 | |
|   LocalTokenNumber = LocalTokenNumberTable[TokenNumber];
 | |
|   
 | |
|   if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {
 | |
|     if (PtrType) {
 | |
|       GetPtrTypeSize (TmpTokenNumber, &MaxSize);
 | |
|     } else {
 | |
|       MaxSize = *Size;
 | |
|     }
 | |
|     LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, MaxSize, IsPeiDb);
 | |
|   }
 | |
| 
 | |
|   Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
 | |
| 
 | |
|   PcdDb = IsPeiDb ? ((UINT8 *) &mPcdDatabase->PeiDb) : ((UINT8 *) &mPcdDatabase->DxeDb);
 | |
| 
 | |
|   if (IsPeiDb) {
 | |
|     StringTable = (UINT8 *) (&mPcdDatabase->PeiDb.Init.StringTable[0]);
 | |
|   } else {
 | |
|     StringTable = (UINT8 *) (&mPcdDatabase->DxeDb.Init.StringTable[0]);
 | |
|   }
 | |
| 
 | |
|   
 | |
|   InternalData = PcdDb + Offset;
 | |
| 
 | |
|   switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
 | |
|     case PCD_TYPE_VPD:
 | |
|       ASSERT (FALSE);
 | |
|       Status = EFI_INVALID_PARAMETER;
 | |
|       break;
 | |
|     
 | |
|     case PCD_TYPE_STRING:
 | |
|       if (SetPtrTypeSize (TmpTokenNumber, Size)) {
 | |
|         CopyMem (StringTable + *((UINT16 *)InternalData), Data, *Size);
 | |
|         Status = EFI_SUCCESS;
 | |
|       } else {
 | |
|         Status = EFI_INVALID_PARAMETER;
 | |
|       }
 | |
|       break;
 | |
| 
 | |
|     case PCD_TYPE_HII:
 | |
|       if (PtrType) {
 | |
|         if (!SetPtrTypeSize (TmpTokenNumber, Size)) {
 | |
|           Status = EFI_INVALID_PARAMETER;
 | |
|           break;
 | |
|         }
 | |
|       }
 | |
|       
 | |
|       if (IsPeiDb) {
 | |
|         GuidTable = (EFI_GUID *) (&mPcdDatabase->PeiDb.Init.GuidTable[0]);
 | |
|       } else {
 | |
|         GuidTable = (EFI_GUID *) (&mPcdDatabase->DxeDb.Init.GuidTable[0]);
 | |
|       }
 | |
|                               
 | |
|       VariableHead = (VARIABLE_HEAD *) (PcdDb + Offset);
 | |
|       
 | |
|       Guid = GuidTable + VariableHead->GuidTableIndex;
 | |
|       Name = (UINT16*) (StringTable + VariableHead->StringIndex);
 | |
|       VariableOffset = VariableHead->Offset;
 | |
| 
 | |
|       Status = SetHiiVariable (Guid, Name, Data, *Size, VariableOffset);
 | |
| 
 | |
|       if (EFI_NOT_FOUND == Status) {
 | |
|         CopyMem (PcdDb + VariableHead->DefaultValueOffset, Data, *Size);
 | |
|         Status = EFI_SUCCESS;
 | |
|       } 
 | |
|       break;
 | |
|       
 | |
|     case PCD_TYPE_DATA:
 | |
|       if (PtrType) {
 | |
|         if (SetPtrTypeSize (TmpTokenNumber, Size)) {
 | |
|           CopyMem (InternalData, Data, *Size);
 | |
|           Status = EFI_SUCCESS;
 | |
|         } else {
 | |
|           Status = EFI_INVALID_PARAMETER;
 | |
|         }
 | |
|         break;
 | |
|       }
 | |
| 
 | |
|       Status = EFI_SUCCESS;
 | |
|       switch (*Size) {
 | |
|         case sizeof(UINT8):
 | |
|           *((UINT8 *) InternalData) = *((UINT8 *) Data);
 | |
|           break;
 | |
| 
 | |
|         case sizeof(UINT16):
 | |
|           *((UINT16 *) InternalData) = *((UINT16 *) Data);
 | |
|           break;
 | |
| 
 | |
|         case sizeof(UINT32):
 | |
|           *((UINT32 *) InternalData) = *((UINT32 *) Data);
 | |
|           break;
 | |
| 
 | |
|         case sizeof(UINT64):
 | |
|           *((UINT64 *) InternalData) = *((UINT64 *) Data);
 | |
|           break;
 | |
| 
 | |
|         default:
 | |
|           ASSERT (FALSE);
 | |
|           Status = EFI_NOT_FOUND;
 | |
|           break;
 | |
|       }
 | |
|       break;
 | |
| 
 | |
|     default:
 | |
|       ASSERT (FALSE);
 | |
|       Status = EFI_NOT_FOUND;
 | |
|       break;
 | |
|     }
 | |
| 
 | |
|   EfiReleaseLock (&mPcdDatabaseLock);
 | |
|   
 | |
|   return Status;
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Wrapper function for get PCD value for dynamic-ex PCD.
 | |
| 
 | |
|   @param Guid            Token space guid for dynamic-ex PCD.
 | |
|   @param ExTokenNumber   Token number for dynamic-ex PCD.
 | |
|   @param GetSize         The size of dynamic-ex PCD value.
 | |
| 
 | |
|   @return PCD entry in PCD database.
 | |
| 
 | |
| **/
 | |
| VOID *
 | |
| ExGetWorker (
 | |
|   IN CONST EFI_GUID         *Guid,
 | |
|   IN UINTN                  ExTokenNumber,
 | |
|   IN UINTN                  GetSize
 | |
|   ) 
 | |
| {
 | |
|   return GetWorker(GetExPcdTokenNumber (Guid, (UINT32) ExTokenNumber), GetSize);
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
 | |
| 
 | |
|   @param ExTokenNumber   Token number for dynamic-ex PCD.
 | |
|   @param Guid            Token space guid for dynamic-ex PCD.
 | |
|   @param Data            Value want to be set.
 | |
|   @param SetSize         The size of value.
 | |
| 
 | |
|   @return status of ExSetWorker().
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| ExSetValueWorker (
 | |
|   IN          UINTN                ExTokenNumber,
 | |
|   IN          CONST EFI_GUID       *Guid,
 | |
|   IN          VOID                 *Data,
 | |
|   IN          UINTN                SetSize
 | |
|   )
 | |
| {
 | |
|   return ExSetWorker (ExTokenNumber, Guid, Data, &SetSize, FALSE);
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Set value for a dynamic PCD entry.
 | |
|   
 | |
|   This routine find the local token number according to dynamic-ex PCD's token 
 | |
|   space guid and token number firstly, and invoke callback function if this PCD
 | |
|   entry registered callback function. Finally, invoken general SetWorker to set
 | |
|   PCD value.
 | |
|   
 | |
|   @param ExTokenNumber   Dynamic-ex PCD token number.
 | |
|   @param Guid            Token space guid for dynamic-ex PCD.
 | |
|   @param Data            PCD value want to be set
 | |
|   @param SetSize         Size of value.
 | |
|   @param PtrType         If TRUE, this PCD entry is pointer type.
 | |
|                          If FALSE, this PCD entry is not pointer type.
 | |
| 
 | |
|   @return status of SetWorker().
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| ExSetWorker (
 | |
|   IN          UINTN                ExTokenNumber,
 | |
|   IN          CONST EFI_GUID       *Guid,
 | |
|   IN          VOID                 *Data,
 | |
|   IN OUT      UINTN                *SetSize,
 | |
|   IN          BOOLEAN              PtrType
 | |
|   )
 | |
| {
 | |
|   UINTN                   TokenNumber;
 | |
|   
 | |
|   TokenNumber = GetExPcdTokenNumber (Guid, (UINT32) ExTokenNumber);
 | |
| 
 | |
|   InvokeCallbackOnSet ((UINT32) ExTokenNumber, Guid, TokenNumber, Data, *SetSize);
 | |
| 
 | |
|   return SetWorker (TokenNumber, Data, SetSize, PtrType);
 | |
| 
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Set value for HII-type PCD.
 | |
| 
 | |
|   A HII-type PCD's value is stored in a variable. Setting/Getting the value of 
 | |
|   HII-type PCD is to visit this variable.
 | |
|   
 | |
|   @param VariableGuid    Guid of variable which stored value of a HII-type PCD.
 | |
|   @param VariableName    Unicode name of variable which stored value of a HII-type PCD.
 | |
|   @param Data            Value want to be set.
 | |
|   @param DataSize        Size of value
 | |
|   @param Offset          Value offset of HII-type PCD in variable.
 | |
| 
 | |
|   @return status of GetVariable()/SetVariable().
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| SetHiiVariable (
 | |
|   IN  EFI_GUID     *VariableGuid,
 | |
|   IN  UINT16       *VariableName,
 | |
|   IN  CONST VOID   *Data,
 | |
|   IN  UINTN        DataSize,
 | |
|   IN  UINTN        Offset
 | |
|   )
 | |
| {
 | |
|   UINTN       Size;
 | |
|   VOID        *Buffer;
 | |
|   EFI_STATUS  Status;
 | |
|   UINT32      Attribute;
 | |
|   UINTN       SetSize;
 | |
| 
 | |
|   Size = 0;
 | |
|   SetSize = 0;
 | |
| 
 | |
|   //
 | |
|   // Try to get original variable size information.
 | |
|   //
 | |
|   Status = gRT->GetVariable (
 | |
|     (UINT16 *)VariableName,
 | |
|     VariableGuid,
 | |
|     NULL,
 | |
|     &Size,
 | |
|     NULL
 | |
|     );
 | |
|   
 | |
|   if (Status == EFI_BUFFER_TOO_SMALL) {
 | |
|     //
 | |
|     // Patch new PCD's value to offset in given HII variable.
 | |
|     //
 | |
|     if  (Size >= (DataSize + Offset)) {
 | |
|       SetSize = Size;
 | |
|     } else {
 | |
|       SetSize = DataSize + Offset;
 | |
|     }
 | |
|     Buffer = AllocatePool (SetSize);
 | |
|     ASSERT (Buffer != NULL);
 | |
| 
 | |
|     Status = gRT->GetVariable (
 | |
|       VariableName,
 | |
|       VariableGuid,
 | |
|       &Attribute,
 | |
|       &Size,
 | |
|       Buffer
 | |
|       );
 | |
|     
 | |
|     ASSERT_EFI_ERROR (Status);
 | |
| 
 | |
|     CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);
 | |
| 
 | |
|     Status = gRT->SetVariable (
 | |
|               VariableName,
 | |
|               VariableGuid,
 | |
|               Attribute,
 | |
|               SetSize,
 | |
|               Buffer
 | |
|               );
 | |
| 
 | |
|     FreePool (Buffer);
 | |
|     return Status;
 | |
|   } else if (Status == EFI_NOT_FOUND) {
 | |
|     //
 | |
|     // If variable does not exist, a new variable need to be created.
 | |
|     //
 | |
|     
 | |
|     Size = Offset + DataSize;
 | |
|     
 | |
|     Buffer = AllocateZeroPool (Size);
 | |
|     ASSERT (Buffer != NULL);
 | |
|     
 | |
|     CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);
 | |
|     
 | |
|     Status = gRT->SetVariable (
 | |
|               VariableName,
 | |
|               VariableGuid,
 | |
|               EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
 | |
|               Size,
 | |
|               Buffer
 | |
|               );
 | |
| 
 | |
|     FreePool (Buffer);
 | |
|     return Status;    
 | |
|   }
 | |
|   
 | |
|   //
 | |
|   // If we drop to here, the value is failed to be written in to variable area
 | |
|   // So, we will save the data in the PCD Database's volatile area.
 | |
|   //
 | |
|   return Status;
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Get local token number according to dynamic-ex PCD's {token space guid:token number}
 | |
| 
 | |
|   A dynamic-ex type PCD, developer must provide pair of token space guid: token number
 | |
|   in DEC file. PCD database maintain a mapping table that translate pair of {token
 | |
|   space guid: token number} to local token number.
 | |
|   
 | |
|   @param Guid            Token space guid for dynamic-ex PCD entry.
 | |
|   @param ExTokenNumber   Dynamic-ex PCD token number.
 | |
| 
 | |
|   @return local token number for dynamic-ex PCD.
 | |
| 
 | |
| **/
 | |
| UINTN           
 | |
| GetExPcdTokenNumber (
 | |
|   IN CONST EFI_GUID             *Guid,
 | |
|   IN UINT32                     ExTokenNumber
 | |
|   )
 | |
| {
 | |
|   UINT32              Index;
 | |
|   DYNAMICEX_MAPPING   *ExMap;
 | |
|   EFI_GUID            *GuidTable;
 | |
|   EFI_GUID            *MatchGuid;
 | |
|   UINTN               MatchGuidIdx;
 | |
| 
 | |
|   if (!PEI_DATABASE_EMPTY) {
 | |
|     ExMap       = mPcdDatabase->PeiDb.Init.ExMapTable;
 | |
|     GuidTable   = mPcdDatabase->PeiDb.Init.GuidTable;
 | |
|     
 | |
|     MatchGuid   = ScanGuid (GuidTable, sizeof(mPcdDatabase->PeiDb.Init.GuidTable), Guid);
 | |
|     
 | |
|     if (MatchGuid != NULL) {
 | |
| 
 | |
|       MatchGuidIdx = MatchGuid - GuidTable;
 | |
|       
 | |
|       for (Index = 0; Index < PEI_EXMAPPING_TABLE_SIZE; Index++) {
 | |
|         if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
 | |
|             (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {
 | |
|             return ExMap[Index].LocalTokenNumber;
 | |
|         }
 | |
|       }
 | |
|     }
 | |
|   }
 | |
|   
 | |
|   ExMap       = mPcdDatabase->DxeDb.Init.ExMapTable;
 | |
|   GuidTable   = mPcdDatabase->DxeDb.Init.GuidTable;
 | |
| 
 | |
|   MatchGuid   = ScanGuid (GuidTable, sizeof(mPcdDatabase->DxeDb.Init.GuidTable), Guid);
 | |
|   //
 | |
|   // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
 | |
|   // error in the BUILD system.
 | |
|   //
 | |
|   ASSERT (MatchGuid != NULL);
 | |
| 
 | |
|   MatchGuidIdx = MatchGuid - GuidTable;
 | |
|   
 | |
|   for (Index = 0; Index < DXE_EXMAPPING_TABLE_SIZE; Index++) {
 | |
|     if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
 | |
|          (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {
 | |
|         return ExMap[Index].LocalTokenNumber;
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   ASSERT (FALSE);
 | |
| 
 | |
|   return 0;
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Get SKU ID table from PCD database.
 | |
| 
 | |
|   @param LocalTokenNumberTableIdx Index of local token number in token number table.
 | |
|   @param IsPeiPcd                 If TRUE, 
 | |
| 
 | |
|   @return Pointer to SKU ID array table
 | |
| 
 | |
| **/
 | |
| SKU_ID *
 | |
| GetSkuIdArray (
 | |
|   IN    UINTN             LocalTokenNumberTableIdx,
 | |
|   IN    BOOLEAN           IsPeiPcd
 | |
|   )
 | |
| {
 | |
|   SKU_HEAD  *SkuHead;
 | |
|   UINTN     LocalTokenNumber;
 | |
|   UINT8     *Database;
 | |
| 
 | |
|   if (IsPeiPcd) {
 | |
|     LocalTokenNumber = mPcdDatabase->PeiDb.Init.LocalTokenNumberTable[LocalTokenNumberTableIdx];
 | |
|     Database         = (UINT8 *) &mPcdDatabase->PeiDb;
 | |
|   } else {
 | |
|     LocalTokenNumber = mPcdDatabase->DxeDb.Init.LocalTokenNumberTable[LocalTokenNumberTableIdx - PEI_LOCAL_TOKEN_NUMBER];
 | |
|     Database         = (UINT8 *) &mPcdDatabase->DxeDb;
 | |
|   }
 | |
| 
 | |
|   ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) != 0);
 | |
| 
 | |
|   SkuHead = (SKU_HEAD *) ((UINT8 *)Database + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));
 | |
| 
 | |
|   return (SKU_ID *) (Database + SkuHead->SkuIdTableOffset);
 | |
|   
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Wrapper function of getting index of PCD entry in size table.
 | |
|   
 | |
|   @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
 | |
|   @param IsPeiDb                  If TRUE, the pcd entry is initialized in PEI phase,
 | |
|                                   If FALSE, the pcd entry is initialized in DXE phase.
 | |
| 
 | |
|   @return index of PCD entry in size table.
 | |
| **/
 | |
| UINTN
 | |
| GetSizeTableIndex (
 | |
|   IN    UINTN             LocalTokenNumberTableIdx,
 | |
|   IN    BOOLEAN           IsPeiDb
 | |
|   )
 | |
| {
 | |
|   UINT32 *LocalTokenNumberTable;
 | |
|   UINTN  LocalTokenNumber;
 | |
|   UINTN  Index;
 | |
|   UINTN  SizeTableIdx;
 | |
|   SKU_ID *SkuIdTable;
 | |
|   
 | |
|   if (IsPeiDb) {
 | |
|     LocalTokenNumberTable = mPcdDatabase->PeiDb.Init.LocalTokenNumberTable;
 | |
|   } else {
 | |
|     LocalTokenNumberTable = mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;
 | |
|   }
 | |
| 
 | |
|   SizeTableIdx = 0;
 | |
| 
 | |
|   for (Index = 0; Index < LocalTokenNumberTableIdx; Index ++) {
 | |
|     LocalTokenNumber = LocalTokenNumberTable[Index];
 | |
| 
 | |
|     if ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER) {
 | |
|       //
 | |
|       // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type 
 | |
|       // PCD entry.
 | |
|       //
 | |
|       if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
 | |
|           //
 | |
|           // We have only one entry for VPD enabled PCD entry:
 | |
|           // 1) MAX Size.
 | |
|           // We consider current size is equal to MAX size.
 | |
|           //
 | |
|           SizeTableIdx++;
 | |
|       } else {
 | |
|         if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0) {
 | |
|           //
 | |
|           // We have only two entry for Non-Sku enabled PCD entry:
 | |
|           // 1) MAX SIZE
 | |
|           // 2) Current Size
 | |
|           //
 | |
|           SizeTableIdx += 2;
 | |
|         } else {
 | |
|           //
 | |
|           // We have these entry for SKU enabled PCD entry
 | |
|           // 1) MAX SIZE
 | |
|           // 2) Current Size for each SKU_ID (It is equal to MaxSku).
 | |
|           //
 | |
|           SkuIdTable = GetSkuIdArray (Index, IsPeiDb);
 | |
|           SizeTableIdx += (UINTN)*SkuIdTable + 1;
 | |
|         }
 | |
|       }
 | |
|     }
 | |
| 
 | |
|   }
 | |
| 
 | |
|   return SizeTableIdx;  
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Get size of POINTER type PCD value.
 | |
| 
 | |
|   @param LocalTokenNumberTableIdx Index of local token number in local token number table.
 | |
|   @param MaxSize                  Maxmium size of POINTER type PCD value.
 | |
| 
 | |
|   @return size of POINTER type PCD value.
 | |
| 
 | |
| **/
 | |
| UINTN
 | |
| GetPtrTypeSize (
 | |
|   IN    UINTN             LocalTokenNumberTableIdx,
 | |
|   OUT   UINTN             *MaxSize
 | |
|   )
 | |
| {
 | |
|   INTN        SizeTableIdx;
 | |
|   UINTN       LocalTokenNumber;
 | |
|   SKU_ID      *SkuIdTable;
 | |
|   SIZE_INFO   *SizeTable;
 | |
|   UINTN       Index;
 | |
|   BOOLEAN     IsPeiDb;
 | |
|   UINT32      *LocalTokenNumberTable;
 | |
| 
 | |
|   // EBC compiler is very choosy. It may report warning about comparison
 | |
|   // between UINTN and 0 . So we add 1 in each size of the 
 | |
|   // comparison.
 | |
|   IsPeiDb = (BOOLEAN) (LocalTokenNumberTableIdx + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);
 | |
| 
 | |
| 
 | |
|   if (IsPeiDb) {
 | |
|     LocalTokenNumberTable = mPcdDatabase->PeiDb.Init.LocalTokenNumberTable;
 | |
|     SizeTable = mPcdDatabase->PeiDb.Init.SizeTable;
 | |
|   } else {
 | |
|     LocalTokenNumberTableIdx -= PEI_LOCAL_TOKEN_NUMBER;
 | |
|     LocalTokenNumberTable = mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;
 | |
|     SizeTable = mPcdDatabase->DxeDb.Init.SizeTable;
 | |
|   }
 | |
| 
 | |
|   LocalTokenNumber = LocalTokenNumberTable[LocalTokenNumberTableIdx];
 | |
| 
 | |
|   ASSERT ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER);
 | |
|   
 | |
|   SizeTableIdx = GetSizeTableIndex (LocalTokenNumberTableIdx, IsPeiDb);
 | |
| 
 | |
|   *MaxSize = SizeTable[SizeTableIdx];
 | |
|   //
 | |
|   // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type 
 | |
|   // PCD entry.
 | |
|   //
 | |
|   if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
 | |
|       //
 | |
|       // We have only one entry for VPD enabled PCD entry:
 | |
|       // 1) MAX Size.
 | |
|       // We consider current size is equal to MAX size.
 | |
|       //
 | |
|       return *MaxSize;
 | |
|   } else {
 | |
|     if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0) {
 | |
|       //
 | |
|       // We have only two entry for Non-Sku enabled PCD entry:
 | |
|       // 1) MAX SIZE
 | |
|       // 2) Current Size
 | |
|       //
 | |
|       return SizeTable[SizeTableIdx + 1];
 | |
|     } else {
 | |
|       //
 | |
|       // We have these entry for SKU enabled PCD entry
 | |
|       // 1) MAX SIZE
 | |
|       // 2) Current Size for each SKU_ID (It is equal to MaxSku).
 | |
|       //
 | |
|       SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);
 | |
|       for (Index = 0; Index < SkuIdTable[0]; Index++) {
 | |
|         if (SkuIdTable[1 + Index] == mPcdDatabase->PeiDb.Init.SystemSkuId) {
 | |
|           return SizeTable[SizeTableIdx + 1 + Index];
 | |
|         }
 | |
|       }
 | |
|       return SizeTable[SizeTableIdx + 1];
 | |
|     }
 | |
|   }
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Set size of POINTER type PCD value. The size should not exceed the maximum size
 | |
|   of this PCD value.
 | |
| 
 | |
|   @param LocalTokenNumberTableIdx Index of local token number in local token number table.
 | |
|   @param CurrentSize              Size of POINTER type PCD value.
 | |
| 
 | |
|   @retval TRUE  Success to set size of PCD value.
 | |
|   @retval FALSE Fail to set size of PCD value.
 | |
| **/
 | |
| BOOLEAN
 | |
| SetPtrTypeSize (
 | |
|   IN          UINTN             LocalTokenNumberTableIdx,
 | |
|   IN    OUT   UINTN             *CurrentSize
 | |
|   )
 | |
| {
 | |
|   INTN        SizeTableIdx;
 | |
|   UINTN       LocalTokenNumber;
 | |
|   SKU_ID      *SkuIdTable;
 | |
|   SIZE_INFO   *SizeTable;
 | |
|   UINTN       Index;
 | |
|   UINTN       MaxSize;
 | |
|   BOOLEAN     IsPeiDb;
 | |
|   UINT32      *LocalTokenNumberTable;
 | |
| 
 | |
|   //
 | |
|   // EBC compiler is very choosy. It may report warning about comparison
 | |
|   // between UINTN and 0 . So we add 1 in each size of the 
 | |
|   // comparison.
 | |
|   //
 | |
|   IsPeiDb = (BOOLEAN) (LocalTokenNumberTableIdx + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);
 | |
| 
 | |
|   if (IsPeiDb) {
 | |
|     LocalTokenNumberTable = mPcdDatabase->PeiDb.Init.LocalTokenNumberTable;
 | |
|     SizeTable = mPcdDatabase->PeiDb.Init.SizeTable;
 | |
|   } else {
 | |
|     LocalTokenNumberTableIdx -= PEI_LOCAL_TOKEN_NUMBER;
 | |
|     LocalTokenNumberTable = mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;
 | |
|     SizeTable = mPcdDatabase->DxeDb.Init.SizeTable;
 | |
|   }
 | |
| 
 | |
|   LocalTokenNumber = LocalTokenNumberTable[LocalTokenNumberTableIdx];
 | |
| 
 | |
|   ASSERT ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER);
 | |
|   
 | |
|   SizeTableIdx = GetSizeTableIndex (LocalTokenNumberTableIdx, IsPeiDb);
 | |
| 
 | |
|   MaxSize = SizeTable[SizeTableIdx];
 | |
|   //
 | |
|   // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type 
 | |
|   // PCD entry.
 | |
|   //
 | |
|   if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
 | |
|       //
 | |
|       // We shouldn't come here as we don't support SET for VPD
 | |
|       //
 | |
|       ASSERT (FALSE);
 | |
|       return FALSE;
 | |
|   } else {
 | |
|     if ((*CurrentSize > MaxSize) ||
 | |
|       (*CurrentSize == MAX_ADDRESS)) {
 | |
|        *CurrentSize = MaxSize;
 | |
|        return FALSE;
 | |
|     } 
 | |
|     
 | |
|     if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0) {
 | |
|       //
 | |
|       // We have only two entry for Non-Sku enabled PCD entry:
 | |
|       // 1) MAX SIZE
 | |
|       // 2) Current Size
 | |
|       //
 | |
|       SizeTable[SizeTableIdx + 1] = (SIZE_INFO) *CurrentSize;
 | |
|       return TRUE;
 | |
|     } else {
 | |
|       //
 | |
|       // We have these entry for SKU enabled PCD entry
 | |
|       // 1) MAX SIZE
 | |
|       // 2) Current Size for each SKU_ID (It is equal to MaxSku).
 | |
|       //
 | |
|       SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);
 | |
|       for (Index = 0; Index < SkuIdTable[0]; Index++) {
 | |
|         if (SkuIdTable[1 + Index] == mPcdDatabase->PeiDb.Init.SystemSkuId) {
 | |
|           SizeTable[SizeTableIdx + 1 + Index] = (SIZE_INFO) *CurrentSize;
 | |
|           return TRUE;
 | |
|         }
 | |
|       }
 | |
|       SizeTable[SizeTableIdx + 1] = (SIZE_INFO) *CurrentSize;
 | |
|       return TRUE;
 | |
|     }
 | |
|   }
 | |
| }
 |