OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/dts/bindings/clock/fixed-clock.yaml

28 lines
594 B
YAML
Raw Normal View History

dts: bindings: Add fixed-clock DTS binding This commit adds binding for clock provider with fixed frequency. Signed-off-by: Derek Hageman <hageman@inthat.cloud> Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-05-28 20:52:33 +08:00
# Copyright (c) 2019 Derek Hageman <hageman@inthat.cloud>
# SPDX-License-Identifier: Apache-2.0
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 15:39:11 +08:00
description: Generic fixed-rate clock provider
dts: bindings: Add fixed-clock DTS binding This commit adds binding for clock provider with fixed frequency. Signed-off-by: Derek Hageman <hageman@inthat.cloud> Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-05-28 20:52:33 +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-20 02:32:25 +08:00
compatible: "fixed-clock"
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-22 07:10:12 +08:00
include: clock-controller.yaml
dts/bindings: Add base clock controller to dts bindings Introduce a clock.yaml that clock controller bindings should inherit from. clock.yaml defines the properties "#clock-cells" which all clock controllers should have. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-08-09 23:27:28 +08:00
dts: bindings: Add fixed-clock DTS binding This commit adds binding for clock provider with fixed frequency. Signed-off-by: Derek Hageman <hageman@inthat.cloud> Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-05-28 20:52:33 +08:00
properties:
label:
type: string
dts: bindings: Have 'required: true/false' instead of 'category: ...' The 'category: required/optional' setting for properties is just a yes/no thing. Using a boolean makes it clearer, so have 'required: true/false' instead. Print a clear error when 'category:' is used: edtlib.EDTError: please put 'required: true' instead of 'category: required' in 'properties: foo: ...' in test-bindings/sub-node-parent.yaml - 'category' has been removed The old scripts in scripts/dts/ ignore this setting, and only print a warning if 'category: required' in an inherited binding is changed to 'category: optional'. Remove that code, since the new scripts already have the same check. The replacement was done with git ls-files 'dts/bindings/*.yaml' | xargs sed -i \ -e 's/category:\s*required/required: true/' \ -e 's/category:\s*optional/required: false/' dts/binding-template.yaml is updated as well. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-28 06:22:01 +08:00
required: false
dts: bindings: Add fixed-clock DTS binding This commit adds binding for clock provider with fixed frequency. Signed-off-by: Derek Hageman <hageman@inthat.cloud> Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-05-28 20:52:33 +08:00
description: Human readable string describing the device (used by Zephyr for API name)
clock-frequency:
type: int
description: output clock frequency (Hz)
dts: bindings: Have 'required: true/false' instead of 'category: ...' The 'category: required/optional' setting for properties is just a yes/no thing. Using a boolean makes it clearer, so have 'required: true/false' instead. Print a clear error when 'category:' is used: edtlib.EDTError: please put 'required: true' instead of 'category: required' in 'properties: foo: ...' in test-bindings/sub-node-parent.yaml - 'category' has been removed The old scripts in scripts/dts/ ignore this setting, and only print a warning if 'category: required' in an inherited binding is changed to 'category: optional'. Remove that code, since the new scripts already have the same check. The replacement was done with git ls-files 'dts/bindings/*.yaml' | xargs sed -i \ -e 's/category:\s*required/required: true/' \ -e 's/category:\s*optional/required: false/' dts/binding-template.yaml is updated as well. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-28 06:22:01 +08:00
required: true
dts: bindings: Add fixed-clock DTS binding This commit adds binding for clock provider with fixed frequency. Signed-off-by: Derek Hageman <hageman@inthat.cloud> Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-05-28 20:52:33 +08:00
clocks:
type: array
dts: bindings: Have 'required: true/false' instead of 'category: ...' The 'category: required/optional' setting for properties is just a yes/no thing. Using a boolean makes it clearer, so have 'required: true/false' instead. Print a clear error when 'category:' is used: edtlib.EDTError: please put 'required: true' instead of 'category: required' in 'properties: foo: ...' in test-bindings/sub-node-parent.yaml - 'category' has been removed The old scripts in scripts/dts/ ignore this setting, and only print a warning if 'category: required' in an inherited binding is changed to 'category: optional'. Remove that code, since the new scripts already have the same check. The replacement was done with git ls-files 'dts/bindings/*.yaml' | xargs sed -i \ -e 's/category:\s*required/required: true/' \ -e 's/category:\s*optional/required: false/' dts/binding-template.yaml is updated as well. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-28 06:22:01 +08:00
required: false
dts: bindings: Add fixed-clock DTS binding This commit adds binding for clock provider with fixed frequency. Signed-off-by: Derek Hageman <hageman@inthat.cloud> Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-05-28 20:52:33 +08:00
description: input clock source
"#clock-cells":
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-10 03:54:26 +08:00
const: 0