Intel Extensible Firmware Interface Users Manual Specification

2015-02-02

• Extensible Firmware Interface Specification
• Disclaimer
• Revision History
• Table of Contents
• 1 Introduction
  • 1.1 Overview
  • 1.2 Goals
  • 1.3 Target Audience
  • 1.4 Related Information
  • 1.5 Prerequisite Specifications
    • 1.5.1 ACPI Specification
    • 1.5.2 WfM Specification
    • 1.5.3 Additional Considerations for Intel® Itanium™-based Platforms
  • 1.6 EFI Design Overview
  • 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
    • 1.8.1 Data Structure Descriptions
    • 1.8.2 Typographic Conventions
  • 1.9 Guidelines for Use of the Term ”Extensible Firmware Interface”
• 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.3.1 Data Types
    • 2.3.2 IA-32 Platforms
    • 2.3.3 Itanium-based Platforms
  • 2.4 Protocols
  • 2.5 Requirements
    • 2.5.1 Required Elements
    • 2.5.2 Optional Elements
    • 2.5.3 Appendixes
• 3 Services
  • 3.1 Event, Timer, and Task Priority Services
    • 3.1.1 CreateEvent()
    • 3.1.2 CloseEvent()
    • 3.1.3 SignalEvent()
    • 3.1.4 WaitForEvent()
    • 3.1.5 CheckEvent()
    • 3.1.6 SetTimer()
    • 3.1.7 RaiseTPL()
    • 3.1.8 RestoreTPL()
  • 3.2 Memory Allocation Services
    • 3.2.1 AllocatePages()
    • 3.2.2 FreePages()
    • 3.2.3 GetMemoryMap()
    • 3.2.4 AllocatePool()
    • 3.2.5 FreePool()
  • 3.3 Protocol Handler Services
    • 3.3.1 InstallProtocolInterface()
    • 3.3.2 UninstallProtocolInterface()
    • 3.3.3 ReinstallProtocolInterface()
    • 3.3.4 RegisterProtocolNotify()
    • 3.3.5 LocateHandle()
    • 3.3.6 HandleProtocol()
    • 3.3.7 LocateDevicePath()
  • 3.4 Image Services
    • 3.4.1 LoadImage()
    • 3.4.2 StartImage()
    • 3.4.3 UnloadImage()
    • 3.4.4 EFI_IMAGE_ENTRY_POINT
    • 3.4.5 Exit()
    • 3.4.6 ExitBootServices()
  • 3.5 Variable Services
    • 3.5.1 GetVariable()
    • 3.5.2 GetNextVariableName()
    • 3.5.3 SetVariable()
  • 3.6 Time Services
    • 3.6.1 GetTime()
    • 3.6.2 SetTime()
    • 3.6.3 GetWakeupTime()
    • 3.6.4 SetWakeupTime()
  • 3.7 Virtual Memory Services
    • 3.7.1 SetVirtualAddressMap()
    • 3.7.2 ConvertPointer()
  • 3.8 Miscellaneous Services
    • 3.8.1 ResetSystem()
    • 3.8.2 SetWatchdogTimer()
    • 3.8.3 Stall()
    • 3.8.4 GetNextMonotonicCount()
    • 3.8.5 GetNextHighMonotonicCount()
    • 3.8.6 InstallConfigurationTable()
• 4 EFI Image
  • 4.1 LOADED_IMAGE Protocol
    • 4.1.1 LOADED_IMAGE.Unload()
  • 4.2 EFI Image Header
  • 4.3 EFI Applications
  • 4.4 EFI OS Loaders
  • 4.5 EFI Drivers
    • 4.5.1 EFI Image Handoff State
• 5 Device Path Protocol
  • 5.1 Device Path Overview
  • 5.2 EFI_DEVICE_PATH Protocol
  • 5.3 Device Path Nodes
    • 5.3.1 Generic Device Path Structures
    • 5.3.2 Hardware Device Path
    • 5.3.3 ACPI Device Path
    • 5.3.4 Messaging Device Path
    • 5.3.5 Media Device Path
    • 5.3.6 BIOS Boot Specification Device Path
  • 5.4 Device Path Generation Rules
    • 5.4.1 Housekeeping Rules
    • 5.4.2 Rules with ACPI _HID and _UID
    • 5.4.3 Rules with ACPI _ADR
    • 5.4.4 Hardware vs. Messaging Device Path Rules
    • 5.4.5 Media Device Path Rules
    • 5.4.6 Other Rules
