zephyr/dts/bindings/riscv/openisa,rv32m1-pcc.yaml

# Copyright (c) 2018 Foundries.io
# SPDX-License-Identifier: Apache-2.0

description: RV32M1 PCC (Peripheral Clock Control) IP node

compatible: "openisa,rv32m1-pcc"

include: [clock-controller.yaml, base.yaml]

properties:
  reg:
    required: true

  "#clock-cells":
    const: 1

clock-cells:
  - name
clock_control: RV32M1: introduce PCC driver / DT bindings Add a Peripheral Clock Controller (PCC) driver. This gates and ungates clocks to various peripherals on the SoC. Signed-off-by: Michael Scott <mike@foundries.io> Signed-off-by: Marti Bolivar <marti@foundries.io> 2018-11-07 10:13:52 -08:00			`# Copyright (c) 2018 Foundries.io`
			`# SPDX-License-Identifier: Apache-2.0`
yaml: Remove redundant document separators YAML document separators are needed e.g. when doing $ cat doc1.yaml doc2.yaml \| <parser> For the bindings, we never parse concatenated documents. Assume we don't for any other .yaml files either. Having document separators in e.g. base.yaml makes !include a bit confusing, since the !included files are merged and not separate documents (the merging is done in Python code though, so it makes no difference for behavior). The replacement was done with $ git ls-files '.yaml' \| \ xargs sed -i -e '${/\s\.\.\.\s/d;}' -e 's/^\s---\s$//' First pattern removes ... at the end of files, second pattern clears a line with a lone --- on it. Some redundant blank lines at the end of files were cleared with $ git ls-files '.yaml' \| xargs sed -i '${/^\s*$/d}' This is more about making sure people can understand why every part of a binding is there than about removing some text. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no> 2019-06-19 00:03:49 +02:00
dts: bindings: Remove 'title:' and put all info. into 'description:' Add any useful information from 'title:' to the 'description:' strings (e.g. explanations of acronyms), and remove 'title:' as well as any copy-pasted "this binding gives a ..." boilerplate. Also clean some description strings up a bit. Some other things could probably be cleaned up (replacing 'GPIO node' with 'GPIO controller' on controllers for consistency, for example), but I kept things close to the original to avoid accidentally messing up. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no> 2019-11-19 08:39:11 +01:00			`description: RV32M1 PCC (Peripheral Clock Control) IP node`
clock_control: RV32M1: introduce PCC driver / DT bindings Add a Peripheral Clock Controller (PCC) driver. This gates and ungates clocks to various peripherals on the SoC. Signed-off-by: Michael Scott <mike@foundries.io> Signed-off-by: Marti Bolivar <marti@foundries.io> 2018-11-07 10:13:52 -08:00
scripts: dts: Simplify and improve 'compatible' matching Instead of properties: compatible: constraint: "foo" , just have compatible: "foo" at the top level of the binding. For backwards compatibility, the old 'properties: compatible: ...' form is still accepted for now, and is treated the same as a single-element 'compatible:'. The old syntax was inspired by dt-schema (though it isn't dt-schema-compatible), which is in turn a thin wrapper around json-schema (the idea is to transform .dts files into YAML and then verify them). Maybe the idea was to gradually switch the syntax over to dt-schema and then be able to use unmodified dt-schema bindings, but dt-schema is really a different kind of tool (a completely standalone linter), and works very differently from our stuff (see schemas/dt-core.yaml in the dt-schema repo to get an idea of just how differently). Better to keep it simple. This commit also piggybacks some clarifications to the binding template re. '#cells:'. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no> 2019-08-19 20:32:25 +02:00			`compatible: "openisa,rv32m1-pcc"`

dts/bindings: Convert bindings to new include syntax Convert from: inherits: !include spi-device.yaml to: include: spi-device.yaml Signed-off-by: Kumar Gala <kumar.gala@linaro.org> 2019-08-21 18:10:12 -05:00			`include: [clock-controller.yaml, base.yaml]`
dts/bindings: Move common properties into a base.yaml Move common properties like 'compatible', 'reg', 'reg-names', 'interrupts', 'interrupt-names', and 'label' into one common base.yaml that all the other yaml's can inherit from. This removes both duplication and inconsistent definition. The device specific yamls just need to say if a property is 'required' or not. NOTE: due to some generation conflicts we did not covert 'soc-nv-flash.yaml' to use base.yaml. Signed-off-by: Kumar Gala <kumar.gala@linaro.org> 2019-06-07 11:12:49 -05:00
clock_control: RV32M1: introduce PCC driver / DT bindings Add a Peripheral Clock Controller (PCC) driver. This gates and ungates clocks to various peripherals on the SoC. Signed-off-by: Michael Scott <mike@foundries.io> Signed-off-by: Marti Bolivar <marti@foundries.io> 2018-11-07 10:13:52 -08:00			`properties:`
yamllint: indentation: fix dts/bindings/ Fix the YAML files indentation for files in dts/bindings/. Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com> 2023-01-03 19:21:25 +00:00			`reg:`
			`required: true`
clock_control: RV32M1: introduce PCC driver / DT bindings Add a Peripheral Clock Controller (PCC) driver. This gates and ungates clocks to various peripherals on the SoC. Signed-off-by: Michael Scott <mike@foundries.io> Signed-off-by: Marti Bolivar <marti@foundries.io> 2018-11-07 10:13:52 -08:00
yamllint: indentation: fix dts/bindings/ Fix the YAML files indentation for files in dts/bindings/. Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com> 2023-01-03 19:21:25 +00:00			`"#clock-cells":`
			`const: 1`
dts/bindings: use const to validate #<FOO>-cells In most cases #<FOO>-cells should be a constant. For example in spi controller #address-cells should be 1, and #size-cells should be 0. Use the const attribute to specify such single known values. Add const value to missing bindings which have cells. Signed-off-by: Kumar Gala <kumar.gala@linaro.org> 2019-08-09 14:54:26 -05:00
scripts: dts: Generalize '#cells' to allow multiple sources Implement a nice generalization suggested by Bobby Noelte. Instead of having a generic #cells key in bindings, have source-specific -cells keys. Some examples: interrupt-cells: - irq - priority - flags gpio-cells: - pin - flags pwm-cells: - channel - period This makes bindings a bit easier to read, and allows a node to be a controller for many different 'phandle-array' properties. The prefix before -cells is derived from the property name, meaning there's no fixed set of *-cells keys. This is possible because of the earlier 'phandle-array' generalization. The older #cells key is supported for backwards compatibility, but generates a deprecation warning. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no> 2019-09-26 20:34:13 +02:00			`clock-cells:`
clock_control: RV32M1: introduce PCC driver / DT bindings Add a Peripheral Clock Controller (PCC) driver. This gates and ungates clocks to various peripherals on the SoC. Signed-off-by: Michael Scott <mike@foundries.io> Signed-off-by: Marti Bolivar <marti@foundries.io> 2018-11-07 10:13:52 -08:00			`- name`