From patchwork Fri Feb 7 22:52:28 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sakari Ailus X-Patchwork-Id: 3608361 Return-Path: X-Original-To: patchwork-linux-media@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id D4E2DBF418 for ; Fri, 7 Feb 2014 22:49:32 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 0326320172 for ; Fri, 7 Feb 2014 22:49:32 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 9A5E92012F for ; Fri, 7 Feb 2014 22:49:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752368AbaBGWtX (ORCPT ); Fri, 7 Feb 2014 17:49:23 -0500 Received: from nblzone-211-213.nblnetworks.fi ([83.145.211.213]:45745 "EHLO hillosipuli.retiisi.org.uk" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1752054AbaBGWtU (ORCPT ); Fri, 7 Feb 2014 17:49:20 -0500 Received: from lanttu.localdomain (salottisipuli.retiisi.org.uk [IPv6:2001:1bc8:102:7fc9::83:2]) by hillosipuli.retiisi.org.uk (Postfix) with ESMTP id 62D5D60093; Sat, 8 Feb 2014 00:49:16 +0200 (EET) From: Sakari Ailus To: linux-media@vger.kernel.org Cc: k.debski@samsung.com, hverkuil@xs4all.nl, laurent.pinchart@ideasonboard.com Subject: [PATCH v4.2 4/4] v4l: Document timestamp buffer flag behaviour Date: Sat, 8 Feb 2014 00:52:28 +0200 Message-Id: <1391813548-818-2-git-send-email-sakari.ailus@iki.fi> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1391813548-818-1-git-send-email-sakari.ailus@iki.fi> References: <1393149.6OyBNhdFTt@avalon> <1391813548-818-1-git-send-email-sakari.ailus@iki.fi> Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Spam-Status: No, score=-7.4 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=ham 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 Timestamp buffer flags are constant at the moment. Document them so that 1) they're always valid and 2) not changed by the drivers. This leaves room to extend the functionality later on if needed. Signed-off-by: Sakari Ailus --- Documentation/DocBook/media/v4l/io.xml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml index 451626f..f523725 100644 --- a/Documentation/DocBook/media/v4l/io.xml +++ b/Documentation/DocBook/media/v4l/io.xml @@ -654,6 +654,14 @@ plane, are stored in struct v4l2_plane instead. In that case, struct v4l2_buffer contains an array of plane structures. + Buffers that have been dequeued come with timestamps. These + timestamps can be taken from different clocks and at different part of + the frame, depending on the driver. Please see flags in the masks + V4L2_BUF_FLAG_TIMESTAMP_MASK and + V4L2_BUF_FLAG_TSTAMP_SRC_MASK in . These flags are guaranteed to be always valid + and will not be changed by the driver. + struct <structname>v4l2_buffer</structname>