]>
Commit | Line | Data |
---|---|---|
96d6d004 SZ |
1 | /** @file\r |
2 | Platform Configuration Database (PCD) Info Ppi defined in PI 1.2.1 Vol3.\r | |
3 | \r | |
4 | The PPI that provides additional information about items that reside in the PCD database.\r | |
5 | \r | |
6 | Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r | |
7 | This program and the accompanying materials\r | |
8 | are licensed and made available under the terms and conditions of the BSD License\r | |
9 | which accompanies this distribution. The full text of the license may be found at\r | |
10 | http://opensource.org/licenses/bsd-license.php\r | |
11 | \r | |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
14 | \r | |
15 | @par Revision Reference:\r | |
16 | PI Version 1.2.1 Vol 3.\r | |
17 | **/\r | |
18 | \r | |
19 | #ifndef __PI_PCD_INFO_PPI_H__\r | |
20 | #define __PI_PCD_INFO_PPI_H__\r | |
21 | \r | |
22 | extern EFI_GUID gEfiGetPcdInfoPpiGuid;\r | |
23 | \r | |
24 | #define EFI_GET_PCD_INFO_PPI_GUID \\r | |
25 | { 0xa60c6b59, 0xe459, 0x425d, { 0x9c, 0x69, 0xb, 0xcc, 0x9c, 0xb2, 0x7d, 0x81 } }\r | |
26 | \r | |
27 | ///\r | |
28 | /// The forward declaration for EFI_GET_PCD_INFO_PPI.\r | |
29 | ///\r | |
30 | typedef struct _EFI_GET_PCD_INFO_PPI EFI_GET_PCD_INFO_PPI;\r | |
31 | \r | |
32 | /**\r | |
33 | Retrieve additional information associated with a PCD token.\r | |
34 | \r | |
35 | This includes information such as the type of value the TokenNumber is associated with as well as possible\r | |
36 | human readable name that is associated with the token.\r | |
37 | \r | |
38 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r | |
39 | @param[in] TokenNumber The PCD token number.\r | |
40 | @param[out] PcdInfo The returned information associated with the requested TokenNumber.\r | |
41 | \r | |
42 | @retval EFI_SUCCESS The PCD information was returned successfully\r | |
43 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r | |
44 | **/\r | |
45 | typedef\r | |
46 | EFI_STATUS\r | |
47 | (EFIAPI *EFI_GET_PCD_INFO_PPI_GET_INFO) (\r | |
48 | IN CONST EFI_GUID *Guid,\r | |
49 | IN UINTN TokenNumber,\r | |
50 | OUT EFI_PCD_INFO *PcdInfo\r | |
51 | );\r | |
52 | \r | |
53 | /**\r | |
54 | Retrieve the currently set SKU Id.\r | |
55 | \r | |
56 | @return The currently set SKU Id. If the platform has not set at a SKU Id, then the\r | |
57 | default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU\r | |
58 | Id is returned.\r | |
59 | **/\r | |
60 | typedef\r | |
61 | UINTN\r | |
62 | (EFIAPI *EFI_GET_PCD_INFO_PPI_GET_SKU) (\r | |
63 | VOID\r | |
64 | );\r | |
65 | \r | |
66 | ///\r | |
67 | /// This is the PCD service to use when querying for some additional data that can be contained in the\r | |
68 | /// PCD database.\r | |
69 | ///\r | |
70 | struct _EFI_GET_PCD_INFO_PPI {\r | |
71 | ///\r | |
72 | /// Retrieve additional information associated with a PCD.\r | |
73 | ///\r | |
74 | EFI_GET_PCD_INFO_PPI_GET_INFO GetInfo;\r | |
75 | ///\r | |
76 | /// Retrieve the currently set SKU Id.\r | |
77 | ///\r | |
78 | EFI_GET_PCD_INFO_PPI_GET_SKU GetSku;\r | |
79 | };\r | |
80 | \r | |
81 | #endif\r | |
82 | \r |