Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20201111145757.74974-1-aford173@gmail.com>
In-Reply-To: <20201111145757.74974-1-aford173@gmail.com>
From:   Rob Herring <robh+dt@kernel.org>
Date:   Wed, 11 Nov 2020 09:13:53 -0600
Message-ID: <CAL_JsqKfe=uMPS6CgSGh6OfUMMY8yuKsa-q=PsFN3=NhYVYdDw@mail.gmail.com>
Subject: Re: [PATCH V3] dt-bindings: soc: imx: Add binding doc for spba bus
To:     Adam Ford <aford173@gmail.com>
Cc:     devicetree@vger.kernel.org,
        Adam Ford-BE <aford@beaconembedded.com>,
        Shawn Guo <shawnguo@kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Wed, Nov 11, 2020 at 8:58 AM Adam Ford <aford173@gmail.com> wrote:
>
> Add binding doc for fsl,spba-bus.
>
> Signed-off-by: Adam Ford <aford173@gmail.com>
> ---
> make dt_binding_check showed no errors if I did this right.
>
> V3:  Rebase sample from aips-bus example
>      Split off from series adding i.MX8M Nano functions to reduce noise
> V2:  Attempted to update yaml from feedback
>
> diff --git a/Documentation/devicetree/bindings/Makefile b/Documentation/devicetree/bindings/Makefile
> index f50420099a55..ec8073cb2e71 100644
> --- a/Documentation/devicetree/bindings/Makefile
> +++ b/Documentation/devicetree/bindings/Makefile
> @@ -3,8 +3,6 @@ DT_DOC_CHECKER ?= dt-doc-validate
>  DT_EXTRACT_EX ?= dt-extract-example
>  DT_MK_SCHEMA ?= dt-mk-schema
>
> -DT_SCHEMA_LINT = $(shell which yamllint)
> -

???

>  DT_SCHEMA_MIN_VERSION = 2020.8.1
>
>  PHONY += check_dtschema_version
> @@ -26,10 +24,6 @@ find_cmd = find $(srctree)/$(src) \( -name '*.yaml' ! \
>                 -name 'processed-schema*' ! \
>                 -name '*.example.dt.yaml' \)
>
> -quiet_cmd_yamllint = LINT    $(src)
> -      cmd_yamllint = $(find_cmd) | \
> -                     xargs $(DT_SCHEMA_LINT) -f parsable -c $(srctree)/$(src)/.yamllint
> -
>  quiet_cmd_chk_bindings = CHKDT   $@
>        cmd_chk_bindings = $(find_cmd) | \
>                           xargs -n200 -P$$(nproc) $(DT_DOC_CHECKER) -u $(srctree)/$(src)
> @@ -43,7 +37,6 @@ quiet_cmd_mk_schema = SCHEMA  $@
>                       rm -f $$f
>
>  define rule_chkdt
> -       $(if $(DT_SCHEMA_LINT),$(call cmd,yamllint),)
>         $(call cmd,chk_bindings)
>         $(call cmd,mk_schema)
>  endef
> @@ -55,7 +48,7 @@ override DTC_FLAGS := \
>         -Wno-graph_child_address \
>         -Wno-interrupt_provider
>
> -$(obj)/processed-schema-examples.json: $(DT_DOCS) $(src)/.yamllint check_dtschema_version FORCE
> +$(obj)/processed-schema-examples.json: $(DT_DOCS) check_dtschema_version FORCE
>         $(call if_changed_rule,chkdt)
>
>  ifeq ($(DT_SCHEMA_FILES),)
> diff --git a/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml
> new file mode 100644
> index 000000000000..91dae405ed39
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml
> @@ -0,0 +1,65 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/bus/fsl,spba-bus.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Shared Peripherals Bus Interface
> +
> +maintainers:
> +  - Shawn Guo <shawnguo@kernel.org>
> +
> +description: |
> +  A simple bus enabling access to shared peripherals.
> +
> +  The "spba-bus" follows the "simple-bus" set of properties, as
> +  specified in the Devicetree Specification.  It is an extension of
> +  "simple-bus" because the SDMA controller uses this compatible flag to
> +  determine which peripherals are available to it and the range over which
> +  the SDMA can access.  There are no special clocks for the bus, because
> +  the SDMA controller itself has its interrupt, and clock assignments.
> +
> +select:
> +  properties:
> +    compatible:
> +      contains:
> +        const: fsl,spba-bus
> +  required:
> +    - compatible
> +
> +properties:
> +  $nodename:
> +    pattern: "^bus(@[0-9a-f]+)?$"
> +
> +  compatible:
> +    items:
> +      - const: fsl,spba-bus
> +      - const: simple-bus
> +
> +  '#address-cells':
> +    enum: [ 1, 2 ]
> +
> +  '#size-cells':
> +    enum: [ 1, 2 ]
> +
> +  ranges: true
> +
> +required:
> +  - compatible
> +  - '#address-cells'
> +  - '#size-cells'
> +  - ranges
> +

> +additionalProperties: true
> +
> +type: object

Should be:

additionalProperties:
  type: object

> +
> +examples:
> +  - |
> +    bus@30000000 {
> +        compatible = "fsl,spba-bus", "simple-bus";
> +        #address-cells = <1>;
> +        #size-cells = <1>;
> +        reg = <0x30000000 0x100000>;
> +        ranges;
> +    };
> --
> 2.25.1
>