Include/Protocol/PiPcd.h

35   For each item (token), the database can hold a single value that applies to all SKUs, or multiple
39   not SKU enabled, the system ignores any set SKU Id and works with the single value for that token.
41 …Id is set or the currently set SKU Id isn't valid for the specified token, the system uses the def…
54   Retrieves an 8-bit value for a given PCD token.
58   @param[in]    TokenNumber The PCD token number.
60   @return 8-bit value for a given PCD token.
70   Retrieves the current word-sized value for a PCD token number.
74   @param[in]    TokenNumber The PCD token number.
76   @return word-sized value for a given PCD token.
86   Retrieves the current 32-bit sized value for a PCD token number.
90   @param[in]    TokenNumber The PCD token number.
92   @return 32-bit value for a given PCD token.
102   Retrieves the 64-bit sized value for a PCD token number.
106   @param[in]    TokenNumber The PCD token number.
108   @return 64-bit value for a given PCD token.
119   Retrieves the current pointer to the value for a PCD token number. Do not make any assumptions
124   @param[in]    TokenNumber The PCD token number.
126   @return pointer to a value for a given PCD token.
136   Retrieves the current BOOLEAN-sized value for a PCD token number. If the TokenNumber is
140   @param[in]    TokenNumber The PCD token number.
142   @return Boolean value for a given PCD token.
152 …Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results a…
156   @param[in]    TokenNumber The PCD token number.
158   @return the size of the value for a given PCD token.
168   Sets an 8-bit value for a given PCD token.
171   compatible with the Token's existing definition. If it is not, an error will be returned.
174   @param[in]    TokenNumber The PCD token number.
175   @param[in]    Value       The value to set for the PCD token.
181   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
192   Sets an 16-bit value for a given PCD token.
195   compatible with the Token's existing definition. If it is not, an error will be returned.
198   @param[in]    TokenNumber The PCD token number.
199   @param[in]    Value       The value to set for the PCD token.
205   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
216   Sets an 32-bit value for a given PCD token.
219   compatible with the Token's existing definition. If it is not, an error will be returned.
222   @param[in]    TokenNumber The PCD token number.
223   @param[in]    Value       The value to set for the PCD token.
229   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
240   Sets an 64-bit value for a given PCD token.
243   compatible with the Token's existing definition. If it is not, an error will be returned.
246   @param[in]    TokenNumber The PCD token number.
247   @param[in]    Value       The value to set for the PCD token.
253   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
264   Sets a value of a specified size for a given PCD token.
267   compatible with the Token's existing definition. If it is not, an error will be returned.
270   @param[in]    TokenNumber The PCD token number.
271 …@param[in]    SizeOfValue The length of the value being set for the PCD token. If too large of a l…
273                             reflect the maximum size for the PCD token.
274   @param[in]    Buffer      A pointer to the buffer containing the value to set for the PCD token.
280   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
292   Sets a Boolean value for a given PCD token.
295   compatible with the Token's existing definition. If it is not, an error will be returned.
298   @param[in]    TokenNumber The PCD token number.
299   @param[in]    Value       The value to set for the PCD token.
305   @retval   EFI_NOT_FOUND           The PCD service could not find the requested token number.
325   Specifies a function to be called anytime the value of a designated token is changed.
328   @param[in]    CallBackToken     The PCD token number to monitor.
332   @retval EFI_NOT_FOUND   The PCD service could not find the referenced token number.
346   @param[in]    CallBackToken     The PCD token number to monitor.
350   @retval EFI_NOT_FOUND   The PCD service could not find the referenced token number.
361   Gets the next valid token number in a given namespace. This is useful since the PCD infrastructure
362   contains a sparse list of token numbers, and one cannot a priori know what token numbers are valid
365 …      The 128-bit unique value that designates the namespace from which to retrieve the next token.
366 …param[in]    TokenNumber       A pointer to the PCD token number to use to find the subsequent tok…
367 …                   retrieve the "first" token, have the pointer reference a TokenNumber value of 0.
369   @retval EFI_NOT_FOUND         The PCD service could not find data from the requested token number.
379   Gets the next valid token namespace for a given namespace. This is useful to traverse the valid
380   token namespaces on a platform.
382 …@param[in, out]   Guid    An indirect pointer to EFI_GUID. On input it designates a known token na…
383 …                    from which the search will start. On output, it designates the next valid token
384 …                      namespace on the platform. If *Guid is NULL, then the GUID of the first token
386 …                         token namespace, an error is returned and the value of *Guid is undefined.
389   @retval   EFI_NOT_FOUND The PCD service could not find the next valid token namespace.