Documentation/gpu/drm-internals.rst

   1 =============
   2 DRM Internals
   3 =============
   4
   5 This chapter documents DRM internals relevant to driver authors and
   6 developers working to add support for the latest features to existing
   7 drivers.
   8
   9 First, we go over some typical driver initialization requirements, like
  10 setting up command buffers, creating an initial output configuration,
  11 and initializing core services. Subsequent sections cover core internals
  12 in more detail, providing implementation notes and examples.
  13
  14 The DRM layer provides several services to graphics drivers, many of
  15 them driven by the application interfaces it provides through libdrm,
  16 the library that wraps most of the DRM ioctls. These include vblank
  17 event handling, memory management, output management, framebuffer
  18 management, command submission & fencing, suspend/resume support, and
  19 DMA services.
  20
  21 Driver Initialization
  22 =====================
  23
  24 At the core of every DRM driver is a :c:type:`struct drm_driver
  25 <drm_driver>` structure. Drivers typically statically initialize
  26 a drm_driver structure, and then pass it to
  27 :c:func:`drm_dev_alloc()` to allocate a device instance. After the
  28 device instance is fully initialized it can be registered (which makes
  29 it accessible from userspace) using :c:func:`drm_dev_register()`.
  30
  31 The :c:type:`struct drm_driver <drm_driver>` structure
  32 contains static information that describes the driver and features it
  33 supports, and pointers to methods that the DRM core will call to
  34 implement the DRM API. We will first go through the :c:type:`struct
  35 drm_driver <drm_driver>` static information fields, and will
  36 then describe individual operations in details as they get used in later
  37 sections.
  38
  39 Driver Information
  40 ------------------
  41
  42 Major, Minor and Patchlevel
  43 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  44
  45 int major; int minor; int patchlevel;
  46 The DRM core identifies driver versions by a major, minor and patch
  47 level triplet. The information is printed to the kernel log at
  48 initialization time and passed to userspace through the
  49 DRM_IOCTL_VERSION ioctl.
  50
  51 The major and minor numbers are also used to verify the requested driver
  52 API version passed to DRM_IOCTL_SET_VERSION. When the driver API
  53 changes between minor versions, applications can call
  54 DRM_IOCTL_SET_VERSION to select a specific version of the API. If the
  55 requested major isn't equal to the driver major, or the requested minor
  56 is larger than the driver minor, the DRM_IOCTL_SET_VERSION call will
  57 return an error. Otherwise the driver's set_version() method will be
  58 called with the requested version.
  59
  60 Name, Description and Date
  61 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  62
  63 char \*name; char \*desc; char \*date;
  64 The driver name is printed to the kernel log at initialization time,
  65 used for IRQ registration and passed to userspace through
  66 DRM_IOCTL_VERSION.
  67
  68 The driver description is a purely informative string passed to
  69 userspace through the DRM_IOCTL_VERSION ioctl and otherwise unused by
  70 the kernel.
  71
  72 The driver date, formatted as YYYYMMDD, is meant to identify the date of
  73 the latest modification to the driver. However, as most drivers fail to
  74 update it, its value is mostly useless. The DRM core prints it to the
  75 kernel log at initialization time and passes it to userspace through the
  76 DRM_IOCTL_VERSION ioctl.
  77
  78 Device Instance and Driver Handling
  79 -----------------------------------
  80
  81 .. kernel-doc:: drivers/gpu/drm/drm_drv.c
  82    :doc: driver instance overview
  83
  84 .. kernel-doc:: include/drm/drm_device.h
  85    :internal:
  86
  87 .. kernel-doc:: include/drm/drm_drv.h
  88    :internal:
  89
  90 .. kernel-doc:: drivers/gpu/drm/drm_drv.c
  91    :export:
  92
  93 Driver Load
  94 -----------
  95
  96 Component Helper Usage
  97 ~~~~~~~~~~~~~~~~~~~~~~
  98
  99 .. kernel-doc:: drivers/gpu/drm/drm_drv.c
 100    :doc: component helper usage recommendations
 101
 102 IRQ Helper Library
 103 ~~~~~~~~~~~~~~~~~~
 104
 105 .. kernel-doc:: drivers/gpu/drm/drm_irq.c
 106    :doc: irq helpers
 107
 108 .. kernel-doc:: drivers/gpu/drm/drm_irq.c
 109    :export:
 110
 111 Memory Manager Initialization
 112 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 113
 114 Every DRM driver requires a memory manager which must be initialized at
 115 load time. DRM currently contains two memory managers, the Translation
 116 Table Manager (TTM) and the Graphics Execution Manager (GEM). This
 117 document describes the use of the GEM memory manager only. See ? for
 118 details.
 119
 120 Miscellaneous Device Configuration
 121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 122
 123 Another task that may be necessary for PCI devices during configuration
 124 is mapping the video BIOS. On many devices, the VBIOS describes device
 125 configuration, LCD panel timings (if any), and contains flags indicating
 126 device state. Mapping the BIOS can be done using the pci_map_rom()
 127 call, a convenience function that takes care of mapping the actual ROM,
 128 whether it has been shadowed into memory (typically at address 0xc0000)
 129 or exists on the PCI device in the ROM BAR. Note that after the ROM has
 130 been mapped and any necessary information has been extracted, it should
 131 be unmapped; on many devices, the ROM address decoder is shared with
 132 other BARs, so leaving it mapped could cause undesired behaviour like
 133 hangs or memory corruption.
 134
 135 Bus-specific Device Registration and PCI Support
 136 ------------------------------------------------
 137
 138 A number of functions are provided to help with device registration. The
 139 functions deal with PCI and platform devices respectively and are only
 140 provided for historical reasons. These are all deprecated and shouldn't
 141 be used in new drivers. Besides that there's a few helpers for pci
 142 drivers.
 143
 144 .. kernel-doc:: drivers/gpu/drm/drm_pci.c
 145    :export:
 146
 147 Open/Close, File Operations and IOCTLs
 148 ======================================
 149
 150 .. _drm_driver_fops:
 151
 152 File Operations
 153 ---------------
 154
 155 .. kernel-doc:: drivers/gpu/drm/drm_file.c
 156    :doc: file operations
 157
 158 .. kernel-doc:: include/drm/drm_file.h
 159    :internal:
 160
 161 .. kernel-doc:: drivers/gpu/drm/drm_file.c
 162    :export:
 163
 164 Misc Utilities
 165 ==============
 166
 167 Printer
 168 -------
 169
 170 .. kernel-doc:: include/drm/drm_print.h
 171    :doc: print
 172
 173 .. kernel-doc:: include/drm/drm_print.h
 174    :internal:
 175
 176 .. kernel-doc:: drivers/gpu/drm/drm_print.c
 177    :export:
 178
 179 Utilities
 180 ---------
 181
 182 .. kernel-doc:: include/drm/drm_util.h
 183    :doc: drm utils
 184
 185 .. kernel-doc:: include/drm/drm_util.h
 186    :internal:
 187
 188
 189 Legacy Support Code
 190 ===================
 191
 192 The section very briefly covers some of the old legacy support code
 193 which is only used by old DRM drivers which have done a so-called
 194 shadow-attach to the underlying device instead of registering as a real
 195 driver. This also includes some of the old generic buffer management and
 196 command submission code. Do not use any of this in new and modern
 197 drivers.
 198
 199 Legacy Suspend/Resume
 200 ---------------------
 201
 202 The DRM core provides some suspend/resume code, but drivers wanting full
 203 suspend/resume support should provide save() and restore() functions.
 204 These are called at suspend, hibernate, or resume time, and should
 205 perform any state save or restore required by your device across suspend
 206 or hibernate states.
 207
 208 int (\*suspend) (struct drm_device \*, pm_message_t state); int
 209 (\*resume) (struct drm_device \*);
 210 Those are legacy suspend and resume methods which *only* work with the
 211 legacy shadow-attach driver registration functions. New driver should
 212 use the power management interface provided by their bus type (usually
 213 through the :c:type:`struct device_driver <device_driver>`
 214 dev_pm_ops) and set these methods to NULL.
 215
 216 Legacy DMA Services
 217 -------------------
 218
 219 This should cover how DMA mapping etc. is supported by the core. These
 220 functions are deprecated and should not be used.