linux-kernel - [PATCH] v4l: doc: clarify v4l2_mbus

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <1515422746-5971-1-git-send-email-kieran.bingham@ideasonboard.com>
Date:   Mon, 08 Jan 2018 14:45:50 +0000 (UTC)
From:   Kieran Bingham <kieran.bingham@...asonboard.com>
To:     linux-media@...r.kernel.org
Cc:     niklas.soderlund@...natech.se, linux-renesas-soc@...r.kernel.org,
        Kieran Bingham <kieran.bingham@...asonboard.com>,
        Kieran Bingham <kieran.bingham+renesas@...asonboard.com>,
        Mauro Carvalho Chehab <mchehab@...nel.org>,
        Hans Verkuil <hverkuil@...all.nl>,
        Archit Taneja <architt@...eaurora.org>,
        Sean Paul <seanpaul@...omium.org>,
        Neil Armstrong <narmstrong@...libre.com>,
        linux-kernel@...r.kernel.org (open list)
Subject: [PATCH] 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 by referencing 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: Kieran Bingham <kieran.bingham+renesas@...asonboard.com>
---
 Documentation/media/uapi/v4l/subdev-formats.rst | 6 ++++--
 include/uapi/linux/v4l2-mediabus.h              | 4 ++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/Documentation/media/uapi/v4l/subdev-formats.rst b/Documentation/media/uapi/v4l/subdev-formats.rst
index b1eea44550e1..a2a00202b430 100644
--- a/Documentation/media/uapi/v4l/subdev-formats.rst
+++ b/Documentation/media/uapi/v4l/subdev-formats.rst
@@ -16,10 +16,12 @@ Media Bus Formats
 
     * - __u32
       - ``width``
-      - Image width, in pixels.
+      - Image width in pixels. See struct
+	:c:type:`v4l2_pix_format`.
     * - __u32
       - ``height``
-      - Image height, in pixels.
+      - Image height in pixels. See struct
+	:c:type:`v4l2_pix_format`.
     * - __u32
       - ``code``
       - Format code, from enum
diff --git a/include/uapi/linux/v4l2-mediabus.h b/include/uapi/linux/v4l2-mediabus.h
index 6e20de63ec59..6b34108d0338 100644
--- a/include/uapi/linux/v4l2-mediabus.h
+++ b/include/uapi/linux/v4l2-mediabus.h
@@ -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 (see struct v4l2_pix_format)
  * @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)
-- 
2.7.4