[PATCH v2 4/8] v4l: vsp1: Document the vsp1_du_atomic_config structure

[Kieran Bingham]

Hi Laurent,

On 22/04/18 23:34, Laurent Pinchart wrote:
> The structure is used in the API that the VSP1 driver exposes to the DU
> driver. Documenting it is thus important.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas at ideasonboard.com>

I look forward to being reminded to add a doc-line to this structure for my
interlaced support branch which added 'bool interlaced' to this structure before
it was documented, (thus doesn't add a doc string). Maybe me writing this
comment will remind me in the future when I rebase the interlaced patches ;-)


Reviewed-by: Kieran Bingham <kieran.bingham+renesas at ideasonboard.com>

> ---
> Changes since v1:
> 
> - Fixed typo
> ---
>  include/media/vsp1.h | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/include/media/vsp1.h b/include/media/vsp1.h
> index 68a8abe4fac5..ff7ef894465d 100644
> --- a/include/media/vsp1.h
> +++ b/include/media/vsp1.h
> @@ -41,6 +41,16 @@ struct vsp1_du_lif_config {
>  int vsp1_du_setup_lif(struct device *dev, unsigned int pipe_index,
>  		      const struct vsp1_du_lif_config *cfg);
>  
> +/**
> + * struct vsp1_du_atomic_config - VSP atomic configuration parameters
> + * @pixelformat: plane pixel format (V4L2 4CC)
> + * @pitch: line pitch in bytes, for all planes
> + * @mem: DMA memory address for each plane of the frame buffer
> + * @src: source rectangle in the frame buffer (integer coordinates)
> + * @dst: destination rectangle on the display (integer coordinates)
> + * @alpha: alpha value (0: fully transparent, 255: fully opaque)
> + * @zpos: Z position of the plane (from 0 to number of planes minus 1)
> + */
>  struct vsp1_du_atomic_config {
>  	u32 pixelformat;
>  	unsigned int pitch;
> 

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <https://lists.freedesktop.org/archives/dri-devel/attachments/20180428/2237406e/attachment.sig>