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
5.1 Services that UEFI drivers commonly use
5.2 Services that UEFI drivers rarely use
5.2.1 ConnectController() and DisconnectController()
5.2.2 ReinstallProtocolInterface()
5.2.3 LocateDevicePath()
5.2.4 LoadImage() and StartImage()
5.2.5 GetVariable() and SetVariable()
5.2.6 QueryVariableInfo ()
5.2.7 GetTime()
5.2.8 CalculateCrc32()
5.2.9 ConvertPointer()
5.2.10 InstallConfigurationTable()
5.2.11 GetNextMonotonicCount()
5.3 Services that UEFI drivers should not use
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
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
5.2 Services that UEFI drivers rarely use
Table 19 lists UEFI services rarely used by UEFI drivers. The following sub-topics briefly describe each service, why they are rarely used, or the particular circumstance in which they are useful. The code examples show how the services are typically used by UEFI drivers and are grouped by Service Type.

Table 19-UEFI services that are rarely used by UEFI drivers

Service
Type
Service Type
Notes
ConnectController()
Boot
Protocol Handler
Uses a set of precedence rules to find the best set of drivers to manage a controller.
DisconnectController()
Boot
Protocol Handler
Informs a set of drivers to stop managing a controller.
ReinstallProtocolInterface()
Boot
Protocol Handler
Reinstalls a protocol interface on a device handle.
LocateDevicePath()
Boot
Protocol Handler
Locates a device handle supporting a specific protocol and having the closest matching device path. UEFI drivers should use the services on the ControllerHandle passed into the Supported() and Start() functions of the driver's EFI_DRIVER_BINDING_PROTOCOL.
LoadImage()
Boot
Image
Used only by bus drivers that can load, start, and potentially unload UEFI drivers stored in other images in some other location on the child devices of the bus.
StartImage()
Boot
Image
Used only by bus drivers that can load, start, and potentially unload UEFI drivers stored in other images in some other location on the child devices of the bus.
GetVariable()
Runtime
Variable
Returns the value of a variable.
SetVariable()
Runtime
Variable
Sets the value of a variable.
QueryVariableInfo()
Runtime
Variable
Returns information about the EFI variables.
GetTime()
Runtime
Time-related
Returns the current time and date, and the time-keeping capabilities of the platform.
CalculateCrc32()
Boot
Miscellaneous
Maintains the checksum of the UEFI System Table, UEFI boot services table, and UEFI runtime services table.
ConvertPointer()
Runtime
Miscellaneous
Sometimes used by UEFI runtime drivers. This service should never be used by UEFI boot service drivers.
InstallConfigurationTable()
Boot
Miscellaneous
Adds, updates, or removes a configuration table from the UEFI system table.
WaitForEvent()
Boot
Event
Stops execution until an event is signaled.
GetNextMonotonicCount()
Boot
Special
Provides a 64-bit monotonic counter that is guaranteed to increase.
Previous
5.1.7 Stall()
Next
5.2.1 ConnectController() and DisconnectController()
Last modified 2yr ago
Copy link