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 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 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 and Description
  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 Module Initialization
  73 ---------------------
  74
  75 .. kernel-doc:: include/drm/drm_module.h
  76    :doc: overview
  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 Memory Manager Initialization
 103 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 104
 105 Every DRM driver requires a memory manager which must be initialized at
 106 load time. DRM currently contains two memory managers, the Translation
 107 Table Manager (TTM) and the Graphics Execution Manager (GEM). This
 108 document describes the use of the GEM memory manager only. See ? for
 109 details.
 110
 111 Miscellaneous Device Configuration
 112 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 113
 114 Another task that may be necessary for PCI devices during configuration
 115 is mapping the video BIOS. On many devices, the VBIOS describes device
 116 configuration, LCD panel timings (if any), and contains flags indicating
 117 device state. Mapping the BIOS can be done using the pci_map_rom()
 118 call, a convenience function that takes care of mapping the actual ROM,
 119 whether it has been shadowed into memory (typically at address 0xc0000)
 120 or exists on the PCI device in the ROM BAR. Note that after the ROM has
 121 been mapped and any necessary information has been extracted, it should
 122 be unmapped; on many devices, the ROM address decoder is shared with
 123 other BARs, so leaving it mapped could cause undesired behaviour like
 124 hangs or memory corruption.
 125
 126 Managed Resources
 127 -----------------
 128
 129 .. kernel-doc:: drivers/gpu/drm/drm_managed.c
 130    :doc: managed resources
 131
 132 .. kernel-doc:: drivers/gpu/drm/drm_managed.c
 133    :export:
 134
 135 .. kernel-doc:: include/drm/drm_managed.h
 136    :internal:
 137
 138 Open/Close, File Operations and IOCTLs
 139 ======================================
 140
 141 .. _drm_driver_fops:
 142
 143 File Operations
 144 ---------------
 145
 146 .. kernel-doc:: drivers/gpu/drm/drm_file.c
 147    :doc: file operations
 148
 149 .. kernel-doc:: include/drm/drm_file.h
 150    :internal:
 151
 152 .. kernel-doc:: drivers/gpu/drm/drm_file.c
 153    :export:
 154
 155 Misc Utilities
 156 ==============
 157
 158 Printer
 159 -------
 160
 161 .. kernel-doc:: include/drm/drm_print.h
 162    :doc: print
 163
 164 .. kernel-doc:: include/drm/drm_print.h
 165    :internal:
 166
 167 .. kernel-doc:: drivers/gpu/drm/drm_print.c
 168    :export:
 169
 170 Utilities
 171 ---------
 172
 173 .. kernel-doc:: include/drm/drm_util.h
 174    :doc: drm utils
 175
 176 .. kernel-doc:: include/drm/drm_util.h
 177    :internal:
 178
 179
 180 Unit testing
 181 ============
 182
 183 KUnit
 184 -----
 185
 186 KUnit (Kernel unit testing framework) provides a common framework for unit tests
 187 within the Linux kernel.
 188
 189 This section covers the specifics for the DRM subsystem. For general information
 190 about KUnit, please refer to Documentation/dev-tools/kunit/start.rst.
 191
 192 How to run the tests?
 193 ~~~~~~~~~~~~~~~~~~~~~
 194
 195 In order to facilitate running the test suite, a configuration file is present
 196 in ``drivers/gpu/drm/tests/.kunitconfig``. It can be used by ``kunit.py`` as
 197 follows:
 198
 199 .. code-block:: bash
 200
 201         $ ./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm/tests \
 202                 --kconfig_add CONFIG_VIRTIO_UML=y \
 203                 --kconfig_add CONFIG_UML_PCI_OVER_VIRTIO=y
 204
 205 .. note::
 206         The configuration included in ``.kunitconfig`` should be as generic as
 207         possible.
 208         ``CONFIG_VIRTIO_UML`` and ``CONFIG_UML_PCI_OVER_VIRTIO`` are not
 209         included in it because they are only required for User Mode Linux.
 210
 211
 212 Legacy Support Code
 213 ===================
 214
 215 The section very briefly covers some of the old legacy support code
 216 which is only used by old DRM drivers which have done a so-called
 217 shadow-attach to the underlying device instead of registering as a real
 218 driver. This also includes some of the old generic buffer management and
 219 command submission code. Do not use any of this in new and modern
 220 drivers.
 221
 222 Legacy Suspend/Resume
 223 ---------------------
 224
 225 The DRM core provides some suspend/resume code, but drivers wanting full
 226 suspend/resume support should provide save() and restore() functions.
 227 These are called at suspend, hibernate, or resume time, and should
 228 perform any state save or restore required by your device across suspend
 229 or hibernate states.
 230
 231 int (\*suspend) (struct drm_device \*, pm_message_t state); int
 232 (\*resume) (struct drm_device \*);
 233 Those are legacy suspend and resume methods which *only* work with the
 234 legacy shadow-attach driver registration functions. New driver should
 235 use the power management interface provided by their bus type (usually
 236 through the :c:type:`struct device_driver <device_driver>`
 237 dev_pm_ops) and set these methods to NULL.
 238
 239 Legacy DMA Services
 240 -------------------
 241
 242 This should cover how DMA mapping etc. is supported by the core. These
 243 functions are deprecated and should not be used.