Fuchsia's [driver framework](https://fuchsia.dev/docs/concepts/drivers/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](https://fuchsia.dev/docs/concepts/drivers/README) under the **Fundamentals**
section.

## Sections

- [**DFv1 to DFv2 driver migration**](https://fuchsia.dev/fuchsia-src/development/drivers/migration/README): Migrate existing legacy DFv1 drivers to the new driver framework (DFv2).
- [**DFv2 driver development**](https://fuchsia.dev/fuchsia-src/development/drivers/dfv2-overview.md.txt): Create new DFv2 drivers using the [Fuchsia source checkout](https://fuchsia.dev/docs/get-started/get_fuchsia_source) development setup.
- [**Fuchsia driver development**](https://fuchsia.dev/fuchsia-src/development/drivers/developer_guide/driver-development.md.txt): Build, debug, and test drivers.
- [**DFv1 concepts**](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/fdf.md.txt): Understand concepts specific to the legacy driver framework (DFv1).
- [**Driver-specific guides**](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/driver_development/gpio-initialization.md.txt): Explore examples and best practices unique to specific drivers.
- [**Others**](https://fuchsia.dev/fuchsia-src/development/drivers/best_practices/deleting.md.txt): Additional information related to Fuchsia driver development.

## Table of contents

### DFv1 to DFv2 driver migration

- [Overview](https://fuchsia.dev/fuchsia-src/development/drivers/migration/README)
- [1. Migrate from DFv1 to DFv2](https://fuchsia.dev/fuchsia-src/development/drivers/migration/migrate-from-dfv1-to-dfv2/overview.md.txt)
- [2. Migrate from Banjo to FIDL](https://fuchsia.dev/fuchsia-src/development/drivers/migration/migrate-from-banjo-to-fidl/overview.md.txt)
- Extensions

  - [Set up the compat device server in a DFv2 driver](https://fuchsia.dev/fuchsia-src/development/drivers/migration/set-up-compat-device-server.md.txt)
  - [Connect and serve Banjo protocols in a DFv2 driver](https://fuchsia.dev/fuchsia-src/development/drivers/migration/serve-banjo-protocols.md.txt)
  - [Advertise services in a DFv2 driver](https://fuchsia.dev/docs/concepts/drivers/driver_communication)

### DFv2 driver development

- [Overview](https://fuchsia.dev/fuchsia-src/development/drivers/dfv2-overview.md.txt)

- How-to

  - [Write a minimal DFv2 driver](https://fuchsia.dev/fuchsia-src/development/drivers/developer_guide/write-a-minimal-dfv2-driver.md.txt)
  - [Driver examples](https://fuchsia.dev/fuchsia-src/development/drivers/developer_guide/driver-examples.md.txt)
- Tutorials

  - [Create a composite node](https://fuchsia.dev/fuchsia-src/development/drivers/developer_guide/create-a-composite-node.md.txt)
  - [Bind rules tutorial](https://fuchsia.dev/fuchsia-src/development/drivers/tutorials/bind-rules-tutorial.md.txt)
  - [Bind library code generation tutorial](https://fuchsia.dev/fuchsia-src/development/drivers/tutorials/bind-libraries-codegen.md.txt)
  - [FIDL tutorial](https://fuchsia.dev/fuchsia-src/development/drivers/tutorials/fidl-tutorial.md.txt)
  - [Metadata tutorial](https://fuchsia.dev/fuchsia-src/development/drivers/tutorials/metadata-tutorial.md.txt)
- Debugging

  - [Troubleshoot common issues in DFv2 driver development](https://fuchsia.dev/fuchsia-src/development/drivers/developer_guide/troubleshoot-common-issues.md.txt)
  - [Driver utilities](https://fuchsia.dev/fuchsia-src/development/drivers/diagnostics/driver-utils.md.txt)
- Testing

  - [DriverTestRealm](https://fuchsia.dev/fuchsia-src/development/drivers/testing/driver_test_realm.md.txt)
  - [Device enumeration tests](https://fuchsia.dev/fuchsia-src/development/drivers/testing/device_enumeration.md.txt)
  - [Threading tips in tests](https://fuchsia.dev/fuchsia-src/development/drivers/testing/threading-tips-in-tests.md.txt)
- Best practices

  - [VMO registration pattern](https://fuchsia.dev/fuchsia-src/development/drivers/best_practices/vmo-registration-pattern.md.txt)
  - [Driver stack performance](https://fuchsia.dev/fuchsia-src/development/drivers/best_practices/driver_stack_performance.md.txt)
  - [Device firmware](https://fuchsia.dev/fuchsia-src/development/drivers/best_practices/firmware)
- Guidelines

  - [Driver runtime API guidelines](https://fuchsia.dev/fuchsia-src/development/drivers/developer_guide/driver-runtime-api-guidelines.md.txt)
  - [Drivers C++ rubric](https://fuchsia.dev/fuchsia-src/development/drivers/developer_guide/cpp-rubric.md.txt)
  - [Drivers Rust rubric](https://fuchsia.dev/fuchsia-src/development/drivers/developer_guide/rust-rubric.md.txt)
- Concepts

  - [DMA (Direct Memory Access)](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/driver_development/dma.md.txt)

### Fuchsia driver development

- [Fuchsia driver development](https://fuchsia.dev/fuchsia-src/development/drivers/developer_guide/driver-development.md.txt)
- [Building drivers](https://fuchsia.dev/fuchsia-src/development/drivers/best_practices/build.md.txt)
- [Interrupts](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/driver_development/interrupts.md.txt)
- [Platform Bus](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/device_driver_model/platform-bus.md.txt)

- Testing

  - [Driver testing](https://fuchsia.dev/fuchsia-src/development/drivers/testing/overview.md.txt)
- Debugging

  - [Using Inspect for drivers](https://fuchsia.dev/fuchsia-src/development/drivers/diagnostics/inspect.md.txt)
  - [Driver Logging](https://fuchsia.dev/fuchsia-src/development/drivers/diagnostics/logging.md.txt)
  - [Add tracing to a driver](https://fuchsia.dev/fuchsia-src/development/drivers/diagnostics/tracing.md.txt)

### DFv1 concepts

- [Fuchsia Driver Framework](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/fdf.md.txt)
- Device driver model

  - [Overview](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/device_driver_model/README)
  - [Introduction](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/device_driver_model/introduction.md.txt)
  - [Device model](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/device_driver_model/device-model.md.txt)
  - [Driver binding](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/device_driver_model/driver-binding.md.txt)
  - [The Device ops](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/device_driver_model/device-ops.md.txt)
  - [Device power management](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/device_driver_model/device-power.md.txt)
  - [Protocols in drivers](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/device_driver_model/protocol.md.txt)

### Driver-specific guides

- Board drivers
  - [GPIO initialization](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/driver_development/gpio-initialization.md.txt)
- Display drivers
  - [Display hardware overview](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/display/hardware.md.txt)
  - [Developing drivers for new display hardware](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/display/new-driver-guide.md.txt)
  - [Display Coordinator terms for configuration states](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/display/config-states.md.txt)
  - [Referencing information sources in Fuchsia display drivers](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/display/referencing.md.txt)
  - [Principles for modern register definitions](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/display/register-definitions.md.txt)
  - [Rubric for display drivers written in Rust](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/display/rust-rubric.md.txt)
- PCI drivers
  - [Configuration](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/driver_development/bar.md.txt)
- Registers
  - [Registers overview](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/registers/overview.md.txt)
- USB drivers
  - [Getting descriptors and endpoints from USB](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/usb/getting_descriptors_and_endpoints.md.txt)
  - [USB system overview](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/usb/concepts/overview.md.txt)
  - [Lifecycle of a USB request](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/usb/concepts/request-lifecycle.md.txt)
  - [USB mass storage driver](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/usb/concepts/usb-mass-storage.md.txt)
- Input drivers
  - [Fuchsia input drivers](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/driver_architectures/input_drivers/input.md.txt)
  - [Input report reader library](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/driver_architectures/input_drivers/input_report_reader.md.txt)
- SDMMC drivers
  - [SDMMC drivers architecture](https://fuchsia.dev/fuchsia-src/development/drivers/concepts/driver_architectures/sdmmc_drivers/sdmmc.md.txt)
- SPMI drivers
  - [SPMI overview](https://fuchsia.dev/fuchsia-src/development/drivers/driver_guides/spmi/overview.md.txt)

### Others

- [Deleting drivers](https://fuchsia.dev/fuchsia-src/development/drivers/best_practices/deleting.md.txt)

[](https://issues.fuchsia.dev/issues/new?component=1439230&template=1881640&description=Issue+on:+https://fuchsia.dev/docs/development/drivers/README.md "Report a bug or suggest improvements on this page") [](https://cs.opensource.google/fuchsia/fuchsia/+/main:docs/development/drivers/README.md "View the source code of this page") [](https://ci.android.com/edit?repo=fuchsia/fuchsia/main&file=docs/development/drivers/README.md&cloneRepo=fuchsia/fuchsia:refs/heads/main&fullPath=fuchsia/docs/development/drivers/README.md "Edit the source code of this page")