2 The EFI Legacy BIOS Protocol is used to abstract legacy Option ROM usage
3 under EFI and Legacy OS boot.
5 Note: The names for EFI_IA32_REGISTER_SET elements were picked to follow
6 well known naming conventions.
8 Thunk - A thunk is a transition from one processor mode to another. A Thunk
9 is a transition from native EFI mode to 16-bit mode. A reverse thunk
10 would be a transition from 16-bit mode to native EFI mode.
12 You most likely should not use this protocol! Find the EFI way to solve the
13 problem to make your code portable
15 Copyright (c) 2007 - 2009, Intel Corporation
16 All rights reserved. This program and the accompanying materials
17 are licensed and made available under the terms and conditions of the BSD License
18 which accompanies this distribution. The full text of the license may be found at
19 http://opensource.org/licenses/bsd-license.php
21 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
22 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
24 Module Name: LegacyBios.h
26 @par Revision Reference:
27 This protocol is defined in Framework for EFI Compatibility Support Module spec
32 #ifndef _EFI_LEGACY_BIOS_H_
33 #define _EFI_LEGACY_BIOS_H_
35 #include <FrameworkDxe.h>
37 #define EFI_LEGACY_BIOS_PROTOCOL_GUID \
39 0xdb9a1e3d, 0x45cb, 0x4abb, {0x85, 0x3b, 0xe5, 0x38, 0x7f, 0xdb, 0x2e, 0x2d } \
42 typedef struct _EFI_LEGACY_BIOS_PROTOCOL EFI_LEGACY_BIOS_PROTOCOL
;
45 // Flags returned by CheckPciRom()
48 #define ROM_FOUND 0x01
49 #define VALID_LEGACY_ROM 0x02
50 #define ROM_WITH_CONFIG 0x04 // Not defined in CSM Specification0.96
53 /// @bug These macros appear in no specifications and are kept for backward
54 // compatibility only.
55 // Convert from 32-bit address (_Adr) to Segment:Offset 16-bit form
57 #define EFI_SEGMENT(_Adr) (UINT16) ((UINT16) (((UINTN) (_Adr)) >> 4) & 0xf000)
58 #define EFI_OFFSET(_Adr) (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xffff)
59 #define BYTE_GRANULARITY 0x01
60 #define WORD_GRANULARITY 0x02
61 #define DWORD_GRANULARITY 0x04
62 #define QWORD_GRANULARITY 0x08
63 #define PARAGRAPH_GRANULARITY 0x10
65 #define CARRY_FLAG 0x01
67 //*********************************************************
69 //*********************************************************
90 //*********************************************************
92 //*********************************************************
101 EFI_EFLAGS_REG EFlags
;
112 //*******************************************
114 //*******************************************
134 //*********************************************************
136 //*********************************************************
152 UINT16 ReservedFlags
;
165 //*********************************************************
167 //*********************************************************
184 } EFI_IA32_REGISTER_SET
;
187 Thunk to 16-bit real mode and execute a software interrupt with a vector
188 of BiosInt. Regs will contain the 16-bit register context on entry and
191 @param This Protocol instance pointer.
192 @param BiosInt Processor interrupt vector to invoke
193 @param Reg Register contexted passed into (and returned) from thunk to
196 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
198 @retval TRUE There was a BIOS erro in the target code.
203 (EFIAPI
*EFI_LEGACY_BIOS_INT86
)(
204 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
206 IN OUT EFI_IA32_REGISTER_SET
*Regs
210 Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
211 16-bit register context on entry and exit. Arguments can be passed on
214 @param This Protocol instance pointer.
215 @param Segment Segemnt of 16-bit mode call
216 @param Offset Offset of 16-bit mdoe call
217 @param Reg Register contexted passed into (and returned) from thunk to
219 @param Stack Caller allocated stack used to pass arguments
220 @param StackSize Size of Stack in bytes
222 @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
224 @retval TRUE There was a BIOS erro in the target code.
229 (EFIAPI
*EFI_LEGACY_BIOS_FARCALL86
)(
230 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
233 IN EFI_IA32_REGISTER_SET
*Regs
,
239 Test to see if a legacy PCI ROM exists for this device. Optionally return
240 the Legacy ROM instance for this PCI device.
242 @param This Protocol instance pointer.
243 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
244 @param RomImage Return the legacy PCI ROM for this device
245 @param RomSize Size of ROM Image
246 @param Flags Indicates if ROM found and if PC-AT.
248 @retval EFI_SUCCESS Legacy Option ROM availible for this device
249 @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
254 (EFIAPI
*EFI_LEGACY_BIOS_CHECK_ROM
)(
255 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
256 IN EFI_HANDLE PciHandle
,
257 OUT VOID
**RomImage
, OPTIONAL
258 OUT UINTN
*RomSize
, OPTIONAL
263 Load a legacy PC-AT OPROM on the PciHandle device. Return information
264 about how many disks were added by the OPROM and the shadow address and
265 size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:
267 @param This Protocol instance pointer.
268 @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded.
269 This value is NULL if RomImage is non-NULL. This is the normal
271 @param RomImage A PCI PC-AT ROM image. This argument is non-NULL if there is
272 no hardware associated with the ROM and thus no PciHandle,
273 otherwise is must be NULL.
274 Example is PXE base code.
275 @param Flags Return Status if ROM was found and if was Legacy OPROM.
276 @param DiskStart Disk number of first device hooked by the ROM. If DiskStart
277 is the same as DiskEnd no disked were hooked.
278 @param DiskEnd Disk number of the last device hooked by the ROM.
279 @param RomShadowAddress Shadow address of PC-AT ROM
280 @param RomShadowSize Size of RomShadowAddress in bytes
282 @retval EFI_SUCCESS Thunk completed, see Regs for status.
283 @retval EFI_INVALID_PARAMETER PciHandle not found
288 (EFIAPI
*EFI_LEGACY_BIOS_INSTALL_ROM
)(
289 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
290 IN EFI_HANDLE PciHandle
,
293 OUT UINT8
*DiskStart
, OPTIONAL
294 OUT UINT8
*DiskEnd
, OPTIONAL
295 OUT VOID
**RomShadowAddress
, OPTIONAL
296 OUT UINT32
*ShadowedRomSize OPTIONAL
300 Attempt to legacy boot the BootOption. If the EFI contexted has been
301 compromised this function will not return.
303 @param This Protocol instance pointer.
304 @param BootOption EFI Device Path from BootXXXX variable.
305 @param LoadOptionSize Size of LoadOption in size.
306 @param LoadOption LoadOption from BootXXXX variable
308 @retval EFI_SUCCESS Removable media not present
313 (EFIAPI
*EFI_LEGACY_BIOS_BOOT
)(
314 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
315 IN BBS_BBS_DEVICE_PATH
*BootOption
,
316 IN UINT32 LoadOptionsSize
,
321 Update BDA with current Scroll, Num & Cap lock LEDS
323 @param This Protocol instance pointer.
324 @param Leds Status of current Scroll, Num & Cap lock LEDS
325 Bit 0 is Scroll Lock 0 = Not locked
329 @retval EFI_SUCCESS Removable media not present
334 (EFIAPI
*EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS
)(
335 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
340 Retrieve legacy BBS info and assign boot priority.
342 @param This Protocol instance pointer.
343 @param HddCount Number of HDD_INFO structures
344 @param HddInfo Onboard IDE controller information
345 @param BbsCount Number of BBS_TABLE structures
346 @param BbsTable List BBS entries
348 @retval EFI_SUCCESS Tables returned
353 (EFIAPI
*EFI_LEGACY_BIOS_GET_BBS_INFO
)(
354 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
355 OUT UINT16
*HddCount
,
356 OUT HDD_INFO
**HddInfo
,
357 OUT UINT16
*BbsCount
,
358 IN OUT BBS_TABLE
**BbsTable
362 Assign drive number to legacy HDD drives prior to booting an EFI
363 aware OS so the OS can access drives without an EFI driver.
365 @param This Protocol instance pointer.
366 @param BbsCount Number of BBS_TABLE structures
367 @param BbsTable List BBS entries
369 @retval EFI_SUCCESS Drive numbers assigned
374 (EFIAPI
*EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI
)(
375 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
376 OUT UINT16
*BbsCount
,
377 OUT BBS_TABLE
**BbsTable
381 To boot from an unconventional device like parties and/or execute
384 @param This Protocol instance pointer.
385 @param Attributes How to interpret the other input parameters
386 @param BbsEntry The 0-based index into the BbsTable for the parent
388 @param BeerData Pointer to the 128 bytes of ram BEER data.
389 @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data. The
390 caller must provide a pointer to the specific Service
391 Area and not the start all Service Areas.
393 EFI_INVALID_PARAMETER if error. Does NOT return if no error.
398 (EFIAPI
*EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE
)(
399 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
400 IN UDC_ATTRIBUTES Attributes
,
403 IN VOID
*ServiceAreaData
407 Shadow all legacy16 OPROMs that haven't been shadowed.
408 Warning: Use this with caution. This routine disconnects all EFI
409 drivers. If used externally then caller must re-connect EFI
412 @retval EFI_SUCCESS OPROMs shadowed
417 (EFIAPI
*EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS
)(
418 IN EFI_LEGACY_BIOS_PROTOCOL
*This
422 Get a region from the LegacyBios for S3 usage.
424 @param This Protocol instance pointer.
425 @param LegacyMemorySize Size of required region
426 @param Region Region to use.
427 00 = Either 0xE0000 or 0xF0000 block
428 Bit0 = 1 0xF0000 block
429 Bit1 = 1 0xE0000 block
430 @param Alignment Address alignment. Bit mapped. First non-zero
431 bit from right is alignment.
432 @param LegacyMemoryAddress Region Assigned
434 @retval EFI_SUCCESS Region assigned
435 @retval Other Region not assigned
440 (EFIAPI
*EFI_LEGACY_BIOS_GET_LEGACY_REGION
)(
441 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
442 IN UINTN LegacyMemorySize
,
445 OUT VOID
**LegacyMemoryAddress
449 Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
451 @param This Protocol instance pointer.
452 @param LegacyMemorySize Size of data to copy
453 @param LegacyMemoryAddress Legacy Region destination address
454 Note: must be in region assigned by
455 LegacyBiosGetLegacyRegion
456 @param LegacyMemorySourceAddress
459 @retval EFI_SUCCESS Region assigned
460 @retval EFI_ACCESS_DENIED Destination outside assigned region
465 (EFIAPI
*EFI_LEGACY_BIOS_COPY_LEGACY_REGION
)(
466 IN EFI_LEGACY_BIOS_PROTOCOL
*This
,
467 IN UINTN LegacyMemorySize
,
468 IN VOID
*LegacyMemoryAddress
,
469 IN VOID
*LegacyMemorySourceAddress
473 Abstracts the traditional BIOS from the rest of EFI. The LegacyBoot()
474 member function allows the BDS to support booting a traditional OS.
475 EFI thunks drivers that make EFI bindings for BIOS INT services use
476 all the other member functions.
478 struct _EFI_LEGACY_BIOS_PROTOCOL
{
480 /// Performs traditional software INT. See the Int86() function description.
482 EFI_LEGACY_BIOS_INT86 Int86
;
485 /// Performs a far call into Compatibility16 or traditional OpROM code.
487 EFI_LEGACY_BIOS_FARCALL86 FarCall86
;
490 /// Checks if a traditional OpROM exists for this device.
492 EFI_LEGACY_BIOS_CHECK_ROM CheckPciRom
;
495 /// Loads a traditional OpROM in traditional OpROM address space.
497 EFI_LEGACY_BIOS_INSTALL_ROM InstallPciRom
;
500 /// Boots a traditional OS.
502 EFI_LEGACY_BIOS_BOOT LegacyBoot
;
505 /// Updates BDA to reflect the current EFI keyboard LED status.
507 EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS UpdateKeyboardLedStatus
;
510 /// Allows an external agent, such as BIOS Setup, to get the BBS data.
512 EFI_LEGACY_BIOS_GET_BBS_INFO GetBbsInfo
;
515 /// Causes all legacy OpROMs to be shadowed.
517 EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS ShadowAllLegacyOproms
;
520 /// Performs all actions prior to boot. Used when booting an EFI-aware OS
521 /// rather than a legacy OS.
523 EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI PrepareToBootEfi
;
526 /// Allows EFI to reserve an area in the 0xE0000 or 0xF0000 block.
528 EFI_LEGACY_BIOS_GET_LEGACY_REGION GetLegacyRegion
;
531 /// Allows EFI to copy data to the area specified by GetLegacyRegion.
533 EFI_LEGACY_BIOS_COPY_LEGACY_REGION CopyLegacyRegion
;
536 /// Allows the user to boot off an unconventional device such as a PARTIES partition.
538 EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE BootUnconventionalDevice
;
541 extern EFI_GUID gEfiLegacyBiosProtocolGuid
;