EFI 1.10 驱动程序开发指南

5星 · 超过95%的资源需积分: 35 137 浏览量更新于2024-07-27 收藏 1.91MB PDF 举报

"EFI 1.10 Driver Writer’s Guide" EFI（Extensible Firmware Interface，扩展固件接口）是一种开放式的firmware接口规范，由Intel公司推出。EFI 1.10 Driver Writer’s Guide是写EFI BIOS driver的必备资料，本指南旨在帮助开发人员了解如何编写EFI驱动程序，实现硬件设备的控制和管理。在本指南中，我们将详细介绍EFI 1.10驱动程序开发的整个过程，包括驱动程序架构、驱动程序接口、驱动程序开发工具、驱动程序测试和验证等内容。 EFI驱动程序架构 EFI驱动程序架构是指驱动程序的组织结构和设计模式。EFI驱动程序架构主要包括以下几个部分： 1. Driver Entry Point：驱动程序入口点，负责驱动程序的初始化和卸载。 2. Driver Binding Protocol：驱动程序绑定协议，负责驱动程序与设备的绑定。 3. Driver Configuration Protocol：驱动程序配置协议，负责驱动程序的配置和设置。 4. Driver I/O Protocol：驱动程序I/O协议，负责驱动程序的输入/输出操作。 EFI驱动程序接口 EFI驱动程序接口是指驱动程序与操作系统或应用程序之间的交互接口。EFI驱动程序接口主要包括以下几种： 1. EFI_BOOT_SERVICES：EFI启动服务接口，提供了驱动程序的启动和卸载功能。 2. EFI_RUNTIME_SERVICES：EFI运行时服务接口，提供了驱动程序的运行时功能。 3. EFI_DEVICE_PATH_PROTOCOL：EFI设备路径协议，提供了驱动程序与设备的交互功能。 EFI驱动程序开发工具 EFI驱动程序开发工具是指用于开发和测试EFI驱动程序的工具。常见的EFI驱动程序开发工具包括： 1. EFI Development Kit（EDK）：EFI开发工具包，提供了EFI驱动程序开发的所有必要工具和库。 2. EFI Driver Wizard：EFI驱动程序向导，提供了驱动程序开发的图形化界面。 EFI驱动程序测试和验证 EFI驱动程序测试和验证是指对驱动程序的功能和性能进行测试和验证的过程。EFI驱动程序测试和验证主要包括以下几个步骤： 1. 单元测试：对驱动程序的每个模块进行测试和验证。 2. 集成测试：对驱动程序的所有模块进行集成测试和验证。 3. 系统测试：对驱动程序在实际系统中的测试和验证。 EFI 1.10 Driver Writer’s Guide为开发人员提供了详细的EFI驱动程序开发指南，涵盖了驱动程序架构、驱动程序接口、驱动程序开发工具、驱动程序测试和验证等方面的内容。

EFI 1.10 Driver Writer’s Guide Draft for Review

xvi July 2004 Version 0.9

Example 4-27. Install Configuration Table........................................................................ 132

Example 4-28. Computing 32-bit CRC Values.................................................................. 132

Example 4-29. Validating 32-bit CRC Values ................................................................... 133

Example 4-30. Stall Loop.................................................................................................. 138

Example 4-31. Stall Service.............................................................................................. 139

Example 4-32. Starting a Periodic Timer .......................................................................... 140

Example 4-33. Arming a One-Shot Timer......................................................................... 141

Example 4-34. Stopping a Timer ...................................................................................... 141

Example 4-35. Time and Date Services ........................................................................... 142

Example 5-1. PCI Bus Walk Example ............................................................................ 154

Example 7-1. Generic Entry Point ..................................................................................177

Example 7-2. Driver Library Functions ...........................................................................178

Example 7-3. Simple EFI Driver Model Driver Entry Point.............................................. 179

Example 7-4. Complex EFI Driver Model Driver Entry Point .......................................... 180

Example 7-5. Multiple Driver Binding Protocols.............................................................. 182

Example 7-6. Add the Unload Feature ...........................................................................185

Example 7-7. Unload Function .......................................................................................186

Example 7-8. Adding the Exit Boot Services Feature..................................................... 188

Example 7-9. Add the Unload and Exit Boot Services Event Feature ............................ 189

Example 7-10. Initializing Driver Entry Point..................................................................... 190

Example 7-11. Service Driver Entry Point – Image Handle .............................................. 191

