From patchwork Sat Feb 15 20:53:05 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sakari Ailus X-Patchwork-Id: 3657041 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 4538F9F334 for ; Sat, 15 Feb 2014 20:52:00 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 6D894201C8 for ; Sat, 15 Feb 2014 20:51:59 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 280C420203 for ; Sat, 15 Feb 2014 20:51:58 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753731AbaBOUvu (ORCPT ); Sat, 15 Feb 2014 15:51:50 -0500 Received: from nblzone-211-213.nblnetworks.fi ([83.145.211.213]:46724 "EHLO hillosipuli.retiisi.org.uk" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1753821AbaBOUvi (ORCPT ); Sat, 15 Feb 2014 15:51:38 -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 72C23600A0; Sat, 15 Feb 2014 22:51:33 +0200 (EET) From: Sakari Ailus To: linux-media@vger.kernel.org Cc: laurent.pinchart@ideasonboard.com, k.debski@samsung.com, hverkuil@xs4all.nl, Sakari Ailus Subject: [PATCH v5 7/7] v4l: Document timestamp buffer flag behaviour Date: Sat, 15 Feb 2014 22:53:05 +0200 Message-Id: <1392497585-5084-8-git-send-email-sakari.ailus@iki.fi> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1392497585-5084-1-git-send-email-sakari.ailus@iki.fi> References: <1392497585-5084-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.5 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 | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml index fbd0c6e..4f76565 100644 --- a/Documentation/DocBook/media/v4l/io.xml +++ b/Documentation/DocBook/media/v4l/io.xml @@ -653,6 +653,16 @@ plane, are stored in struct v4l2_plane instead. In that case, struct v4l2_buffer contains an array of plane structures. + Dequeued video buffers 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 autonomously. Changes + in these flags may take place due as a side effect of + &VIDIOC-S-INPUT; or &VIDIOC-S-OUTPUT; however. + struct <structname>v4l2_buffer</structname>