Drivers

Fuchsia’s driver framework is a collection of libraries, tools, metadata, and components that enable developers to create, run, test, and distribute drivers for Fuchsia systems. The driver framework aims to provide a stable ABI that allows developers to write a driver once and deploy it on multiple versions of the Fuchsia platform. (However, Fuchsia's driver framework is constantly evolving and has not achieved ABI stability yet.)

Fuchsia has a new version of the driver framework (DFv2). For more information on DFv2-specific concepts, see Drivers under the Fundamentals section.

Sections

• DFv1 to DFv2 driver migration: Migrate existing legacy DFv1 drivers to the new driver framework (DFv2).
• DFv2 driver development: Create new DFv2 drivers using the Fuchsia source checkout development setup.
• DFv1 driver development: Build, debug, and test legacy DFv1 drivers.
• DFv1 concepts: Understand concepts specific to the legacy driver framework (DFv1).
• Driver-specific guides: Explore examples and best practices unique to specific drivers.
• Others: Additional information related to Fuchsia driver development.

Table of contents

DFv1 to DFv2 driver migration

• Overview
• 1. Migrate from DFv1 to DFv2
• 2. Migrate from Banjo to FIDL

• Extensions

  • Set up the compat device server in a DFv2 driver
  • Connect and serve Banjo protocols in a DFv2 driver
  • Set up devfs in a DFv2 driver

DFv2 driver development

• Overview

• How-to

  • Write a minimal DFv2 driver
  • Driver examples
  • Composite nodes

• Tutorials

  • Bind rules tutorial
  • Bind library code generation tutorial
  • FIDL tutorial
  • Metadata tutorial

• Debugging

  • Troubleshoot common issues in DFv2 driver development
  • Driver utilities

• Testing

  • DriverTestRealm
  • Threading tips in tests

• Best practices

  • VMO registration pattern
  • Driver stack performance

• Guidelines

  • Driver runtime API guidelines
  • Drivers rubric

• Concepts

  • DMA (Direct Memory Access)

DFv1 driver development

• Fuchsia driver development (DFv1)
• Building drivers
• Interrupts
• Platform Bus

• Tutorials

  • Banjo tutorial
  • Using the C++ DDK Template Library

• Testing

  • Driver testing
  • Mock DDK

• Debugging

  • Using Inspect for drivers
  • Driver Logging
  • Add tracing to a driver

DFv1 concepts

• Fuchsia Driver Framework (DFv1)

• Device driver model

  • Overview
  • Introduction
  • Device model
  • Driver binding
  • The Device ops
  • Device driver lifecycle
  • Device power management
  • Protocols in drivers
  • FIDL in drivers
  • Banjo in drivers
  • Composite devices
  • Device firmware

Driver-specific guides

• Board drivers
  • GPIO initialization
• Display drivers
  • How to write a display driver
  • Modifying board drivers
  • What does a display controller do?
• PCI drivers
  • Configuration
• Registers
  • Registers overview
• USB drivers
  • Getting descriptors and endpoints from USB
  • USB system overview
  • Lifecycle of a USB request
  • USB mass storage driver
• Input drivers
  • Fuchsia input drivers
  • Input report reader library
• SDMMC drivers
  • SDMMC drivers architecture
• SPMI drivers
  • SPMI overview

Others

• Deleting drivers