[PATCH v3 1/3] drm: add drm_of_encoder_active_endpoint helpers

Philipp Zabel p.zabel at pengutronix.de
Fri Aug 28 06:31:14 PDT 2015


Hi Daniel,

Am Donnerstag, den 27.08.2015, 16:22 +0200 schrieb Daniel Vetter:
[...]
> > +/*
> > + * drm_of_encoder_active_endpoint - return the active encoder endpoint
> > + * @node: device tree node containing encoder input ports
> > + * @encoder: drm_encoder
> > + *
> > + * Given an encoder device node and a drm_encoder with a connected crtc,
> > + * parse the encoder endpoint connecting to the crtc port.
> > + */
> 
> Can you please write proper kerneldoc for this plus pull drm_of.c into the
> docbook template? Some overview comments in a DOC: section (maybe even
> with code snippets/examples, we can do those now in 4.3) would be even
> better.

Ok. Do you have a pointer or example how to include code snippets in
DOC: sections? Where would you put this into drm.tmpl? I could add a
device tree section at the end, before the legacy section:

diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl
index 9ddf8c6..b396fa1 100644
--- a/Documentation/DocBook/drm.tmpl
+++ b/Documentation/DocBook/drm.tmpl
@@ -3755,6 +3755,17 @@ int num_ioctls;</synopsis>
     </sect2>
   </sect1>
   <sect1>
+    <title>Device Tree Helper Functions</title>
+    <para>
+      This section covers helper functions for common device tree bindings.
+    </para>
+    <sect2>
+!Edrivers/gpu/drm/drm_of.c
+!Iinclude/drm/drm_of.h
+!Pdrivers/gpu/drm/drm_of.c overview
+    </sect2>
+  </sect1>
+  <sect1>
     <title>Legacy Support Code</title>
     <para>
       The section very briefly covers some of the old legacy support code which

thanks
Philipp



More information about the dri-devel mailing list