From mboxrd@z Thu Jan 1 00:00:00 1970 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754813AbeAHRz0 (ORCPT + 1 other); Mon, 8 Jan 2018 12:55:26 -0500 Received: from o1682455182.outbound-mail.sendgrid.net ([168.245.5.182]:28560 "EHLO o1682455182.outbound-mail.sendgrid.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753755AbeAHRzZ (ORCPT ); Mon, 8 Jan 2018 12:55:25 -0500 X-Greylist: delayed 948 seconds by postgrey-1.27 at vger.kernel.org; Mon, 08 Jan 2018 12:55:25 EST From: Kieran Bingham To: linux-media@vger.kernel.org Cc: linux-renesas-soc@vger.kernel.org, niklas.soderlund@ragnatech.se, sakari.ailus@iki.fi, Hans Verkuil , Kieran Bingham , Kieran Bingham , Mauro Carvalho Chehab , Jonathan Corbet , Archit Taneja , Neil Armstrong , linux-kernel@vger.kernel.org (open list) Subject: [PATCH v2] v4l: doc: Clarify v4l2_mbus_fmt height definition Date: Mon, 08 Jan 2018 17:55:24 +0000 (UTC) Message-Id: <1515434106-18747-1-git-send-email-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.7.4 X-SG-EID: UsLXQ589HNP4HLBydmD9pgHURQozLYm9XliudupI8YvVwHdWR6qPAzViMvJN/PPHNBYGCX8YQDAZHL bAVoo13adDdmLMvwA33Dy0pzrNOl/Z58GE+1A39HqFuw8oK8iFXhnRobkG8UHbGj9oVMJx16oJF7T2 yzCVlRrhncli/XZrQyq8xm5ck9xtV6lUjp1tj7J3yRjBKLCUHXZWYFJdSau0tBdKDv5ReuRsv9F5dY wK5JQlw4xHyjA/zO3ClRA5 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 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: Kieran Bingham --- v2: - Duplicated explicit text from v4l2_pix_format rather than referencing it. Documentation/media/uapi/v4l/subdev-formats.rst | 8 ++++++-- include/uapi/linux/v4l2-mediabus.h | 4 ++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/Documentation/media/uapi/v4l/subdev-formats.rst b/Documentation/media/uapi/v4l/subdev-formats.rst index b1eea44550e1..9fcabe7f9367 100644 --- a/Documentation/media/uapi/v4l/subdev-formats.rst +++ b/Documentation/media/uapi/v4l/subdev-formats.rst @@ -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 diff --git a/include/uapi/linux/v4l2-mediabus.h b/include/uapi/linux/v4l2-mediabus.h index 6e20de63ec59..123a231001a8 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 * @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