2016-06-21 14:49:00 +03:00
=============
2016-06-21 14:48:58 +03:00
DRM Internals
=============
This chapter documents DRM internals relevant to driver authors and
developers working to add support for the latest features to existing
drivers.
First, we go over some typical driver initialization requirements, like
setting up command buffers, creating an initial output configuration,
and initializing core services. Subsequent sections cover core internals
in more detail, providing implementation notes and examples.
The DRM layer provides several services to graphics drivers, many of
them driven by the application interfaces it provides through libdrm,
the library that wraps most of the DRM ioctls. These include vblank
event handling, memory management, output management, framebuffer
management, command submission & fencing, suspend/resume support, and
DMA services.
Driver Initialization
2016-06-21 14:49:00 +03:00
=====================
2016-06-21 14:48:58 +03:00
At the core of every DRM driver is a :c:type:`struct drm_driver
<drm_driver> ` structure. Drivers typically statically initialize
a drm_driver structure, and then pass it to
2019-12-04 13:19:33 +03:00
drm_dev_alloc() to allocate a device instance. After the
2016-06-21 14:48:58 +03:00
device instance is fully initialized it can be registered (which makes
2019-12-04 13:19:33 +03:00
it accessible from userspace) using drm_dev_register().
2016-06-21 14:48:58 +03:00
The :c:type: `struct drm_driver <drm_driver>` structure
contains static information that describes the driver and features it
supports, and pointers to methods that the DRM core will call to
implement the DRM API. We will first go through the :c:type:`struct
drm_driver <drm_driver>` static information fields, and will
then describe individual operations in details as they get used in later
sections.
Driver Information
2016-06-21 14:49:00 +03:00
------------------
2016-06-21 14:48:58 +03:00
Major, Minor and Patchlevel
2016-06-21 14:49:02 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-06-21 14:48:58 +03:00
int major; int minor; int patchlevel;
The DRM core identifies driver versions by a major, minor and patch
level triplet. The information is printed to the kernel log at
initialization time and passed to userspace through the
DRM_IOCTL_VERSION ioctl.
The major and minor numbers are also used to verify the requested driver
API version passed to DRM_IOCTL_SET_VERSION. When the driver API
changes between minor versions, applications can call
DRM_IOCTL_SET_VERSION to select a specific version of the API. If the
requested major isn't equal to the driver major, or the requested minor
is larger than the driver minor, the DRM_IOCTL_SET_VERSION call will
return an error. Otherwise the driver's set_version() method will be
called with the requested version.
Name, Description and Date
2016-06-21 14:49:02 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-06-21 14:48:58 +03:00
char \*name; char \*desc; char \*date;
The driver name is printed to the kernel log at initialization time,
used for IRQ registration and passed to userspace through
DRM_IOCTL_VERSION.
The driver description is a purely informative string passed to
userspace through the DRM_IOCTL_VERSION ioctl and otherwise unused by
the kernel.
The driver date, formatted as YYYYMMDD, is meant to identify the date of
the latest modification to the driver. However, as most drivers fail to
update it, its value is mostly useless. The DRM core prints it to the
kernel log at initialization time and passes it to userspace through the
DRM_IOCTL_VERSION ioctl.
2021-12-22 11:28:22 +03:00
Module Initialization
---------------------
.. kernel-doc :: include/drm/drm_module.h
:doc: overview
2021-04-12 16:10:41 +03:00
Managing Ownership of the Framebuffer Aperture
----------------------------------------------
.. kernel-doc :: drivers/gpu/drm/drm_aperture.c
:doc: overview
.. kernel-doc :: include/drm/drm_aperture.h
:internal:
.. kernel-doc :: drivers/gpu/drm/drm_aperture.c
:export:
2016-06-21 14:48:58 +03:00
Device Instance and Driver Handling
2016-06-21 14:49:00 +03:00
-----------------------------------
2016-06-21 14:48:58 +03:00
.. kernel-doc :: drivers/gpu/drm/drm_drv.c
:doc: driver instance overview
2019-01-11 19:40:48 +03:00
.. kernel-doc :: include/drm/drm_device.h
:internal:
2016-11-14 14:58:20 +03:00
.. kernel-doc :: include/drm/drm_drv.h
:internal:
2017-03-02 18:16:36 +03:00
.. kernel-doc :: drivers/gpu/drm/drm_drv.c
:export:
2016-06-21 14:48:58 +03:00
Driver Load
2016-06-21 14:49:00 +03:00
-----------
2016-06-21 14:48:58 +03:00
2019-02-12 19:46:15 +03:00
Component Helper Usage
~~~~~~~~~~~~~~~~~~~~~~
.. kernel-doc :: drivers/gpu/drm/drm_drv.c
:doc: component helper usage recommendations
2016-06-21 14:48:58 +03:00
Memory Manager Initialization
2016-06-21 14:49:02 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-06-21 14:48:58 +03:00
Every DRM driver requires a memory manager which must be initialized at
load time. DRM currently contains two memory managers, the Translation
Table Manager (TTM) and the Graphics Execution Manager (GEM). This
document describes the use of the GEM memory manager only. See ? for
details.
Miscellaneous Device Configuration
2016-06-21 14:49:02 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-06-21 14:48:58 +03:00
Another task that may be necessary for PCI devices during configuration
is mapping the video BIOS. On many devices, the VBIOS describes device
configuration, LCD panel timings (if any), and contains flags indicating
device state. Mapping the BIOS can be done using the pci_map_rom()
call, a convenience function that takes care of mapping the actual ROM,
whether it has been shadowed into memory (typically at address 0xc0000)
or exists on the PCI device in the ROM BAR. Note that after the ROM has
been mapped and any necessary information has been extracted, it should
be unmapped; on many devices, the ROM address decoder is shared with
other BARs, so leaving it mapped could cause undesired behaviour like
hangs or memory corruption.
drm: add managed resources tied to drm_device
We have lots of these. And the cleanup code tends to be of dubious
quality. The biggest wrong pattern is that developers use devm_, which
ties the release action to the underlying struct device, whereas
all the userspace visible stuff attached to a drm_device can long
outlive that one (e.g. after a hotunplug while userspace has open
files and mmap'ed buffers). Give people what they want, but with more
correctness.
Mostly copied from devres.c, with types adjusted to fit drm_device and
a few simplifications - I didn't (yet) copy over everything. Since
the types don't match code sharing looked like a hopeless endeavour.
For now it's only super simplified, no groups, you can't remove
actions (but kfree exists, we'll need that soon). Plus all specific to
drm_device ofc, including the logging. Which I didn't bother to make
compile-time optional, since none of the other drm logging is compile
time optional either.
One tricky bit here is the chicken&egg between allocating your
drm_device structure and initiliazing it with drm_dev_init. For
perfect onion unwinding we'd need to have the action to kfree the
allocation registered before drm_dev_init registers any of its own
release handlers. But drm_dev_init doesn't know where exactly the
drm_device is emebedded into the overall structure, and by the time it
returns it'll all be too late. And forcing drivers to be able clean up
everything except the one kzalloc is silly.
Work around this by having a very special final_kfree pointer. This
also avoids troubles with the list head possibly disappearing from
underneath us when we release all resources attached to the
drm_device.
v2: Do all the kerneldoc at the end, to avoid lots of fairly pointless
shuffling while getting everything into shape.
v3: Add static to add/del_dr (Neil)
Move typo fix to the right patch (Neil)
v4: Enforce contract for drmm_add_final_kfree:
Use ksize() to check that the drm_device is indeed contained somewhere
in the final kfree(). Because we need that or the entire managed
release logic blows up in a pile of use-after-frees. Motivated by a
discussion with Laurent.
v5: Review from Laurent:
- %zu instead of casting size_t
- header guards
- sorting of includes
- guarding of data assignment if we didn't allocate it for a NULL
pointer
- delete spurious newline
- cast void* data parameter correctly in ->release call, no idea how
this even worked before
v6: Review from Sam
- Add the kerneldoc for the managed sub-struct back in, even if it
doesn't show up in the generated html somehow.
- Explain why __always_inline.
- Fix bisectability around the final kfree() in drm_dev_relase(). This
is just interim code which will disappear again.
- Some whitespace polish.
- Add debug output when drmm_add_action or drmm_kmalloc fail.
v7: My bisectability fix wasn't up to par as noticed by smatch.
v8: Remove unecessary {} around if else
v9: Use kstrdup_const, which requires kfree_const and introducing a free_dr()
helper (Thomas).
v10: kfree_const goes boom on the plain "kmalloc" assignment, somehow
we need to wrap that in kstrdup_const() too!! Also renumber revision
log, I somehow reset it midway thruh.
Reviewed-by: Sam Ravnborg <sam@ravnborg.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Dan Carpenter <dan.carpenter@oracle.com>
Cc: Sam Ravnborg <sam@ravnborg.org>
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Neil Armstrong <narmstrong@baylibre.com
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20200324124540.3227396-1-daniel.vetter@ffwll.ch
2020-03-24 15:45:40 +03:00
Managed Resources
-----------------
.. kernel-doc :: drivers/gpu/drm/drm_managed.c
:doc: managed resources
drm: Add docs for managed resources
All collected together to provide a consistent story in one patch,
instead of the somewhat bumpy refactor-evolution leading to this.
Also some thoughts on what the next steps could be:
- Create a macro called devm_drm_dev_alloc() which essentially wraps
the kzalloc(); devm_drm_dev_init(); drmm_add_final_kfree() combo.
Needs to be a macro since we'll have to do some typeof trickery and
casting to make this fully generic for all drivers that embed struct
drm_device into their own thing.
- A lot of the simple drivers now have essentially just
drm_dev_unplug(); drm_atomic_helper_shutdown(); as their
$bus_driver->remove hook. We could create a devm_mode_config_reset
which sets drm_atomic_helper_shutdown as it's cleanup action, and a
devm_drm_dev_register with drm_dev_unplug as it's cleanup action,
and simple drivers wouldn't have a need for a ->remove function at
all, and we could delete them.
- For more complicated drivers we need drmm_ versions of a _lot_ more
things. All the userspace visible objects (crtc, plane, encoder,
crtc), anything else hanging of those (maybe a drmm_get_edid, at
least for panels and other built-in stuff).
Also some more thoughts on why we're not reusing devm_ with maybe a
fake struct device embedded into the drm_device (we can't use the
kdev, since that's in each drm_minor).
- Code review gets extremely tricky, since every time you see a devm_
you need to carefully check whether the fake device (with the
drm_device lifetim) or the real device (with the lifetim of the
underlying physical device and driver binding) are used. That's not
going to help at all, and we have enormous amounts of drivers who
use devm_ where they really shouldn't. Having different types makes
sure the compiler type checks this for us and ensures correctness.
- The set of functions are very much non-overlapping. E.g.
devm_ioremap makes total sense, drmm_ioremap has the wrong lifetime,
since hw resources need to be cleaned out at driver unbind and wont
outlive that like a drm_device. Similar, but other way round for
drmm_connector_init (which is the only correct version, devm_ for
drm_connector is just buggy). Simply not having the wrong version
again prevents bugs.
Finally I guess this opens a huge todo for all the drivers. I'm
semi-tempted to do a tree-wide s/devm_kzalloc/drmm_kzalloc/ since most
likely that'll fix an enormous amount of bugs and most likely not
cause any issues at all (aside from maybe holding onto memory slightly
too long).
v2:
- Doc improvements from Laurent.
- Also add kerneldoc for the new drmm_add_action_or_reset.
v3:
- Remove kerneldoc for drmm_remove_action.
Reviewed-by: Sam Ravnborg <sam@ravnborg.org>
Cc: Sam Ravnborg <sam@ravnborg.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
fixup docs
Link: https://patchwork.freedesktop.org/patch/msgid/20200323144950.3018436-52-daniel.vetter@ffwll.ch
2020-03-23 17:49:50 +03:00
.. kernel-doc :: drivers/gpu/drm/drm_managed.c
:export:
.. kernel-doc :: include/drm/drm_managed.h
:internal:
2016-06-21 14:48:58 +03:00
Open/Close, File Operations and IOCTLs
2016-06-21 14:49:00 +03:00
======================================
2016-06-21 14:48:58 +03:00
2017-05-31 12:20:45 +03:00
.. _drm_driver_fops:
2016-06-21 14:48:58 +03:00
File Operations
2016-06-21 14:49:00 +03:00
---------------
2016-06-21 14:48:58 +03:00
2017-03-08 17:12:40 +03:00
.. kernel-doc :: drivers/gpu/drm/drm_file.c
2016-06-21 14:48:58 +03:00
:doc: file operations
2017-03-08 17:12:44 +03:00
.. kernel-doc :: include/drm/drm_file.h
:internal:
2017-03-08 17:12:40 +03:00
.. kernel-doc :: drivers/gpu/drm/drm_file.c
2016-06-21 14:48:58 +03:00
:export:
2016-11-05 18:08:07 +03:00
Misc Utilities
==============
Printer
-------
.. kernel-doc :: include/drm/drm_print.h
:doc: print
.. kernel-doc :: include/drm/drm_print.h
:internal:
2016-11-14 14:58:22 +03:00
.. kernel-doc :: drivers/gpu/drm/drm_print.c
2016-11-05 18:08:07 +03:00
:export:
2019-01-12 22:32:44 +03:00
Utilities
---------
.. kernel-doc :: include/drm/drm_util.h
:doc: drm utils
.. kernel-doc :: include/drm/drm_util.h
:internal:
2016-11-05 18:08:07 +03:00
2022-06-20 19:06:40 +03:00
Unit testing
============
KUnit
-----
KUnit (Kernel unit testing framework) provides a common framework for unit tests
within the Linux kernel.
This section covers the specifics for the DRM subsystem. For general information
about KUnit, please refer to Documentation/dev-tools/kunit/start.rst.
How to run the tests?
~~~~~~~~~~~~~~~~~~~~~
In order to facilitate running the test suite, a configuration file is present
in `` drivers/gpu/drm/tests/.kunitconfig `` . It can be used by `` kunit.py `` as
follows:
.. code-block :: bash
$ ./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm/tests \
--kconfig_add CONFIG_VIRTIO_UML=y \
--kconfig_add CONFIG_UML_PCI_OVER_VIRTIO=y
.. note ::
The configuration included in `` .kunitconfig `` should be as generic as
possible.
`` CONFIG_VIRTIO_UML `` and `` CONFIG_UML_PCI_OVER_VIRTIO `` are not
included in it because they are only required for User Mode Linux.
2016-06-21 14:48:58 +03:00
Legacy Support Code
2016-06-21 14:49:00 +03:00
===================
2016-06-21 14:48:58 +03:00
The section very briefly covers some of the old legacy support code
which is only used by old DRM drivers which have done a so-called
shadow-attach to the underlying device instead of registering as a real
driver. This also includes some of the old generic buffer management and
command submission code. Do not use any of this in new and modern
drivers.
Legacy Suspend/Resume
2016-06-21 14:49:00 +03:00
---------------------
2016-06-21 14:48:58 +03:00
The DRM core provides some suspend/resume code, but drivers wanting full
suspend/resume support should provide save() and restore() functions.
These are called at suspend, hibernate, or resume time, and should
perform any state save or restore required by your device across suspend
or hibernate states.
int (\*suspend) (struct drm_device \*, pm_message_t state); int
(\*resume) (struct drm_device \*);
Those are legacy suspend and resume methods which *only* work with the
legacy shadow-attach driver registration functions. New driver should
use the power management interface provided by their bus type (usually
through the :c:type: `struct device_driver <device_driver>`
dev_pm_ops) and set these methods to NULL.
Legacy DMA Services
2016-06-21 14:49:00 +03:00
-------------------
2016-06-21 14:48:58 +03:00
This should cover how DMA mapping etc. is supported by the core. These
functions are deprecated and should not be used.