3 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions
7 of the BSD License which accompanies this distribution. The
8 full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef _LEGACY_BIOS_INTERFACE_
17 #define _LEGACY_BIOS_INTERFACE_
20 #include <FrameworkDxe.h>
21 #include <IndustryStandard/Pci.h>
22 #include <IndustryStandard/SmBios.h>
23 #include <IndustryStandard/Acpi10.h>
25 #include <Guid/SmBios.h>
26 #include <Guid/Acpi.h>
27 #include <Guid/DxeServices.h>
28 #include <Guid/LegacyBios.h>
29 #include <Guid/StatusCodeDataTypeId.h>
30 #include <Guid/ImageAuthentication.h>
32 #include <Protocol/BlockIo.h>
33 #include <Protocol/LoadedImage.h>
34 #include <Protocol/PciIo.h>
35 #include <Protocol/Cpu.h>
36 #include <Protocol/Timer.h>
37 #include <Protocol/IsaIo.h>
38 #include <Protocol/LegacyRegion2.h>
39 #include <Protocol/SimpleTextIn.h>
40 #include <Protocol/LegacyInterrupt.h>
41 #include <Protocol/LegacyBios.h>
42 #include <Protocol/DiskInfo.h>
43 #include <Protocol/GenericMemoryTest.h>
44 #include <Protocol/LegacyBiosPlatform.h>
45 #include <Protocol/DevicePath.h>
46 #include <Protocol/Legacy8259.h>
47 #include <Protocol/PciRootBridgeIo.h>
48 #include <Protocol/SerialIo.h>
49 #include <Protocol/SuperIo.h>
51 #include <Library/BaseLib.h>
52 #include <Library/DebugLib.h>
53 #include <Library/UefiLib.h>
54 #include <Library/BaseMemoryLib.h>
55 #include <Library/ReportStatusCodeLib.h>
56 #include <Library/UefiRuntimeServicesTableLib.h>
57 #include <Library/HobLib.h>
58 #include <Library/UefiDriverEntryPoint.h>
59 #include <Library/MemoryAllocationLib.h>
60 #include <Library/UefiBootServicesTableLib.h>
61 #include <Library/IoLib.h>
62 #include <Library/PcdLib.h>
63 #include <Library/DevicePathLib.h>
64 #include <Library/DxeServicesTableLib.h>
65 #include <Library/PeCoffLib.h>
66 #include <Library/CacheMaintenanceLib.h>
67 #include <Library/DebugAgentLib.h>
70 // BUGBUG: This entry maybe changed to PCD in future and wait for
71 // redesign of BDS library
73 #define MAX_BBS_ENTRIES 0x100
77 // (These apply only to errors with the thunk and not to the code that was
81 #define THUNK_ERR_A20_UNSUP 0x01
82 #define THUNK_ERR_A20_FAILED 0x02
85 // Vector base definitions
88 // 8259 Hardware definitions
90 #define LEGACY_MODE_BASE_VECTOR_MASTER 0x08
91 #define LEGACY_MODE_BASE_VECTOR_SLAVE 0x70
94 // The original PC used INT8-F for master PIC. Since these mapped over
95 // processor exceptions TIANO moved the master PIC to INT68-6F.
97 // The vector base for slave PIC is set as 0x70 for PC-AT compatibility.
99 #define PROTECTED_MODE_BASE_VECTOR_MASTER 0x68
100 #define PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70
103 // When we call CSM16 functions, some CSM16 use es:[offset + 0xabcd] to get data passed from CSM32,
104 // offset + 0xabcd could overflow which exceeds 0xFFFF which is invalid in real mode.
105 // So this will keep offset as small as possible to avoid offset overflow in real mode.
107 #define NORMALIZE_EFI_SEGMENT(_Adr) (UINT16) (((UINTN) (_Adr)) >> 4)
108 #define NORMALIZE_EFI_OFFSET(_Adr) (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xf)
114 #define LEGACY_BDA_TRACE 0x000
115 #define LEGACY_BIOS_TRACE 0x040
116 #define LEGACY_BOOT_TRACE 0x080
117 #define LEGACY_CMOS_TRACE 0x0C0
118 #define LEGACY_IDE_TRACE 0x100
119 #define LEGACY_MP_TRACE 0x140
120 #define LEGACY_PCI_TRACE 0x180
121 #define LEGACY_SIO_TRACE 0x1C0
123 #define LEGACY_PCI_TRACE_000 LEGACY_PCI_TRACE + 0x00
124 #define LEGACY_PCI_TRACE_001 LEGACY_PCI_TRACE + 0x01
125 #define LEGACY_PCI_TRACE_002 LEGACY_PCI_TRACE + 0x02
126 #define LEGACY_PCI_TRACE_003 LEGACY_PCI_TRACE + 0x03
127 #define LEGACY_PCI_TRACE_004 LEGACY_PCI_TRACE + 0x04
128 #define LEGACY_PCI_TRACE_005 LEGACY_PCI_TRACE + 0x05
129 #define LEGACY_PCI_TRACE_006 LEGACY_PCI_TRACE + 0x06
130 #define LEGACY_PCI_TRACE_007 LEGACY_PCI_TRACE + 0x07
131 #define LEGACY_PCI_TRACE_008 LEGACY_PCI_TRACE + 0x08
132 #define LEGACY_PCI_TRACE_009 LEGACY_PCI_TRACE + 0x09
133 #define LEGACY_PCI_TRACE_00A LEGACY_PCI_TRACE + 0x0A
134 #define LEGACY_PCI_TRACE_00B LEGACY_PCI_TRACE + 0x0B
135 #define LEGACY_PCI_TRACE_00C LEGACY_PCI_TRACE + 0x0C
136 #define LEGACY_PCI_TRACE_00D LEGACY_PCI_TRACE + 0x0D
137 #define LEGACY_PCI_TRACE_00E LEGACY_PCI_TRACE + 0x0E
138 #define LEGACY_PCI_TRACE_00F LEGACY_PCI_TRACE + 0x0F
140 #define BDA_VIDEO_MODE 0x49
142 #define IDE_PI_REGISTER_PNE BIT0
143 #define IDE_PI_REGISTER_SNE BIT2
150 UINT32 ShadowAddress
;
154 } ROM_INSTANCE_ENTRY
;
157 // Values for RealModeGdt
159 #if defined (MDE_CPU_IA32)
161 #define NUM_REAL_GDT_ENTRIES 3
162 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
163 #define INITIAL_VALUE_BELOW_1K 0x0
165 #elif defined (MDE_CPU_X64)
167 #define NUM_REAL_GDT_ENTRIES 8
168 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
169 #define INITIAL_VALUE_BELOW_1K 0x0
171 #elif defined (MDE_CPU_IPF)
173 #define NUM_REAL_GDT_ENTRIES 3
174 #define CONVENTIONAL_MEMORY_TOP 0x80000 // 512 KB
175 #define INITIAL_VALUE_BELOW_1K 0xff
182 // Define what a processor GDT looks like
195 UINT32 DefaultSize
: 1;
196 UINT32 Granularity
: 1;
210 // Define what a processor descriptor looks like
211 // This data structure must be kept in sync with ASM STRUCT in Thunk.inc
226 #define LOW_STACK_SIZE (8 * 1024) // 8k?
227 #define EFI_MAX_E820_ENTRY 100
228 #define FIRST_INSTANCE 1
229 #define NOT_FIRST_INSTANCE 0
231 #if defined (MDE_CPU_IA32)
234 // Space for the code
235 // The address of Code is also the beginning of the relocated Thunk code
237 CHAR8 Code
[4096]; // ?
239 // The address of the Reverse Thunk code
240 // Note that this member CONTAINS the address of the relocated reverse thunk
241 // code unlike the member variable 'Code', which IS the address of the Thunk
244 UINT32 LowReverseThunkStart
;
247 // Data for the code (cs releative)
249 DESCRIPTOR32 GdtDesc
; // Protected mode GDT
250 DESCRIPTOR32 IdtDesc
; // Protected mode IDT
254 UINT32 LowCodeSelector
; // Low code selector in GDT
255 UINT32 LowDataSelector
; // Low data selector in GDT
257 DESCRIPTOR32 RealModeIdtDesc
;
260 // real-mode GDT (temporary GDT with two real mode segment descriptors)
262 GDT32 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
263 DESCRIPTOR32 RealModeGdtDesc
;
266 // Members specifically for the reverse thunk
267 // The RevReal* members are used to store the current state of real mode
268 // before performing the reverse thunk. The RevFlat* members must be set
269 // before calling the reverse thunk assembly code.
274 DESCRIPTOR32 RevRealIdtDesc
;
275 UINT16 RevFlatDataSelector
; // Flat data selector in GDT
279 // A low memory stack
281 CHAR8 Stack
[LOW_STACK_SIZE
];
284 // Stack for flat mode after reverse thunk
285 // @bug - This may no longer be necessary if the reverse thunk interface
286 // is changed to have the flat stack in a different location.
288 CHAR8 RevThunkStack
[LOW_STACK_SIZE
];
291 // Legacy16 Init memory map info
293 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
295 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
297 CHAR8 InterruptRedirectionCode
[32];
298 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
299 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
300 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
303 #elif defined (MDE_CPU_X64)
307 // Space for the code
308 // The address of Code is also the beginning of the relocated Thunk code
310 CHAR8 Code
[4096]; // ?
313 // Data for the code (cs releative)
315 DESCRIPTOR64 X64GdtDesc
; // Protected mode GDT
316 DESCRIPTOR64 X64IdtDesc
; // Protected mode IDT
321 DESCRIPTOR32 RealModeIdtDesc
;
322 DESCRIPTOR32 RealModeGdtDesc
;
325 // real-mode GDT (temporary GDT with two real mode segment descriptors)
327 GDT64 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
328 UINT64 PageMapLevel4
;
331 // A low memory stack
333 CHAR8 Stack
[LOW_STACK_SIZE
];
336 // Legacy16 Init memory map info
338 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
340 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
342 CHAR8 InterruptRedirectionCode
[32];
343 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
344 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
345 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
348 #elif defined (MDE_CPU_IPF)
352 // Space for the code
353 // The address of Code is also the beginning of the relocated Thunk code
355 CHAR8 Code
[4096]; // ?
357 // The address of the Reverse Thunk code
358 // Note that this member CONTAINS the address of the relocated reverse thunk
359 // code unlike the member variable 'Code', which IS the address of the Thunk
362 UINT32 LowReverseThunkStart
;
365 // Data for the code (cs releative)
367 DESCRIPTOR32 GdtDesc
; // Protected mode GDT
368 DESCRIPTOR32 IdtDesc
; // Protected mode IDT
372 UINT32 LowCodeSelector
; // Low code selector in GDT
373 UINT32 LowDataSelector
; // Low data selector in GDT
375 DESCRIPTOR32 RealModeIdtDesc
;
378 // real-mode GDT (temporary GDT with two real mode segment descriptors)
380 GDT32 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
381 DESCRIPTOR32 RealModeGdtDesc
;
384 // Members specifically for the reverse thunk
385 // The RevReal* members are used to store the current state of real mode
386 // before performing the reverse thunk. The RevFlat* members must be set
387 // before calling the reverse thunk assembly code.
392 DESCRIPTOR32 RevRealIdtDesc
;
393 UINT16 RevFlatDataSelector
; // Flat data selector in GDT
397 // A low memory stack
399 CHAR8 Stack
[LOW_STACK_SIZE
];
402 // Stack for flat mode after reverse thunk
403 // @bug - This may no longer be necessary if the reverse thunk interface
404 // is changed to have the flat stack in a different location.
406 CHAR8 RevThunkStack
[LOW_STACK_SIZE
];
409 // Legacy16 Init memory map info
411 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
413 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
415 CHAR8 InterruptRedirectionCode
[32];
416 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
417 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
418 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
424 // PnP Expansion Header
435 UINT16 ProductNamePointer
;
439 UINT8 DeviceIndicators
;
441 UINT16 DisconnectVector
;
444 UINT16 StaticResourceVector
;
445 } LEGACY_PNP_EXPANSION_HEADER
;
461 UINTN ManufacturerString
;
462 UINTN ProductNameString
;
463 } LEGACY_ROM_AND_BBS_TABLE
;
466 // Structure how EFI has mapped a devices HDD drive numbers.
467 // Boot to EFI aware OS or shell requires this mapping when
468 // 16-bit CSM assigns drive numbers.
469 // This mapping is ignored booting to a legacy OS.
476 UINT8 StartDriveNumber
;
477 UINT8 EndDriveNumber
;
478 } LEGACY_EFI_HDD_TABLE
;
481 // This data is passed to Leacy16Boot
484 EfiAcpiAddressRangeMemory
= 1,
485 EfiAcpiAddressRangeReserved
= 2,
486 EfiAcpiAddressRangeACPI
= 3,
487 EfiAcpiAddressRangeNVS
= 4,
488 EfiAddressRangePersistentMemory
= 7
489 } EFI_ACPI_MEMORY_TYPE
;
494 EFI_ACPI_MEMORY_TYPE Type
;
502 EFI_ACPI_MEMORY_TYPE Type
;
507 extern BBS_TABLE
*mBbsTable
;
509 extern EFI_GENERIC_MEMORY_TEST_PROTOCOL
*gGenMemoryTest
;
514 #define CMOS_0A 0x0a ///< Status register A
515 #define CMOS_0D 0x0d ///< Status register D
516 #define CMOS_0E 0x0e ///< Diagnostic Status
517 #define CMOS_0F 0x0f ///< Shutdown status
518 #define CMOS_10 0x10 ///< Floppy type
519 #define CMOS_12 0x12 ///< IDE type
520 #define CMOS_14 0x14 ///< Same as BDA 40:10
521 #define CMOS_15 0x15 ///< Low byte of base memory in 1k increments
522 #define CMOS_16 0x16 ///< High byte of base memory in 1k increments
523 #define CMOS_17 0x17 ///< Low byte of 1MB+ memory in 1k increments - max 15 MB
524 #define CMOS_18 0x18 ///< High byte of 1MB+ memory in 1k increments - max 15 MB
525 #define CMOS_19 0x19 ///< C: extended drive type
526 #define CMOS_1A 0x1a ///< D: extended drive type
527 #define CMOS_2E 0x2e ///< Most significient byte of standard checksum
528 #define CMOS_2F 0x2f ///< Least significient byte of standard checksum
529 #define CMOS_30 0x30 ///< CMOS 0x17
530 #define CMOS_31 0x31 ///< CMOS 0x18
531 #define CMOS_32 0x32 ///< Century byte
534 // 8254 Timer registers
536 #define TIMER0_COUNT_PORT 0x40
537 #define TIMER1_COUNT_PORT 0x41
538 #define TIMER2_COUNT_PORT 0x42
539 #define TIMER_CONTROL_PORT 0x43
542 // Timer 0, Read/Write LSB then MSB, Square wave output, binary count use.
544 #define TIMER0_CONTROL_WORD 0x36
546 #define LEGACY_BIOS_INSTANCE_SIGNATURE SIGNATURE_32 ('L', 'B', 'I', 'T')
551 EFI_LEGACY_BIOS_PROTOCOL LegacyBios
;
553 EFI_HANDLE ImageHandle
;
556 // CPU Architectural Protocol
558 EFI_CPU_ARCH_PROTOCOL
*Cpu
;
561 // Timer Architectural Protocol
563 EFI_TIMER_ARCH_PROTOCOL
*Timer
;
564 BOOLEAN TimerUses8254
;
567 // Protocol to Lock and Unlock 0xc0000 - 0xfffff
569 EFI_LEGACY_REGION2_PROTOCOL
*LegacyRegion
;
571 EFI_LEGACY_BIOS_PLATFORM_PROTOCOL
*LegacyBiosPlatform
;
574 // Interrupt control for thunk and PCI IRQ
576 EFI_LEGACY_8259_PROTOCOL
*Legacy8259
;
579 // PCI Interrupt PIRQ control
581 EFI_LEGACY_INTERRUPT_PROTOCOL
*LegacyInterrupt
;
584 // Generic Memory Test
586 EFI_GENERIC_MEMORY_TEST_PROTOCOL
*GenericMemoryTest
;
589 // TRUE if PCI Interupt Line registers have been programmed.
591 BOOLEAN PciInterruptLine
;
594 // Code space below 1MB needed by thunker to transition to real mode.
595 // Contains stack and real mode code fragments
597 LOW_MEMORY_THUNK
*IntThunk
;
600 // Starting shadow address of the Legacy BIOS
603 UINT32 LegacyBiosImageSize
;
606 // Start of variables used by CsmItp.mac ITP macro file and/os LegacyBios
611 // $EFI Legacy16 code entry info in memory < 1 MB;
613 EFI_COMPATIBILITY16_TABLE
*Legacy16Table
;
614 VOID
*Legacy16InitPtr
;
615 VOID
*Legacy16BootPtr
;
616 VOID
*InternalIrqRoutingTable
;
617 UINT32 NumberIrqRoutingEntries
;
620 UINT32 NumberHddControllers
;
623 // Cached copy of Legacy16 entry point
625 UINT16 Legacy16CallSegment
;
626 UINT16 Legacy16CallOffset
;
629 // Returned from $EFI and passed in to OPROMS
631 UINT16 PnPInstallationCheckSegment
;
632 UINT16 PnPInstallationCheckOffset
;
637 EFI_E820_ENTRY E820Table
[EFI_MAX_E820_ENTRY
];
638 UINT32 NumberE820Entries
;
641 // True if legacy VGA INT 10h handler installed
643 BOOLEAN VgaInstalled
;
646 // Number of IDE drives
651 // Current Free Option ROM space. An option ROM must NOT go past
657 // Save Legacy16 unexpected interrupt vector. Reprogram INT 68-6F from
658 // EFI values to legacy value just before boot.
660 UINT32 BiosUnexpectedInt
;
661 UINT32 ThunkSavedInt
[8];
663 LEGACY_EFI_HDD_TABLE
*LegacyEfiHddTable
;
664 UINT16 LegacyEfiHddTableIndex
;
671 // Indicate that whether GenericLegacyBoot is entered or not
673 BOOLEAN LegacyBootEntered
;
676 // CSM16 PCI Interface Version
678 UINT16 Csm16PciInterfaceVersion
;
680 } LEGACY_BIOS_INSTANCE
;
693 40:0E-0E Ebda segment
694 40:10-11 MachineConfig
696 40:13-14 MemSize below 1MB
697 40:15-16 Bda15_16 - skip
698 40:17 Keyboard Shift status
699 40:18-19 Bda18_19 - skip
700 40:1A-1B Key buffer head
701 40:1C-1D Key buffer tail
702 40:1E-3D Bda1E_3D- key buffer -skip
703 40:3E-3F FloppyData 3E = Calibration status 3F = Motor status
705 40:41-74 Bda41_74 - skip
706 40:75 Number of HDD drives
707 40:76-77 Bda76_77 - skip
708 40:78-79 78 = Lpt1 timeout, 79 = Lpt2 timeout
709 40:7A-7B 7A = Lpt3 timeout, 7B = Lpt4 timeout
710 40:7C-7D 7C = Com1 timeout, 7D = Com2 timeout
711 40:7E-7F 7E = Com3 timeout, 7F = Com4 timeout
712 40:80-81 Pointer to start of key buffer
713 40:82-83 Pointer to end of key buffer
714 40:84-87 Bda84_87 - skip
715 40:88 HDD Data Xmit rate
717 40:90 Floppy data rate
719 40:96 Keyboard Status
732 UINT16 MachineConfig
;
735 UINT8 Bda15_16
[0x02];
737 UINT8 Bda18_19
[0x02];
740 UINT16 Bda1E_3D
[0x10];
743 UINT8 Bda41_74
[0x34];
744 UINT8 NumberOfDrives
;
745 UINT8 Bda76_77
[0x02];
746 UINT16 Lpt1_2Timeout
;
747 UINT16 Lpt3_4Timeout
;
748 UINT16 Com1_2Timeout
;
749 UINT16 Com3_4Timeout
;
754 UINT8 Bda89_8F
[0x07];
756 UINT8 Bda91_95
[0x05];
757 UINT8 KeyboardStatus
;
762 #define LEGACY_BIOS_INSTANCE_FROM_THIS(this) CR (this, LEGACY_BIOS_INSTANCE, LegacyBios, LEGACY_BIOS_INSTANCE_SIGNATURE)
765 Thunk to 16-bit real mode and execute a software interrupt with a vector
766 of BiosInt. Regs will contain the 16-bit register context on entry and
769 @param This Protocol instance pointer.
770 @param BiosInt Processor interrupt vector to invoke
771 @param Regs Register contexted passed into (and returned) from thunk to
774 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
776 @retval TRUE There was a BIOS erro in the target code.
782 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
784 IN EFI_IA32_REGISTER_SET
*Regs
789 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
790 16-bit register context on entry and exit. Arguments can be passed on
793 @param This Protocol instance pointer.
794 @param Segment Segemnt of 16-bit mode call
795 @param Offset Offset of 16-bit mdoe call
796 @param Regs Register contexted passed into (and returned) from
798 @param Stack Caller allocated stack used to pass arguments
799 @param StackSize Size of Stack in bytes
801 @retval FALSE Thunk completed, and there were no BIOS errors in
802 the target code. See Regs for status.
803 @retval TRUE There was a BIOS erro in the target code.
808 LegacyBiosFarCall86 (
809 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
812 IN EFI_IA32_REGISTER_SET
*Regs
,
819 Test to see if a legacy PCI ROM exists for this device. Optionally return
820 the Legacy ROM instance for this PCI device.
822 @param This Protocol instance pointer.
823 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
825 @param RomImage Return the legacy PCI ROM for this device
826 @param RomSize Size of ROM Image
827 @param Flags Indicates if ROM found and if PC-AT.
829 @retval EFI_SUCCESS Legacy Option ROM available for this device
830 @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
835 LegacyBiosCheckPciRom (
836 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
837 IN EFI_HANDLE PciHandle
,
838 OUT VOID
**RomImage
, OPTIONAL
839 OUT UINTN
*RomSize
, OPTIONAL
845 Assign drive number to legacy HDD drives prior to booting an EFI
846 aware OS so the OS can access drives without an EFI driver.
847 Note: BBS compliant drives ARE NOT available until this call by
850 @param This Protocol instance pointer.
851 @param BbsCount Number of BBS_TABLE structures
852 @param BbsTable List BBS entries
854 @retval EFI_SUCCESS Drive numbers assigned
859 LegacyBiosPrepareToBootEfi (
860 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
861 OUT UINT16
*BbsCount
,
862 OUT BBS_TABLE
**BbsTable
867 To boot from an unconventional device like parties and/or execute
870 @param This Protocol instance pointer.
871 @param Attributes How to interpret the other input parameters
872 @param BbsEntry The 0-based index into the BbsTable for the parent
874 @param BeerData Pointer to the 128 bytes of ram BEER data.
875 @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data.
876 The caller must provide a pointer to the specific
877 Service Area and not the start all Service Areas.
878 EFI_INVALID_PARAMETER if error. Does NOT return if no error.
883 LegacyBiosBootUnconventionalDevice (
884 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
885 IN UDC_ATTRIBUTES Attributes
,
888 IN VOID
*ServiceAreaData
893 Load a legacy PC-AT OPROM on the PciHandle device. Return information
894 about how many disks were added by the OPROM and the shadow address and
895 size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:
897 @param This Protocol instance pointer.
898 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
899 be loaded. This value is NULL if RomImage is
900 non-NULL. This is the normal case.
901 @param RomImage A PCI PC-AT ROM image. This argument is non-NULL
902 if there is no hardware associated with the ROM
903 and thus no PciHandle, otherwise is must be NULL.
904 Example is PXE base code.
905 @param Flags Indicates if ROM found and if PC-AT.
906 @param DiskStart Disk number of first device hooked by the ROM. If
907 DiskStart is the same as DiskEnd no disked were
909 @param DiskEnd Disk number of the last device hooked by the ROM.
910 @param RomShadowAddress Shadow address of PC-AT ROM
911 @param RomShadowedSize Size of RomShadowAddress in bytes
913 @retval EFI_SUCCESS Legacy ROM loaded for this device
914 @retval EFI_INVALID_PARAMETER PciHandle not found
915 @retval EFI_UNSUPPORTED There is no PCI ROM in the ROM BAR or no onboard
921 LegacyBiosInstallPciRom (
922 IN EFI_LEGACY_BIOS_PROTOCOL
* This
,
923 IN EFI_HANDLE PciHandle
,
926 OUT UINT8
*DiskStart
, OPTIONAL
927 OUT UINT8
*DiskEnd
, OPTIONAL
928 OUT VOID
**RomShadowAddress
, OPTIONAL
929 OUT UINT32
*RomShadowedSize OPTIONAL
934 Fill in the standard BDA for Keyboard LEDs
936 @param This Protocol instance pointer.
937 @param Leds Current LED status
939 @retval EFI_SUCCESS It should always work.
944 LegacyBiosUpdateKeyboardLedStatus (
945 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
953 @param This Protocol instance pointer.
954 @param HddCount Number of HDD_INFO structures
955 @param HddInfo Onboard IDE controller information
956 @param BbsCount Number of BBS_TABLE structures
957 @param BbsTable List BBS entries
959 @retval EFI_SUCCESS Tables returned
960 @retval EFI_NOT_FOUND resource not found
961 @retval EFI_DEVICE_ERROR can not get BBS table
966 LegacyBiosGetBbsInfo (
967 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
968 OUT UINT16
*HddCount
,
969 OUT HDD_INFO
**HddInfo
,
970 OUT UINT16
*BbsCount
,
971 OUT BBS_TABLE
**BbsTable
976 Shadow all legacy16 OPROMs that haven't been shadowed.
977 Warning: Use this with caution. This routine disconnects all EFI
978 drivers. If used externally then caller must re-connect EFI
981 @param This Protocol instance pointer.
983 @retval EFI_SUCCESS OPROMs shadowed
988 LegacyBiosShadowAllLegacyOproms (
989 IN EFI_LEGACY_BIOS_PROTOCOL
*This
994 Attempt to legacy boot the BootOption. If the EFI contexted has been
995 compromised this function will not return.
997 @param This Protocol instance pointer.
998 @param BbsDevicePath EFI Device Path from BootXXXX variable.
999 @param LoadOptionsSize Size of LoadOption in size.
1000 @param LoadOptions LoadOption from BootXXXX variable
1002 @retval EFI_SUCCESS Removable media not present
1007 LegacyBiosLegacyBoot (
1008 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1009 IN BBS_BBS_DEVICE_PATH
*BbsDevicePath
,
1010 IN UINT32 LoadOptionsSize
,
1011 IN VOID
*LoadOptions
1016 Allocate memory < 1 MB and copy the thunker code into low memory. Se up
1017 all the descriptors.
1019 @param Private Private context for Legacy BIOS
1021 @retval EFI_SUCCESS Should only pass.
1025 LegacyBiosInitializeThunk (
1026 IN LEGACY_BIOS_INSTANCE
*Private
1031 Fill in the standard BDA and EBDA stuff before Legacy16 load
1033 @param Private Legacy BIOS Instance data
1035 @retval EFI_SUCCESS It should always work.
1040 IN LEGACY_BIOS_INSTANCE
*Private
1045 Collect IDE Inquiry data from the IDE disks
1047 @param Private Legacy BIOS Instance data
1048 @param HddInfo Hdd Information
1049 @param Flag Reconnect IdeController or not
1051 @retval EFI_SUCCESS It should always work.
1055 LegacyBiosBuildIdeData (
1056 IN LEGACY_BIOS_INSTANCE
*Private
,
1057 IN HDD_INFO
**HddInfo
,
1063 Enable ide controller. This gets disabled when LegacyBoot.c is about
1064 to run the Option ROMs.
1066 @param Private Legacy BIOS Instance data
1071 EnableIdeController (
1072 IN LEGACY_BIOS_INSTANCE
*Private
1077 If the IDE channel is in compatibility (legacy) mode, remove all
1078 PCI I/O BAR addresses from the controller.
1080 @param IdeController The handle of target IDE controller
1085 InitLegacyIdeController (
1086 IN EFI_HANDLE IdeController
1091 Program the interrupt routing register in all the PCI devices. On a PC AT system
1092 this register contains the 8259 IRQ vector that matches it's PCI interrupt.
1094 @param Private Legacy BIOS Instance data
1096 @retval EFI_SUCCESS Succeed.
1097 @retval EFI_ALREADY_STARTED All PCI devices have been processed.
1101 PciProgramAllInterruptLineRegisters (
1102 IN LEGACY_BIOS_INSTANCE
*Private
1107 Collect EFI Info about legacy devices.
1109 @param Private Legacy BIOS Instance data
1111 @retval EFI_SUCCESS It should always work.
1115 LegacyBiosBuildSioData (
1116 IN LEGACY_BIOS_INSTANCE
*Private
1121 Shadow all the PCI legacy ROMs. Use data from the Legacy BIOS Protocol
1122 to chose the order. Skip any devices that have already have legacy
1125 @param Private Protocol instance pointer.
1127 @retval EFI_SUCCESS Succeed.
1128 @retval EFI_UNSUPPORTED Cannot get VGA device handle.
1133 IN LEGACY_BIOS_INSTANCE
*Private
1138 Fill in the standard BDA and EBDA stuff prior to legacy Boot
1140 @param Private Legacy BIOS Instance data
1142 @retval EFI_SUCCESS It should always work.
1146 LegacyBiosCompleteBdaBeforeBoot (
1147 IN LEGACY_BIOS_INSTANCE
*Private
1152 Fill in the standard CMOS stuff before Legacy16 load
1154 @param Private Legacy BIOS Instance data
1156 @retval EFI_SUCCESS It should always work.
1160 LegacyBiosInitCmos (
1161 IN LEGACY_BIOS_INSTANCE
*Private
1166 Fill in the standard CMOS stuff prior to legacy Boot
1168 @param Private Legacy BIOS Instance data
1170 @retval EFI_SUCCESS It should always work.
1174 LegacyBiosCompleteStandardCmosBeforeBoot (
1175 IN LEGACY_BIOS_INSTANCE
*Private
1180 Contains the code that is copied into low memory (below 640K).
1181 This code reflects interrupts 0x68-0x6f to interrupts 0x08-0x0f.
1182 This template must be copied into low memory, and the IDT entries
1183 0x68-0x6F must be point to the low memory copy of this code. Each
1184 entry is 4 bytes long, so IDT entries 0x68-0x6F can be easily
1189 InterruptRedirectionTemplate (
1195 Build the E820 table.
1197 @param Private Legacy BIOS Instance data
1198 @param Size Size of E820 Table
1200 @retval EFI_SUCCESS It should always work.
1204 LegacyBiosBuildE820 (
1205 IN LEGACY_BIOS_INSTANCE
*Private
,
1210 This function is to put all AP in halt state.
1212 @param Private Legacy BIOS Instance data
1217 IN LEGACY_BIOS_INSTANCE
*Private
1221 Worker function for LegacyBiosGetFlatDescs, retrieving content of
1224 @param IntThunk Pointer to IntThunk of Legacy BIOS context.
1229 LOW_MEMORY_THUNK
*IntThunk
1233 Routine for calling real thunk code.
1235 @param RealCode The address of thunk code.
1236 @param BiosInt The Bios interrupt vector number.
1237 @param CallAddress The address of 16-bit mode call.
1239 @return Status returned by real thunk code
1250 Routine for generating soft interrupt.
1252 @param Vector The interrupt vector number.
1261 Do an AllocatePages () of type AllocateMaxAddress for EfiBootServicesCode
1264 @param AllocateType Allocated Legacy Memory Type
1265 @param StartPageAddress Start address of range
1266 @param Pages Number of pages to allocate
1267 @param Result Result of allocation
1269 @retval EFI_SUCCESS Legacy16 code loaded
1270 @retval Other No protocol installed, unload driver.
1274 AllocateLegacyMemory (
1275 IN EFI_ALLOCATE_TYPE AllocateType
,
1276 IN EFI_PHYSICAL_ADDRESS StartPageAddress
,
1278 OUT EFI_PHYSICAL_ADDRESS
*Result
1282 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1284 @param This Protocol instance pointer.
1285 @param LegacyMemorySize Size of required region
1286 @param Region Region to use. 00 = Either 0xE0000 or 0xF0000
1287 block Bit0 = 1 0xF0000 block Bit1 = 1 0xE0000
1289 @param Alignment Address alignment. Bit mapped. First non-zero
1290 bit from right is alignment.
1291 @param LegacyMemoryAddress Region Assigned
1293 @retval EFI_SUCCESS Region assigned
1294 @retval EFI_ACCESS_DENIED Procedure previously invoked
1295 @retval Other Region not assigned
1300 LegacyBiosGetLegacyRegion (
1301 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1302 IN UINTN LegacyMemorySize
,
1305 OUT VOID
**LegacyMemoryAddress
1309 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1311 @param This Protocol instance pointer.
1312 @param LegacyMemorySize Size of data to copy
1313 @param LegacyMemoryAddress Legacy Region destination address Note: must
1314 be in region assigned by
1315 LegacyBiosGetLegacyRegion
1316 @param LegacyMemorySourceAddress Source of data
1318 @retval EFI_SUCCESS Region assigned
1319 @retval EFI_ACCESS_DENIED Destination outside assigned region
1324 LegacyBiosCopyLegacyRegion (
1325 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1326 IN UINTN LegacyMemorySize
,
1327 IN VOID
*LegacyMemoryAddress
,
1328 IN VOID
*LegacyMemorySourceAddress
1332 Find Legacy16 BIOS image in the FLASH device and shadow it into memory. Find
1333 the $EFI table in the shadow area. Thunk into the Legacy16 code after it had
1336 @param Private Legacy BIOS context data
1338 @retval EFI_SUCCESS Legacy16 code loaded
1339 @retval Other No protocol installed, unload driver.
1343 ShadowAndStartLegacy16 (
1344 IN LEGACY_BIOS_INSTANCE
*Private
1348 Checks the state of the floppy and if media is inserted.
1350 This routine checks the state of the floppy and if media is inserted.
1352 No floppy present - Set BBS entry to ignore
1353 Floppy present & no media - Set BBS entry to lowest priority. We cannot
1354 set it to ignore since 16-bit CSM will
1355 indicate no floppy and thus drive A: is
1356 unusable. CSM-16 will not try floppy since
1357 lowest priority and thus not incur boot
1359 Floppy present & media - Set BBS entry to some priority.
1361 @return State of floppy media
1370 Identify drive data must be updated to actual parameters before boot.
1371 This requires updating the checksum, if it exists.
1373 @param IdentifyDriveData ATA Identify Data
1374 @param Checksum checksum of the ATA Identify Data
1376 @retval EFI_SUCCESS checksum calculated
1377 @retval EFI_SECURITY_VIOLATION IdentifyData invalid
1381 CalculateIdentifyDriveChecksum (
1382 IN UINT8
*IdentifyDriveData
,
1387 Identify drive data must be updated to actual parameters before boot.
1389 @param IdentifyDriveData ATA Identify Data
1393 UpdateIdentifyDriveData (
1394 IN UINT8
*IdentifyDriveData
1398 Complete build of BBS TABLE.
1400 @param Private Legacy BIOS Instance data
1401 @param BbsTable BBS Table passed to 16-bit code
1403 @retval EFI_SUCCESS Removable media not present
1407 LegacyBiosBuildBbs (
1408 IN LEGACY_BIOS_INSTANCE
*Private
,
1409 IN BBS_TABLE
*BbsTable
1413 Read CMOS register through index/data port.
1415 @param[in] Index The index of the CMOS register to read.
1417 @return The data value from the CMOS register specified by Index.
1421 LegacyReadStandardCmos (
1426 Write CMOS register through index/data port.
1428 @param[in] Index The index of the CMOS register to write.
1429 @param[in] Value The value of CMOS register to write.
1431 @return The value written to the CMOS register specified by Index.
1435 LegacyWriteStandardCmos (
1441 Calculate the new standard CMOS checksum and write it.
1443 @param Private Legacy BIOS Instance data
1445 @retval EFI_SUCCESS Calculate 16-bit checksum successfully
1449 LegacyCalculateWriteStandardCmosChecksum (
1454 Test to see if a legacy PCI ROM exists for this device. Optionally return
1455 the Legacy ROM instance for this PCI device.
1457 @param[in] This Protocol instance pointer.
1458 @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
1459 @param[out] RomImage Return the legacy PCI ROM for this device
1460 @param[out] RomSize Size of ROM Image
1461 @param[out] RuntimeImageLength Runtime size of ROM Image
1462 @param[out] Flags Indicates if ROM found and if PC-AT.
1463 @param[out] OpromRevision Revision of the PCI Rom
1464 @param[out] ConfigUtilityCodeHeaderPointer of Configuration Utility Code Header
1466 @return EFI_SUCCESS Legacy Option ROM available for this device
1467 @return EFI_ALREADY_STARTED This device is already managed by its Oprom
1468 @return EFI_UNSUPPORTED Legacy Option ROM not supported.
1472 LegacyBiosCheckPciRomEx (
1473 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1474 IN EFI_HANDLE PciHandle
,
1475 OUT VOID
**RomImage
, OPTIONAL
1476 OUT UINTN
*RomSize
, OPTIONAL
1477 OUT UINTN
*RuntimeImageLength
, OPTIONAL
1478 OUT UINTN
*Flags
, OPTIONAL
1479 OUT UINT8
*OpromRevision
, OPTIONAL
1480 OUT VOID
**ConfigUtilityCodeHeader OPTIONAL
1484 Relocate this image under 4G memory for IPF.
1486 @param ImageHandle Handle of driver image.
1487 @param SystemTable Pointer to system table.
1489 @retval EFI_SUCCESS Image successfully relocated.
1490 @retval EFI_ABORTED Failed to relocate image.
1494 RelocateImageUnder4GIfNeeded (
1495 IN EFI_HANDLE ImageHandle
,
1496 IN EFI_SYSTEM_TABLE
*SystemTable
1500 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
1501 16-bit register context on entry and exit. Arguments can be passed on
1504 @param This Protocol instance pointer.
1505 @param Segment Segemnt of 16-bit mode call
1506 @param Offset Offset of 16-bit mdoe call
1507 @param Regs Register contexted passed into (and returned) from thunk to
1509 @param Stack Caller allocated stack used to pass arguments
1510 @param StackSize Size of Stack in bytes
1512 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
1513 See Regs for status.
1514 @retval TRUE There was a BIOS erro in the target code.
1519 InternalLegacyBiosFarCall (
1520 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1523 IN EFI_IA32_REGISTER_SET
*Regs
,
1529 Load a legacy PC-AT OpROM for VGA controller.
1531 @param Private Driver private data.
1533 @retval EFI_SUCCESS Legacy ROM successfully installed for this device.
1534 @retval EFI_DEVICE_ERROR No VGA device handle found, or native EFI video
1535 driver cannot be successfully disconnected, or VGA
1536 thunk driver cannot be successfully connected.
1540 LegacyBiosInstallVgaRom (
1541 IN LEGACY_BIOS_INSTANCE
*Private