From patchwork Sun Nov 29 19:20:23 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sakari Ailus X-Patchwork-Id: 7719121 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.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 4699DBEEE5 for ; Sun, 29 Nov 2015 19:23:42 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 7BB83205E2 for ; Sun, 29 Nov 2015 19:23:41 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 5DC45205E8 for ; Sun, 29 Nov 2015 19:23:40 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752588AbbK2TXh (ORCPT ); Sun, 29 Nov 2015 14:23:37 -0500 Received: from nblzone-211-213.nblnetworks.fi ([83.145.211.213]:39772 "EHLO hillosipuli.retiisi.org.uk" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1752488AbbK2TWr (ORCPT ); Sun, 29 Nov 2015 14:22:47 -0500 Received: from lanttu.localdomain (lanttu-e.localdomain [192.168.1.64]) by hillosipuli.retiisi.org.uk (Postfix) with ESMTP id 2F2BC600B1; Sun, 29 Nov 2015 21:22:38 +0200 (EET) From: Sakari Ailus To: linux-media@vger.kernel.org Cc: laurent.pinchart@ideasonboard.com, mchehab@osg.samsung.com, hverkuil@xs4all.nl, javier@osg.samsung.com Subject: [PATCH v2 22/22] media: Update media graph walk documentation for the changed API Date: Sun, 29 Nov 2015 21:20:23 +0200 Message-Id: <1448824823-10372-23-git-send-email-sakari.ailus@iki.fi> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1448824823-10372-1-git-send-email-sakari.ailus@iki.fi> References: <1448824823-10372-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=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, T_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 media_entity_graph_walk_init() and media_entity_graph_walk_cleanup() are now mandatory. Signed-off-by: Sakari Ailus --- Documentation/media-framework.txt | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/Documentation/media-framework.txt b/Documentation/media-framework.txt index b424de6..738a526 100644 --- a/Documentation/media-framework.txt +++ b/Documentation/media-framework.txt @@ -241,13 +241,22 @@ supported by the graph traversal API. To prevent infinite loops, the graph traversal code limits the maximum depth to MEDIA_ENTITY_ENUM_MAX_DEPTH, currently defined as 16. -Drivers initiate a graph traversal by calling +The graph traversal must be initialised calling + + media_entity_graph_walk_init(struct media_entity_graph *graph); + +The return value of the function must be checked. Should the number of +graph entities exceed the pre-allocated memory, it will also allocate +memory for the enumeration. + +Once initialised, the graph walk may be started by calling media_entity_graph_walk_start(struct media_entity_graph *graph, struct media_entity *entity); -The graph structure, provided by the caller, is initialized to start graph -traversal at the given entity. +The graph structure, provided by the caller, is initialized to start +graph traversal at the given entity. It is possible to start the graph +walk multiple times using the same graph struct. Drivers can then retrieve the next entity by calling @@ -255,8 +264,11 @@ Drivers can then retrieve the next entity by calling When the graph traversal is complete the function will return NULL. -Graph traversal can be interrupted at any moment. No cleanup function call is -required and the graph structure can be freed normally. +Graph traversal can be interrupted at any moment. Once the graph +structure is no longer needed, the resources that have been allocated +by media_entity_graph_walk_init() are released using + + media_entity_graph_walk_cleanup(struct media_entity_graph *graph); Helper functions can be used to find a link between two given pads, or a pad connected to another pad through an enabled link