[v5,2/2] dt-bindings: Document common device controller bindings
Commit Message
Introducing of the common device controller bindings for the controller
provider and consumer devices. Those bindings are intended to allow
divided system on chip into muliple domains, that can be used to
configure hardware permissions.
Signed-off-by: Oleksii Moisieiev <oleksii_moisieiev@epam.com>
---
.../feature-domain-controller.yaml | 80 +++++++++++++++++++
1 file changed, 80 insertions(+)
create mode 100644 Documentation/devicetree/bindings/feature-domains/feature-domain-controller.yaml
Comments
On Wed, 26 Oct 2022 17:51:27 +0000, Oleksii Moisieiev wrote:
> Introducing of the common device controller bindings for the controller
> provider and consumer devices. Those bindings are intended to allow
> divided system on chip into muliple domains, that can be used to
> configure hardware permissions.
>
> Signed-off-by: Oleksii Moisieiev <oleksii_moisieiev@epam.com>
> ---
> .../feature-domain-controller.yaml | 80 +++++++++++++++++++
> 1 file changed, 80 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/feature-domains/feature-domain-controller.yaml
>
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/feature-domains/feature-domain-controller.example.dtb: foo@0: feature-domain-names: ['default', 'unbind'] is too long
From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/feature-domains/feature-domain-controller.yaml
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/ab68324eea3c788a369260f5a1e5da843a960cde.1666806317.git.oleksii_moisieiev@epam.com/
This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit.
On Wed, Oct 26, 2022 at 04:51:15PM -0500, Rob Herring wrote:
> On Wed, 26 Oct 2022 17:51:27 +0000, Oleksii Moisieiev wrote:
> > Introducing of the common device controller bindings for the controller
> > provider and consumer devices. Those bindings are intended to allow
> > divided system on chip into muliple domains, that can be used to
> > configure hardware permissions.
> >
> > Signed-off-by: Oleksii Moisieiev <oleksii_moisieiev@epam.com>
> > ---
> > .../feature-domain-controller.yaml | 80 +++++++++++++++++++
> > 1 file changed, 80 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/feature-domains/feature-domain-controller.yaml
> >
>
> My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> on your patch (DT_CHECKER_FLAGS is new in v5.13):
>
> yamllint warnings/errors:
>
> dtschema/dtc warnings/errors:
> /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/feature-domains/feature-domain-controller.example.dtb: foo@0: feature-domain-names: ['default', 'unbind'] is too long
> From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/feature-domains/feature-domain-controller.yaml
>
> doc reference errors (make refcheckdocs):
>
>
> See https://urldefense.com/v3/__https://patchwork.ozlabs.org/project/devicetree-bindings/patch/ab68324eea3c788a369260f5a1e5da843a960cde.1666806317.git.oleksii_moisieiev@epam.com/__;!!GF_29dbcQIUBPA!y6dnIrQEa4gr2RDYPf2_Oc7JsKHJrAKtl69xg0Jlf-Qri5BP9kBzqIknprWXaikX5y2Yz_UWCW5yYv_9Hw$ [patchwork[.]ozlabs[.]org]
>
> This check can fail if there are any dependencies. The base for a patch
> series is generally the most recent rc1.
>
> If you already ran 'make dt_binding_check' and didn't see the above
> error(s), then make sure 'yamllint' is installed and dt-schema is up to
> date:
>
> pip3 install dtschema --upgrade
>
> Please check and re-submit.
>
Hello,
Thank you for the response. I would recheck and resubmit patch series if there
will be no additional comments.
Best regards,
Oleksii.
On 27/10/2022 02:35, Oleksii Moisieiev wrote:
> On Wed, Oct 26, 2022 at 04:51:15PM -0500, Rob Herring wrote:
>> On Wed, 26 Oct 2022 17:51:27 +0000, Oleksii Moisieiev wrote:
>>> Introducing of the common device controller bindings for the controller
>>> provider and consumer devices. Those bindings are intended to allow
>>> divided system on chip into muliple domains, that can be used to
>>> configure hardware permissions.
>>>
>>> Signed-off-by: Oleksii Moisieiev <oleksii_moisieiev@epam.com>
>>> ---
>>> .../feature-domain-controller.yaml | 80 +++++++++++++++++++
>>> 1 file changed, 80 insertions(+)
>>> create mode 100644 Documentation/devicetree/bindings/feature-domains/feature-domain-controller.yaml
>>>
>>
>> My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
>> on your patch (DT_CHECKER_FLAGS is new in v5.13):
>>
>> yamllint warnings/errors:
>>
>> dtschema/dtc warnings/errors:
>> /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/feature-domains/feature-domain-controller.example.dtb: foo@0: feature-domain-names: ['default', 'unbind'] is too long
>> From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/feature-domains/feature-domain-controller.yaml
>>
>> doc reference errors (make refcheckdocs):
>>
>>
>> See https://urldefense.com/v3/__https://patchwork.ozlabs.org/project/devicetree-bindings/patch/ab68324eea3c788a369260f5a1e5da843a960cde.1666806317.git.oleksii_moisieiev@epam.com/__;!!GF_29dbcQIUBPA!y6dnIrQEa4gr2RDYPf2_Oc7JsKHJrAKtl69xg0Jlf-Qri5BP9kBzqIknprWXaikX5y2Yz_UWCW5yYv_9Hw$ [patchwork[.]ozlabs[.]org]
>>
>> This check can fail if there are any dependencies. The base for a patch
>> series is generally the most recent rc1.
>>
>> If you already ran 'make dt_binding_check' and didn't see the above
>> error(s), then make sure 'yamllint' is installed and dt-schema is up to
>> date:
>>
>> pip3 install dtschema --upgrade
>>
>> Please check and re-submit.
>>
>
> Hello,
>
> Thank you for the response. I would recheck and resubmit patch series if there
> will be no additional comments.
>
when resubmitting, Cc necessary maintainers as pointed out by
scripts/get_maintainer.pl. Or base your tree on something decent...
Best regards,
Krzysztof
new file mode 100644
@@ -0,0 +1,80 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/feature-domains/feature-domain-controller.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Generic Domain Controller bindings
+
+maintainers:
+ - Oleksii Moisieiev <oleksii_moisieiev@epam.com>
+
+description: |+
+ Common Feature Domains Controller bindings properties
+
+ Domain controllers allow to divided system on chip into multiple feature
+ domains that can be used to select by who hardware blocks could be accessed.
+ A feature domain could be a cluster of CPUs (or coprocessors), a range of
+ addresses or a group of hardware blocks.
+
+ This device tree bindings can be used to bind feature domain consumer devices
+ with their feature domains provided by feature-domains controllers.
+ Feature omain controller provider can be represened by any node in the
+ device tree and can provide one or more configuration parameters, needed to
+ control parameters of the consumer device. A consumer node can refer to the
+ provider by phandle and a set of phandle arguments, specified by
+ '#feature-domain-cells' property in the device controller provider node.
+
+ Device controllers are typically used to set the permissions of the hardware
+ block. The contents of the feature-domains configuration properties are
+ defined by the binding for the individual feature-domains controller device.
+
+ Each node can be a consumer for the several providers. The first
+ configuration of 'feature-domains' or the one named 'default' is applied
+ before probing the device itself.
+
+# always select the core schema
+select: true
+
+properties:
+ '#feature-domain-cells':
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Number of cells in a feature-domains controller specifier;
+ Can be any value as specified by device tree binding documentation
+ of a particular provider.
+
+ feature-domain-names:
+ $ref: '/schemas/types.yaml#/definitions/string-array'
+ minItems: 1
+ description:
+ A list of feature-domains names, sorted in the same order as
+ feature-domains entries. Consumer drivers will use feature-domain-names
+ to match with existing feature-domains entries.
+
+ feature-domains:
+ $ref: "/schemas/types.yaml#/definitions/phandle-array"
+ description:
+ A list of feature-domains controller specifiers, as defined by the
+ bindings of the feature-domain-controller provider.
+
+additionalProperties: true
+
+examples:
+ - |
+ ctrl0: ctrl@100 {
+ feature-domain-controller;
+ reg = <0x100 0x10>;
+ #feature-domain-cells = <2>;
+ };
+
+ ctrl1: ctrl@110 {
+ feature-domain-controller;
+ reg = <0x110 0x10>;
+ #feature-domain-cells = <3>;
+ };
+
+ foo@0 {
+ reg = <0x0 0x1>;
+ feature-domains = <&ctrl0 1 2>, <&ctrl1 3 4 5>;
+ feature-domain-names = "default", "unbind";
+ };