• 6 Device I/O Protocol
  • 6.1 Device I/O Overview
  • 6.2 DEVICE_IO Protocol
    • 6.2.1 DEVICE_IO.Mem(), .Io(), and .Pci()
    • 6.2.2 DEVICE_IO.PciDevicePath()
    • 6.2.3 DEVICE_IO.Map()
    • 6.2.4 DEVICE_IO.Unmap()
    • 6.2.5 DEVICE_IO.AllocateBuffer()
    • 6.2.6 DEVICE_IO.Flush()
    • 6.2.7 DEVICE_IO.FreeBuffer()
• 7 Console I/O Protocol
  • 7.1 Console I/O Overview
  • 7.2 ConsoleIn Definition
  • 7.3 SIMPLE_INPUT Protocol
    • 7.3.1 SIMPLE_INPUT.Reset()
    • 7.3.2 SIMPLE_INPUT.ReadKeyStroke
  • 7.4 ConsoleOut or StandardError
  • 7.5 SIMPLE_TEXT_OUTPUT Protocol
    • 7.5.1 SIMPLE_TEXT_OUTPUT.Reset()
    • 7.5.2 SIMPLE_TEXT_OUTPUT.OutputString()
    • 7.5.3 SIMPLE_TEXT_OUTPUT.TestString()
    • 7.5.4 SIMPLE_TEXT_OUTPUT.QueryMode()
    • 7.5.5 SIMPLE_TEXT_OUTPUT.SetMode()
    • 7.5.6 SIMPLE_TEXT_OUTPUT.SetAttribute()
    • 7.5.7 SIMPLE_TEXT_OUTPUT.ClearScreen()
    • 7.5.8 SIMPLE_TEXT_OUTPUT.SetCursorPosition()
    • 7.5.9 SIMPLE_TEXT_OUTPUT.EnableCursor()
• 8 Block I/O Protocol
  • 8.1 BLOCK_IO Protocol
    • 8.1.1 EFI_BLOCK_IO.Reset()
    • 8.1.2 EFI_BLOCK_IO.ReadBlocks()
    • 8.1.3 EFI_BLOCK_IO.WriteBlocks()
    • 8.1.4 BLOCK_IO.FlushBlocks()
• 9 Disk I/O Protocol
  • 9.1 DISK_IO Protocol
    • 9.1.1 EFI_DISK_IO.ReadDisk()
    • 9.1.2 EFI_DISK_IO.WriteDisk()
• 10 File System Protocol
  • 10.1 Simple File System Protocol
    • 10.1.1 EFI_FILE_IO_INTERFACE.OpenVolume()
  • 10.2 EFI_FILE Protocol
    • 10.2.1 EFI_FILE.Open()
    • 10.2.2 EFI_FILE.Close()
    • 10.2.3 EFI_FILE.Delete()
    • 10.2.4 EFI_FILE.Read()
    • 10.2.5 EFI_FILE.Write()
    • 10.2.6 EFI_FILE.SetPosition()
    • 10.2.7 EFI_FILE.GetPosition()
    • 10.2.8 EFI_FILE.GetInfo()
    • 10.2.9 EFI_FILE.SetInfo()
    • 10.2.10 EFI_FILE.Flush()
    • 10.2.11 EFI_FILE_INFO
    • 10.2.12 EFI_FILE_SYSTEM_INFO
    • 10.2.13 EFI_FILE_SYSTEM_VOLUME_LABEL
• 11 Load File Protocol
  • 11.1 LOAD_FILE Protocol
    • 11.1.1 LOAD_FILE.LoadFile()
• 12 Serial I/O Protocol
  • 12.1 SERIAL_IO Protocol
    • 12.1.1 SERIAL_IO.Reset()
    • 12.1.2 SERIAL_IO.SetAttributes()
    • 12.1.3 SERIAL_IO.SetControl()
    • 12.1.4 SERIAL_IO.GetControl()
    • 12.1.5 SERIAL_IO.Write()
    • 12.1.6 SERIAL_IO.Read()
• 13 Unicode Collation Protocol
  • 13.1 UNICODE_COLLATION Protocol
    • 13.1.1 UNICODE_COLLATION.StriColl()
    • 13.1.2 UNICODE_COLLATION.MetaiMatch()
    • 13.1.3 UNICODE_COLLATION.StrLwr()
    • 13.1.4 UNICODE_COLLATION.StrUpr()
    • 13.1.5 UNICODE_COLLATION.FatToStr()
    • 13.1.6 UNICODE_COLLATION.StrToFat()
