/** @file The internal header file declares the private functions used by PeiPcd driver. Copyright (c) 2006 - 2008, 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. **/ #ifndef _PEI_PCD_SERVICE_H_ #define _PEI_PCD_SERVICE_H_ #include #include #include #include #include #include #include #include #include #include #include // // Please make sure the PCD Serivce PEIM Version is consistent with // the version of PCD Database generation tool // #define PCD_SERVICE_PEIM_VERSION 2 // // PCD_PEI_DATABASE_GENTOOL_VERSION is defined in Autogen.h // and generated by PCD Database generation tool. // //#if (PCD_SERVICE_PEIM_VERSION != PCD_PEI_SERVICE_DRIVER_AUTOGEN_VERSION ) // #error "Please make sure the version of PCD Service PEIM and PCD PEI Database Generation Tool matches" //#endif // // PPI Interface Implementation Declaration. // /** Sets the SKU value for subsequent calls to set or get PCD token values. SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. SetSku() is normally called only once by the system. For each item (token), the database can hold a single value that applies to all SKUs, or multiple values, where each value is associated with a specific SKU Id. Items with multiple, SKU-specific values are called SKU enabled. The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255. For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been set for that Id, the results are unpredictable. @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and set values associated with a PCD token. **/ VOID EFIAPI PeiPcdSetSku ( IN UINTN SkuId ); /** Retrieves an 8-bit value for a given PCD token. Retrieves the current byte-sized value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @return The UINT8 value. **/ UINT8 EFIAPI PeiPcdGet8 ( IN UINTN TokenNumber ); /** Retrieves an 16-bit value for a given PCD token. Retrieves the current 16-bits value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @return The UINT16 value. **/ UINT16 EFIAPI PeiPcdGet16 ( IN UINTN TokenNumber ); /** Retrieves an 32-bit value for a given PCD token. Retrieves the current 32-bits value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @return The UINT32 value. **/ UINT32 EFIAPI PeiPcdGet32 ( IN UINTN TokenNumber ); /** Retrieves an 64-bit value for a given PCD token. Retrieves the current 64-bits value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @return The UINT64 value. **/ UINT64 EFIAPI PeiPcdGet64 ( IN UINTN TokenNumber ); /** Retrieves a pointer to a value for a given PCD token. Retrieves the current pointer to the buffer for a PCD token number. Do not make any assumptions about the alignment of the pointer that is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @return The pointer to the buffer to be retrived. **/ VOID * EFIAPI PeiPcdGetPtr ( IN UINTN TokenNumber ); /** Retrieves a Boolean value for a given PCD token. Retrieves the current boolean value for a PCD token number. Do not make any assumptions about the alignment of the pointer that is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @return The Boolean value. **/ BOOLEAN EFIAPI PeiPcdGetBool ( IN UINTN TokenNumber ); /** Retrieves the size of the value for a given PCD token. Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @return The size of the value for the PCD token. **/ UINTN EFIAPI PeiPcdGetSize ( IN UINTN TokenNumber ); /** Retrieves an 8-bit value for a given PCD token. Retrieves the 8-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size 8-bit value for the PCD token. **/ UINT8 EFIAPI PeiPcdGet8Ex ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber ); /** Retrieves an 16-bit value for a given PCD token. Retrieves the 16-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size 16-bit value for the PCD token. **/ UINT16 EFIAPI PeiPcdGet16Ex ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber ); /** Retrieves an 32-bit value for a given PCD token. Retrieves the 32-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size 32-bit value for the PCD token. **/ UINT32 EFIAPI PeiPcdGet32Ex ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber ); /** Retrieves an 64-bit value for a given PCD token. Retrieves the 64-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size 64-bit value for the PCD token. **/ UINT64 EFIAPI PeiPcdGet64Ex ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber ); /** Retrieves a pointer to a value for a given PCD token. Retrieves the current pointer to the buffer for a PCD token number. Do not make any assumptions about the alignment of the pointer that is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The pointer to the buffer to be retrived. **/ VOID * EFIAPI PeiPcdGetPtrEx ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber ); /** Retrieves an Boolean value for a given PCD token. Retrieves the Boolean value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size Boolean value for the PCD token. **/ BOOLEAN EFIAPI PeiPcdGetBoolEx ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber ); /** Retrieves the size of the value for a given PCD token. Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are unpredictable. @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size of the value for the PCD token. **/ UINTN EFIAPI PeiPcdGetSizeEx ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber ); /** Sets an 8-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSet8 ( IN UINTN TokenNumber, IN UINT8 Value ); /** Sets an 16-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSet16 ( IN UINTN TokenNumber, IN UINT16 Value ); /** Sets an 32-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSet32 ( IN UINTN TokenNumber, IN UINT32 Value ); /** Sets an 64-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSet64 ( IN UINTN TokenNumber, IN UINT64 Value ); /** Sets a value of a specified size for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. On input, if the SizeOfValue is greater than the maximum size supported for this TokenNumber then the output value of SizeOfValue will reflect the maximum size supported for this TokenNumber. @param[in] Buffer The buffer to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSetPtr ( IN UINTN TokenNumber, IN OUT UINTN *SizeOfBuffer, IN VOID *Buffer ); /** Sets an Boolean value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSetBool ( IN UINTN TokenNumber, IN BOOLEAN Value ); /** Sets an 8-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSet8Ex ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN UINT8 Value ); /** Sets an 16-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSet16Ex ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN UINT16 Value ); /** Sets an 32-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSet32Ex ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN UINT32 Value ); /** Sets an 64-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSet64Ex ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN UINT64 Value ); /** Sets a value of a specified size for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. On input, if the SizeOfValue is greater than the maximum size supported for this TokenNumber then the output value of SizeOfValue will reflect the maximum size supported for this TokenNumber. @param[in] Buffer The buffer to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSetPtrEx ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN OUT UINTN *SizeOfBuffer, IN VOID *Buffer ); /** Sets an Boolean value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS Procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ EFI_STATUS EFIAPI PeiPcdSetBoolEx ( IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, IN BOOLEAN Value ); /** Specifies a function to be called anytime the value of a designated token is changed. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. @retval EFI_SUCCESS The PCD service has successfully established a call event for the CallBackToken requested. @retval EFI_NOT_FOUND The PCD service could not find the referenced token number. **/ EFI_STATUS EFIAPI PeiRegisterCallBackOnSet ( IN CONST EFI_GUID *Guid, OPTIONAL IN UINTN TokenNumber, IN PCD_PPI_CALLBACK CallBackFunction ); /** Cancels a previously set callback function for a particular PCD token number. @param [in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param [in] TokenNumber The PCD token number. @param [in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. @retval EFI_SUCCESS The PCD service has successfully established a call event for the CallBackToken requested. @retval EFI_NOT_FOUND The PCD service could not find the referenced token number. **/ EFI_STATUS EFIAPI PcdUnRegisterCallBackOnSet ( IN CONST EFI_GUID *Guid, OPTIONAL IN UINTN TokenNumber, IN PCD_PPI_CALLBACK CallBackFunction ); /** Retrieves the next valid PCD token for a given namespace. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number. If the input token namespace or token number does not exist on the platform, an error is returned and the value of *TokenNumber is undefined. To retrieve the "first" token, have the pointer reference a TokenNumber value of 0. If the input token number is 0 and there is no valid token number for this token namespace, *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS. If the token number is the last valid token number, *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS. @retval EFI_SUCCESS The PCD service retrieved the next valid token number. Or the input token number is already the last valid token number in the PCD database. In the later case, *TokenNumber is updated with the value of 0. @retval EFI_NOT_FOUND If this input token number and token namespace does not exist on the platform. **/ EFI_STATUS EFIAPI PeiPcdGetNextToken ( IN CONST EFI_GUID *Guid, OPTIONAL IN OUT UINTN *TokenNumber ); /** Retrieves the next valid PCD token namespace for a given namespace. @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known token namespace from which the search will start. On output, it designates the next valid token namespace on the platform. If the input token namespace does not exist on the platform, an error is returned and the value of *Guid is undefined. If *Guid is NULL, then the GUID of the first token space of the current platform is assigned to *Guid the function return EFI_SUCCESS. If *Guid is NULL and there is no namespace exist in the platform other than the default (NULL) tokennamespace, *Guid is unchanged and the function return EFI_SUCCESS. If this input token namespace is the last namespace on the platform, *Guid will be assigned to NULL and the function return EFI_SUCCESS. @retval EFI_SUCCESS The PCD service retrieved the next valid token space Guid. Or the input token space Guid is already the last valid token space Guid in the PCD database. In the later case, *Guid is updated with the value of NULL. @retval EFI_NOT_FOUND If the input token namespace does not exist on the platform. **/ EFI_STATUS EFIAPI PeiPcdGetNextTokenSpace ( IN OUT CONST EFI_GUID **Guid ); /* Internal Function definitions */ /** Get PCD database from GUID HOB in PEI phase. @return Pointer to PCD database. **/ PEI_PCD_DATABASE * GetPcdDatabase ( VOID ); /** 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 ); /** 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 ); /** 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 Size ); /** 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 *Size, IN BOOLEAN PtrType ); /** 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 ); /** Wrapper function for get PCD value for dynamic-ex PCD. @param Guid Token space guid for dynamic-ex PCD. @param ExTokenNumber Token number for dyanmic-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 ); typedef struct { UINTN TokenNumber; UINTN Size; UINT32 LocalTokenNumberAlias; } EX_PCD_ENTRY_ATTRIBUTE; /** 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 Token number for dynamic-ex PCD. @return local token number for dynamic-ex PCD. **/ UINTN GetExPcdTokenNumber ( IN CONST EFI_GUID *Guid, IN UINTN ExTokenNumber ); /** The function registers the CallBackOnSet fucntion according to TokenNumber and EFI_GUID space. @param TokenNumber The token number. @param Guid The GUID space. @param CallBackFunction The Callback function to be registered. @param Register To register or unregister the callback function. @retval EFI_SUCCESS If the Callback function is registered. @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space. @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free slot left in the CallbackFnTable. **/ EFI_STATUS PeiRegisterCallBackWorker ( IN UINTN TokenNumber, IN CONST EFI_GUID *Guid, OPTIONAL IN PCD_PPI_CALLBACK CallBackFunction, IN BOOLEAN Register ); /** The function builds the PCD database. **/ VOID BuildPcdDatabase ( VOID ); /** Get SKU ID tabble from PCD database. @param LocalTokenNumberTableIdx Index of local token number in token number table. @param Database PCD Database in PEI phase @return Pointer to SKU ID array table **/ SKU_ID * GetSkuIdArray ( IN UINTN LocalTokenNumberTableIdx, IN PEI_PCD_DATABASE *Database ); /** Get index of PCD entry in size table. @param LocalTokenNumberTableIdx Index of this PCD in local token number table. @param Database Pointer to PCD database. @return index of PCD entry in size table. **/ UINTN GetSizeTableIndex ( IN UINTN LocalTokenNumberTableIdx, IN PEI_PCD_DATABASE *Database ); /** Get PCD value's size for POINTER type PCD. The POINTER type PCD's value will be stored into a buffer in specificed size. The max size of this PCD's value is described in PCD's definition in DEC file. @param LocalTokenNumberTableIdx Index of PCD token number in PCD token table @param MaxSize Maxmium size of PCD's value @param Database Pcd database in PEI phase. @return PCD value's size for POINTER type PCD. **/ UINTN GetPtrTypeSize ( IN UINTN LocalTokenNumberTableIdx, OUT UINTN *MaxSize, IN PEI_PCD_DATABASE *Database ); /** Set PCD value's size for POINTER type PCD. The POINTER type PCD's value will be stored into a buffer in specificed size. The max size of this PCD's value is described in PCD's definition in DEC file. @param LocalTokenNumberTableIdx Index of PCD token number in PCD token table @param CurrentSize Maxmium size of PCD's value @param Database Pcd database in PEI phase. @retval TRUE Success to set PCD's value size, which is not exceed maxmium size @retval FALSE Fail to set PCD's value size, which maybe exceed maxmium size **/ BOOLEAN SetPtrTypeSize ( IN UINTN LocalTokenNumberTableIdx, IN OUT UINTN *CurrentSize, IN PEI_PCD_DATABASE *Database ); // // The init Database created by PCD Database generation tool // extern PEI_PCD_DATABASE_INIT gPEIPcdDbInit; #endif //////////////////////////////////////////////////////////////////////////////// // // // Introduction of PEI PCD database // // // //////////////////////////////////////////////////////////////////////////////// /** 1, Introduction PEI PCD database hold all dynamic type PCD information used in PEI phase. The structure of PEI PCD database is generated by build tools according to dynamic PCD usage for specified platform. 2, Dynamic Type PCD Dynamic type PCD is designed for accessing setting which value is determined dynamic. In contrast, the value of static type PCD (FeatureFlag, FixedPcd, PatchablePcd) is fixed in final generated FD image in build time. 2.1 The "dynamic" determination means: a) The PCD value is produced by someone driver and consumed by other driver in execution time. b) The PCD value is set/get by user from FrontPage. c) The PCD value is produced by platform OEM specified area. 2.2 According to distribution mehod, dynamic PCD could be classfied as: a) Dynamic: This type PCD is used for module in source distribution which will be built in platform. b) DynamicEx: This type PCD is used for module in binary distribution which will be will not built. 2.3 According to storage method, dynamic PCD could be classfied as: a) Default Storage: - The value is stored in PCD database maintained by PCD database in boot time memory which is built as a guid hob in PEI phase. - This type is used for communication between PEIM/DXE driver, DXE/DXE driver. But all set/get value will be losted after boot-time memory is turn off. - [PcdsDynamicDefault]/[PcdsDynamicExDefault] is used as section name for this type PCD in platform DSC file. b) Variable Storage: - The value is stored in variable area. - As default storage type, this type PCD could used for communication. But beside it, this type PCD could be used store the value associating with HII setting via variable technology. - In PEI phase, the PCD value could only be got but can not be set due to variable area is readonly for PEI phase. - [PcdsDynamicHii]/[PcdsDynamicExHii] is used as section name for this type PCD in platform DSC file. c) OEM specificed storage area: - The value is stored in OEM specified area, the base address is specified by a FixedAtBuild PCD PcdVpdBaseAddress. - The area is read only for PEI and DXE phase. - [PcdsDynamicVpd]/[PcdsDynamicExVpd] is used as section name for this type PCD in platform DSC file. Note: The default value of dynamic PCD are storaged in memory maintained by PEI/DXE PCD drvier. 2.4 When and how to use dynamic PCD Module developer do not care the used PCD is dynamic or static when writting source code/INF. Dynamic PCD and dynamic type is pointed by platform integrator in platform DSC file. Please ref section 2.3 to get matching between dynamic PCD type and section name in DSC file. 3, PCD database: Although dynamic PCD could be in different storage type as above description, but the basic information and default value for all dynamic PCD is hold by PCD database maintained by PEI/DXE driver. As whole EFI BIOS boot path is divided into PEI/DXE phase, the PCD database also is divided into Pei/Dxe database maintaied by PcdPeim/PcdDxe driver separatly. To make PcdPeim's driver image smaller, PEI PCD database only hold all dynamic PCD information used in PEI phase or use in both PEI/DXE phase. And DXE PCD database contains all PCDs used in PEI/DXE phase in memory. Build tool will generate PCD database into some C structure and variable for PEI/DXE PCD driver according to dynamic PCD section in platform DSC file. 3.1 PcdPeim and PcdDxe PEI PCD database is maintained by PcdPeim driver run from flash. PcdPeim driver build guid hob in temporary memory and copy auto-generated C structure to temporary memory for PEI PCD database. DXE PCD database is maintained by PcdDxe driver.At entry point of PcdDxe driver, a new PCD database is allocated in boot-time memory which including all PEI PCD and DXE PCD entry. Pcd driver should run as early as possible before any other driver access dynamic PCD's value. PEI/DXE "Apriori File" mechanism make it possible by making PcdPeim/PcdDxe as first dispatching driver in PEI/DXE phase. 3.2 Token space Guid/Token number, Platform token, Local token number Dynamic PCD +-----------+ +---------+ |TokenSpace | |Platform | | Guid | build tool | Token | | + +-------------->| Number | | Token | +---------+`._ | Number | `. +-----------+ `. +------+ `-|Local | |Token | DynamicEx PCD ,-|Number| +-----------+ ,-' +------+ |TokenSpace | ,-' | Guid | _,-' | + +.' | Token | | Number | +-----------+ 3.2.1 Pair of Token space guid + Token number Any type PCD is identified by pair of "TokenSpaceGuid + TokeNumber". But it is not easy maintained by PCD driver, and hashed token number will make searching slowly. 3.2.2 Platform Token Number "Platform token number" concept is introduced for mapping to a pair of "TokenSpaceGuid + TokenNumber". The platform token number is generated by build tool in autogen.h and all of them are continual in a platform scope started from 1.(0 meaning invalid internal token number) With auto-generated "platform token number", PcdGet(PcdSampleDynamicPcd) in source code is translated to LibPcdGet(_PCD_TOKEN_PcdSampleDynamicPcd) in autogen.h. Notes: The mapping between pair of "tokenspace guid + token number" and "internal token number" need build tool establish, so "platform token number" mechanism is not suitable for binary module which use DynamicEx type PCD. To access a dynamicEx type PCD, pair of "token space guid/token number" all need to be specificed for PcdSet/PcdGet accessing macro. 3.2.3 Local Token Number To fast searching a PCD entry in PCD database, PCD driver translate platform token number to local token number via a mapping table. For binary DynamicEx type PCD, there is a another mapping table to translate "token space guid + token number" to local token number directly. Local token number is identifier for all internal interface in PCD PEI/DXE driver. A local token number is a 32-bit value in following meaning: 32 ------------- 28 ---------- 24 -------- 0 | PCD type mask | Datum Type | Offset | +-----------------------------------------+ where: PCd type mask: indicate Pcd type from following macro: PCD_TYPE_DATA PCD_TYPE_HII PCD_TYPE_VPD PCD_TYPE_SKU_ENABLED PCD_TYPE_STRING Datum Type : indicate PCD vaue type from following macro: PCD_DATUM_TYPE_POINTER PCD_DATUM_TYPE_UINT8 PCD_DATUM_TYPE_UINT16 PCD_DATUM_TYPE_UINT32 PCD_DATUM_TYPE_UINT64 Offset : indicate the related offset of PCD value in PCD database array. Based on local token number, PCD driver could fast determine PCD type, value type and get PCD entry from PCD database. 3.3 PCD Database C structure. PCD Database C structure is generated by build tools in PCD driver's autogen.h/ autogen.c file. In generated C structure, following information is stored: - ExMapTable: This table is used translate a binary dynamicex type PCD's "tokenguid + token" to local token number. - LocalTokenNumberTable: This table stores all local token number in array, use "Internal token number" as array index to get PCD entry's offset fastly. - SizeTable: This table stores the size information for all PCD entry. - GuidTable: This table stores guid value for DynamicEx's token space, HII type PCD's variable. - SkuIdTable: TBD - SystemSkuId: TBD - PCD value structure: Every PCD has a value record in PCD database. For different datum type PCD has different record structure which will be introduced in 3.3.1 In a PCD database structure, there are two major area: Init and UnInit. Init area is use stored above PCD internal structure such as ExMapTable, LocalTokenNumberTable etc and the (default) value of PCD which has default value specified in platform DSC file. Unint area is used stored the value of PCD which has no default value in platform DSC file, the value of NULL, 0 specified in platform DSC file can be seemed as "no default value". 3.3.1 Simple Sample PCD Database C Structure A general sample of PCD database structue is as follows: typedef struct _PCD_DATABASE { typedef struct _PCD_DATABASE_INIT { //===== Following is PCD database internal maintain structures DYNAMICEX_MAPPING ExMapTable[PEI_EXMAPPING_TABLE_SIZE]; UINT32 LocalTokenNumberTable[PEI_LOCAL_TOKEN_NUMBER_TABLE_SIZE]; GUID GuidTable[PEI_GUID_TABLE_SIZE]; SIZE_INFO SizeTable[PEI_SIZE_TABLE_SIZE]; UINT8 SkuIdTable[PEI_SKUID_TABLE_SIZE]; SKU_ID SystemSkuId; //===== Following is value structure for PCD with default value .... .... .... } Init; typedef struct _PCD_DATABSE_UNINIT { //==== Following is value structure for PCD without default value .... .... } UnInit; } 3.3.2 PCD value structure in PCD database C structure The value's structure is generated by build tool in PCD database C structure. The PCDs in different datum type has different value structure. 3.3.2.1 UINT8/UINT16/UINT32/UINT64 datum type PCD The C structure for these datum type PCD is just a UINT8/UINT16/UINT32/UINT64 data member in PCD database, For example: UINT16 PcdHardwareErrorRecordLevel_d3705011_bc19_4af7_be16_f68030378c15_VariableDefault_0; Above structure is generated by build tool, the member name is "PcdCName_Guidvalue" Member type is UINT16 according to PcdHardwareErrorRecordLevel declaration in DEC file. 3.3.2.2 VOID* datum type PCD The value of VOID* datum type PCD is a UINT8/UINT16 array in PCD database. 3.3.2.2.1 VOID* - string type If the default value for VOID* datum type PCD like L"xxx", the PCD is used for unicode string, and C structure of this datum type PCD is UINT16 string array in PCD database, for example: UINT16 StringTable[29]; The number of 29 in above sample is max size of a unicode string. If the default value for VOID* datum type PCD like "xxx", the PCD is used for ascii string, and C structure of this datum type PCD is UINT8 string array in PCD database, for example: UINT8 StringTable[20]; The number of 20 in above sample is max size of a ascii string. 3.3.2.2.2 VOID* - byte array If the default value of VOID* datum type PCD like {'0x29', '0x01', '0xf2'} the PCD is used for byte array. The generated structrue is same as above ascii string table, UINT8 StringTable[13]; The number of 13 in above sample is max size of byte array. **/