MdePkg/Include/Ppi/PiPcd.h - third_party/edk2 - Git at Google

 /** @file
   Platform Configuration Database (PCD) PPI defined in PI 1.2 Vol3

   A platform database that contains a variety of current platform settings or
   directives that can be accessed by a driver or application.
   PI PCD ppi only provide the accessing interfaces for Dynamic-Ex type PCD.

   This is the base PCD service API that provides an abstraction for accessing configuration content in
   the platform. It a seamless mechanism for extracting information regardless of where the
   information is stored (such as in Read-only data, or an EFI Variable).
   This protocol allows access to data through size-granular APIs and provides a mechanism for a
   firmware component to monitor specific settings and be alerted when a setting is changed.

   Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>
   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.

   @par Revision Reference:
   PI Version 1.2 Vol 3.
 **/

 #ifndef __PI_PCD_PPI_H__
 #define __PI_PCD_PPI_H__

 extern EFI_GUID gEfiPeiPcdPpiGuid;

 #define EFI_PEI_PCD_PPI_GUID \
   { 0x1f34d25, 0x4de2, 0x23ad, { 0x3f, 0xf3, 0x36, 0x35, 0x3f, 0xf3, 0x23, 0xf1 } }

 #define EFI_PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)

 /**
   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 to set.
 **/
 typedef
 VOID
 (EFIAPI *EFI_PEI_PCD_PPI_SET_SKU)(
   IN UINTN SkuId
 );

 /**
   Retrieves the current byte-sized value for a PCD token number. If the TokenNumber is invalid,
   the results are unpredictable.

   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.

   @return 8-bit value for a given PCD token.
 **/
 typedef
 UINT8
 (EFIAPI *EFI_PEI_PCD_PPI_GET_8)(
   IN CONST  EFI_GUID  *Guid,
   IN        UINTN     TokenNumber
 );

 /**
   Retrieves the current word-sized value for a PCD token number. If the TokenNumber is invalid,
   the results are unpredictable.

   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.

   @return 16-bit value for a given PCD token.
 **/
 typedef
 UINT16
 (EFIAPI *EFI_PEI_PCD_PPI_GET_16)(
   IN CONST  EFI_GUID  *Guid,
   IN        UINTN     TokenNumber
 );

 /**
   Retrieves the current 32-bit value for a PCD token number. If the TokenNumber is invalid, the
   results are unpredictable.

   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.

   @return 32-bit value for a given PCD token.
 **/
 typedef
 UINT32
 (EFIAPI *EFI_PEI_PCD_PPI_GET_32)(
   IN CONST  EFI_GUID  *Guid,
   IN        UINTN     TokenNumber
 );

 /**
   Retrieves the current 64-bit value for a PCD token number. If the TokenNumber is invalid, the
   results are unpredictable.

   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.

   @return 64-bit value for a given PCD token.
 **/
 typedef
 UINT64
 (EFIAPI *EFI_PEI_PCD_PPI_GET_64)(
   IN CONST  EFI_GUID  *Guid,
   IN        UINTN     TokenNumber
 );

 /**
   Retrieves the current pointer to the value for a PCD token number. There should not be any
   alignment assumptions about the pointer that is returned by this function call. If the TokenNumber
   is invalid, the results are unpredictable.

   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.
 **/
 typedef
 VOID *
 (EFIAPI *EFI_PEI_PCD_PPI_GET_POINTER)(
   IN CONST  EFI_GUID  *Guid,
   IN        UINTN     TokenNumber
 );

 /**
   Retrieves the current Boolean-sized value for a PCD token number. If the TokenNumber is
   invalid, the results are unpredictable.

   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.

   @return Boolean value for a given PCD token.
 **/
 typedef
 BOOLEAN
 (EFIAPI *EFI_PEI_PCD_PPI_GET_BOOLEAN)(
   IN CONST  EFI_GUID  *Guid,
   IN        UINTN     TokenNumber
 );

 /**
   Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are
   unpredictable.

   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.

   @return the size of the value for a given PCD token.
 **/
 typedef
 UINTN
 (EFIAPI *EFI_PEI_PCD_PPI_GET_SIZE)(
   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]    Guid          The 128-bit unique value that designates which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.
   @param[in]    Value         The value to set for the PCD token.

   @retval   EFI_SUCCESS             The PCD service has set the value requested
   @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 GetSizeEx() to
                                     retrieve the size of the target data.
   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_SET_8)(
   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 which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.
   @param[in]    Value         The value to set for the PCD token.

   @retval   EFI_SUCCESS             The PCD service has set the value requested
   @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 GetSizeEx() to
                                     retrieve the size of the target data.
   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_SET_16)(
   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 which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.
   @param[in]    Value         The value to set for the PCD token.

   @retval   EFI_SUCCESS             The PCD service has set the value requested
   @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 GetSizeEx() to
                                     retrieve the size of the target data.
   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_SET_32)(
   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 which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.
   @param[in]    Value         The value to set for the PCD token.

   @retval   EFI_SUCCESS             The PCD service has set the value requested
   @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 GetSizeEx() to
                                     retrieve the size of the target data.
   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_SET_64)(
   IN CONST  EFI_GUID  *Guid,
   IN        UINTN     TokenNumber,
   IN        UINT64    Value
 );

 /**
   Sets a value of the 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 which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.
   @param[in]    SizeOfValue   The length of the value being set for the PCD token. If too large of a length is
                               specified, upon return from this function the value of SizeOfValue will reflect the
                               maximum size for the PCD token.
   @param[in]    Buffer        A pointer to the buffer containing the value to set for the PCD token.

   @retval   EFI_SUCCESS             The PCD service has set the value requested
   @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 GetSizeEx() to
                                     retrieve the size of the target data.
   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_SET_POINTER)(
   IN CONST  EFI_GUID  *Guid,
   IN        UINTN     TokenNumber,
   IN OUT    UINTN     *SizeOfValue,
   IN        VOID      *Buffer
 );

 /**
   Sets a 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 which namespace to extract the value from.
   @param[in]    TokenNumber   The PCD token number.
   @param[in]    Value         The value to set for the PCD token.

   @retval   EFI_SUCCESS             The PCD service has set the value requested
   @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 GetSizeEx() to
                                     retrieve the size of the target data.
   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_SET_BOOLEAN)(
   IN CONST  EFI_GUID  *Guid,
   IN        UINTN     TokenNumber,
   IN        BOOLEAN   Value
 );

 typedef
 VOID
 (EFIAPI *EFI_PEI_PCD_PPI_CALLBACK)(
   IN     EFI_GUID *Guid     OPTIONAL,
   IN     UINTN    CallBackToken,
   IN OUT VOID     *TokenData,
   IN     UINTN    TokenDatSize
 );

 /**
   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 which namespace to monitor. If NULL, use
                                   the standard platform namespace.
   @param[in]    CallBackToken     The PCD token number to monitor.
   @param[in]    CallBackFunction  The function prototype that will be 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.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_CALLBACK_ON_SET)(
   IN CONST  EFI_GUID                  *Guid   OPTIONAL,
   IN        UINTN                     CallBackToken,
   IN        EFI_PEI_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 which namespace to monitor. If NULL, use
                                 the standard platform namespace.
   @param[in]  CallBackToken     The PCD token number to cancel monitoring.
   @param[in]  CallBackFunction  The function prototype that was originally passed to the CallBackOnSet function.

   @retval     EFI_SUCCESS       The PCD service has cancelled the call event associated with the
                                 CallBackToken.
   @retval     EFI_INVALID_PARAMETER   The PCD service did not match the CallBackFunction to one
                                       that is currently being monitored.
   @retval     EFI_NOT_FOUND     The PCD service could not find data the requested token number.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_CANCEL_CALLBACK)(
   IN CONST  EFI_GUID                  *Guid   OPTIONAL,
   IN        UINTN                     CallBackToken,
   IN        EFI_PEI_PCD_PPI_CALLBACK  CallBackFunction
 );

 /**
   Retrieves the next valid PCD token for a given namespace.

   This provides a means by which to get the next valid token number in a given namespace. This is
   useful since the PCD infrastructure has a sparse list of token numbers in it, and one cannot a priori
   know what token numbers are valid in the database.

   @param[in]    Guid          The 128-bit unique value that designates which namespace to extract the value from.
   @param[in]    TokenNumber   A pointer to the PCD token number to use to find the subsequent token number. To
                               retrieve the "first" token, have the pointer reference a TokenNumber value of 0.

   @retval   EFI_SUCCESS       The PCD service has retrieved the value requested.
   @retval   EFI_NOT_FOUND     The PCD service could not find data from the requested token number.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_GET_NEXT_TOKEN)(
   IN CONST  EFI_GUID      *Guid     OPTIONAL,
   IN        UINTN         *TokenNumber
 );

 /**
   Retrieves the next valid PCD token namespace for a given namespace.

   Gets the next valid token namespace for a given namespace. This is useful to traverse the valid
   token namespaces on a platform.

   @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 *Guid is NULL, then the GUID of the first token
                             space of the current platform is returned. If the search cannot locate the next valid
                             token namespace, an error is returned and the value of *Guid is undefined.

   @retval  EFI_SUCCESS      The PCD service retrieved the value requested.
   @retval  EFI_NOT_FOUND    The PCD service could not find the next valid token namespace.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PEI_PCD_PPI_GET_NEXT_TOKEN_SPACE)(
   IN OUT CONST EFI_GUID     **Guid
 );

 typedef struct {
   EFI_PEI_PCD_PPI_SET_SKU               SetSku;
   EFI_PEI_PCD_PPI_GET_8                 Get8;
   EFI_PEI_PCD_PPI_GET_16                Get16;
   EFI_PEI_PCD_PPI_GET_32                Get32;
   EFI_PEI_PCD_PPI_GET_64                Get64;
   EFI_PEI_PCD_PPI_GET_POINTER           GetPtr;
   EFI_PEI_PCD_PPI_GET_BOOLEAN           GetBool;
   EFI_PEI_PCD_PPI_GET_SIZE              GetSize;
   EFI_PEI_PCD_PPI_SET_8                 Set8;
   EFI_PEI_PCD_PPI_SET_16                Set16;
   EFI_PEI_PCD_PPI_SET_32                Set32;
   EFI_PEI_PCD_PPI_SET_64                Set64;
   EFI_PEI_PCD_PPI_SET_POINTER           SetPtr;
   EFI_PEI_PCD_PPI_SET_BOOLEAN           SetBool;
   EFI_PEI_PCD_PPI_CALLBACK_ON_SET       CallbackOnSet;
   EFI_PEI_PCD_PPI_CANCEL_CALLBACK       CancelCallback;
   EFI_PEI_PCD_PPI_GET_NEXT_TOKEN        GetNextToken;
   EFI_PEI_PCD_PPI_GET_NEXT_TOKEN_SPACE  GetNextTokenSpace;
 } EFI_PEI_PCD_PPI;

 #endif
	/** @file
	Platform Configuration Database (PCD) PPI defined in PI 1.2 Vol3

	A platform database that contains a variety of current platform settings or
	directives that can be accessed by a driver or application.
	PI PCD ppi only provide the accessing interfaces for Dynamic-Ex type PCD.

	This is the base PCD service API that provides an abstraction for accessing configuration content in
	the platform. It a seamless mechanism for extracting information regardless of where the
	information is stored (such as in Read-only data, or an EFI Variable).
	This protocol allows access to data through size-granular APIs and provides a mechanism for a
	firmware component to monitor specific settings and be alerted when a setting is changed.

	Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>
	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.

	@par Revision Reference:
	PI Version 1.2 Vol 3.
	**/

	#ifndef __PI_PCD_PPI_H__
	#define __PI_PCD_PPI_H__

	extern EFI_GUID gEfiPeiPcdPpiGuid;

	#define EFI_PEI_PCD_PPI_GUID \
	{ 0x1f34d25, 0x4de2, 0x23ad, { 0x3f, 0xf3, 0x36, 0x35, 0x3f, 0xf3, 0x23, 0xf1 } }

	#define EFI_PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)

	/**
	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 to set.
	**/
	typedef
	VOID
	(EFIAPI *EFI_PEI_PCD_PPI_SET_SKU)(
	IN UINTN SkuId
	);

	/**
	Retrieves the current byte-sized value for a PCD token number. If the TokenNumber is invalid,
	the results are unpredictable.

	@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.

	@return 8-bit value for a given PCD token.
	**/
	typedef
	UINT8
	(EFIAPI *EFI_PEI_PCD_PPI_GET_8)(
	IN CONST EFI_GUID *Guid,
	IN UINTN TokenNumber
	);

	/**
	Retrieves the current word-sized value for a PCD token number. If the TokenNumber is invalid,
	the results are unpredictable.

	@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.

	@return 16-bit value for a given PCD token.
	**/
	typedef
	UINT16
	(EFIAPI *EFI_PEI_PCD_PPI_GET_16)(
	IN CONST EFI_GUID *Guid,
	IN UINTN TokenNumber
	);

	/**
	Retrieves the current 32-bit value for a PCD token number. If the TokenNumber is invalid, the
	results are unpredictable.

	@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.

	@return 32-bit value for a given PCD token.
	**/
	typedef
	UINT32
	(EFIAPI *EFI_PEI_PCD_PPI_GET_32)(
	IN CONST EFI_GUID *Guid,
	IN UINTN TokenNumber
	);

	/**
	Retrieves the current 64-bit value for a PCD token number. If the TokenNumber is invalid, the
	results are unpredictable.

	@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.

	@return 64-bit value for a given PCD token.
	**/
	typedef
	UINT64
	(EFIAPI *EFI_PEI_PCD_PPI_GET_64)(
	IN CONST EFI_GUID *Guid,
	IN UINTN TokenNumber
	);

	/**
	Retrieves the current pointer to the value for a PCD token number. There should not be any
	alignment assumptions about the pointer that is returned by this function call. If the TokenNumber
	is invalid, the results are unpredictable.

	@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.
	**/
	typedef
	VOID *
	(EFIAPI *EFI_PEI_PCD_PPI_GET_POINTER)(
	IN CONST EFI_GUID *Guid,
	IN UINTN TokenNumber
	);

	/**
	Retrieves the current Boolean-sized value for a PCD token number. If the TokenNumber is
	invalid, the results are unpredictable.

	@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.

	@return Boolean value for a given PCD token.
	**/
	typedef
	BOOLEAN
	(EFIAPI *EFI_PEI_PCD_PPI_GET_BOOLEAN)(
	IN CONST EFI_GUID *Guid,
	IN UINTN TokenNumber
	);

	/**
	Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are
	unpredictable.

	@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.

	@return the size of the value for a given PCD token.
	**/
	typedef
	UINTN
	(EFIAPI *EFI_PEI_PCD_PPI_GET_SIZE)(
	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] Guid The 128-bit unique value that designates which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.
	@param[in] Value The value to set for the PCD token.

	@retval EFI_SUCCESS The PCD service has set the value requested
	@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 GetSizeEx() to
	retrieve the size of the target data.
	@retval EFI_NOT_FOUND The PCD service could not find the requested token number.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_SET_8)(
	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 which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.
	@param[in] Value The value to set for the PCD token.

	@retval EFI_SUCCESS The PCD service has set the value requested
	@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 GetSizeEx() to
	retrieve the size of the target data.
	@retval EFI_NOT_FOUND The PCD service could not find the requested token number.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_SET_16)(
	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 which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.
	@param[in] Value The value to set for the PCD token.

	@retval EFI_SUCCESS The PCD service has set the value requested
	@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 GetSizeEx() to
	retrieve the size of the target data.
	@retval EFI_NOT_FOUND The PCD service could not find the requested token number.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_SET_32)(
	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 which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.
	@param[in] Value The value to set for the PCD token.

	@retval EFI_SUCCESS The PCD service has set the value requested
	@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 GetSizeEx() to
	retrieve the size of the target data.
	@retval EFI_NOT_FOUND The PCD service could not find the requested token number.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_SET_64)(
	IN CONST EFI_GUID *Guid,
	IN UINTN TokenNumber,
	IN UINT64 Value
	);

	/**
	Sets a value of the 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 which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.
	@param[in] SizeOfValue The length of the value being set for the PCD token. If too large of a length is
	specified, upon return from this function the value of SizeOfValue will reflect the
	maximum size for the PCD token.
	@param[in] Buffer A pointer to the buffer containing the value to set for the PCD token.

	@retval EFI_SUCCESS The PCD service has set the value requested
	@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 GetSizeEx() to
	retrieve the size of the target data.
	@retval EFI_NOT_FOUND The PCD service could not find the requested token number.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_SET_POINTER)(
	IN CONST EFI_GUID *Guid,
	IN UINTN TokenNumber,
	IN OUT UINTN *SizeOfValue,
	IN VOID *Buffer
	);

	/**
	Sets a 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 which namespace to extract the value from.
	@param[in] TokenNumber The PCD token number.
	@param[in] Value The value to set for the PCD token.

	@retval EFI_SUCCESS The PCD service has set the value requested
	@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 GetSizeEx() to
	retrieve the size of the target data.
	@retval EFI_NOT_FOUND The PCD service could not find the requested token number.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_SET_BOOLEAN)(
	IN CONST EFI_GUID *Guid,
	IN UINTN TokenNumber,
	IN BOOLEAN Value
	);

	typedef
	VOID
	(EFIAPI *EFI_PEI_PCD_PPI_CALLBACK)(
	IN EFI_GUID *Guid OPTIONAL,
	IN UINTN CallBackToken,
	IN OUT VOID *TokenData,
	IN UINTN TokenDatSize
	);

	/**
	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 which namespace to monitor. If NULL, use
	the standard platform namespace.
	@param[in] CallBackToken The PCD token number to monitor.
	@param[in] CallBackFunction The function prototype that will be 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.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_CALLBACK_ON_SET)(
	IN CONST EFI_GUID *Guid OPTIONAL,
	IN UINTN CallBackToken,
	IN EFI_PEI_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 which namespace to monitor. If NULL, use
	the standard platform namespace.
	@param[in] CallBackToken The PCD token number to cancel monitoring.
	@param[in] CallBackFunction The function prototype that was originally passed to the CallBackOnSet function.

	@retval EFI_SUCCESS The PCD service has cancelled the call event associated with the
	CallBackToken.
	@retval EFI_INVALID_PARAMETER The PCD service did not match the CallBackFunction to one
	that is currently being monitored.
	@retval EFI_NOT_FOUND The PCD service could not find data the requested token number.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_CANCEL_CALLBACK)(
	IN CONST EFI_GUID *Guid OPTIONAL,
	IN UINTN CallBackToken,
	IN EFI_PEI_PCD_PPI_CALLBACK CallBackFunction
	);

	/**
	Retrieves the next valid PCD token for a given namespace.

	This provides a means by which to get the next valid token number in a given namespace. This is
	useful since the PCD infrastructure has a sparse list of token numbers in it, and one cannot a priori
	know what token numbers are valid in the database.

	@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.
	@param[in] TokenNumber A pointer to the PCD token number to use to find the subsequent token number. To
	retrieve the "first" token, have the pointer reference a TokenNumber value of 0.

	@retval EFI_SUCCESS The PCD service has retrieved the value requested.
	@retval EFI_NOT_FOUND The PCD service could not find data from the requested token number.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_GET_NEXT_TOKEN)(
	IN CONST EFI_GUID *Guid OPTIONAL,
	IN UINTN *TokenNumber
	);

	/**
	Retrieves the next valid PCD token namespace for a given namespace.

	Gets the next valid token namespace for a given namespace. This is useful to traverse the valid
	token namespaces on a platform.

	@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 *Guid is NULL, then the GUID of the first token
	space of the current platform is returned. If the search cannot locate the next valid
	token namespace, an error is returned and the value of *Guid is undefined.

	@retval EFI_SUCCESS The PCD service retrieved the value requested.
	@retval EFI_NOT_FOUND The PCD service could not find the next valid token namespace.
	**/
	typedef
	EFI_STATUS
	(EFIAPI *EFI_PEI_PCD_PPI_GET_NEXT_TOKEN_SPACE)(
	IN OUT CONST EFI_GUID **Guid
	);

	typedef struct {
	EFI_PEI_PCD_PPI_SET_SKU SetSku;
	EFI_PEI_PCD_PPI_GET_8 Get8;
	EFI_PEI_PCD_PPI_GET_16 Get16;
	EFI_PEI_PCD_PPI_GET_32 Get32;
	EFI_PEI_PCD_PPI_GET_64 Get64;
	EFI_PEI_PCD_PPI_GET_POINTER GetPtr;
	EFI_PEI_PCD_PPI_GET_BOOLEAN GetBool;
	EFI_PEI_PCD_PPI_GET_SIZE GetSize;
	EFI_PEI_PCD_PPI_SET_8 Set8;
	EFI_PEI_PCD_PPI_SET_16 Set16;
	EFI_PEI_PCD_PPI_SET_32 Set32;
	EFI_PEI_PCD_PPI_SET_64 Set64;
	EFI_PEI_PCD_PPI_SET_POINTER SetPtr;
	EFI_PEI_PCD_PPI_SET_BOOLEAN SetBool;
	EFI_PEI_PCD_PPI_CALLBACK_ON_SET CallbackOnSet;
	EFI_PEI_PCD_PPI_CANCEL_CALLBACK CancelCallback;
	EFI_PEI_PCD_PPI_GET_NEXT_TOKEN GetNextToken;
	EFI_PEI_PCD_PPI_GET_NEXT_TOKEN_SPACE GetNextTokenSpace;
	} EFI_PEI_PCD_PPI;

	#endif