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/i2c/i2c-controller.yaml

28 lines
446 B
YAML
Raw Normal View History

dts/i2c: Fixing copyright headers Some yaml files were missing there copyright header. Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2018-02-28 17:37:41 +08:00
#
# Copyright (c) 2017 I-SENSE group of ICCS
#
# 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 I2C controllers
dts: yaml: Add yaml files for STM32 I2C support to DT Add yaml files to DT for initial support of STM32 I2C Origin: original Signed-off-by: Yannis Damigos <giannis.damigos@gmail.com>
2017-06-29 22:20:30 +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: provide generic yaml description for i2c-devices Provide generic yaml description for i2c-devices such as sensors New yaml binding category 'parent/child' is added. It aims at binding two types of related node such as bus master and bus slave. In case of i2c-device object, parent property is 'bus' with value 'i2c'. In the mean time, i2c node gets child property bus. Master and slave bus values should match. As such, 'i2c' node is bus master and 'i2c-devices' nodes are bus slaves Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-10-19 22:31:44 +08:00
child:
bus: i2c
dts: yaml: Add yaml files for STM32 I2C support to DT Add yaml files to DT for initial support of STM32 I2C Origin: original Signed-off-by: Yannis Damigos <giannis.damigos@gmail.com>
2017-06-29 22:20:30 +08:00
properties:
yaml: fix properties syntax to 'mapping' instead of 'series' According to yaml syntaxic rules, 'properties' described in dts bindings yaml files could be seen as 'mapping'(key/value couple), instead of 'series' (list of single elements). yaml 'mappings' will then be converted by yaml python library as python 'dict' which will ease treatment (instead of current list as were before this commit). Same treatment is applied to 'inherits'. script extract_dts_inlcude is updated to take change of yaml_list structre into account. This allows some code simplification. Largest impact is yaml_collapse function which works now allow complete overload method on all the attributes of a yaml nodes. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-11-23 15:48:10 +08:00
"#address-cells":
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: 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: 1
yaml: fix properties syntax to 'mapping' instead of 'series' According to yaml syntaxic rules, 'properties' described in dts bindings yaml files could be seen as 'mapping'(key/value couple), instead of 'series' (list of single elements). yaml 'mappings' will then be converted by yaml python library as python 'dict' which will ease treatment (instead of current list as were before this commit). Same treatment is applied to 'inherits'. script extract_dts_inlcude is updated to take change of yaml_list structre into account. This allows some code simplification. Largest impact is yaml_collapse function which works now allow complete overload method on all the attributes of a yaml nodes. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-11-23 15:48:10 +08:00
"#size-cells":
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: 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
yaml: fix properties syntax to 'mapping' instead of 'series' According to yaml syntaxic rules, 'properties' described in dts bindings yaml files could be seen as 'mapping'(key/value couple), instead of 'series' (list of single elements). yaml 'mappings' will then be converted by yaml python library as python 'dict' which will ease treatment (instead of current list as were before this commit). Same treatment is applied to 'inherits'. script extract_dts_inlcude is updated to take change of yaml_list structre into account. This allows some code simplification. Largest impact is yaml_collapse function which works now allow complete overload method on all the attributes of a yaml nodes. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-11-23 15:48:10 +08:00
clock-frequency :
dts: yaml: Add yaml files for STM32 I2C support to DT Add yaml files to DT for initial support of STM32 I2C Origin: original Signed-off-by: Yannis Damigos <giannis.damigos@gmail.com>
2017-06-29 22:20:30 +08:00
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
i2c: Cleanup dts clock-frequency property usage Clarify that the clock-frequency is the bitrate at boot and introduce defines that .dts files can use to set the clock-frequency. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-08-11 00:22:24 +08:00
description: Initial clock frequency in Hz
yaml: fix properties syntax to 'mapping' instead of 'series' According to yaml syntaxic rules, 'properties' described in dts bindings yaml files could be seen as 'mapping'(key/value couple), instead of 'series' (list of single elements). yaml 'mappings' will then be converted by yaml python library as python 'dict' which will ease treatment (instead of current list as were before this commit). Same treatment is applied to 'inherits'. script extract_dts_inlcude is updated to take change of yaml_list structre into account. This allows some code simplification. Largest impact is yaml_collapse function which works now allow complete overload method on all the attributes of a yaml nodes. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-11-23 15:48:10 +08:00
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