Actually implement nvmem support for mtd
Subsystems (5)
v2 cover Actually implement nvmem support for mtd
The mtd support for the nvmem api has been stalled from 2018 with a patch half pushed hoping that a scheme is found for the mtd name later. This pathset try to address this and add a very needed feature for the mac-address.
My solution to the already discussed problem here [1] is to keep it simple. A mtd subpartition can be set as a nvmem-provider with a specific tag and each direct subnode is treat by the nvmem api as a nvmem-cell and gets correctly registred. The mtd driver will treat a direct subnode of the subpartition as a legacy subpartition of the subpartition using the 'fixed-partition' parser. To fix this every nvmem-cell has to have the 'nvmem-cell' tag and the fixed-partition parser will skip these node if this tag is detected. Simple as that. The subpartition with the tag 'nvmem-provider' will then be set by the config to not skip the of registration in the config and the nvmem-cells are correctly registred and can be used to set mac-address of the devices on the system.
The last 2 patch try to address a problem in the embedded devices (mostly routers) that have the mac-address saved in a dedicated partition and is a ""master"" mac-address. Each device increment or decrement the extracted mac-address based on the device number. The increment function is implemented in the of_net function to get the mac-address that every net driver should allready use if they don't have a trusty mac-address source. (One example of this implementation are many ath10k device that gets the mac-address from the art mtd partition assigned to the network driver and increments it 1 for the wifi 2.4ghz and 2 for the wifi 5ghz).
I really hope my mtd nvmem implementation doesn't conflicts with others and can be used, since this would remove many patch used to get mac-address and other nvmem data.
[1] https://lore.kernel.org/patchwork/patch/765435/
Changes:
v2:
* Fix compile error (missing mtd_node in mtdcore)
Ansuel Smith (4):
mtd: Add nvmem support for mtd nvmem-providers
dt-bindings: mtd: partition: Document use of nvmem-provider
of_net: add mac-address-increment support
dt-bindings: net: Document use of mac-address-increment
.../devicetree/bindings/mtd/partition.txt | 59 +++++++++++++++++++ .../bindings/net/ethernet-controller.yaml | 19 ++++++ drivers/mtd/mtdcore.c | 3 +- drivers/mtd/parsers/ofpart.c | 8 +++ drivers/of/of_net.c | 53 +++++++++++++---- 5 files changed, 129 insertions(+), 13 deletions(-)
Signature · 1 line
2.27.0
PATCH v2 1/4 mtd: Add nvmem support for mtd nvmem-providers
Introduce 2 new bindings for the mtd structure.
Mtd partitions can be set as 'nvmem-provider' and any subpartition defined with the tag 'nvmem-cell' are skipped by the 'fixed-partitions' parser and registred as a nvmem cell by the nvmem api.
--- drivers/mtd/mtdcore.c | 3 ++- drivers/mtd/parsers/ofpart.c | 8 ++++++++ 2 files changed, 10 insertions(+), 1 deletion(-)
drivers/mtd/mtdcore.c +2 -1
@@ -551,6 +551,7 @@ static int mtd_nvmem_reg_read(void *priv, unsigned int offset,static int mtd_nvmem_add (struct mtd_info *mtd) { +struct device_node *mtd_node =mtd_get_of_node (mtd);struct nvmem_config config = {}; config.id =-1 ;
@@ -563,7 +564,7 @@ static int mtd_nvmem_add(struct mtd_info *mtd) config.stride =1 ; config.read_only = true; config.root_only = true; - config.no_of_node = true; + config.no_of_node = !of_property_read_bool (mtd_node,"nvmem-provider" ); config.priv = mtd; mtd->nvmem =nvmem_register (&config);
drivers/mtd/parsers/ofpart.c +8 -0
@@ -61,6 +61,10 @@ static int parse_fixed_partitions(struct mtd_info *master,if (!dedicated &&node_has_compatible (pp))continue ; +/* skip adding if a nvmem-cell is detected */ +if (of_property_read_bool (pp,"nvmem-cell" )) +continue ; + nr_parts++; }
@@ -80,6 +84,10 @@ static int parse_fixed_partitions(struct mtd_info *master,if (!dedicated &&node_has_compatible (pp))continue ; +/* skip adding if a nvmem-cell is detected */ +if (of_property_read_bool (pp,"nvmem-cell" )) +continue ; + reg =of_get_property (pp,"reg" , &len);if (!reg) {if (dedicated) {
Signature · 1 line
2.27.0
PATCH v2 2/4 dt-bindings: mtd: partition: Document use of nvmem-provider
In reply to Ansuel SmithDocument the use of this 2 new bindings, nvmem-provider and nvmem-cell, used to describe the nvmem cell that the subpartition provide to the nvmem api and the system. Nvmem cell are direct subnode of the subpartition and are skipped by the 'fixed-partitions' parser if they contain the 'nvmem-cell' tag. The subpartition must have the 'nvmem-provider' tag or the subpartition will not register the cell to the nvmem api.
--- .../devicetree/bindings/mtd/partition.txt | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+)
Documentation/devicetree/bindings/mtd/partition.txt +59 -0
@@ -64,6 +64,16 @@ Optional properties: - slc-mode: This parameter, if present, allows one to emulate SLC mode on a partition attached to an MLC NAND thus making this partition immune to paired-pages corruptions +- nvmem-provider : Optionally a subpartition can be set as a nvmem-provider. This can + be very useful if some data like the mac-address is stored in a special partition + at a specific offset. Subpartition that describe nvmem-cell must have set the + 'nvmem-cell' of they will be treated as a subpartition and not skipped and registred + as nvmem cells. In this specific case '#address-cells' and '#size-cells' must be + provided. +- nvmem-cell : A direct subnode of a subpartition can be described as a nvmem-cell and + skipped by the fixed-partition parser and registred as a nvmem-cell of the registred + nvmem subpartition IF it does contain the 'nvmem-provider tag. If the subpartition + lacks of such tag the subnode will be skipped and the nvmem api won't register them. Examples:
@@ -158,3 +168,52 @@ flash@3 { }; }; }; + +flash@0 { + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + partition@0 { + label = "u-boot"; + reg = <0x0000000 0x100000>; + read-only; + }; + + art: art@1200000 { + label = "art"; + reg = <0x1200000 0x0140000>; + read-only; + nvmem-provider; + + #address-cells = <1>; + #size-cells = <1>; + + macaddr_gmac1: macaddr_gmac1@0 { + nvmem-cell; + reg = <0x0 0x6>; + }; + + macaddr_gmac2: macaddr_gmac2@6 { + nvmem-cell; + reg = <0x6 0x6>; + }; + + macaddr_wifi: macaddr_wifi@6 { + nvmem-cell; + reg = <0x6 0x6>; + }; + + pre_cal_24g: pre_cal_24g@1000 { + nvmem-cell; + reg = <0x1000 0x2f20>; + }; + + pre_cal_5g: pre_cal_5g@5000{ + nvmem-cell; + reg = <0x5000 0x2f20>; + }; + }; + }; +};
Signature · 1 line
2.27.0
PATCH v2 3/4 of_net: add mac-address-increment support
In reply to Ansuel SmithLots of embedded devices use the mac-address of other interface extracted from nvmem cells and increments it by one or two. Add two bindings to integrate this and directly use the right mac-address for the interface. Some example are some routers that use the gmac mac-address stored in the art partition and increments it by one for the wifi. mac-address-increment-byte bindings is used to tell what byte of the mac-address has to be increased (if not defined the last byte is increased) and mac-address-increment tells how much the byte decided early has to be increased.
--- drivers/of/of_net.c | 53 +++++++++++++++++++++++++++++++++++---------- 1 file changed, 41 insertions(+), 12 deletions(-)
drivers/of/of_net.c +41 -12
@@ -45,7 +45,7 @@ int of_get_phy_mode(struct device_node *np, phy_interface_t *interface) }EXPORT_SYMBOL_GPL (of_get_phy_mode); -static const void *of_get_mac_addr (struct device_node *np,const char *name) +static void *of_get_mac_addr (struct device_node *np,const char *name) {struct property *pp =of_find_property (np, name,NULL );
@@ -54,26 +54,31 @@ static const void *of_get_mac_addr(struct device_node *np, const char *name)return NULL ; } -static const void *of_get_mac_addr_nvmem (struct device_node *np) +static void *of_get_mac_addr_nvmem (struct device_node *np,int *err) {int ret;const void *mac;u8 nvmem_mac[ETH_ALEN ];struct platform_device *pdev =of_find_device_by_node (np); -if (!pdev) -return ERR_PTR (-ENODEV ); +if (!pdev) { + *err = -ENODEV ; +return NULL ; + } ret =nvmem_get_mac_address (&pdev->dev, &nvmem_mac);if (ret) {put_device (&pdev->dev); -return ERR_PTR (ret); + *err = ret; +return NULL ; } mac =devm_kmemdup (&pdev->dev, nvmem_mac,ETH_ALEN ,GFP_KERNEL );put_device (&pdev->dev); -if (!mac) -return ERR_PTR (-ENOMEM ); +if (!mac) { + *err = -ENOMEM ; +return NULL ; + }return mac; }
@@ -98,24 +103,48 @@ static const void *of_get_mac_addr_nvmem(struct device_node *np)* this case, the real MAC is in 'local-mac-address', and 'mac-address' exists * but is all zeros. * +* DT can tell the system to increment the mac-address after is extracted by +* using: +* - mac-address-increment-byte to decide what byte to increase +* (if not defined is increased the last byte) +* - mac-address-increment to decide how much to increase +* * Return: Will be a valid pointer on success and ERR_PTR in case of error. */ const void *of_get_mac_address (struct device_node *np) { -const void *addr; +u32 inc_idx, mac_inc; +int ret =0 ; +u8 *addr; + +/* Check first if the increment byte is present and valid. +* If not set assume to increment the last byte if found. +*/ +if (of_property_read_u32 (np,"mac-address-increment-byte" , &inc_idx)) + inc_idx =5 ; +if (inc_idx >5 ) +return ERR_PTR (-EINVAL ); addr =of_get_mac_addr (np,"mac-address" );if (addr) -return addr; + goto found; addr =of_get_mac_addr (np,"local-mac-address" );if (addr) -return addr; + goto found; addr =of_get_mac_addr (np,"address" );if (addr) -return addr; + goto found; + + addr =of_get_mac_addr_nvmem (np, &ret); +if (ret) +return ERR_PTR (ret); + +found: +if (!of_property_read_u32 (np,"mac-address-increment" , &mac_inc)) + addr[inc_idx] += mac_inc; -return of_get_mac_addr_nvmem (np); +return addr; }EXPORT_SYMBOL (of_get_mac_address);
Signature · 1 line
2.27.0
PATCH v2 4/4 dt-bindings: net: Document use of mac-address-increment
In reply to Ansuel SmithTwo new bindings are now supported by the of_net driver to increase (or decrease) a mac-address. This can be very useful in case where the system extract the mac-address for the device from a dedicated partition and have a generic mac-address that needs to be incremented based on the device number.
- mac-address-increment-byte is used to tell what byte must be incremented (if not set the last byte is increased)
- mac-address-increment is used to tell how much to increment of the extracted mac-address decided byte.
--- .../bindings/net/ethernet-controller.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)
Documentation/devicetree/bindings/net/ethernet-controller.yaml +19 -0
@@ -32,6 +32,25 @@ properties: - minItems: 6 maxItems: 6 + mac-address-increment: + description: + The MAC address can optionally be increased (or decreased using + negative values) from the original value readed (from a nvmem cell + for example). This can be used if the mac is readed from a dedicated + partition and must be increased based on the number of device + present in the system. + minimum: -255 + maximum: 255 + + mac-address-increment-byte: + description: + If 'mac-address-increment' is defined, this will tell what byte of + the mac-address will be increased. If 'mac-address-increment' is + not defined, this option will do nothing. + default: 5 + minimum: 0 + maximum: 5 + max-frame-size: $ref: /schemas/types.yaml#definitions/uint32 description:
Signature · 1 line
2.27.0
Re: [PATCH v2 4/4] dt-bindings: net: Document use of mac-address-increment
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties: · line 38
Quoted 4 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +4
-0+ mac-address-increment: + description: + The MAC address can optionally be increased (or decreased using + negative values) from the original value readed (from a nvmem cell
Read is irregular, there is no readed, just read.
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties: · line 41
Quoted 3 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +3
-0+ for example). This can be used if the mac is readed from a dedicated + partition and must be increased based on the number of device + present in the system.
You should probably add there is no underflow/overflow to other bytes of the MAC address. 00:01:02:03:04:ff + 1 == 00:01:02:03:04:00.
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties: · line 52
Quoted 11 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +11
-0+ minimum: -255 + maximum: 255 + + mac-address-increment-byte: + description: + If 'mac-address-increment' is defined, this will tell what byte of + the mac-address will be increased. If 'mac-address-increment' is + not defined, this option will do nothing. + default: 5 + minimum: 0 + maximum: 5
Is there a real need for this? A value of 0 seems like a bad idea, since a unicast address could easily become a multicast address, which is not valid for an interface address. It also does not seem like a good idea to allow the OUI to be changed. So i think only bytes 3-5 should be allowed, but even then, i don't think this is needed, unless you do have a clear use case.
Andrew
R: [PATCH v2 4/4] dt-bindings: net: Document use of mac-address-increment
Quoted 21 lines
-----Messaggio originale-----
Da: Andrew Lunn <[email protected]>
Inviato: domenica 20 settembre 2020 02:31
A: Ansuel Smith <[email protected]>
Cc: Miquel Raynal <[email protected]>; Richard Weinberger <[email protected]>; Vignesh Raghavendra <[email protected]>; Rob Herring <[email protected]>; David S. Miller <[email protected]>; Jakub Kicinski <[email protected]>; Heiner Kallweit <[email protected]>; Russell King <[email protected]>; Frank Rowand <[email protected]>; Boris Brezillon <[email protected]>; linux- [email protected]; [email protected]; linux- [email protected]; [email protected]
Oggetto: Re: [PATCH v2 4/4] dt-bindings: net: Document use of mac- address-incrementQuoted 4 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +4
-0+ mac-address-increment: + description: + The MAC address can optionally be increased (or decreased using + negative values) from the original value readed (from a nvmem
cell
Quoted 4 lines
Read is irregular, there is no readed, just read.
Quoted 1 line
+ for example). This can be used if the mac is readed from a
dedicated
Quoted 12 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties: · line 41
Quoted 2 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +2
-0+ partition and must be increased based on the number of device + present in the system.You should probably add there is no underflow/overflow to other bytes of the MAC address. 00:01:02:03:04:ff + 1 == 00:01:02:03:04:00.
Quoted 6 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +6
-0+ minimum: -255 + maximum: 255 + + mac-address-increment-byte: + description: + If 'mac-address-increment' is defined, this will tell what byte
of
Quoted 6 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties: · line 52
Quoted 5 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +5
-0+ the mac-address will be increased. If 'mac-address-increment' is + not defined, this option will do nothing. + default: 5 + minimum: 0 + maximum: 5
Quoted 8 lines
Is there a real need for this? A value of 0 seems like a bad idea, since a unicast address could easily become a multicast address, which is not valid for an interface address. It also does not seem like a good idea to allow the OUI to be changed. So i think only bytes 3-5 should be allowed, but even then, i don't think this is needed, unless you do have a clear use case.
Andrew
Honestly the mac-address-increment-byte is added to give user some control but I
don't really have a use case for it. Should I limit it to 3 or just remove the function?
Will address the other 2 comment in v3.
Thx for review.
Re: R: [PATCH v2 4/4] dt-bindings: net: Document use of mac-address-increment
Quoted 53 lines · On Sun, Sep 20, 2020 at 02:39:39AM +0200, [email protected] wrote:
Quoted 21 lines
-----Messaggio originale-----
Da: Andrew Lunn <[email protected]>
Inviato: domenica 20 settembre 2020 02:31
A: Ansuel Smith <[email protected]>
Cc: Miquel Raynal <[email protected]>; Richard Weinberger <[email protected]>; Vignesh Raghavendra <[email protected]>; Rob Herring <[email protected]>; David S. Miller <[email protected]>; Jakub Kicinski <[email protected]>; Heiner Kallweit <[email protected]>; Russell King <[email protected]>; Frank Rowand <[email protected]>; Boris Brezillon <[email protected]>; linux- [email protected]; [email protected]; linux- [email protected]; [email protected]
Oggetto: Re: [PATCH v2 4/4] dt-bindings: net: Document use of mac- address-incrementQuoted 4 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +4
-0+ mac-address-increment: + description: + The MAC address can optionally be increased (or decreased using + negative values) from the original value readed (from a nvmemcell
Quoted 4 lines
Read is irregular, there is no readed, just read.
Quoted 1 line
+ for example). This can be used if the mac is readed from a
dedicated
Quoted 12 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties: · line 41
Quoted 2 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +2
-0+ partition and must be increased based on the number of device + present in the system.You should probably add there is no underflow/overflow to other bytes of the MAC address. 00:01:02:03:04:ff + 1 == 00:01:02:03:04:00.
Quoted 6 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +6
-0+ minimum: -255 + maximum: 255 + + mac-address-increment-byte: + description: + If 'mac-address-increment' is defined, this will tell what byteof
Quoted 13 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties: · line 52
Quoted 5 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +5
-0+ the mac-address will be increased. If 'mac-address-increment' is + not defined, this option will do nothing. + default: 5 + minimum: 0 + maximum: 5Is there a real need for this? A value of 0 seems like a bad idea, since a unicast address could easily become a multicast address, which is not valid for an interface address. It also does not seem like a good idea to allow the OUI to be changed. So i think only bytes 3-5 should be allowed, but even then, i don't think this is needed, unless you do have a clear use case.
Quoted 6 lines
Quoted 1 line
Andrew
Honestly the mac-address-increment-byte is added to give user some control but I
don't really have a use case for it. Should I limit it to 3 or just remove the function?
If you have no use case, just remove it and document that last byte will be incremented. I somebody does need it, it can be added in a backwards compatible way.
Andrew
RE: R: [PATCH v2 4/4] dt-bindings: net: Document use of mac-address-increment
Quoted 10 lines
Quoted 8 lines · On Sun, Sep 20, 2020 at 02:39:39AM +0200, [email protected] wrote:
Quoted 8 lines
-----Messaggio originale-----
Da: Andrew Lunn <[email protected]>
Inviato: domenica 20 settembre 2020 02:31
A: Ansuel Smith <[email protected]>
Cc: Miquel Raynal <[email protected]>; Richard Weinberger <[email protected]>; Vignesh Raghavendra <[email protected]>; Rob
Quoted 14 lines
Herring
Quoted 4 lines
Quoted 4 lines
<[email protected]>; David S. Miller <[email protected]>; Jakub Kicinski <[email protected]>; Heiner Kallweit <[email protected]>; Russell King <[email protected]>; Frank Rowand <[email protected]>; Boris Brezillon <[email protected]>;
linux-
Quoted 8 lines
Quoted 8 lines
[email protected]; [email protected]; linux- [email protected]; [email protected]
Oggetto: Re: [PATCH v2 4/4] dt-bindings: net: Document use of mac- address-incrementQuoted 3 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +3
-0+ mac-address-increment: + description: + The MAC address can optionally be increased (or decreased
using
Quoted 13 lines
Quoted 13 lines
Quoted 1 line
Quoted 1 line
+ negative values) from the original value readed (from a nvmem
cell
Quoted 4 lines
Read is irregular, there is no readed, just read.
Quoted 1 line
+ for example). This can be used if the mac is readed from a
dedicated
Quoted 6 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties: · line 41
Quoted 2 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +2
-0+ partition and must be increased based on the number of device + present in the system.You should probably add there is no underflow/overflow to other bytes of the MAC address. 00:01:02:03:04:ff + 1 == 00:01:02:03:04:00.
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties:
Quoted 6 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +6
-0+ minimum: -255 + maximum: 255 + + mac-address-increment-byte: + description: + If 'mac-address-increment' is defined, this will tell what
byte
Quoted 2 lines
Quoted 2 lines
of
Quoted 1 line
Quoted 1 line
+ the mac-address will be increased. If 'mac-address-increment'
is
Quoted 12 lines
Quoted 12 lines
Quoted 12 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml properties: · line 52
Quoted 4 lines
Documentation/devicetree/bindings/net/ethernet-controller.yaml +4
-0+ not defined, this option will do nothing. + default: 5 + minimum: 0 + maximum: 5Is there a real need for this? A value of 0 seems like a bad idea, since a unicast address could easily become a multicast address, which is not valid for an interface address. It also does not seem like a good idea to allow the OUI to be changed. So i think only bytes 3-5 should be allowed, but even then, i don't think this is needed, unless you do have a clear use case.
Quoted 6 lines
Quoted 3 lines
Quoted 1 line
Andrew
Honestly the mac-address-increment-byte is added to give user some
control
Quoted 2 lines
but I
don't really have a use case for it. Should I limit it to 3 or just
remove
Quoted 7 lines
Quoted 1 line
the function?
If you have no use case, just remove it and document that last byte will be incremented. I somebody does need it, it can be added in a backwards compatible way.
Andrew
I just rechecked mac-address-increment-byte and we have one device that use it and would benefits from this. I will change the Documentation to min 3 and leave it.