Intel Extensible Firmware Interface User Manual

Extensible firmware interface specification

Extensible Firmware Interface

Specification

Version 1.10

December 1, 2002

Table of contents

Document Outline

Extensible Firmware Interface Specification
Disclaimer
Revision History
Contents
1 Introduction
- 1.1 EFI Driver Model Extensions
- 1.2 Overview
- 1.3 Goals
- 1.4 Target Audience
- 1.5 EFI Design Overview
- 1.6 EFI Driver Model
  - 1.6.1 EFI Driver Model Goals
  - 1.6.2 Legacy Option ROM Issues
- 1.7 Migration Requirements
  - 1.7.1 Legacy Operating System Support
  - 1.7.2 Supporting the EFI Specification on a Legacy Platform
- 1.8 Conventions Used in This Document
2 Overview
- 2.1 Boot Manager
- 2.2 Firmware Core
  - 2.2.1 EFI Services
  - 2.2.2 Runtime Services
- 2.3 Calling Conventions
- 2.4 Protocols
- 2.5 EFI Driver Model
- 2.6 Requirements
3 Boot Manager
- 3.1 Firmware Boot Manager
- 3.2 Globally-Defined Variables
- 3.3 Boot Option Variables Default Behavior
- 3.4 Boot Mechanisms
  - 3.4.1 Boot via Simple File Protocol
    - 3.4.1.1 Removable Media Boot Behavior
  - 3.4.2 Boot via LOAD_FILE Protocol
    - 3.4.2.1 Network Booting
    - 3.4.2.2 Future Boot Media
4 EFI System Table
- 4.1 EFI Image Entry Point
  - EFI_IMAGE_ENTRY_POINT
- 4.2 EFI Table Header
  - EFI_TABLE_HEADER
- 4.3 EFI System Table
  - EFI_SYSTEM_TABLE
- 4.4 EFI Boot Services Table
  - EFI_BOOT_SERVICES
- 4.5 EFI Runtime Services Table
  - EFI_RUNTIME_SERVICES
- 4.6 EFI Configuration Table
  - EFI_CONFIGURATION_TABLE
- 4.7 EFI Image Entry Point Examples
5 Services - Boot Services
- 5.1 Event, Timer, and Task Priority Services
- 5.2 Memory Allocation Services
- 5.3 Protocol Handler Services
  - 5.3.1 Driver Model Boot Services
- 5.4 Image Services
- 5.5 Miscellaneous Boot Services
6 Services - Runtime Services
- 6.1 Variable Services
- 6.2 Time Services
- 6.3 Virtual Memory Services
  - SetVirtualAddressMap()
  - ConvertPointer()
- 6.4 Miscellaneous Runtime Services
  - ResetSystem()
  - GetNextHighMonotonicCount()
7 Protocols - EFI Loaded Image
- EFI_LOADED_IMAGE Protocol
  - LOADED_IMAGE.Unload()
8 Protocols - Device Path Protocol
- 8.1 Device Path Overview
- 8.2 EFI_DEVICE_PATH Protocol
  - EFI_DEVICE_PATH Protocol
- 8.3 Device Path Nodes
- 8.4 Device Path Generation Rules
9 Protocols - EFI Driver Model
- 9.1 EFI Driver Binding Protocol
  - EFI_DRIVER_BINDING_PROTOCOL
- 9.2 EFI Platform Driver Override Protocol
  - EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL
- 9.3 EFI Bus Specific Driver Override Protocol
  - EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL
    - EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL.GetDriver()
- 9.4 EFI Driver Configuration Protocol
  - EFI_DRIVER_CONFIGURATION_PROTOCOL
- 9.5 EFI Driver Diagnostics Protocol
  - EFI_DRIVER_DIAGNOSTICS_PROTOCOL
    - EFI_DRIVER_DIAGNOSTICS_PROTOCOL.RunDiagnostics()
- 9.6 EFI Component Name Protocol
  - EFI_COMPONENT_NAME_PROTOCOL
    - EFI_COMPONENT_NAME_PROTOCOL.GetDriverName()
    - EFI_COMPONENT_NAME_PROTOCOL.GetControllerName()
10 Protocols - Console Support
- 10.1 Console I/O Protocol
  - 10.1.1 Overview
  - 10.1.2 ConsoleIn Definition
- 10.2 Simple Input Protocol
  - SIMPLE_INPUT
    - SIMPLE_INPUT.Reset()
    - SIMPLE_INPUT.ReadKeyStroke()
  - 10.2.1 ConsoleOut or StandardError
- 10.3 Simple Text Output Protocol
  - SIMPLE_TEXT_OUTPUT Protocol
- 10.4 Universal Graphics Adapter Protocols
- 10.5 UGA Draw Protocol
  - EFI_UGA_DRAW_PROTOCOL
- 10.6 Rules for PCI/AGP Devices
- 10.7 UGA I/O Protocol
  - EFI_UGA_IO_PROTOCOL
- 10.8 Implementation Rules for an EFI UGA Driver
- 10.9 UGA Draw Protocol to UGA I/O Protocol Mapping
- 10.10 Simple Pointer Protocol
  - EFI_SIMPLE_POINTER_PROTOCOL
    - EFI_SIMPLE_POINTER.Reset()
    - EFI_SIMPLE_POINTER.GetState()
- 10.11 EFI Simple Pointer Device Paths
- 10.12 Serial I/O Protocol
  - SERIAL_IO_PROTOCOL
11 Protocols - Bootable Image Support
- 11.1 LOAD_FILE Protocol
  - LOAD_FILE Protocol
    - LOAD_FILE.LoadFile()
