From patchwork Fri Aug 28 13:31:14 2015
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Patchwork-Submitter: Philipp Zabel
X-Patchwork-Id: 7091861
Return-Path:
X-Original-To: patchwork-dri-devel@patchwork.kernel.org
Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org
Received: from mail.kernel.org (mail.kernel.org [198.145.29.136])
by patchwork1.web.kernel.org (Postfix) with ESMTP id 033B59F22E
for ;
Fri, 28 Aug 2015 13:31:34 +0000 (UTC)
Received: from mail.kernel.org (localhost [127.0.0.1])
by mail.kernel.org (Postfix) with ESMTP id 3A0B7206F7
for ;
Fri, 28 Aug 2015 13:31:33 +0000 (UTC)
Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177])
by mail.kernel.org (Postfix) with ESMTP id 4F4EB206F4
for ;
Fri, 28 Aug 2015 13:31:32 +0000 (UTC)
Received: from gabe.freedesktop.org (localhost [127.0.0.1])
by gabe.freedesktop.org (Postfix) with ESMTP id DDEF16E2FF;
Fri, 28 Aug 2015 06:31:21 -0700 (PDT)
X-Original-To: dri-devel@lists.freedesktop.org
Delivered-To: dri-devel@lists.freedesktop.org
Received: from metis.ext.pengutronix.de (metis.ext.pengutronix.de
[92.198.50.35])
by gabe.freedesktop.org (Postfix) with ESMTPS id 950496E2FF
for ;
Fri, 28 Aug 2015 06:31:19 -0700 (PDT)
Received: from paszta.hi.pengutronix.de
([2001:67c:670:100:96de:80ff:fec2:9969] helo=paszta)
by metis.ext.pengutronix.de with esmtp (Exim 4.80)
(envelope-from )
id 1ZVJkQ-0007ld-Qv; Fri, 28 Aug 2015 15:31:14 +0200
Message-ID: <1440768674.3229.13.camel@pengutronix.de>
Subject: Re: [PATCH v3 1/3] drm: add drm_of_encoder_active_endpoint helpers
From: Philipp Zabel
To: Daniel Vetter
Date: Fri, 28 Aug 2015 15:31:14 +0200
In-Reply-To: <20150827142246.GC1367@phenom.ffwll.local>
References: <1440672968-29422-1-git-send-email-p.zabel@pengutronix.de>
<1440672968-29422-2-git-send-email-p.zabel@pengutronix.de>
<20150827142246.GC1367@phenom.ffwll.local>
X-Mailer: Evolution 3.12.9-1+b1
Mime-Version: 1.0
X-SA-Exim-Connect-IP: 2001:67c:670:100:96de:80ff:fec2:9969
X-SA-Exim-Mail-From: p.zabel@pengutronix.de
X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de);
SAEximRunCond expanded to false
X-PTX-Original-Recipient: dri-devel@lists.freedesktop.org
Cc: dri-devel@lists.freedesktop.org, kernel@pengutronix.de,
Russell King ,
Grant Likely ,
Andy Yan
X-BeenThere: dri-devel@lists.freedesktop.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: Direct Rendering Infrastructure - Development
List-Unsubscribe: ,
List-Archive:
List-Post:
List-Help:
List-Subscribe: ,
Errors-To: dri-devel-bounces@lists.freedesktop.org
Sender: "dri-devel"
X-Spam-Status: No, score=-5.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED,
RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1
X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org
X-Virus-Scanned: ClamAV using ClamSMTP
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:
thanks
Philipp
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;
+ Device Tree Helper Functions
+
+ This section covers helper functions for common device tree bindings.
+
+
+!Edrivers/gpu/drm/drm_of.c
+!Iinclude/drm/drm_of.h
+!Pdrivers/gpu/drm/drm_of.c overview
+
+
+
Legacy Support Code
The section very briefly covers some of the old legacy support code which