diff options
| author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-17 03:43:28 +0000 |
|---|---|---|
| committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-17 03:43:28 +0000 |
| commit | a7c5092fc5cfbb674af264a5e96266698792606c (patch) | |
| tree | e31fb156a66cf08e487f1deecb7e2748a36ac869 /MdePkg/Include/Ppi/Pcd.h | |
| parent | 56fe62ce9df879062f3e1e9882c6e227304aeda4 (diff) | |
| download | edk2-platforms-a7c5092fc5cfbb674af264a5e96266698792606c.tar.xz | |
Add in function description and comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1026 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Ppi/Pcd.h')
| -rw-r--r-- | MdePkg/Include/Ppi/Pcd.h | 549 |
1 files changed, 544 insertions, 5 deletions
diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h index 2050d659de..97d487e249 100644 --- a/MdePkg/Include/Ppi/Pcd.h +++ b/MdePkg/Include/Ppi/Pcd.h @@ -24,54 +24,190 @@ extern EFI_GUID gPcdPpiGuid; #define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)
+
+
+/**
+ 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 SkuId The SKU value that will be used when the PCD service will retrieve and
+ set values associated with a PCD token.
+
+ @retval VOID
+
+**/
typedef
VOID
(EFIAPI *PCD_PPI_SET_SKU) (
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 TokenNumber The PCD token number.
+
+ @return The UINT8 value.
+
+**/
typedef
UINT8
(EFIAPI *PCD_PPI_GET8) (
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 TokenNumber The PCD token number.
+
+ @return The UINT16 value.
+
+**/
typedef
UINT16
(EFIAPI *PCD_PPI_GET16) (
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 TokenNumber The PCD token number.
+
+ @return The UINT32 value.
+
+**/
typedef
UINT32
(EFIAPI *PCD_PPI_GET32) (
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 TokenNumber The PCD token number.
+
+ @return The UINT64 value.
+
+**/
typedef
UINT64
(EFIAPI *PCD_PPI_GET64) (
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 TokenNumber The PCD token number.
+
+ @return The pointer to the buffer to be retrived.
+
+**/
typedef
VOID *
(EFIAPI *PCD_PPI_GET_POINTER) (
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 TokenNumber The PCD token number.
+
+ @return The Boolean value.
+
+**/
typedef
BOOLEAN
(EFIAPI *PCD_PPI_GET_BOOLEAN) (
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 TokenNumber The PCD token number.
+
+ @return The size of the value for the PCD token.
+
+**/
typedef
UINTN
(EFIAPI *PCD_PPI_GET_SIZE) (
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 Guid The token space for the token number.
+ @param TokenNumber The PCD token number.
+
+ @return The size 8-bit value for the PCD token.
+
+**/
typedef
UINT8
(EFIAPI *PCD_PPI_GET_EX_8) (
@@ -79,6 +215,22 @@ UINT8 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 Guid The token space for the token number.
+ @param TokenNumber The PCD token number.
+
+ @return The size 16-bit value for the PCD token.
+
+**/
typedef
UINT16
(EFIAPI *PCD_PPI_GET_EX_16) (
@@ -86,6 +238,22 @@ UINT16 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 Guid The token space for the token number.
+ @param TokenNumber The PCD token number.
+
+ @return The size 32-bit value for the PCD token.
+
+**/
typedef
UINT32
(EFIAPI *PCD_PPI_GET_EX_32) (
@@ -93,6 +261,22 @@ UINT32 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 Guid The token space for the token number.
+ @param TokenNumber The PCD token number.
+
+ @return The size 64-bit value for the PCD token.
+
+**/
typedef
UINT64
(EFIAPI *PCD_PPI_GET_EX_64) (
@@ -100,6 +284,22 @@ UINT64 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 Guid The token space for the token number.
+ @param TokenNumber The PCD token number.
+
+ @return The pointer to the buffer to be retrived.
+
+**/
typedef
VOID *
(EFIAPI *PCD_PPI_GET_EX_POINTER) (
@@ -107,6 +307,22 @@ VOID * 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 Guid The token space for the token number.
+ @param TokenNumber The PCD token number.
+
+ @return The size Boolean value for the PCD token.
+
+**/
typedef
BOOLEAN
(EFIAPI *PCD_PPI_GET_EX_BOOLEAN) (
@@ -114,6 +330,20 @@ BOOLEAN 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 Guid The token space for the token number.
+ @param TokenNumber The PCD token number.
+
+ @return The size of the value for the PCD token.
+
+**/
typedef
UINTN
(EFIAPI *PCD_PPI_GET_EX_SIZE) (
@@ -121,6 +351,25 @@ UINTN 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 TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET8) (
@@ -128,6 +377,25 @@ EFI_STATUS 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 TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET16) (
@@ -135,6 +403,25 @@ EFI_STATUS 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 TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET32) (
@@ -142,6 +429,25 @@ EFI_STATUS 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 TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET64) (
@@ -149,6 +455,30 @@ EFI_STATUS 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 TokenNumber The PCD token number.
+ @param 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 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET_POINTER) (
@@ -157,6 +487,25 @@ EFI_STATUS 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 TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET_BOOLEAN) (
@@ -164,6 +513,26 @@ EFI_STATUS 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 Guid The 128-bit unique value that designates the namespace from which to extract the value.
+ @param TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET_EX_8) (
@@ -172,6 +541,26 @@ EFI_STATUS 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 Guid The 128-bit unique value that designates the namespace from which to extract the value.
+ @param TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET_EX_16) (
@@ -180,6 +569,26 @@ EFI_STATUS 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 Guid The 128-bit unique value that designates the namespace from which to extract the value.
+ @param TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET_EX_32) (
@@ -188,6 +597,26 @@ EFI_STATUS 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 Guid The 128-bit unique value that designates the namespace from which to extract the value.
+ @param TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET_EX_64) (
@@ -196,6 +625,30 @@ EFI_STATUS 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 Guid The 128-bit unique value that designates the namespace from which to extract the value.
+ @param TokenNumber The PCD token number.
+ @param 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 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET_EX_POINTER) (
@@ -205,6 +658,26 @@ EFI_STATUS 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 Guid The 128-bit unique value that designates the namespace from which to extract the value.
+ @param TokenNumber The PCD token number.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_SET_EX_BOOLEAN) (
@@ -213,17 +686,19 @@ EFI_STATUS IN BOOLEAN Value
);
+
+
/**
Callback on SET function prototype definition.
- @param[in] CallBackGuid The PCD token GUID being set.
- @param[in] CallBackToken The PCD token number being set.
- @param[in] TokenData A pointer to the token data being set.
- @param[in] TokenDataSize The size, in bytes, of the data being set.
+ @param CallBackGuid The PCD token GUID being set.
+ @param CallBackToken The PCD token number being set.
+ @param TokenData A pointer to the token data being set.
+ @param TokenDataSize The size, in bytes, of the data being set.
@retval VOID
---*/
+**/
typedef
VOID
(EFIAPI *PCD_PPI_CALLBACK) (
@@ -233,6 +708,20 @@ VOID IN UINTN TokenDataSize
);
+
+
+/**
+ Specifies a function to be called anytime the value of a designated token is changed.
+
+ @param TokenNumber The PCD token number.
+ @param Guid The 128-bit unique value that designates the namespace from which to extract the value.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_CALLBACK_ONSET) (
@@ -241,6 +730,20 @@ EFI_STATUS IN PCD_PPI_CALLBACK CallBackFunction
);
+
+
+/**
+ Cancels a previously set callback function for a particular PCD token number.
+
+ @param TokenNumber The PCD token number.
+ @param Guid The 128-bit unique value that designates the namespace from which to extract the value.
+ @param 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.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_CANCEL_CALLBACK) (
@@ -249,6 +752,19 @@ EFI_STATUS IN PCD_PPI_CALLBACK CallBackFunction
);
+
+
+/**
+ Retrieves the next valid PCD token for a given namespace.
+
+ @param Guid The 128-bit unique value that designates the namespace from which to extract the value.
+ @param 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 retrieved the value requested.
+ @retval EFI_NOT_FOUND The PCD service could not find data from the requested token number.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_GET_NEXT_TOKEN) (
@@ -256,12 +772,35 @@ EFI_STATUS IN OUT UINTN *TokenNumber
);
+
+
+/**
+ Retrieves the next valid PCD token namespace for a given namespace.
+
+ @param 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 this input token namespace is the last tokenspace on the platform,
+ *Guid will be assigned to NULL and the function return EFI_SUCCESS.
+ If the search cannot locate the input 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 input token namespace.
+
+**/
typedef
EFI_STATUS
(EFIAPI *PCD_PPI_GET_NEXT_TOKENSPACE) (
IN OUT CONST EFI_GUID **Guid
);
+
+
+//
+// Interface structure for the PCD PPI
+//
typedef struct {
PCD_PPI_SET_SKU SetSku;
|