Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753183AbdDDJRe (ORCPT ); Tue, 4 Apr 2017 05:17:34 -0400 Received: from mail-lf0-f44.google.com ([209.85.215.44]:33613 "EHLO mail-lf0-f44.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751082AbdDDJRd (ORCPT ); Tue, 4 Apr 2017 05:17:33 -0400 Subject: Re: [PATCH v2 12/13] drm/meson: Add RST to bring together kerneldoc To: airlied@linux.ie, linux-amlogic@lists.infradead.org, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, dri-devel@lists.freedesktop.org References: <1490109950-21421-1-git-send-email-narmstrong@baylibre.com> <1490109950-21421-13-git-send-email-narmstrong@baylibre.com> <20170404090049.auhtxqke3l5px5a7@phenom.ffwll.local> From: Neil Armstrong Organization: Baylibre Message-ID: <72fd17d0-173e-4efe-cd16-fae156a9f9f6@baylibre.com> Date: Tue, 4 Apr 2017 11:17:24 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.7.0 MIME-Version: 1.0 In-Reply-To: <20170404090049.auhtxqke3l5px5a7@phenom.ffwll.local> Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 3549 Lines: 111 On 04/04/2017 11:00 AM, Daniel Vetter wrote: > On Tue, Mar 21, 2017 at 04:25:49PM +0100, Neil Armstrong wrote: >> Signed-off-by: Neil Armstrong > > \o/ for kerneldoc! > > This is awesome, but I guess it's time to extract a drivers.rst sub-file > within Doc/gpu and put all the various driver docs in there? Would be > great if you could do the follow-up for that. Ok, I'll follow up on that. Thanks, Neil > > Thanks, Daniel > >> --- >> Documentation/gpu/index.rst | 1 + >> Documentation/gpu/meson.rst | 61 +++++++++++++++++++++++++++++++++++++++++++++ >> 2 files changed, 62 insertions(+) >> create mode 100644 Documentation/gpu/meson.rst >> >> diff --git a/Documentation/gpu/index.rst b/Documentation/gpu/index.rst >> index e998ee0..7eceb97 100644 >> --- a/Documentation/gpu/index.rst >> +++ b/Documentation/gpu/index.rst >> @@ -11,6 +11,7 @@ Linux GPU Driver Developer's Guide >> drm-kms-helpers >> drm-uapi >> i915 >> + meson >> tinydrm >> vc4 >> vga-switcheroo >> diff --git a/Documentation/gpu/meson.rst b/Documentation/gpu/meson.rst >> new file mode 100644 >> index 0000000..479f6f5 >> --- /dev/null >> +++ b/Documentation/gpu/meson.rst >> @@ -0,0 +1,61 @@ >> +============================================= >> +drm/meson AmLogic Meson Video Processing Unit >> +============================================= >> + >> +.. kernel-doc:: drivers/gpu/drm/meson/meson_drv.c >> + :doc: Video Processing Unit >> + >> +Video Processing Unit >> +===================== >> + >> +The Amlogic Meson Display controller is composed of several components >> +that are going to be documented below: >> + >> +.. code:: >> + >> + DMC|---------------VPU (Video Processing Unit)----------------|------HHI------| >> + | vd1 _______ _____________ _________________ | | >> + D |-------| |----| | | | | HDMI PLL | >> + D | vd2 | VIU | | Video Post | | Video Encoders |<---|-----VCLK | >> + R |-------| |----| Processing | | | | | >> + | osd2 | | | |---| Enci ----------|----|-----VDAC------| >> + R |-------| CSC |----| Scalers | | Encp ----------|----|----HDMI-TX----| >> + A | osd1 | | | Blenders | | Encl ----------|----|---------------| >> + M |-------|______|----|____________| |________________| | | >> + ___|__________________________________________________________|_______________| >> + >> +Video Input Unit >> +================ >> + >> +.. kernel-doc:: drivers/gpu/drm/meson/meson_viu.c >> + :doc: Video Input Unit >> + >> +Video Post Processing >> +===================== >> + >> +.. kernel-doc:: drivers/gpu/drm/meson/meson_vpp.c >> + :doc: Video Post Processing >> + >> +Video Encoder >> +============= >> + >> +.. kernel-doc:: drivers/gpu/drm/meson/meson_venc.c >> + :doc: Video Encoder >> + >> +Video Canvas Management >> +======================= >> + >> +.. kernel-doc:: drivers/gpu/drm/meson/meson_canvas.c >> + :doc: Canvas >> + >> +Video Clocks >> +============ >> + >> +.. kernel-doc:: drivers/gpu/drm/meson/meson_vclk.c >> + :doc: Video Clocks >> + >> +HDMI Video Output >> +================= >> + >> +.. kernel-doc:: drivers/gpu/drm/meson/meson_dw_hdmi.c >> + :doc: HDMI Output >> -- >> 1.9.1 >> >> _______________________________________________ >> dri-devel mailing list >> dri-devel@lists.freedesktop.org >> https://lists.freedesktop.org/mailman/listinfo/dri-devel >