summaryrefslogtreecommitdiffstats
path: root/Documentation/gpu/drm-uapi.rst
diff options
context:
space:
mode:
authorDesmond Cheong Zhi Xi <desmondcheongzx@gmail.com>2021-07-28 18:27:39 +0800
committerDaniel Vetter <daniel.vetter@ffwll.ch>2021-07-29 09:12:01 +0200
commitd793b8f732d6acbc6390be7342fb2e92b069dc7f (patch)
tree95ccc7c3a10688188584de4ff7c0562adeb9562d /Documentation/gpu/drm-uapi.rst
parent7835ed6a9e868376c3d7758d017fcfb34e35b8bc (diff)
downloadlinux-stable-d793b8f732d6acbc6390be7342fb2e92b069dc7f.tar.gz
linux-stable-d793b8f732d6acbc6390be7342fb2e92b069dc7f.tar.bz2
linux-stable-d793b8f732d6acbc6390be7342fb2e92b069dc7f.zip
drm: clarify usage of drm leases
We make the following changes to the documentation of drm leases to make it easier to reason about their usage. In particular, we clarify the lifetime and locking rules of lease fields in drm_master: 1. Make it clear that &drm_device.mode_config.idr_mutex protects the lease idr and list structures for drm_master. The lessor field itself doesn't need to be protected as it doesn't change after it's set in drm_lease_create. 2. Add descriptions for the lifetime of lessors and leases. 3. Add an overview DOC: section in drm-uapi.rst that defines the terminology for drm leasing, and explains how leases work and why they're used. Signed-off-by: Desmond Cheong Zhi Xi <desmondcheongzx@gmail.com> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Link: https://patchwork.freedesktop.org/patch/msgid/20210728102739.441543-1-desmondcheongzx@gmail.com
Diffstat (limited to 'Documentation/gpu/drm-uapi.rst')
-rw-r--r--Documentation/gpu/drm-uapi.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
index 7e51dd40bf6e..199afb503ab1 100644
--- a/Documentation/gpu/drm-uapi.rst
+++ b/Documentation/gpu/drm-uapi.rst
@@ -37,6 +37,15 @@ Primary Nodes, DRM Master and Authentication
.. kernel-doc:: include/drm/drm_auth.h
:internal:
+
+.. _drm_leasing:
+
+DRM Display Resource Leasing
+============================
+
+.. kernel-doc:: drivers/gpu/drm/drm_lease.c
+ :doc: drm leasing
+
Open-Source Userspace Requirements
==================================