3 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef _LEGACY_BIOS_INTERFACE_
10 #define _LEGACY_BIOS_INTERFACE_
13 #include <FrameworkDxe.h>
14 #include <IndustryStandard/Pci.h>
15 #include <IndustryStandard/SmBios.h>
16 #include <IndustryStandard/Acpi10.h>
18 #include <Guid/SmBios.h>
19 #include <Guid/Acpi.h>
20 #include <Guid/DxeServices.h>
21 #include <Guid/LegacyBios.h>
22 #include <Guid/StatusCodeDataTypeId.h>
23 #include <Guid/ImageAuthentication.h>
25 #include <Protocol/BlockIo.h>
26 #include <Protocol/LoadedImage.h>
27 #include <Protocol/PciIo.h>
28 #include <Protocol/Cpu.h>
29 #include <Protocol/Timer.h>
30 #include <Protocol/IsaIo.h>
31 #include <Protocol/LegacyRegion2.h>
32 #include <Protocol/SimpleTextIn.h>
33 #include <Protocol/LegacyInterrupt.h>
34 #include <Protocol/LegacyBios.h>
35 #include <Protocol/DiskInfo.h>
36 #include <Protocol/GenericMemoryTest.h>
37 #include <Protocol/LegacyBiosPlatform.h>
38 #include <Protocol/DevicePath.h>
39 #include <Protocol/Legacy8259.h>
40 #include <Protocol/PciRootBridgeIo.h>
41 #include <Protocol/SerialIo.h>
42 #include <Protocol/SuperIo.h>
43 #include <Protocol/IoMmu.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/DebugAgentLib.h>
62 // BUGBUG: This entry maybe changed to PCD in future and wait for
63 // redesign of BDS library
65 #define MAX_BBS_ENTRIES 0x100
69 // (These apply only to errors with the thunk and not to the code that was
73 #define THUNK_ERR_A20_UNSUP 0x01
74 #define THUNK_ERR_A20_FAILED 0x02
77 // Vector base definitions
80 // 8259 Hardware definitions
82 #define LEGACY_MODE_BASE_VECTOR_MASTER 0x08
83 #define LEGACY_MODE_BASE_VECTOR_SLAVE 0x70
86 // The original PC used INT8-F for master PIC. Since these mapped over
87 // processor exceptions TIANO moved the master PIC to INT68-6F.
89 // The vector base for slave PIC is set as 0x70 for PC-AT compatibility.
91 #define PROTECTED_MODE_BASE_VECTOR_MASTER 0x68
92 #define PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70
95 // When we call CSM16 functions, some CSM16 use es:[offset + 0xabcd] to get data passed from CSM32,
96 // offset + 0xabcd could overflow which exceeds 0xFFFF which is invalid in real mode.
97 // So this will keep offset as small as possible to avoid offset overflow in real mode.
99 #define NORMALIZE_EFI_SEGMENT(_Adr) (UINT16) (((UINTN) (_Adr)) >> 4)
100 #define NORMALIZE_EFI_OFFSET(_Adr) (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xf)
106 #define LEGACY_BDA_TRACE 0x000
107 #define LEGACY_BIOS_TRACE 0x040
108 #define LEGACY_BOOT_TRACE 0x080
109 #define LEGACY_CMOS_TRACE 0x0C0
110 #define LEGACY_IDE_TRACE 0x100
111 #define LEGACY_MP_TRACE 0x140
112 #define LEGACY_PCI_TRACE 0x180
113 #define LEGACY_SIO_TRACE 0x1C0
115 #define LEGACY_PCI_TRACE_000 LEGACY_PCI_TRACE + 0x00
116 #define LEGACY_PCI_TRACE_001 LEGACY_PCI_TRACE + 0x01
117 #define LEGACY_PCI_TRACE_002 LEGACY_PCI_TRACE + 0x02
118 #define LEGACY_PCI_TRACE_003 LEGACY_PCI_TRACE + 0x03
119 #define LEGACY_PCI_TRACE_004 LEGACY_PCI_TRACE + 0x04
120 #define LEGACY_PCI_TRACE_005 LEGACY_PCI_TRACE + 0x05
121 #define LEGACY_PCI_TRACE_006 LEGACY_PCI_TRACE + 0x06
122 #define LEGACY_PCI_TRACE_007 LEGACY_PCI_TRACE + 0x07
123 #define LEGACY_PCI_TRACE_008 LEGACY_PCI_TRACE + 0x08
124 #define LEGACY_PCI_TRACE_009 LEGACY_PCI_TRACE + 0x09
125 #define LEGACY_PCI_TRACE_00A LEGACY_PCI_TRACE + 0x0A
126 #define LEGACY_PCI_TRACE_00B LEGACY_PCI_TRACE + 0x0B
127 #define LEGACY_PCI_TRACE_00C LEGACY_PCI_TRACE + 0x0C
128 #define LEGACY_PCI_TRACE_00D LEGACY_PCI_TRACE + 0x0D
129 #define LEGACY_PCI_TRACE_00E LEGACY_PCI_TRACE + 0x0E
130 #define LEGACY_PCI_TRACE_00F LEGACY_PCI_TRACE + 0x0F
132 #define BDA_VIDEO_MODE 0x49
134 #define IDE_PI_REGISTER_PNE BIT0
135 #define IDE_PI_REGISTER_SNE BIT2
142 UINT32 ShadowAddress
;
146 } ROM_INSTANCE_ENTRY
;
149 // Values for RealModeGdt
151 #if defined (MDE_CPU_IA32)
153 #define NUM_REAL_GDT_ENTRIES 3
154 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
155 #define INITIAL_VALUE_BELOW_1K 0x0
157 #elif defined (MDE_CPU_X64)
159 #define NUM_REAL_GDT_ENTRIES 8
160 #define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB
161 #define INITIAL_VALUE_BELOW_1K 0x0
168 // Define what a processor GDT looks like
181 UINT32 DefaultSize
: 1;
182 UINT32 Granularity
: 1;
196 // Define what a processor descriptor looks like
197 // This data structure must be kept in sync with ASM STRUCT in Thunk.inc
212 #define LOW_STACK_SIZE (8 * 1024) // 8k?
213 #define EFI_MAX_E820_ENTRY 100
214 #define FIRST_INSTANCE 1
215 #define NOT_FIRST_INSTANCE 0
217 #if defined (MDE_CPU_IA32)
220 // Space for the code
221 // The address of Code is also the beginning of the relocated Thunk code
223 CHAR8 Code
[4096]; // ?
225 // The address of the Reverse Thunk code
226 // Note that this member CONTAINS the address of the relocated reverse thunk
227 // code unlike the member variable 'Code', which IS the address of the Thunk
230 UINT32 LowReverseThunkStart
;
233 // Data for the code (cs releative)
235 DESCRIPTOR32 GdtDesc
; // Protected mode GDT
236 DESCRIPTOR32 IdtDesc
; // Protected mode IDT
240 UINT32 LowCodeSelector
; // Low code selector in GDT
241 UINT32 LowDataSelector
; // Low data selector in GDT
243 DESCRIPTOR32 RealModeIdtDesc
;
246 // real-mode GDT (temporary GDT with two real mode segment descriptors)
248 GDT32 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
249 DESCRIPTOR32 RealModeGdtDesc
;
252 // Members specifically for the reverse thunk
253 // The RevReal* members are used to store the current state of real mode
254 // before performing the reverse thunk. The RevFlat* members must be set
255 // before calling the reverse thunk assembly code.
260 DESCRIPTOR32 RevRealIdtDesc
;
261 UINT16 RevFlatDataSelector
; // Flat data selector in GDT
265 // A low memory stack
267 CHAR8 Stack
[LOW_STACK_SIZE
];
270 // Stack for flat mode after reverse thunk
271 // @bug - This may no longer be necessary if the reverse thunk interface
272 // is changed to have the flat stack in a different location.
274 CHAR8 RevThunkStack
[LOW_STACK_SIZE
];
277 // Legacy16 Init memory map info
279 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
281 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
283 CHAR8 InterruptRedirectionCode
[32];
284 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
285 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
286 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
289 #elif defined (MDE_CPU_X64)
293 // Space for the code
294 // The address of Code is also the beginning of the relocated Thunk code
296 CHAR8 Code
[4096]; // ?
299 // Data for the code (cs releative)
301 DESCRIPTOR64 X64GdtDesc
; // Protected mode GDT
302 DESCRIPTOR64 X64IdtDesc
; // Protected mode IDT
307 DESCRIPTOR32 RealModeIdtDesc
;
308 DESCRIPTOR32 RealModeGdtDesc
;
311 // real-mode GDT (temporary GDT with two real mode segment descriptors)
313 GDT64 RealModeGdt
[NUM_REAL_GDT_ENTRIES
];
314 UINT64 PageMapLevel4
;
317 // A low memory stack
319 CHAR8 Stack
[LOW_STACK_SIZE
];
322 // Legacy16 Init memory map info
324 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable
;
326 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable
;
328 CHAR8 InterruptRedirectionCode
[32];
329 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler
;
330 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable
;
331 BBS_TABLE BbsTable
[MAX_BBS_ENTRIES
];
337 // PnP Expansion Header
348 UINT16 ProductNamePointer
;
352 UINT8 DeviceIndicators
;
354 UINT16 DisconnectVector
;
357 UINT16 StaticResourceVector
;
358 } LEGACY_PNP_EXPANSION_HEADER
;
374 UINTN ManufacturerString
;
375 UINTN ProductNameString
;
376 } LEGACY_ROM_AND_BBS_TABLE
;
379 // Structure how EFI has mapped a devices HDD drive numbers.
380 // Boot to EFI aware OS or shell requires this mapping when
381 // 16-bit CSM assigns drive numbers.
382 // This mapping is ignored booting to a legacy OS.
389 UINT8 StartDriveNumber
;
390 UINT8 EndDriveNumber
;
391 } LEGACY_EFI_HDD_TABLE
;
394 // This data is passed to Leacy16Boot
397 EfiAcpiAddressRangeMemory
= 1,
398 EfiAcpiAddressRangeReserved
= 2,
399 EfiAcpiAddressRangeACPI
= 3,
400 EfiAcpiAddressRangeNVS
= 4,
401 EfiAddressRangePersistentMemory
= 7
402 } EFI_ACPI_MEMORY_TYPE
;
407 EFI_ACPI_MEMORY_TYPE Type
;
415 EFI_ACPI_MEMORY_TYPE Type
;
420 extern BBS_TABLE
*mBbsTable
;
422 extern EFI_GENERIC_MEMORY_TEST_PROTOCOL
*gGenMemoryTest
;
424 extern BOOLEAN mEndOfDxe
;
429 #define CMOS_0A 0x0a ///< Status register A
430 #define CMOS_0D 0x0d ///< Status register D
431 #define CMOS_0E 0x0e ///< Diagnostic Status
432 #define CMOS_0F 0x0f ///< Shutdown status
433 #define CMOS_10 0x10 ///< Floppy type
434 #define CMOS_12 0x12 ///< IDE type
435 #define CMOS_14 0x14 ///< Same as BDA 40:10
436 #define CMOS_15 0x15 ///< Low byte of base memory in 1k increments
437 #define CMOS_16 0x16 ///< High byte of base memory in 1k increments
438 #define CMOS_17 0x17 ///< Low byte of 1MB+ memory in 1k increments - max 15 MB
439 #define CMOS_18 0x18 ///< High byte of 1MB+ memory in 1k increments - max 15 MB
440 #define CMOS_19 0x19 ///< C: extended drive type
441 #define CMOS_1A 0x1a ///< D: extended drive type
442 #define CMOS_2E 0x2e ///< Most significient byte of standard checksum
443 #define CMOS_2F 0x2f ///< Least significient byte of standard checksum
444 #define CMOS_30 0x30 ///< CMOS 0x17
445 #define CMOS_31 0x31 ///< CMOS 0x18
446 #define CMOS_32 0x32 ///< Century byte
449 // 8254 Timer registers
451 #define TIMER0_COUNT_PORT 0x40
452 #define TIMER1_COUNT_PORT 0x41
453 #define TIMER2_COUNT_PORT 0x42
454 #define TIMER_CONTROL_PORT 0x43
457 // Timer 0, Read/Write LSB then MSB, Square wave output, binary count use.
459 #define TIMER0_CONTROL_WORD 0x36
461 #define LEGACY_BIOS_INSTANCE_SIGNATURE SIGNATURE_32 ('L', 'B', 'I', 'T')
466 EFI_LEGACY_BIOS_PROTOCOL LegacyBios
;
468 EFI_HANDLE ImageHandle
;
471 // CPU Architectural Protocol
473 EFI_CPU_ARCH_PROTOCOL
*Cpu
;
476 // Timer Architectural Protocol
478 EFI_TIMER_ARCH_PROTOCOL
*Timer
;
479 BOOLEAN TimerUses8254
;
482 // Protocol to Lock and Unlock 0xc0000 - 0xfffff
484 EFI_LEGACY_REGION2_PROTOCOL
*LegacyRegion
;
486 EFI_LEGACY_BIOS_PLATFORM_PROTOCOL
*LegacyBiosPlatform
;
489 // Interrupt control for thunk and PCI IRQ
491 EFI_LEGACY_8259_PROTOCOL
*Legacy8259
;
494 // PCI Interrupt PIRQ control
496 EFI_LEGACY_INTERRUPT_PROTOCOL
*LegacyInterrupt
;
499 // Generic Memory Test
501 EFI_GENERIC_MEMORY_TEST_PROTOCOL
*GenericMemoryTest
;
504 // TRUE if PCI Interupt Line registers have been programmed.
506 BOOLEAN PciInterruptLine
;
509 // Code space below 1MB needed by thunker to transition to real mode.
510 // Contains stack and real mode code fragments
512 LOW_MEMORY_THUNK
*IntThunk
;
515 // Starting shadow address of the Legacy BIOS
518 UINT32 LegacyBiosImageSize
;
521 // Start of variables used by CsmItp.mac ITP macro file and/os LegacyBios
526 // $EFI Legacy16 code entry info in memory < 1 MB;
528 EFI_COMPATIBILITY16_TABLE
*Legacy16Table
;
529 VOID
*Legacy16InitPtr
;
530 VOID
*Legacy16BootPtr
;
531 VOID
*InternalIrqRoutingTable
;
532 UINT32 NumberIrqRoutingEntries
;
535 UINT32 NumberHddControllers
;
538 // Cached copy of Legacy16 entry point
540 UINT16 Legacy16CallSegment
;
541 UINT16 Legacy16CallOffset
;
544 // Returned from $EFI and passed in to OPROMS
546 UINT16 PnPInstallationCheckSegment
;
547 UINT16 PnPInstallationCheckOffset
;
552 EFI_E820_ENTRY E820Table
[EFI_MAX_E820_ENTRY
];
553 UINT32 NumberE820Entries
;
556 // True if legacy VGA INT 10h handler installed
558 BOOLEAN VgaInstalled
;
561 // Number of IDE drives
566 // Current Free Option ROM space. An option ROM must NOT go past
572 // Save Legacy16 unexpected interrupt vector. Reprogram INT 68-6F from
573 // EFI values to legacy value just before boot.
575 UINT32 BiosUnexpectedInt
;
576 UINT32 ThunkSavedInt
[8];
578 LEGACY_EFI_HDD_TABLE
*LegacyEfiHddTable
;
579 UINT16 LegacyEfiHddTableIndex
;
586 // Indicate that whether GenericLegacyBoot is entered or not
588 BOOLEAN LegacyBootEntered
;
591 // CSM16 PCI Interface Version
593 UINT16 Csm16PciInterfaceVersion
;
595 } LEGACY_BIOS_INSTANCE
;
608 40:0E-0E Ebda segment
609 40:10-11 MachineConfig
611 40:13-14 MemSize below 1MB
612 40:15-16 Bda15_16 - skip
613 40:17 Keyboard Shift status
614 40:18-19 Bda18_19 - skip
615 40:1A-1B Key buffer head
616 40:1C-1D Key buffer tail
617 40:1E-3D Bda1E_3D- key buffer -skip
618 40:3E-3F FloppyData 3E = Calibration status 3F = Motor status
620 40:41-74 Bda41_74 - skip
621 40:75 Number of HDD drives
622 40:76-77 Bda76_77 - skip
623 40:78-79 78 = Lpt1 timeout, 79 = Lpt2 timeout
624 40:7A-7B 7A = Lpt3 timeout, 7B = Lpt4 timeout
625 40:7C-7D 7C = Com1 timeout, 7D = Com2 timeout
626 40:7E-7F 7E = Com3 timeout, 7F = Com4 timeout
627 40:80-81 Pointer to start of key buffer
628 40:82-83 Pointer to end of key buffer
629 40:84-87 Bda84_87 - skip
630 40:88 HDD Data Xmit rate
632 40:90 Floppy data rate
634 40:96 Keyboard Status
647 UINT16 MachineConfig
;
650 UINT8 Bda15_16
[0x02];
652 UINT8 Bda18_19
[0x02];
655 UINT16 Bda1E_3D
[0x10];
658 UINT8 Bda41_74
[0x34];
659 UINT8 NumberOfDrives
;
660 UINT8 Bda76_77
[0x02];
661 UINT16 Lpt1_2Timeout
;
662 UINT16 Lpt3_4Timeout
;
663 UINT16 Com1_2Timeout
;
664 UINT16 Com3_4Timeout
;
669 UINT8 Bda89_8F
[0x07];
671 UINT8 Bda91_95
[0x05];
672 UINT8 KeyboardStatus
;
677 #define LEGACY_BIOS_INSTANCE_FROM_THIS(this) CR (this, LEGACY_BIOS_INSTANCE, LegacyBios, LEGACY_BIOS_INSTANCE_SIGNATURE)
680 Thunk to 16-bit real mode and execute a software interrupt with a vector
681 of BiosInt. Regs will contain the 16-bit register context on entry and
684 @param This Protocol instance pointer.
685 @param BiosInt Processor interrupt vector to invoke
686 @param Regs Register contexted passed into (and returned) from thunk to
689 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
691 @retval TRUE There was a BIOS erro in the target code.
697 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
699 IN EFI_IA32_REGISTER_SET
*Regs
704 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
705 16-bit register context on entry and exit. Arguments can be passed on
708 @param This Protocol instance pointer.
709 @param Segment Segemnt of 16-bit mode call
710 @param Offset Offset of 16-bit mdoe call
711 @param Regs Register contexted passed into (and returned) from
713 @param Stack Caller allocated stack used to pass arguments
714 @param StackSize Size of Stack in bytes
716 @retval FALSE Thunk completed, and there were no BIOS errors in
717 the target code. See Regs for status.
718 @retval TRUE There was a BIOS erro in the target code.
723 LegacyBiosFarCall86 (
724 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
727 IN EFI_IA32_REGISTER_SET
*Regs
,
734 Test to see if a legacy PCI ROM exists for this device. Optionally return
735 the Legacy ROM instance for this PCI device.
737 @param This Protocol instance pointer.
738 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
740 @param RomImage Return the legacy PCI ROM for this device
741 @param RomSize Size of ROM Image
742 @param Flags Indicates if ROM found and if PC-AT.
744 @retval EFI_SUCCESS Legacy Option ROM available for this device
745 @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
750 LegacyBiosCheckPciRom (
751 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
752 IN EFI_HANDLE PciHandle
,
753 OUT VOID
**RomImage
, OPTIONAL
754 OUT UINTN
*RomSize
, OPTIONAL
760 Assign drive number to legacy HDD drives prior to booting an EFI
761 aware OS so the OS can access drives without an EFI driver.
762 Note: BBS compliant drives ARE NOT available until this call by
765 @param This Protocol instance pointer.
766 @param BbsCount Number of BBS_TABLE structures
767 @param BbsTable List BBS entries
769 @retval EFI_SUCCESS Drive numbers assigned
774 LegacyBiosPrepareToBootEfi (
775 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
776 OUT UINT16
*BbsCount
,
777 OUT BBS_TABLE
**BbsTable
782 To boot from an unconventional device like parties and/or execute
785 @param This Protocol instance pointer.
786 @param Attributes How to interpret the other input parameters
787 @param BbsEntry The 0-based index into the BbsTable for the parent
789 @param BeerData Pointer to the 128 bytes of ram BEER data.
790 @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data.
791 The caller must provide a pointer to the specific
792 Service Area and not the start all Service Areas.
793 EFI_INVALID_PARAMETER if error. Does NOT return if no error.
798 LegacyBiosBootUnconventionalDevice (
799 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
800 IN UDC_ATTRIBUTES Attributes
,
803 IN VOID
*ServiceAreaData
808 Load a legacy PC-AT OPROM on the PciHandle device. Return information
809 about how many disks were added by the OPROM and the shadow address and
810 size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:
812 @param This Protocol instance pointer.
813 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will
814 be loaded. This value is NULL if RomImage is
815 non-NULL. This is the normal case.
816 @param RomImage A PCI PC-AT ROM image. This argument is non-NULL
817 if there is no hardware associated with the ROM
818 and thus no PciHandle, otherwise is must be NULL.
819 Example is PXE base code.
820 @param Flags Indicates if ROM found and if PC-AT.
821 @param DiskStart Disk number of first device hooked by the ROM. If
822 DiskStart is the same as DiskEnd no disked were
824 @param DiskEnd Disk number of the last device hooked by the ROM.
825 @param RomShadowAddress Shadow address of PC-AT ROM
826 @param RomShadowedSize Size of RomShadowAddress in bytes
828 @retval EFI_SUCCESS Legacy ROM loaded for this device
829 @retval EFI_INVALID_PARAMETER PciHandle not found
830 @retval EFI_UNSUPPORTED There is no PCI ROM in the ROM BAR or no onboard
836 LegacyBiosInstallPciRom (
837 IN EFI_LEGACY_BIOS_PROTOCOL
* This
,
838 IN EFI_HANDLE PciHandle
,
841 OUT UINT8
*DiskStart
, OPTIONAL
842 OUT UINT8
*DiskEnd
, OPTIONAL
843 OUT VOID
**RomShadowAddress
, OPTIONAL
844 OUT UINT32
*RomShadowedSize OPTIONAL
849 Fill in the standard BDA for Keyboard LEDs
851 @param This Protocol instance pointer.
852 @param Leds Current LED status
854 @retval EFI_SUCCESS It should always work.
859 LegacyBiosUpdateKeyboardLedStatus (
860 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
868 @param This Protocol instance pointer.
869 @param HddCount Number of HDD_INFO structures
870 @param HddInfo Onboard IDE controller information
871 @param BbsCount Number of BBS_TABLE structures
872 @param BbsTable List BBS entries
874 @retval EFI_SUCCESS Tables returned
875 @retval EFI_NOT_FOUND resource not found
876 @retval EFI_DEVICE_ERROR can not get BBS table
881 LegacyBiosGetBbsInfo (
882 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
883 OUT UINT16
*HddCount
,
884 OUT HDD_INFO
**HddInfo
,
885 OUT UINT16
*BbsCount
,
886 OUT BBS_TABLE
**BbsTable
891 Shadow all legacy16 OPROMs that haven't been shadowed.
892 Warning: Use this with caution. This routine disconnects all EFI
893 drivers. If used externally then caller must re-connect EFI
896 @param This Protocol instance pointer.
898 @retval EFI_SUCCESS OPROMs shadowed
903 LegacyBiosShadowAllLegacyOproms (
904 IN EFI_LEGACY_BIOS_PROTOCOL
*This
909 Attempt to legacy boot the BootOption. If the EFI contexted has been
910 compromised this function will not return.
912 @param This Protocol instance pointer.
913 @param BbsDevicePath EFI Device Path from BootXXXX variable.
914 @param LoadOptionsSize Size of LoadOption in size.
915 @param LoadOptions LoadOption from BootXXXX variable
917 @retval EFI_SUCCESS Removable media not present
922 LegacyBiosLegacyBoot (
923 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
924 IN BBS_BBS_DEVICE_PATH
*BbsDevicePath
,
925 IN UINT32 LoadOptionsSize
,
931 Allocate memory < 1 MB and copy the thunker code into low memory. Se up
934 @param Private Private context for Legacy BIOS
936 @retval EFI_SUCCESS Should only pass.
940 LegacyBiosInitializeThunk (
941 IN LEGACY_BIOS_INSTANCE
*Private
946 Fill in the standard BDA and EBDA stuff before Legacy16 load
948 @param Private Legacy BIOS Instance data
950 @retval EFI_SUCCESS It should always work.
955 IN LEGACY_BIOS_INSTANCE
*Private
960 Collect IDE Inquiry data from the IDE disks
962 @param Private Legacy BIOS Instance data
963 @param HddInfo Hdd Information
964 @param Flag Reconnect IdeController or not
966 @retval EFI_SUCCESS It should always work.
970 LegacyBiosBuildIdeData (
971 IN LEGACY_BIOS_INSTANCE
*Private
,
972 IN HDD_INFO
**HddInfo
,
978 Enable ide controller. This gets disabled when LegacyBoot.c is about
979 to run the Option ROMs.
981 @param Private Legacy BIOS Instance data
986 EnableIdeController (
987 IN LEGACY_BIOS_INSTANCE
*Private
992 If the IDE channel is in compatibility (legacy) mode, remove all
993 PCI I/O BAR addresses from the controller.
995 @param IdeController The handle of target IDE controller
1000 InitLegacyIdeController (
1001 IN EFI_HANDLE IdeController
1006 Program the interrupt routing register in all the PCI devices. On a PC AT system
1007 this register contains the 8259 IRQ vector that matches it's PCI interrupt.
1009 @param Private Legacy BIOS Instance data
1011 @retval EFI_SUCCESS Succeed.
1012 @retval EFI_ALREADY_STARTED All PCI devices have been processed.
1016 PciProgramAllInterruptLineRegisters (
1017 IN LEGACY_BIOS_INSTANCE
*Private
1022 Collect EFI Info about legacy devices.
1024 @param Private Legacy BIOS Instance data
1026 @retval EFI_SUCCESS It should always work.
1030 LegacyBiosBuildSioData (
1031 IN LEGACY_BIOS_INSTANCE
*Private
1036 Shadow all the PCI legacy ROMs. Use data from the Legacy BIOS Protocol
1037 to chose the order. Skip any devices that have already have legacy
1040 @param Private Protocol instance pointer.
1042 @retval EFI_SUCCESS Succeed.
1043 @retval EFI_UNSUPPORTED Cannot get VGA device handle.
1048 IN LEGACY_BIOS_INSTANCE
*Private
1053 Fill in the standard BDA and EBDA stuff prior to legacy Boot
1055 @param Private Legacy BIOS Instance data
1057 @retval EFI_SUCCESS It should always work.
1061 LegacyBiosCompleteBdaBeforeBoot (
1062 IN LEGACY_BIOS_INSTANCE
*Private
1067 Fill in the standard CMOS stuff before Legacy16 load
1069 @param Private Legacy BIOS Instance data
1071 @retval EFI_SUCCESS It should always work.
1075 LegacyBiosInitCmos (
1076 IN LEGACY_BIOS_INSTANCE
*Private
1081 Fill in the standard CMOS stuff prior to legacy Boot
1083 @param Private Legacy BIOS Instance data
1085 @retval EFI_SUCCESS It should always work.
1089 LegacyBiosCompleteStandardCmosBeforeBoot (
1090 IN LEGACY_BIOS_INSTANCE
*Private
1095 Contains the code that is copied into low memory (below 640K).
1096 This code reflects interrupts 0x68-0x6f to interrupts 0x08-0x0f.
1097 This template must be copied into low memory, and the IDT entries
1098 0x68-0x6F must be point to the low memory copy of this code. Each
1099 entry is 4 bytes long, so IDT entries 0x68-0x6F can be easily
1104 InterruptRedirectionTemplate (
1110 Build the E820 table.
1112 @param Private Legacy BIOS Instance data
1113 @param Size Size of E820 Table
1115 @retval EFI_SUCCESS It should always work.
1119 LegacyBiosBuildE820 (
1120 IN LEGACY_BIOS_INSTANCE
*Private
,
1125 This function is to put all AP in halt state.
1127 @param Private Legacy BIOS Instance data
1132 IN LEGACY_BIOS_INSTANCE
*Private
1136 Worker function for LegacyBiosGetFlatDescs, retrieving content of
1139 @param IntThunk Pointer to IntThunk of Legacy BIOS context.
1144 LOW_MEMORY_THUNK
*IntThunk
1148 Routine for calling real thunk code.
1150 @param RealCode The address of thunk code.
1151 @param BiosInt The Bios interrupt vector number.
1152 @param CallAddress The address of 16-bit mode call.
1154 @return Status returned by real thunk code
1165 Routine for generating soft interrupt.
1167 @param Vector The interrupt vector number.
1176 Allocate memory for legacy usage.
1178 @param AllocateType The type of allocation to perform.
1179 @param MemoryType The type of memory to allocate.
1180 @param StartPageAddress Start address of range
1181 @param Pages Number of pages to allocate
1182 @param Result Result of allocation
1184 @retval EFI_SUCCESS Legacy16 code loaded
1185 @retval Other No protocol installed, unload driver.
1189 AllocateLegacyMemory (
1190 IN EFI_ALLOCATE_TYPE AllocateType
,
1191 IN EFI_MEMORY_TYPE MemoryType
,
1192 IN EFI_PHYSICAL_ADDRESS StartPageAddress
,
1194 OUT EFI_PHYSICAL_ADDRESS
*Result
1198 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1200 @param This Protocol instance pointer.
1201 @param LegacyMemorySize Size of required region
1202 @param Region Region to use. 00 = Either 0xE0000 or 0xF0000
1203 block Bit0 = 1 0xF0000 block Bit1 = 1 0xE0000
1205 @param Alignment Address alignment. Bit mapped. First non-zero
1206 bit from right is alignment.
1207 @param LegacyMemoryAddress Region Assigned
1209 @retval EFI_SUCCESS Region assigned
1210 @retval EFI_ACCESS_DENIED Procedure previously invoked
1211 @retval Other Region not assigned
1216 LegacyBiosGetLegacyRegion (
1217 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1218 IN UINTN LegacyMemorySize
,
1221 OUT VOID
**LegacyMemoryAddress
1225 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
1227 @param This Protocol instance pointer.
1228 @param LegacyMemorySize Size of data to copy
1229 @param LegacyMemoryAddress Legacy Region destination address Note: must
1230 be in region assigned by
1231 LegacyBiosGetLegacyRegion
1232 @param LegacyMemorySourceAddress Source of data
1234 @retval EFI_SUCCESS Region assigned
1235 @retval EFI_ACCESS_DENIED Destination outside assigned region
1240 LegacyBiosCopyLegacyRegion (
1241 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1242 IN UINTN LegacyMemorySize
,
1243 IN VOID
*LegacyMemoryAddress
,
1244 IN VOID
*LegacyMemorySourceAddress
1248 Find Legacy16 BIOS image in the FLASH device and shadow it into memory. Find
1249 the $EFI table in the shadow area. Thunk into the Legacy16 code after it had
1252 @param Private Legacy BIOS context data
1254 @retval EFI_SUCCESS Legacy16 code loaded
1255 @retval Other No protocol installed, unload driver.
1259 ShadowAndStartLegacy16 (
1260 IN LEGACY_BIOS_INSTANCE
*Private
1264 Checks the state of the floppy and if media is inserted.
1266 This routine checks the state of the floppy and if media is inserted.
1268 No floppy present - Set BBS entry to ignore
1269 Floppy present & no media - Set BBS entry to lowest priority. We cannot
1270 set it to ignore since 16-bit CSM will
1271 indicate no floppy and thus drive A: is
1272 unusable. CSM-16 will not try floppy since
1273 lowest priority and thus not incur boot
1275 Floppy present & media - Set BBS entry to some priority.
1277 @return State of floppy media
1286 Identify drive data must be updated to actual parameters before boot.
1287 This requires updating the checksum, if it exists.
1289 @param IdentifyDriveData ATA Identify Data
1290 @param Checksum checksum of the ATA Identify Data
1292 @retval EFI_SUCCESS checksum calculated
1293 @retval EFI_SECURITY_VIOLATION IdentifyData invalid
1297 CalculateIdentifyDriveChecksum (
1298 IN UINT8
*IdentifyDriveData
,
1303 Identify drive data must be updated to actual parameters before boot.
1305 @param IdentifyDriveData ATA Identify Data
1309 UpdateIdentifyDriveData (
1310 IN UINT8
*IdentifyDriveData
1314 Complete build of BBS TABLE.
1316 @param Private Legacy BIOS Instance data
1317 @param BbsTable BBS Table passed to 16-bit code
1319 @retval EFI_SUCCESS Removable media not present
1323 LegacyBiosBuildBbs (
1324 IN LEGACY_BIOS_INSTANCE
*Private
,
1325 IN BBS_TABLE
*BbsTable
1329 Read CMOS register through index/data port.
1331 @param[in] Index The index of the CMOS register to read.
1333 @return The data value from the CMOS register specified by Index.
1337 LegacyReadStandardCmos (
1342 Write CMOS register through index/data port.
1344 @param[in] Index The index of the CMOS register to write.
1345 @param[in] Value The value of CMOS register to write.
1347 @return The value written to the CMOS register specified by Index.
1351 LegacyWriteStandardCmos (
1357 Calculate the new standard CMOS checksum and write it.
1359 @param Private Legacy BIOS Instance data
1361 @retval EFI_SUCCESS Calculate 16-bit checksum successfully
1365 LegacyCalculateWriteStandardCmosChecksum (
1370 Test to see if a legacy PCI ROM exists for this device. Optionally return
1371 the Legacy ROM instance for this PCI device.
1373 @param[in] This Protocol instance pointer.
1374 @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
1375 @param[out] RomImage Return the legacy PCI ROM for this device
1376 @param[out] RomSize Size of ROM Image
1377 @param[out] RuntimeImageLength Runtime size of ROM Image
1378 @param[out] Flags Indicates if ROM found and if PC-AT.
1379 @param[out] OpromRevision Revision of the PCI Rom
1380 @param[out] ConfigUtilityCodeHeaderPointer of Configuration Utility Code Header
1382 @return EFI_SUCCESS Legacy Option ROM available for this device
1383 @return EFI_ALREADY_STARTED This device is already managed by its Oprom
1384 @return EFI_UNSUPPORTED Legacy Option ROM not supported.
1388 LegacyBiosCheckPciRomEx (
1389 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1390 IN EFI_HANDLE PciHandle
,
1391 OUT VOID
**RomImage
, OPTIONAL
1392 OUT UINTN
*RomSize
, OPTIONAL
1393 OUT UINTN
*RuntimeImageLength
, OPTIONAL
1394 OUT UINTN
*Flags
, OPTIONAL
1395 OUT UINT8
*OpromRevision
, OPTIONAL
1396 OUT VOID
**ConfigUtilityCodeHeader OPTIONAL
1400 Relocate this image under 4G memory for IPF.
1402 @param ImageHandle Handle of driver image.
1403 @param SystemTable Pointer to system table.
1405 @retval EFI_SUCCESS Image successfully relocated.
1406 @retval EFI_ABORTED Failed to relocate image.
1410 RelocateImageUnder4GIfNeeded (
1411 IN EFI_HANDLE ImageHandle
,
1412 IN EFI_SYSTEM_TABLE
*SystemTable
1416 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
1417 16-bit register context on entry and exit. Arguments can be passed on
1420 @param This Protocol instance pointer.
1421 @param Segment Segemnt of 16-bit mode call
1422 @param Offset Offset of 16-bit mdoe call
1423 @param Regs Register contexted passed into (and returned) from thunk to
1425 @param Stack Caller allocated stack used to pass arguments
1426 @param StackSize Size of Stack in bytes
1428 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
1429 See Regs for status.
1430 @retval TRUE There was a BIOS erro in the target code.
1435 InternalLegacyBiosFarCall (
1436 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
1439 IN EFI_IA32_REGISTER_SET
*Regs
,
1445 Load a legacy PC-AT OpROM for VGA controller.
1447 @param Private Driver private data.
1449 @retval EFI_SUCCESS Legacy ROM successfully installed for this device.
1450 @retval EFI_DEVICE_ERROR No VGA device handle found, or native EFI video
1451 driver cannot be successfully disconnected, or VGA
1452 thunk driver cannot be successfully connected.
1456 LegacyBiosInstallVgaRom (
1457 IN LEGACY_BIOS_INSTANCE
*Private