| 1 | /** @file
|
|---|
| 2 | Platform Configuration Database (PCD) Info Ppi defined in PI 1.2.1 Vol3.
|
|---|
| 3 |
|
|---|
| 4 | The PPI that provides additional information about items that reside in the PCD database.
|
|---|
| 5 |
|
|---|
| 6 | Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>
|
|---|
| 7 | SPDX-License-Identifier: BSD-2-Clause-Patent
|
|---|
| 8 |
|
|---|
| 9 | @par Revision Reference:
|
|---|
| 10 | PI Version 1.2.1 Vol 3.
|
|---|
| 11 | **/
|
|---|
| 12 |
|
|---|
| 13 | #ifndef __PI_PCD_INFO_PPI_H__
|
|---|
| 14 | #define __PI_PCD_INFO_PPI_H__
|
|---|
| 15 |
|
|---|
| 16 | extern EFI_GUID gEfiGetPcdInfoPpiGuid;
|
|---|
| 17 |
|
|---|
| 18 | #define EFI_GET_PCD_INFO_PPI_GUID \
|
|---|
| 19 | { 0xa60c6b59, 0xe459, 0x425d, { 0x9c, 0x69, 0xb, 0xcc, 0x9c, 0xb2, 0x7d, 0x81 } }
|
|---|
| 20 |
|
|---|
| 21 | ///
|
|---|
| 22 | /// The forward declaration for EFI_GET_PCD_INFO_PPI.
|
|---|
| 23 | ///
|
|---|
| 24 | typedef struct _EFI_GET_PCD_INFO_PPI EFI_GET_PCD_INFO_PPI;
|
|---|
| 25 |
|
|---|
| 26 | /**
|
|---|
| 27 | Retrieve additional information associated with a PCD token.
|
|---|
| 28 |
|
|---|
| 29 | This includes information such as the type of value the TokenNumber is associated with as well as possible
|
|---|
| 30 | human readable name that is associated with the token.
|
|---|
| 31 |
|
|---|
| 32 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
|
|---|
| 33 | @param[in] TokenNumber The PCD token number.
|
|---|
| 34 | @param[out] PcdInfo The returned information associated with the requested TokenNumber.
|
|---|
| 35 |
|
|---|
| 36 | @retval EFI_SUCCESS The PCD information was returned successfully
|
|---|
| 37 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
|
|---|
| 38 | **/
|
|---|
| 39 | typedef
|
|---|
| 40 | EFI_STATUS
|
|---|
| 41 | (EFIAPI *EFI_GET_PCD_INFO_PPI_GET_INFO) (
|
|---|
| 42 | IN CONST EFI_GUID *Guid,
|
|---|
| 43 | IN UINTN TokenNumber,
|
|---|
| 44 | OUT EFI_PCD_INFO *PcdInfo
|
|---|
| 45 | );
|
|---|
| 46 |
|
|---|
| 47 | /**
|
|---|
| 48 | Retrieve the currently set SKU Id.
|
|---|
| 49 |
|
|---|
| 50 | @return The currently set SKU Id. If the platform has not set at a SKU Id, then the
|
|---|
| 51 | default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU
|
|---|
| 52 | Id is returned.
|
|---|
| 53 | **/
|
|---|
| 54 | typedef
|
|---|
| 55 | UINTN
|
|---|
| 56 | (EFIAPI *EFI_GET_PCD_INFO_PPI_GET_SKU) (
|
|---|
| 57 | VOID
|
|---|
| 58 | );
|
|---|
| 59 |
|
|---|
| 60 | ///
|
|---|
| 61 | /// This is the PCD service to use when querying for some additional data that can be contained in the
|
|---|
| 62 | /// PCD database.
|
|---|
| 63 | ///
|
|---|
| 64 | struct _EFI_GET_PCD_INFO_PPI {
|
|---|
| 65 | ///
|
|---|
| 66 | /// Retrieve additional information associated with a PCD.
|
|---|
| 67 | ///
|
|---|
| 68 | EFI_GET_PCD_INFO_PPI_GET_INFO GetInfo;
|
|---|
| 69 | ///
|
|---|
| 70 | /// Retrieve the currently set SKU Id.
|
|---|
| 71 | ///
|
|---|
| 72 | EFI_GET_PCD_INFO_PPI_GET_SKU GetSku;
|
|---|
| 73 | };
|
|---|
| 74 |
|
|---|
| 75 | #endif
|
|---|
| 76 |
|
|---|