- 11.2 File System Format
- 11.3 File System Protocol
  - Simple File System Protocol
    - EFI_FILE_IO_INTERFACE.OpenVolume()
- 11.4 EFI_FILE Protocol
  - EFI_FILE Protocol
- 11.5 DISK_IO Protocol
  - DISK_IO Protocol
    - EFI_DISK_IO.ReadDisk()
    - EFI_DISK_IO.WriteDisk()
- 11.6 BLOCK_IO Protocol
  - BLOCK_IO Protocol
- 11.7 UNICODE_COLLATION Protocol
  - UNICODE_COLLATION Protocol
12 Protocols - PCI Bus Support
- 12.1 PCI Root Bridge I/O Support
  - 12.1.1 PCI Root Bridge I/O Overview
    - 12.1.1.1 Sample PCI Architectures
- 12.2 PCI Root Bridge I/O Protocol
  - EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
  - 12.2.1 PCI Root Bridge Device Paths
- 12.3 PCI Driver Model
- 12.4 EFI PCI I/O Protocol
13 Protocols - SCSI Bus Support
- 13.1 SCSI Pass Thru Protocol
  - EFI_SCSI_PASS_THRU Protocol
- 13.2 SCSI Pass Thru Device Paths
14 Protocols - USB Support
- 14.1 USB Host Controller Protocol
  - 14.1.1 USB Host Controller Protocol Overview
    - EFI_USB_HC_PROTOCOL
- 14.2 USB Driver Model
15 Protocols - Network Support
- 15.1 EFI_SIMPLE_NETWORK Protocol
  - EFI_SIMPLE_NETWORK Protocol
- 15.2 NETWORK_INTERFACE_IDENTIFIER Protocol
  - EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL
- 15.3 PXE Base Code Protocol
  - EFI_PXE_BASE_CODE Protocol
- 15.4 PXE Base Code Callback Protocol
  - EFI_PXE_BASE_CODE_CALLBACK Protocol
    - EFI_PXE_BASE_CODE_CALLBACK.Callback()
- 15.5 Boot Integrity Services Protocol
  - EFI_BIS_PROTOCOL
16 Protocols - Debugger Support
- 16.1 Overview
- 16.2 EFI Debug Support Protocol
  - 16.2.1 EFI Debug Support Protocol Overview
    - EFI_DEBUG_SUPPORT_PROTOCOL
- 16.3 EFI Debugport Protocol
- 16.4 EFI Debug Support Table
17 Protocols - Compression Algorithm Specification
- 17.1 Algorithm Overview
- 17.2 Data Format
- 17.3 Compressor Design
- 17.4 Decompressor Design
- 17.5 Decompress Protocol
  - EFI_DECOMPRESS_PROTOCOL
    - EFI_DECOMPRESS_PROTOCOL.GetInfo()
    - EFI_DECOMPRESS_PROTOCOL.Decompress()
18 Protocols - Device I/O Protocol
- 18.1 Device I/O Overview
- 18.2 DEVICE_IO Protocol
  - DEVICE_IO Protocol
19 EFI Byte Code Virtual Machine
- 19.1 Overview
- 19.2 Memory Ordering
- 19.3 Virtual Machine Registers
- 19.4 Natural Indexing
- 19.5 EBC Instruction Operands
- 19.6 EBC Instruction Syntax
- 19.7 Instruction Encoding
- 19.8 EBC Instruction Set
  - ADD
  - AND
  - ASHR
  - BREAK
  - CALL
  - CMP
  - CMPI
  - DIV
  - DIVU
  - EXTNDB
  - EXTNDD
  - EXTNDW
  - JMP
  - JMP8
  - MOD
  - MODU
  - MOV
  - MOVI
  - MOVIn
  - MOVn
  - MOVREL
  - MOVsn
  - MUL
  - MULU
  - NEG
  - NOT
  - OR
  - POP
  - POPn
  - PUSH
  - PUSHn
  - RET
  - SHL
  - SHR
  - STORESP
  - SUB
  - XOR
- 19.9 Runtime and Software Conventions
- 19.10 Architectural Requirements
- 19.11 EBC Interpreter Protocol
  - EFI_EBC_PROTOCOL
- 19.12 EBC Tools
- 19.13 VM Exception Handling
- 19.14 Option ROM Formats
  - 19.14.1 EFI Drivers for PCI Add-in Cards
  - 19.14.2 Non-PCI Bus Support
Appendix A GUID and Time Formats
Appendix B Console
- B.1 SIMPLE_INPUT
- B.2 SIMPLE_TEXT_OUTPUT
Appendix C Device Path Examples
- C.1 Example Computer System
- C.2 Legacy Floppy
- C.3 IDE Disk
- C.4 Secondary Root PCI Bus with PCI to PCI Bridge
- C.5 ACPI Terms
- C.6 EFI Device Path as a Name Space
Appendix D Status Codes
Appendix E 32/64-Bit UNDI Specification
- E.1 Introduction
- E.2 Overview
  - E.2.1 32/64-bit UNDI Interface
  - E.2.2 UNDI Command Format
- E.3 UNDI C Definitions
- E.4 UNDI Commands
- E.5 UNDI as an EFI Runtime Driver
Appendix F Using the Simple Pointer Protocol
Appendix G Using the EFI SCSI Pass Thru Protocol
Appendix H Compression Source Code
Appendix I Decompression Source Code
Appendix J EFI Byte Code Virtual Machine Opcode Summary
Appendix K Alphabetic Function Lists
References
Glossary
Index