dt-bindings: nvmem: support describing cells
Subsystems (5)
cover dt-bindings: nvmem: support describing cells
From: Rafał Miłecki <[email protected]>
Michael has recently posted a cleaned up patchset for NVMEM transformations support:
[PATCH 0/8] nvmem: add ethernet address offset support
https://lore.kernel.org/lkml/[email protected]/T/
https://patchwork.ozlabs.org/project/linux-mtd/list/?series=278644&state=*
I find it very important & fully support it. In home routers we very often deal with just one MAC address that:
1. Is a base for calculating multiple Ethernet addresses
2. Can be stored in binary as well as ASCII format
I'd like to suggest just a slightly different solution though. I think that using something like:
otp-1 {
compatible = "kontron,sl28-vpd", "user-otp";
#address-cells = <1>;
#size-cells = <1>;
base_mac_address: base-mac-address@17 {
#nvmem-cell-cells = <1>;
reg = <17 6>;
};
};isn't clear enough and requires too much conditional code in Linux / whatever implementation. DT doesn't make it clear which NVMEM cells are used for what and how should be handled. That has to be hardcoded in a Linux / whatever driver.
My idea is to add "compatible" & additional flags to NVMEM cells. Example:
otp-1 {
compatible = "user-otp";
#address-cells = <1>;
#size-cells = <1>;
base_mac_address: base-mac-address@17 {
compatible = "mac-address";
reg = <17 6>;
#nvmem-cell-cells = <1>;
};
};(for more examples see PATCH 2/2 and its mac-address.yaml .
Rafał Miłecki (2):
dt-bindings: nvmem: extract NVMEM cell to separated file
dt-bindings: nvmem: cells: add MAC address cell
.../devicetree/bindings/nvmem/cells/cell.yaml | 35 +++++++ .../bindings/nvmem/cells/mac-address.yaml | 94 +++++++++++++++++++ .../devicetree/bindings/nvmem/nvmem.yaml | 25 +---- 3 files changed, 131 insertions(+), 23 deletions(-) create mode 100644 Documentation/devicetree/bindings/nvmem/cells/cell.yaml create mode 100644 Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml
Signature · 6 lines
2.31.1 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
PATCH 1/2 dt-bindings: nvmem: extract NVMEM cell to separated file
From: Rafał Miłecki <[email protected]>
This will allow adding binding for more specific cells and reusing (sharing) common code.
--- .../devicetree/bindings/nvmem/cells/cell.yaml | 35 +++++++++++++++++++ .../devicetree/bindings/nvmem/nvmem.yaml | 25 ++----------- 2 files changed, 37 insertions(+), 23 deletions(-) create mode 100644 Documentation/devicetree/bindings/nvmem/cells/cell.yaml
Documentation/devicetree/bindings/nvmem/cells/cell.yaml new file +35 -0
@@ -0,0 +1,35 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/cell.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell + +maintainers: + - Srinivas Kandagatla <[email protected]> + +description: NVMEM cell is a data entry of NVMEM device. + +properties: + reg: + maxItems: 1 + description: + Offset and size in bytes within the storage device. + + bits: + maxItems: 1 + items: + items: + - minimum: 0 + maximum: 7 + description: + Offset in bit within the address range specified by reg. + - minimum: 1 + description: + Size in bit within the address range specified by reg. + +required: + - reg + +additionalProperties: true
Documentation/devicetree/bindings/nvmem/nvmem.yaml +2 -23
@@ -40,29 +40,8 @@ properties: maxItems: 1 patternProperties: - "@[0-9a-f]+(,[0-7])?$": - type: object - - properties: - reg: - maxItems: 1 - description: - Offset and size in bytes within the storage device. - - bits: - maxItems: 1 - items: - items: - - minimum: 0 - maximum: 7 - description: - Offset in bit within the address range specified by reg. - - minimum: 1 - description: - Size in bit within the address range specified by reg. - - required: - - reg + "@[0-9a-f]+$": + $ref: cells/cell.yaml# additionalProperties: true
Signature · 6 lines
2.31.1 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
PATCH 2/2 dt-bindings: nvmem: cells: add MAC address cell
In reply to Rafał MiłeckiFrom: Rafał Miłecki <[email protected]>
This adds support for describing details of NVMEM cell containing MAC address. Those are often device specific and could be nicely stored in DT.
Initial documentation includes support for describing:
1. Cell data format (e.g. Broadcom's NVRAM uses ASCII to store MAC)
2. Reversed bytes flash (required for i.MX6/i.MX7 OCOTP support)
3. Source for multiple addresses (very common in home routers)
--- .../bindings/nvmem/cells/mac-address.yaml | 94 +++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml
Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +94 -0
@@ -0,0 +1,94 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/mac-address.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell containing a MAC address + +maintainers: + - Rafał Miłecki <[email protected]> + +properties: + compatible: + const: mac-address + + format: + description: | + Some NVMEM cells contain MAC in a non-binary format. + + ASCII should be specified if MAC is string formatted like: + - "01:23:45:67:89:AB" (30 31 3a 32 33 3a 34 35 3a 36 37 3a 38 39 3a 41 42) + - "01-23-45-67-89-AB" + - "0123456789AB" + enum: + - ascii + + reversed-bytes: + type: boolean + description: | + MAC is stored in reversed bytes order. Example: + Stored value: AB 89 67 45 23 01 + Actual MAC: 01 23 45 67 89 AB + + base-address: + type: boolean + description: | + Marks NVMEM cell as provider of multiple addresses that are relative to + the one actually stored physically. Respective addresses can be requested + by specifying cell index of NVMEM cell. + +allOf: + - $ref: cell.yaml# + - if: + required: + - base-address + then: + properties: + "#nvmem-cell-cells": + const: 1 + required: + - "#nvmem-cell-cells" + +unevaluatedProperties: false + +examples: + - | + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + partition@f00000 { + compatible = "nvmem-cells"; + label = "calibration"; + reg = <0xf00000 0x100000>; + ranges = <0 0xf00000 0x100000>; + #address-cells = <1>; + #size-cells = <1>; + + mac@100 { + compatible = "mac-address"; + reg = <0x100 0x6>; + }; + + mac@200 { + compatible = "mac-address"; + reg = <0x200 0x6>; + reversed-bytes; + }; + + mac@300 { + compatible = "mac-address"; + reg = <0x300 0x11>; + format = "ascii"; + }; + + mac@400 { + compatible = "mac-address"; + reg = <0x400 0x6>; + base-address; + #nvmem-cell-cells = <1>; + }; + }; + };
Signature · 6 lines
2.31.1 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
Rob Herring
maintainerRe: [PATCH 2/2] dt-bindings: nvmem: cells: add MAC address cell
Quoted 11 lines · Rafał Miłecki
From: Rafał Miłecki <[email protected]>
This adds support for describing details of NVMEM cell containing MAC address. Those are often device specific and could be nicely stored in DT.
Initial documentation includes support for describing:
1. Cell data format (e.g. Broadcom's NVRAM uses ASCII to store MAC)
2. Reversed bytes flash (required for i.MX6/i.MX7 OCOTP support)
3. Source for multiple addresses (very common in home routers)
Quoted 6 lines
Signed-off-by Rafał Miłecki <[email protected]>--- .../bindings/nvmem/cells/mac-address.yaml | 94 +++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
dtschema/dtc warnings/errors:schemas/nvmem/cells/cell.yaml: ignoring, error parsing file
make[1]: *** Deleting file 'Documentation/devicetree/bindings/nvmem/cells/mac-address.example.dt.yaml' schemas/nvmem/cells/cell.yaml: ignoring, error parsing file
Traceback (most recent call last):
File "/usr/local/bin/dt-validate", line 170, in <module>
sg.check_trees(filename, testtree)
File "/usr/local/bin/dt-validate", line 119, in check_trees
self.check_subtree(dt, subtree, False, "/", "/", filename)
File "/usr/local/bin/dt-validate", line 110, in check_subtree
self.check_subtree(tree, value, disabled, name, fullname + name, filename)
File "/usr/local/bin/dt-validate", line 110, in check_subtree
self.check_subtree(tree, value, disabled, name, fullname + name, filename)
File "/usr/local/bin/dt-validate", line 110, in check_subtree
self.check_subtree(tree, value, disabled, name, fullname + name, filename)
[Previous line repeated 1 more time]
File "/usr/local/bin/dt-validate", line 105, in check_subtree
self.check_node(tree, subtree, disabled, nodename, fullname, filename)
File "/usr/local/bin/dt-validate", line 49, in check_node
errors = sorted(dtschema.DTValidator(schema).iter_errors(node), key=lambda e: e.linecol)
File "/usr/local/lib/python3.8/dist-packages/dtschema/lib.py", line 771, in iter_errors
for error in super().iter_errors(instance, _schema):
File "/usr/local/lib/python3.8/dist-packages/jsonschema/validators.py", line 229, in iter_errors
for error in errors:
File "/usr/local/lib/python3.8/dist-packages/jsonschema/_validators.py", line 362, in allOf
yield from validator.descend(instance, subschema, schema_path=index)
File "/usr/local/lib/python3.8/dist-packages/jsonschema/validators.py", line 245, in descend
for error in self.evolve(schema=schema).iter_errors(instance):
File "/usr/local/lib/python3.8/dist-packages/dtschema/lib.py", line 771, in iter_errors
for error in super().iter_errors(instance, _schema):
File "/usr/local/lib/python3.8/dist-packages/jsonschema/validators.py", line 229, in iter_errors
for error in errors:
File "/usr/local/lib/python3.8/dist-packages/jsonschema/_validators.py", line 298, in ref
yield from validator.descend(instance, resolved)
File "/usr/local/lib/python3.8/dist-packages/jsonschema/validators.py", line 245, in descend
for error in self.evolve(schema=schema).iter_errors(instance):
File "/usr/local/lib/python3.8/dist-packages/dtschema/lib.py", line 771, in iter_errors
for error in super().iter_errors(instance, _schema):
File "/usr/local/lib/python3.8/dist-packages/jsonschema/validators.py", line 219, in iter_errors
scope = id_of(_schema)
File "/usr/local/lib/python3.8/dist-packages/jsonschema/validators.py", line 96, in _id_of
return schema.get("$id", "")AttributeError: 'NoneType' object has no attribute 'get'
make[1]: *** [scripts/Makefile.lib:378: Documentation/devicetree/bindings/nvmem/cells/mac-address.example.dt.yaml] Error 1 make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1398: dt_binding_check] Error 2
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/patch/1584227
This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1.
If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date:
pip3 install dtschema --upgrade
Please check and re-submit.
PATCH 1/2 dt-bindings: nvmem: extract NVMEM cell to separated file
In reply to Rafał MiłeckiFrom: Rafał Miłecki <[email protected]>
This will allow adding binding for more specific cells and reusing (sharing) common code.
--- .../devicetree/bindings/nvmem/cells/cell.yaml | 34 +++++++++++++++++++ .../devicetree/bindings/nvmem/nvmem.yaml | 22 +----------- 2 files changed, 35 insertions(+), 21 deletions(-) create mode 100644 Documentation/devicetree/bindings/nvmem/cells/cell.yaml
Documentation/devicetree/bindings/nvmem/cells/cell.yaml new file +34 -0
@@ -0,0 +1,34 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/cell.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell + +maintainers: + - Srinivas Kandagatla <[email protected]> + +description: NVMEM cell is a data entry of NVMEM device. + +properties: + reg: + maxItems: 1 + description: + Offset and size in bytes within the storage device. + + bits: + $ref: /schemas/types.yaml#/definitions/uint32-array + items: + - minimum: 0 + maximum: 7 + description: + Offset in bit within the address range specified by reg. + - minimum: 1 + description: + Size in bit within the address range specified by reg. + +required: + - reg + +additionalProperties: true
Documentation/devicetree/bindings/nvmem/nvmem.yaml +1 -21
@@ -41,27 +41,7 @@ properties: patternProperties: "@[0-9a-f]+(,[0-7])?$": - type: object - - properties: - reg: - maxItems: 1 - description: - Offset and size in bytes within the storage device. - - bits: - $ref: /schemas/types.yaml#/definitions/uint32-array - items: - - minimum: 0 - maximum: 7 - description: - Offset in bit within the address range specified by reg. - - minimum: 1 - description: - Size in bit within the address range specified by reg. - - required: - - reg + $ref: cells/cell.yaml# additionalProperties: true
Signature · 1 line
2.31.1
PATCH 2/2 dt-bindings: nvmem: cells: add MAC address cell
From: Rafał Miłecki <[email protected]>
This adds support for describing details of NVMEM cell containing MAC address. Those are often device specific and could be nicely stored in DT.
Initial documentation includes support for describing:
1. Cell data format (e.g. Broadcom's NVRAM uses ASCII to store MAC)
2. Reversed bytes flash (required for i.MX6/i.MX7 OCOTP support)
3. Source for multiple addresses (very common in home routers)
--- .../bindings/nvmem/cells/mac-address.yaml | 94 +++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml
Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +94 -0
@@ -0,0 +1,94 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/mac-address.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell containing a MAC address + +maintainers: + - Rafał Miłecki <[email protected]> + +properties: + compatible: + const: mac-address + + format: + description: | + Some NVMEM cells contain MAC in a non-binary format. + + ASCII should be specified if MAC is string formatted like: + - "01:23:45:67:89:AB" (30 31 3a 32 33 3a 34 35 3a 36 37 3a 38 39 3a 41 42) + - "01-23-45-67-89-AB" + - "0123456789AB" + enum: + - ascii + + reversed-bytes: + type: boolean + description: | + MAC is stored in reversed bytes order. Example: + Stored value: AB 89 67 45 23 01 + Actual MAC: 01 23 45 67 89 AB + + base-address: + type: boolean + description: | + Marks NVMEM cell as provider of multiple addresses that are relative to + the one actually stored physically. Respective addresses can be requested + by specifying cell index of NVMEM cell. + +allOf: + - $ref: cell.yaml# + - if: + required: + - base-address + then: + properties: + "#nvmem-cell-cells": + const: 1 + required: + - "#nvmem-cell-cells" + +unevaluatedProperties: false + +examples: + - | + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + partition@f00000 { + compatible = "nvmem-cells"; + label = "calibration"; + reg = <0xf00000 0x100000>; + ranges = <0 0xf00000 0x100000>; + #address-cells = <1>; + #size-cells = <1>; + + mac@100 { + compatible = "mac-address"; + reg = <0x100 0x6>; + }; + + mac@200 { + compatible = "mac-address"; + reg = <0x200 0x6>; + reversed-bytes; + }; + + mac@300 { + compatible = "mac-address"; + reg = <0x300 0x11>; + format = "ascii"; + }; + + mac@400 { + compatible = "mac-address"; + reg = <0x400 0x6>; + base-address; + #nvmem-cell-cells = <1>; + }; + }; + };
Signature · 1 line
2.31.1
Rob Herring
maintainerRe: [PATCH REBASED 2/2] dt-bindings: nvmem: cells: add MAC address cell
Quoted 52 lines · Rafał Miłecki
From: Rafał Miłecki <[email protected]>
This adds support for describing details of NVMEM cell containing MAC address. Those are often device specific and could be nicely stored in DT.
Initial documentation includes support for describing:
1. Cell data format (e.g. Broadcom's NVRAM uses ASCII to store MAC)
2. Reversed bytes flash (required for i.MX6/i.MX7 OCOTP support)
3. Source for multiple addresses (very common in home routers)Signed-off-by Rafał Miłecki <[email protected]>--- .../bindings/nvmem/cells/mac-address.yaml | 94 +++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 Documentation/devicetree/bindings/nvmem/cells/mac-address.yamlDocumentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +29
-0@@ -0,0 +1,94 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/mac-address.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell containing a MAC address + +maintainers: + - Rafał Miłecki <[email protected]> + +properties: + compatible: + const: mac-address + + format: + description: | + Some NVMEM cells contain MAC in a non-binary format. + + ASCII should be specified if MAC is string formatted like: + - "01:23:45:67:89:AB" (30 31 3a 32 33 3a 34 35 3a 36 37 3a 38 39 3a 41 42) + - "01-23-45-67-89-AB" + - "0123456789AB" + enum: + - ascii + + reversed-bytes: + type: boolean + description: |
Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml line 39
Quoted 10 lines
Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +10
-0+ MAC is stored in reversed bytes order. Example: + Stored value: AB 89 67 45 23 01 + Actual MAC: 01 23 45 67 89 AB + + base-address: + type: boolean + description: | + Marks NVMEM cell as provider of multiple addresses that are relative to + the one actually stored physically. Respective addresses can be requested + by specifying cell index of NVMEM cell.
While a base address is common, aren't there different ways the base is modified.
The problem with these properties is every new variation results in a new property and the end result is something not well designed. A unique compatible string, "#nvmem-cell-cells" and code to interpret the data is more flexible.
For something like this to fly, I need some level of confidence this is enough for everyone for some time (IOW, find all the previous attempts and get those people's buy-in). You have found at least 3 cases, but I seem to recall more.
Rob
Re: [PATCH REBASED 2/2] dt-bindings: nvmem: cells: add MAC address cell
Quoted 77 lines · Rob Herring
Quoted 63 lines · Rafał Miłecki
From: Rafał Miłecki <[email protected]>
This adds support for describing details of NVMEM cell containing MAC address. Those are often device specific and could be nicely stored in DT.
Initial documentation includes support for describing:
1. Cell data format (e.g. Broadcom's NVRAM uses ASCII to store MAC)
2. Reversed bytes flash (required for i.MX6/i.MX7 OCOTP support)
3. Source for multiple addresses (very common in home routers)Signed-off-by Rafał Miłecki <[email protected]>--- .../bindings/nvmem/cells/mac-address.yaml | 94 +++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644
Documentation/devicetree/bindings/nvmem/cells/mac-address.yamlDocumentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +21
-0@@ -0,0 +1,94 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/mac-address.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell containing a MAC address + +maintainers: + - Rafał Miłecki <[email protected]> + +properties: + compatible: + const: mac-address + + format: + description: | + Some NVMEM cells contain MAC in a non-binary format. + + ASCII should be specified if MAC is string formatted like: + - "01:23:45:67:89:AB" (30 31 3a 32 33 3a 34 35 3a 36 37 3a 3839 3a 41 42)
Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +16
-0+ - "01-23-45-67-89-AB" + - "0123456789AB" + enum: + - ascii + + reversed-bytes: + type: boolean + description: | + MAC is stored in reversed bytes order. Example: + Stored value: AB 89 67 45 23 01 + Actual MAC: 01 23 45 67 89 AB + + base-address: + type: boolean + description: | + Marks NVMEM cell as provider of multiple addresses that areQuoted 4 lines
relative to
+ the one actually stored physically. Respective addresses can be
requested
+ by specifying cell index of NVMEM cell.While a base address is common, aren't there different ways the base is modified.
The problem with these properties is every new variation results in a new property and the end result is something not well designed. A unique compatible string, "#nvmem-cell-cells" and code to interpret the data is more flexible.
Quoted 4 lines
For something like this to fly, I need some level of confidence this is enough for everyone for some time (IOW, find all the previous attempts and get those people's buy-in). You have found at least 3 cases, but I seem to recall more.
For base address I thought of dealing with base + offset only. I'm not sure what are other cases.
I read few old threads:
https://lore.kernel.org/lkml/[email protected]/T/
https://lore.kernel.org/linux-devicetree/[email protected]/
https://lore.kernel.org/all/[email protected]/
https://lore.kernel.org/linux-devicetree/[email protected]/
but didn't find other required /transformations/ except for offset and format. Even "reversed-bytes" wasn't widely discussed (or I missed that) and I just came with it on my own.
If anyone knows other cases: please share so we have a complete view.
I tried to Cc all previously invovled people but it seems only me and Michael remained active in this subject. If anyone knows other interested please Cc them and let us know.
Rob: instead of me and Michael sending patch after patch let me try to gather solutions I can think of / I recall. Please kindly review them and let us know what do you find the cleanest.
1. NVMEM specific "compatible" string
Example:
partition@f00000 {
compatible = "brcm,foo-cells", "nvmem-cells";
label = "calibration";
reg = <0xf00000 0x100000>;
ranges = <0 0xf00000 0x100000>;
#address-cells = <1>;
#size-cells = <1>;
mac@100 {
reg = <0x100 0x6>;
[optional: #nvmem-cell-cells = <1>;]
};
};A minimalistic binding proposed by Michael. DT doesn't carry any information on NVMEM cell format. Specific drivers (e.g. one handling "brcm,foo-cells") have to know how to handle specific cell.
Cell handling conditional code can depend on cell node name ("mac" in above case) OR on value of "nvmem-cell-names" in cell consumer (e.g. nvmem-cell-names = "mac-address").
2. NVMEM specific "compatible" string + cells "compatible"s
Example:
partition@f00000 {
compatible = "brcm,foo-cells", "nvmem-cells";
label = "calibration";
reg = <0xf00000 0x100000>;
ranges = <0 0xf00000 0x100000>;
#address-cells = <1>;
#size-cells = <1>;
mac@100 {
compatible = "mac-address";
reg = <0x100 0x6>;
[optional: #nvmem-cell-cells = <1>;]
};
};Similar to the first case but cells that require special handling are marked with NVMEM device specific "compatible" values. Details of handling cells are still hardcoded in NVMEM driver. Different cells with compatible = "mac-address";
may be handled differencly - depending on parent NVMEM device.
3. Flexible properties in NVMEM cells
Example:
partition@f00000 {
compatible = "brcm,foo-cells", "nvmem-cells";
label = "calibration";
reg = <0xf00000 0x100000>;
ranges = <0 0xf00000 0x100000>;
#address-cells = <1>;
#size-cells = <1>;
mac@100 {
compatible = "mac-address";
reg = <0x100 0x6>;
[optional: #nvmem-cell-cells = <1>;]
};
mac@200 {
compatible = "mac-address";
reg = <0x200 0x6>;
reversed-bytes;
[optional: #nvmem-cell-cells = <1>;]
};
mac@300 {
compatible = "mac-address";
reg = <0x300 0x11>;
format = "ascii";
[optional: #nvmem-cell-cells = <1>;]
};
};This moves details into DT and requires more shared properties. It helps avoiding duplicated code for common cases (like base MAC address).
It's what I proposed in the
[PATCH 0/2] dt-bindings: nvmem: support describing cells
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
Re: [PATCH REBASED 2/2] dt-bindings: nvmem: cells: add MAC address cell
In reply to Rob HerringAm 2022-02-01 16:55, schrieb Rob Herring:
Quoted 72 lines · Rafał Miłecki
Quoted 63 lines
From: Rafał Miłecki <[email protected]>
This adds support for describing details of NVMEM cell containing MAC address. Those are often device specific and could be nicely stored in DT.
Initial documentation includes support for describing:
1. Cell data format (e.g. Broadcom's NVRAM uses ASCII to store MAC)
2. Reversed bytes flash (required for i.MX6/i.MX7 OCOTP support)
3. Source for multiple addresses (very common in home routers)Signed-off-by Rafał Miłecki <[email protected]>--- .../bindings/nvmem/cells/mac-address.yaml | 94 +++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644
Documentation/devicetree/bindings/nvmem/cells/mac-address.yamlDocumentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +21
-0@@ -0,0 +1,94 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/mac-address.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell containing a MAC address + +maintainers: + - Rafał Miłecki <[email protected]> + +properties: + compatible: + const: mac-address + + format: + description: | + Some NVMEM cells contain MAC in a non-binary format. + + ASCII should be specified if MAC is string formatted like: + - "01:23:45:67:89:AB" (30 31 3a 32 33 3a 34 35 3a 36 37 3a 3839 3a 41 42)
Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +16
-0+ - "01-23-45-67-89-AB" + - "0123456789AB" + enum: + - ascii + + reversed-bytes: + type: boolean + description: | + MAC is stored in reversed bytes order. Example: + Stored value: AB 89 67 45 23 01 + Actual MAC: 01 23 45 67 89 AB + + base-address: + type: boolean + description: | + Marks NVMEM cell as provider of multiple addresses that areQuoted 4 lines
relative to
+ the one actually stored physically. Respective addresses can be
requested
+ by specifying cell index of NVMEM cell.While a base address is common, aren't there different ways the base is modified.
Quoted 4 lines
The problem with these properties is every new variation results in a new property and the end result is something not well designed. A unique compatible string, "#nvmem-cell-cells" and code to interpret the data is more flexible.
I actually like having a unique compatible for anything but the basic operations. For example, the sl28 vpd area also has a checksum, which could be handled if there is an own compatible. I don't think this is possible with this proposal. Also there is a version field, what if we change the layout of that thing? Am I supposed to change the device tree? The more I think about Rob's proposal to have a compatible the more I like it.
One of Rafałs concerns are code duplication. I.e. if everything needs its own compatible string, the driver will also have to have all of these. But I'd say, this is a common thing in most drivers.
That being said, I'd really like to have a consens here as this topic is open like forever and I was under the impression that at least we were clear on the device tree side.
-michael
Quoted 6 lines
For something like this to fly, I need some level of confidence this is enough for everyone for some time (IOW, find all the previous attempts and get those people's buy-in). You have found at least 3 cases, but I seem to recall more.
Rob
Rob Herring
maintainerRe: [PATCH REBASED 1/2] dt-bindings: nvmem: extract NVMEM cell to separated file
In reply to Rafał MiłeckiQuoted 8 lines · Rafał Miłecki
From: Rafał Miłecki <[email protected]>
This will allow adding binding for more specific cells and reusing (sharing) common code.
Signed-off-by Rafał Miłecki <[email protected]>--- .../devicetree/bindings/nvmem/cells/cell.yaml | 34 +++++++++++++++++++
Why the 'cells' subdir? cell.yaml is a bit generic for me as DT defines 'cell' which is different from nvmem cell. While we have the path to distinguish, '$ref: cell.yaml' doesn't.
Quoted 81 lines
.../devicetree/bindings/nvmem/nvmem.yaml | 22 +----------- 2 files changed, 35 insertions(+), 21 deletions(-) create mode 100644 Documentation/devicetree/bindings/nvmem/cells/cell.yamlDocumentation/devicetree/bindings/nvmem/cells/cell.yaml new file +34
-0@@ -0,0 +1,34 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/cell.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell + +maintainers: + - Srinivas Kandagatla <[email protected]> + +description: NVMEM cell is a data entry of NVMEM device. + +properties: + reg: + maxItems: 1 + description: + Offset and size in bytes within the storage device. + + bits: + $ref: /schemas/types.yaml#/definitions/uint32-array + items: + - minimum: 0 + maximum: 7 + description: + Offset in bit within the address range specified by reg. + - minimum: 1 + description: + Size in bit within the address range specified by reg. + +required: + - reg + +additionalProperties: trueDocumentation/devicetree/bindings/nvmem/nvmem.yaml +1
-21@@ -41,27 +41,7 @@ properties: patternProperties: "@[0-9a-f]+(,[0-7])?$": - type: object - - properties: - reg: - maxItems: 1 - description: - Offset and size in bytes within the storage device. - - bits: - $ref: /schemas/types.yaml#/definitions/uint32-array - items: - - minimum: 0 - maximum: 7 - description: - Offset in bit within the address range specified by reg. - - minimum: 1 - description: - Size in bit within the address range specified by reg. - - required: - - reg + $ref: cells/cell.yaml# additionalProperties: trueSignature · 1 line
2.31.1
Re: [PATCH REBASED 2/2] dt-bindings: nvmem: cells: add MAC address cell
In reply to Michael WalleQuoted 73 lines · Michael Walle
Am 2022-02-01 16:55, schrieb Rob Herring:
Quoted 67 lines · Rafał Miłecki
Quoted 52 lines
From: Rafał Miłecki <[email protected]>
This adds support for describing details of NVMEM cell containing MAC address. Those are often device specific and could be nicely stored in DT.
Initial documentation includes support for describing:
1. Cell data format (e.g. Broadcom's NVRAM uses ASCII to store MAC)
2. Reversed bytes flash (required for i.MX6/i.MX7 OCOTP support)
3. Source for multiple addresses (very common in home routers)Signed-off-by Rafał Miłecki <[email protected]>---
.../bindings/nvmem/cells/mac-address.yaml | 94 +++++++++++++++++++1 file changed, 94 insertions(+)create mode 100644
Documentation/devicetree/bindings/nvmem/cells/mac-address.yamlDocumentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +29
-0@@ -0,0 +1,94 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/mac-address.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell containing a MAC address + +maintainers: + - Rafał Miłecki <[email protected]> + +properties: + compatible: + const: mac-address + + format: + description: | + Some NVMEM cells contain MAC in a non-binary format. + + ASCII should be specified if MAC is string formatted like: + - "01:23:45:67:89:AB" (30 31 3a 32 33 3a 34 35 3a 36 37 3a 38 39 3a 41 42) + - "01-23-45-67-89-AB" + - "0123456789AB" + enum: + - ascii + + reversed-bytes: + type: boolean + description: |Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml line 39
Quoted 10 lines
Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +10
-0+ MAC is stored in reversed bytes order. Example: + Stored value: AB 89 67 45 23 01 + Actual MAC: 01 23 45 67 89 AB + + base-address: + type: boolean + description: | + Marks NVMEM cell as provider of multiple addresses that are relative to + the one actually stored physically. Respective addresses can be requested + by specifying cell index of NVMEM cell.While a base address is common, aren't there different ways the base is modified.
Quoted 4 lines
The problem with these properties is every new variation results in a new property and the end result is something not well designed. A unique compatible string, "#nvmem-cell-cells" and code to interpret the data is more flexible.
Quoted 7 lines
I actually like having a unique compatible for anything but the basic operations. For example, the sl28 vpd area also has a checksum, which could be handled if there is an own compatible. I don't think this is possible with this proposal. Also there is a version field, what if we change the layout of that thing? Am I supposed to change the device tree? The more I think about Rob's proposal to have a compatible the more I like it.
Having more detailed binding for cells doesn't stop you from using NVMEM device specific binding.
You could have e.g.
partition@f00000 {
compatible = "foo,foo-cells", "nvmem-cells";
(...)
mac@100 {
compatible = "mac-address";
reg = <0x100 0x6>;
};
OR
mac@100 {
compatible = "mac-address";
reg = <0x100 0x11>;
format = "ascii";
};
};Then you can have "foo,foo-cells" driver handling checksum.
I'm not saying we have to use this solution, just saying it's possible.
Re: [PATCH REBASED 2/2] dt-bindings: nvmem: cells: add MAC address cell
In reply to Rafał MiłeckiQuoted 190 lines · Rafał Miłecki
Quoted 72 lines · Rob Herring
Quoted 52 lines · Rafał Miłecki
From: Rafał Miłecki <[email protected]>
This adds support for describing details of NVMEM cell containing MAC address. Those are often device specific and could be nicely stored in DT.
Initial documentation includes support for describing:
1. Cell data format (e.g. Broadcom's NVRAM uses ASCII to store MAC)
2. Reversed bytes flash (required for i.MX6/i.MX7 OCOTP support)
3. Source for multiple addresses (very common in home routers)Signed-off-by Rafał Miłecki <[email protected]>---
.../bindings/nvmem/cells/mac-address.yaml | 94 +++++++++++++++++++1 file changed, 94 insertions(+)create mode 100644
Documentation/devicetree/bindings/nvmem/cells/mac-address.yamlDocumentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +29
-0@@ -0,0 +1,94 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/cells/mac-address.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM cell containing a MAC address + +maintainers: + - Rafał Miłecki <[email protected]> + +properties: + compatible: + const: mac-address + + format: + description: | + Some NVMEM cells contain MAC in a non-binary format. + + ASCII should be specified if MAC is string formatted like: + - "01:23:45:67:89:AB" (30 31 3a 32 33 3a 34 35 3a 36 37 3a 38 39 3a 41 42) + - "01-23-45-67-89-AB" + - "0123456789AB" + enum: + - ascii + + reversed-bytes: + type: boolean + description: |Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml line 39
Quoted 10 lines
Documentation/devicetree/bindings/nvmem/cells/mac-address.yaml new file +10
-0+ MAC is stored in reversed bytes order. Example: + Stored value: AB 89 67 45 23 01 + Actual MAC: 01 23 45 67 89 AB + + base-address: + type: boolean + description: | + Marks NVMEM cell as provider of multiple addresses that are relative to + the one actually stored physically. Respective addresses can be requested + by specifying cell index of NVMEM cell.While a base address is common, aren't there different ways the base is modified.
The problem with these properties is every new variation results in a new property and the end result is something not well designed. A unique compatible string, "#nvmem-cell-cells" and code to interpret the data is more flexible.
Quoted 4 lines
For something like this to fly, I need some level of confidence this is enough for everyone for some time (IOW, find all the previous attempts and get those people's buy-in). You have found at least 3 cases, but I seem to recall more.
For base address I thought of dealing with base + offset only. I'm not sure what are other cases.
I read few old threads:
https://lore.kernel.org/lkml/[email protected]/T/
https://lore.kernel.org/linux-devicetree/[email protected]/
https://lore.kernel.org/all/[email protected]/
https://lore.kernel.org/linux-devicetree/[email protected]/but didn't find other required /transformations/ except for offset and format. Even "reversed-bytes" wasn't widely discussed (or I missed that) and I just came with it on my own.
If anyone knows other cases: please share so we have a complete view.
I tried to Cc all previously invovled people but it seems only me and Michael remained active in this subject. If anyone knows other interested please Cc them and let us know.
Rob: instead of me and Michael sending patch after patch let me try to gather solutions I can think of / I recall. Please kindly review them and let us know what do you find the cleanest.
1. NVMEM specific "compatible" string
Example:
partition@f00000 {
compatible = "brcm,foo-cells", "nvmem-cells"; label = "calibration";
reg = <0xf000000x100000>;
ranges = <00xf000000x100000>; #address-cells = <1>;
#size-cells = <1>;mac@100 {
reg = <0x1000x6>;
[optional: #nvmem-cell-cells = <1>;]
};
};A minimalistic binding proposed by Michael. DT doesn't carry any information on NVMEM cell format. Specific drivers (e.g. one handling "brcm,foo-cells") have to know how to handle specific cell.
Cell handling conditional code can depend on cell node name ("mac" in above case) OR on value of "nvmem-cell-names" in cell consumer (e.g. nvmem-cell-names = "mac-address").
2. NVMEM specific "compatible" string + cells "compatible"s
Example:
partition@f00000 {
compatible = "brcm,foo-cells", "nvmem-cells"; label = "calibration";
reg = <0xf000000x100000>;
ranges = <00xf000000x100000>; #address-cells = <1>;
#size-cells = <1>;mac@100 {
compatible = "mac-address";
reg = <0x1000x6>;
[optional: #nvmem-cell-cells = <1>;]
};
};Similar to the first case but cells that require special handling are marked with NVMEM device specific "compatible" values. Details of handling cells are still hardcoded in NVMEM driver. Different cells with compatible = "mac-address";
may be handled differencly - depending on parent NVMEM device.3. Flexible properties in NVMEM cells
Example:
partition@f00000 {
compatible = "brcm,foo-cells", "nvmem-cells"; label = "calibration";
reg = <0xf000000x100000>;
ranges = <00xf000000x100000>; #address-cells = <1>;
#size-cells = <1>;mac@100 {
compatible = "mac-address";
reg = <0x1000x6>;
[optional: #nvmem-cell-cells = <1>;]
};mac@200 {
compatible = "mac-address";
reg = <0x2000x6>;
reversed-bytes;
[optional: #nvmem-cell-cells = <1>;]
};mac@300 {
compatible = "mac-address";
reg = <0x3000x11>;
format = "ascii";
[optional: #nvmem-cell-cells = <1>;]
};
};
Quoted 5 lines
This moves details into DT and requires more shared properties. It helps avoiding duplicated code for common cases (like base MAC address).
It's what I proposed in the
[PATCH 0/2] dt-bindings: nvmem: support describing cells
Rob: could you review for us 3 above examples, please?