Example 7-12. Service Driver Entry Point – New Handle.................................................191

Example 7-13. Single PCI Root Bridge Driver Entry Point ............................................... 193

Example 7-14. Multiple PCI Root Bridge Driver Entry Point ............................................. 196

Example 7-15. Runtime Driver Entry Point ....................................................................... 198

Example 7-16. Runtime Driver Entry Point with Unload Feature......................................200

Example 8-1. Containing Record Macro Definitions ....................................................... 202

Example 8-2. Private Context Data Structure Template................................................. 205

Example 8-3. Simple Private Context Data Structure..................................................... 206

Example 8-4. Complex Private Context Data Structure.................................................. 207

Example 8-5. Allocation of a Private Context Data Structure ......................................... 207

Example 8-6. Library Allocation of Private Context Data Structure ................................ 208

Example 8-7. Disk I/O Allocation of Private Context Data Structure............................... 208

Example 8-8. Freeing a Private Context Data Structure................................................. 209

Example 8-9. Disk I/O Freeing of a Private Context Data Structure...............................210

Example 8-10. Retrieving the Private Context Data Structure.......................................... 211

Example 8-11. Retrieving the Disk I/O Private Context Data Structure............................ 211

Example 9-1. Driver Binding Protocol Declaration.......................................................... 214

Example 9-2. Driver Binding Protocol Template............................................................. 215

Example 10-1. Driver Name .............................................................................................220

Example 10-2. Device Driver with Static Controller Names.............................................. 221

Example 10-3. Private Context Data Structure with a Dynamic Controller Name Table .. 222

Example 10-4. Adding a Controller Name to a Dynamic Controller Name Table ............. 223

Example 10-5. Freeing a Dynamic Controller Name Table .............................................. 223

Example 10-6. Device Driver with Dynamic Controller Names......................................... 225

Example 10-7. Bus Driver with Static Controller and Child Names .................................. 227

Example 10-8. Bus Driver with Dynamic Child Names.....................................................229

Example 11-1. Driver Configuration Protocol Template ................................................... 233

Draft for Review Contents

Version 0.9 July 2004 xvii

Example 11-2. Retrieving the Private Context Data Structure.......................................... 234

Example 11-3. Validating Options in SetOptions() ...........................................................235

Example 11-4. Retrieving the Private Context Data Structure.......................................... 238

Example 12-1. Driver Diagnostics Protocol Template ...................................................... 240

Example 13-1. Private Context for a Bus Specific Driver Override Protocol..................... 244

Example 13-2. GetDriver() Function of a Bus Specific Driver Override Protocol.............. 245

Example 13-3. AddDriver() Worker Function.................................................................... 246

Example 13-4. Bus Specific Driver Override Protocol Constructor................................... 246

Example 14-1. Supported() Service with Partial PCI Configuration Header.....................251

Example 14-2. Supported() Service with Entire PCI Configuration Header...................... 252

Example 14-3. Start() and Stop() for a 64-Bit DMA Capable PCI Controller .................... 254

Example 14-4. Start() and Stop() for a 32-Bit DMA Capable PCI Controller .................... 254

Example 14-5. Completing a Memory Write Transaction ................................................. 257

Example 14-6. Accessing ISA Resources on a PCI Controller......................................... 258

Example 14-7. Locate PCI Handles with Matching Bus Number...................................... 260

Example 14-8. Map() Function .........................................................................................262

Example 14-9. Completing a Bus Master Write Operation ............................................... 263

Example 14-10. Bus Master Read Operation ..................................................................... 267

Example 14-11. Bus Master Write Operation ..................................................................... 270

Example 14-12. Setting up a Bus Master Common Buffer Operation ................................ 272

Example 14-13. Tearing Down a Bus Master Common Buffer Operation .......................... 273

Example 15-1. Supported() Service for USB Host Controller Driver................................. 280

Example 15-2. Turning off USB Legacy Support.............................................................. 281

Example 15-3. Implementing the USB Host Controller Protocol....................................... 284

Example 15-4. Supported() Service of USB Device Driver............................................... 288

Example 15-5. Implementing a USB CBI Mass Storage Device Driver............................289

Example 15-6. Initiating an Asynchronous Interrupt Transfer in a USB Mouse Driver ..... 291

Example 15-7. Completing an Asynchronous Interrupt Transfer...................................... 292

Example 15-8. Retrieving Pointer Movement ................................................................... 293

