[PATCH 8/8] drm/i915: Integrate kerneldoc for atomic plane helpers

Matt Roper
2014-11-13T22:53:15Z

Signed-off-by: Matt Roper <matthew.d.roper@intel.com>
---
Documentation/DocBook/drm.tmpl | 5 +++++
drivers/gpu/drm/i915/intel_atomic_plane.c | 10 ++++++++++
2 files changed, 15 insertions(+)

diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl
index 9449cd6..fefee7d 100644
--- a/Documentation/DocBook/drm.tmpl
+++ b/Documentation/DocBook/drm.tmpl
@@ -3879,6 +3879,11 @@ int num_ioctls;</synopsis>

</sect2>
<sect2>
+ Atomic Plane Helpers
+!Pdrivers/gpu/drm/i915/intel_atomic_plane.c atomic plane helpers
+!Idrivers/gpu/drm/i915/intel_atomic_plane.c
+ </sect2>
+ <sect2>
Output Probing

This section covers output probing and related infrastructure like the
diff --git a/drivers/gpu/drm/i915/intel_atomic_plane.c b/drivers/gpu/drm/i915/intel_atomic_plane.c
index 7c039bf..b0c319c 100644
--- a/drivers/gpu/drm/i915/intel_atomic_plane.c
+++ b/drivers/gpu/drm/i915/intel_atomic_plane.c
@@ -21,6 +21,16 @@
* DEALINGS IN THE SOFTWARE.
*/

+/**
+ * DOC: atomic plane helper support
+ *
+ * The functions here are used by the atomic plane helper functions to
+ * implement legacy plane updates (i.e., drm_plane->update_plane() and
+ * drm_plane->disable_plane()). This allows plane updates to use the
+ * atomic state infrastructure and perform plane updates as separate
+ * prepare/check/commit/cleanup steps.
+ */
+
#include <drm/drmP.h>
#include <drm/drm_atomic_helper.h>
#include <drm/drm_plane_helper.h>
--
1.8.5.1