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/rtc/rtc.yaml

22 lines
470 B
YAML
Raw Normal View History

yaml: rtc: Add yaml definitions for RTC This patch adds the YAML descriptions for a generic RTC block and also for NXP Kinetis based RTCs. Signed-off-by: Andy Gross <agross@kernel.org>
2018-04-25 02:28:04 +08:00
# Copyright (c) 2018, blik GmbH
# 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 06:03:49 +08:00
dts: edtlib: Sanity-check the final merged binding only Sanity-checking each !included file separately was inherited from the old scripts. It makes it messy to check that combinations of fields make sense, e.g. to check 'const:' or 'default:' against 'type:', since those fields might come from different files (this is handy, since it makes sense to just add/change a 'const:' value, for example). Drop the requirement that each !included file is a complete binding in itself, and treat them as binding fragments instead. Only check the final merged binding. This also means that !included files no longer need to have a 'description:' or 'title:' (those have always been unused for !included files), so remove those, and add comments that explain what the fragments are for instead. That should demystify bindings a bit. Also fix the descriptions of i2c.yaml, i2s.yaml, spi.yaml, and uart.yaml. They're for controllers, not devices. These are copy-paste error from the corresponding device .yaml files. Piggyback some indentation consistency nits in binding-template.yaml. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-15 20:06:15 +08:00
# Common fields for RTC devices
yaml: rtc: Add yaml definitions for RTC This patch adds the YAML descriptions for a generic RTC block and also for NXP Kinetis based RTCs. Signed-off-by: Andy Gross <agross@kernel.org>
2018-04-25 02:28:04 +08:00
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: base.yaml
yaml: rtc: Add yaml definitions for RTC This patch adds the YAML descriptions for a generic RTC block and also for NXP Kinetis based RTCs. Signed-off-by: Andy Gross <agross@kernel.org>
2018-04-25 02:28:04 +08:00
properties:
clock-frequency:
type: int
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
yaml: rtc: Add yaml definitions for RTC This patch adds the YAML descriptions for a generic RTC block and also for NXP Kinetis based RTCs. Signed-off-by: Andy Gross <agross@kernel.org>
2018-04-25 02:28:04 +08:00
description: Clock frequency information for RTC operation
label:
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
yaml: rtc: Add yaml definitions for RTC This patch adds the YAML descriptions for a generic RTC block and also for NXP Kinetis based RTCs. Signed-off-by: Andy Gross <agross@kernel.org>
2018-04-25 02:28:04 +08:00
interrupts:
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
drivers: counter: Move nRF TIMER and RTC configuration to device tree Reduced Kconfig for counter with nRF TIMER and RTC. Added overlays for TIMER and RTC configuration in the counter test. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2019-05-14 16:38:14 +08:00
yaml: rtc: Add yaml definitions for RTC This patch adds the YAML descriptions for a generic RTC block and also for NXP Kinetis based RTCs. Signed-off-by: Andy Gross <agross@kernel.org>
2018-04-25 02:28:04 +08:00
prescaler:
type: int
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
drivers: counter: Move nRF TIMER and RTC configuration to device tree Reduced Kconfig for counter with nRF TIMER and RTC. Added overlays for TIMER and RTC configuration in the counter test. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2019-05-14 16:38:14 +08:00
description: RTC frequency equals clock-frequency divided by the prescaler value