{"id":817366,"url":"http://patchwork.ozlabs.org/api/patches/817366/?format=json","web_url":"http://patchwork.ozlabs.org/project/devicetree-bindings/patch/1506066134-25997-2-git-send-email-sakari.ailus@linux.intel.com/","project":{"id":37,"url":"http://patchwork.ozlabs.org/api/projects/37/?format=json","name":"Devicetree Bindings","link_name":"devicetree-bindings","list_id":"devicetree.vger.kernel.org","list_email":"devicetree@vger.kernel.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<1506066134-25997-2-git-send-email-sakari.ailus@linux.intel.com>","list_archive_url":null,"date":"2017-09-22T07:42:13","name":"[v2,1/2] dt: bindings: media: Document practices for DT bindings, ports, endpoints","commit_ref":null,"pull_url":null,"state":"superseded","archived":true,"hash":"63457372b2ef8ca937b9c5031bd2ad7060e45706","submitter":{"id":65485,"url":"http://patchwork.ozlabs.org/api/people/65485/?format=json","name":"Sakari Ailus","email":"sakari.ailus@linux.intel.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/devicetree-bindings/patch/1506066134-25997-2-git-send-email-sakari.ailus@linux.intel.com/mbox/","series":[{"id":4561,"url":"http://patchwork.ozlabs.org/api/series/4561/?format=json","web_url":"http://patchwork.ozlabs.org/project/devicetree-bindings/list/?series=4561","date":"2017-09-22T07:42:13","name":"Improve generic DT binding documentation for media devices","version":2,"mbox":"http://patchwork.ozlabs.org/series/4561/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/817366/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/817366/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":"incoming-dt@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming-dt@bilbo.ozlabs.org","Authentication-Results":"ozlabs.org;\n\tspf=none (mailfrom) smtp.mailfrom=vger.kernel.org\n\t(client-ip=209.132.180.67; helo=vger.kernel.org;\n\tenvelope-from=devicetree-owner@vger.kernel.org; receiver=)","Received":["from vger.kernel.org (vger.kernel.org [209.132.180.67])\n\tby ozlabs.org (Postfix) with ESMTP id 3xz59b1cPMz9ryr\n\tfor ;\n\tFri, 22 Sep 2017 17:45:07 +1000 (AEST)","(majordomo@vger.kernel.org) by vger.kernel.org via listexpand\n\tid S1751838AbdIVHpG (ORCPT\n\t);\n\tFri, 22 Sep 2017 03:45:06 -0400","from mga03.intel.com ([134.134.136.65]:35795 \"EHLO mga03.intel.com\"\n\trhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP\n\tid S1751795AbdIVHpF (ORCPT );\n\tFri, 22 Sep 2017 03:45:05 -0400","from fmsmga004.fm.intel.com ([10.253.24.48])\n\tby orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t22 Sep 2017 00:45:04 -0700","from paasikivi.fi.intel.com ([10.237.72.42])\n\tby fmsmga004.fm.intel.com with ESMTP; 22 Sep 2017 00:45:02 -0700","from nauris.fi.intel.com (nauris.localdomain [192.168.240.2])\n\tby paasikivi.fi.intel.com (Postfix) with ESMTP id 7440A20B0D;\n\tFri, 22 Sep 2017 10:45:01 +0300 (EEST)","by nauris.fi.intel.com (Postfix, from userid 1000)\n\tid 648E3200B4; Fri, 22 Sep 2017 10:42:14 +0300 (EEST)"],"X-ExtLoop1":"1","X-IronPort-AV":"E=Sophos;i=\"5.42,427,1500966000\"; d=\"scan'208\";a=\"314976112\"","From":"Sakari Ailus ","To":"linux-media@vger.kernel.org","Cc":"devicetree@vger.kernel.org, robh@kernel.org","Subject":"[PATCH v2 1/2] dt: bindings: media: Document practices for DT\n\tbindings, ports, endpoints","Date":"Fri, 22 Sep 2017 10:42:13 +0300","Message-Id":"<1506066134-25997-2-git-send-email-sakari.ailus@linux.intel.com>","X-Mailer":"git-send-email 2.7.4","In-Reply-To":"<1506066134-25997-1-git-send-email-sakari.ailus@linux.intel.com>","References":"<1506066134-25997-1-git-send-email-sakari.ailus@linux.intel.com>","Sender":"devicetree-owner@vger.kernel.org","Precedence":"bulk","List-ID":"","X-Mailing-List":"devicetree@vger.kernel.org"},"content":"Port and endpoint numbering has been omitted in DT binding documentation\nfor a large number of devices. Also common properties the device uses have\nbeen missed in binding documentation. Make it explicit that these things\nneed to be documented.\n\nSigned-off-by: Sakari Ailus \n---\n .../devicetree/bindings/media/video-interfaces.txt | 15 +++++++++++++++\n 1 file changed, 15 insertions(+)","diff":"diff --git a/Documentation/devicetree/bindings/media/video-interfaces.txt b/Documentation/devicetree/bindings/media/video-interfaces.txt\nindex 852041a..3c5382f 100644\n--- a/Documentation/devicetree/bindings/media/video-interfaces.txt\n+++ b/Documentation/devicetree/bindings/media/video-interfaces.txt\n@@ -55,6 +55,21 @@ divided into two separate ITU-R BT.656 8-bit busses. In such case bus-width\n and data-shift properties can be used to assign physical data lines to each\n endpoint node (logical bus).\n \n+Documenting bindings for devices\n+--------------------------------\n+\n+All required and optional bindings the device supports shall be explicitly\n+documented in device DT binding documentation. This also includes port and\n+endpoint numbering for the device.\n+\n+Port and endpoint numbering\n+---------------------------\n+\n+Old binding documentation may have omitted explicitly specifying port and\n+endpoint numbers. This often applies to devices that have a single port and a\n+single endpoint in that port. In this case, the only valid port number for such\n+a device is zero. The same applies for devices for which bindings do not\n+document endpoint numbering: only zero is a valid endpoint.\n \n Required properties\n -------------------\n","prefixes":["v2","1/2"]}