]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Platform Configuration Database (PCD) Info Protocol defined in PI 1.2.1 Vol3.\r | |
3 | \r | |
4 | The protocol 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 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
8 | \r | |
9 | @par Revision Reference:\r | |
10 | PI Version 1.2.1 Vol 3.\r | |
11 | **/\r | |
12 | \r | |
13 | #ifndef __PI_PCD_INFO_H__\r | |
14 | #define __PI_PCD_INFO_H__\r | |
15 | \r | |
16 | extern EFI_GUID gEfiGetPcdInfoProtocolGuid;\r | |
17 | \r | |
18 | #define EFI_GET_PCD_INFO_PROTOCOL_GUID \\r | |
19 | { 0xfd0f4478, 0xefd, 0x461d, { 0xba, 0x2d, 0xe5, 0x8c, 0x45, 0xfd, 0x5f, 0x5e } }\r | |
20 | \r | |
21 | ///\r | |
22 | /// The forward declaration for EFI_GET_PCD_INFO_PROTOCOL.\r | |
23 | ///\r | |
24 | typedef struct _EFI_GET_PCD_INFO_PROTOCOL EFI_GET_PCD_INFO_PROTOCOL;\r | |
25 | \r | |
26 | /**\r | |
27 | Retrieve additional information associated with a PCD token.\r | |
28 | \r | |
29 | This includes information such as the type of value the TokenNumber is associated with as well as possible\r | |
30 | human readable name that is associated with the token.\r | |
31 | \r | |
32 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r | |
33 | @param[in] TokenNumber The PCD token number.\r | |
34 | @param[out] PcdInfo The returned information associated with the requested TokenNumber.\r | |
35 | \r | |
36 | @retval EFI_SUCCESS The PCD information was returned successfully\r | |
37 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r | |
38 | **/\r | |
39 | typedef\r | |
40 | EFI_STATUS\r | |
41 | (EFIAPI *EFI_GET_PCD_INFO_PROTOCOL_GET_INFO) (\r | |
42 | IN CONST EFI_GUID *Guid,\r | |
43 | IN UINTN TokenNumber,\r | |
44 | OUT EFI_PCD_INFO *PcdInfo\r | |
45 | );\r | |
46 | \r | |
47 | /**\r | |
48 | Retrieve the currently set SKU Id.\r | |
49 | \r | |
50 | @return The currently set SKU Id. If the platform has not set at a SKU Id, then the\r | |
51 | default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU\r | |
52 | Id is returned.\r | |
53 | **/\r | |
54 | typedef\r | |
55 | UINTN\r | |
56 | (EFIAPI *EFI_GET_PCD_INFO_PROTOCOL_GET_SKU) (\r | |
57 | VOID\r | |
58 | );\r | |
59 | \r | |
60 | ///\r | |
61 | /// Callers to this protocol must be at a TPL_APPLICATION task priority level.\r | |
62 | /// This is the PCD service to use when querying for some additional data that can be contained in the\r | |
63 | /// PCD database.\r | |
64 | ///\r | |
65 | struct _EFI_GET_PCD_INFO_PROTOCOL {\r | |
66 | ///\r | |
67 | /// Retrieve additional information associated with a PCD.\r | |
68 | ///\r | |
69 | EFI_GET_PCD_INFO_PROTOCOL_GET_INFO GetInfo;\r | |
70 | ///\r | |
71 | /// Retrieve the currently set SKU Id.\r | |
72 | ///\r | |
73 | EFI_GET_PCD_INFO_PROTOCOL_GET_SKU GetSku;\r | |
74 | };\r | |
75 | \r | |
76 | #endif\r | |
77 | \r |