]>
Commit | Line | Data |
---|---|---|
96d6d004 SZ |
1 | /** @file\r |
2 | Native Platform Configuration Database (PCD) INFO PROTOCOL.\r | |
3 | \r | |
4 | The protocol that provides additional information about items that reside in the PCD database.\r | |
5 | \r | |
6 | Different with the EFI_GET_PCD_INFO_PROTOCOL defined in PI 1.2.1 specification,\r | |
9095d37b | 7 | the native PCD INFO PROTOCOL provide interfaces for dynamic and dynamic-ex type PCD.\r |
96d6d004 SZ |
8 | The interfaces for dynamic type PCD do not require the token space guid as parameter,\r |
9 | but interfaces for dynamic-ex type PCD require token space guid as parameter.\r | |
10 | \r | |
9095d37b | 11 | Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 12 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
96d6d004 | 13 | \r |
497a5fb1 SZ |
14 | @par Revision Reference:\r |
15 | This Protocol was introduced in PI Specification 1.2.\r | |
16 | \r | |
96d6d004 SZ |
17 | **/\r |
18 | \r | |
19 | #ifndef __PCD_INFO_H__\r | |
20 | #define __PCD_INFO_H__\r | |
21 | \r | |
2f88bd3a | 22 | extern EFI_GUID gGetPcdInfoProtocolGuid;\r |
96d6d004 SZ |
23 | \r |
24 | #define GET_PCD_INFO_PROTOCOL_GUID \\r | |
25 | { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } }\r | |
26 | \r | |
27 | ///\r | |
28 | /// The forward declaration for GET_PCD_INFO_PROTOCOL.\r | |
29 | ///\r | |
2f88bd3a | 30 | typedef struct _GET_PCD_INFO_PROTOCOL GET_PCD_INFO_PROTOCOL;\r |
96d6d004 SZ |
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] TokenNumber The PCD token number.\r | |
39 | @param[out] PcdInfo The returned information associated with the requested TokenNumber.\r | |
40 | \r | |
41 | @retval EFI_SUCCESS The PCD information was returned successfully\r | |
42 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r | |
43 | **/\r | |
44 | typedef\r | |
45 | EFI_STATUS\r | |
2f88bd3a | 46 | (EFIAPI *GET_PCD_INFO_PROTOCOL_GET_INFO)(\r |
96d6d004 SZ |
47 | IN UINTN TokenNumber,\r |
48 | OUT EFI_PCD_INFO *PcdInfo\r | |
2f88bd3a | 49 | );\r |
96d6d004 SZ |
50 | \r |
51 | /**\r | |
52 | Retrieve additional information associated with a PCD token.\r | |
53 | \r | |
54 | This includes information such as the type of value the TokenNumber is associated with as well as possible\r | |
55 | human readable name that is associated with the token.\r | |
56 | \r | |
57 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r | |
58 | @param[in] TokenNumber The PCD token number.\r | |
59 | @param[out] PcdInfo The returned information associated with the requested TokenNumber.\r | |
60 | \r | |
61 | @retval EFI_SUCCESS The PCD information was returned successfully\r | |
62 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r | |
63 | **/\r | |
64 | typedef\r | |
65 | EFI_STATUS\r | |
2f88bd3a | 66 | (EFIAPI *GET_PCD_INFO_PROTOCOL_GET_INFO_EX)(\r |
96d6d004 SZ |
67 | IN CONST EFI_GUID *Guid,\r |
68 | IN UINTN TokenNumber,\r | |
69 | OUT EFI_PCD_INFO *PcdInfo\r | |
2f88bd3a | 70 | );\r |
96d6d004 SZ |
71 | \r |
72 | /**\r | |
73 | Retrieve the currently set SKU Id.\r | |
74 | \r | |
75 | @return The currently set SKU Id. If the platform has not set at a SKU Id, then the\r | |
76 | default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU\r | |
77 | Id is returned.\r | |
78 | **/\r | |
79 | typedef\r | |
80 | UINTN\r | |
2f88bd3a | 81 | (EFIAPI *GET_PCD_INFO_PROTOCOL_GET_SKU)(\r |
96d6d004 | 82 | VOID\r |
2f88bd3a | 83 | );\r |
96d6d004 SZ |
84 | \r |
85 | ///\r | |
86 | /// This is the PCD service to use when querying for some additional data that can be contained in the\r | |
87 | /// PCD database.\r | |
88 | ///\r | |
89 | struct _GET_PCD_INFO_PROTOCOL {\r | |
90 | ///\r | |
91 | /// Retrieve additional information associated with a PCD.\r | |
92 | ///\r | |
2f88bd3a MK |
93 | GET_PCD_INFO_PROTOCOL_GET_INFO GetInfo;\r |
94 | GET_PCD_INFO_PROTOCOL_GET_INFO_EX GetInfoEx;\r | |
96d6d004 SZ |
95 | ///\r |
96 | /// Retrieve the currently set SKU Id.\r | |
97 | ///\r | |
2f88bd3a | 98 | GET_PCD_INFO_PROTOCOL_GET_SKU GetSku;\r |
96d6d004 SZ |
99 | };\r |
100 | \r | |
101 | #endif\r |