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/sifive,i2c0.yaml

18 lines
334 B
YAML
Raw Normal View History

drivers/i2c: I2C driver for SiFive Freedom Driver for the I2C peripheral in the SiFive Blocks RTL Repository (https://github.com/sifive/sifive-blocks). Signed-off-by: Nathaniel Graff <nathaniel.graff@sifive.com>
2018-11-28 07:02:13 +08:00
# Copyright (c) 2018 SiFive Inc.
# 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: 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: SiFive Freedom I2C interface
drivers/i2c: I2C driver for SiFive Freedom Driver for the I2C peripheral in the SiFive Blocks RTL Repository (https://github.com/sifive/sifive-blocks). Signed-off-by: Nathaniel Graff <nathaniel.graff@sifive.com>
2018-11-28 07:02:13 +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: "sifive,i2c0"
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: i2c-controller.yaml
drivers/i2c: I2C driver for SiFive Freedom Driver for the I2C peripheral in the SiFive Blocks RTL Repository (https://github.com/sifive/sifive-blocks). Signed-off-by: Nathaniel Graff <nathaniel.graff@sifive.com>
2018-11-28 07:02:13 +08:00
properties:
input-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
drivers/i2c: I2C driver for SiFive Freedom Driver for the I2C peripheral in the SiFive Blocks RTL Repository (https://github.com/sifive/sifive-blocks). Signed-off-by: Nathaniel Graff <nathaniel.graff@sifive.com>
2018-11-28 07:02:13 +08:00
description: Frequency of the peripheral input clock.
reg:
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