Example 16-1. SCSI Pass Thru Mode Structure on Single-Channel SCSI Adapter......... 303

Example 16-2. SCSI Pass Thru Mode Structure on Multichannel SCSI Adapter ............. 303

Example 16-3. SCSI Pass Thru Mode Structures on RAID SCSI Adapter.......................304

Example 16-4. SCSI Pass Thru Protocol Template.......................................................... 306

Example 16-5. Building Device Path for ATAPI Device.................................................... 307

Example 16-6. Sample Nonblocking SCSI Pass Thru Protocol Implementation .............. 309

Example 16-7. SCSI Channel Enumeration ..................................................................... 311

Example 16-8. Sample Creation of SCSI Device Child Handle........................................313

Example 16-9. Handle Device and Media Change........................................................... 314

Example 16-10. Blocking and Nonblocking Modes ............................................................321

Example 17-1. CopyMem() and SetMem() Speed Optimizations ..................................... 326

Example 17-2. Speed Optimizations Using PCI I/O Fill Operations ................................. 328

Example 17-3. Speed Optimizations Using PCI I/O FIFO Operations.............................. 329

Example 17-4. Speed Optimizations Using the PCI I/O CopyMem() Service................... 330

Example 17-5. Speed Optimizations for PCI Configuration Cycles .................................. 331

Example 17-6. Speed Optimizations for Multiple Read/Write Operations ........................ 331

Example 17-7. Speed Optimizations for Polled I/O Operations........................................ 332

Example 18-1. Pointer-Cast Alignment Fault.................................................................... 333

Example 18-2. Corrected Pointer-Cast Alignment Fault................................................... 334

EFI 1.10 Driver Writer’s Guide Draft for Review

xviii July 2004 Version 0.9

Example 18-3. Packed Structure Alignment Fault ............................................................ 334

Example 18-4. Corrected Packed Structure Alignment Fault ........................................... 335

Example 18-5. EFI Device Path Node Alignment Fault .................................................... 336

Example 18-6. Corrected EFI Device Path Node Alignment Fault ................................... 336

Example 18-7. Accessing a 64-Bit BAR in a PCI Configuration Header........................... 337

Example 18-8. Assignment Operation Warnings.............................................................. 338

Example 18-9. Comparison Operation Warnings ............................................................. 338

Example 18-10. Casting Pointer Examples ........................................................................ 340

Example 18-11. Negative Number Example....................................................................... 340

Example 18-12. Casting OUT Function Parameters........................................................... 341

Example 18-13. Array Subscripts Example ........................................................................ 342

Example 18-14. Piecemeal Structure Allocation................................................................. 342

Example 19-1. Size of EBC Data Types........................................................................... 348

Example 19-2. Case Statements ...................................................................................... 348

Example 19-3. Stronger Type Checking........................................................................... 349

Example 20-1. Disk I/O Driver Files.................................................................................. 351

Example 20-2. Disk I/O Driver with Processor-Specific Files ........................................... 352

Example 20-3. Disk I/O Driver Make.inf File..................................................................... 353

Example 20-4. Disk I/O Driver Make.inf File with Processor-Specific Files...................... 354

Example 20-5. EFI Build Tips ........................................................................................... 357

Example 20-6. Adding an EFI Driver to a Makefile........................................................... 358

Example 20-7. Integrating an EFI Driver to a Makefile ..................................................... 358

Example 20-8. Adding an EFI Driver’s Entry Point to Drivers.h........................................ 359

Example 20-9. Calling an EFI Driver’s Entry Point ........................................................... 360

Example 20-10. Linking All EFI_LIBS together in Makefile ................................................ 361

Example 20-11. EFIROM Tool Examples........................................................................... 364

Example 21-1. POST Code Examples ............................................................................. 376

Example 21-2. VGA Display Examples ............................................................................ 377

Draft for Review

Version 0.9 July 2004 19

Introduction

1.1 Overview

This document is designed to aid the development of EFI drivers that follow the EFI Driver Model

that is described in the Extensible Firmware Interface Specification, version 1.10 (hereafter referred

to as the “EFI 1.10 Specification”). There are several different classes of EFI drivers and many

variations of each of them. This document provides basic information for some of the most

common classes of EFI drivers. Many other driver designs are possible. In addition, the design

guidelines for the different driver-related protocols are covered, along with the design guidelines

