Lines Matching full:the
4 Different with the EFI_PCD_PROTOCOL defined in PI 1.2 specification, the native
6 The interfaces in dynamic type PCD do not require the token space guid as parameter,
28 Sets the SKU value for subsequent calls to set or get PCD token values.
30 SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values.
31 SetSku() is normally called only once by the system.
33 For each item (token), the database can hold a single value that applies to all SKUs,
37 The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255.
38 For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the
39 single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the
40 …last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specifi…
41 …the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value …
42 set for that Id, the results are unpredictable.
44 @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
58 Retrieves the current byte-sized value for a PCD token number.
59 If the TokenNumber is invalid, the results are unpredictable.
61 @param[in] TokenNumber The PCD token number.
63 @return The UINT8 value.
75 Retrieves the current 16-bit value for a PCD token number.
76 If the TokenNumber is invalid, the results are unpredictable.
78 @param[in] TokenNumber The PCD token number.
80 @return The UINT16 value.
92 Retrieves the current 32-bit value for a PCD token number.
93 If the TokenNumber is invalid, the results are unpredictable.
95 @param[in] TokenNumber The PCD token number.
97 @return The UINT32 value.
109 Retrieves the current 64-bit value for a PCD token number.
110 If the TokenNumber is invalid, the results are unpredictable.
112 @param[in] TokenNumber The PCD token number.
114 @return The UINT64 value.
126 Retrieves the current pointer to the buffer for a PCD token number.
127 Do not make any assumptions about the alignment of the pointer that
128 is returned by this function call. If the TokenNumber is invalid,
129 the results are unpredictable.
131 @param[in] TokenNumber The PCD token number.
133 @return The pointer to the buffer to be retrived.
145 Retrieves the current boolean value for a PCD token number.
146 Do not make any assumptions about the alignment of the pointer that
147 is returned by this function call. If the TokenNumber is invalid,
148 the results are unpredictable.
150 @param[in] TokenNumber The PCD token number.
152 @return The Boolean value.
162 Retrieves the size of the value for a given PCD token.
164 Retrieves the current size of a particular PCD token.
165 If the TokenNumber is invalid, the results are unpredictable.
167 @param[in] TokenNumber The PCD token number.
169 @return The size of the value for the PCD token.
181 Retrieves the 8-bit value of a particular PCD token.
182 If the TokenNumber is invalid or the token space
183 specified by Guid does not exist, the results are
186 @param[in] Guid The token space for the token number.
187 @param[in] TokenNumber The PCD token number.
189 @return The size 8-bit value for the PCD token.
202 Retrieves the 16-bit value of a particular PCD token.
203 If the TokenNumber is invalid or the token space
204 specified by Guid does not exist, the results are
207 @param[in] Guid The token space for the token number.
208 @param[in] TokenNumber The PCD token number.
210 @return The size 16-bit value for the PCD token.
223 Retrieves the 32-bit value of a particular PCD token.
224 If the TokenNumber is invalid or the token space
225 specified by Guid does not exist, the results are
228 @param[in] Guid The token space for the token number.
229 @param[in] TokenNumber The PCD token number.
231 @return The size 32-bit value for the PCD token.
244 Retrieves the 64-bit value of a particular PCD token.
245 If the TokenNumber is invalid or the token space
246 specified by Guid does not exist, the results are
249 @param[in] Guid The token space for the token number.
250 @param[in] TokenNumber The PCD token number.
252 @return The size 64-bit value for the PCD token.
265 Retrieves the current pointer to the buffer for a PCD token number.
266 Do not make any assumptions about the alignment of the pointer that
267 is returned by this function call. If the TokenNumber is invalid,
268 the results are unpredictable.
270 @param[in] Guid The token space for the token number.
271 @param[in] TokenNumber The PCD token number.
273 @return The pointer to the buffer to be retrieved.
286 Retrieves the Boolean value of a particular PCD token.
287 If the TokenNumber is invalid or the token space
288 specified by Guid does not exist, the results are
291 @param[in] Guid The token space for the token number.
292 @param[in] TokenNumber The PCD token number.
294 @return The size Boolean value for the PCD token.
305 Retrieves the size of the value for a given PCD token.
307 Retrieves the current size of a particular PCD token.
308 If the TokenNumber is invalid, the results are unpredictable.
310 @param[in] Guid The token space for the token number.
311 @param[in] TokenNumber The PCD token number.
313 @return The size of the value for the PCD token.
326 When the PCD service sets a value, it will check to ensure that the
327 size of the value being set is compatible with the Token's existing definition.
330 @param[in] TokenNumber The PCD token number.
331 @param[in] Value The value to set for the PCD token.
333 @retval EFI_SUCCESS The procedure returned successfully.
334 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
336 Use GetSize() to retrieve the size of the target data.
337 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
350 When the PCD service sets a value, it will check to ensure that the
351 size of the value being set is compatible with the Token's existing definition.
354 @param[in] TokenNumber The PCD token number.
355 @param[in] Value The value to set for the PCD token.
357 @retval EFI_SUCCESS The procedure returned successfully.
358 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
360 Use GetSize() to retrieve the size of the target data.
361 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
374 When the PCD service sets a value, it will check to ensure that the
375 size of the value being set is compatible with the Token's existing definition.
378 @param[in] TokenNumber The PCD token number.
379 @param[in] Value The value to set for the PCD token.
381 @retval EFI_SUCCESS The procedure returned successfully.
382 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
384 Use GetSize() to retrieve the size of the target data.
385 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
398 When the PCD service sets a value, it will check to ensure that the
399 size of the value being set is compatible with the Token's existing definition.
402 @param[in] TokenNumber The PCD token number.
403 @param[in] Value The value to set for the PCD token.
405 @retval EFI_SUCCESS The procedure returned successfully.
406 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
408 Use GetSize() to retrieve the size of the target data.
409 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
422 When the PCD service sets a value, it will check to ensure that the
423 size of the value being set is compatible with the Token's existing definition.
426 @param[in] TokenNumber The PCD token number.
427 @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token.
428 … On input, if the SizeOfValue is greater than the maximum size supported
429 … for this TokenNumber then the output value of SizeOfValue will reflect
430 the maximum size supported for this TokenNumber.
431 @param[in] Buffer The buffer to set for the PCD token.
433 @retval EFI_SUCCESS The procedure returned successfully.
434 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
436 Use GetSize() to retrieve the size of the target data.
437 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
451 When the PCD service sets a value, it will check to ensure that the
452 size of the value being set is compatible with the Token's existing definition.
455 @param[in] TokenNumber The PCD token number.
456 @param[in] Value The value to set for the PCD token.
458 @retval EFI_SUCCESS The procedure returned successfully.
459 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
461 Use GetSize() to retrieve the size of the target data.
462 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
475 When the PCD service sets a value, it will check to ensure that the
476 size of the value being set is compatible with the Token's existing definition.
479 …@param[in] Guid The 128-bit unique value that designates the namespace from which to extra…
480 @param[in] TokenNumber The PCD token number.
481 @param[in] Value The value to set for the PCD token.
483 @retval EFI_SUCCESS The procedure returned successfully.
484 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
486 Use GetSize() to retrieve the size of the target data.
487 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
501 When the PCD service sets a value, it will check to ensure that the
502 size of the value being set is compatible with the Token's existing definition.
505 …@param[in] Guid The 128-bit unique value that designates the namespace from which to extra…
506 @param[in] TokenNumber The PCD token number.
507 @param[in] Value The value to set for the PCD token.
509 @retval EFI_SUCCESS The procedure returned successfully.
510 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
512 Use GetSize() to retrieve the size of the target data.
513 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
527 When the PCD service sets a value, it will check to ensure that the
528 size of the value being set is compatible with the Token's existing definition.
531 …@param[in] Guid The 128-bit unique value that designates the namespace from which to extra…
532 @param[in] TokenNumber The PCD token number.
533 @param[in] Value The value to set for the PCD token.
535 @retval EFI_SUCCESS The procedure returned successfully.
536 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
538 Use GetSize() to retrieve the size of the target data.
539 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
553 When the PCD service sets a value, it will check to ensure that the
554 size of the value being set is compatible with the Token's existing definition.
557 …@param[in] Guid The 128-bit unique value that designates the namespace from which to extra…
558 @param[in] TokenNumber The PCD token number.
559 @param[in] Value The value to set for the PCD token.
561 @retval EFI_SUCCESS The procedure returned successfully.
562 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
564 Use GetSize() to retrieve the size of the target data.
565 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
579 When the PCD service sets a value, it will check to ensure that the
580 size of the value being set is compatible with the Token's existing definition.
583 …@param[in] Guid The 128-bit unique value that designates the namespace from which to e…
584 @param[in] TokenNumber The PCD token number.
585 @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token.
586 … On input, if the SizeOfValue is greater than the maximum size supported
587 for this TokenNumber then the output value of SizeOfValue will reflect
588 the maximum size supported for this TokenNumber.
589 @param[in] Buffer The buffer to set for the PCD token.
591 @retval EFI_SUCCESS The procedure returned successfully.
592 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
594 Use GetSize() to retrieve the size of the target data.
595 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
610 When the PCD service sets a value, it will check to ensure that the
611 size of the value being set is compatible with the Token's existing definition.
614 …@param[in] Guid The 128-bit unique value that designates the namespace from which to extra…
615 @param[in] TokenNumber The PCD token number.
616 @param[in] Value The value to set for the PCD token.
618 @retval EFI_SUCCESS The procedure returned successfully.
619 @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data
621 Use GetSize() to retrieve the size of the target data.
622 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
637 Firstly, it notifies the module which did the registration that the value
638 of this PCD token has been set. Secondly, it provides a mechanism for the
639 module that did the registration to intercept the set operation and override
640 the value that has been set, if necessary. After the invocation of the callback function,
641 TokenData will be used by PCD service DXE driver to modify the internal data in
644 @param[in] CallBackGuid The PCD token GUID being set.
645 @param[in] CallBackToken The PCD token number being set.
646 @param[in, out] TokenData A pointer to the token data being set.
647 @param[in] TokenDataSize The size, in bytes, of the data being set.
662 Specifies a function to be called anytime the value of a designated token is changed.
664 @param[in] TokenNumber The PCD token number.
665 …@param[in] Guid The 128-bit unique value that designates the namespace from which to…
666 …@param[in] CallBackFunction The function prototype called when the value associated with the Cal…
668 @retval EFI_SUCCESS The PCD service has successfully established a call event
669 for the CallBackToken requested.
670 @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.
684 @param[in] TokenNumber The PCD token number.
685 …@param[in] Guid The 128-bit unique value that designates the namespace from which to …
686 …@param[in] CallBackFunction The function prototype called when the value associated with the Call…
688 @retval EFI_SUCCESS The PCD service has successfully established a call event
689 for the CallBackToken requested.
690 @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.
702 Retrieves the next valid token number in a given namespace.
704 This is useful since the PCD infrastructure contains a sparse list of token numbers,
705 and one cannot a priori know what token numbers are valid in the database.
707 …If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by G…
708 …If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by …
709 If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned.
710 …If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is return…
711 …The token numbers in the default token space may not be related to token numbers in token spaces t…
712 …If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is …
713 …If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT…
714 …If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned.
717 …@param[in] Guid The 128-bit unique value that designates the namespace from which to retri…
719 being made to retrieve tokens from the default token space.
721 … A pointer to the PCD token number to use to find the subsequent token number.
723 @retval EFI_SUCCESS The PCD service has retrieved the next valid token number.
724 @retval EFI_NOT_FOUND The PCD service could not find data from the requested token number.
735 Retrieves the next valid PCD token namespace for a given namespace.
737 Gets the next valid token namespace for a given namespace. This is useful to traverse the valid
741 … from which the search will start. On output, it designates the next valid token
742 … namespace on the platform. If *Guid is NULL, then the GUID of the first token
743 … space of the current platform is returned. If the search cannot locate the next valid
744 … token namespace, an error is returned and the value of *Guid is undefined.
746 @retval EFI_SUCCESS The PCD service retrieved the value requested.
747 @retval EFI_NOT_FOUND The PCD service could not find the next valid token namespace.
757 /// This service abstracts the ability to set/get Platform Configuration Database (PCD).