Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 0018147c authored by Kieran Bingham's avatar Kieran Bingham Committed by Mauro Carvalho Chehab
Browse files

media: v4l: doc: Clarify v4l2_mbus_fmt height definition 



The v4l2_mbus_fmt width and height corresponds directly with the
v4l2_pix_format definitions, yet the differences in documentation make
it ambiguous what to do in the event of field heights.

Clarify this using the same text as is provided for the v4l2_pix_format
which is explicit on the matter, and by matching the terminology of
'image height' rather than the misleading 'frame height'.

Signed-off-by: default avatarKieran Bingham <kieran.bingham+renesas@ideasonboard.com>
Acked-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: default avatarNiklas Söderlund <niklas.soderlund+renesas@ragnatech.se>
Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent c32678ea

Documentation/media/uapi/v4l/subdev-formats.rst

+6 −2
Original line number Diff line number Diff line
@@ -16,10 +16,14 @@ Media Bus Formats 


    * - __u32

      - ``width``

      - Image width, in pixels.

      - Image width in pixels.

    * - __u32

      - ``height``

      - Image height, in pixels.

      - Image height in pixels. If ``field`` is one of ``V4L2_FIELD_TOP``,

	``V4L2_FIELD_BOTTOM`` or ``V4L2_FIELD_ALTERNATE`` then height

	refers to the number of lines in the field, otherwise it refers to

	the number of lines in the frame (which is twice the field height

	for interlaced formats).

    * - __u32

      - ``code``

      - Format code, from enum

include/uapi/linux/v4l2-mediabus.h

+2 −2
Original line number Diff line number Diff line
@@ -18,8 +18,8 @@ 


/**

 * struct v4l2_mbus_framefmt - frame format on the media bus

 * @width:	frame width

 * @height:	frame height

 * @width:	image width

 * @height:	image height

 * @code:	data format code (from enum v4l2_mbus_pixelcode)

 * @field:	used interlacing type (from enum v4l2_field)

 * @colorspace:	colorspace of the data (from enum v4l2_colorspace)