]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
IntelFsp2WrapperPkg: Support FSP Dispatch mode
[mirror_edk2.git] / IntelFrameworkModulePkg / Csm / LegacyBiosDxe / LegacyBiosInterface.h
CommitLineData
bcecde14 1/** @file\r
2\r
b22a62be 3Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
bcecde14 4\r
5This program and the accompanying materials\r
6are licensed and made available under the terms and conditions\r
7of the BSD License which accompanies this distribution. The\r
8full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef _LEGACY_BIOS_INTERFACE_\r
17#define _LEGACY_BIOS_INTERFACE_\r
18\r
19\r
20#include <FrameworkDxe.h>\r
d316f1dc 21#include <IndustryStandard/Pci.h>\r
b6823730 22#include <IndustryStandard/SmBios.h>\r
62ade6d2 23#include <IndustryStandard/Acpi10.h>\r
bcecde14 24\r
25#include <Guid/SmBios.h>\r
26#include <Guid/Acpi.h>\r
27#include <Guid/DxeServices.h>\r
28#include <Guid/LegacyBios.h>\r
29#include <Guid/StatusCodeDataTypeId.h>\r
0f8b0298 30#include <Guid/ImageAuthentication.h>\r
bcecde14 31\r
32#include <Protocol/BlockIo.h>\r
33#include <Protocol/LoadedImage.h>\r
34#include <Protocol/PciIo.h>\r
35#include <Protocol/Cpu.h>\r
f767f990 36#include <Protocol/Timer.h>\r
bcecde14 37#include <Protocol/IsaIo.h>\r
38#include <Protocol/LegacyRegion2.h>\r
39#include <Protocol/SimpleTextIn.h>\r
40#include <Protocol/LegacyInterrupt.h>\r
41#include <Protocol/LegacyBios.h>\r
42#include <Protocol/DiskInfo.h>\r
43#include <Protocol/GenericMemoryTest.h>\r
44#include <Protocol/LegacyBiosPlatform.h>\r
45#include <Protocol/DevicePath.h>\r
46#include <Protocol/Legacy8259.h>\r
47#include <Protocol/PciRootBridgeIo.h>\r
faef6952 48#include <Protocol/SerialIo.h>\r
62ade6d2 49#include <Protocol/SuperIo.h>\r
60794ee6 50#include <Protocol/IoMmu.h>\r
bcecde14 51\r
52#include <Library/BaseLib.h>\r
53#include <Library/DebugLib.h>\r
54#include <Library/UefiLib.h>\r
55#include <Library/BaseMemoryLib.h>\r
56#include <Library/ReportStatusCodeLib.h>\r
57#include <Library/UefiRuntimeServicesTableLib.h>\r
58#include <Library/HobLib.h>\r
59#include <Library/UefiDriverEntryPoint.h>\r
60#include <Library/MemoryAllocationLib.h>\r
61#include <Library/UefiBootServicesTableLib.h>\r
62#include <Library/IoLib.h>\r
63#include <Library/PcdLib.h>\r
64#include <Library/DevicePathLib.h>\r
65#include <Library/DxeServicesTableLib.h>\r
bcecde14 66#include <Library/DebugAgentLib.h>\r
67\r
68//\r
bcecde14 69// BUGBUG: This entry maybe changed to PCD in future and wait for\r
70// redesign of BDS library\r
71//\r
72#define MAX_BBS_ENTRIES 0x100\r
73\r
74//\r
75// Thunk Status Codes\r
76// (These apply only to errors with the thunk and not to the code that was\r
77// thunked to.)\r
78//\r
79#define THUNK_OK 0x00\r
80#define THUNK_ERR_A20_UNSUP 0x01\r
81#define THUNK_ERR_A20_FAILED 0x02\r
82\r
83//\r
84// Vector base definitions\r
85//\r
86//\r
87// 8259 Hardware definitions\r
88//\r
89#define LEGACY_MODE_BASE_VECTOR_MASTER 0x08\r
90#define LEGACY_MODE_BASE_VECTOR_SLAVE 0x70\r
91\r
92//\r
93// The original PC used INT8-F for master PIC. Since these mapped over\r
94// processor exceptions TIANO moved the master PIC to INT68-6F.\r
95//\r
96// The vector base for slave PIC is set as 0x70 for PC-AT compatibility.\r
97//\r
98#define PROTECTED_MODE_BASE_VECTOR_MASTER 0x68\r
99#define PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70\r
100\r
81c0d6e9 101//\r
0a6f4824
LG		 102// When we call CSM16 functions, some CSM16 use es:[offset + 0xabcd] to get data passed from CSM32,\r
103// offset + 0xabcd could overflow which exceeds 0xFFFF which is invalid in real mode.\r
104// So this will keep offset as small as possible to avoid offset overflow in real mode.\r
81c0d6e9 105//\r
106#define NORMALIZE_EFI_SEGMENT(_Adr) (UINT16) (((UINTN) (_Adr)) >> 4)\r
107#define NORMALIZE_EFI_OFFSET(_Adr) (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xf)\r
108\r
bcecde14 109//\r
110// Trace defines\r
111//\r
112//\r
113#define LEGACY_BDA_TRACE 0x000\r
114#define LEGACY_BIOS_TRACE 0x040\r
115#define LEGACY_BOOT_TRACE 0x080\r
116#define LEGACY_CMOS_TRACE 0x0C0\r
117#define LEGACY_IDE_TRACE 0x100\r
118#define LEGACY_MP_TRACE 0x140\r
119#define LEGACY_PCI_TRACE 0x180\r
120#define LEGACY_SIO_TRACE 0x1C0\r
121\r
122#define LEGACY_PCI_TRACE_000 LEGACY_PCI_TRACE + 0x00\r
123#define LEGACY_PCI_TRACE_001 LEGACY_PCI_TRACE + 0x01\r
124#define LEGACY_PCI_TRACE_002 LEGACY_PCI_TRACE + 0x02\r
125#define LEGACY_PCI_TRACE_003 LEGACY_PCI_TRACE + 0x03\r
126#define LEGACY_PCI_TRACE_004 LEGACY_PCI_TRACE + 0x04\r
127#define LEGACY_PCI_TRACE_005 LEGACY_PCI_TRACE + 0x05\r
128#define LEGACY_PCI_TRACE_006 LEGACY_PCI_TRACE + 0x06\r
129#define LEGACY_PCI_TRACE_007 LEGACY_PCI_TRACE + 0x07\r
130#define LEGACY_PCI_TRACE_008 LEGACY_PCI_TRACE + 0x08\r
131#define LEGACY_PCI_TRACE_009 LEGACY_PCI_TRACE + 0x09\r
132#define LEGACY_PCI_TRACE_00A LEGACY_PCI_TRACE + 0x0A\r
133#define LEGACY_PCI_TRACE_00B LEGACY_PCI_TRACE + 0x0B\r
134#define LEGACY_PCI_TRACE_00C LEGACY_PCI_TRACE + 0x0C\r
135#define LEGACY_PCI_TRACE_00D LEGACY_PCI_TRACE + 0x0D\r
136#define LEGACY_PCI_TRACE_00E LEGACY_PCI_TRACE + 0x0E\r
137#define LEGACY_PCI_TRACE_00F LEGACY_PCI_TRACE + 0x0F\r
138\r
edf4af6f 139#define BDA_VIDEO_MODE 0x49\r
bcecde14 140\r
6d55565d 141#define IDE_PI_REGISTER_PNE BIT0\r
142#define IDE_PI_REGISTER_SNE BIT2\r
143\r
bcecde14 144typedef struct {\r
145 UINTN PciSegment;\r
146 UINTN PciBus;\r
147 UINTN PciDevice;\r
148 UINTN PciFunction;\r
149 UINT32 ShadowAddress;\r
150 UINT32 ShadowedSize;\r
151 UINT8 DiskStart;\r
152 UINT8 DiskEnd;\r
153} ROM_INSTANCE_ENTRY;\r
154\r
155//\r
156// Values for RealModeGdt\r
157//\r
158#if defined (MDE_CPU_IA32)\r
159\r
160#define NUM_REAL_GDT_ENTRIES 3\r
161#define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB\r
162#define INITIAL_VALUE_BELOW_1K 0x0\r
163\r
164#elif defined (MDE_CPU_X64)\r
165\r
166#define NUM_REAL_GDT_ENTRIES 8\r
167#define CONVENTIONAL_MEMORY_TOP 0xA0000 // 640 KB\r
168#define INITIAL_VALUE_BELOW_1K 0x0\r
169\r
bcecde14 170#endif\r
171\r
bcecde14 172#pragma pack(1)\r
173\r
174//\r
175// Define what a processor GDT looks like\r
176//\r
177typedef struct {\r
178 UINT32 LimitLo : 16;\r
179 UINT32 BaseLo : 16;\r
180 UINT32 BaseMid : 8;\r
181 UINT32 Type : 4;\r
182 UINT32 System : 1;\r
183 UINT32 Dpl : 2;\r
184 UINT32 Present : 1;\r
185 UINT32 LimitHi : 4;\r
186 UINT32 Software : 1;\r
187 UINT32 Reserved : 1;\r
188 UINT32 DefaultSize : 1;\r
189 UINT32 Granularity : 1;\r
190 UINT32 BaseHi : 8;\r
191} GDT32;\r
192\r
193typedef struct {\r
194 UINT16 LimitLow;\r
195 UINT16 BaseLow;\r
196 UINT8 BaseMid;\r
197 UINT8 Attribute;\r
198 UINT8 LimitHi;\r
199 UINT8 BaseHi;\r
200} GDT64;\r
201\r
202//\r
203// Define what a processor descriptor looks like\r
204// This data structure must be kept in sync with ASM STRUCT in Thunk.inc\r
205//\r
206typedef struct {\r
207 UINT16 Limit;\r
208 UINT64 Base;\r
209} DESCRIPTOR64;\r
210\r
211typedef struct {\r
212 UINT16 Limit;\r
213 UINT32 Base;\r
214} DESCRIPTOR32;\r
215\r
216//\r
217// Low stub lay out\r
218//\r
219#define LOW_STACK_SIZE (8 * 1024) // 8k?\r
220#define EFI_MAX_E820_ENTRY 100\r
221#define FIRST_INSTANCE 1\r
222#define NOT_FIRST_INSTANCE 0\r
223\r
224#if defined (MDE_CPU_IA32)\r
225typedef struct {\r
226 //\r
227 // Space for the code\r
228 // The address of Code is also the beginning of the relocated Thunk code\r
229 //\r
230 CHAR8 Code[4096]; // ?\r
231 //\r
232 // The address of the Reverse Thunk code\r
233 // Note that this member CONTAINS the address of the relocated reverse thunk\r
234 // code unlike the member variable 'Code', which IS the address of the Thunk\r
235 // code.\r
236 //\r
237 UINT32 LowReverseThunkStart;\r
238\r
239 //\r
240 // Data for the code (cs releative)\r
241 //\r
242 DESCRIPTOR32 GdtDesc; // Protected mode GDT\r
243 DESCRIPTOR32 IdtDesc; // Protected mode IDT\r
244 UINT32 FlatSs;\r
245 UINT32 FlatEsp;\r
246\r
247 UINT32 LowCodeSelector; // Low code selector in GDT\r
248 UINT32 LowDataSelector; // Low data selector in GDT\r
249 UINT32 LowStack;\r
250 DESCRIPTOR32 RealModeIdtDesc;\r
251\r
252 //\r
253 // real-mode GDT (temporary GDT with two real mode segment descriptors)\r
254 //\r
255 GDT32 RealModeGdt[NUM_REAL_GDT_ENTRIES];\r
256 DESCRIPTOR32 RealModeGdtDesc;\r
257\r
258 //\r
259 // Members specifically for the reverse thunk\r
260 // The RevReal* members are used to store the current state of real mode\r
261 // before performing the reverse thunk. The RevFlat* members must be set\r
262 // before calling the reverse thunk assembly code.\r
263 //\r
264 UINT16 RevRealDs;\r
265 UINT16 RevRealSs;\r
266 UINT32 RevRealEsp;\r
267 DESCRIPTOR32 RevRealIdtDesc;\r
268 UINT16 RevFlatDataSelector; // Flat data selector in GDT\r
269 UINT32 RevFlatStack;\r
270\r
271 //\r
272 // A low memory stack\r
273 //\r
274 CHAR8 Stack[LOW_STACK_SIZE];\r
275\r
276 //\r
277 // Stack for flat mode after reverse thunk\r
278 // @bug - This may no longer be necessary if the reverse thunk interface\r
279 // is changed to have the flat stack in a different location.\r
280 //\r
281 CHAR8 RevThunkStack[LOW_STACK_SIZE];\r
282\r
283 //\r
284 // Legacy16 Init memory map info\r
285 //\r
286 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable;\r
287\r
288 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable;\r
289\r
290 CHAR8 InterruptRedirectionCode[32];\r
291 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler;\r
292 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable;\r
293 BBS_TABLE BbsTable[MAX_BBS_ENTRIES];\r
294} LOW_MEMORY_THUNK;\r
295\r
296#elif defined (MDE_CPU_X64)\r
297\r
298typedef struct {\r
299 //\r
300 // Space for the code\r
301 // The address of Code is also the beginning of the relocated Thunk code\r
302 //\r
303 CHAR8 Code[4096]; // ?\r
304\r
305 //\r
306 // Data for the code (cs releative)\r
307 //\r
308 DESCRIPTOR64 X64GdtDesc; // Protected mode GDT\r
309 DESCRIPTOR64 X64IdtDesc; // Protected mode IDT\r
310 UINTN X64Ss;\r
311 UINTN X64Esp;\r
312\r
313 UINTN RealStack;\r
314 DESCRIPTOR32 RealModeIdtDesc;\r
315 DESCRIPTOR32 RealModeGdtDesc;\r
316\r
317 //\r
318 // real-mode GDT (temporary GDT with two real mode segment descriptors)\r
319 //\r
320 GDT64 RealModeGdt[NUM_REAL_GDT_ENTRIES];\r
321 UINT64 PageMapLevel4;\r
322\r
323 //\r
324 // A low memory stack\r
325 //\r
326 CHAR8 Stack[LOW_STACK_SIZE];\r
327\r
328 //\r
329 // Legacy16 Init memory map info\r
330 //\r
331 EFI_TO_COMPATIBILITY16_INIT_TABLE EfiToLegacy16InitTable;\r
bcecde14 332\r
333 EFI_TO_COMPATIBILITY16_BOOT_TABLE EfiToLegacy16BootTable;\r
334\r
335 CHAR8 InterruptRedirectionCode[32];\r
336 EFI_LEGACY_INSTALL_PCI_HANDLER PciHandler;\r
337 EFI_DISPATCH_OPROM_TABLE DispatchOpromTable;\r
338 BBS_TABLE BbsTable[MAX_BBS_ENTRIES];\r
339} LOW_MEMORY_THUNK;\r
340\r
341#endif\r
342\r
343//\r
344// PnP Expansion Header\r
345//\r
346typedef struct {\r
347 UINT32 PnpSignature;\r
348 UINT8 Revision;\r
349 UINT8 Length;\r
350 UINT16 NextHeader;\r
351 UINT8 Reserved1;\r
352 UINT8 Checksum;\r
353 UINT32 DeviceId;\r
354 UINT16 MfgPointer;\r
355 UINT16 ProductNamePointer;\r
356 UINT8 Class;\r
357 UINT8 SubClass;\r
358 UINT8 Interface;\r
359 UINT8 DeviceIndicators;\r
360 UINT16 Bcv;\r
361 UINT16 DisconnectVector;\r
362 UINT16 Bev;\r
363 UINT16 Reserved2;\r
364 UINT16 StaticResourceVector;\r
365} LEGACY_PNP_EXPANSION_HEADER;\r
366\r
367typedef struct {\r
368 UINT8 PciSegment;\r
369 UINT8 PciBus;\r
370 UINT8 PciDevice;\r
371 UINT8 PciFunction;\r
372 UINT16 Vid;\r
373 UINT16 Did;\r
374 UINT16 SysSid;\r
375 UINT16 SVid;\r
376 UINT8 Class;\r
377 UINT8 SubClass;\r
378 UINT8 Interface;\r
379 UINT8 Reserved;\r
380 UINTN RomStart;\r
381 UINTN ManufacturerString;\r
382 UINTN ProductNameString;\r
383} LEGACY_ROM_AND_BBS_TABLE;\r
384\r
385//\r
386// Structure how EFI has mapped a devices HDD drive numbers.\r
387// Boot to EFI aware OS or shell requires this mapping when\r
388// 16-bit CSM assigns drive numbers.\r
389// This mapping is ignored booting to a legacy OS.\r
390//\r
391typedef struct {\r
392 UINT8 PciSegment;\r
393 UINT8 PciBus;\r
394 UINT8 PciDevice;\r
395 UINT8 PciFunction;\r
396 UINT8 StartDriveNumber;\r
397 UINT8 EndDriveNumber;\r
398} LEGACY_EFI_HDD_TABLE;\r
399\r
400//\r
401// This data is passed to Leacy16Boot\r
402//\r
403typedef enum {\r
404 EfiAcpiAddressRangeMemory = 1,\r
405 EfiAcpiAddressRangeReserved = 2,\r
406 EfiAcpiAddressRangeACPI = 3,\r
b483e74d
LG		 407 EfiAcpiAddressRangeNVS = 4,\r
408 EfiAddressRangePersistentMemory = 7\r
bcecde14 409} EFI_ACPI_MEMORY_TYPE;\r
410\r
411typedef struct {\r
412 UINT64 BaseAddr;\r
413 UINT64 Length;\r
414 EFI_ACPI_MEMORY_TYPE Type;\r
415} EFI_E820_ENTRY64;\r
416\r
417typedef struct {\r
418 UINT32 BassAddrLow;\r
419 UINT32 BaseAddrHigh;\r
420 UINT32 LengthLow;\r
421 UINT32 LengthHigh;\r
422 EFI_ACPI_MEMORY_TYPE Type;\r
423} EFI_E820_ENTRY;\r
424\r
425#pragma pack()\r
426\r
427extern BBS_TABLE *mBbsTable;\r
428\r
429extern EFI_GENERIC_MEMORY_TEST_PROTOCOL *gGenMemoryTest;\r
430\r
d057d8c4
JW		 431extern BOOLEAN mEndOfDxe;\r
432\r
bcecde14 433#define PORT_70 0x70\r
434#define PORT_71 0x71\r
435\r
436#define CMOS_0A 0x0a ///< Status register A\r
437#define CMOS_0D 0x0d ///< Status register D\r
438#define CMOS_0E 0x0e ///< Diagnostic Status\r
439#define CMOS_0F 0x0f ///< Shutdown status\r
440#define CMOS_10 0x10 ///< Floppy type\r
441#define CMOS_12 0x12 ///< IDE type\r
442#define CMOS_14 0x14 ///< Same as BDA 40:10\r
443#define CMOS_15 0x15 ///< Low byte of base memory in 1k increments\r
444#define CMOS_16 0x16 ///< High byte of base memory in 1k increments\r
445#define CMOS_17 0x17 ///< Low byte of 1MB+ memory in 1k increments - max 15 MB\r
446#define CMOS_18 0x18 ///< High byte of 1MB+ memory in 1k increments - max 15 MB\r
447#define CMOS_19 0x19 ///< C: extended drive type\r
448#define CMOS_1A 0x1a ///< D: extended drive type\r
449#define CMOS_2E 0x2e ///< Most significient byte of standard checksum\r
450#define CMOS_2F 0x2f ///< Least significient byte of standard checksum\r
451#define CMOS_30 0x30 ///< CMOS 0x17\r
452#define CMOS_31 0x31 ///< CMOS 0x18\r
453#define CMOS_32 0x32 ///< Century byte\r
454\r
f767f990 455//\r
456// 8254 Timer registers\r
457//\r
458#define TIMER0_COUNT_PORT 0x40\r
459#define TIMER1_COUNT_PORT 0x41\r
460#define TIMER2_COUNT_PORT 0x42\r
461#define TIMER_CONTROL_PORT 0x43\r
462\r
463//\r
464// Timer 0, Read/Write LSB then MSB, Square wave output, binary count use.\r
465//\r
0a6f4824 466#define TIMER0_CONTROL_WORD 0x36\r
bcecde14 467\r
468#define LEGACY_BIOS_INSTANCE_SIGNATURE SIGNATURE_32 ('L', 'B', 'I', 'T')\r
469typedef struct {\r
470 UINTN Signature;\r
471\r
472 EFI_HANDLE Handle;\r
473 EFI_LEGACY_BIOS_PROTOCOL LegacyBios;\r
474\r
475 EFI_HANDLE ImageHandle;\r
476\r
477 //\r
0a6f4824 478 // CPU Architectural Protocol\r
bcecde14 479 //\r
480 EFI_CPU_ARCH_PROTOCOL *Cpu;\r
481\r
f767f990 482 //\r
0a6f4824 483 // Timer Architectural Protocol\r
f767f990 484 //\r
485 EFI_TIMER_ARCH_PROTOCOL *Timer;\r
0a6f4824
LG		 486 BOOLEAN TimerUses8254;\r
487\r
bcecde14 488 //\r
489 // Protocol to Lock and Unlock 0xc0000 - 0xfffff\r
490 //\r
491 EFI_LEGACY_REGION2_PROTOCOL *LegacyRegion;\r
492\r
493 EFI_LEGACY_BIOS_PLATFORM_PROTOCOL *LegacyBiosPlatform;\r
494\r
495 //\r
496 // Interrupt control for thunk and PCI IRQ\r
497 //\r
498 EFI_LEGACY_8259_PROTOCOL *Legacy8259;\r
0a6f4824 499\r
bcecde14 500 //\r
501 // PCI Interrupt PIRQ control\r
502 //\r
503 EFI_LEGACY_INTERRUPT_PROTOCOL *LegacyInterrupt;\r
504\r
505 //\r
506 // Generic Memory Test\r
507 //\r
508 EFI_GENERIC_MEMORY_TEST_PROTOCOL *GenericMemoryTest;\r
509\r
510 //\r
511 // TRUE if PCI Interupt Line registers have been programmed.\r
512 //\r
513 BOOLEAN PciInterruptLine;\r
514\r
515 //\r
516 // Code space below 1MB needed by thunker to transition to real mode.\r
517 // Contains stack and real mode code fragments\r
518 //\r
519 LOW_MEMORY_THUNK *IntThunk;\r
520\r
521 //\r
522 // Starting shadow address of the Legacy BIOS\r
523 //\r
524 UINT32 BiosStart;\r
525 UINT32 LegacyBiosImageSize;\r
526\r
527 //\r
528 // Start of variables used by CsmItp.mac ITP macro file and/os LegacyBios\r
529 //\r
530 UINT8 Dump[4];\r
531\r
532 //\r
533 // $EFI Legacy16 code entry info in memory < 1 MB;\r
534 //\r
535 EFI_COMPATIBILITY16_TABLE *Legacy16Table;\r
536 VOID *Legacy16InitPtr;\r
537 VOID *Legacy16BootPtr;\r
538 VOID *InternalIrqRoutingTable;\r
539 UINT32 NumberIrqRoutingEntries;\r
540 VOID *BbsTablePtr;\r
541 VOID *HddTablePtr;\r
542 UINT32 NumberHddControllers;\r
543\r
544 //\r
545 // Cached copy of Legacy16 entry point\r
546 //\r
547 UINT16 Legacy16CallSegment;\r
548 UINT16 Legacy16CallOffset;\r
549\r
550 //\r
551 // Returned from $EFI and passed in to OPROMS\r
552 //\r
553 UINT16 PnPInstallationCheckSegment;\r
554 UINT16 PnPInstallationCheckOffset;\r
555\r
556 //\r
557 // E820 table\r
558 //\r
559 EFI_E820_ENTRY E820Table[EFI_MAX_E820_ENTRY];\r
560 UINT32 NumberE820Entries;\r
561\r
562 //\r
563 // True if legacy VGA INT 10h handler installed\r
564 //\r
565 BOOLEAN VgaInstalled;\r
566\r
567 //\r
568 // Number of IDE drives\r
569 //\r
570 UINT8 IdeDriveCount;\r
571\r
572 //\r
573 // Current Free Option ROM space. An option ROM must NOT go past\r
574 // BiosStart.\r
575 //\r
576 UINT32 OptionRom;\r
577\r
578 //\r
579 // Save Legacy16 unexpected interrupt vector. Reprogram INT 68-6F from\r
580 // EFI values to legacy value just before boot.\r
581 //\r
582 UINT32 BiosUnexpectedInt;\r
583 UINT32 ThunkSavedInt[8];\r
584 UINT16 ThunkSeg;\r
585 LEGACY_EFI_HDD_TABLE *LegacyEfiHddTable;\r
586 UINT16 LegacyEfiHddTableIndex;\r
587 UINT8 DiskEnd;\r
588 UINT8 Disk4075;\r
589 UINT16 TraceIndex;\r
590 UINT16 Trace[0x200];\r
591\r
592 //\r
593 // Indicate that whether GenericLegacyBoot is entered or not\r
594 //\r
0a6f4824 595 BOOLEAN LegacyBootEntered;\r
bcecde14 596\r
597 //\r
598 // CSM16 PCI Interface Version\r
599 //\r
600 UINT16 Csm16PciInterfaceVersion;\r
601\r
602} LEGACY_BIOS_INSTANCE;\r
603\r
604\r
605#pragma pack(1)\r
606\r
607/*\r
608 40:00-01 Com1\r
609 40:02-03 Com2\r
610 40:04-05 Com3\r
611 40:06-07 Com4\r
612 40:08-09 Lpt1\r
613 40:0A-0B Lpt2\r
614 40:0C-0D Lpt3\r
615 40:0E-0E Ebda segment\r
616 40:10-11 MachineConfig\r
617 40:12 Bda12 - skip\r
618 40:13-14 MemSize below 1MB\r
619 40:15-16 Bda15_16 - skip\r
620 40:17 Keyboard Shift status\r
621 40:18-19 Bda18_19 - skip\r
622 40:1A-1B Key buffer head\r
623 40:1C-1D Key buffer tail\r
624 40:1E-3D Bda1E_3D- key buffer -skip\r
625 40:3E-3F FloppyData 3E = Calibration status 3F = Motor status\r
626 40:40 FloppyTimeout\r
627 40:41-74 Bda41_74 - skip\r
628 40:75 Number of HDD drives\r
629 40:76-77 Bda76_77 - skip\r
630 40:78-79 78 = Lpt1 timeout, 79 = Lpt2 timeout\r
631 40:7A-7B 7A = Lpt3 timeout, 7B = Lpt4 timeout\r
632 40:7C-7D 7C = Com1 timeout, 7D = Com2 timeout\r
633 40:7E-7F 7E = Com3 timeout, 7F = Com4 timeout\r
634 40:80-81 Pointer to start of key buffer\r
635 40:82-83 Pointer to end of key buffer\r
636 40:84-87 Bda84_87 - skip\r
637 40:88 HDD Data Xmit rate\r
638 40:89-8f skip\r
639 40:90 Floppy data rate\r
640 40:91-95 skip\r
641 40:96 Keyboard Status\r
642 40:97 LED Status\r
643 40:98-101 skip\r
644*/\r
645typedef struct {\r
646 UINT16 Com1;\r
647 UINT16 Com2;\r
648 UINT16 Com3;\r
649 UINT16 Com4;\r
650 UINT16 Lpt1;\r
651 UINT16 Lpt2;\r
652 UINT16 Lpt3;\r
653 UINT16 Ebda;\r
654 UINT16 MachineConfig;\r
655 UINT8 Bda12;\r
656 UINT16 MemSize;\r
657 UINT8 Bda15_16[0x02];\r
658 UINT8 ShiftStatus;\r
659 UINT8 Bda18_19[0x02];\r
660 UINT16 KeyHead;\r
661 UINT16 KeyTail;\r
662 UINT16 Bda1E_3D[0x10];\r
663 UINT16 FloppyData;\r
664 UINT8 FloppyTimeout;\r
665 UINT8 Bda41_74[0x34];\r
666 UINT8 NumberOfDrives;\r
667 UINT8 Bda76_77[0x02];\r
668 UINT16 Lpt1_2Timeout;\r
669 UINT16 Lpt3_4Timeout;\r
670 UINT16 Com1_2Timeout;\r
671 UINT16 Com3_4Timeout;\r
672 UINT16 KeyStart;\r
673 UINT16 KeyEnd;\r
674 UINT8 Bda84_87[0x4];\r
675 UINT8 DataXmit;\r
676 UINT8 Bda89_8F[0x07];\r
677 UINT8 FloppyXRate;\r
678 UINT8 Bda91_95[0x05];\r
679 UINT8 KeyboardStatus;\r
680 UINT8 LedStatus;\r
681} BDA_STRUC;\r
682#pragma pack()\r
683\r
684#define LEGACY_BIOS_INSTANCE_FROM_THIS(this) CR (this, LEGACY_BIOS_INSTANCE, LegacyBios, LEGACY_BIOS_INSTANCE_SIGNATURE)\r
685\r
686/**\r
687 Thunk to 16-bit real mode and execute a software interrupt with a vector\r
688 of BiosInt. Regs will contain the 16-bit register context on entry and\r
689 exit.\r
690\r
691 @param This Protocol instance pointer.\r
692 @param BiosInt Processor interrupt vector to invoke\r
693 @param Regs Register contexted passed into (and returned) from thunk to\r
694 16-bit mode\r
695\r
696 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.\r
697 See Regs for status.\r
698 @retval TRUE There was a BIOS erro in the target code.\r
699\r
700**/\r
701BOOLEAN\r
702EFIAPI\r
703LegacyBiosInt86 (\r
704 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
705 IN UINT8 BiosInt,\r
706 IN EFI_IA32_REGISTER_SET *Regs\r
707 );\r
708\r
709\r
710/**\r
711 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the\r
712 16-bit register context on entry and exit. Arguments can be passed on\r
713 the Stack argument\r
714\r
715 @param This Protocol instance pointer.\r
716 @param Segment Segemnt of 16-bit mode call\r
717 @param Offset Offset of 16-bit mdoe call\r
718 @param Regs Register contexted passed into (and returned) from\r
719 thunk to 16-bit mode\r
720 @param Stack Caller allocated stack used to pass arguments\r
721 @param StackSize Size of Stack in bytes\r
722\r
723 @retval FALSE Thunk completed, and there were no BIOS errors in\r
724 the target code. See Regs for status.\r
725 @retval TRUE There was a BIOS erro in the target code.\r
726\r
727**/\r
728BOOLEAN\r
729EFIAPI\r
730LegacyBiosFarCall86 (\r
731 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
732 IN UINT16 Segment,\r
733 IN UINT16 Offset,\r
734 IN EFI_IA32_REGISTER_SET *Regs,\r
735 IN VOID *Stack,\r
736 IN UINTN StackSize\r
737 );\r
738\r
739\r
740/**\r
741 Test to see if a legacy PCI ROM exists for this device. Optionally return\r
742 the Legacy ROM instance for this PCI device.\r
743\r
744 @param This Protocol instance pointer.\r
745 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will\r
746 be loaded\r
747 @param RomImage Return the legacy PCI ROM for this device\r
748 @param RomSize Size of ROM Image\r
749 @param Flags Indicates if ROM found and if PC-AT.\r
750\r
70d3fe9d 751 @retval EFI_SUCCESS Legacy Option ROM available for this device\r
bcecde14 752 @retval EFI_UNSUPPORTED Legacy Option ROM not supported.\r
753\r
754**/\r
755EFI_STATUS\r
756EFIAPI\r
757LegacyBiosCheckPciRom (\r
758 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
759 IN EFI_HANDLE PciHandle,\r
760 OUT VOID **RomImage, OPTIONAL\r
761 OUT UINTN *RomSize, OPTIONAL\r
762 OUT UINTN *Flags\r
763 );\r
764\r
765\r
766/**\r
767 Assign drive number to legacy HDD drives prior to booting an EFI\r
768 aware OS so the OS can access drives without an EFI driver.\r
769 Note: BBS compliant drives ARE NOT available until this call by\r
770 either shell or EFI.\r
771\r
772 @param This Protocol instance pointer.\r
773 @param BbsCount Number of BBS_TABLE structures\r
774 @param BbsTable List BBS entries\r
775\r
776 @retval EFI_SUCCESS Drive numbers assigned\r
777\r
778**/\r
779EFI_STATUS\r
780EFIAPI\r
781LegacyBiosPrepareToBootEfi (\r
782 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
783 OUT UINT16 *BbsCount,\r
784 OUT BBS_TABLE **BbsTable\r
785 );\r
786\r
787\r
788/**\r
789 To boot from an unconventional device like parties and/or execute\r
790 HDD diagnostics.\r
791\r
792 @param This Protocol instance pointer.\r
793 @param Attributes How to interpret the other input parameters\r
794 @param BbsEntry The 0-based index into the BbsTable for the parent\r
795 device.\r
796 @param BeerData Pointer to the 128 bytes of ram BEER data.\r
797 @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data.\r
798 The caller must provide a pointer to the specific\r
799 Service Area and not the start all Service Areas.\r
800 EFI_INVALID_PARAMETER if error. Does NOT return if no error.\r
801\r
802**/\r
803EFI_STATUS\r
804EFIAPI\r
805LegacyBiosBootUnconventionalDevice (\r
806 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
807 IN UDC_ATTRIBUTES Attributes,\r
808 IN UINTN BbsEntry,\r
809 IN VOID *BeerData,\r
810 IN VOID *ServiceAreaData\r
811 );\r
812\r
813\r
814/**\r
815 Load a legacy PC-AT OPROM on the PciHandle device. Return information\r
816 about how many disks were added by the OPROM and the shadow address and\r
817 size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:\r
818\r
819 @param This Protocol instance pointer.\r
820 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will\r
821 be loaded. This value is NULL if RomImage is\r
822 non-NULL. This is the normal case.\r
823 @param RomImage A PCI PC-AT ROM image. This argument is non-NULL\r
824 if there is no hardware associated with the ROM\r
825 and thus no PciHandle, otherwise is must be NULL.\r
826 Example is PXE base code.\r
827 @param Flags Indicates if ROM found and if PC-AT.\r
828 @param DiskStart Disk number of first device hooked by the ROM. If\r
829 DiskStart is the same as DiskEnd no disked were\r
830 hooked.\r
831 @param DiskEnd Disk number of the last device hooked by the ROM.\r
832 @param RomShadowAddress Shadow address of PC-AT ROM\r
833 @param RomShadowedSize Size of RomShadowAddress in bytes\r
834\r
835 @retval EFI_SUCCESS Legacy ROM loaded for this device\r
836 @retval EFI_INVALID_PARAMETER PciHandle not found\r
837 @retval EFI_UNSUPPORTED There is no PCI ROM in the ROM BAR or no onboard\r
838 ROM\r
839\r
840**/\r
841EFI_STATUS\r
842EFIAPI\r
843LegacyBiosInstallPciRom (\r
844 IN EFI_LEGACY_BIOS_PROTOCOL * This,\r
845 IN EFI_HANDLE PciHandle,\r
846 IN VOID **RomImage,\r
847 OUT UINTN *Flags,\r
848 OUT UINT8 *DiskStart, OPTIONAL\r
849 OUT UINT8 *DiskEnd, OPTIONAL\r
850 OUT VOID **RomShadowAddress, OPTIONAL\r
851 OUT UINT32 *RomShadowedSize OPTIONAL\r
852 );\r
853\r
854\r
855/**\r
856 Fill in the standard BDA for Keyboard LEDs\r
857\r
858 @param This Protocol instance pointer.\r
859 @param Leds Current LED status\r
860\r
861 @retval EFI_SUCCESS It should always work.\r
862\r
863**/\r
864EFI_STATUS\r
865EFIAPI\r
866LegacyBiosUpdateKeyboardLedStatus (\r
867 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
868 IN UINT8 Leds\r
869 );\r
870\r
871\r
872/**\r
873 Get all BBS info\r
874\r
875 @param This Protocol instance pointer.\r
876 @param HddCount Number of HDD_INFO structures\r
877 @param HddInfo Onboard IDE controller information\r
878 @param BbsCount Number of BBS_TABLE structures\r
879 @param BbsTable List BBS entries\r
880\r
881 @retval EFI_SUCCESS Tables returned\r
882 @retval EFI_NOT_FOUND resource not found\r
883 @retval EFI_DEVICE_ERROR can not get BBS table\r
884\r
885**/\r
886EFI_STATUS\r
887EFIAPI\r
888LegacyBiosGetBbsInfo (\r
889 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
890 OUT UINT16 *HddCount,\r
891 OUT HDD_INFO **HddInfo,\r
892 OUT UINT16 *BbsCount,\r
893 OUT BBS_TABLE **BbsTable\r
894 );\r
895\r
896\r
897/**\r
898 Shadow all legacy16 OPROMs that haven't been shadowed.\r
899 Warning: Use this with caution. This routine disconnects all EFI\r
900 drivers. If used externally then caller must re-connect EFI\r
901 drivers.\r
902\r
903 @param This Protocol instance pointer.\r
904\r
905 @retval EFI_SUCCESS OPROMs shadowed\r
906\r
907**/\r
908EFI_STATUS\r
909EFIAPI\r
910LegacyBiosShadowAllLegacyOproms (\r
911 IN EFI_LEGACY_BIOS_PROTOCOL *This\r
912 );\r
913\r
914\r
915/**\r
916 Attempt to legacy boot the BootOption. If the EFI contexted has been\r
917 compromised this function will not return.\r
918\r
919 @param This Protocol instance pointer.\r
920 @param BbsDevicePath EFI Device Path from BootXXXX variable.\r
921 @param LoadOptionsSize Size of LoadOption in size.\r
922 @param LoadOptions LoadOption from BootXXXX variable\r
923\r
924 @retval EFI_SUCCESS Removable media not present\r
925\r
926**/\r
927EFI_STATUS\r
928EFIAPI\r
929LegacyBiosLegacyBoot (\r
930 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
931 IN BBS_BBS_DEVICE_PATH *BbsDevicePath,\r
932 IN UINT32 LoadOptionsSize,\r
933 IN VOID *LoadOptions\r
934 );\r
935\r
936\r
937/**\r
938 Allocate memory < 1 MB and copy the thunker code into low memory. Se up\r
939 all the descriptors.\r
940\r
941 @param Private Private context for Legacy BIOS\r
942\r
943 @retval EFI_SUCCESS Should only pass.\r
944\r
945**/\r
946EFI_STATUS\r
947LegacyBiosInitializeThunk (\r
948 IN LEGACY_BIOS_INSTANCE *Private\r
949 );\r
950\r
951\r
952/**\r
953 Fill in the standard BDA and EBDA stuff before Legacy16 load\r
954\r
955 @param Private Legacy BIOS Instance data\r
956\r
957 @retval EFI_SUCCESS It should always work.\r
958\r
959**/\r
960EFI_STATUS\r
961LegacyBiosInitBda (\r
962 IN LEGACY_BIOS_INSTANCE *Private\r
963 );\r
964\r
965\r
966/**\r
967 Collect IDE Inquiry data from the IDE disks\r
968\r
969 @param Private Legacy BIOS Instance data\r
970 @param HddInfo Hdd Information\r
971 @param Flag Reconnect IdeController or not\r
972\r
973 @retval EFI_SUCCESS It should always work.\r
974\r
975**/\r
976EFI_STATUS\r
977LegacyBiosBuildIdeData (\r
978 IN LEGACY_BIOS_INSTANCE *Private,\r
979 IN HDD_INFO **HddInfo,\r
980 IN UINT16 Flag\r
981 );\r
982\r
983\r
984/**\r
985 Enable ide controller. This gets disabled when LegacyBoot.c is about\r
986 to run the Option ROMs.\r
987\r
988 @param Private Legacy BIOS Instance data\r
989\r
990\r
991**/\r
992VOID\r
993EnableIdeController (\r
994 IN LEGACY_BIOS_INSTANCE *Private\r
995 );\r
996\r
997\r
998/**\r
999 If the IDE channel is in compatibility (legacy) mode, remove all\r
1000 PCI I/O BAR addresses from the controller.\r
1001\r
1002 @param IdeController The handle of target IDE controller\r
1003\r
1004\r
1005**/\r
1006VOID\r
1007InitLegacyIdeController (\r
1008 IN EFI_HANDLE IdeController\r
1009 );\r
1010\r
1011\r
1012/**\r
1013 Program the interrupt routing register in all the PCI devices. On a PC AT system\r
1014 this register contains the 8259 IRQ vector that matches it's PCI interrupt.\r
1015\r
1016 @param Private Legacy BIOS Instance data\r
1017\r
1018 @retval EFI_SUCCESS Succeed.\r
1019 @retval EFI_ALREADY_STARTED All PCI devices have been processed.\r
1020\r
1021**/\r
1022EFI_STATUS\r
1023PciProgramAllInterruptLineRegisters (\r
1024 IN LEGACY_BIOS_INSTANCE *Private\r
1025 );\r
1026\r
1027\r
1028/**\r
1029 Collect EFI Info about legacy devices.\r
1030\r
1031 @param Private Legacy BIOS Instance data\r
1032\r
1033 @retval EFI_SUCCESS It should always work.\r
1034\r
1035**/\r
1036EFI_STATUS\r
1037LegacyBiosBuildSioData (\r
1038 IN LEGACY_BIOS_INSTANCE *Private\r
1039 );\r
1040\r
1041\r
1042/**\r
1043 Shadow all the PCI legacy ROMs. Use data from the Legacy BIOS Protocol\r
1044 to chose the order. Skip any devices that have already have legacy\r
1045 BIOS run.\r
1046\r
1047 @param Private Protocol instance pointer.\r
1048\r
1049 @retval EFI_SUCCESS Succeed.\r
1050 @retval EFI_UNSUPPORTED Cannot get VGA device handle.\r
1051\r
1052**/\r
1053EFI_STATUS\r
1054PciShadowRoms (\r
1055 IN LEGACY_BIOS_INSTANCE *Private\r
1056 );\r
1057\r
1058\r
1059/**\r
1060 Fill in the standard BDA and EBDA stuff prior to legacy Boot\r
1061\r
1062 @param Private Legacy BIOS Instance data\r
1063\r
1064 @retval EFI_SUCCESS It should always work.\r
1065\r
1066**/\r
1067EFI_STATUS\r
1068LegacyBiosCompleteBdaBeforeBoot (\r
1069 IN LEGACY_BIOS_INSTANCE *Private\r
1070 );\r
1071\r
1072\r
1073/**\r
1074 Fill in the standard CMOS stuff before Legacy16 load\r
1075\r
1076 @param Private Legacy BIOS Instance data\r
1077\r
1078 @retval EFI_SUCCESS It should always work.\r
1079\r
1080**/\r
1081EFI_STATUS\r
1082LegacyBiosInitCmos (\r
1083 IN LEGACY_BIOS_INSTANCE *Private\r
1084 );\r
1085\r
1086\r
1087/**\r
1088 Fill in the standard CMOS stuff prior to legacy Boot\r
1089\r
1090 @param Private Legacy BIOS Instance data\r
1091\r
1092 @retval EFI_SUCCESS It should always work.\r
1093\r
1094**/\r
1095EFI_STATUS\r
1096LegacyBiosCompleteStandardCmosBeforeBoot (\r
1097 IN LEGACY_BIOS_INSTANCE *Private\r
1098 );\r
1099\r
1100\r
1101/**\r
1102 Contains the code that is copied into low memory (below 640K).\r
1103 This code reflects interrupts 0x68-0x6f to interrupts 0x08-0x0f.\r
1104 This template must be copied into low memory, and the IDT entries\r
1105 0x68-0x6F must be point to the low memory copy of this code. Each\r
1106 entry is 4 bytes long, so IDT entries 0x68-0x6F can be easily\r
1107 computed.\r
1108\r
1109**/\r
1110VOID\r
1111InterruptRedirectionTemplate (\r
1112 VOID\r
1113 );\r
1114\r
1115\r
1116/**\r
1117 Build the E820 table.\r
1118\r
1119 @param Private Legacy BIOS Instance data\r
1120 @param Size Size of E820 Table\r
1121\r
1122 @retval EFI_SUCCESS It should always work.\r
1123\r
1124**/\r
1125EFI_STATUS\r
1126LegacyBiosBuildE820 (\r
1127 IN LEGACY_BIOS_INSTANCE *Private,\r
1128 OUT UINTN *Size\r
1129 );\r
1130\r
1131/**\r
1132 This function is to put all AP in halt state.\r
1133\r
1134 @param Private Legacy BIOS Instance data\r
1135\r
1136**/\r
1137VOID\r
1138ShutdownAPs (\r
1139 IN LEGACY_BIOS_INSTANCE *Private\r
1140 );\r
1141\r
1142/**\r
1143 Worker function for LegacyBiosGetFlatDescs, retrieving content of\r
1144 specific registers.\r
1145\r
1146 @param IntThunk Pointer to IntThunk of Legacy BIOS context.\r
1147\r
1148**/\r
1149VOID\r
1150GetRegisters (\r
1151 LOW_MEMORY_THUNK *IntThunk\r
1152 );\r
1153\r
1154/**\r
1155 Routine for calling real thunk code.\r
1156\r
1157 @param RealCode The address of thunk code.\r
1158 @param BiosInt The Bios interrupt vector number.\r
1159 @param CallAddress The address of 16-bit mode call.\r
1160\r
1161 @return Status returned by real thunk code\r
1162\r
1163**/\r
1164UINTN\r
1165CallRealThunkCode (\r
1166 UINT8 *RealCode,\r
1167 UINT8 BiosInt,\r
1168 UINT32 CallAddress\r
1169 );\r
1170\r
1171/**\r
1172 Routine for generating soft interrupt.\r
1173\r
1174 @param Vector The interrupt vector number.\r
1175\r
1176**/\r
1177VOID\r
1178GenerateSoftInit (\r
1179 UINT8 Vector\r
1180 );\r
1181\r
1182/**\r
b22a62be 1183 Allocate memory for legacy usage.\r
bcecde14 1184\r
b22a62be
RN		 1185 @param AllocateType The type of allocation to perform.\r
1186 @param MemoryType The type of memory to allocate.\r
bcecde14 1187 @param StartPageAddress Start address of range\r
1188 @param Pages Number of pages to allocate\r
1189 @param Result Result of allocation\r
1190\r
1191 @retval EFI_SUCCESS Legacy16 code loaded\r
1192 @retval Other No protocol installed, unload driver.\r
1193\r
1194**/\r
1195EFI_STATUS\r
1196AllocateLegacyMemory (\r
1197 IN EFI_ALLOCATE_TYPE AllocateType,\r
b22a62be 1198 IN EFI_MEMORY_TYPE MemoryType,\r
bcecde14 1199 IN EFI_PHYSICAL_ADDRESS StartPageAddress,\r
1200 IN UINTN Pages,\r
1201 OUT EFI_PHYSICAL_ADDRESS *Result\r
1202 );\r
1203\r
1204/**\r
1205 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
1206\r
1207 @param This Protocol instance pointer.\r
1208 @param LegacyMemorySize Size of required region\r
1209 @param Region Region to use. 00 = Either 0xE0000 or 0xF0000\r
1210 block Bit0 = 1 0xF0000 block Bit1 = 1 0xE0000\r
1211 block\r
1212 @param Alignment Address alignment. Bit mapped. First non-zero\r
1213 bit from right is alignment.\r
1214 @param LegacyMemoryAddress Region Assigned\r
1215\r
1216 @retval EFI_SUCCESS Region assigned\r
1217 @retval EFI_ACCESS_DENIED Procedure previously invoked\r
1218 @retval Other Region not assigned\r
1219\r
1220**/\r
1221EFI_STATUS\r
1222EFIAPI\r
1223LegacyBiosGetLegacyRegion (\r
1224 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
1225 IN UINTN LegacyMemorySize,\r
1226 IN UINTN Region,\r
1227 IN UINTN Alignment,\r
1228 OUT VOID **LegacyMemoryAddress\r
1229 );\r
1230\r
1231/**\r
1232 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
1233\r
1234 @param This Protocol instance pointer.\r
1235 @param LegacyMemorySize Size of data to copy\r
1236 @param LegacyMemoryAddress Legacy Region destination address Note: must\r
1237 be in region assigned by\r
1238 LegacyBiosGetLegacyRegion\r
1239 @param LegacyMemorySourceAddress Source of data\r
1240\r
1241 @retval EFI_SUCCESS Region assigned\r
1242 @retval EFI_ACCESS_DENIED Destination outside assigned region\r
1243\r
1244**/\r
1245EFI_STATUS\r
1246EFIAPI\r
1247LegacyBiosCopyLegacyRegion (\r
1248 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
1249 IN UINTN LegacyMemorySize,\r
1250 IN VOID *LegacyMemoryAddress,\r
1251 IN VOID *LegacyMemorySourceAddress\r
1252 );\r
1253\r
1254/**\r
1255 Find Legacy16 BIOS image in the FLASH device and shadow it into memory. Find\r
1256 the $EFI table in the shadow area. Thunk into the Legacy16 code after it had\r
1257 been shadowed.\r
1258\r
1259 @param Private Legacy BIOS context data\r
1260\r
1261 @retval EFI_SUCCESS Legacy16 code loaded\r
1262 @retval Other No protocol installed, unload driver.\r
1263\r
1264**/\r
1265EFI_STATUS\r
1266ShadowAndStartLegacy16 (\r
1267 IN LEGACY_BIOS_INSTANCE *Private\r
1268 );\r
1269\r
1270/**\r
1271 Checks the state of the floppy and if media is inserted.\r
0a6f4824 1272\r
bcecde14 1273 This routine checks the state of the floppy and if media is inserted.\r
1274 There are 3 cases:\r
1275 No floppy present - Set BBS entry to ignore\r
1276 Floppy present & no media - Set BBS entry to lowest priority. We cannot\r
1277 set it to ignore since 16-bit CSM will\r
1278 indicate no floppy and thus drive A: is\r
1279 unusable. CSM-16 will not try floppy since\r
1280 lowest priority and thus not incur boot\r
1281 time penality.\r
1282 Floppy present & media - Set BBS entry to some priority.\r
1283\r
1284 @return State of floppy media\r
1285\r
1286**/\r
1287UINT8\r
1288HasMediaInFloppy (\r
1289 VOID\r
1290 );\r
1291\r
1292/**\r
1293 Identify drive data must be updated to actual parameters before boot.\r
1294 This requires updating the checksum, if it exists.\r
1295\r
1296 @param IdentifyDriveData ATA Identify Data\r
1297 @param Checksum checksum of the ATA Identify Data\r
1298\r
1299 @retval EFI_SUCCESS checksum calculated\r
1300 @retval EFI_SECURITY_VIOLATION IdentifyData invalid\r
1301\r
1302**/\r
1303EFI_STATUS\r
1304CalculateIdentifyDriveChecksum (\r
1305 IN UINT8 *IdentifyDriveData,\r
1306 OUT UINT8 *Checksum\r
1307 );\r
1308\r
1309/**\r
1310 Identify drive data must be updated to actual parameters before boot.\r
1311\r
1312 @param IdentifyDriveData ATA Identify Data\r
1313\r
1314**/\r
1315VOID\r
1316UpdateIdentifyDriveData (\r
1317 IN UINT8 *IdentifyDriveData\r
1318 );\r
1319\r
1320/**\r
1321 Complete build of BBS TABLE.\r
1322\r
1323 @param Private Legacy BIOS Instance data\r
1324 @param BbsTable BBS Table passed to 16-bit code\r
1325\r
1326 @retval EFI_SUCCESS Removable media not present\r
1327\r
1328**/\r
1329EFI_STATUS\r
1330LegacyBiosBuildBbs (\r
1331 IN LEGACY_BIOS_INSTANCE *Private,\r
1332 IN BBS_TABLE *BbsTable\r
1333 );\r
1334\r
1335/**\r
1336 Read CMOS register through index/data port.\r
1337\r
1338 @param[in] Index The index of the CMOS register to read.\r
1339\r
1340 @return The data value from the CMOS register specified by Index.\r
1341\r
1342**/\r
1343UINT8\r
1344LegacyReadStandardCmos (\r
1345 IN UINT8 Index\r
1346 );\r
1347\r
1348/**\r
1349 Write CMOS register through index/data port.\r
1350\r
1351 @param[in] Index The index of the CMOS register to write.\r
1352 @param[in] Value The value of CMOS register to write.\r
1353\r
1354 @return The value written to the CMOS register specified by Index.\r
1355\r
1356**/\r
1357UINT8\r
1358LegacyWriteStandardCmos (\r
1359 IN UINT8 Index,\r
1360 IN UINT8 Value\r
1361 );\r
1362\r
1363/**\r
1364 Calculate the new standard CMOS checksum and write it.\r
1365\r
1366 @param Private Legacy BIOS Instance data\r
1367\r
1368 @retval EFI_SUCCESS Calculate 16-bit checksum successfully\r
1369\r
1370**/\r
1371EFI_STATUS\r
1372LegacyCalculateWriteStandardCmosChecksum (\r
1373 VOID\r
1374 );\r
1375\r
1376/**\r
1377 Test to see if a legacy PCI ROM exists for this device. Optionally return\r
1378 the Legacy ROM instance for this PCI device.\r
1379\r
1380 @param[in] This Protocol instance pointer.\r
1381 @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r
1382 @param[out] RomImage Return the legacy PCI ROM for this device\r
1383 @param[out] RomSize Size of ROM Image\r
1384 @param[out] RuntimeImageLength Runtime size of ROM Image\r
1385 @param[out] Flags Indicates if ROM found and if PC-AT.\r
1386 @param[out] OpromRevision Revision of the PCI Rom\r
1387 @param[out] ConfigUtilityCodeHeaderPointer of Configuration Utility Code Header\r
1388\r
70d3fe9d 1389 @return EFI_SUCCESS Legacy Option ROM available for this device\r
bcecde14 1390 @return EFI_ALREADY_STARTED This device is already managed by its Oprom\r
1391 @return EFI_UNSUPPORTED Legacy Option ROM not supported.\r
1392\r
1393**/\r
1394EFI_STATUS\r
1395LegacyBiosCheckPciRomEx (\r
1396 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
1397 IN EFI_HANDLE PciHandle,\r
1398 OUT VOID **RomImage, OPTIONAL\r
1399 OUT UINTN *RomSize, OPTIONAL\r
1400 OUT UINTN *RuntimeImageLength, OPTIONAL\r
1401 OUT UINTN *Flags, OPTIONAL\r
1402 OUT UINT8 *OpromRevision, OPTIONAL\r
1403 OUT VOID **ConfigUtilityCodeHeader OPTIONAL\r
1404 );\r
1405\r
1406/**\r
1407 Relocate this image under 4G memory for IPF.\r
1408\r
1409 @param ImageHandle Handle of driver image.\r
1410 @param SystemTable Pointer to system table.\r
1411\r
1412 @retval EFI_SUCCESS Image successfully relocated.\r
1413 @retval EFI_ABORTED Failed to relocate image.\r
1414\r
1415**/\r
1416EFI_STATUS\r
1417RelocateImageUnder4GIfNeeded (\r
1418 IN EFI_HANDLE ImageHandle,\r
1419 IN EFI_SYSTEM_TABLE *SystemTable\r
1420 );\r
1421\r
1422/**\r
1423 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the\r
1424 16-bit register context on entry and exit. Arguments can be passed on\r
1425 the Stack argument\r
1426\r
1427 @param This Protocol instance pointer.\r
1428 @param Segment Segemnt of 16-bit mode call\r
1429 @param Offset Offset of 16-bit mdoe call\r
1430 @param Regs Register contexted passed into (and returned) from thunk to\r
1431 16-bit mode\r
1432 @param Stack Caller allocated stack used to pass arguments\r
1433 @param StackSize Size of Stack in bytes\r
1434\r
1435 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.\r
1436 See Regs for status.\r
1437 @retval TRUE There was a BIOS erro in the target code.\r
1438\r
1439**/\r
1440BOOLEAN\r
1441EFIAPI\r
1442InternalLegacyBiosFarCall (\r
1443 IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
1444 IN UINT16 Segment,\r
1445 IN UINT16 Offset,\r
1446 IN EFI_IA32_REGISTER_SET *Regs,\r
1447 IN VOID *Stack,\r
1448 IN UINTN StackSize\r
1449 );\r
1450\r
0934a605 1451/**\r
1452 Load a legacy PC-AT OpROM for VGA controller.\r
1453\r
1454 @param Private Driver private data.\r
1455\r
1456 @retval EFI_SUCCESS Legacy ROM successfully installed for this device.\r
1457 @retval EFI_DEVICE_ERROR No VGA device handle found, or native EFI video\r
1458 driver cannot be successfully disconnected, or VGA\r
1459 thunk driver cannot be successfully connected.\r
1460\r
1461**/\r
1462EFI_STATUS\r
1463LegacyBiosInstallVgaRom (\r
1464 IN LEGACY_BIOS_INSTANCE *Private\r
1465 );\r
1466\r
bcecde14 1467#endif\r
EFI Development Kit II mirror for PVE