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/mtd/jedec,spi-nor.yaml

27 lines
661 B
YAML
Raw Normal View History

dts: flash: add bindings for jedec,spi-nor Device tree bindings for serial flash chips that support the JEDEC Common Flash Interface. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-01-29 02:26:30 +08:00
# Copyright (c) 2018 Peter Bigot Consulting, LLC
dts: bindings: generalize JEDEC SPI NOR descriptions Currently most SPI NOR serial flash devices are accessed through the spi-nor flash driver, but there are pending enhancements that will access these devices through other driver implementations. Several of the descriptive properties of the flash memories are common regardless of the interface selected. Pull those out to a separate yaml file to be included into the bindings for interface-specific node descriptions. Also revise the documentation to note that the jedec,spi-nor compatible depends on a commands set compatible with the Micron M25P80 serial nor flash; there is no JEDEC standard for these commands. These devices do generally provide descriptive structures defined by JESD216, but currently Zephyr doesn't make use of these structures. The JEDEC CFI standard previously referenced in the description is not relevant to these devices. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2019-11-20 21:45:06 +08:00
# Copyright (c) 2019 Nordic Semiconductor ASA
dts: flash: add bindings for jedec,spi-nor Device tree bindings for serial flash chips that support the JEDEC Common Flash Interface. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-01-29 02:26:30 +08:00
# 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: generalize JEDEC SPI NOR descriptions Currently most SPI NOR serial flash devices are accessed through the spi-nor flash driver, but there are pending enhancements that will access these devices through other driver implementations. Several of the descriptive properties of the flash memories are common regardless of the interface selected. Pull those out to a separate yaml file to be included into the bindings for interface-specific node descriptions. Also revise the documentation to note that the jedec,spi-nor compatible depends on a commands set compatible with the Micron M25P80 serial nor flash; there is no JEDEC standard for these commands. These devices do generally provide descriptive structures defined by JESD216, but currently Zephyr doesn't make use of these structures. The JEDEC CFI standard previously referenced in the description is not relevant to these devices. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2019-11-20 21:45:06 +08:00
description: |
Properties supporting Zephyr spi-nor flash driver (over the Zephyr SPI
API) control of serial flash memories using the standard M25P80-based
command set.
dts: flash: add bindings for jedec,spi-nor Device tree bindings for serial flash chips that support the JEDEC Common Flash Interface. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-01-29 02:26:30 +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: "jedec,spi-nor"
dts: bindings: generalize JEDEC SPI NOR descriptions Currently most SPI NOR serial flash devices are accessed through the spi-nor flash driver, but there are pending enhancements that will access these devices through other driver implementations. Several of the descriptive properties of the flash memories are common regardless of the interface selected. Pull those out to a separate yaml file to be included into the bindings for interface-specific node descriptions. Also revise the documentation to note that the jedec,spi-nor compatible depends on a commands set compatible with the Micron M25P80 serial nor flash; there is no JEDEC standard for these commands. These devices do generally provide descriptive structures defined by JESD216, but currently Zephyr doesn't make use of these structures. The JEDEC CFI standard previously referenced in the description is not relevant to these devices. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2019-11-20 21:45:06 +08:00
include: [spi-device.yaml, "jedec,spi-nor-common.yaml"]
dts: flash: add bindings for jedec,spi-nor Device tree bindings for serial flash chips that support the JEDEC Common Flash Interface. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-01-29 02:26:30 +08:00
properties:
wp-gpios:
dts/bindings: Convert compound to phandle-array type Convert type from compound to phandle-array for various bindings that have properties like like <FOO>-gpios, pwms, clocks, interrupt-extended, etc. that are phandle-array's. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-08-14 21:58:07 +08:00
type: phandle-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: flash: add bindings for jedec,spi-nor Device tree bindings for serial flash chips that support the JEDEC Common Flash Interface. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-01-29 02:26:30 +08:00
description: WPn pin
hold-gpios:
dts/bindings: Convert compound to phandle-array type Convert type from compound to phandle-array for various bindings that have properties like like <FOO>-gpios, pwms, clocks, interrupt-extended, etc. that are phandle-array's. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-08-14 21:58:07 +08:00
type: phandle-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: flash: add bindings for jedec,spi-nor Device tree bindings for serial flash chips that support the JEDEC Common Flash Interface. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-01-29 02:26:30 +08:00
description: HOLDn pin
reset-gpios:
dts/bindings: Convert compound to phandle-array type Convert type from compound to phandle-array for various bindings that have properties like like <FOO>-gpios, pwms, clocks, interrupt-extended, etc. that are phandle-array's. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-08-14 21:58:07 +08:00
type: phandle-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: flash: add bindings for jedec,spi-nor Device tree bindings for serial flash chips that support the JEDEC Common Flash Interface. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-01-29 02:26:30 +08:00
description: RESETn pin