From mboxrd@z Thu Jan 1 00:00:00 1970 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933779AbeAHOw3 (ORCPT + 1 other); Mon, 8 Jan 2018 09:52:29 -0500 Received: from o1.7nn.fshared.sendgrid.net ([167.89.55.65]:14535 "EHLO o1.7nn.fshared.sendgrid.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932200AbeAHOw1 (ORCPT ); Mon, 8 Jan 2018 09:52:27 -0500 X-Greylist: delayed 330 seconds by postgrey-1.27 at vger.kernel.org; Mon, 08 Jan 2018 09:52:25 EST From: Kieran Bingham To: linux-media@vger.kernel.org Cc: niklas.soderlund@ragnatech.se, linux-renesas-soc@vger.kernel.org, Kieran Bingham , Kieran Bingham , Mauro Carvalho Chehab , Hans Verkuil , Archit Taneja , Sean Paul , Neil Armstrong , linux-kernel@vger.kernel.org (open list) Subject: [PATCH] v4l: doc: clarify v4l2_mbus_fmt height definition Date: Mon, 08 Jan 2018 14:45:50 +0000 (UTC) Message-Id: <1515422746-5971-1-git-send-email-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.7.4 X-SG-EID: UsLXQ589HNP4HLBydmD9pgHURQozLYm9XliudupI8YuTIuleZ5jpgztwCpu0fasLTHd7JXsup5q4lF iYRWthEGap0+SFIrYMwv8e3IvVolBBW8bukSjgMgZ22tCW7C1j30ib9cNS9k+dQf1CFomnhgoiooAo /D/o14H/9j/hYEBICaBOeDjySbOFp5g6kiVwiXTUeWzakLpirHO/1M4/Ab50d33rWIj/rp0NVcLUvd 0YfgWFETT9NARmcGeNpKKo Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Return-Path: 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 --- 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