4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Native Platform Configuration Database (PCD) PPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Different with the EFI_PCD_PPI defined in PI 1.2 specification, the native
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PCD PPI provide interfaces for dynamic and dynamic-ex type PCD.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The interfaces for dynamic type PCD do not require the token space guid as parameter,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync but interfaces for dynamic-ex type PCD require token space guid as parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x6e81c58, 0x4ad7, 0x44bc, { 0x83, 0x90, 0xf1, 0x2, 0x65, 0xf7, 0x24, 0x80 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the SKU value for subsequent calls to set or get PCD token values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SetSku() is normally called only once by the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For each item (token), the database can hold a single value that applies to all SKUs,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or multiple values, where each value is associated with a specific SKU Id. Items with multiple,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SKU-specific values are called SKU enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set for that Id, the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set values associated with a PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves an 8-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the current byte-sized value for a PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid, the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The UINT8 value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a 16-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the current 16-bit value for a PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid, the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The UINT16 value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a 32-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the current 32-bit value for a PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid, the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The UINT32 value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a 64-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the current 64-bit value for a PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid, the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The UINT64 value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a pointer to a value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the current pointer to the buffer for a PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Do not make any assumptions about the alignment of the pointer that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned by this function call. If the TokenNumber is invalid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the buffer to be retrived.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a Boolean value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the current boolean value for a PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Do not make any assumptions about the alignment of the pointer that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned by this function call. If the TokenNumber is invalid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The Boolean value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the size of the value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the current size of a particular PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid, the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The size of the value for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves an 8-bit value for a given PCD token and token space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the 8-bit value of a particular PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid or the token space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Guid does not exist, the results are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The token space for the token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The size 8-bit value for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a 16-bit value for a given PCD token and token space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the 16-bit value of a particular PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid or the token space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Guid does not exist, the results are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The token space for the token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The size 16-bit value for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a 32-bit value for a given PCD token and token space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the 32-bit value of a particular PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid or the token space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Guid does not exist, the results are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The token space for the token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The size 32-bit value for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a 64-bit value for a given PCD token and token space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the 64-bit value of a particular PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid or the token space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Guid does not exist, the results are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The token space for the token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The size 64-bit value for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a pointer to a value for a given PCD token and token space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the current pointer to the buffer for a PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Do not make any assumptions about the alignment of the pointer that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned by this function call. If the TokenNumber is invalid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The token space for the token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the buffer to be retrived.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves an Boolean value for a given PCD token and token space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the Boolean value of a particular PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid or the token space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Guid does not exist, the results are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The token space for the token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The size Boolean value for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the size of the value for a given PCD token and token space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the current size of a particular PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TokenNumber is invalid, the results are unpredictable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The token space for the token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The size of the value for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets an 8-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets a 16-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets a 32-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets a 64-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets a value of a specified size for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SizeOfValue A pointer to the length of the value being set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On input, if the SizeOfValue is greater than the maximum size supported
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for this TokenNumber then the output value of SizeOfValue will reflect
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the maximum size supported for this TokenNumber.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buffer The buffer to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets an Boolean value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets an 8-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets a 16-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets a 32-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets a 64-bit value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets a value of a specified size for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SizeOfValue A pointer to the length of the value being set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On input, if the SizeOfValue is greater than the maximum size supported
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for this TokenNumber then the output value of SizeOfValue will reflect
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the maximum size supported for this TokenNumber.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buffer The buffer to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets an Boolean value for a given PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the PCD service sets a value, it will check to ensure that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the value being set is compatible with the Token's existing definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If it is not, an error will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The value to set for the PCD token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The procedure returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being set was incompatible with a call to this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use GetSize() to retrieve the size of the target data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Callback on SET function prototype definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This notification function serves two purposes. Firstly, it notifies the module
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which did the registration that the value of this PCD token has been set. Secondly,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it provides a mechanism for the module which did the registration to intercept the set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operation and override the value been set if necessary. After the invocation of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync callback function, TokenData will be used by PCD service PEIM to modify the internal data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in PCD database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallBackGuid The PCD token GUID being set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallBackToken The PCD token number being set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] TokenData A pointer to the token data being set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenDataSize The size, in bytes, of the data being set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specifies a function to be called anytime the value of a designated token is changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PCD service has successfully established a call event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the CallBackToken requested.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cancels a previously set callback function for a particular PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TokenNumber The PCD token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PCD service has successfully established a call event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the CallBackToken requested.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the next valid token number in a given namespace.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is useful since the PCD infrastructure contains a sparse list of token numbers,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and one cannot a priori know what token numbers are valid in the database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter that may be NULL. If this parameter is NULL, then a request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is being made to retrieve tokens from the default token space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PCD service has retrieved the next valid token number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Or the input token number is already the last valid token number in the PCD database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync In the later case, *TokenNumber is updated with the value of 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND If this input token number and token namespace does not exist on the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the next valid PCD token namespace for a given namespace.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If *Guid is NULL, then the GUID of the first token space of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current platform is assigned to *Guid the function return EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If *Guid is NULL and there is no namespace exist in the platform other than the default
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (NULL) tokennamespace, *Guid is unchanged and the function return EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this input token namespace is the last namespace on the platform,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *Guid will be assigned to NULL and the function return EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync token namespace from which the search will start. On output, it designates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the next valid token namespace on the platform. If the input token namespace
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync does not exist on the platform, an error is returned, and the value of *Guid is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PCD service has retrieved the next valid token namespace.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Or the input token namespace is already the last valid token
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number in the PCD database. In the later case, *Guid is updated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the value of NULL. Or the input token name space is NULL and there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is no valid token namespace other than the default namespace (NULL).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND If the input token namespace does not exist on the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This service abstracts the ability to set/get Platform Configuration Database (PCD).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {