From patchwork Mon Jan 8 14:45:49 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 10149711 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id A3C5A601A1 for ; Mon, 8 Jan 2018 14:52:40 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 51CF828A3A for ; Mon, 8 Jan 2018 14:52:40 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5025628A4B; Mon, 8 Jan 2018 14:52:40 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.5 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,RCVD_IN_DNSWL_HI,URIBL_GREY autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 1176128A70 for ; Mon, 8 Jan 2018 14:52:24 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933055AbeAHOwW (ORCPT ); Mon, 8 Jan 2018 09:52:22 -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 S932200AbeAHOwW (ORCPT ); Mon, 8 Jan 2018 09:52:22 -0500 X-Greylist: delayed 391 seconds by postgrey-1.27 at vger.kernel.org; Mon, 08 Jan 2018 09:52:21 EST DKIM-Signature: v=1; a=rsa-sha1; c=relaxed/relaxed; d=sendgrid.me; h=from:to:cc:subject; s=smtpapi; bh=ik4dseHXbl42atutRLl4rS5XyGw=; b=nnGIo7YC37Cpi2W+MZQ/9wTBdWr5IPStpdi87e0iJmYYQ6I58Fh2eensmsvzPr hAmXioxP3Ig1uIL9a14F+pUhvwMzomeGJO9sUEGR1jcfIfcDyzH0mMYfZ7f5ZauX yjNNM6Ji4qq/y1aH85PLq9KLd58V8FMWb3Na6b4QpfPVk= Received: by filter0022p3iad2.sendgrid.net with SMTP id filter0022p3iad2-22704-5A53841D-7 2018-01-08 14:45:49.35892299 +0000 UTC Received: from localhost.localdomain (cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233]) by ismtpd0002p1lon1.sendgrid.net (SG) with ESMTP id ZJqvgDVTSECmlRchS_r21g Mon, 08 Jan 2018 14:45:48.695 +0000 (UTC) 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:49 +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: Tfq0zQjjJFmIKL8hyrOr6KT7wyjsEm7XZZskPfLyBPLeXSNO2DlGigxP93PeTkEM9zmKH0IgZLlCXU ZfxNwaRw9lMAKTHunJ4K2VdfAr6h24nHPhFyDJb6px9ujW7js3GEZsyZOgBUZorbPEdN5pqmxenOCe L6bCMwdI08wCpqrfBFrNGM7+9o3i+/GYvtE/Kl9XBzolN5LZNdNXfC/X2VlBodbugOOSofl8CvUvzf VE146Ny48sNPg/SFmV7+4v Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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)