3 Copyright (c) 2006 - 2011, 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>
22 #include <Guid/SmBios.h>
23 #include <Guid/Acpi.h>
24 #include <Guid/DxeServices.h>
25 #include <Guid/LegacyBios.h>
26 #include <Guid/StatusCodeDataTypeId.h>
28 #include <Protocol/BlockIo.h>
29 #include <Protocol/LoadedImage.h>
30 #include <Protocol/PciIo.h>
31 #include <Protocol/Cpu.h>
32 #include <Protocol/Timer.h>
33 #include <Protocol/IsaIo.h>
34 #include <Protocol/LegacyRegion2.h>
35 #include <Protocol/SimpleTextIn.h>
36 #include <Protocol/LegacyInterrupt.h>
37 #include <Protocol/LegacyBios.h>
38 #include <Protocol/DiskInfo.h>
39 #include <Protocol/GenericMemoryTest.h>
40 #include <Protocol/LegacyBiosPlatform.h>
41 #include <Protocol/DevicePath.h>
42 #include <Protocol/Legacy8259.h>
43 #include <Protocol/PciRootBridgeIo.h>
45 #include <Library/BaseLib.h>
46 #include <Library/DebugLib.h>
47 #include <Library/UefiLib.h>
48 #include <Library/BaseMemoryLib.h>
49 #include <Library/ReportStatusCodeLib.h>
50 #include <Library/UefiRuntimeServicesTableLib.h>
51 #include <Library/HobLib.h>
52 #include <Library/UefiDriverEntryPoint.h>
53 #include <Library/MemoryAllocationLib.h>
54 #include <Library/UefiBootServicesTableLib.h>
55 #include <Library/IoLib.h>
56 #include <Library/PcdLib.h>
57 #include <Library/DevicePathLib.h>
58 #include <Library/DxeServicesTableLib.h>
59 #include <Library/PeCoffLib.h>
60 #include <Library/CacheMaintenanceLib.h>
61 #include <Library/DebugAgentLib.h>
64 // BUGBUG: This entry maybe changed to PCD in future and wait for
65 // redesign of BDS library
67 #define MAX_BBS_ENTRIES 0x100
71 // (These apply only to errors with the thunk and not to the code that was
75 #define THUNK_ERR_A20_UNSUP 0x01
76 #define THUNK_ERR_A20_FAILED 0x02
79 // Vector base definitions
82 // 8259 Hardware definitions
84 #define LEGACY_MODE_BASE_VECTOR_MASTER 0x08
85 #define LEGACY_MODE_BASE_VECTOR_SLAVE 0x70
88 // The original PC used INT8-F for master PIC. Since these mapped over
89 // processor exceptions TIANO moved the master PIC to INT68-6F.
91 // The vector base for slave PIC is set as 0x70 for PC-AT compatibility.
93 #define PROTECTED_MODE_BASE_VECTOR_MASTER 0x68
94 #define PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70
100 #define LEGACY_BDA_TRACE 0x000
101 #define LEGACY_BIOS_TRACE 0x040
102 #define LEGACY_BOOT_TRACE 0x080
103 #define LEGACY_CMOS_TRACE 0x0C0
104 #define LEGACY_IDE_TRACE 0x100
105 #define LEGACY_MP_TRACE 0x140
106 #define LEGACY_PCI_TRACE 0x180
107 #define LEGACY_SIO_TRACE 0x1C0
109 #define LEGACY_PCI_TRACE_000 LEGACY_PCI_TRACE + 0x00
110 #define LEGACY_PCI_TRACE_001 LEGACY_PCI_TRACE + 0x01
111 #define LEGACY_PCI_TRACE_002 LEGACY_PCI_TRACE + 0x02
112 #define LEGACY_PCI_TRACE_003 LEGACY_PCI_TRACE + 0x03
113 #define LEGACY_PCI_TRACE_004 LEGACY_PCI_TRACE + 0x04
114 #define LEGACY_PCI_TRACE_005 LEGACY_PCI_TRACE + 0x05
115 #define LEGACY_PCI_TRACE_006 LEGACY_PCI_TRACE + 0x06
116 #define LEGACY_PCI_TRACE_007 LEGACY_PCI_TRACE + 0x07
117 #define LEGACY_PCI_TRACE_008 LEGACY_PCI_TRACE + 0x08
118 #define LEGACY_PCI_TRACE_009 LEGACY_PCI_TRACE + 0x09
119 #define LEGACY_PCI_TRACE_00A LEGACY_PCI_TRACE + 0x0A
120 #define LEGACY_PCI_TRACE_00B LEGACY_PCI_TRACE + 0x0B
121 #define LEGACY_PCI_TRACE_00C LEGACY_PCI_TRACE + 0x0C
122 #define LEGACY_PCI_TRACE_00D LEGACY_PCI_TRACE + 0x0D
123 #define LEGACY_PCI_TRACE_00E LEGACY_PCI_TRACE + 0x0E
124 #define LEGACY_PCI_TRACE_00F LEGACY_PCI_TRACE + 0x0F
132 UINT32 ShadowAddress
;
136 } ROM_INSTANCE_ENTRY
;
139 // Values for RealModeGdt
141 #if defined (MDE_CPU_IA32)
143 #define NUM_REAL_GDT_ENTRIES 3
144 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
145 #define INITIAL_VALUE_BELOW_1K 0x0
147 #elif defined (MDE_CPU_X64)
149 #define NUM_REAL_GDT_ENTRIES 8
150 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
151 #define INITIAL_VALUE_BELOW_1K 0x0
153 #elif defined (MDE_CPU_IPF)
155 #define NUM_REAL_GDT_ENTRIES 3
156 #define CONVENTIONAL_MEMORY_TOP 0x80000 // 512 KB
157 #define INITIAL_VALUE_BELOW_1K 0xff
164 // Define what a processor GDT looks like
177 UINT32 DefaultSize
: 1;
178 UINT32 Granularity
: 1;
192 // Define what a processor descriptor looks like
193 // This data structure must be kept in sync with ASM STRUCT in Thunk.inc
208 #define LOW_STACK_SIZE (8 * 1024) // 8k?
209 #define EFI_MAX_E820_ENTRY 100
210 #define FIRST_INSTANCE 1
211 #define NOT_FIRST_INSTANCE 0
213 #if defined (MDE_CPU_IA32)
216 // Space for the code
217 // The address of Code is also the beginning of the relocated Thunk code
219 CHAR8 Code
[4096]; // ?
221 // The address of the Reverse Thunk code
222 // Note that this member CONTAINS the address of the relocated reverse thunk
223 // code unlike the member variable 'Code', which IS the address of the Thunk
226 UINT32 LowReverseThunkStart
;
229 // Data for the code (cs releative)
231 DESCRIPTOR32 GdtDesc
; // Protected mode GDT
232 DESCRIPTOR32 IdtDesc
; // Protected mode IDT
236 UINT32 LowCodeSelector
; // Low code selector in GDT
237 UINT32 LowDataSelector
; // Low data selector in GDT
239 DESCRIPTOR32 RealModeIdtDesc
;
242 // real-mode GDT (temporary GDT with two real mode segment descriptors)
244 GDT32 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
245 DESCRIPTOR32 RealModeGdtDesc
;
248 // Members specifically for the reverse thunk
249 // The RevReal* members are used to store the current state of real mode
250 // before performing the reverse thunk. The RevFlat* members must be set
251 // before calling the reverse thunk assembly code.
256 DESCRIPTOR32 RevRealIdtDesc
;
257 UINT16 RevFlatDataSelector
; // Flat data selector in GDT
261 // A low memory stack
263 CHAR8 Stack
[LOW_STACK_SIZE
];
266 // Stack for flat mode after reverse thunk
267 // @bug - This may no longer be necessary if the reverse thunk interface
268 // is changed to have the flat stack in a different location.
270 CHAR8 RevThunkStack
[LOW_STACK_SIZE
];
273 // Legacy16 Init memory map info
275 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
277 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
279 CHAR8 InterruptRedirectionCode
[32];
280 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
281 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
282 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
285 #elif defined (MDE_CPU_X64)
289 // Space for the code
290 // The address of Code is also the beginning of the relocated Thunk code
292 CHAR8 Code
[4096]; // ?
295 // Data for the code (cs releative)
297 DESCRIPTOR64 X64GdtDesc
; // Protected mode GDT
298 DESCRIPTOR64 X64IdtDesc
; // Protected mode IDT
303 DESCRIPTOR32 RealModeIdtDesc
;
304 DESCRIPTOR32 RealModeGdtDesc
;
307 // real-mode GDT (temporary GDT with two real mode segment descriptors)
309 GDT64 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
310 UINT64 PageMapLevel4
;
313 // A low memory stack
315 CHAR8 Stack
[LOW_STACK_SIZE
];
318 // Legacy16 Init memory map info
320 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
322 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
324 CHAR8 InterruptRedirectionCode
[32];
325 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
326 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
327 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
330 #elif defined (MDE_CPU_IPF)
334 // Space for the code
335 // The address of Code is also the beginning of the relocated Thunk code
337 CHAR8 Code
[4096]; // ?
339 // The address of the Reverse Thunk code
340 // Note that this member CONTAINS the address of the relocated reverse thunk
341 // code unlike the member variable 'Code', which IS the address of the Thunk
344 UINT32 LowReverseThunkStart
;
347 // Data for the code (cs releative)
349 DESCRIPTOR32 GdtDesc
; // Protected mode GDT
350 DESCRIPTOR32 IdtDesc
; // Protected mode IDT
354 UINT32 LowCodeSelector
; // Low code selector in GDT
355 UINT32 LowDataSelector
; // Low data selector in GDT
357 DESCRIPTOR32 RealModeIdtDesc
;
360 // real-mode GDT (temporary GDT with two real mode segment descriptors)
362 GDT32 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
363 DESCRIPTOR32 RealModeGdtDesc
;
366 // Members specifically for the reverse thunk
367 // The RevReal* members are used to store the current state of real mode
368 // before performing the reverse thunk. The RevFlat* members must be set
369 // before calling the reverse thunk assembly code.
374 DESCRIPTOR32 RevRealIdtDesc
;
375 UINT16 RevFlatDataSelector
; // Flat data selector in GDT
379 // A low memory stack
381 CHAR8 Stack
[LOW_STACK_SIZE
];
384 // Stack for flat mode after reverse thunk
385 // @bug - This may no longer be necessary if the reverse thunk interface
386 // is changed to have the flat stack in a different location.
388 CHAR8 RevThunkStack
[LOW_STACK_SIZE
];
391 // Legacy16 Init memory map info
393 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
395 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
397 CHAR8 InterruptRedirectionCode
[32];
398 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
399 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
400 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
406 // PnP Expansion Header
417 UINT16 ProductNamePointer
;
421 UINT8 DeviceIndicators
;
423 UINT16 DisconnectVector
;
426 UINT16 StaticResourceVector
;
427 } LEGACY_PNP_EXPANSION_HEADER
;
443 UINTN ManufacturerString
;
444 UINTN ProductNameString
;
445 } LEGACY_ROM_AND_BBS_TABLE
;
448 // Structure how EFI has mapped a devices HDD drive numbers.
449 // Boot to EFI aware OS or shell requires this mapping when
450 // 16-bit CSM assigns drive numbers.
451 // This mapping is ignored booting to a legacy OS.
458 UINT8 StartDriveNumber
;
459 UINT8 EndDriveNumber
;
460 } LEGACY_EFI_HDD_TABLE
;
463 // This data is passed to Leacy16Boot
466 EfiAcpiAddressRangeMemory
= 1,
467 EfiAcpiAddressRangeReserved
= 2,
468 EfiAcpiAddressRangeACPI
= 3,
469 EfiAcpiAddressRangeNVS
= 4
470 } EFI_ACPI_MEMORY_TYPE
;
475 EFI_ACPI_MEMORY_TYPE Type
;
483 EFI_ACPI_MEMORY_TYPE Type
;
488 extern BBS_TABLE
*mBbsTable
;
490 extern EFI_GENERIC_MEMORY_TEST_PROTOCOL
*gGenMemoryTest
;
495 #define CMOS_0A 0x0a ///< Status register A
496 #define CMOS_0D 0x0d ///< Status register D
497 #define CMOS_0E 0x0e ///< Diagnostic Status
498 #define CMOS_0F 0x0f ///< Shutdown status
499 #define CMOS_10 0x10 ///< Floppy type
500 #define CMOS_12 0x12 ///< IDE type
501 #define CMOS_14 0x14 ///< Same as BDA 40:10
502 #define CMOS_15 0x15 ///< Low byte of base memory in 1k increments
503 #define CMOS_16 0x16 ///< High byte of base memory in 1k increments
504 #define CMOS_17 0x17 ///< Low byte of 1MB+ memory in 1k increments - max 15 MB
505 #define CMOS_18 0x18 ///< High byte of 1MB+ memory in 1k increments - max 15 MB
506 #define CMOS_19 0x19 ///< C: extended drive type
507 #define CMOS_1A 0x1a ///< D: extended drive type
508 #define CMOS_2E 0x2e ///< Most significient byte of standard checksum
509 #define CMOS_2F 0x2f ///< Least significient byte of standard checksum
510 #define CMOS_30 0x30 ///< CMOS 0x17
511 #define CMOS_31 0x31 ///< CMOS 0x18
512 #define CMOS_32 0x32 ///< Century byte
515 // 8254 Timer registers
517 #define TIMER0_COUNT_PORT 0x40
518 #define TIMER1_COUNT_PORT 0x41
519 #define TIMER2_COUNT_PORT 0x42
520 #define TIMER_CONTROL_PORT 0x43
523 // Timer 0, Read/Write LSB then MSB, Square wave output, binary count use.
525 #define TIMER0_CONTROL_WORD 0x36
527 #define LEGACY_BIOS_INSTANCE_SIGNATURE SIGNATURE_32 ('L', 'B', 'I', 'T')
532 EFI_LEGACY_BIOS_PROTOCOL LegacyBios
;
534 EFI_HANDLE ImageHandle
;
537 // CPU Architectural Protocol
539 EFI_CPU_ARCH_PROTOCOL
*Cpu
;
542 // Timer Architectural Protocol
544 EFI_TIMER_ARCH_PROTOCOL
*Timer
;
545 BOOLEAN TimerUses8254
;
548 // Protocol to Lock and Unlock 0xc0000 - 0xfffff
550 EFI_LEGACY_REGION2_PROTOCOL
*LegacyRegion
;
552 EFI_LEGACY_BIOS_PLATFORM_PROTOCOL
*LegacyBiosPlatform
;
555 // Interrupt control for thunk and PCI IRQ
557 EFI_LEGACY_8259_PROTOCOL
*Legacy8259
;
560 // PCI Interrupt PIRQ control
562 EFI_LEGACY_INTERRUPT_PROTOCOL
*LegacyInterrupt
;
565 // Generic Memory Test
567 EFI_GENERIC_MEMORY_TEST_PROTOCOL
*GenericMemoryTest
;
570 // TRUE if PCI Interupt Line registers have been programmed.
572 BOOLEAN PciInterruptLine
;
575 // Code space below 1MB needed by thunker to transition to real mode.
576 // Contains stack and real mode code fragments
578 LOW_MEMORY_THUNK
*IntThunk
;
581 // Starting shadow address of the Legacy BIOS
584 UINT32 LegacyBiosImageSize
;
587 // Start of variables used by CsmItp.mac ITP macro file and/os LegacyBios
592 // $EFI Legacy16 code entry info in memory < 1 MB;
594 EFI_COMPATIBILITY16_TABLE
*Legacy16Table
;
595 VOID
*Legacy16InitPtr
;
596 VOID
*Legacy16BootPtr
;
597 VOID
*InternalIrqRoutingTable
;
598 UINT32 NumberIrqRoutingEntries
;
601 UINT32 NumberHddControllers
;
604 // Cached copy of Legacy16 entry point
606 UINT16 Legacy16CallSegment
;
607 UINT16 Legacy16CallOffset
;
610 // Returned from $EFI and passed in to OPROMS
612 UINT16 PnPInstallationCheckSegment
;
613 UINT16 PnPInstallationCheckOffset
;
618 EFI_E820_ENTRY E820Table
[EFI_MAX_E820_ENTRY
];
619 UINT32 NumberE820Entries
;
622 // True if legacy VGA INT 10h handler installed
624 BOOLEAN VgaInstalled
;
627 // Number of IDE drives
632 // Current Free Option ROM space. An option ROM must NOT go past
638 // Save Legacy16 unexpected interrupt vector. Reprogram INT 68-6F from
639 // EFI values to legacy value just before boot.
641 UINT32 BiosUnexpectedInt
;
642 UINT32 ThunkSavedInt
[8];
644 LEGACY_EFI_HDD_TABLE
*LegacyEfiHddTable
;
645 UINT16 LegacyEfiHddTableIndex
;
652 // Indicate that whether GenericLegacyBoot is entered or not
654 BOOLEAN LegacyBootEntered
;
657 // CSM16 PCI Interface Version
659 UINT16 Csm16PciInterfaceVersion
;
661 } LEGACY_BIOS_INSTANCE
;
674 40:0E-0E Ebda segment
675 40:10-11 MachineConfig
677 40:13-14 MemSize below 1MB
678 40:15-16 Bda15_16 - skip
679 40:17 Keyboard Shift status
680 40:18-19 Bda18_19 - skip
681 40:1A-1B Key buffer head
682 40:1C-1D Key buffer tail
683 40:1E-3D Bda1E_3D- key buffer -skip
684 40:3E-3F FloppyData 3E = Calibration status 3F = Motor status
686 40:41-74 Bda41_74 - skip
687 40:75 Number of HDD drives
688 40:76-77 Bda76_77 - skip
689 40:78-79 78 = Lpt1 timeout, 79 = Lpt2 timeout
690 40:7A-7B 7A = Lpt3 timeout, 7B = Lpt4 timeout
691 40:7C-7D 7C = Com1 timeout, 7D = Com2 timeout
692 40:7E-7F 7E = Com3 timeout, 7F = Com4 timeout
693 40:80-81 Pointer to start of key buffer
694 40:82-83 Pointer to end of key buffer
695 40:84-87 Bda84_87 - skip
696 40:88 HDD Data Xmit rate
698 40:90 Floppy data rate
700 40:96 Keyboard Status
713 UINT16 MachineConfig
;
716 UINT8 Bda15_16
[0x02];
718 UINT8 Bda18_19
[0x02];
721 UINT16 Bda1E_3D
[0x10];
724 UINT8 Bda41_74
[0x34];
725 UINT8 NumberOfDrives
;
726 UINT8 Bda76_77
[0x02];
727 UINT16 Lpt1_2Timeout
;
728 UINT16 Lpt3_4Timeout
;
729 UINT16 Com1_2Timeout
;
730 UINT16 Com3_4Timeout
;
735 UINT8 Bda89_8F
[0x07];
737 UINT8 Bda91_95
[0x05];
738 UINT8 KeyboardStatus
;
743 #define LEGACY_BIOS_INSTANCE_FROM_THIS(this) CR (this, LEGACY_BIOS_INSTANCE, LegacyBios, LEGACY_BIOS_INSTANCE_SIGNATURE)
746 Thunk to 16-bit real mode and execute a software interrupt with a vector
747 of BiosInt. Regs will contain the 16-bit register context on entry and
750 @param This Protocol instance pointer.
751 @param BiosInt Processor interrupt vector to invoke
752 @param Regs Register contexted passed into (and returned) from thunk to
755 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
757 @retval TRUE There was a BIOS erro in the target code.
763 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
765 IN EFI_IA32_REGISTER_SET
*Regs
770 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
771 16-bit register context on entry and exit. Arguments can be passed on
774 @param This Protocol instance pointer.
775 @param Segment Segemnt of 16-bit mode call
776 @param Offset Offset of 16-bit mdoe call
777 @param Regs Register contexted passed into (and returned) from
779 @param Stack Caller allocated stack used to pass arguments
780 @param StackSize Size of Stack in bytes
782 @retval FALSE Thunk completed, and there were no BIOS errors in
783 the target code. See Regs for status.
784 @retval TRUE There was a BIOS erro in the target code.
789 LegacyBiosFarCall86 (
790 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
793 IN EFI_IA32_REGISTER_SET
*Regs
,
800 Test to see if a legacy PCI ROM exists for this device. Optionally return
801 the Legacy ROM instance for this PCI device.
803 @param This Protocol instance pointer.
804 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
806 @param RomImage Return the legacy PCI ROM for this device
807 @param RomSize Size of ROM Image
808 @param Flags Indicates if ROM found and if PC-AT.
810 @retval EFI_SUCCESS Legacy Option ROM availible for this device
811 @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
816 LegacyBiosCheckPciRom (
817 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
818 IN EFI_HANDLE PciHandle
,
819 OUT VOID
**RomImage
, OPTIONAL
820 OUT UINTN
*RomSize
, OPTIONAL
826 Assign drive number to legacy HDD drives prior to booting an EFI
827 aware OS so the OS can access drives without an EFI driver.
828 Note: BBS compliant drives ARE NOT available until this call by
831 @param This Protocol instance pointer.
832 @param BbsCount Number of BBS_TABLE structures
833 @param BbsTable List BBS entries
835 @retval EFI_SUCCESS Drive numbers assigned
840 LegacyBiosPrepareToBootEfi (
841 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
842 OUT UINT16
*BbsCount
,
843 OUT BBS_TABLE
**BbsTable
848 To boot from an unconventional device like parties and/or execute
851 @param This Protocol instance pointer.
852 @param Attributes How to interpret the other input parameters
853 @param BbsEntry The 0-based index into the BbsTable for the parent
855 @param BeerData Pointer to the 128 bytes of ram BEER data.
856 @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data.
857 The caller must provide a pointer to the specific
858 Service Area and not the start all Service Areas.
859 EFI_INVALID_PARAMETER if error. Does NOT return if no error.
864 LegacyBiosBootUnconventionalDevice (
865 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
866 IN UDC_ATTRIBUTES Attributes
,
869 IN VOID
*ServiceAreaData
874 Load a legacy PC-AT OPROM on the PciHandle device. Return information
875 about how many disks were added by the OPROM and the shadow address and
876 size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:
878 @param This Protocol instance pointer.
879 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
880 be loaded. This value is NULL if RomImage is
881 non-NULL. This is the normal case.
882 @param RomImage A PCI PC-AT ROM image. This argument is non-NULL
883 if there is no hardware associated with the ROM
884 and thus no PciHandle, otherwise is must be NULL.
885 Example is PXE base code.
886 @param Flags Indicates if ROM found and if PC-AT.
887 @param DiskStart Disk number of first device hooked by the ROM. If
888 DiskStart is the same as DiskEnd no disked were
890 @param DiskEnd Disk number of the last device hooked by the ROM.
891 @param RomShadowAddress Shadow address of PC-AT ROM
892 @param RomShadowedSize Size of RomShadowAddress in bytes
894 @retval EFI_SUCCESS Legacy ROM loaded for this device
895 @retval EFI_INVALID_PARAMETER PciHandle not found
896 @retval EFI_UNSUPPORTED There is no PCI ROM in the ROM BAR or no onboard
902 LegacyBiosInstallPciRom (
903 IN EFI_LEGACY_BIOS_PROTOCOL
* This
,
904 IN EFI_HANDLE PciHandle
,
907 OUT UINT8
*DiskStart
, OPTIONAL
908 OUT UINT8
*DiskEnd
, OPTIONAL
909 OUT VOID
**RomShadowAddress
, OPTIONAL
910 OUT UINT32
*RomShadowedSize OPTIONAL
915 Fill in the standard BDA for Keyboard LEDs
917 @param This Protocol instance pointer.
918 @param Leds Current LED status
920 @retval EFI_SUCCESS It should always work.
925 LegacyBiosUpdateKeyboardLedStatus (
926 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
934 @param This Protocol instance pointer.
935 @param HddCount Number of HDD_INFO structures
936 @param HddInfo Onboard IDE controller information
937 @param BbsCount Number of BBS_TABLE structures
938 @param BbsTable List BBS entries
940 @retval EFI_SUCCESS Tables returned
941 @retval EFI_NOT_FOUND resource not found
942 @retval EFI_DEVICE_ERROR can not get BBS table
947 LegacyBiosGetBbsInfo (
948 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
949 OUT UINT16
*HddCount
,
950 OUT HDD_INFO
**HddInfo
,
951 OUT UINT16
*BbsCount
,
952 OUT BBS_TABLE
**BbsTable
957 Shadow all legacy16 OPROMs that haven't been shadowed.
958 Warning: Use this with caution. This routine disconnects all EFI
959 drivers. If used externally then caller must re-connect EFI
962 @param This Protocol instance pointer.
964 @retval EFI_SUCCESS OPROMs shadowed
969 LegacyBiosShadowAllLegacyOproms (
970 IN EFI_LEGACY_BIOS_PROTOCOL
*This
975 Attempt to legacy boot the BootOption. If the EFI contexted has been
976 compromised this function will not return.
978 @param This Protocol instance pointer.
979 @param BbsDevicePath EFI Device Path from BootXXXX variable.
980 @param LoadOptionsSize Size of LoadOption in size.
981 @param LoadOptions LoadOption from BootXXXX variable
983 @retval EFI_SUCCESS Removable media not present
988 LegacyBiosLegacyBoot (
989 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
990 IN BBS_BBS_DEVICE_PATH
*BbsDevicePath
,
991 IN UINT32 LoadOptionsSize
,
997 Allocate memory < 1 MB and copy the thunker code into low memory. Se up
1000 @param Private Private context for Legacy BIOS
1002 @retval EFI_SUCCESS Should only pass.
1006 LegacyBiosInitializeThunk (
1007 IN LEGACY_BIOS_INSTANCE
*Private
1012 Fill in the standard BDA and EBDA stuff before Legacy16 load
1014 @param Private Legacy BIOS Instance data
1016 @retval EFI_SUCCESS It should always work.
1021 IN LEGACY_BIOS_INSTANCE
*Private
1026 Collect IDE Inquiry data from the IDE disks
1028 @param Private Legacy BIOS Instance data
1029 @param HddInfo Hdd Information
1030 @param Flag Reconnect IdeController or not
1032 @retval EFI_SUCCESS It should always work.
1036 LegacyBiosBuildIdeData (
1037 IN LEGACY_BIOS_INSTANCE
*Private
,
1038 IN HDD_INFO
**HddInfo
,
1044 Enable ide controller. This gets disabled when LegacyBoot.c is about
1045 to run the Option ROMs.
1047 @param Private Legacy BIOS Instance data
1052 EnableIdeController (
1053 IN LEGACY_BIOS_INSTANCE
*Private
1058 If the IDE channel is in compatibility (legacy) mode, remove all
1059 PCI I/O BAR addresses from the controller.
1061 @param IdeController The handle of target IDE controller
1066 InitLegacyIdeController (
1067 IN EFI_HANDLE IdeController
1072 Program the interrupt routing register in all the PCI devices. On a PC AT system
1073 this register contains the 8259 IRQ vector that matches it's PCI interrupt.
1075 @param Private Legacy BIOS Instance data
1077 @retval EFI_SUCCESS Succeed.
1078 @retval EFI_ALREADY_STARTED All PCI devices have been processed.
1082 PciProgramAllInterruptLineRegisters (
1083 IN LEGACY_BIOS_INSTANCE
*Private
1088 Collect EFI Info about legacy devices.
1090 @param Private Legacy BIOS Instance data
1092 @retval EFI_SUCCESS It should always work.
1096 LegacyBiosBuildSioData (
1097 IN LEGACY_BIOS_INSTANCE
*Private
1102 Shadow all the PCI legacy ROMs. Use data from the Legacy BIOS Protocol
1103 to chose the order. Skip any devices that have already have legacy
1106 @param Private Protocol instance pointer.
1108 @retval EFI_SUCCESS Succeed.
1109 @retval EFI_UNSUPPORTED Cannot get VGA device handle.
1114 IN LEGACY_BIOS_INSTANCE
*Private
1119 Fill in the standard BDA and EBDA stuff prior to legacy Boot
1121 @param Private Legacy BIOS Instance data
1123 @retval EFI_SUCCESS It should always work.
1127 LegacyBiosCompleteBdaBeforeBoot (
1128 IN LEGACY_BIOS_INSTANCE
*Private
1133 Fill in the standard CMOS stuff before Legacy16 load
1135 @param Private Legacy BIOS Instance data
1137 @retval EFI_SUCCESS It should always work.
1141 LegacyBiosInitCmos (
1142 IN LEGACY_BIOS_INSTANCE
*Private
1147 Fill in the standard CMOS stuff prior to legacy Boot
1149 @param Private Legacy BIOS Instance data
1151 @retval EFI_SUCCESS It should always work.
1155 LegacyBiosCompleteStandardCmosBeforeBoot (
1156 IN LEGACY_BIOS_INSTANCE
*Private
1161 Contains the code that is copied into low memory (below 640K).
1162 This code reflects interrupts 0x68-0x6f to interrupts 0x08-0x0f.
1163 This template must be copied into low memory, and the IDT entries
1164 0x68-0x6F must be point to the low memory copy of this code. Each
1165 entry is 4 bytes long, so IDT entries 0x68-0x6F can be easily
1170 InterruptRedirectionTemplate (
1176 Build the E820 table.
1178 @param Private Legacy BIOS Instance data
1179 @param Size Size of E820 Table
1181 @retval EFI_SUCCESS It should always work.
1185 LegacyBiosBuildE820 (
1186 IN LEGACY_BIOS_INSTANCE
*Private
,
1191 This function is to put all AP in halt state.
1193 @param Private Legacy BIOS Instance data
1198 IN LEGACY_BIOS_INSTANCE
*Private
1202 Worker function for LegacyBiosGetFlatDescs, retrieving content of
1205 @param IntThunk Pointer to IntThunk of Legacy BIOS context.
1210 LOW_MEMORY_THUNK
*IntThunk
1214 Routine for calling real thunk code.
1216 @param RealCode The address of thunk code.
1217 @param BiosInt The Bios interrupt vector number.
1218 @param CallAddress The address of 16-bit mode call.
1220 @return Status returned by real thunk code
1231 Routine for generating soft interrupt.
1233 @param Vector The interrupt vector number.
1242 Do an AllocatePages () of type AllocateMaxAddress for EfiBootServicesCode
1245 @param AllocateType Allocated Legacy Memory Type
1246 @param StartPageAddress Start address of range
1247 @param Pages Number of pages to allocate
1248 @param Result Result of allocation
1250 @retval EFI_SUCCESS Legacy16 code loaded
1251 @retval Other No protocol installed, unload driver.
1255 AllocateLegacyMemory (
1256 IN EFI_ALLOCATE_TYPE AllocateType
,
1257 IN EFI_PHYSICAL_ADDRESS StartPageAddress
,
1259 OUT EFI_PHYSICAL_ADDRESS
*Result
1263 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1265 @param This Protocol instance pointer.
1266 @param LegacyMemorySize Size of required region
1267 @param Region Region to use. 00 = Either 0xE0000 or 0xF0000
1268 block Bit0 = 1 0xF0000 block Bit1 = 1 0xE0000
1270 @param Alignment Address alignment. Bit mapped. First non-zero
1271 bit from right is alignment.
1272 @param LegacyMemoryAddress Region Assigned
1274 @retval EFI_SUCCESS Region assigned
1275 @retval EFI_ACCESS_DENIED Procedure previously invoked
1276 @retval Other Region not assigned
1281 LegacyBiosGetLegacyRegion (
1282 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1283 IN UINTN LegacyMemorySize
,
1286 OUT VOID
**LegacyMemoryAddress
1290 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1292 @param This Protocol instance pointer.
1293 @param LegacyMemorySize Size of data to copy
1294 @param LegacyMemoryAddress Legacy Region destination address Note: must
1295 be in region assigned by
1296 LegacyBiosGetLegacyRegion
1297 @param LegacyMemorySourceAddress Source of data
1299 @retval EFI_SUCCESS Region assigned
1300 @retval EFI_ACCESS_DENIED Destination outside assigned region
1305 LegacyBiosCopyLegacyRegion (
1306 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1307 IN UINTN LegacyMemorySize
,
1308 IN VOID
*LegacyMemoryAddress
,
1309 IN VOID
*LegacyMemorySourceAddress
1313 Find Legacy16 BIOS image in the FLASH device and shadow it into memory. Find
1314 the $EFI table in the shadow area. Thunk into the Legacy16 code after it had
1317 @param Private Legacy BIOS context data
1319 @retval EFI_SUCCESS Legacy16 code loaded
1320 @retval Other No protocol installed, unload driver.
1324 ShadowAndStartLegacy16 (
1325 IN LEGACY_BIOS_INSTANCE
*Private
1329 Checks the state of the floppy and if media is inserted.
1331 This routine checks the state of the floppy and if media is inserted.
1333 No floppy present - Set BBS entry to ignore
1334 Floppy present & no media - Set BBS entry to lowest priority. We cannot
1335 set it to ignore since 16-bit CSM will
1336 indicate no floppy and thus drive A: is
1337 unusable. CSM-16 will not try floppy since
1338 lowest priority and thus not incur boot
1340 Floppy present & media - Set BBS entry to some priority.
1342 @return State of floppy media
1351 Identify drive data must be updated to actual parameters before boot.
1352 This requires updating the checksum, if it exists.
1354 @param IdentifyDriveData ATA Identify Data
1355 @param Checksum checksum of the ATA Identify Data
1357 @retval EFI_SUCCESS checksum calculated
1358 @retval EFI_SECURITY_VIOLATION IdentifyData invalid
1362 CalculateIdentifyDriveChecksum (
1363 IN UINT8
*IdentifyDriveData
,
1368 Identify drive data must be updated to actual parameters before boot.
1370 @param IdentifyDriveData ATA Identify Data
1374 UpdateIdentifyDriveData (
1375 IN UINT8
*IdentifyDriveData
1379 Complete build of BBS TABLE.
1381 @param Private Legacy BIOS Instance data
1382 @param BbsTable BBS Table passed to 16-bit code
1384 @retval EFI_SUCCESS Removable media not present
1388 LegacyBiosBuildBbs (
1389 IN LEGACY_BIOS_INSTANCE
*Private
,
1390 IN BBS_TABLE
*BbsTable
1394 Read CMOS register through index/data port.
1396 @param[in] Index The index of the CMOS register to read.
1398 @return The data value from the CMOS register specified by Index.
1402 LegacyReadStandardCmos (
1407 Write CMOS register through index/data port.
1409 @param[in] Index The index of the CMOS register to write.
1410 @param[in] Value The value of CMOS register to write.
1412 @return The value written to the CMOS register specified by Index.
1416 LegacyWriteStandardCmos (
1422 Calculate the new standard CMOS checksum and write it.
1424 @param Private Legacy BIOS Instance data
1426 @retval EFI_SUCCESS Calculate 16-bit checksum successfully
1430 LegacyCalculateWriteStandardCmosChecksum (
1435 Test to see if a legacy PCI ROM exists for this device. Optionally return
1436 the Legacy ROM instance for this PCI device.
1438 @param[in] This Protocol instance pointer.
1439 @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
1440 @param[out] RomImage Return the legacy PCI ROM for this device
1441 @param[out] RomSize Size of ROM Image
1442 @param[out] RuntimeImageLength Runtime size of ROM Image
1443 @param[out] Flags Indicates if ROM found and if PC-AT.
1444 @param[out] OpromRevision Revision of the PCI Rom
1445 @param[out] ConfigUtilityCodeHeaderPointer of Configuration Utility Code Header
1447 @return EFI_SUCCESS Legacy Option ROM availible for this device
1448 @return EFI_ALREADY_STARTED This device is already managed by its Oprom
1449 @return EFI_UNSUPPORTED Legacy Option ROM not supported.
1453 LegacyBiosCheckPciRomEx (
1454 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1455 IN EFI_HANDLE PciHandle
,
1456 OUT VOID
**RomImage
, OPTIONAL
1457 OUT UINTN
*RomSize
, OPTIONAL
1458 OUT UINTN
*RuntimeImageLength
, OPTIONAL
1459 OUT UINTN
*Flags
, OPTIONAL
1460 OUT UINT8
*OpromRevision
, OPTIONAL
1461 OUT VOID
**ConfigUtilityCodeHeader OPTIONAL
1465 Relocate this image under 4G memory for IPF.
1467 @param ImageHandle Handle of driver image.
1468 @param SystemTable Pointer to system table.
1470 @retval EFI_SUCCESS Image successfully relocated.
1471 @retval EFI_ABORTED Failed to relocate image.
1475 RelocateImageUnder4GIfNeeded (
1476 IN EFI_HANDLE ImageHandle
,
1477 IN EFI_SYSTEM_TABLE
*SystemTable
1481 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
1482 16-bit register context on entry and exit. Arguments can be passed on
1485 @param This Protocol instance pointer.
1486 @param Segment Segemnt of 16-bit mode call
1487 @param Offset Offset of 16-bit mdoe call
1488 @param Regs Register contexted passed into (and returned) from thunk to
1490 @param Stack Caller allocated stack used to pass arguments
1491 @param StackSize Size of Stack in bytes
1493 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
1494 See Regs for status.
1495 @retval TRUE There was a BIOS erro in the target code.
1500 InternalLegacyBiosFarCall (
1501 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1504 IN EFI_IA32_REGISTER_SET
*Regs
,