From patchwork Fri Aug 2 01:03:21 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 2837437 Return-Path: X-Original-To: patchwork-linux-media@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 3F5CB9F3B8 for ; Fri, 2 Aug 2013 01:02:56 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 05D60202EC for ; Fri, 2 Aug 2013 01:02:55 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 3B80F20300 for ; Fri, 2 Aug 2013 01:02:54 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752706Ab3HBBCs (ORCPT ); Thu, 1 Aug 2013 21:02:48 -0400 Received: from perceval.ideasonboard.com ([95.142.166.194]:56338 "EHLO perceval.ideasonboard.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752185Ab3HBBCb (ORCPT ); Thu, 1 Aug 2013 21:02:31 -0400 Received: from avalon.ideasonboard.com (67.232-240-81.adsl-dyn.isp.belgacom.be [81.240.232.67]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id F0CE2363DC; Fri, 2 Aug 2013 03:02:11 +0200 (CEST) From: Laurent Pinchart To: linux-media@vger.kernel.org Cc: linux-sh@vger.kernel.org, Hans Verkuil , Sakari Ailus , Katsuya MATSUBARA , Sylwester Nawrocki Subject: [PATCH v5 2/9] Documentation: media: Clarify the VIDIOC_CREATE_BUFS format requirements Date: Fri, 2 Aug 2013 03:03:21 +0200 Message-Id: <1375405408-17134-3-git-send-email-laurent.pinchart+renesas@ideasonboard.com> X-Mailer: git-send-email 1.8.1.5 In-Reply-To: <1375405408-17134-1-git-send-email-laurent.pinchart+renesas@ideasonboard.com> References: <1375405408-17134-1-git-send-email-laurent.pinchart+renesas@ideasonboard.com> Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Spam-Status: No, score=-8.4 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The VIDIOC_CREATE_BUFS ioctl takes a format argument that must contain a valid format supported by the driver. Clarify the documentation. Signed-off-by: Laurent Pinchart --- Documentation/DocBook/media/v4l/vidioc-create-bufs.xml | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/Documentation/DocBook/media/v4l/vidioc-create-bufs.xml b/Documentation/DocBook/media/v4l/vidioc-create-bufs.xml index cd99436..407937a 100644 --- a/Documentation/DocBook/media/v4l/vidioc-create-bufs.xml +++ b/Documentation/DocBook/media/v4l/vidioc-create-bufs.xml @@ -69,10 +69,11 @@ the v4l2_create_buffers structure. They set the structure, to the respective stream or buffer type. count must be set to the number of required buffers. memory specifies the required I/O method. The -format field shall typically be filled in using -either the VIDIOC_TRY_FMT or -VIDIOC_G_FMT ioctl(). Additionally, applications can adjust -sizeimage fields to fit their specific needs. The +format field must be a valid format supported by the +driver. Applications shall typically fill it using either the +VIDIOC_TRY_FMT or VIDIOC_G_FMT +ioctl(). Any format that would be modified by the +VIDIOC_TRY_FMT ioctl() will be rejected with an error. The reserved array must be zeroed. When the ioctl is called with a pointer to this structure the driver @@ -144,9 +145,9 @@ mapped I/O. EINVAL - The buffer type (type field) or the -requested I/O method (memory) is not -supported. + The buffer type (type field), +requested I/O method (memory) or format +(format field) is not valid.