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