]>
Commit | Line | Data |
---|---|---|
d00ed85e | 1 | /** @file\r |
2 | The file defined some common structures used for communicating between SMM variable module and SMM variable wrapper module.\r | |
3 | \r | |
efb01a10 | 4 | Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>\r |
fa0737a8 SZ |
5 | This program and the accompanying materials are licensed and made available under\r |
6 | the terms and conditions of the BSD License that accompanies this distribution.\r | |
d00ed85e | 7 | The full text of the license may be found at\r |
fa0737a8 | 8 | http://opensource.org/licenses/bsd-license.php.\r |
d00ed85e | 9 | \r |
fa0737a8 | 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
d00ed85e | 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _SMM_VARIABLE_COMMON_H_\r | |
16 | #define _SMM_VARIABLE_COMMON_H_\r | |
17 | \r | |
efb01a10 SZ |
18 | #include <Protocol/VarCheck.h>\r |
19 | \r | |
d00ed85e | 20 | #define EFI_SMM_VARIABLE_WRITE_GUID \\r |
21 | { 0x93ba1826, 0xdffb, 0x45dd, { 0x82, 0xa7, 0xe7, 0xdc, 0xaa, 0x3b, 0xbd, 0xf3 } }\r | |
22 | \r | |
23 | extern EFI_GUID gSmmVariableWriteGuid;\r | |
24 | \r | |
25 | //\r | |
fa0737a8 SZ |
26 | // This structure is used for SMM variable. the collected statistics data is saved in SMRAM. It can be got from\r |
27 | // SMI handler. The communication buffer should be:\r | |
d00ed85e | 28 | // EFI_SMM_COMMUNICATE_HEADER + SMM_VARIABLE_COMMUNICATE_HEADER + payload.\r |
29 | //\r | |
30 | typedef struct {\r | |
31 | UINTN Function;\r | |
32 | EFI_STATUS ReturnStatus;\r | |
33 | UINT8 Data[1];\r | |
34 | } SMM_VARIABLE_COMMUNICATE_HEADER;\r | |
35 | \r | |
36 | //\r | |
37 | // The payload for this function is SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.\r | |
38 | //\r | |
39 | #define SMM_VARIABLE_FUNCTION_GET_VARIABLE 1\r | |
40 | //\r | |
41 | // The payload for this function is SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME.\r | |
fa0737a8 | 42 | //\r |
d00ed85e | 43 | #define SMM_VARIABLE_FUNCTION_GET_NEXT_VARIABLE_NAME 2\r |
44 | //\r | |
45 | // The payload for this function is SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.\r | |
fa0737a8 | 46 | //\r |
d00ed85e | 47 | #define SMM_VARIABLE_FUNCTION_SET_VARIABLE 3\r |
48 | //\r | |
49 | // The payload for this function is SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO.\r | |
fa0737a8 | 50 | //\r |
d00ed85e | 51 | #define SMM_VARIABLE_FUNCTION_QUERY_VARIABLE_INFO 4\r |
52 | //\r | |
53 | // It is a notify event, no extra payload for this function.\r | |
fa0737a8 | 54 | //\r |
d00ed85e | 55 | #define SMM_VARIABLE_FUNCTION_READY_TO_BOOT 5\r |
56 | //\r | |
57 | // It is a notify event, no extra payload for this function.\r | |
fa0737a8 | 58 | //\r |
d00ed85e | 59 | #define SMM_VARIABLE_FUNCTION_EXIT_BOOT_SERVICE 6\r |
60 | //\r | |
fa0737a8 | 61 | // The payload for this function is VARIABLE_INFO_ENTRY. The GUID in EFI_SMM_COMMUNICATE_HEADER\r |
d00ed85e | 62 | // is gEfiSmmVariableProtocolGuid.\r |
63 | //\r | |
64 | #define SMM_VARIABLE_FUNCTION_GET_STATISTICS 7\r | |
ff843847 RN |
65 | //\r |
66 | // The payload for this function is SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE\r | |
67 | //\r | |
68 | #define SMM_VARIABLE_FUNCTION_LOCK_VARIABLE 8\r | |
d00ed85e | 69 | \r |
efb01a10 SZ |
70 | #define SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_SET 9\r |
71 | \r | |
72 | #define SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_GET 10\r | |
73 | \r | |
fa0737a8 SZ |
74 | #define SMM_VARIABLE_FUNCTION_GET_PAYLOAD_SIZE 11\r |
75 | \r | |
d00ed85e | 76 | ///\r |
77 | /// Size of SMM communicate header, without including the payload.\r | |
78 | ///\r | |
79 | #define SMM_COMMUNICATE_HEADER_SIZE (OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data))\r | |
80 | \r | |
81 | ///\r | |
82 | /// Size of SMM variable communicate header, without including the payload.\r | |
83 | ///\r | |
84 | #define SMM_VARIABLE_COMMUNICATE_HEADER_SIZE (OFFSET_OF (SMM_VARIABLE_COMMUNICATE_HEADER, Data))\r | |
85 | \r | |
86 | ///\r | |
87 | /// This structure is used to communicate with SMI handler by SetVariable and GetVariable.\r | |
88 | ///\r | |
89 | typedef struct {\r | |
90 | EFI_GUID Guid;\r | |
91 | UINTN DataSize;\r | |
92 | UINTN NameSize;\r | |
fa0737a8 | 93 | UINT32 Attributes;\r |
d00ed85e | 94 | CHAR16 Name[1];\r |
95 | } SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE;\r | |
96 | \r | |
97 | ///\r | |
98 | /// This structure is used to communicate with SMI handler by GetNextVariableName.\r | |
99 | ///\r | |
100 | typedef struct {\r | |
101 | EFI_GUID Guid;\r | |
0c55190f | 102 | UINTN NameSize; // Return name buffer size\r |
d00ed85e | 103 | CHAR16 Name[1];\r |
104 | } SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME;\r | |
105 | \r | |
106 | ///\r | |
107 | /// This structure is used to communicate with SMI handler by QueryVariableInfo.\r | |
108 | ///\r | |
109 | typedef struct {\r | |
110 | UINT64 MaximumVariableStorageSize;\r | |
111 | UINT64 RemainingVariableStorageSize;\r | |
112 | UINT64 MaximumVariableSize;\r | |
fa0737a8 | 113 | UINT32 Attributes;\r |
d00ed85e | 114 | } SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO;\r |
115 | \r | |
ff843847 RN |
116 | typedef SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE;\r |
117 | \r | |
efb01a10 SZ |
118 | typedef struct {\r |
119 | EFI_GUID Guid;\r | |
120 | UINTN NameSize;\r | |
121 | VAR_CHECK_VARIABLE_PROPERTY VariableProperty;\r | |
122 | CHAR16 Name[1];\r | |
123 | } SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY;\r | |
124 | \r | |
fa0737a8 SZ |
125 | typedef struct {\r |
126 | UINTN VariablePayloadSize;\r | |
127 | } SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE;\r | |
128 | \r | |
129 | #endif // _SMM_VARIABLE_COMMON_H_\r |