drm/dsc: Add kernel documentation for DRM DP DSC helpers
authorManasi Navare <manasi.d.navare@intel.com>
Wed, 6 Feb 2019 21:31:48 +0000 (13:31 -0800)
committerManasi Navare <manasi.d.navare@intel.com>
Fri, 8 Feb 2019 21:38:51 +0000 (13:38 -0800)
commit05bad2357afcb9f89804f04f0ae5ac58ae898ec5
tree8d18074e82e592b2385578d8867bde2c35a4caaf
parent05f8bc82fc428dbaf41764e95167dd759769f33d
drm/dsc: Add kernel documentation for DRM DP DSC helpers

This patch adds appropriate kernel documentation for DRM DP helpers
used for enabling Display Stream compression functionality in
drm_dp_helper.h and drm_dp_helper.c as well as for the DSC spec
related structure definitions and helpers in drm_dsc.c and drm_dsc.h
Also add links between the functions and structures in the documentation.

v3:
* Fix the checkpatch warnings (Sean Paul)
v2:
* Add inline comments for longer structs (Daniel Vetter)
* Split the summary and description (Daniel Vetter)

Suggested-by: Daniel Vetter <daniel.vetter@intel.com>
Suggested-by: Sean Paul <sean@poorly.run>
Cc: Daniel Vetter <daniel.vetter@intel.com>
Cc: Sean Paul <sean@poorly.run>
Signed-off-by: Manasi Navare <manasi.d.navare@intel.com>
Acked-by: Sean Paul <sean@poorly.run>
Reviewed-by: Daniel Vetter <daniel.vetter@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20190206213148.21390-1-manasi.d.navare@intel.com
drivers/gpu/drm/drm_dp_helper.c
drivers/gpu/drm/drm_dsc.c
include/drm/drm_dp_helper.h
include/drm/drm_dsc.h