[PATCH v2] drm: pl111: Update documentation

[Daniel Vetter]

On Mon, Jul 20, 2020 at 03:03:27PM +0200, Linus Walleij wrote:
> Remove notes about migrating from the old driver which is
> retired as all users are now migrated.
> 
> Update the text to reflect that we support PL110 and PL111
> alike.
> 
> Drop the bullet on memory bandwidth scaling: this has been
> implemented.
> 
> Cc: Russell King <linux at armlinux.org.uk>
> Signed-off-by: Linus Walleij <linus.walleij at linaro.org>
> ---
> ChangeLog v1->v2:
> - Fix up the documentation rst link as well so we don't
>   get build failures in the documentation.

I'm always happy when people take care of the docs.

Acked-by: Daniel Vetter <daniel.vetter at ffwll.ch>
> ---
>  Documentation/gpu/pl111.rst       |  8 ++++----
>  drivers/gpu/drm/pl111/pl111_drv.c | 20 +++++---------------
>  2 files changed, 9 insertions(+), 19 deletions(-)
> 
> diff --git a/Documentation/gpu/pl111.rst b/Documentation/gpu/pl111.rst
> index 9b03736d33dd..6d9a1b59a545 100644
> --- a/Documentation/gpu/pl111.rst
> +++ b/Documentation/gpu/pl111.rst
> @@ -1,6 +1,6 @@
> -==========================================
> - drm/pl111 ARM PrimeCell PL111 CLCD Driver
> -==========================================
> +====================================================
> + drm/pl111 ARM PrimeCell PL110 and PL111 CLCD Driver
> +====================================================
>  
>  .. kernel-doc:: drivers/gpu/drm/pl111/pl111_drv.c
> -   :doc: ARM PrimeCell PL111 CLCD Driver
> +   :doc: ARM PrimeCell PL110 and PL111 CLCD Driver
> diff --git a/drivers/gpu/drm/pl111/pl111_drv.c b/drivers/gpu/drm/pl111/pl111_drv.c
> index 96e58fda75d8..46b0d1c4a16c 100644
> --- a/drivers/gpu/drm/pl111/pl111_drv.c
> +++ b/drivers/gpu/drm/pl111/pl111_drv.c
> @@ -10,18 +10,11 @@
>   */
>  
>  /**
> - * DOC: ARM PrimeCell PL111 CLCD Driver
> + * DOC: ARM PrimeCell PL110 and PL111 CLCD Driver
>   *
> - * The PL111 is a simple LCD controller that can support TFT and STN
> - * displays.  This driver exposes a standard KMS interface for them.
> - *
> - * This driver uses the same Device Tree binding as the fbdev CLCD
> - * driver.  While the fbdev driver supports panels that may be
> - * connected to the CLCD internally to the CLCD driver, in DRM the
> - * panels get split out to drivers/gpu/drm/panels/.  This means that,
> - * in converting from using fbdev to using DRM, you also need to write
> - * a panel driver (which may be as simple as an entry in
> - * panel-simple.c).
> + * The PL110/PL111 is a simple LCD controller that can support TFT
> + * and STN displays. This driver exposes a standard KMS interface
> + * for them.
>   *
>   * The driver currently doesn't expose the cursor.  The DRM API for
>   * cursors requires support for 64x64 ARGB8888 cursor images, while
> @@ -29,16 +22,13 @@
>   * cursors.  While one could imagine trying to hack something together
>   * to look at the ARGB8888 and program reasonable in monochrome, we
>   * just don't expose the cursor at all instead, and leave cursor
> - * support to the X11 software cursor layer.
> + * support to the application software cursor layer.
>   *
>   * TODO:
>   *
>   * - Fix race between setting plane base address and getting IRQ for
>   *   vsync firing the pageflip completion.
>   *
> - * - Use the "max-memory-bandwidth" DT property to filter the
> - *   supported formats.
> - *
>   * - Read back hardware state at boot to skip reprogramming the
>   *   hardware when doing a no-op modeset.
>   *
> -- 
> 2.26.2
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch