From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.6 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_2 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C0FFEC433E1 for ; Tue, 25 Aug 2020 09:29:24 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9CB6A2068F for ; Tue, 25 Aug 2020 09:29:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1598347764; bh=giUh8kfdw+J36IN0Ge8r43Cgn1ew0GISv68WF0PHD6c=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=v+7yzP1CBaB0My3UOsBIbXBAofp5IBSsxC6+9gRpkG3AoiMjmBD3km3PrZdxBcIxx /rfZ0IjG4grDTqRXmj4dGLfraz+n+IOV1gasRD5Ci39WQLe07ZrGvCBbRoP4N+0jbv ijQclFpGjRvDc+Z6Y5JeTFbapPIgJGzWx/7ULT+g= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726000AbgHYJ3S (ORCPT ); Tue, 25 Aug 2020 05:29:18 -0400 Received: from mail.kernel.org ([198.145.29.99]:59734 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726149AbgHYJ3S (ORCPT ); Tue, 25 Aug 2020 05:29:18 -0400 Received: from coco.lan (ip5f5ad5a4.dynamic.kabel-deutschland.de [95.90.213.164]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id A4DDB2068F; Tue, 25 Aug 2020 09:29:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1598347757; bh=giUh8kfdw+J36IN0Ge8r43Cgn1ew0GISv68WF0PHD6c=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=OKFVKlDTuVbtfdKMEfHQBUFSi6MOoM/ICBdx2oNDMshzM1tuFmSkFC0ODT1FPGhDr b7AS2aRWF8NI00LIOrrbKPdWaBa0Gjyn1+ysZ6fqrQbtNQrvTE1vPu95P57J0bncnn Gq9NmF0ow7xDJkWWG20g38ccq9mUWJW5xrahMJrU= Date: Tue, 25 Aug 2020 11:29:12 +0200 From: Mauro Carvalho Chehab To: Rob Herring Cc: linuxarm@huawei.com, mauro.chehab@huawei.com, John Stultz , Manivannan Sadhasivam , Andy Gross , Bjorn Andersson , Lee Jones , Stephen Boyd , Josh Cartwright , linux-arm-msm@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH] dt-bindings: convert spmi.txt to spmi.yaml Message-ID: <20200825112912.4fca31ad@coco.lan> In-Reply-To: <20200819230812.GB2090217@bogus> References: <94b055687143c9593cd4311f8bcda99a743a619f.1597850327.git.mchehab+huawei@kernel.org> <20200819230812.GB2090217@bogus> X-Mailer: Claws Mail 3.17.6 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: devicetree-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org Em Wed, 19 Aug 2020 17:08:12 -0600 Rob Herring escreveu: > On Wed, Aug 19, 2020 at 05:20:06PM +0200, Mauro Carvalho Chehab wrote: > > Convert the SPMI bus documentation to JSON/yaml. > > > > Signed-off-by: Mauro Carvalho Chehab > > --- > > > > Rob, > > > > As promissed, this patch converts the spmi.txt generic bus bindings to > > html. > > Thanks! > > > > > .../bindings/mfd/qcom,spmi-pmic.txt | 2 +- > > .../bindings/spmi/qcom,spmi-pmic-arb.txt | 4 +- > > .../devicetree/bindings/spmi/spmi.txt | 41 ------------ > > .../devicetree/bindings/spmi/spmi.yaml | 62 +++++++++++++++++++ > > 4 files changed, 65 insertions(+), 44 deletions(-) > > delete mode 100644 Documentation/devicetree/bindings/spmi/spmi.txt > > create mode 100644 Documentation/devicetree/bindings/spmi/spmi.yaml > > > > diff --git a/Documentation/devicetree/bindings/mfd/qcom,spmi-pmic.txt b/Documentation/devicetree/bindings/mfd/qcom,spmi-pmic.txt > > index fffc8fde3302..79367a43b27d 100644 > > --- a/Documentation/devicetree/bindings/mfd/qcom,spmi-pmic.txt > > +++ b/Documentation/devicetree/bindings/mfd/qcom,spmi-pmic.txt > > @@ -37,7 +37,7 @@ Required properties: > > or generalized "qcom,spmi-pmic". > > - reg: Specifies the SPMI USID slave address for this device. > > For more information see: > > - Documentation/devicetree/bindings/spmi/spmi.txt > > + Documentation/devicetree/bindings/spmi/spmi.yaml > > > > Required properties for peripheral child nodes: > > - compatible: Should contain "qcom,xxx", where "xxx" is a peripheral name. > > diff --git a/Documentation/devicetree/bindings/spmi/qcom,spmi-pmic-arb.txt b/Documentation/devicetree/bindings/spmi/qcom,spmi-pmic-arb.txt > > index e16b9b5afc70..ca645e21fe47 100644 > > --- a/Documentation/devicetree/bindings/spmi/qcom,spmi-pmic-arb.txt > > +++ b/Documentation/devicetree/bindings/spmi/qcom,spmi-pmic-arb.txt > > @@ -7,8 +7,8 @@ devices to control a single SPMI master. > > The PMIC Arbiter can also act as an interrupt controller, providing interrupts > > to slave devices. > > > > -See spmi.txt for the generic SPMI controller binding requirements for child > > -nodes. > > +See Documentation/devicetree/bindings/spmi/spmi.yaml for the generic SPMI > > +controller binding requirements for child nodes. > > > > See Documentation/devicetree/bindings/interrupt-controller/interrupts.txt for > > generic interrupt controller binding documentation. > > diff --git a/Documentation/devicetree/bindings/spmi/spmi.txt b/Documentation/devicetree/bindings/spmi/spmi.txt > > deleted file mode 100644 > > index 4bb10d161a27..000000000000 > > --- a/Documentation/devicetree/bindings/spmi/spmi.txt > > +++ /dev/null > > @@ -1,41 +0,0 @@ > > -System Power Management Interface (SPMI) Controller > > - > > -This document defines a generic set of bindings for use by SPMI controllers. A > > -controller is modelled in device tree as a node with zero or more child nodes, > > -each representing a unique slave on the bus. > > - > > -Required properties: > > -- #address-cells : must be set to 2 > > -- #size-cells : must be set to 0 > > - > > -Child nodes: > > - > > -An SPMI controller node can contain zero or more child nodes representing slave > > -devices on the bus. Child 'reg' properties are specified as an address, type > > -pair. The address must be in the range 0-15 (4 bits). The type must be one of > > -SPMI_USID (0) or SPMI_GSID (1) for Unique Slave ID or Group Slave ID respectively. > > -These are the identifiers "statically assigned by the system integrator", as > > -per the SPMI spec. > > - > > -Each child node must have one and only one 'reg' entry of type SPMI_USID. > > - > > -#include > > - > > - spmi@.. { > > - compatible = "..."; > > - reg = <...>; > > - > > - #address-cells = <2>; > > - #size-cells = <0>; > > - > > - child@0 { > > - compatible = "..."; > > - reg = <0 SPMI_USID>; > > - }; > > - > > - child@7 { > > - compatible = "..."; > > - reg = <7 SPMI_USID > > - 3 SPMI_GSID>; > > - }; > > - }; > > diff --git a/Documentation/devicetree/bindings/spmi/spmi.yaml b/Documentation/devicetree/bindings/spmi/spmi.yaml > > new file mode 100644 > > index 000000000000..8d72796b9bec > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/spmi/spmi.yaml > > @@ -0,0 +1,62 @@ > > +# SPDX-License-Identifier: GPL-2.0 > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/spmi/spmi.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: System Power Management Interface (SPMI) Controller > > + > > +maintainers: > > + - Josh Cartwright > > + > > +description: | > > + The System Power Management (SPMI) controller is a 2-wire bus defined > > + by the MIPI Alliance for power management control to be used on SoC designs. > > + > > + SPMI controllers are modelled in device tree using a generic set of > > + bindings defined here, plus any bus controller specific properties, if > > + needed. > > + > > + Each SPMI controller has zero or more child nodes (up to 16 ones), each > > + one representing an unique slave at the bus. > > + > > +properties: > > + $nodename: > > + pattern: "spmi@[0-9a-f]+" > > Just "spmi@.*" as we shouldn't assume unit-address details of the parent > bus. Ok. > > > + > > + compatible: > > + description: filled by the SPMI bus controller > > + > > + reg: > > + maxItems: 1 > > No need for 'reg' and 'compatible' here. Those will be covered by > specific SPMI controller schemas. Ok. I was in doubt about those, as the original .txt file had it with a <...>. > But you do need: > > "#address-cells": > const: 2 > > "#size-cells": > const: 0 Ok. > > > + > > +patternProperties: > > + "@([0-9]|1[0-5])$": > > While buses define their own unit-address format, unit addresses are > normally hex. I don't have a strong preference here. Yet, as this bus can have only up to 16 child (starting from 0), I guess decimal would make more sense. > > > + description: up to 16 child PMIC nodes > > type: object > > Need to also define 'reg' constraints as defined by the bus: > > properties: > reg: > minItems: 1 > maxItems: 2 #??? Not sure about this. Is it 1 SPMI_USID and 1 \ > SPMI_GSID entry at most? I guess so. Currently, no devices use SPMI_GSID. I guess that we can place maxItems: 2. If later needed, this could be changed in the future. > items: > items: > - minimum: 0 > maximum: 0xf > - enum: [ 0, 1 ] > > > + > > +required: > > + - compatible > > + - reg > > + > > +examples: > > + - | > > + #include > > + > > + spmi@.. { > > + compatible = "..."; > > + reg = <...>; > > Example has to build now. Just drop these 2 properties. OK. > > > + > > + #address-cells = <2>; > > + #size-cells = <0>; > > + > > + child@0 { > > + compatible = "..."; > > + reg = <0 SPMI_USID>; > > + }; > > + > > + child@7 { > > + compatible = "..."; > > + reg = <7 SPMI_USID > > + 3 SPMI_GSID>; > > + }; > > + }; > > -- > > 2.26.2 > > > > Thanks, Mauro