for PCI, USB, and SCSI buses. Finally, porting considerations for Itanium

-based platforms and

EFI Byte Code (EBC) drivers and driver optimizations techniques are discussed.

This document assumes that the reader is familiar with the following:

• EFI 1.02 Specification

• EFI 1.10 Specification

• EFI 1.10.14.62 Sample Implementation

The EFI 1.10.14.62 Sample Implementation is also referred to as the EFI Sample Implementation or

the EFI 1.10 Sample Implementation throughout the remainder of this document. The EFI Sample

Implementation supports the following operating systems:

• Microsoft Windows NT* 4.0

• Microsoft Windows* 2000

• Microsoft Windows XP

It has a build infrastructure that supports Intel

compilers and the following versions of Microsoft

Visual Studio* or Visual C++*:

• Microsoft Visual Studio .NET 2003 or 2002. These versions do not require service packs. It is

recommended to use the Visual Studio .NET versions instead of Visual C++ 6.0.

• Microsoft Visual C++ 6.0 with the Visual Studio 6.0 Service Pack 5 or later and the Visual

C++ Processor Pack Download. These two service packs are available for download from:

http://msdn.microsoft.com/vstudio/downloads/updates/sp/vs6/sp5/default.aspx

http://msdn.microsoft.com/vstudio/downloads/tools/ppack/download.aspx

In general, this document will use the term Visual Studio to refer generically to any of the supported

versions in the Visual Studio or Visual C++ tool chains. If required, the EFI Sample

Implementation can be modified to support a wider variety of operating systems and tools chains.

However, only the supported operating systems and tools chains will be discussed in this document

as required.

EFI 1.10 Driver Writer’s Guide Draft for Review

20 July 2004 Version 0.9

1.2 Organization of This Document

This document is not intended to be read front to back. Instead, it is designed more as a cookbook

for developing and implementing drivers. The first four chapters provide background information,

chapter 5 provides the basic recipe for all drivers, and the remaining chapters provide detailed

information for developing specific types of drivers.

In general, driver writers should use this document in the following way:

1. Read the first four chapters of this document before starting to code.

2. Read chapter 5, which describes the general guidelines for designing all types of EFI drivers.

Specifically, see section 5.2 for the general steps to follow when designing a driver. This

section then points you to other sections in this document that contain the specific “recipe” for

that particular type of EFI driver.

3. Read the specific sections or chapters listed in section 5.2 that apply to your EFI driver.

Table 1-1 describes the organization of this document.

Table 1-1. Organization of the EFI 1.10 Driver Writer’s Guide

Chapter Description

1. Introduction Provides a brief overview of this document, its organization,

and the conventions used in it.

2. Foundation Describes the basic concepts in the EFI 1.10 Specification.

3. Coding Conventions Describes the common coding conventions to use in an

implementation of the EFI 1.10 Specification.

4. EFI Services Describes the services available in the EFI 1.10 Specification

and provides example code that uses these EFI services.

5. General Driver Design Guidelines Gives general guidelines for designing all types of EFI drivers.

Provides the basic “recipe” for developing a driver and points

to later chapters or sections for more detailed information.

6. Classes of EFI Drivers Describes the required and optional features and the subtypes

for different types of drivers that follow the EFI Driver Model.

7. Driver Entry Point Describes the entry point and optional features for the different

classes of EFI drivers.

8. Private Context Data Structures Introduces object-oriented programming techniques for

managing controllers and the concept of private context data

structures.

9. Driver Binding Protocol Describes the requirements and features for the Driver Binding

Protocol. This protocol provides services that can be used to

connect a driver to a controller and disconnect a driver from a

controller.

10. Component Name Protocol Describes the requirements and features for the Component

Name Protocol. This protocol provides a human-readable

name for drivers and the devices that drivers manage.

continued

剩余423页未读，继续阅读

parkershe

粉丝: 0
资源: 1

EFI 1.10 驱动程序开发指南

efi-driver-writers-v1-10-guide

Driver Writer’s Guide For UEFI 2.0

EFI_DRIVER_BINDING_PROTOCOL

没有/sys/firmware/efi/vars

/mnt_efi/EFI/BOOT/BOOTX64.EFI

启动efi_linux内核启动流程分析 efi_main

UEFI DXE_DRIVER和UEFI_DRIVER的区别

ubuntu启动文件efi

matebook13efi 文件

bootx64.efi和shim.efi的区别

最新资源