diff options
| author | Rob Herring <robh@kernel.org> | 2019-11-01 16:37:54 +0100 |
|---|---|---|
| committer | Rob Herring <robh@kernel.org> | 2019-11-07 00:57:42 +0100 |
| commit | 105401b659b7eb9cb42d6b5b75d5c049ad4b3dca (patch) | |
| tree | 4ee84e213d2e122d82523797ed42406463de1e72 /include/drm/drm_gem_shmem_helper.h | |
| parent | drm/atomic: fix self-refresh helpers crtc state dereference (diff) | |
| download | linux-105401b659b7eb9cb42d6b5b75d5c049ad4b3dca.tar.xz linux-105401b659b7eb9cb42d6b5b75d5c049ad4b3dca.zip | |
drm/shmem: Add docbook comments for drm_gem_shmem_object madvise fields
Add missing docbook comments to madvise fields in struct
drm_gem_shmem_object which fixes these warnings:
include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv' not described in 'drm_gem_shmem_object'
include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv_list' not described in 'drm_gem_shmem_object'
Fixes: 17acb9f35ed7 ("drm/shmem: Add madvise state and purge helpers")
Reported-by: Sean Paul <sean@poorly.run>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Signed-off-by: Rob Herring <robh@kernel.org>
Reviewed-by: Sean Paul <sean@poorly.run>
Link: https://patchwork.freedesktop.org/patch/msgid/20191101153754.22803-1-robh@kernel.org
Diffstat (limited to 'include/drm/drm_gem_shmem_helper.h')
| -rw-r--r-- | include/drm/drm_gem_shmem_helper.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/include/drm/drm_gem_shmem_helper.h b/include/drm/drm_gem_shmem_helper.h index 01f514521687..7865e6b5d36c 100644 --- a/include/drm/drm_gem_shmem_helper.h +++ b/include/drm/drm_gem_shmem_helper.h @@ -44,7 +44,20 @@ struct drm_gem_shmem_object { */ unsigned int pages_use_count; + /** + * @madv: State for madvise + * + * 0 is active/inuse. + * A negative value is the object is purged. + * Positive values are driver specific and not used by the helpers. + */ int madv; + + /** + * @madv_list: List entry for madvise tracking + * + * Typically used by drivers to track purgeable objects + */ struct list_head madv_list; /** |