EDK II UEFI Driver Writer's Guide
Search…
EDK II UEFI Driver Writer's Guide
Introduction
Tables
Figures
Examples
Acknowledgements
1 Introduction
2 UEFI Driver Implementation Checklist
3 Foundation
4 General Driver Design Guidelines
5 UEFI Services
6 UEFI Driver Categories
7 Driver Entry Point
8 Private Context Data Structures
9 Driver Binding Protocol
10 UEFI Service Binding Protocol
11 UEFI Driver and Controller Names
12 UEFI Driver Configuration
13 UEFI Driver Diagnostics
14 Driver Health Protocol
15 Driver Family Override Protocol
16 Driver Supported EFI Version Protocol
17 Bus-Specific Driver Override Protocol
18 PCI Driver Design Guidelines
19 USB Driver Design Guidelines
20 SCSI Driver Design Guidelines
21 ATA Driver Design Guidelines
22 Text Console Driver Design Guidelines
23 Graphics Driver Design Guidelines
24 Mass Storage Driver Design Guidelines
24.1 Assumptions
24.2 Block I/O Protocol Implementations
24.3 Storage Security Protocol Implementation
25 Network Driver Design Guidelines
26 User Credential Driver Design Guidelines
27 Load File Driver Design Guidelines
28 IPF Platform Porting Considerations
29 EFI Byte Code Porting Considerations
30 Building UEFI Drivers
31 Testing and Debugging UEFI Drivers
32 Distributing UEFI Drivers
Appendix A EDK II File Templates
Appendix B EDK II Sample Drivers
Appendix C Glossary
Powered By GitBook
24 Mass Storage Driver Design Guidelines
This chapter covers the general guidelines for implementing UEFI Drivers for mass storage devices. Most mass storage devices reside on industry standard busses such as ATA, SCSI, or USB. This means that the design guidelines as described in Chapter 21 for ATA, Chapter 20 for SCSI, or Chapter 19 for USB must be followed along with the general guidelines described in Chapter 4 of this guide.
If a mass storage device is intended to be used as a boot device for a UEFI operating system or UEFI applications, then a UEFI Driver must be implemented that produces the Block I/O Protocol. If the UEFI Driver is required to be conformant with the UEFI Specification 2.3.1 or higher, then the Block I/O 2 Protocol must also be produced. If the mass storage device supports the SPC-4 or ATA8-ACS security commands, then the Storage Security Command Protocol must also be produced. A mass storage device must either directly support or be able to emulate the following operations:
    Read blocks of data from the mass storage device.
    Write blocks of data to the mass storage device.
    Determine the size of the blocks on the mass storage device.
    Determine the total number of blocks on the mass storage device.
    If the mass storage device supports removable media, then methods must exist to determine if media is present, media is not present, and if the media has been changed.
If a mass storage device does not meet these requirements, but still must support being used as a boot device, then consider implementing a UEFI Driver that produces either the Simple File System Protocol or the Load File Protocol. Please see the Media Access chapter of the UEFI Specification for details on the Simple File System Protocol and Chapter 27 for details on the Load File Protocol.
The EDK II provides a set of platform agnostic drivers in the MdeModulePkg and the FatBinPkg that consume the Block I/O Protocols and produce the Simple File System Protocol which is one of the two protocols from which a UEFI Boot Manager is able to boot a UEFI operating system or a UEFI application. These platform agnostic drivers allow the contents of the mass storage media to be accessed without any specialized knowledge of the specific device or controller. The set platform agnostic drivers UEFI Drivers include:
    MdeModulePkg/Universal/Disk/DiskIoDxe
    MdeModulePkg/Universal/Disk/PartitionDxe
    MdeModulePkg/Universal/Disk/UnicodeCollation
    FatBinPkg/EnhancedFatDxe
Previous
23.5.1 GetEdid() Implementation
Next
24.1 Assumptions
Last modified 1yr ago
Copy link