Linux GPU Driver Developer’s Guide

• Introduction
  • Style Guidelines
  • Getting Started
  • Contribution Process
    • Feature Merge Deadlines
    • Code of Conduct
• DRM Internals
  • Driver Initialization
    • Driver Information
      • Driver Features
      • Major, Minor and Patchlevel
      • Name, Description and Date
    • Device Instance and Driver Handling
    • Driver Load
      • IRQ Helper Library
      • Memory Manager Initialization
      • Miscellaneous Device Configuration
    • Bus-specific Device Registration and PCI Support
  • Open/Close, File Operations and IOCTLs
    • File Operations
  • Misc Utilities
    • Printer
  • Legacy Support Code
    • Legacy Suspend/Resume
    • Legacy DMA Services
• DRM Memory Management
  • The Translation Table Manager (TTM)
    • TTM initialization
  • The Graphics Execution Manager (GEM)
    • GEM Initialization
    • GEM Objects Creation
    • GEM Objects Lifetime
    • GEM Objects Naming
    • GEM Objects Mapping
    • Memory Coherency
    • Command Execution
    • GEM Function Reference
    • GEM CMA Helper Functions Reference
  • VMA Offset Manager
  • PRIME Buffer Sharing
    • Overview and Driver Interface
    • PRIME Helper Functions
    • PRIME Function References
  • DRM MM Range Allocator
    • Overview
    • LRU Scan/Eviction Support
    • DRM MM Range Allocator Function References
  • DRM Cache Handling
  • DRM Sync Objects
• Kernel Mode Setting (KMS)
  • Overview
  • KMS Core Structures and Functions
  • Modeset Base Object Abstraction
  • Atomic Mode Setting
    • Atomic Mode Setting Function Reference
  • CRTC Abstraction
    • CRTC Functions Reference
  • Frame Buffer Abstraction
    • Frame Buffer Functions Reference
  • DRM Format Handling
  • Dumb Buffer Objects
  • Plane Abstraction
    • Plane Functions Reference
  • Display Modes Function Reference
  • Connector Abstraction
    • Connector Functions Reference
  • Encoder Abstraction
    • Encoder Functions Reference
  • KMS Initialization and Cleanup
    • CRTCs (struct drm_crtc)
      • CRTC Initialization
    • Cleanup
    • Output discovery and initialization example
  • KMS Locking
  • KMS Properties
    • Property Types and Blob Property Support
    • Standard Connector Properties
    • Plane Composition Properties
    • Color Management Properties
    • Tile Group Property
    • Explicit Fencing Properties
    • Existing KMS Properties
  • Vertical Blanking
    • Vertical Blanking and Interrupt Handling Functions Reference
• Mode Setting Helper Functions
  • Modeset Helper Reference for Common Vtables
  • Atomic Modeset Helper Functions Reference
    • Overview
    • Implementing Asynchronous Atomic Commit
    • Atomic State Reset and Initialization
    • Helper Functions Reference
  • Legacy CRTC/Modeset Helper Functions Reference
  • Simple KMS Helper Reference
  • fbdev Helper Functions Reference
  • Framebuffer CMA Helper Functions Reference
  • Bridges
    • Overview
    • Default bridge callback sequence
    • Bridge Helper Reference
    • Panel-Bridge Helper Reference
  • Panel Helper Reference
  • Display Port Helper Functions Reference
  • Display Port Dual Mode Adaptor Helper Functions Reference
  • Display Port MST Helper Functions Reference
  • MIPI DSI Helper Functions Reference
  • Output Probing Helper Functions Reference
  • EDID Helper Functions Reference
  • SCDC Helper Functions Reference
  • Rectangle Utilities Reference
  • HDMI Infoframes Helper Reference
  • Flip-work Helper Reference
  • Plane Helper Reference
  • Auxiliary Modeset Helpers
• Userland interfaces
  • libdrm Device Lookup
  • Primary Nodes, DRM Master and Authentication
  • Open-Source Userspace Requirements
  • Render nodes
  • IOCTL Support on Device Nodes
  • Testing and validation
    • Validating changes with IGT
    • Display CRC Support
    • Debugfs Support
  • Sysfs Support
  • VBlank event handling
