zephyr/dts/bindings/serial/uart-device.yaml

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

# Common fields for UART devices

inherits:
    !include base.yaml

parent:
    bus: uart

properties:
    label:
      required: true
dts: bindings: add generic yaml description for uart-devices Provide generic yaml description for uart-devices such as modems. Signed-off-by: Michael Scott <mike@foundries.io> 2018-08-02 04:00:00 +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 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 UART devices`
dts: bindings: add generic yaml description for uart-devices Provide generic yaml description for uart-devices such as modems. Signed-off-by: Michael Scott <mike@foundries.io> 2018-08-02 04:00:00 +08:00
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-08 00:12:49 +08:00			`inherits:`
			`!include base.yaml`

dts: bindings: add generic yaml description for uart-devices Provide generic yaml description for uart-devices such as modems. Signed-off-by: Michael Scott <mike@foundries.io> 2018-08-02 04:00:00 +08:00			`parent:`
			`bus: uart`

			`properties:`
			`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:\srequired/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`