From: Neil Armstrong <narmstrong@baylibre.com>
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
Subject: Re: [PATCH v2 12/13] drm/meson: Add RST to bring together kerneldoc
Date: Tue, 4 Apr 2017 11:17:24 +0200 [thread overview]
Message-ID: <72fd17d0-173e-4efe-cd16-fae156a9f9f6@baylibre.com> (raw)
In-Reply-To: <20170404090049.auhtxqke3l5px5a7@phenom.ffwll.local>
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 <narmstrong@baylibre.com>
>
> \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
>
next prev parent reply other threads:[~2017-04-04 9:17 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-21 15:25 [PATCH v2 00/13] drm/meson: Initial support for HDMI Output Neil Armstrong
2017-03-21 15:25 ` [PATCH v2 01/13] drm/meson: Use crtc_state for hdisplay and fix atomic flush/enable sync for vsync commit Neil Armstrong
2017-04-04 8:49 ` Daniel Vetter
2017-03-21 15:25 ` [PATCH v2 02/13] drm/meson: Add missing HDMI register Neil Armstrong
2017-03-21 15:25 ` [PATCH v2 03/13] drm/meson: Add support for components Neil Armstrong
2017-04-04 8:59 ` Daniel Vetter
2017-04-04 9:08 ` Neil Armstrong
2017-04-04 9:09 ` Daniel Vetter
2017-03-21 15:25 ` [PATCH v2 04/13] drm/meson: venc_cvbs: no more return -ENODEV if CVBS is not available Neil Armstrong
2017-03-21 15:25 ` [PATCH v2 05/13] drm/meson: add support for HDMI clock support Neil Armstrong
2017-03-21 15:25 ` [PATCH v2 06/13] drm/meson: Add support for HDMI venc modes and settings Neil Armstrong
2017-03-21 15:25 ` [PATCH v2 07/13] drm/meson: Add support for HDMI encoder and DW-HDMI bridge + PHY Neil Armstrong
2017-04-04 8:57 ` Daniel Vetter
2017-04-04 9:16 ` Neil Armstrong
2017-04-04 13:50 ` Daniel Vetter
2017-03-21 15:25 ` [PATCH v2 08/13] ARM64: dts: meson-gx: Add shared CMA dma memory pool Neil Armstrong
2017-04-04 8:41 ` Neil Armstrong
2017-04-04 11:57 ` Kevin Hilman
2017-03-21 15:25 ` [PATCH v2 09/13] ARM64: dts: meson-gx: Add support for HDMI output Neil Armstrong
2017-04-04 8:10 ` Neil Armstrong
2017-04-04 11:57 ` Kevin Hilman
2017-03-21 15:25 ` [PATCH v2 10/13] dt-bindings: Add bindings for the Amlogic Meson dw-hdmi extension Neil Armstrong
2017-03-21 15:25 ` [PATCH v2 11/13] drm/meson: Convert existing documentation to actual kerneldoc Neil Armstrong
2017-03-21 15:25 ` [PATCH v2 12/13] drm/meson: Add RST to bring together kerneldoc Neil Armstrong
2017-04-04 9:00 ` Daniel Vetter
2017-04-04 9:17 ` Neil Armstrong [this message]
2017-03-21 15:25 ` [PATCH v2 13/13] MAINTAINERS: update files for Amlogic DRM Driver Neil Armstrong
2017-04-04 9:01 ` Daniel Vetter
2017-04-04 9:18 ` Neil Armstrong
2017-04-04 9:04 ` [PATCH v2 00/13] drm/meson: Initial support for HDMI Output Daniel Vetter
2017-04-04 9:21 ` Neil Armstrong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=72fd17d0-173e-4efe-cd16-fae156a9f9f6@baylibre.com \
--to=narmstrong@baylibre.com \
--cc=airlied@linux.ie \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-amlogic@lists.infradead.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).