3 Copyright (c) 2006 - 2018, 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>
50 #include <Protocol/IoMmu.h>
52 #include <Library/BaseLib.h>
53 #include <Library/DebugLib.h>
54 #include <Library/UefiLib.h>
55 #include <Library/BaseMemoryLib.h>
56 #include <Library/ReportStatusCodeLib.h>
57 #include <Library/UefiRuntimeServicesTableLib.h>
58 #include <Library/HobLib.h>
59 #include <Library/UefiDriverEntryPoint.h>
60 #include <Library/MemoryAllocationLib.h>
61 #include <Library/UefiBootServicesTableLib.h>
62 #include <Library/IoLib.h>
63 #include <Library/PcdLib.h>
64 #include <Library/DevicePathLib.h>
65 #include <Library/DxeServicesTableLib.h>
66 #include <Library/PeCoffLib.h>
67 #include <Library/CacheMaintenanceLib.h>
68 #include <Library/DebugAgentLib.h>
71 // BUGBUG: This entry maybe changed to PCD in future and wait for
72 // redesign of BDS library
74 #define MAX_BBS_ENTRIES 0x100
78 // (These apply only to errors with the thunk and not to the code that was
82 #define THUNK_ERR_A20_UNSUP 0x01
83 #define THUNK_ERR_A20_FAILED 0x02
86 // Vector base definitions
89 // 8259 Hardware definitions
91 #define LEGACY_MODE_BASE_VECTOR_MASTER 0x08
92 #define LEGACY_MODE_BASE_VECTOR_SLAVE 0x70
95 // The original PC used INT8-F for master PIC. Since these mapped over
96 // processor exceptions TIANO moved the master PIC to INT68-6F.
98 // The vector base for slave PIC is set as 0x70 for PC-AT compatibility.
100 #define PROTECTED_MODE_BASE_VECTOR_MASTER 0x68
101 #define PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70
104 // When we call CSM16 functions, some CSM16 use es:[offset + 0xabcd] to get data passed from CSM32,
105 // offset + 0xabcd could overflow which exceeds 0xFFFF which is invalid in real mode.
106 // So this will keep offset as small as possible to avoid offset overflow in real mode.
108 #define NORMALIZE_EFI_SEGMENT(_Adr) (UINT16) (((UINTN) (_Adr)) >> 4)
109 #define NORMALIZE_EFI_OFFSET(_Adr) (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xf)
115 #define LEGACY_BDA_TRACE 0x000
116 #define LEGACY_BIOS_TRACE 0x040
117 #define LEGACY_BOOT_TRACE 0x080
118 #define LEGACY_CMOS_TRACE 0x0C0
119 #define LEGACY_IDE_TRACE 0x100
120 #define LEGACY_MP_TRACE 0x140
121 #define LEGACY_PCI_TRACE 0x180
122 #define LEGACY_SIO_TRACE 0x1C0
124 #define LEGACY_PCI_TRACE_000 LEGACY_PCI_TRACE + 0x00
125 #define LEGACY_PCI_TRACE_001 LEGACY_PCI_TRACE + 0x01
126 #define LEGACY_PCI_TRACE_002 LEGACY_PCI_TRACE + 0x02
127 #define LEGACY_PCI_TRACE_003 LEGACY_PCI_TRACE + 0x03
128 #define LEGACY_PCI_TRACE_004 LEGACY_PCI_TRACE + 0x04
129 #define LEGACY_PCI_TRACE_005 LEGACY_PCI_TRACE + 0x05
130 #define LEGACY_PCI_TRACE_006 LEGACY_PCI_TRACE + 0x06
131 #define LEGACY_PCI_TRACE_007 LEGACY_PCI_TRACE + 0x07
132 #define LEGACY_PCI_TRACE_008 LEGACY_PCI_TRACE + 0x08
133 #define LEGACY_PCI_TRACE_009 LEGACY_PCI_TRACE + 0x09
134 #define LEGACY_PCI_TRACE_00A LEGACY_PCI_TRACE + 0x0A
135 #define LEGACY_PCI_TRACE_00B LEGACY_PCI_TRACE + 0x0B
136 #define LEGACY_PCI_TRACE_00C LEGACY_PCI_TRACE + 0x0C
137 #define LEGACY_PCI_TRACE_00D LEGACY_PCI_TRACE + 0x0D
138 #define LEGACY_PCI_TRACE_00E LEGACY_PCI_TRACE + 0x0E
139 #define LEGACY_PCI_TRACE_00F LEGACY_PCI_TRACE + 0x0F
141 #define BDA_VIDEO_MODE 0x49
143 #define IDE_PI_REGISTER_PNE BIT0
144 #define IDE_PI_REGISTER_SNE BIT2
151 UINT32 ShadowAddress
;
155 } ROM_INSTANCE_ENTRY
;
158 // Values for RealModeGdt
160 #if defined (MDE_CPU_IA32)
162 #define NUM_REAL_GDT_ENTRIES 3
163 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
164 #define INITIAL_VALUE_BELOW_1K 0x0
166 #elif defined (MDE_CPU_X64)
168 #define NUM_REAL_GDT_ENTRIES 8
169 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
170 #define INITIAL_VALUE_BELOW_1K 0x0
172 #elif defined (MDE_CPU_IPF)
174 #define NUM_REAL_GDT_ENTRIES 3
175 #define CONVENTIONAL_MEMORY_TOP 0x80000 // 512 KB
176 #define INITIAL_VALUE_BELOW_1K 0xff
183 // Define what a processor GDT looks like
196 UINT32 DefaultSize
: 1;
197 UINT32 Granularity
: 1;
211 // Define what a processor descriptor looks like
212 // This data structure must be kept in sync with ASM STRUCT in Thunk.inc
227 #define LOW_STACK_SIZE (8 * 1024) // 8k?
228 #define EFI_MAX_E820_ENTRY 100
229 #define FIRST_INSTANCE 1
230 #define NOT_FIRST_INSTANCE 0
232 #if defined (MDE_CPU_IA32)
235 // Space for the code
236 // The address of Code is also the beginning of the relocated Thunk code
238 CHAR8 Code
[4096]; // ?
240 // The address of the Reverse Thunk code
241 // Note that this member CONTAINS the address of the relocated reverse thunk
242 // code unlike the member variable 'Code', which IS the address of the Thunk
245 UINT32 LowReverseThunkStart
;
248 // Data for the code (cs releative)
250 DESCRIPTOR32 GdtDesc
; // Protected mode GDT
251 DESCRIPTOR32 IdtDesc
; // Protected mode IDT
255 UINT32 LowCodeSelector
; // Low code selector in GDT
256 UINT32 LowDataSelector
; // Low data selector in GDT
258 DESCRIPTOR32 RealModeIdtDesc
;
261 // real-mode GDT (temporary GDT with two real mode segment descriptors)
263 GDT32 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
264 DESCRIPTOR32 RealModeGdtDesc
;
267 // Members specifically for the reverse thunk
268 // The RevReal* members are used to store the current state of real mode
269 // before performing the reverse thunk. The RevFlat* members must be set
270 // before calling the reverse thunk assembly code.
275 DESCRIPTOR32 RevRealIdtDesc
;
276 UINT16 RevFlatDataSelector
; // Flat data selector in GDT
280 // A low memory stack
282 CHAR8 Stack
[LOW_STACK_SIZE
];
285 // Stack for flat mode after reverse thunk
286 // @bug - This may no longer be necessary if the reverse thunk interface
287 // is changed to have the flat stack in a different location.
289 CHAR8 RevThunkStack
[LOW_STACK_SIZE
];
292 // Legacy16 Init memory map info
294 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
296 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
298 CHAR8 InterruptRedirectionCode
[32];
299 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
300 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
301 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
304 #elif defined (MDE_CPU_X64)
308 // Space for the code
309 // The address of Code is also the beginning of the relocated Thunk code
311 CHAR8 Code
[4096]; // ?
314 // Data for the code (cs releative)
316 DESCRIPTOR64 X64GdtDesc
; // Protected mode GDT
317 DESCRIPTOR64 X64IdtDesc
; // Protected mode IDT
322 DESCRIPTOR32 RealModeIdtDesc
;
323 DESCRIPTOR32 RealModeGdtDesc
;
326 // real-mode GDT (temporary GDT with two real mode segment descriptors)
328 GDT64 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
329 UINT64 PageMapLevel4
;
332 // A low memory stack
334 CHAR8 Stack
[LOW_STACK_SIZE
];
337 // Legacy16 Init memory map info
339 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
341 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
343 CHAR8 InterruptRedirectionCode
[32];
344 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
345 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
346 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
349 #elif defined (MDE_CPU_IPF)
353 // Space for the code
354 // The address of Code is also the beginning of the relocated Thunk code
356 CHAR8 Code
[4096]; // ?
358 // The address of the Reverse Thunk code
359 // Note that this member CONTAINS the address of the relocated reverse thunk
360 // code unlike the member variable 'Code', which IS the address of the Thunk
363 UINT32 LowReverseThunkStart
;
366 // Data for the code (cs releative)
368 DESCRIPTOR32 GdtDesc
; // Protected mode GDT
369 DESCRIPTOR32 IdtDesc
; // Protected mode IDT
373 UINT32 LowCodeSelector
; // Low code selector in GDT
374 UINT32 LowDataSelector
; // Low data selector in GDT
376 DESCRIPTOR32 RealModeIdtDesc
;
379 // real-mode GDT (temporary GDT with two real mode segment descriptors)
381 GDT32 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
382 DESCRIPTOR32 RealModeGdtDesc
;
385 // Members specifically for the reverse thunk
386 // The RevReal* members are used to store the current state of real mode
387 // before performing the reverse thunk. The RevFlat* members must be set
388 // before calling the reverse thunk assembly code.
393 DESCRIPTOR32 RevRealIdtDesc
;
394 UINT16 RevFlatDataSelector
; // Flat data selector in GDT
398 // A low memory stack
400 CHAR8 Stack
[LOW_STACK_SIZE
];
403 // Stack for flat mode after reverse thunk
404 // @bug - This may no longer be necessary if the reverse thunk interface
405 // is changed to have the flat stack in a different location.
407 CHAR8 RevThunkStack
[LOW_STACK_SIZE
];
410 // Legacy16 Init memory map info
412 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
414 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
416 CHAR8 InterruptRedirectionCode
[32];
417 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
418 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
419 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
425 // PnP Expansion Header
436 UINT16 ProductNamePointer
;
440 UINT8 DeviceIndicators
;
442 UINT16 DisconnectVector
;
445 UINT16 StaticResourceVector
;
446 } LEGACY_PNP_EXPANSION_HEADER
;
462 UINTN ManufacturerString
;
463 UINTN ProductNameString
;
464 } LEGACY_ROM_AND_BBS_TABLE
;
467 // Structure how EFI has mapped a devices HDD drive numbers.
468 // Boot to EFI aware OS or shell requires this mapping when
469 // 16-bit CSM assigns drive numbers.
470 // This mapping is ignored booting to a legacy OS.
477 UINT8 StartDriveNumber
;
478 UINT8 EndDriveNumber
;
479 } LEGACY_EFI_HDD_TABLE
;
482 // This data is passed to Leacy16Boot
485 EfiAcpiAddressRangeMemory
= 1,
486 EfiAcpiAddressRangeReserved
= 2,
487 EfiAcpiAddressRangeACPI
= 3,
488 EfiAcpiAddressRangeNVS
= 4,
489 EfiAddressRangePersistentMemory
= 7
490 } EFI_ACPI_MEMORY_TYPE
;
495 EFI_ACPI_MEMORY_TYPE Type
;
503 EFI_ACPI_MEMORY_TYPE Type
;
508 extern BBS_TABLE
*mBbsTable
;
510 extern EFI_GENERIC_MEMORY_TEST_PROTOCOL
*gGenMemoryTest
;
512 extern BOOLEAN mEndOfDxe
;
517 #define CMOS_0A 0x0a ///< Status register A
518 #define CMOS_0D 0x0d ///< Status register D
519 #define CMOS_0E 0x0e ///< Diagnostic Status
520 #define CMOS_0F 0x0f ///< Shutdown status
521 #define CMOS_10 0x10 ///< Floppy type
522 #define CMOS_12 0x12 ///< IDE type
523 #define CMOS_14 0x14 ///< Same as BDA 40:10
524 #define CMOS_15 0x15 ///< Low byte of base memory in 1k increments
525 #define CMOS_16 0x16 ///< High byte of base memory in 1k increments
526 #define CMOS_17 0x17 ///< Low byte of 1MB+ memory in 1k increments - max 15 MB
527 #define CMOS_18 0x18 ///< High byte of 1MB+ memory in 1k increments - max 15 MB
528 #define CMOS_19 0x19 ///< C: extended drive type
529 #define CMOS_1A 0x1a ///< D: extended drive type
530 #define CMOS_2E 0x2e ///< Most significient byte of standard checksum
531 #define CMOS_2F 0x2f ///< Least significient byte of standard checksum
532 #define CMOS_30 0x30 ///< CMOS 0x17
533 #define CMOS_31 0x31 ///< CMOS 0x18
534 #define CMOS_32 0x32 ///< Century byte
537 // 8254 Timer registers
539 #define TIMER0_COUNT_PORT 0x40
540 #define TIMER1_COUNT_PORT 0x41
541 #define TIMER2_COUNT_PORT 0x42
542 #define TIMER_CONTROL_PORT 0x43
545 // Timer 0, Read/Write LSB then MSB, Square wave output, binary count use.
547 #define TIMER0_CONTROL_WORD 0x36
549 #define LEGACY_BIOS_INSTANCE_SIGNATURE SIGNATURE_32 ('L', 'B', 'I', 'T')
554 EFI_LEGACY_BIOS_PROTOCOL LegacyBios
;
556 EFI_HANDLE ImageHandle
;
559 // CPU Architectural Protocol
561 EFI_CPU_ARCH_PROTOCOL
*Cpu
;
564 // Timer Architectural Protocol
566 EFI_TIMER_ARCH_PROTOCOL
*Timer
;
567 BOOLEAN TimerUses8254
;
570 // Protocol to Lock and Unlock 0xc0000 - 0xfffff
572 EFI_LEGACY_REGION2_PROTOCOL
*LegacyRegion
;
574 EFI_LEGACY_BIOS_PLATFORM_PROTOCOL
*LegacyBiosPlatform
;
577 // Interrupt control for thunk and PCI IRQ
579 EFI_LEGACY_8259_PROTOCOL
*Legacy8259
;
582 // PCI Interrupt PIRQ control
584 EFI_LEGACY_INTERRUPT_PROTOCOL
*LegacyInterrupt
;
587 // Generic Memory Test
589 EFI_GENERIC_MEMORY_TEST_PROTOCOL
*GenericMemoryTest
;
592 // TRUE if PCI Interupt Line registers have been programmed.
594 BOOLEAN PciInterruptLine
;
597 // Code space below 1MB needed by thunker to transition to real mode.
598 // Contains stack and real mode code fragments
600 LOW_MEMORY_THUNK
*IntThunk
;
603 // Starting shadow address of the Legacy BIOS
606 UINT32 LegacyBiosImageSize
;
609 // Start of variables used by CsmItp.mac ITP macro file and/os LegacyBios
614 // $EFI Legacy16 code entry info in memory < 1 MB;
616 EFI_COMPATIBILITY16_TABLE
*Legacy16Table
;
617 VOID
*Legacy16InitPtr
;
618 VOID
*Legacy16BootPtr
;
619 VOID
*InternalIrqRoutingTable
;
620 UINT32 NumberIrqRoutingEntries
;
623 UINT32 NumberHddControllers
;
626 // Cached copy of Legacy16 entry point
628 UINT16 Legacy16CallSegment
;
629 UINT16 Legacy16CallOffset
;
632 // Returned from $EFI and passed in to OPROMS
634 UINT16 PnPInstallationCheckSegment
;
635 UINT16 PnPInstallationCheckOffset
;
640 EFI_E820_ENTRY E820Table
[EFI_MAX_E820_ENTRY
];
641 UINT32 NumberE820Entries
;
644 // True if legacy VGA INT 10h handler installed
646 BOOLEAN VgaInstalled
;
649 // Number of IDE drives
654 // Current Free Option ROM space. An option ROM must NOT go past
660 // Save Legacy16 unexpected interrupt vector. Reprogram INT 68-6F from
661 // EFI values to legacy value just before boot.
663 UINT32 BiosUnexpectedInt
;
664 UINT32 ThunkSavedInt
[8];
666 LEGACY_EFI_HDD_TABLE
*LegacyEfiHddTable
;
667 UINT16 LegacyEfiHddTableIndex
;
674 // Indicate that whether GenericLegacyBoot is entered or not
676 BOOLEAN LegacyBootEntered
;
679 // CSM16 PCI Interface Version
681 UINT16 Csm16PciInterfaceVersion
;
683 } LEGACY_BIOS_INSTANCE
;
696 40:0E-0E Ebda segment
697 40:10-11 MachineConfig
699 40:13-14 MemSize below 1MB
700 40:15-16 Bda15_16 - skip
701 40:17 Keyboard Shift status
702 40:18-19 Bda18_19 - skip
703 40:1A-1B Key buffer head
704 40:1C-1D Key buffer tail
705 40:1E-3D Bda1E_3D- key buffer -skip
706 40:3E-3F FloppyData 3E = Calibration status 3F = Motor status
708 40:41-74 Bda41_74 - skip
709 40:75 Number of HDD drives
710 40:76-77 Bda76_77 - skip
711 40:78-79 78 = Lpt1 timeout, 79 = Lpt2 timeout
712 40:7A-7B 7A = Lpt3 timeout, 7B = Lpt4 timeout
713 40:7C-7D 7C = Com1 timeout, 7D = Com2 timeout
714 40:7E-7F 7E = Com3 timeout, 7F = Com4 timeout
715 40:80-81 Pointer to start of key buffer
716 40:82-83 Pointer to end of key buffer
717 40:84-87 Bda84_87 - skip
718 40:88 HDD Data Xmit rate
720 40:90 Floppy data rate
722 40:96 Keyboard Status
735 UINT16 MachineConfig
;
738 UINT8 Bda15_16
[0x02];
740 UINT8 Bda18_19
[0x02];
743 UINT16 Bda1E_3D
[0x10];
746 UINT8 Bda41_74
[0x34];
747 UINT8 NumberOfDrives
;
748 UINT8 Bda76_77
[0x02];
749 UINT16 Lpt1_2Timeout
;
750 UINT16 Lpt3_4Timeout
;
751 UINT16 Com1_2Timeout
;
752 UINT16 Com3_4Timeout
;
757 UINT8 Bda89_8F
[0x07];
759 UINT8 Bda91_95
[0x05];
760 UINT8 KeyboardStatus
;
765 #define LEGACY_BIOS_INSTANCE_FROM_THIS(this) CR (this, LEGACY_BIOS_INSTANCE, LegacyBios, LEGACY_BIOS_INSTANCE_SIGNATURE)
768 Thunk to 16-bit real mode and execute a software interrupt with a vector
769 of BiosInt. Regs will contain the 16-bit register context on entry and
772 @param This Protocol instance pointer.
773 @param BiosInt Processor interrupt vector to invoke
774 @param Regs Register contexted passed into (and returned) from thunk to
777 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
779 @retval TRUE There was a BIOS erro in the target code.
785 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
787 IN EFI_IA32_REGISTER_SET
*Regs
792 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
793 16-bit register context on entry and exit. Arguments can be passed on
796 @param This Protocol instance pointer.
797 @param Segment Segemnt of 16-bit mode call
798 @param Offset Offset of 16-bit mdoe call
799 @param Regs Register contexted passed into (and returned) from
801 @param Stack Caller allocated stack used to pass arguments
802 @param StackSize Size of Stack in bytes
804 @retval FALSE Thunk completed, and there were no BIOS errors in
805 the target code. See Regs for status.
806 @retval TRUE There was a BIOS erro in the target code.
811 LegacyBiosFarCall86 (
812 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
815 IN EFI_IA32_REGISTER_SET
*Regs
,
822 Test to see if a legacy PCI ROM exists for this device. Optionally return
823 the Legacy ROM instance for this PCI device.
825 @param This Protocol instance pointer.
826 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
828 @param RomImage Return the legacy PCI ROM for this device
829 @param RomSize Size of ROM Image
830 @param Flags Indicates if ROM found and if PC-AT.
832 @retval EFI_SUCCESS Legacy Option ROM available for this device
833 @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
838 LegacyBiosCheckPciRom (
839 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
840 IN EFI_HANDLE PciHandle
,
841 OUT VOID
**RomImage
, OPTIONAL
842 OUT UINTN
*RomSize
, OPTIONAL
848 Assign drive number to legacy HDD drives prior to booting an EFI
849 aware OS so the OS can access drives without an EFI driver.
850 Note: BBS compliant drives ARE NOT available until this call by
853 @param This Protocol instance pointer.
854 @param BbsCount Number of BBS_TABLE structures
855 @param BbsTable List BBS entries
857 @retval EFI_SUCCESS Drive numbers assigned
862 LegacyBiosPrepareToBootEfi (
863 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
864 OUT UINT16
*BbsCount
,
865 OUT BBS_TABLE
**BbsTable
870 To boot from an unconventional device like parties and/or execute
873 @param This Protocol instance pointer.
874 @param Attributes How to interpret the other input parameters
875 @param BbsEntry The 0-based index into the BbsTable for the parent
877 @param BeerData Pointer to the 128 bytes of ram BEER data.
878 @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data.
879 The caller must provide a pointer to the specific
880 Service Area and not the start all Service Areas.
881 EFI_INVALID_PARAMETER if error. Does NOT return if no error.
886 LegacyBiosBootUnconventionalDevice (
887 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
888 IN UDC_ATTRIBUTES Attributes
,
891 IN VOID
*ServiceAreaData
896 Load a legacy PC-AT OPROM on the PciHandle device. Return information
897 about how many disks were added by the OPROM and the shadow address and
898 size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:
900 @param This Protocol instance pointer.
901 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
902 be loaded. This value is NULL if RomImage is
903 non-NULL. This is the normal case.
904 @param RomImage A PCI PC-AT ROM image. This argument is non-NULL
905 if there is no hardware associated with the ROM
906 and thus no PciHandle, otherwise is must be NULL.
907 Example is PXE base code.
908 @param Flags Indicates if ROM found and if PC-AT.
909 @param DiskStart Disk number of first device hooked by the ROM. If
910 DiskStart is the same as DiskEnd no disked were
912 @param DiskEnd Disk number of the last device hooked by the ROM.
913 @param RomShadowAddress Shadow address of PC-AT ROM
914 @param RomShadowedSize Size of RomShadowAddress in bytes
916 @retval EFI_SUCCESS Legacy ROM loaded for this device
917 @retval EFI_INVALID_PARAMETER PciHandle not found
918 @retval EFI_UNSUPPORTED There is no PCI ROM in the ROM BAR or no onboard
924 LegacyBiosInstallPciRom (
925 IN EFI_LEGACY_BIOS_PROTOCOL
* This
,
926 IN EFI_HANDLE PciHandle
,
929 OUT UINT8
*DiskStart
, OPTIONAL
930 OUT UINT8
*DiskEnd
, OPTIONAL
931 OUT VOID
**RomShadowAddress
, OPTIONAL
932 OUT UINT32
*RomShadowedSize OPTIONAL
937 Fill in the standard BDA for Keyboard LEDs
939 @param This Protocol instance pointer.
940 @param Leds Current LED status
942 @retval EFI_SUCCESS It should always work.
947 LegacyBiosUpdateKeyboardLedStatus (
948 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
956 @param This Protocol instance pointer.
957 @param HddCount Number of HDD_INFO structures
958 @param HddInfo Onboard IDE controller information
959 @param BbsCount Number of BBS_TABLE structures
960 @param BbsTable List BBS entries
962 @retval EFI_SUCCESS Tables returned
963 @retval EFI_NOT_FOUND resource not found
964 @retval EFI_DEVICE_ERROR can not get BBS table
969 LegacyBiosGetBbsInfo (
970 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
971 OUT UINT16
*HddCount
,
972 OUT HDD_INFO
**HddInfo
,
973 OUT UINT16
*BbsCount
,
974 OUT BBS_TABLE
**BbsTable
979 Shadow all legacy16 OPROMs that haven't been shadowed.
980 Warning: Use this with caution. This routine disconnects all EFI
981 drivers. If used externally then caller must re-connect EFI
984 @param This Protocol instance pointer.
986 @retval EFI_SUCCESS OPROMs shadowed
991 LegacyBiosShadowAllLegacyOproms (
992 IN EFI_LEGACY_BIOS_PROTOCOL
*This
997 Attempt to legacy boot the BootOption. If the EFI contexted has been
998 compromised this function will not return.
1000 @param This Protocol instance pointer.
1001 @param BbsDevicePath EFI Device Path from BootXXXX variable.
1002 @param LoadOptionsSize Size of LoadOption in size.
1003 @param LoadOptions LoadOption from BootXXXX variable
1005 @retval EFI_SUCCESS Removable media not present
1010 LegacyBiosLegacyBoot (
1011 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1012 IN BBS_BBS_DEVICE_PATH
*BbsDevicePath
,
1013 IN UINT32 LoadOptionsSize
,
1014 IN VOID
*LoadOptions
1019 Allocate memory < 1 MB and copy the thunker code into low memory. Se up
1020 all the descriptors.
1022 @param Private Private context for Legacy BIOS
1024 @retval EFI_SUCCESS Should only pass.
1028 LegacyBiosInitializeThunk (
1029 IN LEGACY_BIOS_INSTANCE
*Private
1034 Fill in the standard BDA and EBDA stuff before Legacy16 load
1036 @param Private Legacy BIOS Instance data
1038 @retval EFI_SUCCESS It should always work.
1043 IN LEGACY_BIOS_INSTANCE
*Private
1048 Collect IDE Inquiry data from the IDE disks
1050 @param Private Legacy BIOS Instance data
1051 @param HddInfo Hdd Information
1052 @param Flag Reconnect IdeController or not
1054 @retval EFI_SUCCESS It should always work.
1058 LegacyBiosBuildIdeData (
1059 IN LEGACY_BIOS_INSTANCE
*Private
,
1060 IN HDD_INFO
**HddInfo
,
1066 Enable ide controller. This gets disabled when LegacyBoot.c is about
1067 to run the Option ROMs.
1069 @param Private Legacy BIOS Instance data
1074 EnableIdeController (
1075 IN LEGACY_BIOS_INSTANCE
*Private
1080 If the IDE channel is in compatibility (legacy) mode, remove all
1081 PCI I/O BAR addresses from the controller.
1083 @param IdeController The handle of target IDE controller
1088 InitLegacyIdeController (
1089 IN EFI_HANDLE IdeController
1094 Program the interrupt routing register in all the PCI devices. On a PC AT system
1095 this register contains the 8259 IRQ vector that matches it's PCI interrupt.
1097 @param Private Legacy BIOS Instance data
1099 @retval EFI_SUCCESS Succeed.
1100 @retval EFI_ALREADY_STARTED All PCI devices have been processed.
1104 PciProgramAllInterruptLineRegisters (
1105 IN LEGACY_BIOS_INSTANCE
*Private
1110 Collect EFI Info about legacy devices.
1112 @param Private Legacy BIOS Instance data
1114 @retval EFI_SUCCESS It should always work.
1118 LegacyBiosBuildSioData (
1119 IN LEGACY_BIOS_INSTANCE
*Private
1124 Shadow all the PCI legacy ROMs. Use data from the Legacy BIOS Protocol
1125 to chose the order. Skip any devices that have already have legacy
1128 @param Private Protocol instance pointer.
1130 @retval EFI_SUCCESS Succeed.
1131 @retval EFI_UNSUPPORTED Cannot get VGA device handle.
1136 IN LEGACY_BIOS_INSTANCE
*Private
1141 Fill in the standard BDA and EBDA stuff prior to legacy Boot
1143 @param Private Legacy BIOS Instance data
1145 @retval EFI_SUCCESS It should always work.
1149 LegacyBiosCompleteBdaBeforeBoot (
1150 IN LEGACY_BIOS_INSTANCE
*Private
1155 Fill in the standard CMOS stuff before Legacy16 load
1157 @param Private Legacy BIOS Instance data
1159 @retval EFI_SUCCESS It should always work.
1163 LegacyBiosInitCmos (
1164 IN LEGACY_BIOS_INSTANCE
*Private
1169 Fill in the standard CMOS stuff prior to legacy Boot
1171 @param Private Legacy BIOS Instance data
1173 @retval EFI_SUCCESS It should always work.
1177 LegacyBiosCompleteStandardCmosBeforeBoot (
1178 IN LEGACY_BIOS_INSTANCE
*Private
1183 Contains the code that is copied into low memory (below 640K).
1184 This code reflects interrupts 0x68-0x6f to interrupts 0x08-0x0f.
1185 This template must be copied into low memory, and the IDT entries
1186 0x68-0x6F must be point to the low memory copy of this code. Each
1187 entry is 4 bytes long, so IDT entries 0x68-0x6F can be easily
1192 InterruptRedirectionTemplate (
1198 Build the E820 table.
1200 @param Private Legacy BIOS Instance data
1201 @param Size Size of E820 Table
1203 @retval EFI_SUCCESS It should always work.
1207 LegacyBiosBuildE820 (
1208 IN LEGACY_BIOS_INSTANCE
*Private
,
1213 This function is to put all AP in halt state.
1215 @param Private Legacy BIOS Instance data
1220 IN LEGACY_BIOS_INSTANCE
*Private
1224 Worker function for LegacyBiosGetFlatDescs, retrieving content of
1227 @param IntThunk Pointer to IntThunk of Legacy BIOS context.
1232 LOW_MEMORY_THUNK
*IntThunk
1236 Routine for calling real thunk code.
1238 @param RealCode The address of thunk code.
1239 @param BiosInt The Bios interrupt vector number.
1240 @param CallAddress The address of 16-bit mode call.
1242 @return Status returned by real thunk code
1253 Routine for generating soft interrupt.
1255 @param Vector The interrupt vector number.
1264 Allocate memory for legacy usage.
1266 @param AllocateType The type of allocation to perform.
1267 @param MemoryType The type of memory to allocate.
1268 @param StartPageAddress Start address of range
1269 @param Pages Number of pages to allocate
1270 @param Result Result of allocation
1272 @retval EFI_SUCCESS Legacy16 code loaded
1273 @retval Other No protocol installed, unload driver.
1277 AllocateLegacyMemory (
1278 IN EFI_ALLOCATE_TYPE AllocateType
,
1279 IN EFI_MEMORY_TYPE MemoryType
,
1280 IN EFI_PHYSICAL_ADDRESS StartPageAddress
,
1282 OUT EFI_PHYSICAL_ADDRESS
*Result
1286 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1288 @param This Protocol instance pointer.
1289 @param LegacyMemorySize Size of required region
1290 @param Region Region to use. 00 = Either 0xE0000 or 0xF0000
1291 block Bit0 = 1 0xF0000 block Bit1 = 1 0xE0000
1293 @param Alignment Address alignment. Bit mapped. First non-zero
1294 bit from right is alignment.
1295 @param LegacyMemoryAddress Region Assigned
1297 @retval EFI_SUCCESS Region assigned
1298 @retval EFI_ACCESS_DENIED Procedure previously invoked
1299 @retval Other Region not assigned
1304 LegacyBiosGetLegacyRegion (
1305 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1306 IN UINTN LegacyMemorySize
,
1309 OUT VOID
**LegacyMemoryAddress
1313 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1315 @param This Protocol instance pointer.
1316 @param LegacyMemorySize Size of data to copy
1317 @param LegacyMemoryAddress Legacy Region destination address Note: must
1318 be in region assigned by
1319 LegacyBiosGetLegacyRegion
1320 @param LegacyMemorySourceAddress Source of data
1322 @retval EFI_SUCCESS Region assigned
1323 @retval EFI_ACCESS_DENIED Destination outside assigned region
1328 LegacyBiosCopyLegacyRegion (
1329 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1330 IN UINTN LegacyMemorySize
,
1331 IN VOID
*LegacyMemoryAddress
,
1332 IN VOID
*LegacyMemorySourceAddress
1336 Find Legacy16 BIOS image in the FLASH device and shadow it into memory. Find
1337 the $EFI table in the shadow area. Thunk into the Legacy16 code after it had
1340 @param Private Legacy BIOS context data
1342 @retval EFI_SUCCESS Legacy16 code loaded
1343 @retval Other No protocol installed, unload driver.
1347 ShadowAndStartLegacy16 (
1348 IN LEGACY_BIOS_INSTANCE
*Private
1352 Checks the state of the floppy and if media is inserted.
1354 This routine checks the state of the floppy and if media is inserted.
1356 No floppy present - Set BBS entry to ignore
1357 Floppy present & no media - Set BBS entry to lowest priority. We cannot
1358 set it to ignore since 16-bit CSM will
1359 indicate no floppy and thus drive A: is
1360 unusable. CSM-16 will not try floppy since
1361 lowest priority and thus not incur boot
1363 Floppy present & media - Set BBS entry to some priority.
1365 @return State of floppy media
1374 Identify drive data must be updated to actual parameters before boot.
1375 This requires updating the checksum, if it exists.
1377 @param IdentifyDriveData ATA Identify Data
1378 @param Checksum checksum of the ATA Identify Data
1380 @retval EFI_SUCCESS checksum calculated
1381 @retval EFI_SECURITY_VIOLATION IdentifyData invalid
1385 CalculateIdentifyDriveChecksum (
1386 IN UINT8
*IdentifyDriveData
,
1391 Identify drive data must be updated to actual parameters before boot.
1393 @param IdentifyDriveData ATA Identify Data
1397 UpdateIdentifyDriveData (
1398 IN UINT8
*IdentifyDriveData
1402 Complete build of BBS TABLE.
1404 @param Private Legacy BIOS Instance data
1405 @param BbsTable BBS Table passed to 16-bit code
1407 @retval EFI_SUCCESS Removable media not present
1411 LegacyBiosBuildBbs (
1412 IN LEGACY_BIOS_INSTANCE
*Private
,
1413 IN BBS_TABLE
*BbsTable
1417 Read CMOS register through index/data port.
1419 @param[in] Index The index of the CMOS register to read.
1421 @return The data value from the CMOS register specified by Index.
1425 LegacyReadStandardCmos (
1430 Write CMOS register through index/data port.
1432 @param[in] Index The index of the CMOS register to write.
1433 @param[in] Value The value of CMOS register to write.
1435 @return The value written to the CMOS register specified by Index.
1439 LegacyWriteStandardCmos (
1445 Calculate the new standard CMOS checksum and write it.
1447 @param Private Legacy BIOS Instance data
1449 @retval EFI_SUCCESS Calculate 16-bit checksum successfully
1453 LegacyCalculateWriteStandardCmosChecksum (
1458 Test to see if a legacy PCI ROM exists for this device. Optionally return
1459 the Legacy ROM instance for this PCI device.
1461 @param[in] This Protocol instance pointer.
1462 @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
1463 @param[out] RomImage Return the legacy PCI ROM for this device
1464 @param[out] RomSize Size of ROM Image
1465 @param[out] RuntimeImageLength Runtime size of ROM Image
1466 @param[out] Flags Indicates if ROM found and if PC-AT.
1467 @param[out] OpromRevision Revision of the PCI Rom
1468 @param[out] ConfigUtilityCodeHeaderPointer of Configuration Utility Code Header
1470 @return EFI_SUCCESS Legacy Option ROM available for this device
1471 @return EFI_ALREADY_STARTED This device is already managed by its Oprom
1472 @return EFI_UNSUPPORTED Legacy Option ROM not supported.
1476 LegacyBiosCheckPciRomEx (
1477 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1478 IN EFI_HANDLE PciHandle
,
1479 OUT VOID
**RomImage
, OPTIONAL
1480 OUT UINTN
*RomSize
, OPTIONAL
1481 OUT UINTN
*RuntimeImageLength
, OPTIONAL
1482 OUT UINTN
*Flags
, OPTIONAL
1483 OUT UINT8
*OpromRevision
, OPTIONAL
1484 OUT VOID
**ConfigUtilityCodeHeader OPTIONAL
1488 Relocate this image under 4G memory for IPF.
1490 @param ImageHandle Handle of driver image.
1491 @param SystemTable Pointer to system table.
1493 @retval EFI_SUCCESS Image successfully relocated.
1494 @retval EFI_ABORTED Failed to relocate image.
1498 RelocateImageUnder4GIfNeeded (
1499 IN EFI_HANDLE ImageHandle
,
1500 IN EFI_SYSTEM_TABLE
*SystemTable
1504 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
1505 16-bit register context on entry and exit. Arguments can be passed on
1508 @param This Protocol instance pointer.
1509 @param Segment Segemnt of 16-bit mode call
1510 @param Offset Offset of 16-bit mdoe call
1511 @param Regs Register contexted passed into (and returned) from thunk to
1513 @param Stack Caller allocated stack used to pass arguments
1514 @param StackSize Size of Stack in bytes
1516 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
1517 See Regs for status.
1518 @retval TRUE There was a BIOS erro in the target code.
1523 InternalLegacyBiosFarCall (
1524 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1527 IN EFI_IA32_REGISTER_SET
*Regs
,
1533 Load a legacy PC-AT OpROM for VGA controller.
1535 @param Private Driver private data.
1537 @retval EFI_SUCCESS Legacy ROM successfully installed for this device.
1538 @retval EFI_DEVICE_ERROR No VGA device handle found, or native EFI video
1539 driver cannot be successfully disconnected, or VGA
1540 thunk driver cannot be successfully connected.
1544 LegacyBiosInstallVgaRom (
1545 IN LEGACY_BIOS_INSTANCE
*Private