]>
Commit | Line | Data |
---|---|---|
79964ac8 | 1 | /** @file\r |
2 | The EFI Legacy BIOS Patform Protocol is used to mate a Legacy16\r | |
3 | implementation with this EFI code. The EFI driver that produces\r | |
4 | the Legacy BIOS protocol is generic and consumes this protocol.\r | |
5 | A driver that matches the Legacy16 produces this protocol\r | |
6 | \r | |
f0d6194d | 7 | Copyright (c) 2007 - 2009 Intel Corporation\r |
79964ac8 | 8 | All rights reserved. This program and the accompanying materials\r |
9 | are licensed and made available under the terms and conditions of the BSD License\r | |
10 | which accompanies this distribution. The full text of the license may be found at\r | |
11 | http://opensource.org/licenses/bsd-license.php\r | |
12 | \r | |
13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
15 | \r | |
16 | Module Name: LegacyBiosPlatform.h\r | |
17 | \r | |
18 | @par Revision Reference:\r | |
19 | This protocol is defined in Framework for EFI Compatibility Support Module spec\r | |
0f899407 | 20 | Version 0.97.\r |
79964ac8 | 21 | \r |
22 | **/\r | |
23 | \r | |
24 | #ifndef _EFI_LEGACY_BIOS_PLATFORM_H_\r | |
25 | #define _EFI_LEGACY_BIOS_PLATFORM_H_\r | |
26 | \r | |
b80fbe85 | 27 | #include <FrameworkDxe.h>\r |
28 | \r | |
79964ac8 | 29 | #define EFI_LEGACY_BIOS_PLATFORM_PROTOCOL_GUID \\r |
30 | { \\r | |
31 | 0x783658a3, 0x4172, 0x4421, {0xa2, 0x99, 0xe0, 0x9, 0x7, 0x9c, 0xc, 0xb4 } \\r | |
32 | }\r | |
33 | \r | |
34 | typedef struct _EFI_LEGACY_BIOS_PLATFORM_PROTOCOL EFI_LEGACY_BIOS_PLATFORM_PROTOCOL;\r | |
35 | \r | |
04dd6cc0 | 36 | /**\r |
412fb9ef | 37 | This enum specifies the Mode param values for GetPlatformInfo()\r |
04dd6cc0 | 38 | **/\r |
79964ac8 | 39 | typedef enum {\r |
412fb9ef | 40 | ///\r |
41 | /// This mode is invoked twice. The first invocation has LegacySegment and\r | |
42 | /// LegacyOffset set to 0. The mode returns the MP table address in EFI memory and its size.\r | |
43 | /// The second invocation has LegacySegment and LegacyOffset set to the location\r | |
44 | /// in the 0xF0000 or 0xE0000 block to which the MP table is to be copied. The second\r | |
45 | /// invocation allows any MP table address fix ups to occur in the EFI memory copy of the\r | |
46 | /// MP table. The caller, not EfiGetPlatformBinaryMpTable, copies the modified MP\r | |
47 | /// table to the allocated region in 0xF0000 or 0xE0000 block after the second invocation.\r | |
48 | ///\r | |
49 | /// The function parameters associated with this mode are:\r | |
50 | ///\r | |
51 | /// Table Pointer to the MP table.\r | |
52 | ///\r | |
53 | /// TableSize Size in bytes of the MP table.\r | |
54 | ///\r | |
55 | /// Location Location to place table. 0x00. Either 0xE0000 or 0xF0000 64 KB blocks.\r | |
56 | /// Bit 0 = 1 0xF0000 64 KB block.\r | |
57 | /// Bit 1 = 1 0xE0000 64 KB block.\r | |
58 | /// Multiple bits can be set.\r | |
59 | ///\r | |
60 | /// Alignment Bit mapped address alignment granularity. \r | |
61 | /// The first nonzero bit from the right is the address granularity.\r | |
62 | ///\r | |
63 | // LegacySegment Segment where EfiCompatibility code will place the MP table.\r | |
64 | ///\r | |
65 | /// LegacyOffset Offset where EfiCompatibility code will place the MP table.\r | |
66 | ///\r | |
67 | /// The return values associated with this mode are:\r | |
68 | ///\r | |
69 | /// EFI_SUCCESS The MP table was returned.\r | |
70 | ///\r | |
71 | /// EFI_UNSUPPORTED The MP table is not supported on this platform.\r | |
72 | ///\r | |
79964ac8 | 73 | EfiGetPlatformBinaryMpTable = 0,\r |
412fb9ef | 74 | ///\r |
75 | /// This mode returns a block of data. The contents and usage is IBV or OEM defined.\r | |
76 | /// OEMs or IBVs normally use this function for nonstandard Compatibility16 runtime soft\r | |
77 | /// INTs. It is the responsibility of this routine to coalesce multiple OEM 16 bit functions, if\r | |
78 | /// they exist, into one coherent package that is understandable by the Compatibility16 code.\r | |
79 | /// This function is invoked twice. The first invocation has LegacySegment and\r | |
80 | /// LegacyOffset set to 0. The function returns the table address in EFI memory and its size.\r | |
81 | /// The second invocation has LegacySegment and LegacyOffset set to the location\r | |
82 | /// in the 0xF0000 or 0xE0000 block to which the data (table) is to be copied. The second\r | |
83 | /// invocation allows any data (table) address fix ups to occur in the EFI memory copy of\r | |
84 | /// the table. The caller, not GetOemIntData(), copies the modified data (table) to the\r | |
85 | /// allocated region in 0xF0000 or 0xE0000 block after the second invocation.\r | |
86 | ///\r | |
87 | /// The function parameters associated with this mode are:\r | |
88 | ///\r | |
89 | /// Table Pointer to OEM legacy 16 bit code or data.\r | |
90 | ///\r | |
91 | /// TableSize Size of data.\r | |
92 | ///\r | |
93 | /// Location Location to place table. 0x00. Either 0xE0000 or 0xF0000 64 KB blocks.\r | |
94 | /// Bit 0 = 1 0xF0000 64 KB block.\r | |
95 | /// Bit 1 = 1 0xE0000 64 KB block.\r | |
96 | /// Multiple bits can be set.\r | |
97 | ///\r | |
98 | /// Alignment Bit mapped address alignment granularity. \r | |
99 | /// The first nonzero bit from the right is the address granularity.\r | |
100 | ///\r | |
101 | /// LegacySegment Segment where EfiCompatibility code will place the table or data.\r | |
102 | ///\r | |
103 | /// LegacyOffset Offset where EfiCompatibility code will place the table or data.\r | |
104 | ///\r | |
105 | /// The return values associated with this mode are:\r | |
106 | ///\r | |
107 | /// EFI_SUCCESS The data was returned successfully.\r | |
108 | ///\r | |
109 | /// EFI_UNSUPPORTED Oem INT is not supported on this platform.\r | |
110 | ///\r | |
79964ac8 | 111 | EfiGetPlatformBinaryOemIntData = 1,\r |
412fb9ef | 112 | ///\r |
113 | /// This mode returns a block of data. The contents and usage is IBV defined. OEMs or\r | |
114 | /// IBVs normally use this mode for nonstandard Compatibility16 runtime 16 bit routines. It\r | |
115 | /// is the responsibility of this routine to coalesce multiple OEM 16 bit functions, if they\r | |
116 | /// exist, into one coherent package that is understandable by the Compatibility16 code.\r | |
117 | /// An example usage might be a legacy mobile BIOS that has a pre existing runtime\r | |
118 | /// interface to return the battery status to calling applications.\r | |
119 | /// This mode is invoked twice. The first invocation has LegacySegment and\r | |
120 | /// LegacyOffset set to 0. The mode returns the table address in EFI memory and its size.\r | |
121 | /// The second invocation has LegacySegment and LegacyOffset set to the location\r | |
122 | /// in the 0xF0000 or 0xE0000 block to which the table is to be copied. The second\r | |
123 | /// invocation allows any table address fix ups to occur in the EFI memory copy of the table.\r | |
124 | /// The caller, not EfiGetPlatformBinaryOem16Data, copies the modified table to\r | |
125 | /// the allocated region in 0xF0000 or 0xE0000 block after the second invocation.\r | |
126 | ///\r | |
127 | /// The function parameters associated with this mode are:\r | |
128 | ///\r | |
129 | /// Table Pointer to OEM legacy 16 bit code or data.\r | |
130 | ///\r | |
131 | /// TableSize Size of data.\r | |
132 | ///\r | |
133 | /// Location Location to place the table. 0x00. Either 0xE0000 or 0xF0000 64 KB blocks.\r | |
134 | /// Bit 0 = 1 0xF0000 64 KB block.\r | |
135 | /// Bit 1 = 1 0xE0000 64 KB block.\r | |
136 | /// Multiple bits can be set.\r | |
137 | ///\r | |
138 | /// Alignment Bit mapped address alignment granularity. \r | |
139 | /// The first nonzero bit from the right is the address granularity.\r | |
140 | ///\r | |
141 | /// LegacySegment Segment where EfiCompatibility code will place the table or data.\r | |
142 | ///\r | |
143 | /// LegacyOffset Offset where EfiCompatibility code will place the table or data.\r | |
144 | ///\r | |
145 | /// The return values associated with this mode are:\r | |
146 | ///\r | |
147 | /// EFI_SUCCESS The data was returned successfully.\r | |
148 | ///\r | |
149 | /// EFI_UNSUPPORTED Oem16 is not supported on this platform.\r | |
150 | ///\r | |
79964ac8 | 151 | EfiGetPlatformBinaryOem16Data = 2,\r |
412fb9ef | 152 | ///\r |
153 | /// This mode returns a block of data. The contents and usage is IBV defined. OEMs or\r | |
154 | /// IBVs normally use this mode for nonstandard Compatibility16 runtime 32 bit routines. It\r | |
155 | /// is the responsibility of this routine to coalesce multiple OEM 32 bit functions, if they\r | |
156 | /// exist, into one coherent package that is understandable by the Compatibility16 code.\r | |
157 | /// An example usage might be a legacy mobile BIOS that has a pre existing runtime\r | |
158 | /// interface to return the battery status to calling applications.\r | |
159 | /// This mode is invoked twice. The first invocation has LegacySegment and\r | |
160 | /// LegacyOffset set to 0. The mode returns the table address in EFI memory and its size.\r | |
161 | /// \r | |
162 | /// The second invocation has LegacySegment and LegacyOffset set to the location\r | |
163 | /// in the 0xF0000 or 0xE0000 block to which the table is to be copied. The second\r | |
164 | /// invocation allows any table address fix ups to occur in the EFI memory copy of the table.\r | |
165 | /// The caller, not EfiGetPlatformBinaryOem32Data, copies the modified table to\r | |
166 | /// the allocated region in 0xF0000 or 0xE0000 block after the second invocation..\r | |
167 | ///\r | |
168 | /// Note: There are two generic mechanisms by which this mode can be used.\r | |
f0d6194d | 169 | /// Mechanism 1: This mode returns the data and the Legacy BIOS Protocol copies\r |
412fb9ef | 170 | /// the data into the F0000 or E0000 block in the Compatibility16 code. The\r |
171 | /// EFI_COMPATIBILITY16_TABLE entries Oem32Segment and Oem32Offset can\r | |
172 | /// be viewed as two UINT16 entries.\r | |
f0d6194d | 173 | /// Mechanism 2: This mode directly fills in the EFI_COMPATIBILITY16_TABLE with\r |
412fb9ef | 174 | /// a pointer to the INT15 E820 region containing the 32 bit code. It returns\r |
175 | /// EFI_UNSUPPORTED. The EFI_COMPATIBILITY16_TABLE entries,\r | |
176 | /// Oem32Segment and Oem32Offset, can be viewed as two UINT16 entries or\r | |
177 | /// as a single UINT32 entry as determined by the IBV.\r | |
178 | ///\r | |
179 | /// The function parameters associated with this mode are:\r | |
180 | ///\r | |
181 | /// TableSize Size of data.\r | |
182 | ///\r | |
f0d6194d | 183 | /// Location Location to place the table. 0x00 ?Either 0xE0000 or 0xF0000 64 KB blocks.\r |
412fb9ef | 184 | /// Bit 0 = 1 0xF0000 64 KB block.\r |
185 | /// Bit 1 = 1 0xE0000 64 KB block.\r | |
186 | /// Multiple bits can be set.\r | |
187 | ///\r | |
188 | /// Alignment Bit mapped address alignment granularity. \r | |
189 | /// The first nonzero bit from the right is the address granularity.\r | |
190 | ///\r | |
191 | /// LegacySegment Segment where EfiCompatibility code will place the table or data.\r | |
192 | ///\r | |
193 | /// LegacyOffset Offset where EfiCompatibility code will place the table or data.\r | |
194 | ///\r | |
195 | /// The return values associated with this mode are:\r | |
196 | /// EFI_SUCCESS The data was returned successfully.\r | |
197 | /// EFI_UNSUPPORTED Oem32 is not supported on this platform.\r | |
198 | ///\r | |
199 | EfiGetPlatformBinaryOem32Data = 3,\r | |
200 | ///\r | |
201 | /// This mode returns a TPM binary image for the onboard TPM device.\r | |
202 | ///\r | |
203 | /// The function parameters associated with this mode are:\r | |
204 | ///\r | |
205 | /// Table TPM binary image for the onboard TPM device.\r | |
206 | ///\r | |
207 | /// TableSize Size of BinaryImage in bytes.\r | |
208 | ///\r | |
209 | /// Location Location to place the table. 0x00. Either 0xE0000 or 0xF0000 64 KB blocks.\r | |
210 | /// Bit 0 = 1 0xF0000 64 KB block.\r | |
211 | /// Bit 1 = 1 0xE0000 64 KB block.\r | |
212 | /// Multiple bits can be set.\r | |
213 | ///\r | |
214 | /// Alignment Bit mapped address alignment granularity. \r | |
215 | /// The first nonzero bit from the right is the address granularity.\r | |
216 | ///\r | |
217 | /// LegacySegment Segment where EfiCompatibility code will place the table or data.\r | |
218 | ///\r | |
219 | /// LegacyOffset Offset where EfiCompatibility code will place the table or data.\r | |
220 | ///\r | |
221 | /// The return values associated with this mode are:\r | |
222 | ///\r | |
223 | /// EFI_SUCCESS BinaryImage is valid.\r | |
224 | ///\r | |
225 | /// EFI_UNSUPPORTED Mode is not supported on this platform.\r | |
226 | ///\r | |
227 | /// EFI_NOT_FOUND No BinaryImage was found.\r | |
228 | ///\r | |
79964ac8 | 229 | EfiGetPlatformBinaryTpmBinary = 4,\r |
412fb9ef | 230 | ///\r |
f0d6194d | 231 |