drm: clarify usage of drm leases
authorDesmond Cheong Zhi Xi <desmondcheongzx@gmail.com>
Wed, 28 Jul 2021 10:27:39 +0000 (18:27 +0800)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Thu, 29 Jul 2021 07:12:01 +0000 (09:12 +0200)
commitd793b8f732d6acbc6390be7342fb2e92b069dc7f
tree95ccc7c3a10688188584de4ff7c0562adeb9562d
parent7835ed6a9e868376c3d7758d017fcfb34e35b8bc
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
Documentation/gpu/drm-uapi.rst
drivers/gpu/drm/drm_lease.c
include/drm/drm_auth.h