• 14 PXE Base Code Protocol
  • 14.1 EFI_PXE_BASE_CODE Protocol
    • 14.1.1 EFI_PXE_BASE_CODE.Start()
    • 14.1.2 EFI_PXE_BASE_CODE.Stop()
    • 14.1.3 EFI_PXE_BASE_CODE.Dhcp()
    • 14.1.4 EFI_PXE_BASE_CODE.Discover()
    • 14.1.5 EFI_PXE_BASE_CODE.Mtftp()
    • 14.1.6 EFI_PXE_BASE_CODE.UdpWrite()
    • 14.1.7 EFI_PXE_BASE_CODE.UdpRead()
    • 14.1.8 EFI_PXE_BASE_CODE.SetIpFilter()
    • 14.1.9 EFI_PXE_BASE_CODE.Arp()
    • 14.1.10 EFI_PXE_BASE_CODE.SetParameters()
    • 14.1.11 EFI_PXE_BASE_CODE.SetStationIp()
    • 14.1.12 EFI_PXE_BASE_CODE.SetPackets()
  • 14.2 EFI_PXE_BASE_CODE_CALLBACK Protocol
    • 14.2.1 EFI_PXE_BASE_CODE_CALLBACK.Callback()
• 15 Simple Network Protocol
  • 15.1 EFI_SIMPLE_NETWORK Protocol
    • 15.1.1 EFI_SIMPLE_NETWORK.Start()
    • 15.1.2 EFI_SIMPLE_NETWORK.Stop()
    • 15.1.3 EFI_SIMPLE_NETWORK.Initialize()
    • 15.1.4 EFI_SIMPLE_NETWORK.Reset()
    • 15.1.5 EFI_SIMPLE_NETWORK.Shutdown()
    • 15.1.6 EFI_SIMPLE_NETWORK.ReceiveFilters()
    • 15.1.7 EFI_SIMPLE_NETWORK.StationAddress()
    • 15.1.8 EFI_SIMPLE_NETWORK.Statistics()
    • 15.1.9 EFI_SIMPLE_NETWORK.MCastIPtoMAC()
    • 15.1.10 EFI_SIMPLE_NETWORK.NvData()
    • 15.1.11 EFI_SIMPLE_NETWORK.GetStatus()
    • 15.1.12 EFI_SIMPLE_NETWORK.Transmit()
    • 15.1.13 EFI_SIMPLE_NETWORK.Receive()
  • 15.2 NETWORK_INTERFACE_IDENTIFIER Protocol
• 16 File System Format
  • 16.1 System Partition
    • 16.1.1 File System Format
    • 16.1.2 File Names
    • 16.1.3 Directory Structure
  • 16.2 Partition Discovery
    • 16.2.1 EFI Partition Header
    • 16.2.2 ISO-9660 and El Torito
    • 16.2.3 Legacy Master Boot Record
    • 16.2.4 Legacy Master Boot Record and GPT Partitions
  • 16.3 Media Formats
    • 16.3.1 Removable Media
    • 16.3.2 Diskette
    • 16.3.3 Hard Drive
    • 16.3.4 CD-ROM and DVD-ROM
    • 16.3.5 Network
• 17 Boot Manager
  • 17.1 Firmware Boot Manager
  • 17.2 Globally-Defined Variables
  • 17.3 Boot Option Variables Default Behavior
  • 17.4 Boot Mechanisms
    • 17.4.1 Boot via Simple File Protocol
    • 17.4.2 Boot via LOAD_FILE Protocol
• 18 PCI Expansion ROM
  • 18.1 Standard PCI Expansion ROM Header
  • 18.2 EFI PCI Expansion ROM Header
  • 18.3 Multiple Image Format Support
  • 18.4 EFI PCI Expansion ROM Driver
• A GUID and Time Formats
• B Console
  • B.1 SIMPLE_INPUT
  • B.2 SIMPLE_TEXT_OUTPUT
• 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
• D Status Codes
• E Alphabetic Function Lists
• F Glossary
• G 32/64-Bit UNDI Specification
  • G.1 Introduction
    • G.1.1 Definitions
    • G.1.2 Referenced Specifications
    • G.1.3 OS Network Stacks
  • G.2 Overview
    • G.2.1 32/64-bit UNDI Interface
    • G.2.2 UNDI Command Format
  • G.3 UNDI C Definitions
    • G.3.1 Portability Macros
    • G.3.2 Miscellaneous Macros
    • G.3.3 Portability Types
    • G.3.4 Simple Types
    • G.3.5 Compound Types
  • G.4 UNDI Commands
    • G.4.1 Command Linking & Queuing
    • G.4.2 Get State
    • G.4.3 Start
    • G.4.4 Stop
    • G.4.5 Get Init Info
    • G.4.6 Get Config Info
    • G.4.7 Initialize
    • G.4.8 Reset
    • G.4.9 Shutdown
    • G.4.10 Interrupt Enables
    • G.4.11 Receive Filters
    • G.4.12 Station Address
    • G.4.13 Statistics
    • G.4.14 MCast IP To MAC
    • G.4.15 NvData
    • G.4.16 Get Status
    • G.4.17 Fill Header
    • G.4.18 Transmit
    • G.4.19 Receive
  • G.5 UNDI as an EFI Runtime Driver
• H Index