]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
IntelFrameworkModulePkg: Add Compatibility Support Module (CSM) drivers
[mirror_edk2.git] / IntelFrameworkModulePkg / Csm / LegacyBiosDxe / LegacyBiosInterface.h
CommitLineData
bcecde14 1/** @file\r
2\r
3Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
4\r
5This program and the accompanying materials\r
6are licensed and made available under the terms and conditions\r
7of the BSD License which accompanies this distribution. The\r
8full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef _LEGACY_BIOS_INTERFACE_\r
17#define _LEGACY_BIOS_INTERFACE_\r
18\r
19\r
20#include <FrameworkDxe.h>\r
21\r
22#include <Guid/SmBios.h>\r
23#include <Guid/Acpi.h>\r
24#include <Guid/DxeServices.h>\r
25#include <Guid/LegacyBios.h>\r
26#include <Guid/StatusCodeDataTypeId.h>\r
27\r
28#include <Protocol/BlockIo.h>\r
29#include <Protocol/LoadedImage.h>\r
30#include <Protocol/PciIo.h>\r
31#include <Protocol/Cpu.h>\r
32#include <Protocol/IsaIo.h>\r
33#include <Protocol/LegacyRegion2.h>\r
34#include <Protocol/SimpleTextIn.h>\r
35#include <Protocol/LegacyInterrupt.h>\r
36#include <Protocol/LegacyBios.h>\r
37#include <Protocol/DiskInfo.h>\r
38#include <Protocol/GenericMemoryTest.h>\r
39#include <Protocol/LegacyBiosPlatform.h>\r
40#include <Protocol/DevicePath.h>\r
41#include <Protocol/Legacy8259.h>\r
42#include <Protocol/PciRootBridgeIo.h>\r
43#include <Protocol/Timer.h>\r
44\r
45#include <Library/BaseLib.h>\r
46#include <Library/DebugLib.h>\r
47#include <Library/UefiLib.h>\r
48#include <Library/BaseMemoryLib.h>\r
49#include <Library/ReportStatusCodeLib.h>\r
50#include <Library/UefiRuntimeServicesTableLib.h>\r
51#include <Library/HobLib.h>\r
52#include <Library/UefiDriverEntryPoint.h>\r
53#include <Library/MemoryAllocationLib.h>\r
54#include <Library/UefiBootServicesTableLib.h>\r
55#include <Library/IoLib.h>\r
56#include <Library/PcdLib.h>\r
57#include <Library/DevicePathLib.h>\r
58#include <Library/DxeServicesTableLib.h>\r
59#include <Library/PeCoffLib.h>\r
60#include <Library/CacheMaintenanceLib.h>\r
61#include <Library/DebugAgentLib.h>\r
62\r
63//\r
64// System Tickers\r
65//\r
66#define DEFAULT_LAGACY_TIMER_TICK_DURATION 549254\r
67// BUGBUG: This entry maybe changed to PCD in future and wait for\r
68// redesign of BDS library\r
69//\r
70#define MAX_BBS_ENTRIES 0x100\r
71\r
72//\r
73// Thunk Status Codes\r
74// (These apply only to errors with the thunk and not to the code that was\r
75// thunked to.)\r
76//\r
77#define THUNK_OK 0x00\r
78#define THUNK_ERR_A20_UNSUP 0x01\r
79#define THUNK_ERR_A20_FAILED 0x02\r
80\r
81//\r
82// Vector base definitions\r
83//\r
84//\r
85// 8259 Hardware definitions\r
86//\r
87#define LEGACY_MODE_BASE_VECTOR_MASTER 0x08\r
88#define LEGACY_MODE_BASE_VECTOR_SLAVE 0x70\r
89\r
90//\r
91// The original PC used INT8-F for master PIC. Since these mapped over\r
92// processor exceptions TIANO moved the master PIC to INT68-6F.\r
93//\r
94// The vector base for slave PIC is set as 0x70 for PC-AT compatibility.\r
95//\r
96#define PROTECTED_MODE_BASE_VECTOR_MASTER 0x68\r
97#define PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70\r
98\r
99//\r
100// Trace defines\r
101//\r
102//\r
103#define LEGACY_BDA_TRACE 0x000\r
104#define LEGACY_BIOS_TRACE 0x040\r
105#define LEGACY_BOOT_TRACE 0x080\r
106#define LEGACY_CMOS_TRACE 0x0C0\r
107#define LEGACY_IDE_TRACE 0x100\r
108#define LEGACY_MP_TRACE 0x140\r
109#define LEGACY_PCI_TRACE 0x180\r
110#define LEGACY_SIO_TRACE 0x1C0\r
111\r
112#define LEGACY_PCI_TRACE_000 LEGACY_PCI_TRACE + 0x00\r
113#define LEGACY_PCI_TRACE_001 LEGACY_PCI_TRACE + 0x01\r
114#define LEGACY_PCI_TRACE_002 LEGACY_PCI_TRACE + 0x02\r
115#define LEGACY_PCI_TRACE_003 LEGACY_PCI_TRACE + 0x03\r
116#define LEGACY_PCI_TRACE_004 LEGACY_PCI_TRACE + 0x04\r
117#define LEGACY_PCI_TRACE_005 LEGACY_PCI_TRACE + 0x05\r
118#define LEGACY_PCI_TRACE_006 LEGACY_PCI_TRACE + 0x06\r
119#define LEGACY_PCI_TRACE_007 LEGACY_PCI_TRACE + 0x07\r
120#define LEGACY_PCI_TRACE_008 LEGACY_PCI_TRACE + 0x08\r
121#define LEGACY_PCI_TRACE_009 LEGACY_PCI_TRACE + 0x09\r
122#define LEGACY_PCI_TRACE_00A LEGACY_PCI_TRACE + 0x0A\r
123#define LEGACY_PCI_TRACE_00B LEGACY_PCI_TRACE + 0x0B\r
124#define LEGACY_PCI_TRACE_00C LEGACY_PCI_TRACE + 0x0C\r
125#define LEGACY_PCI_TRACE_00D LEGACY_PCI_TRACE + 0x0D\r
126#define LEGACY_PCI_TRACE_00E LEGACY_PCI_TRACE + 0x0E\r
127#define LEGACY_PCI_TRACE_00F LEGACY_PCI_TRACE + 0x0F\r
128\r
129\r
130typedef struct {\r
131 UINTN PciSegment;\r
132 UINTN PciBus;\r
133 UINTN PciDevice;\r
134 UINTN PciFunction;\r
135 UINT32 ShadowAddress;\r
136 UINT32 ShadowedSize;\r
137 UINT8 DiskStart;\r
138 UINT8 DiskEnd;\r
139} ROM_INSTANCE_ENTRY;\r
140\r
141//\r
142// Values for RealModeGdt\r
143//\r
144#if defined (MDE_CPU_IA32)\r
145\r
146#define NUM_REAL_GDT_ENTRIES 3\r
147#define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB\r
148#define INITIAL_VALUE_BELOW_1K 0x0\r
149\r
150#elif defined (MDE_CPU_X64)\r
151\r
152#define NUM_REAL_GDT_ENTRIES 8\r
153#define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB\r
154#define INITIAL_VALUE_BELOW_1K 0x0\r
155\r
156#elif defined (MDE_CPU_IPF)\r
157\r
158#define NUM_REAL_GDT_ENTRIES 3\r
159#define CONVENTIONAL_MEMORY_TOP 0x80000 // 512 KB\r
160#define INITIAL_VALUE_BELOW_1K 0xff\r
161\r
162#endif\r
163\r
164//\r
165// Miscellaneous numbers\r
166//\r
167#define PMM_MEMORY_SIZE 0x400000 // 4 MB\r
168\r
169#pragma pack(1)\r
170\r
171//\r
172// Define what a processor GDT looks like\r
173//\r
174typedef struct {\r
175 UINT32 LimitLo : 16;\r
176 UINT32 BaseLo : 16;\r
177 UINT32 BaseMid : 8;\r
178 UINT32 Type : 4;\r
179 UINT32 System : 1;\r
180 UINT32 Dpl : 2;\r
181 UINT32 Present : 1;\r
182 UINT32 LimitHi : 4;\r
183 UINT32 Software : 1;\r
184 UINT32 Reserved : 1;\r
185 UINT32 DefaultSize : 1;\r
186 UINT32 Granularity : 1;\r
187 UINT32 BaseHi : 8;\r
188} GDT32;\r
189\r
190typedef struct {\r
191 UINT16 LimitLow;\r
192 UINT16 BaseLow;\r
193 UINT8 BaseMid;\r
194 UINT8 Attribute;\r
195 UINT8 LimitHi;\r
196 UINT8 BaseHi;\r
197} GDT64;\r
198\r
199//\r
200// Define what a processor descriptor looks like\r
201// This data structure must be kept in sync with ASM STRUCT in Thunk.inc\r
202//\r
203typedef struct {\r
204 UINT16 Limit;\r
205 UINT64 Base;\r
206} DESCRIPTOR64;\r
207\r
208typedef struct {\r
209 UINT16 Limit;\r
210 UINT32 Base;\r
211} DESCRIPTOR32;\r
212\r
213//\r
214// Low stub lay out\r
215//\r
216#define LOW_STACK_SIZE (8 * 1024) // 8k?\r
217#define EFI_MAX_E820_ENTRY 100\r
218#define FIRST_INSTANCE 1\r
219#define NOT_FIRST_INSTANCE 0\r
220\r
221#if defined (MDE_CPU_IA32)\r
222typedef struct {\r
223 //\r
224 // Space for the code\r
225 // The address of Code is also the beginning of the relocated Thunk code\r
226 //\r
227 CHAR8 Code[4096]; // ?\r
228 //\r
229 // The address of the Reverse Thunk code\r
230 // Note that this member CONTAINS the address of the relocated reverse thunk\r
231 // code unlike the member variable 'Code', which IS the address of the Thunk\r
232 // code.\r
233 //\r
234 UINT32 LowReverseThunkStart;\r
235\r
236 //\r
237 // Data for the code (cs releative)\r
238 //\r
239 DESCRIPTOR32 GdtDesc; // Protected mode GDT\r
240 DESCRIPTOR32 IdtDesc; // Protected mode IDT\r
241 UINT32 FlatSs;\r
242 UINT32 FlatEsp;\r
243\r
244 UINT32 LowCodeSelector; // Low code selector in GDT\r
245 UINT32 LowDataSelector; // Low data selector in GDT\r
246 UINT32 LowStack;\r
247 DESCRIPTOR32 RealModeIdtDesc;\r
248\r
249 //\r
250 // real-mode GDT (temporary GDT with two real mode segment descriptors)\r
251 //\r
252 GDT32 RealModeGdt[NUM_REAL_GDT_ENTRIES];\r
253 DESCRIPTOR32 RealModeGdtDesc;\r
254\r
255 //\r
256 // Members specifically for the reverse thunk\r
257 // The RevReal* members are used to store the current state of real mode\r
258 // before performing the reverse thunk. The RevFlat* members must be set\r
259 // before calling the reverse thunk assembly code.\r
260 //\r
261 UINT16 RevRealDs;\r
262 UINT16 RevRealSs;\r
263 UINT32 RevRealEsp;\r
264 DESCRIPTOR32 RevRealIdtDesc;\r
265 UINT16 RevFlatDataSelector; // Flat data selector in GDT\r
266 UINT32 RevFlatStack;\r
267\r
268 //\r
269 // A low memory stack\r
270 //\r
271 CHAR8 Stack[LOW_STACK_SIZE];\r
272\r
273 //\r
274 // Stack for flat mode after reverse thunk\r
275 // @bug - This may no longer be necessary if the reverse thunk interface\r
276 // is changed to have the flat stack in a different location.\r
277 //\r
278 CHAR8 RevThunkStack[LOW_STACK_SIZE];\r
279\r
280 //\r
281 // Legacy16 Init memory map info\r
282 //\r
283 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable;\r
284\r
285 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable;\r
286\r
287 CHAR8 InterruptRedirectionCode[32];\r
288 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler;\r
289 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable;\r
290 BBS_TABLE BbsTable[MAX_BBS_ENTRIES];\r
291} LOW_MEMORY_THUNK;\r
292\r
293#elif defined (MDE_CPU_X64)\r
294\r
295typedef struct {\r
296 //\r
297 // Space for the code\r
298 // The address of Code is also the beginning of the relocated Thunk code\r
299 //\r
300 CHAR8 Code[4096]; // ?\r
301\r
302 //\r
303 // Data for the code (cs releative)\r
304 //\r
305 DESCRIPTOR64 X64GdtDesc; // Protected mode GDT\r
306 DESCRIPTOR64 X64IdtDesc; // Protected mode IDT\r
307 UINTN X64Ss;\r
308 UINTN X64Esp;\r
309\r
310 UINTN RealStack;\r
311 DESCRIPTOR32 RealModeIdtDesc;\r
312 DESCRIPTOR32 RealModeGdtDesc;\r
313\r
314 //\r
315 // real-mode GDT (temporary GDT with two real mode segment descriptors)\r
316 //\r
317 GDT64 RealModeGdt[NUM_REAL_GDT_ENTRIES];\r
318 UINT64 PageMapLevel4;\r
319\r
320 //\r
321 // A low memory stack\r
322 //\r
323 CHAR8 Stack[LOW_STACK_SIZE];\r
324\r
325 //\r
326 // Legacy16 Init memory map info\r
327 //\r
328 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable;\r
329\r
330 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable;\r
331\r
332 CHAR8 InterruptRedirectionCode[32];\r
333 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler;\r
334 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable;\r
335 BBS_TABLE BbsTable[MAX_BBS_ENTRIES];\r
336} LOW_MEMORY_THUNK;\r
337\r
338#elif defined (MDE_CPU_IPF)\r
339\r
340typedef struct {\r
341 //\r
342 // Space for the code\r
343 // The address of Code is also the beginning of the relocated Thunk code\r
344 //\r
345 CHAR8 Code[4096]; // ?\r
346 //\r
347 // The address of the Reverse Thunk code\r
348 // Note that this member CONTAINS the address of the relocated reverse thunk\r
349 // code unlike the member variable 'Code', which IS the address of the Thunk\r
350 // code.\r
351 //\r
352 UINT32 LowReverseThunkStart;\r
353\r
354 //\r
355 // Data for the code (cs releative)\r
356 //\r
357 DESCRIPTOR32 GdtDesc; // Protected mode GDT\r
358 DESCRIPTOR32 IdtDesc; // Protected mode IDT\r
359 UINT32 FlatSs;\r
360 UINT32 FlatEsp;\r
361\r
362 UINT32 LowCodeSelector; // Low code selector in GDT\r
363 UINT32 LowDataSelector; // Low data selector in GDT\r
364 UINT32 LowStack;\r
365 DESCRIPTOR32 RealModeIdtDesc;\r
366\r
367 //\r
368 // real-mode GDT (temporary GDT with two real mode segment descriptors)\r
369 //\r
370 GDT32 RealModeGdt[NUM_REAL_GDT_ENTRIES];\r
371 DESCRIPTOR32 RealModeGdtDesc;\r
372\r
373 //\r
374 // Members specifically for the reverse thunk\r
375 // The RevReal* members are used to store the current state of real mode\r
376 // before performing the reverse thunk. The RevFlat* members must be set\r
377 // before calling the reverse thunk assembly code.\r
378 //\r
379 UINT16 RevRealDs;\r
380 UINT16 RevRealSs;\r
381 UINT32 RevRealEsp;\r
382 DESCRIPTOR32 RevRealIdtDesc;\r
383 UINT16 RevFlatDataSelector; // Flat data selector in GDT\r
384 UINT32 RevFlatStack;\r
385\r
386 //\r
387 // A low memory stack\r
388 //\r
389 CHAR8 Stack[LOW_STACK_SIZE];\r
390\r
391 //\r
392 // Stack for flat mode after reverse thunk\r
393 // @bug - This may no longer be necessary if the reverse thunk interface\r
394 // is changed to have the flat stack in a different location.\r
395 //\r
396 CHAR8 RevThunkStack[LOW_STACK_SIZE];\r
397\r
398 //\r
399 // Legacy16 Init memory map info\r
400 //\r
401 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable;\r
402\r
403 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable;\r
404\r
405 CHAR8 InterruptRedirectionCode[32];\r
406 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler;\r
407 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable;\r
408 BBS_TABLE BbsTable[MAX_BBS_ENTRIES];\r
409} LOW_MEMORY_THUNK;\r
410\r
411#endif\r
412\r
413//\r
414// PnP Expansion Header\r
415//\r
416typedef struct {\r
417 UINT32 PnpSignature;\r
418 UINT8 Revision;\r
419 UINT8 Length;\r
420 UINT16 NextHeader;\r
421 UINT8 Reserved1;\r
422 UINT8 Checksum;\r
423 UINT32 DeviceId;\r
424 UINT16 MfgPointer;\r
425 UINT16 ProductNamePointer;\r
426 UINT8 Class;\r
427 UINT8 SubClass;\r
428 UINT8 Interface;\r
429 UINT8 DeviceIndicators;\r
430 UINT16 Bcv;\r
431 UINT16 DisconnectVector;\r
432 UINT16 Bev;\r
433 UINT16 Reserved2;\r
434 UINT16 StaticResourceVector;\r
435} LEGACY_PNP_EXPANSION_HEADER;\r
436\r
437typedef struct {\r
438 UINT8 PciSegment;\r
439 UINT8 PciBus;\r
440 UINT8 PciDevice;\r
441 UINT8 PciFunction;\r
442 UINT16 Vid;\r
443 UINT16 Did;\r
444 UINT16 SysSid;\r
445 UINT16 SVid;\r
446 UINT8 Class;\r
447 UINT8 SubClass;\r
448 UINT8 Interface;\r
449 UINT8 Reserved;\r
450 UINTN RomStart;\r
451 UINTN ManufacturerString;\r
452 UINTN ProductNameString;\r
453} LEGACY_ROM_AND_BBS_TABLE;\r
454\r
455//\r
456// Structure how EFI has mapped a devices HDD drive numbers.\r
457// Boot to EFI aware OS or shell requires this mapping when\r
458// 16-bit CSM assigns drive numbers.\r
459// This mapping is ignored booting to a legacy OS.\r
460//\r
461typedef struct {\r
462 UINT8 PciSegment;\r
463 UINT8 PciBus;\r
464 UINT8 PciDevice;\r
465 UINT8 PciFunction;\r
466 UINT8 StartDriveNumber;\r
467 UINT8 EndDriveNumber;\r
468} LEGACY_EFI_HDD_TABLE;\r
469\r
470//\r
471// This data is passed to Leacy16Boot\r
472//\r
473typedef enum {\r
474 EfiAcpiAddressRangeMemory = 1,\r
475 EfiAcpiAddressRangeReserved = 2,\r
476 EfiAcpiAddressRangeACPI = 3,\r
477 EfiAcpiAddressRangeNVS = 4\r
478} EFI_ACPI_MEMORY_TYPE;\r
479\r
480typedef struct {\r
481 UINT64 BaseAddr;\r
482 UINT64 Length;\r
483 EFI_ACPI_MEMORY_TYPE Type;\r
484} EFI_E820_ENTRY64;\r
485\r
486typedef struct {\r
487 UINT32 BassAddrLow;\r
488 UINT32 BaseAddrHigh;\r
489 UINT32 LengthLow;\r
490 UINT32 LengthHigh;\r
491 EFI_ACPI_MEMORY_TYPE Type;\r
492} EFI_E820_ENTRY;\r
493\r
494#pragma pack()\r
495\r
496extern BBS_TABLE *mBbsTable;\r
497\r
498extern EFI_GENERIC_MEMORY_TEST_PROTOCOL *gGenMemoryTest;\r
499\r
500extern UINTN mEndOpromShadowAddress;\r
501\r
502#define PORT_70 0x70\r
503#define PORT_71 0x71\r
504\r
505#define CMOS_0A 0x0a ///< Status register A\r
506#define CMOS_0D 0x0d ///< Status register D\r
507#define CMOS_0E 0x0e ///< Diagnostic Status\r
508#define CMOS_0F 0x0f ///< Shutdown status\r
509#define CMOS_10 0x10 ///< Floppy type\r
510#define CMOS_12 0x12 ///< IDE type\r
511#define CMOS_14 0x14 ///< Same as BDA 40:10\r
512#define CMOS_15 0x15 ///< Low byte of base memory in 1k increments\r
513#define CMOS_16 0x16 ///< High byte of base memory in 1k increments\r
514#define CMOS_17 0x17 ///< Low byte of 1MB+ memory in 1k increments - max 15 MB\r
515#define CMOS_18 0x18 ///< High byte of 1MB+ memory in 1k increments - max 15 MB\r
516#define CMOS_19 0x19 ///< C: extended drive type\r
517#define CMOS_1A 0x1a ///< D: extended drive type\r
518#define CMOS_2E 0x2e ///< Most significient byte of standard checksum\r
519#define CMOS_2F 0x2f ///< Least significient byte of standard checksum\r
520#define CMOS_30 0x30 ///< CMOS 0x17\r
521#define CMOS_31 0x31 ///< CMOS 0x18\r
522#define CMOS_32 0x32 ///< Century byte\r
523\r
524\r
525#define LEGACY_BIOS_INSTANCE_SIGNATURE SIGNATURE_32 ('L', 'B', 'I', 'T')\r
526typedef struct {\r
527 UINTN Signature;\r
528\r
529 EFI_HANDLE Handle;\r
530 EFI_LEGACY_BIOS_PROTOCOL LegacyBios;\r
531\r
532 EFI_HANDLE ImageHandle;\r
533\r
534 //\r
535 // CPU Architectural Protocol \r
536 //\r
537 EFI_CPU_ARCH_PROTOCOL *Cpu;\r
538\r
539 //\r
540 // Protocol to Lock and Unlock 0xc0000 - 0xfffff\r
541 //\r
542 EFI_LEGACY_REGION2_PROTOCOL *LegacyRegion;\r
543\r
544 EFI_LEGACY_BIOS_PLATFORM_PROTOCOL *LegacyBiosPlatform;\r
545\r
546 //\r
547 // Interrupt control for thunk and PCI IRQ\r
548 //\r
549 EFI_LEGACY_8259_PROTOCOL *Legacy8259;\r
550\r
551 //\r
552 // PCI Interrupt PIRQ control\r
553 //\r
554 EFI_LEGACY_INTERRUPT_PROTOCOL *LegacyInterrupt;\r
555\r
556 //\r
557 // Generic Memory Test\r
558 //\r
559 EFI_GENERIC_MEMORY_TEST_PROTOCOL *GenericMemoryTest;\r
560\r
561 //\r
562 // TRUE if PCI Interupt Line registers have been programmed.\r
563 //\r
564 BOOLEAN PciInterruptLine;\r
565\r
566 //\r
567 // Code space below 1MB needed by thunker to transition to real mode.\r
568 // Contains stack and real mode code fragments\r
569 //\r
570 LOW_MEMORY_THUNK *IntThunk;\r
571\r
572 //\r
573 // Starting shadow address of the Legacy BIOS\r
574 //\r
575 UINT32 BiosStart;\r
576 UINT32 LegacyBiosImageSize;\r
577\r
578 //\r
579 // Start of variables used by CsmItp.mac ITP macro file and/os LegacyBios\r
580 //\r
581 UINT8 Dump[4];\r
582\r
583 //\r
584 // $EFI Legacy16 code entry info in memory < 1 MB;\r
585 //\r
586 EFI_COMPATIBILITY16_TABLE *Legacy16Table;\r
587 VOID *Legacy16InitPtr;\r
588 VOID *Legacy16BootPtr;\r
589 VOID *InternalIrqRoutingTable;\r
590 UINT32 NumberIrqRoutingEntries;\r
591 VOID *BbsTablePtr;\r
592 VOID *HddTablePtr;\r
593 UINT32 NumberHddControllers;\r
594\r
595 //\r
596 // Cached copy of Legacy16 entry point\r
597 //\r
598 UINT16 Legacy16CallSegment;\r
599 UINT16 Legacy16CallOffset;\r
600\r
601 //\r
602 // Returned from $EFI and passed in to OPROMS\r
603 //\r
604 UINT16 PnPInstallationCheckSegment;\r
605 UINT16 PnPInstallationCheckOffset;\r
606\r
607 //\r
608 // E820 table\r
609 //\r
610 EFI_E820_ENTRY E820Table[EFI_MAX_E820_ENTRY];\r
611 UINT32 NumberE820Entries;\r
612\r
613 //\r
614 // True if legacy VGA INT 10h handler installed\r
615 //\r
616 BOOLEAN VgaInstalled;\r
617\r
618 //\r
619 // Number of IDE drives\r
620 //\r
621 UINT8 IdeDriveCount;\r
622\r
623 //\r
624 // Current Free Option ROM space. An option ROM must NOT go past\r
625 // BiosStart.\r
626 //\r
627 UINT32 OptionRom;\r
628\r
629 //\r
630 // Save Legacy16 unexpected interrupt vector. Reprogram INT 68-6F from\r
631 // EFI values to legacy value just before boot.\r
632 //\r
633 UINT32 BiosUnexpectedInt;\r
634 UINT32 ThunkSavedInt[8];\r
635 UINT16 ThunkSeg;\r
636 LEGACY_EFI_HDD_TABLE *LegacyEfiHddTable;\r
637 UINT16 LegacyEfiHddTableIndex;\r
638 UINT8 DiskEnd;\r
639 UINT8 Disk4075;\r
640 UINT16 TraceIndex;\r
641 UINT16 Trace[0x200];\r
642\r
643 //\r
644 // Indicate that whether GenericLegacyBoot is entered or not\r
645 //\r
646 BOOLEAN LegacyBootEntered; \r
647\r
648 //\r
649 // CSM16 PCI Interface Version\r
650 //\r
651 UINT16 Csm16PciInterfaceVersion;\r
652\r
653} LEGACY_BIOS_INSTANCE;\r
654\r
655\r
656#pragma pack(1)\r
657\r
658/*\r
659 40:00-01 Com1\r
660 40:02-03 Com2\r
661 40:04-05 Com3\r
662 40:06-07 Com4\r
663 40:08-09 Lpt1\r
664 40:0A-0B Lpt2\r
665 40:0C-0D Lpt3\r
666 40:0E-0E Ebda segment\r
667 40:10-11 MachineConfig\r
668 40:12 Bda12 - skip\r
669 40:13-14 MemSize below 1MB\r
670 40:15-16 Bda15_16 - skip\r
671 40:17 Keyboard Shift status\r
672 40:18-19 Bda18_19 - skip\r
673 40:1A-1B Key buffer head\r
674 40:1C-1D Key buffer tail\r
675 40:1E-3D Bda1E_3D- key buffer -skip\r
676 40:3E-3F FloppyData 3E = Calibration status 3F = Motor status\r
677 40:40 FloppyTimeout\r
678 40:41-74 Bda41_74 - skip\r
679 40:75 Number of HDD drives\r
680 40:76-77 Bda76_77 - skip\r
681 40:78-79 78 = Lpt1 timeout, 79 = Lpt2 timeout\r
682 40:7A-7B 7A = Lpt3 timeout, 7B = Lpt4 timeout\r
683 40:7C-7D 7C = Com1 timeout, 7D = Com2 timeout\r
684 40:7E-7F 7E = Com3 timeout, 7F = Com4 timeout\r
685 40:80-81 Pointer to start of key buffer\r
686 40:82-83 Pointer to end of key buffer\r
687 40:84-87 Bda84_87 - skip\r
688 40:88 HDD Data Xmit rate\r
689 40:89-8f skip\r
690 40:90 Floppy data rate\r
691 40:91-95 skip\r
692 40:96 Keyboard Status\r
693 40:97 LED Status\r
694 40:98-101 skip\r
695*/\r
696typedef struct {\r
697 UINT16 Com1;\r
698 UINT16 Com2;\r
699 UINT16 Com3;\r
700 UINT16 Com4;\r
701 UINT16 Lpt1;\r
702 UINT16 Lpt2;\r
703 UINT16 Lpt3;\r
704 UINT16 Ebda;\r
705 UINT16 MachineConfig;\r
706 UINT8 Bda12;\r
707 UINT16 MemSize;\r
708 UINT8 Bda15_16[0x02];\r
709 UINT8 ShiftStatus;\r
710 UINT8 Bda18_19[0x02];\r
711 UINT16 KeyHead;\r
712 UINT16 KeyTail;\r
713 UINT16 Bda1E_3D[0x10];\r
714 UINT16 FloppyData;\r
715 UINT8 FloppyTimeout;\r
716 UINT8 Bda41_74[0x34];\r
717 UINT8 NumberOfDrives;\r
718 UINT8 Bda76_77[0x02];\r
719 UINT16 Lpt1_2Timeout;\r
720 UINT16 Lpt3_4Timeout;\r
721 UINT16 Com1_2Timeout;\r
722 UINT16 Com3_4Timeout;\r
723 UINT16 KeyStart;\r
724 UINT16 KeyEnd;\r
725 UINT8 Bda84_87[0x4];\r
726 UINT8 DataXmit;\r
727 UINT8 Bda89_8F[0x07];\r
728 UINT8 FloppyXRate;\r
729 UINT8 Bda91_95[0x05];\r
730 UINT8 KeyboardStatus;\r
731 UINT8 LedStatus;\r
732} BDA_STRUC;\r
733#pragma pack()\r
734\r
735#define LEGACY_BIOS_INSTANCE_FROM_THIS(this) CR (this, LEGACY_BIOS_INSTANCE, LegacyBios, LEGACY_BIOS_INSTANCE_SIGNATURE)\r
736\r
737/**\r
738 Thunk to 16-bit real mode and execute a software interrupt with a vector\r
739 of BiosInt. Regs will contain the 16-bit register context on entry and\r
740 exit.\r
741\r
742 @param This Protocol instance pointer.\r
743 @param BiosInt Processor interrupt vector to invoke\r
744 @param Regs Register contexted passed into (and returned) from thunk to\r
745 16-bit mode\r
746\r
747 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.\r
748 See Regs for status.\r
749 @retval TRUE There was a BIOS erro in the target code.\r
750\r
751**/\r
752BOOLEAN\r
753EFIAPI\r
754LegacyBiosInt86 (\r
755 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
756 IN UINT8 BiosInt,\r
757 IN EFI_IA32_REGISTER_SET *Regs\r
758 );\r
759\r
760\r
761/**\r
762 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the\r
763 16-bit register context on entry and exit. Arguments can be passed on\r
764 the Stack argument\r
765\r
766 @param This Protocol instance pointer.\r
767 @param Segment Segemnt of 16-bit mode call\r
768 @param Offset Offset of 16-bit mdoe call\r
769 @param Regs Register contexted passed into (and returned) from\r
770 thunk to 16-bit mode\r
771 @param Stack Caller allocated stack used to pass arguments\r
772 @param StackSize Size of Stack in bytes\r
773\r
774 @retval FALSE Thunk completed, and there were no BIOS errors in\r
775 the target code. See Regs for status.\r
776 @retval TRUE There was a BIOS erro in the target code.\r
777\r
778**/\r
779BOOLEAN\r
780EFIAPI\r
781LegacyBiosFarCall86 (\r
782 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
783 IN UINT16 Segment,\r
784 IN UINT16 Offset,\r
785 IN EFI_IA32_REGISTER_SET *Regs,\r
786 IN VOID *Stack,\r
787 IN UINTN StackSize\r
788 );\r
789\r
790\r
791/**\r
792 Test to see if a legacy PCI ROM exists for this device. Optionally return\r
793 the Legacy ROM instance for this PCI device.\r
794\r
795 @param This Protocol instance pointer.\r
796 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will\r
797 be loaded\r
798 @param RomImage Return the legacy PCI ROM for this device\r
799 @param RomSize Size of ROM Image\r
800 @param Flags Indicates if ROM found and if PC-AT.\r
801\r
802 @retval EFI_SUCCESS Legacy Option ROM availible for this device\r
803 @retval EFI_UNSUPPORTED Legacy Option ROM not supported.\r
804\r
805**/\r
806EFI_STATUS\r
807EFIAPI\r
808LegacyBiosCheckPciRom (\r
809 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
810 IN EFI_HANDLE PciHandle,\r
811 OUT VOID **RomImage, OPTIONAL\r
812 OUT UINTN *RomSize, OPTIONAL\r
813 OUT UINTN *Flags\r
814 );\r
815\r
816\r
817/**\r
818 Assign drive number to legacy HDD drives prior to booting an EFI\r
819 aware OS so the OS can access drives without an EFI driver.\r
820 Note: BBS compliant drives ARE NOT available until this call by\r
821 either shell or EFI.\r
822\r
823 @param This Protocol instance pointer.\r
824 @param BbsCount Number of BBS_TABLE structures\r
825 @param BbsTable List BBS entries\r
826\r
827 @retval EFI_SUCCESS Drive numbers assigned\r
828\r
829**/\r
830EFI_STATUS\r
831EFIAPI\r
832LegacyBiosPrepareToBootEfi (\r
833 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
834 OUT UINT16 *BbsCount,\r
835 OUT BBS_TABLE **BbsTable\r
836 );\r
837\r
838\r
839/**\r
840 To boot from an unconventional device like parties and/or execute\r
841 HDD diagnostics.\r
842\r
843 @param This Protocol instance pointer.\r
844 @param Attributes How to interpret the other input parameters\r
845 @param BbsEntry The 0-based index into the BbsTable for the parent\r
846 device.\r
847 @param BeerData Pointer to the 128 bytes of ram BEER data.\r
848 @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data.\r
849 The caller must provide a pointer to the specific\r
850 Service Area and not the start all Service Areas.\r
851 EFI_INVALID_PARAMETER if error. Does NOT return if no error.\r
852\r
853**/\r
854EFI_STATUS\r
855EFIAPI\r
856LegacyBiosBootUnconventionalDevice (\r
857 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
858 IN UDC_ATTRIBUTES Attributes,\r
859 IN UINTN BbsEntry,\r
860 IN VOID *BeerData,\r
861 IN VOID *ServiceAreaData\r
862 );\r
863\r
864\r
865/**\r
866 Load a legacy PC-AT OPROM on the PciHandle device. Return information\r
867 about how many disks were added by the OPROM and the shadow address and\r
868 size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:\r
869\r
870 @param This Protocol instance pointer.\r
871 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will\r
872 be loaded. This value is NULL if RomImage is\r
873 non-NULL. This is the normal case.\r
874 @param RomImage A PCI PC-AT ROM image. This argument is non-NULL\r
875 if there is no hardware associated with the ROM\r
876 and thus no PciHandle, otherwise is must be NULL.\r
877 Example is PXE base code.\r
878 @param Flags Indicates if ROM found and if PC-AT.\r
879 @param DiskStart Disk number of first device hooked by the ROM. If\r
880 DiskStart is the same as DiskEnd no disked were\r
881 hooked.\r
882 @param DiskEnd Disk number of the last device hooked by the ROM.\r
883 @param RomShadowAddress Shadow address of PC-AT ROM\r
884 @param RomShadowedSize Size of RomShadowAddress in bytes\r
885\r
886 @retval EFI_SUCCESS Legacy ROM loaded for this device\r
887 @retval EFI_INVALID_PARAMETER PciHandle not found\r
888 @retval EFI_UNSUPPORTED There is no PCI ROM in the ROM BAR or no onboard\r
889 ROM\r
890\r
891**/\r
892EFI_STATUS\r
893EFIAPI\r
894LegacyBiosInstallPciRom (\r
895 IN EFI_LEGACY_BIOS_PROTOCOL * This,\r
896 IN EFI_HANDLE PciHandle,\r
897 IN VOID **RomImage,\r
898 OUT UINTN *Flags,\r
899 OUT UINT8 *DiskStart, OPTIONAL\r
900 OUT UINT8 *DiskEnd, OPTIONAL\r
901 OUT VOID **RomShadowAddress, OPTIONAL\r
902 OUT UINT32 *RomShadowedSize OPTIONAL\r
903 );\r
904\r
905\r
906/**\r
907 Fill in the standard BDA for Keyboard LEDs\r
908\r
909 @param This Protocol instance pointer.\r
910 @param Leds Current LED status\r
911\r
912 @retval EFI_SUCCESS It should always work.\r
913\r
914**/\r
915EFI_STATUS\r
916EFIAPI\r
917LegacyBiosUpdateKeyboardLedStatus (\r
918 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
919 IN UINT8 Leds\r
920 );\r
921\r
922\r
923/**\r
924 Get all BBS info\r
925\r
926 @param This Protocol instance pointer.\r
927 @param HddCount Number of HDD_INFO structures\r
928 @param HddInfo Onboard IDE controller information\r
929 @param BbsCount Number of BBS_TABLE structures\r
930 @param BbsTable List BBS entries\r
931\r
932 @retval EFI_SUCCESS Tables returned\r
933 @retval EFI_NOT_FOUND resource not found\r
934 @retval EFI_DEVICE_ERROR can not get BBS table\r
935\r
936**/\r
937EFI_STATUS\r
938EFIAPI\r
939LegacyBiosGetBbsInfo (\r
940 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
941 OUT UINT16 *HddCount,\r
942 OUT HDD_INFO **HddInfo,\r
943 OUT UINT16 *BbsCount,\r
944 OUT BBS_TABLE **BbsTable\r
945 );\r
946\r
947\r
948/**\r
949 Shadow all legacy16 OPROMs that haven't been shadowed.\r
950 Warning: Use this with caution. This routine disconnects all EFI\r
951 drivers. If used externally then caller must re-connect EFI\r
952 drivers.\r
953\r
954 @param This Protocol instance pointer.\r
955\r
956 @retval EFI_SUCCESS OPROMs shadowed\r
957\r
958**/\r
959EFI_STATUS\r
960EFIAPI\r
961LegacyBiosShadowAllLegacyOproms (\r
962 IN EFI_LEGACY_BIOS_PROTOCOL *This\r
963 );\r
964\r
965\r
966/**\r
967 Attempt to legacy boot the BootOption. If the EFI contexted has been\r
968 compromised this function will not return.\r
969\r
970 @param This Protocol instance pointer.\r
971 @param BbsDevicePath EFI Device Path from BootXXXX variable.\r
972 @param LoadOptionsSize Size of LoadOption in size.\r
973 @param LoadOptions LoadOption from BootXXXX variable\r
974\r
975 @retval EFI_SUCCESS Removable media not present\r
976\r
977**/\r
978EFI_STATUS\r
979EFIAPI\r
980LegacyBiosLegacyBoot (\r
981 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
982 IN BBS_BBS_DEVICE_PATH *BbsDevicePath,\r
983 IN UINT32 LoadOptionsSize,\r
984 IN VOID *LoadOptions\r
985 );\r
986\r
987\r
988/**\r
989 Allocate memory < 1 MB and copy the thunker code into low memory. Se up\r
990 all the descriptors.\r
991\r
992 @param Private Private context for Legacy BIOS\r
993\r
994 @retval EFI_SUCCESS Should only pass.\r
995\r
996**/\r
997EFI_STATUS\r
998LegacyBiosInitializeThunk (\r
999 IN LEGACY_BIOS_INSTANCE *Private\r
1000 );\r
1001\r
1002\r
1003/**\r
1004 Fill in the standard BDA and EBDA stuff before Legacy16 load\r
1005\r
1006 @param Private Legacy BIOS Instance data\r
1007\r
1008 @retval EFI_SUCCESS It should always work.\r
1009\r
1010**/\r
1011EFI_STATUS\r
1012LegacyBiosInitBda (\r
1013 IN LEGACY_BIOS_INSTANCE *Private\r
1014 );\r
1015\r
1016\r
1017/**\r
1018 Collect IDE Inquiry data from the IDE disks\r
1019\r
1020 @param Private Legacy BIOS Instance data\r
1021 @param HddInfo Hdd Information\r
1022 @param Flag Reconnect IdeController or not\r
1023\r
1024 @retval EFI_SUCCESS It should always work.\r
1025\r
1026**/\r
1027EFI_STATUS\r
1028LegacyBiosBuildIdeData (\r
1029 IN LEGACY_BIOS_INSTANCE *Private,\r
1030 IN HDD_INFO **HddInfo,\r
1031 IN UINT16 Flag\r
1032 );\r
1033\r
1034\r
1035/**\r
1036 Enable ide controller. This gets disabled when LegacyBoot.c is about\r
1037 to run the Option ROMs.\r
1038\r
1039 @param Private Legacy BIOS Instance data\r
1040\r
1041\r
1042**/\r
1043VOID\r
1044EnableIdeController (\r
1045 IN LEGACY_BIOS_INSTANCE *Private\r
1046 );\r
1047\r
1048\r
1049/**\r
1050 If the IDE channel is in compatibility (legacy) mode, remove all\r
1051 PCI I/O BAR addresses from the controller.\r
1052\r
1053 @param IdeController The handle of target IDE controller\r
1054\r
1055\r
1056**/\r
1057VOID\r
1058InitLegacyIdeController (\r
1059 IN EFI_HANDLE IdeController\r
1060 );\r
1061\r
1062\r
1063/**\r
1064 Program the interrupt routing register in all the PCI devices. On a PC AT system\r
1065 this register contains the 8259 IRQ vector that matches it's PCI interrupt.\r
1066\r
1067 @param Private Legacy BIOS Instance data\r
1068\r
1069 @retval EFI_SUCCESS Succeed.\r
1070 @retval EFI_ALREADY_STARTED All PCI devices have been processed.\r
1071\r
1072**/\r
1073EFI_STATUS\r
1074PciProgramAllInterruptLineRegisters (\r
1075 IN LEGACY_BIOS_INSTANCE *Private\r
1076 );\r
1077\r
1078\r
1079/**\r
1080 Collect EFI Info about legacy devices.\r
1081\r
1082 @param Private Legacy BIOS Instance data\r
1083\r
1084 @retval EFI_SUCCESS It should always work.\r
1085\r
1086**/\r
1087EFI_STATUS\r
1088LegacyBiosBuildSioData (\r
1089 IN LEGACY_BIOS_INSTANCE *Private\r
1090 );\r
1091\r
1092\r
1093/**\r
1094 Shadow all the PCI legacy ROMs. Use data from the Legacy BIOS Protocol\r
1095 to chose the order. Skip any devices that have already have legacy\r
1096 BIOS run.\r
1097\r
1098 @param Private Protocol instance pointer.\r
1099\r
1100 @retval EFI_SUCCESS Succeed.\r
1101 @retval EFI_UNSUPPORTED Cannot get VGA device handle.\r
1102\r
1103**/\r
1104EFI_STATUS\r
1105PciShadowRoms (\r
1106 IN LEGACY_BIOS_INSTANCE *Private\r
1107 );\r
1108\r
1109\r
1110/**\r
1111 Fill in the standard BDA and EBDA stuff prior to legacy Boot\r
1112\r
1113 @param Private Legacy BIOS Instance data\r
1114\r
1115 @retval EFI_SUCCESS It should always work.\r
1116\r
1117**/\r
1118EFI_STATUS\r
1119LegacyBiosCompleteBdaBeforeBoot (\r
1120 IN LEGACY_BIOS_INSTANCE *Private\r
1121 );\r
1122\r
1123\r
1124/**\r
1125 Fill in the standard CMOS stuff before Legacy16 load\r
1126\r
1127 @param Private Legacy BIOS Instance data\r
1128\r
1129 @retval EFI_SUCCESS It should always work.\r
1130\r
1131**/\r
1132EFI_STATUS\r
1133LegacyBiosInitCmos (\r
1134 IN LEGACY_BIOS_INSTANCE *Private\r
1135 );\r
1136\r
1137\r
1138/**\r
1139 Fill in the standard CMOS stuff prior to legacy Boot\r
1140\r
1141 @param Private Legacy BIOS Instance data\r
1142\r
1143 @retval EFI_SUCCESS It should always work.\r
1144\r
1145**/\r
1146EFI_STATUS\r
1147LegacyBiosCompleteStandardCmosBeforeBoot (\r
1148 IN LEGACY_BIOS_INSTANCE *Private\r
1149 );\r
1150\r
1151\r
1152/**\r
1153 Contains the code that is copied into low memory (below 640K).\r
1154 This code reflects interrupts 0x68-0x6f to interrupts 0x08-0x0f.\r
1155 This template must be copied into low memory, and the IDT entries\r
1156 0x68-0x6F must be point to the low memory copy of this code. Each\r
1157 entry is 4 bytes long, so IDT entries 0x68-0x6F can be easily\r
1158 computed.\r
1159\r
1160**/\r
1161VOID\r
1162InterruptRedirectionTemplate (\r
1163 VOID\r
1164 );\r
1165\r
1166\r
1167/**\r
1168 Build the E820 table.\r
1169\r
1170 @param Private Legacy BIOS Instance data\r
1171 @param Size Size of E820 Table\r
1172\r
1173 @retval EFI_SUCCESS It should always work.\r
1174\r
1175**/\r
1176EFI_STATUS\r
1177LegacyBiosBuildE820 (\r
1178 IN LEGACY_BIOS_INSTANCE *Private,\r
1179 OUT UINTN *Size\r
1180 );\r
1181\r
1182/**\r
1183 This function is to put all AP in halt state.\r
1184\r
1185 @param Private Legacy BIOS Instance data\r
1186\r
1187**/\r
1188VOID\r
1189ShutdownAPs (\r
1190 IN LEGACY_BIOS_INSTANCE *Private\r
1191 );\r
1192\r
1193/**\r
1194 Worker function for LegacyBiosGetFlatDescs, retrieving content of\r
1195 specific registers.\r
1196\r
1197 @param IntThunk Pointer to IntThunk of Legacy BIOS context.\r
1198\r
1199**/\r
1200VOID\r
1201GetRegisters (\r
1202 LOW_MEMORY_THUNK *IntThunk\r
1203 );\r
1204\r
1205/**\r
1206 Routine for calling real thunk code.\r
1207\r
1208 @param RealCode The address of thunk code.\r
1209 @param BiosInt The Bios interrupt vector number.\r
1210 @param CallAddress The address of 16-bit mode call.\r
1211\r
1212 @return Status returned by real thunk code\r
1213\r
1214**/\r
1215UINTN\r
1216CallRealThunkCode (\r
1217 UINT8 *RealCode,\r
1218 UINT8 BiosInt,\r
1219 UINT32 CallAddress\r
1220 );\r
1221\r
1222/**\r
1223 Routine for generating soft interrupt.\r
1224\r
1225 @param Vector The interrupt vector number.\r
1226\r
1227**/\r
1228VOID\r
1229GenerateSoftInit (\r
1230 UINT8 Vector\r
1231 );\r
1232\r
1233/**\r
1234 Do an AllocatePages () of type AllocateMaxAddress for EfiBootServicesCode\r
1235 memory.\r
1236\r
1237 @param AllocateType Allocated Legacy Memory Type\r
1238 @param StartPageAddress Start address of range\r
1239 @param Pages Number of pages to allocate\r
1240 @param Result Result of allocation\r
1241\r
1242 @retval EFI_SUCCESS Legacy16 code loaded\r
1243 @retval Other No protocol installed, unload driver.\r
1244\r
1245**/\r
1246EFI_STATUS\r
1247AllocateLegacyMemory (\r
1248 IN EFI_ALLOCATE_TYPE AllocateType,\r
1249 IN EFI_PHYSICAL_ADDRESS StartPageAddress,\r
1250 IN UINTN Pages,\r
1251 OUT EFI_PHYSICAL_ADDRESS *Result\r
1252 );\r
1253\r
1254/**\r
1255 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
1256\r
1257 @param This Protocol instance pointer.\r
1258 @param LegacyMemorySize Size of required region\r
1259 @param Region Region to use. 00 = Either 0xE0000 or 0xF0000\r
1260 block Bit0 = 1 0xF0000 block Bit1 = 1 0xE0000\r
1261 block\r
1262 @param Alignment Address alignment. Bit mapped. First non-zero\r
1263 bit from right is alignment.\r
1264 @param LegacyMemoryAddress Region Assigned\r
1265\r
1266 @retval EFI_SUCCESS Region assigned\r
1267 @retval EFI_ACCESS_DENIED Procedure previously invoked\r
1268 @retval Other Region not assigned\r
1269\r
1270**/\r
1271EFI_STATUS\r
1272EFIAPI\r
1273LegacyBiosGetLegacyRegion (\r
1274 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
1275 IN UINTN LegacyMemorySize,\r
1276 IN UINTN Region,\r
1277 IN UINTN Alignment,\r
1278 OUT VOID **LegacyMemoryAddress\r
1279 );\r
1280\r
1281/**\r
1282 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
1283\r
1284 @param This Protocol instance pointer.\r
1285 @param LegacyMemorySize Size of data to copy\r
1286 @param LegacyMemoryAddress Legacy Region destination address Note: must\r
1287 be in region assigned by\r
1288 LegacyBiosGetLegacyRegion\r
1289 @param LegacyMemorySourceAddress Source of data\r
1290\r
1291 @retval EFI_SUCCESS Region assigned\r
1292 @retval EFI_ACCESS_DENIED Destination outside assigned region\r
1293\r
1294**/\r
1295EFI_STATUS\r
1296EFIAPI\r
1297LegacyBiosCopyLegacyRegion (\r
1298 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
1299 IN UINTN LegacyMemorySize,\r
1300 IN VOID *LegacyMemoryAddress,\r
1301 IN VOID *LegacyMemorySourceAddress\r
1302 );\r
1303\r
1304/**\r
1305 Find Legacy16 BIOS image in the FLASH device and shadow it into memory. Find\r
1306 the $EFI table in the shadow area. Thunk into the Legacy16 code after it had\r
1307 been shadowed.\r
1308\r
1309 @param Private Legacy BIOS context data\r
1310\r
1311 @retval EFI_SUCCESS Legacy16 code loaded\r
1312 @retval Other No protocol installed, unload driver.\r
1313\r
1314**/\r
1315EFI_STATUS\r
1316ShadowAndStartLegacy16 (\r
1317 IN LEGACY_BIOS_INSTANCE *Private\r
1318 );\r
1319\r
1320/**\r
1321 Checks the state of the floppy and if media is inserted.\r
1322 \r
1323 This routine checks the state of the floppy and if media is inserted.\r
1324 There are 3 cases:\r
1325 No floppy present - Set BBS entry to ignore\r
1326 Floppy present & no media - Set BBS entry to lowest priority. We cannot\r
1327 set it to ignore since 16-bit CSM will\r
1328 indicate no floppy and thus drive A: is\r
1329 unusable. CSM-16 will not try floppy since\r
1330 lowest priority and thus not incur boot\r
1331 time penality.\r
1332 Floppy present & media - Set BBS entry to some priority.\r
1333\r
1334 @return State of floppy media\r
1335\r
1336**/\r
1337UINT8\r
1338HasMediaInFloppy (\r
1339 VOID\r
1340 );\r
1341\r
1342/**\r
1343 Identify drive data must be updated to actual parameters before boot.\r
1344 This requires updating the checksum, if it exists.\r
1345\r
1346 @param IdentifyDriveData ATA Identify Data\r
1347 @param Checksum checksum of the ATA Identify Data\r
1348\r
1349 @retval EFI_SUCCESS checksum calculated\r
1350 @retval EFI_SECURITY_VIOLATION IdentifyData invalid\r
1351\r
1352**/\r
1353EFI_STATUS\r
1354CalculateIdentifyDriveChecksum (\r
1355 IN UINT8 *IdentifyDriveData,\r
1356 OUT UINT8 *Checksum\r
1357 );\r
1358\r
1359/**\r
1360 Identify drive data must be updated to actual parameters before boot.\r
1361\r
1362 @param IdentifyDriveData ATA Identify Data\r
1363\r
1364**/\r
1365VOID\r
1366UpdateIdentifyDriveData (\r
1367 IN UINT8 *IdentifyDriveData\r
1368 );\r
1369\r
1370/**\r
1371 Complete build of BBS TABLE.\r
1372\r
1373 @param Private Legacy BIOS Instance data\r
1374 @param BbsTable BBS Table passed to 16-bit code\r
1375\r
1376 @retval EFI_SUCCESS Removable media not present\r
1377\r
1378**/\r
1379EFI_STATUS\r
1380LegacyBiosBuildBbs (\r
1381 IN LEGACY_BIOS_INSTANCE *Private,\r
1382 IN BBS_TABLE *BbsTable\r
1383 );\r
1384\r
1385/**\r
1386 Read CMOS register through index/data port.\r
1387\r
1388 @param[in] Index The index of the CMOS register to read.\r
1389\r
1390 @return The data value from the CMOS register specified by Index.\r
1391\r
1392**/\r
1393UINT8\r
1394LegacyReadStandardCmos (\r
1395 IN UINT8 Index\r
1396 );\r
1397\r
1398/**\r
1399 Write CMOS register through index/data port.\r
1400\r
1401 @param[in] Index The index of the CMOS register to write.\r
1402 @param[in] Value The value of CMOS register to write.\r
1403\r
1404 @return The value written to the CMOS register specified by Index.\r
1405\r
1406**/\r
1407UINT8\r
1408LegacyWriteStandardCmos (\r
1409 IN UINT8 Index,\r
1410 IN UINT8 Value\r
1411 );\r
1412\r
1413/**\r
1414 Calculate the new standard CMOS checksum and write it.\r
1415\r
1416 @param Private Legacy BIOS Instance data\r
1417\r
1418 @retval EFI_SUCCESS Calculate 16-bit checksum successfully\r
1419\r
1420**/\r
1421EFI_STATUS\r
1422LegacyCalculateWriteStandardCmosChecksum (\r
1423 VOID\r
1424 );\r
1425\r
1426/**\r
1427 Test to see if a legacy PCI ROM exists for this device. Optionally return\r
1428 the Legacy ROM instance for this PCI device.\r
1429\r
1430 @param[in] This Protocol instance pointer.\r
1431 @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r
1432 @param[out] RomImage Return the legacy PCI ROM for this device\r
1433 @param[out] RomSize Size of ROM Image\r
1434 @param[out] RuntimeImageLength Runtime size of ROM Image\r
1435 @param[out] Flags Indicates if ROM found and if PC-AT.\r
1436 @param[out] OpromRevision Revision of the PCI Rom\r
1437 @param[out] ConfigUtilityCodeHeaderPointer of Configuration Utility Code Header\r
1438\r
1439 @return EFI_SUCCESS Legacy Option ROM availible for this device\r
1440 @return EFI_ALREADY_STARTED This device is already managed by its Oprom\r
1441 @return EFI_UNSUPPORTED Legacy Option ROM not supported.\r
1442\r
1443**/\r
1444EFI_STATUS\r
1445LegacyBiosCheckPciRomEx (\r
1446 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
1447 IN EFI_HANDLE PciHandle,\r
1448 OUT VOID **RomImage, OPTIONAL\r
1449 OUT UINTN *RomSize, OPTIONAL\r
1450 OUT UINTN *RuntimeImageLength, OPTIONAL\r
1451 OUT UINTN *Flags, OPTIONAL\r
1452 OUT UINT8 *OpromRevision, OPTIONAL\r
1453 OUT VOID **ConfigUtilityCodeHeader OPTIONAL\r
1454 );\r
1455\r
1456/**\r
1457 Relocate this image under 4G memory for IPF.\r
1458\r
1459 @param ImageHandle Handle of driver image.\r
1460 @param SystemTable Pointer to system table.\r
1461\r
1462 @retval EFI_SUCCESS Image successfully relocated.\r
1463 @retval EFI_ABORTED Failed to relocate image.\r
1464\r
1465**/\r
1466EFI_STATUS\r
1467RelocateImageUnder4GIfNeeded (\r
1468 IN EFI_HANDLE ImageHandle,\r
1469 IN EFI_SYSTEM_TABLE *SystemTable\r
1470 );\r
1471\r
1472/**\r
1473 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the\r
1474 16-bit register context on entry and exit. Arguments can be passed on\r
1475 the Stack argument\r
1476\r
1477 @param This Protocol instance pointer.\r
1478 @param Segment Segemnt of 16-bit mode call\r
1479 @param Offset Offset of 16-bit mdoe call\r
1480 @param Regs Register contexted passed into (and returned) from thunk to\r
1481 16-bit mode\r
1482 @param Stack Caller allocated stack used to pass arguments\r
1483 @param StackSize Size of Stack in bytes\r
1484\r
1485 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.\r
1486 See Regs for status.\r
1487 @retval TRUE There was a BIOS erro in the target code.\r
1488\r
1489**/\r
1490BOOLEAN\r
1491EFIAPI\r
1492InternalLegacyBiosFarCall (\r
1493 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
1494 IN UINT16 Segment,\r
1495 IN UINT16 Offset,\r
1496 IN EFI_IA32_REGISTER_SET *Regs,\r
1497 IN VOID *Stack,\r
1498 IN UINTN StackSize\r
1499 );\r
1500\r
1501#endif\r
EFI Development Kit II mirror for PVE