• drm/i915 Intel GFX Driver
  • Core Driver Infrastructure
    • Runtime Power Management
    • Interrupt Handling
    • Intel GVT-g Guest Support(vGPU)
    • Intel GVT-g Host Support(vGPU device model)
  • Display Hardware Handling
    • Mode Setting Infrastructure
    • Frontbuffer Tracking
    • Display FIFO Underrun Reporting
    • Plane Configuration
    • Atomic Plane Helpers
    • Output Probing
    • Hotplug
    • High Definition Audio
    • Intel HDMI LPE Audio Support
    • Panel Self Refresh PSR (PSR/SRD)
    • Frame Buffer Compression (FBC)
    • Display Refresh Rate Switching (DRRS)
    • DPIO
    • CSR firmware support for DMC
    • Video BIOS Table (VBT)
    • Display clocks
    • Display PLLs
  • Memory Management and Command Submission
    • Batchbuffer Parsing
    • Batchbuffer Pools
    • Logical Rings, Logical Ring Contexts and Execlists
    • Global GTT views
    • GTT Fences and Swizzling
      • Global GTT Fence Handling
      • Hardware Tiling and Swizzling Details
    • Object Tiling IOCTLs
    • Buffer Object Eviction
    • Buffer Object Memory Shrinking
  • GuC
    • GuC-specific firmware loader
    • GuC-based command submission
    • GuC Firmware Layout
  • Tracing
    • i915_ppgtt_create and i915_ppgtt_release
    • i915_context_create and i915_context_free
    • switch_mm
  • Perf
    • Overview
    • Comparison with Core Perf
      • Issues hit with first prototype based on Core Perf
    • i915 Driver Entry Points
    • i915 Perf Stream
    • i915 Perf Observation Architecture Stream
    • All i915 Perf Internals
• drm/meson AmLogic Meson Video Processing Unit
  • Video Processing Unit
  • Video Input Unit
  • Video Post Processing
  • Video Encoder
  • Video Canvas Management
  • Video Clocks
  • HDMI Video Output
• drm/pl111 ARM PrimeCell PL111 CLCD Driver
• drm/tegra NVIDIA Tegra GPU and display driver
  • Driver Infrastructure
    • Host1x Infrastructure Reference
    • Host1x Syncpoint Reference
  • KMS driver
    • Display Controllers
      • Windows
    • Outputs
      • RGB/LVDS
      • HDMI
      • DSI
      • eDP/DP
  • Userspace Interface
    • GEM Buffers
    • Syncpoints
    • Command Stream Submission
• drm/tinydrm Driver library
  • Core functionality
  • Additional helpers
  • MIPI DBI Compatible Controllers
• drm/vc4 Broadcom VC4 Graphics Driver
  • Display Hardware Handling
    • Pixel Valve (DRM CRTC)
    • HVS
    • HVS planes
    • HDMI encoder
    • DSI encoder
    • DPI encoder
    • VEC (Composite TV out) encoder
  • Memory Management and 3D Command Submission
    • GPU buffer object (BO) management
    • V3D binner command list (BCL) validation
    • V3D render command list (RCL) generation
    • Shader validator for VC4
    • V3D Interrupts
• VGA Switcheroo
  • Modes of Use
    • Manual switching and manual power control
    • Driver power control
  • API
    • Public functions
    • Public structures
    • Public constants
    • Private structures
  • Handlers
    • apple-gmux Handler
      • Graphics mux
      • Power control
      • Backlight control
      • Public functions
• VGA Arbiter
  • vgaarb kernel/userspace ABI
  • In-kernel interface
  • libpciaccess
  • xf86VGAArbiter (X server implementation)
  • References
• drm/bridge/dw-hdmi Synopsys DesignWare HDMI Controller
  • Synopsys DesignWare HDMI Controller
    • Supported Input Formats and Encodings
• TODO list
  • Subsystem-wide refactorings
    • De-midlayer drivers
    • Switch from reference/unreference to get/put
    • Convert existing KMS drivers to atomic modesetting
    • Clean up the clipped coordination confusion around planes
    • Implement deferred fbdev setup in the helper
    • Convert early atomic drivers to async commit helpers
    • Better manual-upload support for atomic
    • Fallout from atomic KMS
    • Get rid of dev->struct_mutex from GEM drivers
  • Core refactorings
    • Use new IDR deletion interface to clean up drm_gem_handle_delete()
    • Clean up the DRM header mess
    • Add missing kerneldoc for exported functions
    • Hide legacy cruft better
    • Make panic handling work
    • Clean up the debugfs support
  • Better Testing
    • Enable trinity for DRM
    • Make KMS tests in i-g-t generic
    • Create a virtual KMS driver for testing (vkms)
  • Driver Specific
    • tinydrm
  • Outside DRM