3 Copyright (c) 2006 - 2015, 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>
24 #include <Guid/SmBios.h>
25 #include <Guid/Acpi.h>
26 #include <Guid/DxeServices.h>
27 #include <Guid/LegacyBios.h>
28 #include <Guid/StatusCodeDataTypeId.h>
29 #include <Guid/ImageAuthentication.h>
31 #include <Protocol/BlockIo.h>
32 #include <Protocol/LoadedImage.h>
33 #include <Protocol/PciIo.h>
34 #include <Protocol/Cpu.h>
35 #include <Protocol/Timer.h>
36 #include <Protocol/IsaIo.h>
37 #include <Protocol/LegacyRegion2.h>
38 #include <Protocol/SimpleTextIn.h>
39 #include <Protocol/LegacyInterrupt.h>
40 #include <Protocol/LegacyBios.h>
41 #include <Protocol/DiskInfo.h>
42 #include <Protocol/GenericMemoryTest.h>
43 #include <Protocol/LegacyBiosPlatform.h>
44 #include <Protocol/DevicePath.h>
45 #include <Protocol/Legacy8259.h>
46 #include <Protocol/PciRootBridgeIo.h>
48 #include <Library/BaseLib.h>
49 #include <Library/DebugLib.h>
50 #include <Library/UefiLib.h>
51 #include <Library/BaseMemoryLib.h>
52 #include <Library/ReportStatusCodeLib.h>
53 #include <Library/UefiRuntimeServicesTableLib.h>
54 #include <Library/HobLib.h>
55 #include <Library/UefiDriverEntryPoint.h>
56 #include <Library/MemoryAllocationLib.h>
57 #include <Library/UefiBootServicesTableLib.h>
58 #include <Library/IoLib.h>
59 #include <Library/PcdLib.h>
60 #include <Library/DevicePathLib.h>
61 #include <Library/DxeServicesTableLib.h>
62 #include <Library/PeCoffLib.h>
63 #include <Library/CacheMaintenanceLib.h>
64 #include <Library/DebugAgentLib.h>
67 // BUGBUG: This entry maybe changed to PCD in future and wait for
68 // redesign of BDS library
70 #define MAX_BBS_ENTRIES 0x100
74 // (These apply only to errors with the thunk and not to the code that was
78 #define THUNK_ERR_A20_UNSUP 0x01
79 #define THUNK_ERR_A20_FAILED 0x02
82 // Vector base definitions
85 // 8259 Hardware definitions
87 #define LEGACY_MODE_BASE_VECTOR_MASTER 0x08
88 #define LEGACY_MODE_BASE_VECTOR_SLAVE 0x70
91 // The original PC used INT8-F for master PIC. Since these mapped over
92 // processor exceptions TIANO moved the master PIC to INT68-6F.
94 // The vector base for slave PIC is set as 0x70 for PC-AT compatibility.
96 #define PROTECTED_MODE_BASE_VECTOR_MASTER 0x68
97 #define PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70
100 // When we call CSM16 functions, some CSM16 use es:[offset + 0xabcd] to get data passed from CSM32,
101 // offset + 0xabcd could overflow which exceeds 0xFFFF which is invalid in real mode.
102 // So this will keep offset as small as possible to avoid offset overflow in real mode.
104 #define NORMALIZE_EFI_SEGMENT(_Adr) (UINT16) (((UINTN) (_Adr)) >> 4)
105 #define NORMALIZE_EFI_OFFSET(_Adr) (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xf)
111 #define LEGACY_BDA_TRACE 0x000
112 #define LEGACY_BIOS_TRACE 0x040
113 #define LEGACY_BOOT_TRACE 0x080
114 #define LEGACY_CMOS_TRACE 0x0C0
115 #define LEGACY_IDE_TRACE 0x100
116 #define LEGACY_MP_TRACE 0x140
117 #define LEGACY_PCI_TRACE 0x180
118 #define LEGACY_SIO_TRACE 0x1C0
120 #define LEGACY_PCI_TRACE_000 LEGACY_PCI_TRACE + 0x00
121 #define LEGACY_PCI_TRACE_001 LEGACY_PCI_TRACE + 0x01
122 #define LEGACY_PCI_TRACE_002 LEGACY_PCI_TRACE + 0x02
123 #define LEGACY_PCI_TRACE_003 LEGACY_PCI_TRACE + 0x03
124 #define LEGACY_PCI_TRACE_004 LEGACY_PCI_TRACE + 0x04
125 #define LEGACY_PCI_TRACE_005 LEGACY_PCI_TRACE + 0x05
126 #define LEGACY_PCI_TRACE_006 LEGACY_PCI_TRACE + 0x06
127 #define LEGACY_PCI_TRACE_007 LEGACY_PCI_TRACE + 0x07
128 #define LEGACY_PCI_TRACE_008 LEGACY_PCI_TRACE + 0x08
129 #define LEGACY_PCI_TRACE_009 LEGACY_PCI_TRACE + 0x09
130 #define LEGACY_PCI_TRACE_00A LEGACY_PCI_TRACE + 0x0A
131 #define LEGACY_PCI_TRACE_00B LEGACY_PCI_TRACE + 0x0B
132 #define LEGACY_PCI_TRACE_00C LEGACY_PCI_TRACE + 0x0C
133 #define LEGACY_PCI_TRACE_00D LEGACY_PCI_TRACE + 0x0D
134 #define LEGACY_PCI_TRACE_00E LEGACY_PCI_TRACE + 0x0E
135 #define LEGACY_PCI_TRACE_00F LEGACY_PCI_TRACE + 0x0F
137 #define BDA_VIDEO_MODE 0x49
139 #define IDE_PI_REGISTER_PNE BIT0
140 #define IDE_PI_REGISTER_SNE BIT2
147 UINT32 ShadowAddress
;
151 } ROM_INSTANCE_ENTRY
;
154 // Values for RealModeGdt
156 #if defined (MDE_CPU_IA32)
158 #define NUM_REAL_GDT_ENTRIES 3
159 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
160 #define INITIAL_VALUE_BELOW_1K 0x0
162 #elif defined (MDE_CPU_X64)
164 #define NUM_REAL_GDT_ENTRIES 8
165 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
166 #define INITIAL_VALUE_BELOW_1K 0x0
168 #elif defined (MDE_CPU_IPF)
170 #define NUM_REAL_GDT_ENTRIES 3
171 #define CONVENTIONAL_MEMORY_TOP 0x80000 // 512 KB
172 #define INITIAL_VALUE_BELOW_1K 0xff
179 // Define what a processor GDT looks like
192 UINT32 DefaultSize
: 1;
193 UINT32 Granularity
: 1;
207 // Define what a processor descriptor looks like
208 // This data structure must be kept in sync with ASM STRUCT in Thunk.inc
223 #define LOW_STACK_SIZE (8 * 1024) // 8k?
224 #define EFI_MAX_E820_ENTRY 100
225 #define FIRST_INSTANCE 1
226 #define NOT_FIRST_INSTANCE 0
228 #if defined (MDE_CPU_IA32)
231 // Space for the code
232 // The address of Code is also the beginning of the relocated Thunk code
234 CHAR8 Code
[4096]; // ?
236 // The address of the Reverse Thunk code
237 // Note that this member CONTAINS the address of the relocated reverse thunk
238 // code unlike the member variable 'Code', which IS the address of the Thunk
241 UINT32 LowReverseThunkStart
;
244 // Data for the code (cs releative)
246 DESCRIPTOR32 GdtDesc
; // Protected mode GDT
247 DESCRIPTOR32 IdtDesc
; // Protected mode IDT
251 UINT32 LowCodeSelector
; // Low code selector in GDT
252 UINT32 LowDataSelector
; // Low data selector in GDT
254 DESCRIPTOR32 RealModeIdtDesc
;
257 // real-mode GDT (temporary GDT with two real mode segment descriptors)
259 GDT32 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
260 DESCRIPTOR32 RealModeGdtDesc
;
263 // Members specifically for the reverse thunk
264 // The RevReal* members are used to store the current state of real mode
265 // before performing the reverse thunk. The RevFlat* members must be set
266 // before calling the reverse thunk assembly code.
271 DESCRIPTOR32 RevRealIdtDesc
;
272 UINT16 RevFlatDataSelector
; // Flat data selector in GDT
276 // A low memory stack
278 CHAR8 Stack
[LOW_STACK_SIZE
];
281 // Stack for flat mode after reverse thunk
282 // @bug - This may no longer be necessary if the reverse thunk interface
283 // is changed to have the flat stack in a different location.
285 CHAR8 RevThunkStack
[LOW_STACK_SIZE
];
288 // Legacy16 Init memory map info
290 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
292 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
294 CHAR8 InterruptRedirectionCode
[32];
295 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
296 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
297 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
300 #elif defined (MDE_CPU_X64)
304 // Space for the code
305 // The address of Code is also the beginning of the relocated Thunk code
307 CHAR8 Code
[4096]; // ?
310 // Data for the code (cs releative)
312 DESCRIPTOR64 X64GdtDesc
; // Protected mode GDT
313 DESCRIPTOR64 X64IdtDesc
; // Protected mode IDT
318 DESCRIPTOR32 RealModeIdtDesc
;
319 DESCRIPTOR32 RealModeGdtDesc
;
322 // real-mode GDT (temporary GDT with two real mode segment descriptors)
324 GDT64 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
325 UINT64 PageMapLevel4
;
328 // A low memory stack
330 CHAR8 Stack
[LOW_STACK_SIZE
];
333 // Legacy16 Init memory map info
335 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
337 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
339 CHAR8 InterruptRedirectionCode
[32];
340 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
341 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
342 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
345 #elif defined (MDE_CPU_IPF)
349 // Space for the code
350 // The address of Code is also the beginning of the relocated Thunk code
352 CHAR8 Code
[4096]; // ?
354 // The address of the Reverse Thunk code
355 // Note that this member CONTAINS the address of the relocated reverse thunk
356 // code unlike the member variable 'Code', which IS the address of the Thunk
359 UINT32 LowReverseThunkStart
;
362 // Data for the code (cs releative)
364 DESCRIPTOR32 GdtDesc
; // Protected mode GDT
365 DESCRIPTOR32 IdtDesc
; // Protected mode IDT
369 UINT32 LowCodeSelector
; // Low code selector in GDT
370 UINT32 LowDataSelector
; // Low data selector in GDT
372 DESCRIPTOR32 RealModeIdtDesc
;
375 // real-mode GDT (temporary GDT with two real mode segment descriptors)
377 GDT32 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
378 DESCRIPTOR32 RealModeGdtDesc
;
381 // Members specifically for the reverse thunk
382 // The RevReal* members are used to store the current state of real mode
383 // before performing the reverse thunk. The RevFlat* members must be set
384 // before calling the reverse thunk assembly code.
389 DESCRIPTOR32 RevRealIdtDesc
;
390 UINT16 RevFlatDataSelector
; // Flat data selector in GDT
394 // A low memory stack
396 CHAR8 Stack
[LOW_STACK_SIZE
];
399 // Stack for flat mode after reverse thunk
400 // @bug - This may no longer be necessary if the reverse thunk interface
401 // is changed to have the flat stack in a different location.
403 CHAR8 RevThunkStack
[LOW_STACK_SIZE
];
406 // Legacy16 Init memory map info
408 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
410 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
412 CHAR8 InterruptRedirectionCode
[32];
413 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
414 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
415 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
421 // PnP Expansion Header
432 UINT16 ProductNamePointer
;
436 UINT8 DeviceIndicators
;
438 UINT16 DisconnectVector
;
441 UINT16 StaticResourceVector
;
442 } LEGACY_PNP_EXPANSION_HEADER
;
458 UINTN ManufacturerString
;
459 UINTN ProductNameString
;
460 } LEGACY_ROM_AND_BBS_TABLE
;
463 // Structure how EFI has mapped a devices HDD drive numbers.
464 // Boot to EFI aware OS or shell requires this mapping when
465 // 16-bit CSM assigns drive numbers.
466 // This mapping is ignored booting to a legacy OS.
473 UINT8 StartDriveNumber
;
474 UINT8 EndDriveNumber
;
475 } LEGACY_EFI_HDD_TABLE
;
478 // This data is passed to Leacy16Boot
481 EfiAcpiAddressRangeMemory
= 1,
482 EfiAcpiAddressRangeReserved
= 2,
483 EfiAcpiAddressRangeACPI
= 3,
484 EfiAcpiAddressRangeNVS
= 4,
485 EfiAddressRangePersistentMemory
= 7
486 } EFI_ACPI_MEMORY_TYPE
;
491 EFI_ACPI_MEMORY_TYPE Type
;
499 EFI_ACPI_MEMORY_TYPE Type
;
504 extern BBS_TABLE
*mBbsTable
;
506 extern EFI_GENERIC_MEMORY_TEST_PROTOCOL
*gGenMemoryTest
;
511 #define CMOS_0A 0x0a ///< Status register A
512 #define CMOS_0D 0x0d ///< Status register D
513 #define CMOS_0E 0x0e ///< Diagnostic Status
514 #define CMOS_0F 0x0f ///< Shutdown status
515 #define CMOS_10 0x10 ///< Floppy type
516 #define CMOS_12 0x12 ///< IDE type
517 #define CMOS_14 0x14 ///< Same as BDA 40:10
518 #define CMOS_15 0x15 ///< Low byte of base memory in 1k increments
519 #define CMOS_16 0x16 ///< High byte of base memory in 1k increments
520 #define CMOS_17 0x17 ///< Low byte of 1MB+ memory in 1k increments - max 15 MB
521 #define CMOS_18 0x18 ///< High byte of 1MB+ memory in 1k increments - max 15 MB
522 #define CMOS_19 0x19 ///< C: extended drive type
523 #define CMOS_1A 0x1a ///< D: extended drive type
524 #define CMOS_2E 0x2e ///< Most significient byte of standard checksum
525 #define CMOS_2F 0x2f ///< Least significient byte of standard checksum
526 #define CMOS_30 0x30 ///< CMOS 0x17
527 #define CMOS_31 0x31 ///< CMOS 0x18
528 #define CMOS_32 0x32 ///< Century byte
531 // 8254 Timer registers
533 #define TIMER0_COUNT_PORT 0x40
534 #define TIMER1_COUNT_PORT 0x41
535 #define TIMER2_COUNT_PORT 0x42
536 #define TIMER_CONTROL_PORT 0x43
539 // Timer 0, Read/Write LSB then MSB, Square wave output, binary count use.
541 #define TIMER0_CONTROL_WORD 0x36
543 #define LEGACY_BIOS_INSTANCE_SIGNATURE SIGNATURE_32 ('L', 'B', 'I', 'T')
548 EFI_LEGACY_BIOS_PROTOCOL LegacyBios
;
550 EFI_HANDLE ImageHandle
;
553 // CPU Architectural Protocol
555 EFI_CPU_ARCH_PROTOCOL
*Cpu
;
558 // Timer Architectural Protocol
560 EFI_TIMER_ARCH_PROTOCOL
*Timer
;
561 BOOLEAN TimerUses8254
;
564 // Protocol to Lock and Unlock 0xc0000 - 0xfffff
566 EFI_LEGACY_REGION2_PROTOCOL
*LegacyRegion
;
568 EFI_LEGACY_BIOS_PLATFORM_PROTOCOL
*LegacyBiosPlatform
;
571 // Interrupt control for thunk and PCI IRQ
573 EFI_LEGACY_8259_PROTOCOL
*Legacy8259
;
576 // PCI Interrupt PIRQ control
578 EFI_LEGACY_INTERRUPT_PROTOCOL
*LegacyInterrupt
;
581 // Generic Memory Test
583 EFI_GENERIC_MEMORY_TEST_PROTOCOL
*GenericMemoryTest
;
586 // TRUE if PCI Interupt Line registers have been programmed.
588 BOOLEAN PciInterruptLine
;
591 // Code space below 1MB needed by thunker to transition to real mode.
592 // Contains stack and real mode code fragments
594 LOW_MEMORY_THUNK
*IntThunk
;
597 // Starting shadow address of the Legacy BIOS
600 UINT32 LegacyBiosImageSize
;
603 // Start of variables used by CsmItp.mac ITP macro file and/os LegacyBios
608 // $EFI Legacy16 code entry info in memory < 1 MB;
610 EFI_COMPATIBILITY16_TABLE
*Legacy16Table
;
611 VOID
*Legacy16InitPtr
;
612 VOID
*Legacy16BootPtr
;
613 VOID
*InternalIrqRoutingTable
;
614 UINT32 NumberIrqRoutingEntries
;
617 UINT32 NumberHddControllers
;
620 // Cached copy of Legacy16 entry point
622 UINT16 Legacy16CallSegment
;
623 UINT16 Legacy16CallOffset
;
626 // Returned from $EFI and passed in to OPROMS
628 UINT16 PnPInstallationCheckSegment
;
629 UINT16 PnPInstallationCheckOffset
;
634 EFI_E820_ENTRY E820Table
[EFI_MAX_E820_ENTRY
];
635 UINT32 NumberE820Entries
;
638 // True if legacy VGA INT 10h handler installed
640 BOOLEAN VgaInstalled
;
643 // Number of IDE drives
648 // Current Free Option ROM space. An option ROM must NOT go past
654 // Save Legacy16 unexpected interrupt vector. Reprogram INT 68-6F from
655 // EFI values to legacy value just before boot.
657 UINT32 BiosUnexpectedInt
;
658 UINT32 ThunkSavedInt
[8];
660 LEGACY_EFI_HDD_TABLE
*LegacyEfiHddTable
;
661 UINT16 LegacyEfiHddTableIndex
;
668 // Indicate that whether GenericLegacyBoot is entered or not
670 BOOLEAN LegacyBootEntered
;
673 // CSM16 PCI Interface Version
675 UINT16 Csm16PciInterfaceVersion
;
677 } LEGACY_BIOS_INSTANCE
;
690 40:0E-0E Ebda segment
691 40:10-11 MachineConfig
693 40:13-14 MemSize below 1MB
694 40:15-16 Bda15_16 - skip
695 40:17 Keyboard Shift status
696 40:18-19 Bda18_19 - skip
697 40:1A-1B Key buffer head
698 40:1C-1D Key buffer tail
699 40:1E-3D Bda1E_3D- key buffer -skip
700 40:3E-3F FloppyData 3E = Calibration status 3F = Motor status
702 40:41-74 Bda41_74 - skip
703 40:75 Number of HDD drives
704 40:76-77 Bda76_77 - skip
705 40:78-79 78 = Lpt1 timeout, 79 = Lpt2 timeout
706 40:7A-7B 7A = Lpt3 timeout, 7B = Lpt4 timeout
707 40:7C-7D 7C = Com1 timeout, 7D = Com2 timeout
708 40:7E-7F 7E = Com3 timeout, 7F = Com4 timeout
709 40:80-81 Pointer to start of key buffer
710 40:82-83 Pointer to end of key buffer
711 40:84-87 Bda84_87 - skip
712 40:88 HDD Data Xmit rate
714 40:90 Floppy data rate
716 40:96 Keyboard Status
729 UINT16 MachineConfig
;
732 UINT8 Bda15_16
[0x02];
734 UINT8 Bda18_19
[0x02];
737 UINT16 Bda1E_3D
[0x10];
740 UINT8 Bda41_74
[0x34];
741 UINT8 NumberOfDrives
;
742 UINT8 Bda76_77
[0x02];
743 UINT16 Lpt1_2Timeout
;
744 UINT16 Lpt3_4Timeout
;
745 UINT16 Com1_2Timeout
;
746 UINT16 Com3_4Timeout
;
751 UINT8 Bda89_8F
[0x07];
753 UINT8 Bda91_95
[0x05];
754 UINT8 KeyboardStatus
;
759 #define LEGACY_BIOS_INSTANCE_FROM_THIS(this) CR (this, LEGACY_BIOS_INSTANCE, LegacyBios, LEGACY_BIOS_INSTANCE_SIGNATURE)
762 Thunk to 16-bit real mode and execute a software interrupt with a vector
763 of BiosInt. Regs will contain the 16-bit register context on entry and
766 @param This Protocol instance pointer.
767 @param BiosInt Processor interrupt vector to invoke
768 @param Regs Register contexted passed into (and returned) from thunk to
771 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
773 @retval TRUE There was a BIOS erro in the target code.
779 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
781 IN EFI_IA32_REGISTER_SET
*Regs
786 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
787 16-bit register context on entry and exit. Arguments can be passed on
790 @param This Protocol instance pointer.
791 @param Segment Segemnt of 16-bit mode call
792 @param Offset Offset of 16-bit mdoe call
793 @param Regs Register contexted passed into (and returned) from
795 @param Stack Caller allocated stack used to pass arguments
796 @param StackSize Size of Stack in bytes
798 @retval FALSE Thunk completed, and there were no BIOS errors in
799 the target code. See Regs for status.
800 @retval TRUE There was a BIOS erro in the target code.
805 LegacyBiosFarCall86 (
806 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
809 IN EFI_IA32_REGISTER_SET
*Regs
,
816 Test to see if a legacy PCI ROM exists for this device. Optionally return
817 the Legacy ROM instance for this PCI device.
819 @param This Protocol instance pointer.
820 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
822 @param RomImage Return the legacy PCI ROM for this device
823 @param RomSize Size of ROM Image
824 @param Flags Indicates if ROM found and if PC-AT.
826 @retval EFI_SUCCESS Legacy Option ROM availible for this device
827 @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
832 LegacyBiosCheckPciRom (
833 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
834 IN EFI_HANDLE PciHandle
,
835 OUT VOID
**RomImage
, OPTIONAL
836 OUT UINTN
*RomSize
, OPTIONAL
842 Assign drive number to legacy HDD drives prior to booting an EFI
843 aware OS so the OS can access drives without an EFI driver.
844 Note: BBS compliant drives ARE NOT available until this call by
847 @param This Protocol instance pointer.
848 @param BbsCount Number of BBS_TABLE structures
849 @param BbsTable List BBS entries
851 @retval EFI_SUCCESS Drive numbers assigned
856 LegacyBiosPrepareToBootEfi (
857 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
858 OUT UINT16
*BbsCount
,
859 OUT BBS_TABLE
**BbsTable
864 To boot from an unconventional device like parties and/or execute
867 @param This Protocol instance pointer.
868 @param Attributes How to interpret the other input parameters
869 @param BbsEntry The 0-based index into the BbsTable for the parent
871 @param BeerData Pointer to the 128 bytes of ram BEER data.
872 @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data.
873 The caller must provide a pointer to the specific
874 Service Area and not the start all Service Areas.
875 EFI_INVALID_PARAMETER if error. Does NOT return if no error.
880 LegacyBiosBootUnconventionalDevice (
881 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
882 IN UDC_ATTRIBUTES Attributes
,
885 IN VOID
*ServiceAreaData
890 Load a legacy PC-AT OPROM on the PciHandle device. Return information
891 about how many disks were added by the OPROM and the shadow address and
892 size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:
894 @param This Protocol instance pointer.
895 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
896 be loaded. This value is NULL if RomImage is
897 non-NULL. This is the normal case.
898 @param RomImage A PCI PC-AT ROM image. This argument is non-NULL
899 if there is no hardware associated with the ROM
900 and thus no PciHandle, otherwise is must be NULL.
901 Example is PXE base code.
902 @param Flags Indicates if ROM found and if PC-AT.
903 @param DiskStart Disk number of first device hooked by the ROM. If
904 DiskStart is the same as DiskEnd no disked were
906 @param DiskEnd Disk number of the last device hooked by the ROM.
907 @param RomShadowAddress Shadow address of PC-AT ROM
908 @param RomShadowedSize Size of RomShadowAddress in bytes
910 @retval EFI_SUCCESS Legacy ROM loaded for this device
911 @retval EFI_INVALID_PARAMETER PciHandle not found
912 @retval EFI_UNSUPPORTED There is no PCI ROM in the ROM BAR or no onboard
918 LegacyBiosInstallPciRom (
919 IN EFI_LEGACY_BIOS_PROTOCOL
* This
,
920 IN EFI_HANDLE PciHandle
,
923 OUT UINT8
*DiskStart
, OPTIONAL
924 OUT UINT8
*DiskEnd
, OPTIONAL
925 OUT VOID
**RomShadowAddress
, OPTIONAL
926 OUT UINT32
*RomShadowedSize OPTIONAL
931 Fill in the standard BDA for Keyboard LEDs
933 @param This Protocol instance pointer.
934 @param Leds Current LED status
936 @retval EFI_SUCCESS It should always work.
941 LegacyBiosUpdateKeyboardLedStatus (
942 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
950 @param This Protocol instance pointer.
951 @param HddCount Number of HDD_INFO structures
952 @param HddInfo Onboard IDE controller information
953 @param BbsCount Number of BBS_TABLE structures
954 @param BbsTable List BBS entries
956 @retval EFI_SUCCESS Tables returned
957 @retval EFI_NOT_FOUND resource not found
958 @retval EFI_DEVICE_ERROR can not get BBS table
963 LegacyBiosGetBbsInfo (
964 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
965 OUT UINT16
*HddCount
,
966 OUT HDD_INFO
**HddInfo
,
967 OUT UINT16
*BbsCount
,
968 OUT BBS_TABLE
**BbsTable
973 Shadow all legacy16 OPROMs that haven't been shadowed.
974 Warning: Use this with caution. This routine disconnects all EFI
975 drivers. If used externally then caller must re-connect EFI
978 @param This Protocol instance pointer.
980 @retval EFI_SUCCESS OPROMs shadowed
985 LegacyBiosShadowAllLegacyOproms (
986 IN EFI_LEGACY_BIOS_PROTOCOL
*This
991 Attempt to legacy boot the BootOption. If the EFI contexted has been
992 compromised this function will not return.
994 @param This Protocol instance pointer.
995 @param BbsDevicePath EFI Device Path from BootXXXX variable.
996 @param LoadOptionsSize Size of LoadOption in size.
997 @param LoadOptions LoadOption from BootXXXX variable
999 @retval EFI_SUCCESS Removable media not present
1004 LegacyBiosLegacyBoot (
1005 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1006 IN BBS_BBS_DEVICE_PATH
*BbsDevicePath
,
1007 IN UINT32 LoadOptionsSize
,
1008 IN VOID
*LoadOptions
1013 Allocate memory < 1 MB and copy the thunker code into low memory. Se up
1014 all the descriptors.
1016 @param Private Private context for Legacy BIOS
1018 @retval EFI_SUCCESS Should only pass.
1022 LegacyBiosInitializeThunk (
1023 IN LEGACY_BIOS_INSTANCE
*Private
1028 Fill in the standard BDA and EBDA stuff before Legacy16 load
1030 @param Private Legacy BIOS Instance data
1032 @retval EFI_SUCCESS It should always work.
1037 IN LEGACY_BIOS_INSTANCE
*Private
1042 Collect IDE Inquiry data from the IDE disks
1044 @param Private Legacy BIOS Instance data
1045 @param HddInfo Hdd Information
1046 @param Flag Reconnect IdeController or not
1048 @retval EFI_SUCCESS It should always work.
1052 LegacyBiosBuildIdeData (
1053 IN LEGACY_BIOS_INSTANCE
*Private
,
1054 IN HDD_INFO
**HddInfo
,
1060 Enable ide controller. This gets disabled when LegacyBoot.c is about
1061 to run the Option ROMs.
1063 @param Private Legacy BIOS Instance data
1068 EnableIdeController (
1069 IN LEGACY_BIOS_INSTANCE
*Private
1074 If the IDE channel is in compatibility (legacy) mode, remove all
1075 PCI I/O BAR addresses from the controller.
1077 @param IdeController The handle of target IDE controller
1082 InitLegacyIdeController (
1083 IN EFI_HANDLE IdeController
1088 Program the interrupt routing register in all the PCI devices. On a PC AT system
1089 this register contains the 8259 IRQ vector that matches it's PCI interrupt.
1091 @param Private Legacy BIOS Instance data
1093 @retval EFI_SUCCESS Succeed.
1094 @retval EFI_ALREADY_STARTED All PCI devices have been processed.
1098 PciProgramAllInterruptLineRegisters (
1099 IN LEGACY_BIOS_INSTANCE
*Private
1104 Collect EFI Info about legacy devices.
1106 @param Private Legacy BIOS Instance data
1108 @retval EFI_SUCCESS It should always work.
1112 LegacyBiosBuildSioData (
1113 IN LEGACY_BIOS_INSTANCE
*Private
1118 Shadow all the PCI legacy ROMs. Use data from the Legacy BIOS Protocol
1119 to chose the order. Skip any devices that have already have legacy
1122 @param Private Protocol instance pointer.
1124 @retval EFI_SUCCESS Succeed.
1125 @retval EFI_UNSUPPORTED Cannot get VGA device handle.
1130 IN LEGACY_BIOS_INSTANCE
*Private
1135 Fill in the standard BDA and EBDA stuff prior to legacy Boot
1137 @param Private Legacy BIOS Instance data
1139 @retval EFI_SUCCESS It should always work.
1143 LegacyBiosCompleteBdaBeforeBoot (
1144 IN LEGACY_BIOS_INSTANCE
*Private
1149 Fill in the standard CMOS stuff before Legacy16 load
1151 @param Private Legacy BIOS Instance data
1153 @retval EFI_SUCCESS It should always work.
1157 LegacyBiosInitCmos (
1158 IN LEGACY_BIOS_INSTANCE
*Private
1163 Fill in the standard CMOS stuff prior to legacy Boot
1165 @param Private Legacy BIOS Instance data
1167 @retval EFI_SUCCESS It should always work.
1171 LegacyBiosCompleteStandardCmosBeforeBoot (
1172 IN LEGACY_BIOS_INSTANCE
*Private
1177 Contains the code that is copied into low memory (below 640K).
1178 This code reflects interrupts 0x68-0x6f to interrupts 0x08-0x0f.
1179 This template must be copied into low memory, and the IDT entries
1180 0x68-0x6F must be point to the low memory copy of this code. Each
1181 entry is 4 bytes long, so IDT entries 0x68-0x6F can be easily
1186 InterruptRedirectionTemplate (
1192 Build the E820 table.
1194 @param Private Legacy BIOS Instance data
1195 @param Size Size of E820 Table
1197 @retval EFI_SUCCESS It should always work.
1201 LegacyBiosBuildE820 (
1202 IN LEGACY_BIOS_INSTANCE
*Private
,
1207 This function is to put all AP in halt state.
1209 @param Private Legacy BIOS Instance data
1214 IN LEGACY_BIOS_INSTANCE
*Private
1218 Worker function for LegacyBiosGetFlatDescs, retrieving content of
1221 @param IntThunk Pointer to IntThunk of Legacy BIOS context.
1226 LOW_MEMORY_THUNK
*IntThunk
1230 Routine for calling real thunk code.
1232 @param RealCode The address of thunk code.
1233 @param BiosInt The Bios interrupt vector number.
1234 @param CallAddress The address of 16-bit mode call.
1236 @return Status returned by real thunk code
1247 Routine for generating soft interrupt.
1249 @param Vector The interrupt vector number.
1258 Do an AllocatePages () of type AllocateMaxAddress for EfiBootServicesCode
1261 @param AllocateType Allocated Legacy Memory Type
1262 @param StartPageAddress Start address of range
1263 @param Pages Number of pages to allocate
1264 @param Result Result of allocation
1266 @retval EFI_SUCCESS Legacy16 code loaded
1267 @retval Other No protocol installed, unload driver.
1271 AllocateLegacyMemory (
1272 IN EFI_ALLOCATE_TYPE AllocateType
,
1273 IN EFI_PHYSICAL_ADDRESS StartPageAddress
,
1275 OUT EFI_PHYSICAL_ADDRESS
*Result
1279 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1281 @param This Protocol instance pointer.
1282 @param LegacyMemorySize Size of required region
1283 @param Region Region to use. 00 = Either 0xE0000 or 0xF0000
1284 block Bit0 = 1 0xF0000 block Bit1 = 1 0xE0000
1286 @param Alignment Address alignment. Bit mapped. First non-zero
1287 bit from right is alignment.
1288 @param LegacyMemoryAddress Region Assigned
1290 @retval EFI_SUCCESS Region assigned
1291 @retval EFI_ACCESS_DENIED Procedure previously invoked
1292 @retval Other Region not assigned
1297 LegacyBiosGetLegacyRegion (
1298 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1299 IN UINTN LegacyMemorySize
,
1302 OUT VOID
**LegacyMemoryAddress
1306 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1308 @param This Protocol instance pointer.
1309 @param LegacyMemorySize Size of data to copy
1310 @param LegacyMemoryAddress Legacy Region destination address Note: must
1311 be in region assigned by
1312 LegacyBiosGetLegacyRegion
1313 @param LegacyMemorySourceAddress Source of data
1315 @retval EFI_SUCCESS Region assigned
1316 @retval EFI_ACCESS_DENIED Destination outside assigned region
1321 LegacyBiosCopyLegacyRegion (
1322 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1323 IN UINTN LegacyMemorySize
,
1324 IN VOID
*LegacyMemoryAddress
,
1325 IN VOID
*LegacyMemorySourceAddress
1329 Find Legacy16 BIOS image in the FLASH device and shadow it into memory. Find
1330 the $EFI table in the shadow area. Thunk into the Legacy16 code after it had
1333 @param Private Legacy BIOS context data
1335 @retval EFI_SUCCESS Legacy16 code loaded
1336 @retval Other No protocol installed, unload driver.
1340 ShadowAndStartLegacy16 (
1341 IN LEGACY_BIOS_INSTANCE
*Private
1345 Checks the state of the floppy and if media is inserted.
1347 This routine checks the state of the floppy and if media is inserted.
1349 No floppy present - Set BBS entry to ignore
1350 Floppy present & no media - Set BBS entry to lowest priority. We cannot
1351 set it to ignore since 16-bit CSM will
1352 indicate no floppy and thus drive A: is
1353 unusable. CSM-16 will not try floppy since
1354 lowest priority and thus not incur boot
1356 Floppy present & media - Set BBS entry to some priority.
1358 @return State of floppy media
1367 Identify drive data must be updated to actual parameters before boot.
1368 This requires updating the checksum, if it exists.
1370 @param IdentifyDriveData ATA Identify Data
1371 @param Checksum checksum of the ATA Identify Data
1373 @retval EFI_SUCCESS checksum calculated
1374 @retval EFI_SECURITY_VIOLATION IdentifyData invalid
1378 CalculateIdentifyDriveChecksum (
1379 IN UINT8
*IdentifyDriveData
,
1384 Identify drive data must be updated to actual parameters before boot.
1386 @param IdentifyDriveData ATA Identify Data
1390 UpdateIdentifyDriveData (
1391 IN UINT8
*IdentifyDriveData
1395 Complete build of BBS TABLE.
1397 @param Private Legacy BIOS Instance data
1398 @param BbsTable BBS Table passed to 16-bit code
1400 @retval EFI_SUCCESS Removable media not present
1404 LegacyBiosBuildBbs (
1405 IN LEGACY_BIOS_INSTANCE
*Private
,
1406 IN BBS_TABLE
*BbsTable
1410 Read CMOS register through index/data port.
1412 @param[in] Index The index of the CMOS register to read.
1414 @return The data value from the CMOS register specified by Index.
1418 LegacyReadStandardCmos (
1423 Write CMOS register through index/data port.
1425 @param[in] Index The index of the CMOS register to write.
1426 @param[in] Value The value of CMOS register to write.
1428 @return The value written to the CMOS register specified by Index.
1432 LegacyWriteStandardCmos (
1438 Calculate the new standard CMOS checksum and write it.
1440 @param Private Legacy BIOS Instance data
1442 @retval EFI_SUCCESS Calculate 16-bit checksum successfully
1446 LegacyCalculateWriteStandardCmosChecksum (
1451 Test to see if a legacy PCI ROM exists for this device. Optionally return
1452 the Legacy ROM instance for this PCI device.
1454 @param[in] This Protocol instance pointer.
1455 @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
1456 @param[out] RomImage Return the legacy PCI ROM for this device
1457 @param[out] RomSize Size of ROM Image
1458 @param[out] RuntimeImageLength Runtime size of ROM Image
1459 @param[out] Flags Indicates if ROM found and if PC-AT.
1460 @param[out] OpromRevision Revision of the PCI Rom
1461 @param[out] ConfigUtilityCodeHeaderPointer of Configuration Utility Code Header
1463 @return EFI_SUCCESS Legacy Option ROM availible for this device
1464 @return EFI_ALREADY_STARTED This device is already managed by its Oprom
1465 @return EFI_UNSUPPORTED Legacy Option ROM not supported.
1469 LegacyBiosCheckPciRomEx (
1470 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1471 IN EFI_HANDLE PciHandle
,
1472 OUT VOID
**RomImage
, OPTIONAL
1473 OUT UINTN
*RomSize
, OPTIONAL
1474 OUT UINTN
*RuntimeImageLength
, OPTIONAL
1475 OUT UINTN
*Flags
, OPTIONAL
1476 OUT UINT8
*OpromRevision
, OPTIONAL
1477 OUT VOID
**ConfigUtilityCodeHeader OPTIONAL
1481 Relocate this image under 4G memory for IPF.
1483 @param ImageHandle Handle of driver image.
1484 @param SystemTable Pointer to system table.
1486 @retval EFI_SUCCESS Image successfully relocated.
1487 @retval EFI_ABORTED Failed to relocate image.
1491 RelocateImageUnder4GIfNeeded (
1492 IN EFI_HANDLE ImageHandle
,
1493 IN EFI_SYSTEM_TABLE
*SystemTable
1497 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
1498 16-bit register context on entry and exit. Arguments can be passed on
1501 @param This Protocol instance pointer.
1502 @param Segment Segemnt of 16-bit mode call
1503 @param Offset Offset of 16-bit mdoe call
1504 @param Regs Register contexted passed into (and returned) from thunk to
1506 @param Stack Caller allocated stack used to pass arguments
1507 @param StackSize Size of Stack in bytes
1509 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
1510 See Regs for status.
1511 @retval TRUE There was a BIOS erro in the target code.
1516 InternalLegacyBiosFarCall (
1517 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1520 IN EFI_IA32_REGISTER_SET
*Regs
,
1526 Load a legacy PC-AT OpROM for VGA controller.
1528 @param Private Driver private data.
1530 @retval EFI_SUCCESS Legacy ROM successfully installed for this device.
1531 @retval EFI_DEVICE_ERROR No VGA device handle found, or native EFI video
1532 driver cannot be successfully disconnected, or VGA
1533 thunk driver cannot be successfully connected.
1537 LegacyBiosInstallVgaRom (
1538 IN LEGACY_BIOS_INSTANCE
*Private