block: implement NVMEM provider
Subsystems (3)
cover block: implement NVMEM provider
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
---
This series has previously been submitted as RFC on July 19th 2023[1] and most of the basic idea did not change since. Another round of RFC was submitted on March 5th 2024[2] which has received overall positive feedback and only minor corrections have been done since (see changelog below).
[1]: https://patchwork.kernel.org/project/linux-block/list/?series=767565
[2]: https://patchwork.kernel.org/project/linux-block/list/?series=832705
Changes since RFC:
* Use 'partuuid' instead of reserved 'uuid' keyword to match against PARTUUID.
* Simplify blk_nvmem_init(void) function.
Daniel Golle (8):
dt-bindings: block: add basic bindings for block devices
block: partitions: populate fwnode
block: add new genhd flag GENHD_FL_NVMEM
block: implement NVMEM provider
dt-bindings: mmc: mmc-card: add block device nodes
mmc: core: set card fwnode_handle
mmc: block: set fwnode of disk devices
mmc: block: set GENHD_FL_NVMEM
.../bindings/block/block-device.yaml | 22 +++ .../devicetree/bindings/block/partition.yaml | 51 ++++++ .../devicetree/bindings/block/partitions.yaml | 20 +++ .../devicetree/bindings/mmc/mmc-card.yaml | 45 +++++ MAINTAINERS | 5 + block/Kconfig | 9 + block/Makefile | 1 + block/blk-nvmem.c | 169 ++++++++++++++++++ block/partitions/core.c | 41 +++++ drivers/mmc/core/block.c | 8 + drivers/mmc/core/bus.c | 2 + include/linux/blkdev.h | 2 + 12 files changed, 375 insertions(+) create mode 100644 Documentation/devicetree/bindings/block/block-device.yaml create mode 100644 Documentation/devicetree/bindings/block/partition.yaml create mode 100644 Documentation/devicetree/bindings/block/partitions.yaml create mode 100644 block/blk-nvmem.c
Signature · 1 line
2.44.0
PATCH 1/8 dt-bindings: block: add basic bindings for block devices
Add bindings for block devices which are used to allow referencing nvmem bits on them.
--- .../bindings/block/block-device.yaml | 22 ++++++++ .../devicetree/bindings/block/partition.yaml | 51 +++++++++++++++++++ .../devicetree/bindings/block/partitions.yaml | 20 ++++++++ 3 files changed, 93 insertions(+) create mode 100644 Documentation/devicetree/bindings/block/block-device.yaml create mode 100644 Documentation/devicetree/bindings/block/partition.yaml create mode 100644 Documentation/devicetree/bindings/block/partitions.yaml
Documentation/devicetree/bindings/block/block-device.yaml new file +22 -0
@@ -0,0 +1,22 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/block/block-device.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: block storage device + +description: | + This binding is generic and describes a block-oriented storage device. + +maintainers: + - Daniel Golle <[email protected]> + +properties: + partitions: + $ref: /schemas/block/partitions.yaml + + nvmem-layout: + $ref: /schemas/nvmem/layouts/nvmem-layout.yaml# + +unevaluatedProperties: false
Documentation/devicetree/bindings/block/partition.yaml new file +51 -0
51 lines not on this page · raw message
Documentation/devicetree/bindings/block/partitions.yaml new file +20 -0
@@ -0,0 +1,20 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/block/partitions.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Partitions on block devices + +description: | + This binding is generic and describes the content of the partitions container + node. + +maintainers: + - Daniel Golle <[email protected]> + +patternProperties: + "^block-partition-.+$": + $ref: partition.yaml + +unevaluatedProperties: false
Signature · 1 line
2.44.0
Re: [PATCH 1/8] dt-bindings: block: add basic bindings for block devices
Quoted 26 lines · Daniel Golle
+$id: http://devicetree.org/schemas/block/partition.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#Documentation/devicetree/bindings/block/partition.yaml new file +24
-0+ +title: Partition on a block device + +description: | + This binding describes a partition on a block device. + Partitions may be matched by a combination of partition number, name, + and UUID. + +maintainers: + - Daniel Golle <[email protected]> + +properties: + $nodename: + pattern: '^block-partition-.+$' + + partnum: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Matches partition by number if present. + + partname: + $ref: /schemas/types.yaml#/definitions/string + description: + Matches partition by PARTNAME if present.
Documentation/devicetree/bindings/block/partition.yaml line 39
Quoted 10 lines
Documentation/devicetree/bindings/block/partition.yaml new file +10
-0+ + partuuid: + $ref: /schemas/types.yaml#/definitions/string + description: + Matches partition by PARTUUID if present. + + nvmem-layout: + $ref: /schemas/nvmem/layouts/nvmem-layout.yaml# + description: + This container may reference an NVMEM layout parser.
Does the above imply that only systems with a single block device are supported?
Supporting partition numbers seems unfortunate to me. Partition numbers will change if the partition scheme changes.
Bart.
Re: [PATCH 1/8] dt-bindings: block: add basic bindings for block devices
Quoted 32 lines · Bart Van Assche
Quoted 31 lines · Daniel Golle
+$id: http://devicetree.org/schemas/block/partition.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#Documentation/devicetree/bindings/block/partition.yaml new file +29
-0+ +title: Partition on a block device + +description: | + This binding describes a partition on a block device. + Partitions may be matched by a combination of partition number, name, + and UUID. + +maintainers: + - Daniel Golle <[email protected]> + +properties: + $nodename: + pattern: '^block-partition-.+$' + + partnum: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Matches partition by number if present. + + partname: + $ref: /schemas/types.yaml#/definitions/string + description: + Matches partition by PARTNAME if present. + + partuuid: + $ref: /schemas/types.yaml#/definitions/string + description: + Matches partition by PARTUUID if present.
Quoted 8 lines
Documentation/devicetree/bindings/block/partition.yaml line 39
Quoted 5 lines
Documentation/devicetree/bindings/block/partition.yaml new file +5
-0+ + nvmem-layout: + $ref: /schemas/nvmem/layouts/nvmem-layout.yaml# + description: + This container may reference an NVMEM layout parser.Does the above imply that only systems with a single block device are supported?
Absolutely not. Of course also such devices often have multiple block devices, typically eMMC, NVMe and SD card are supported, some also come with SATA ports. The block device(s) relevant as NVMEM providers has/have to be referenced and the 'partitions' node is a child node of a specific block device, of course.
Quoted 3 lines
Supporting partition numbers seems unfortunate to me. Partition numbers will change if the partition scheme changes.
I fully argee with that, and using partnum as an identifier is not very smart. However, this is what some vendors are doing (in custom downstream drivers or scripts running in early userland) and hence the kernel implementation should allow to identify the relevant location in exactly the same way to be sure we are always compatible.
PATCH 2/8 block: partitions: populate fwnode
In reply to Daniel GolleLet block partitions to be represented by a firmware node and hence allow them to being referenced e.g. for use with blk-nvmem.
--- block/partitions/core.c | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+)
block/partitions/core.c +41 -0
@@ -10,6 +10,8 @@#include <linux/ctype.h> #include <linux/vmalloc.h> #include <linux/raid/detect.h> +#include <linux/property.h> +#include "check.h" static int (*const check_part[])(struct parsed_partitions *) = {
@@ -281,6 +283,43 @@ static ssize_t whole_disk_show(struct device *dev, } static const DEVICE_ATTR(whole_disk, 0444, whole_disk_show, NULL); +static struct fwnode_handle *find_partition_fwnode (struct block_device *bdev) +{ +struct fwnode_handle *fw_parts, *fw_part; +struct device *ddev =disk_to_dev (bdev->bd_disk); +const char *partname, *partuuid; +u32 partno; + + fw_parts =device_get_named_child_node (ddev,"partitions" ); +if (!fw_parts) + fw_parts =device_get_named_child_node (ddev->parent,"partitions" ); + +if (!fw_parts) +return NULL ; + +fwnode_for_each_child_node (fw_parts, fw_part) { +if (!fwnode_property_read_string (fw_part,"partuuid" , &partuuid) && + (!bdev->bd_meta_info ||strncmp (partuuid, + bdev->bd_meta_info->uuid, +PARTITION_META_INFO_UUIDLTH ))) +continue ; + +if (!fwnode_property_read_string (fw_part,"partname" , &partname) && + (!bdev->bd_meta_info ||strncmp (partname, + bdev->bd_meta_info->volname, +PARTITION_META_INFO_VOLNAMELTH ))) +continue ; + +if (!fwnode_property_read_u32 (fw_part,"partno" , &partno) && + bdev->bd_partno != partno) +continue ; + +return fw_part; + } + +return NULL ; +} +/* * Must be called either with open_mutex held, before a disk can be opened or * after all disk users are gone.
@@ -355,6 +394,8 @@ static struct block_device *add_partition(struct gendisk *disk, int partno, goto out_put; } +device_set_node (pdev,find_partition_fwnode (bdev)); +/* delay uevent until 'holders' subdir is created */ dev_set_uevent_suppress (pdev,1 ); err =device_add (pdev);
Signature · 1 line
2.44.0
PATCH 3/8 block: add new genhd flag GENHD_FL_NVMEM
In reply to Daniel GolleAdd new flag to destinguish block devices which may act as an NVMEM provider.
--- include/linux/blkdev.h | 2 ++ 1 file changed, 2 insertions(+)
include/linux/blkdev.h +2 -0
@@ -81,11 +81,13 @@ struct partition_meta_info {* ``GENHD_FL_NO_PART``: partition support is disabled. The kernel will not * scan for partitions from add_disk, and users can't add partitions manually. * +* ``GENHD_FL_NVMEM``: the block device should be considered as NVMEM provider. */ enum {GENHD_FL_REMOVABLE =1 <<0 ,GENHD_FL_HIDDEN =1 <<1 ,GENHD_FL_NO_PART =1 <<2 , +GENHD_FL_NVMEM =1 <<3 , };enum {
Signature · 1 line
2.44.0
Re: [PATCH 3/8] block: add new genhd flag GENHD_FL_NVMEM
Quoted 14 lines · Daniel Golle
Add new flag to destinguish block devices which may act as an NVMEM provider.
Signed-off-by Daniel Golle <[email protected]>--- include/linux/blkdev.h | 2 ++ 1 file changed, 2 insertions(+)include/linux/blkdev.h +0
-0@@ -81,11 +81,13 @@ struct partition_meta_info {* ``GENHD_FL_NO_PART``: partition support is disabled. The kernel will not
include/linux/blkdev.h struct partition_meta_info { · line 91
Quoted 10 lines
include/linux/blkdev.h +2
-0* scan for partitions from add_disk, and users can't add partitions manually. * +* ``GENHD_FL_NVMEM``: the block device should be considered as NVMEM provider. */ enum {GENHD_FL_REMOVABLE =1 <<0 ,GENHD_FL_HIDDEN =1 <<1 ,GENHD_FL_NO_PART =1 <<2 , +GENHD_FL_NVMEM =1 <<3 , };
What would break if this flag wouldn't exist?
Thanks,
Bart.
Re: [PATCH 3/8] block: add new genhd flag GENHD_FL_NVMEM
Quoted 19 lines · Bart Van Assche
Quoted 18 lines · Daniel Golle
Add new flag to destinguish block devices which may act as an NVMEM provider.
Signed-off-by Daniel Golle <[email protected]>--- include/linux/blkdev.h | 2 ++ 1 file changed, 2 insertions(+)include/linux/blkdev.h +1
-0@@ -81,11 +81,13 @@ struct partition_meta_info {* ``GENHD_FL_NO_PART``: partition support is disabled. The kernel will not * scan for partitions from add_disk, and users can't add partitions manually. * +* ``GENHD_FL_NVMEM``: the block device should be considered as NVMEM provider. */
Quoted 8 lines
include/linux/blkdev.h struct partition_meta_info { · line 91
Quoted 6 lines
include/linux/blkdev.h +1
-0enum {GENHD_FL_REMOVABLE =1 <<0 ,GENHD_FL_HIDDEN =1 <<1 ,GENHD_FL_NO_PART =1 <<2 , +GENHD_FL_NVMEM =1 <<3 , };What would break if this flag wouldn't exist?
As both, MTD and UBI already act as NVMEM providers themselves, once the user creates a ubiblock device or got CONFIG_MTD_BLOCK=y set in their kernel configuration, we would run into problems because both, the block layer as well as MTD or UBI would try to be an NVMEM provider for the same device tree node.
I intially suggested the invert of this flag, GENHD_FL_NO_NVMEM which would be set only for mtdblock and ubiblock devices to opt-out of acting as NVMEM proviers. However, in a previous comment [1] on the RFC it was requested to make this opt-in instead.
Re: [PATCH 3/8] block: add new genhd flag GENHD_FL_NVMEM
Quoted 11 lines · Daniel Golle
Quoted 9 lines · Bart Van Assche
include/linux/blkdev.h struct partition_meta_info { · line 91
Quoted 6 lines · Daniel Golle
enum { GENHD_FL_REMOVABLE = 1 << 0, GENHD_FL_HIDDEN = 1 << 1, GENHD_FL_NO_PART = 1 << 2,include/linux/blkdev.h +1
-0+ GENHD_FL_NVMEM = 1 << 3, };What would break if this flag wouldn't exist?
Quoted 5 lines
As both, MTD and UBI already act as NVMEM providers themselves, once the user creates a ubiblock device or got
CONFIG_MTD_BLOCK=yset in their kernel configuration, we would run into problems because both, the block layer as well as MTD or UBI would try to be an NVMEM provider for the same device tree node.
Why would both MTD and UBI try to be an NVMEM provider for the same device tree node? Why can't this patch series be implemented such that a partition UUID occurs in the device tree and such that other code scans for that partition UUID?
Thanks,
Bart.
Re: [PATCH 3/8] block: add new genhd flag GENHD_FL_NVMEM
Quoted 12 lines · Bart Van Assche
Quoted 11 lines · Daniel Golle
Quoted 9 lines · Bart Van Assche
include/linux/blkdev.h struct partition_meta_info { · line 91
Quoted 6 lines · Daniel Golle
enum { GENHD_FL_REMOVABLE = 1 << 0, GENHD_FL_HIDDEN = 1 << 1, GENHD_FL_NO_PART = 1 << 2,include/linux/blkdev.h +1
-0+ GENHD_FL_NVMEM = 1 << 3, };What would break if this flag wouldn't exist?
Quoted 8 lines
Quoted 5 lines
As both, MTD and UBI already act as NVMEM providers themselves, once the user creates a ubiblock device or got
CONFIG_MTD_BLOCK=yset in their kernel configuration, we would run into problems because both, the block layer as well as MTD or UBI would try to be an NVMEM provider for the same device tree node.Why would both MTD and UBI try to be an NVMEM provider for the same device tree node?
I didn't mean that both MTD and UBI would **simultanously** try to act as NVMEM providers for the same device tree node. What I meant was that either of them can act as an NVMEM provider while at the same time also providing an emulated block device (mtdblock xor ubiblock).
Hence those emulated block devices will have to be excluded from acting as NVMEM providers. In this patch I suggest to do this by opt-in of block drivers which should potentially provide NVMEM (typically mmcblk).
I apologize for the confusion and assume that wasn't clear from the wording I've used. I hope it's more clear now.
Alternatively it could also be solved via opt-out of ubiblock and mtdblock devices using the inverted flag (GENHD_FL_NO_NVMEM) -- however, this has previously been criticized and I was asked to rather make it opt-in.[1]
Quoted 3 lines
Why can't this patch series be implemented such that
a partition UUID occurs in the device tree and such that other code scans for that partition UUID?
This is actually one way this very series allows one to handle this:
by identifying a partition using its partuuid.
However, it's also quite common that the MMC boot **hardware** partitions are used to store MAC addresses and/or Wi-Fi calibration data. In this case there is no partition table and the NVMEM provider has to act directly on the whole disk device (which is only a few megabytes in size in case of those mmcblkXbootY devices and never has a partition table).
PATCH 4/8 block: implement NVMEM provider
In reply to Daniel GolleOn embedded devices using an eMMC it is common that one or more partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data. Allow referencing the partition in device tree for the kernel and Wi-Fi drivers accessing it via the NVMEM layer.
--- MAINTAINERS | 5 ++ block/Kconfig | 9 +++ block/Makefile | 1 + block/blk-nvmem.c | 169 ++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 184 insertions(+) create mode 100644 block/blk-nvmem.c
MAINTAINERS +5 -0
@@ -3662,6 +3662,11 @@ L: [email protected] S: Maintained F: drivers/mtd/devices/block2mtd.c +BLOCK NVMEM DRIVER +M: Daniel Golle <[email protected]> +S: Maintained +F: block/blk-nvmem.c + BLUETOOTH DRIVERS M: Marcel Holtmann <[email protected]> M: Luiz Augusto von Dentz <[email protected]>
block/Kconfig +9 -0
@@ -229,6 +229,15 @@ config BLK_INLINE_ENCRYPTION_FALLBACK by falling back to the kernel crypto API when inline encryption hardware is not present. +config BLK_NVMEM + bool "Block device NVMEM provider" + depends on OF + depends on NVMEM + help + Allow block devices (or partitions) to act as NVMEM prodivers, + typically used with eMMC to store MAC addresses or Wi-Fi + calibration data on embedded devices. + source "block/partitions/Kconfig" config BLK_MQ_PCI
block/Makefile +1 -0
@@ -34,6 +34,7 @@ obj-$(CONFIG_BLK_DEV_ZONED) += blk-zoned.o obj-$(CONFIG_BLK_WBT) += blk-wbt.o obj-$(CONFIG_BLK_DEBUG_FS) += blk-mq-debugfs.o obj-$(CONFIG_BLK_DEBUG_FS_ZONED)+= blk-mq-debugfs-zoned.o +obj-$(CONFIG_BLK_NVMEM) += blk-nvmem.o obj-$(CONFIG_BLK_SED_OPAL) += sed-opal.o obj-$(CONFIG_BLK_PM) += blk-pm.o obj-$(CONFIG_BLK_INLINE_ENCRYPTION) += blk-crypto.o blk-crypto-profile.o \
block/blk-nvmem.c new file +169 -0
169 lines not on this page · raw message
Signature · 1 line
2.44.0
Quoted 4 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data. Allow referencing the partition in device tree for the kernel and Wi-Fi drivers accessing it via the NVMEM layer.
Why to store calibration data in a partition instead of in a file on a filesystem?
MAINTAINERS L: [email protected] · line 3668
Quoted 12 lines
MAINTAINERS +4
-0@@ -3662,6 +3662,11 @@ L: [email protected] S: Maintained F: drivers/mtd/devices/block2mtd.c +BLOCK NVMEM DRIVER +M: Daniel Golle <[email protected]> +S: Maintained +F: block/blk-nvmem.c
Why to add this functionality to the block layer instead of somewhere in the drivers/ directory?
Thanks,
Bart.
Hi Bart,
thank you for looking at the patches!
Quoted 8 lines · Bart Van Assche
Quoted 4 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data. Allow referencing the partition in device tree for the kernel and Wi-Fi drivers accessing it via the NVMEM layer.
Why to store calibration data in a partition instead of in a file on a filesystem?
First of all, it's just how it is already in the practical world out there. The same methods for mass-production are used independently of the type of flash memory, so vendors don't care if in Linux the flash ends up as MMC/block (in case of an eMMC) device or MTD device (in case of SPI-NOR, for example). I can name countless devices of numerous vendors following this generally very common practise (and then ending up extracting that using ugly custom drivers, or poking around in the block devices in early userland, ... none of it is nice, which is the motivation for this series).
Adtran, GL-iNet, Netgear, ... to name just a few very popular vendors.
The devices are already out there, and the way they store those details is considered part of the low level firmware which will never change. Yet it would be nice to run vanilla Linux on them (or OpenWrt), and make sure things like NFS root can work, and for that the MAC address needs to be in place already, ie. extracting it in userland would be too late.
However, I also believe there is nothing wrong with that and using a filesystem comes with many additional pitfalls, such as being possibly not cleanly unmounted, the file could be renamed or deleted by the user, .... All that should not result in a device not having it's proper MAC address any more.
Why have all the complexity for something as simple as storing 6 bytes of MAC address?
I will not re-iterate over all that discussion now, you may look at list archives where this has been explained and discussed also for the first run of the RFC series last year.
Quoted 15 lines
MAINTAINERS L: [email protected] · line 3667
Quoted 12 lines
MAINTAINERS +4
-0@@ -3662,6 +3662,11 @@ L: [email protected] S: Maintained F: drivers/mtd/devices/block2mtd.c +BLOCK NVMEM DRIVER +M: Daniel Golle <[email protected]> +S: Maintained +F: block/blk-nvmem.cWhy to add this functionality to the block layer instead of somewhere in the
drivers/directory?
Simply because we need notifications about appearing and disappearing block devices, or a way to iterate over all block devices in a system. For both there isn't currently any other interface than using a class_interface for that, and that requires access to &block_class which is considered a block subsystem internal.
Also note that the same is true for the MTD NVMEM provider (in drivers/mtd/mtdcore.c) as well as the UBI NVMEM provider (in drivers/mtd/ubi/nvmem.c), both are considered an integral part of their corresponding subsystems -- despite the fact that in those cases this wouldn't even be stricktly needed as for MTD we got register_mtd_user() and for UBI we'd have ubi_register_volume_notifier().
Doing it differently for block devices would hence not only complicate things unnessesarily, it would also be inconsistent.
Quoted 9 lines · Daniel Golle
Quoted 2 lines · Bart Van Assche
Why to add this functionality to the block layer instead of somewhere in the
drivers/directory?Simply because we need notifications about appearing and disappearing block devices, or a way to iterate over all block devices in a system. For both there isn't currently any other interface than using a
class_interfacefor that, and that requires access to&block_classwhich is considered a block subsystem internal.
That's an argument for adding an interface to the block layer that implements this functionality but not for adding this code in the block layer.
Thanks,
Bart.
Quoted 11 lines · Bart Van Assche
Quoted 9 lines · Daniel Golle
Quoted 2 lines · Bart Van Assche
Why to add this functionality to the block layer instead of somewhere in the
drivers/directory?Simply because we need notifications about appearing and disappearing block devices, or a way to iterate over all block devices in a system. For both there isn't currently any other interface than using a
class_interfacefor that, and that requires access to&block_classwhich is considered a block subsystem internal.
Quoted 3 lines
That's an argument for adding an interface to the block layer that implements this functionality but not for adding this code in the block layer.
Fine with me. I can implement such an interface, similar to how it is implemented for MTD devices or UBI volumes for the block layer.
I would basically add a subscription and callback interface utilizing a class_interface inside the block subsystem similar to how the same is done in this series for registering block-device-backed NVMEM providers.
However, given that this is a bigger task, I'd like to know from more than one block subsystem maintainer that this approach would be agreeable before spending time and effort in this direction.
Also note that obviously it would be much more intrusive and affect *all* users of the block subsystem, while the current approach would only affect those users who got CONFIG_BLOCK_NVMEM enabled.
PATCH 5/8 dt-bindings: mmc: mmc-card: add block device nodes
In reply to Daniel GolleAdd nodes representing the block devices exposed by an MMC device including an example involving nvmem-cells.
--- .../devicetree/bindings/mmc/mmc-card.yaml | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+)
Documentation/devicetree/bindings/mmc/mmc-card.yaml +45 -0
@@ -26,6 +26,18 @@ properties: Use this to indicate that the mmc-card has a broken hpi implementation, and that hpi should not be used. + block: + $ref: /schemas/block/block-device.yaml# + description: + Represents the block storage provided by an SD card or the + main hardware partition of an eMMC. + +patternProperties: + '^boot[0-9]+': + $ref: /schemas/block/block-device.yaml# + description: + Represents a boot hardware partition on an eMMC. + required: - compatible - reg
@@ -42,6 +54,39 @@ examples: compatible = "mmc-card"; reg = <0>; broken-hpi; + + block { + partitions { + cal_data: block-partition-rf { + partnum = <3>; + partname = "rf"; + + nvmem-layout { + compatible = "fixed-layout"; + #address-cells = <1>; + #size-cells = <1>; + + eeprom@0 { + reg = <0x0 0x1000>; + }; + }; + }; + }; + }; + + boot1 { + nvmem-layout { + compatible = "fixed-layout"; + #address-cells = <1>; + #size-cells = <1>; + + macaddr: macaddr@a { + compatible = "mac-base"; + reg = <0xa 0x6>; + #nvmem-cell-cells = <1>; + }; + }; + }; }; };
Signature · 1 line
2.44.0
PATCH 6/8 mmc: core: set card fwnode_handle
In reply to Daniel GolleSet fwnode in case it isn't set yet and of_node is present.
--- drivers/mmc/core/bus.c | 2 ++ 1 file changed, 2 insertions(+)
drivers/mmc/core/bus.c +2 -0
@@ -364,6 +364,8 @@ int mmc_add_card(struct mmc_card *card)mmc_add_card_debugfs (card); card->dev.of_node =mmc_of_find_child_device (card->host,0 ); +if (card->dev.of_node && !card->dev.fwnode) + card->dev.fwnode = &card->dev.of_node->fwnode;device_enable_async_suspend (&card->dev);
Signature · 1 line
2.44.0
PATCH 7/8 mmc: block: set fwnode of disk devices
In reply to Daniel GolleSet fwnode of disk devices to 'block', 'boot0' and 'boot1' subnodes of the mmc-card. This is done in preparation for having the eMMC act as NVMEM provider.
--- drivers/mmc/core/block.c | 7 +++++++ 1 file changed, 7 insertions(+)
drivers/mmc/core/block.c +7 -0
@@ -2463,6 +2463,7 @@ static struct mmc_blk_data *mmc_blk_alloc_req(struct mmc_card *card,int area_type, unsigned int part_type) { + struct fwnode_handle *fwnode;struct mmc_blk_data *md;int devidx, ret;char cap_str[10 ];
@@ -2559,6 +2560,12 @@ static struct mmc_blk_data *mmc_blk_alloc_req(struct mmc_card *card,blk_queue_write_cache (md->queue.queue, cache_enabled, fua_enabled); + fwnode =device_get_named_child_node (subname ? md->parent->parent : + md->parent, + subname ? subname :"block" ); +if (fwnode) +device_set_node (disk_to_dev (md->disk), fwnode); +string_get_size ((u64 )size,512 ,STRING_UNITS_2 , cap_str,sizeof (cap_str)); pr_info("%s: %s %s %s%s\n",
Signature · 1 line
2.44.0
PATCH 8/8 mmc: block: set GENHD_FL_NVMEM
In reply to Daniel GolleSet flag to consider MMC block devices as NVMEM providers.
--- drivers/mmc/core/block.c | 1 + 1 file changed, 1 insertion(+)
drivers/mmc/core/block.c +1 -0
@@ -2516,6 +2516,7 @@ static struct mmc_blk_data *mmc_blk_alloc_req(struct mmc_card *card, md->disk->major =MMC_BLOCK_MAJOR ; md->disk->minors = perdev_minors; md->disk->first_minor = devidx * perdev_minors; + md->disk->flags =GENHD_FL_NVMEM ; md->disk->fops = &mmc_bdops; md->disk->private_data = md; md->parent = parent;
Signature · 1 line
2.44.0
Quoted 11 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Quoted 6 lines
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Since this patch series adds code that opens partitions and reads from partitions, can that part of the functionality be implemented in user space? There is already a mechanism for notifying user space about block device changes, namely udev.
Thanks,
Bart.
Quoted 15 lines · Bart Van Assche
Quoted 14 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
Quoted 8 lines
Quoted 3 lines
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Since this patch series adds code that opens partitions and reads from partitions, can that part of the functionality be implemented in user space? There is already a mechanism for notifying user space about block device changes, namely udev.
No. Because it has to happen (e.g. for nfsroot to work) before userland gets initiated: Without Ethernet MAC address (which if often stored at some raw offset on a partition or hw-partition of an eMMC), we don't have a way to use nfsroot (because that requires functional Ethernet), hence userland won't come up. It's a circular dependency problem which can only be addressed by making sure that everything needed for Ethernet to come up is provided by the kernel **before** rootfs (which can be nfsroot) is mounted.
Quoted 25 lines · Daniel Golle
Quoted 15 lines · Bart Van Assche
Quoted 14 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
Quoted 8 lines
Quoted 3 lines
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Since this patch series adds code that opens partitions and reads from partitions, can that part of the functionality be implemented in user space? There is already a mechanism for notifying user space about block device changes, namely udev.
Quoted 8 lines
No. Because it has to happen (e.g. for nfsroot to work) before userland gets initiated: Without Ethernet MAC address (which if often stored at some raw offset on a partition or hw-partition of an eMMC), we don't have a way to use nfsroot (because that requires functional Ethernet), hence userland won't come up. It's a circular dependency problem which can only be addressed by making sure that everything needed for Ethernet to come up is provided by the kernel **before** rootfs (which can be nfsroot) is mounted.
How about the initial RAM disk? I think that's where code should occur that reads calibration data from local storage.
Thanks,
Bart.
Rob Herring
maintainerQuoted 18 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Quoted 6 lines
---
This series has previously been submitted as RFC on July 19th 2023[1] and most of the basic idea did not change since. Another round of RFC was submitted on March 5th 2024[2] which has received overall positive feedback and only minor corrections have been done since (see changelog below).
I don't recall giving positive feedback.
I still think this should use offsets rather than partition specific information. Not wanting to have to update the offsets if they change is not reason enough to not use them.
Rob
Quoted 26 lines · Rob Herring
Quoted 18 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Quoted 6 lines
---
This series has previously been submitted as RFC on July 19th 2023[1] and most of the basic idea did not change since. Another round of RFC was submitted on March 5th 2024[2] which has received overall positive feedback and only minor corrections have been done since (see changelog below).
Quoted 5 lines
I don't recall giving positive feedback.
I still think this should use offsets rather than partition specific information. Not wanting to have to update the offsets if they change is not reason enough to not use them.
Using raw offsets on the block device (rather than the partition) won't work for most existing devices and boot firmware out there. They always reference the partition, usually by the name of a GPT partition (but sometimes also PARTUUID or even PARTNO) which is then used in the exact same way as an MTD partition or UBI volume would be on devices with NOR or NAND flash. Just on eMMC we usually use a GPT or MBR partition table rather than defining partitions in DT or cmdline, which is rather rare (for historic reasons, I suppose, but it is what it is now).
Depending on the eMMC chip used, that partition may not even be at the same offset for different batches of the same device and hence I'd like to just do it in the same way vendor firmware does it as well.
Chad of Adtran has previously confirmed that [1], which was the positive feedback I was refering to. Other vendors like GL-iNet or Netgear are doing the exact same thing.
As of now, we support this in OpenWrt by adding a lot of board-specific knowledge to userland, which is ugly and also prevents using things like PXE-initiated nfsroot on those devices.
The purpose of this series is to be able to properly support such devices (ie. practially all consumer-grade routers out there using an eMMC for storing firmware).
Also, those devices have enough resources to run a general purpose distribution like Debian instead of OpenWrt, and all the userland hacks to set MAC addresses and extract WiFi-EEPROM-data in a board-specific ways will most certainly never find their way into Debian. It's just not how embedded Linux works, unless you are looking only at the RaspberryPi which got that data stored in a textfile which is shipped by the distribution -- something very weird and very different from literally all of-the-shelf routers, access-points or switches I have ever seen (and I've seen many). Maybe Felix who has seen even more of them can tell us more about that.
Rob Herring
maintainer+boot-architecture list
Quoted 33 lines · Daniel Golle
Quoted 26 lines · Rob Herring
Quoted 18 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Quoted 6 lines
---
This series has previously been submitted as RFC on July 19th 2023[1] and most of the basic idea did not change since. Another round of RFC was submitted on March 5th 2024[2] which has received overall positive feedback and only minor corrections have been done since (see changelog below).Quoted 5 lines
I don't recall giving positive feedback.
I still think this should use offsets rather than partition specific information. Not wanting to have to update the offsets if they change is not reason enough to not use them.
Quoted 6 lines
Using raw offsets on the block device (rather than the partition) won't work for most existing devices and boot firmware out there. They always reference the partition, usually by the name of a GPT partition (but sometimes also PARTUUID or even PARTNO) which is then used in the exact same way as an MTD partition or UBI volume would be on devices with NOR or NAND flash.
MTD normally uses offsets hence why I'd like some alignment. UBI is special because raw NAND is, well, special.
Quoted 4 lines
Just on eMMC we usually use a GPT
or MBR partition table rather than defining partitions in DT or cmdline, which is rather rare (for historic reasons, I suppose, but it is what it is now).
Yes, I understand how eMMC works. I don't understand why if you have part #, uuid, or name you can't get to the offset or vice-versa. You need only 1 piece of identification to map partition table entries to DT nodes. Sure, offsets can change, but surely the firmware can handle adjusting the DT?
An offset would also work for the case of random firmware data on the disk that may or may not have a partition associated with it. There are certainly cases of that. I don't think we have much of a solution for that other than trying to educate vendors to not do that or OS installers only supporting installing to something other than eMMC. This is something EBBR[1] is trying to address.
Quoted 3 lines
Depending on the eMMC chip used, that partition may not even be at the same offset for different batches of the same device and hence I'd like to just do it in the same way vendor firmware does it as well.
Often vendor firmware is not a model to follow...
Quoted 12 lines
Chad of Adtran has previously confirmed that [1], which was the positive feedback I was refering to. Other vendors like GL-iNet or Netgear are doing the exact same thing.
As of now, we support this in OpenWrt by adding a lot of board-specific knowledge to userland, which is ugly and also prevents using things like PXE-initiated nfsroot on those devices.
The purpose of this series is to be able to properly support such devices (ie. practially all consumer-grade routers out there using an eMMC for storing firmware).
Quoted 10 lines
Also, those devices have enough resources to run a general purpose distribution like Debian instead of OpenWrt, and all the userland hacks to set MAC addresses and extract WiFi-EEPROM-data in a board-specific ways will most certainly never find their way into Debian. It's just not how embedded Linux works, unless you are looking only at the RaspberryPi which got that data stored in a textfile which is shipped by the distribution -- something very weird and very different from literally all of-the-shelf routers, access-points or switches I have ever seen (and I've seen many). Maybe Felix who has seen even more of them can tell us more about that.
General purpose distros want to partition the disk themselves. Adding anything to the DT for disk partitions would require the installer to be aware of it. There's various distro folks on the boot-arch list, so maybe one of them can comment.
Rob
[1] https://arm-software.github.io/ebbr/index.html#document-chapter4-firmware-media
Hi Rob,
Quoted 1 line · Rob Herring
+boot-architecture list
Good idea, thank you :)
Quoted 42 lines · Daniel Golle
Quoted 33 lines · Rob Herring
Quoted 26 lines · Daniel Golle
Quoted 18 lines
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Quoted 6 lines
---
This series has previously been submitted as RFC on July 19th 2023[1] and most of the basic idea did not change since. Another round of RFC was submitted on March 5th 2024[2] which has received overall positive feedback and only minor corrections have been done since (see changelog below).Quoted 5 lines
I don't recall giving positive feedback.
I still think this should use offsets rather than partition specific information. Not wanting to have to update the offsets if they change is not reason enough to not use them.
Quoted 6 lines
Using raw offsets on the block device (rather than the partition) won't work for most existing devices and boot firmware out there. They always reference the partition, usually by the name of a GPT partition (but sometimes also PARTUUID or even PARTNO) which is then used in the exact same way as an MTD partition or UBI volume would be on devices with NOR or NAND flash.
Quoted 2 lines
MTD normally uses offsets hence why I'd like some alignment. UBI is special because raw NAND is, well, special.
I get the point and in a way this is also already intended and supported by this series. You can already just add an 'nvmem-layout' node directly to a disk device rather than to a partition and define a layout in this way.
Making this useful in practice will require some improvements to the nvmem system in Linux though, because that currently uses signed 32-bit integers as addresses which is not sufficient for the size of the user-part of an eMMC. However, that needs to be done then and should of course not be read as an excuse.
Quoted 10 lines
Quoted 5 lines
Just on eMMC we usually use a GPT
or MBR partition table rather than defining partitions in DT or cmdline, which is rather rare (for historic reasons, I suppose, but it is what it is now).Yes, I understand how eMMC works. I don't understand why if you have part #, uuid, or name you can't get to the offset or vice-versa. You need only 1 piece of identification to map partition table entries to DT nodes.
Yes, either of them (or a combination) is fine. In practise I've mostly seen PARTNAME as identifier used in userland scripts, and only adding this for now will probably cover most devices (and existing boot firmware) out there. Notable exceptions are devices which are using MBR partitions because the BootROM expects the bootloader to be at the same block as we would usually have the primary GPT. In this case we can only use the PARTNO, of course, and it stinks.
MediaTek's MT7623A/N is such an example, but it's a slingly outdated and pretty weird niche SoC I admit.
Quoted 2 lines
Sure, offsets can change, but surely the firmware can handle adjusting the DT?
Future firmware may be able to do this, of course. Current existing firmware already out there on devices such as the quite popular GL.iNet MT-6000, Netgear's Orbi and Orbi Pro series as well as all Adtran SmartRG devices does not. Updating or changing the boot firmware of devices already out there is not intended and quite challenging, and will make the device incompatible with its vendor firmware. Hence it would be better to support replacing only the Linux-based firmware (eg. with OpenWrt or even Debian or any general-purpose Linux, the eMMC is large enough...) while not having to touch the boot firmware (and risking to brick the device if that goes wrong).
Personally, I'm rather burdened and unhappy with vendor attempts to have the boot firmware mess around too much in (highly customized, downstream) DT, it may look like a good solution at the moment, but can totally become an obstacle in an unpredictable future (no offense ASUS...)
Quoted 7 lines
An offset would also work for the case of random firmware data on the disk that may or may not have a partition associated with it. There are certainly cases of that. I don't think we have much of a solution for that other than trying to educate vendors to not do that or OS installers only supporting installing to something other than eMMC. This is something EBBR[1] is trying to address.
Absolutely. Actually *early* GL-iNet devices did exactly that: Use the eMMC boot hw-partitions to store boot firmware as well as MAC addresses and potentially also Wi-Fi calibration data.
The MT-2500 is the example I'm aware of and got sitting on my desk for testing with this very series (which allows to also reference eMMC hardware partitions, see "[7/8] mmc: block: set fwnode of disk devices").
Unfortunately later devices such the the flag-ship MT-6000 moved MAC addresses and WiFi-EEPROMs into a GPT partition on the user-part of the eMMC.
Quoted 6 lines
Quoted 4 lines
Depending on the eMMC chip used, that partition may not even be at the same offset for different batches of the same device and hence I'd like to just do it in the same way vendor firmware does it as well.
Often vendor firmware is not a model to follow...
I totally agree. However, I don't see a good reason for not supporting those network-appliance-type embedded devices which even ship with (outdated, downstream) Linux by default while going through great lengths for things like broken ACPI tables in many laptops which require lots of work-arounds to have features like suspend-to-disk working, or even be able to run Linux at all.
Quoted 24 lines
Quoted 13 lines
Chad of Adtran has previously confirmed that [1], which was the positive feedback I was refering to. Other vendors like GL-iNet or Netgear are doing the exact same thing.
As of now, we support this in OpenWrt by adding a lot of board-specific knowledge to userland, which is ugly and also prevents using things like PXE-initiated nfsroot on those devices.
The purpose of this series is to be able to properly support such devices (ie. practially all consumer-grade routers out there using an eMMC for storing firmware).
Quoted 10 lines
Also, those devices have enough resources to run a general purpose distribution like Debian instead of OpenWrt, and all the userland hacks to set MAC addresses and extract WiFi-EEPROM-data in a board-specific ways will most certainly never find their way into Debian. It's just not how embedded Linux works, unless you are looking only at the RaspberryPi which got that data stored in a textfile which is shipped by the distribution -- something very weird and very different from literally all of-the-shelf routers, access-points or switches I have ever seen (and I've seen many). Maybe Felix who has seen even more of them can tell us more about that.
Quoted 4 lines
General purpose distros want to partition the disk themselves. Adding anything to the DT for disk partitions would require the installer to be aware of it. There's various distro folks on the boot-arch list, so maybe one of them can comment.
Usually the installers are already aware to not touch partitions when unaware of their purpose. Repartitioning the disk from scratch is not what (modern) distributions are doing, at least the EFI System partition is kept, as well as typical rescue/recovery partitions many vendors put on their (Windows, Mac) laptops to allow to "factory reset" them.
Installers usually offer to replace (or resize) the "large" partition used by the currently installed OS instead.
And well, the DT reference to a partition holding e.g. MAC addresses does make the installer aware of it, obviously.
Thank you for the constructive debate!
Cheers
Daniel
Quoted 4 lines
Rob
[1] https://arm-software.github.io/ebbr/index.html#document-chapter4-firmware-media
Rob Herring
maintainerQuoted 7 lines · Daniel Golle
Hi Rob,
Quoted 1 line · Rob Herring
+boot-architecture list
Good idea, thank you :)
Now really adding it. :(
Will reply to rest later.
Quoted 188 lines
Quoted 42 lines · Daniel Golle
Quoted 33 lines · Rob Herring
Quoted 26 lines · Daniel Golle
Quoted 18 lines
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Quoted 6 lines
---
This series has previously been submitted as RFC on July 19th 2023[1] and most of the basic idea did not change since. Another round of RFC was submitted on March 5th 2024[2] which has received overall positive feedback and only minor corrections have been done since (see changelog below).Quoted 5 lines
I don't recall giving positive feedback.
I still think this should use offsets rather than partition specific information. Not wanting to have to update the offsets if they change is not reason enough to not use them.
Quoted 6 lines
Using raw offsets on the block device (rather than the partition) won't work for most existing devices and boot firmware out there. They always reference the partition, usually by the name of a GPT partition (but sometimes also PARTUUID or even PARTNO) which is then used in the exact same way as an MTD partition or UBI volume would be on devices with NOR or NAND flash.
Quoted 2 lines
MTD normally uses offsets hence why I'd like some alignment. UBI is special because raw NAND is, well, special.
I get the point and in a way this is also already intended and supported by this series. You can already just add an 'nvmem-layout' node directly to a disk device rather than to a partition and define a layout in this way.
Making this useful in practice will require some improvements to the nvmem system in Linux though, because that currently uses signed 32-bit integers as addresses which is not sufficient for the size of the user-part of an eMMC. However, that needs to be done then and should of course not be read as an excuse.
Quoted 10 lines
Quoted 5 lines
Just on eMMC we usually use a GPT
or MBR partition table rather than defining partitions in DT or cmdline, which is rather rare (for historic reasons, I suppose, but it is what it is now).Yes, I understand how eMMC works. I don't understand why if you have part #, uuid, or name you can't get to the offset or vice-versa. You need only 1 piece of identification to map partition table entries to DT nodes.
Yes, either of them (or a combination) is fine. In practise I've mostly seen PARTNAME as identifier used in userland scripts, and only adding this for now will probably cover most devices (and existing boot firmware) out there. Notable exceptions are devices which are using MBR partitions because the BootROM expects the bootloader to be at the same block as we would usually have the primary GPT. In this case we can only use the PARTNO, of course, and it stinks.
MediaTek's MT7623A/N is such an example, but it's a slingly outdated and pretty weird niche SoC I admit.Quoted 2 lines
Sure, offsets can change, but surely the firmware can handle adjusting the DT?
Future firmware may be able to do this, of course. Current existing firmware already out there on devices such as the quite popular GL.iNet MT-6000, Netgear's Orbi and Orbi Pro series as well as all Adtran SmartRG devices does not. Updating or changing the boot firmware of devices already out there is not intended and quite challenging, and will make the device incompatible with its vendor firmware. Hence it would be better to support replacing only the Linux-based firmware (eg. with OpenWrt or even Debian or any general-purpose Linux, the eMMC is large enough...) while not having to touch the boot firmware (and risking to brick the device if that goes wrong).
Personally, I'm rather burdened and unhappy with vendor attempts to have the boot firmware mess around too much in (highly customized, downstream) DT, it may look like a good solution at the moment, but can totally become an obstacle in an unpredictable future (no offense ASUS...)
Quoted 7 lines
An offset would also work for the case of random firmware data on the disk that may or may not have a partition associated with it. There are certainly cases of that. I don't think we have much of a solution for that other than trying to educate vendors to not do that or OS installers only supporting installing to something other than eMMC. This is something EBBR[1] is trying to address.
Absolutely. Actually *early* GL-iNet devices did exactly that: Use the eMMC boot hw-partitions to store boot firmware as well as MAC addresses and potentially also Wi-Fi calibration data.
The MT-2500 is the example I'm aware of and got sitting on my desk for testing with this very series (which allows to also reference eMMC hardware partitions, see "[7/8] mmc: block: set fwnode of disk devices").
Unfortunately later devices such the the flag-ship MT-6000 moved MAC addresses and WiFi-EEPROMs into a GPT partition on the user-part of the eMMC.Quoted 6 lines
Quoted 4 lines
Depending on the eMMC chip used, that partition may not even be at the same offset for different batches of the same device and hence I'd like to just do it in the same way vendor firmware does it as well.
Often vendor firmware is not a model to follow...
I totally agree. However, I don't see a good reason for not supporting those network-appliance-type embedded devices which even ship with (outdated, downstream) Linux by default while going through great lengths for things like broken ACPI tables in many laptops which require lots of work-arounds to have features like suspend-to-disk working, or even be able to run Linux at all.
Quoted 24 lines
Quoted 13 lines
Chad of Adtran has previously confirmed that [1], which was the positive feedback I was refering to. Other vendors like GL-iNet or Netgear are doing the exact same thing.
As of now, we support this in OpenWrt by adding a lot of board-specific knowledge to userland, which is ugly and also prevents using things like PXE-initiated nfsroot on those devices.
The purpose of this series is to be able to properly support such devices (ie. practially all consumer-grade routers out there using an eMMC for storing firmware).
Quoted 10 lines
Also, those devices have enough resources to run a general purpose distribution like Debian instead of OpenWrt, and all the userland hacks to set MAC addresses and extract WiFi-EEPROM-data in a board-specific ways will most certainly never find their way into Debian. It's just not how embedded Linux works, unless you are looking only at the RaspberryPi which got that data stored in a textfile which is shipped by the distribution -- something very weird and very different from literally all of-the-shelf routers, access-points or switches I have ever seen (and I've seen many). Maybe Felix who has seen even more of them can tell us more about that.
Quoted 4 lines
General purpose distros want to partition the disk themselves. Adding anything to the DT for disk partitions would require the installer to be aware of it. There's various distro folks on the boot-arch list, so maybe one of them can comment.
Usually the installers are already aware to not touch partitions when unaware of their purpose. Repartitioning the disk from scratch is not what (modern) distributions are doing, at least the EFI System partition is kept, as well as typical rescue/recovery partitions many vendors put on their (Windows, Mac) laptops to allow to "factory reset" them.
Installers usually offer to replace (or resize) the "large" partition used by the currently installed OS instead.
And well, the DT reference to a partition holding e.g. MAC addresses does make the installer aware of it, obviously.
Thank you for the constructive debate!
Cheers
Daniel
Quoted 4 lines
Rob
[1] https://arm-software.github.io/ebbr/index.html#document-chapter4-firmware-media
Rob Herring
maintainerQuoted 18 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Quoted 6 lines
---
This series has previously been submitted as RFC on July 19th 2023[1] and most of the basic idea did not change since. Another round of RFC was submitted on March 5th 2024[2] which has received overall positive feedback and only minor corrections have been done since (see changelog below).
Also, please version your patches. 'RFC' is a tag, not a version. v1 was July. v2 was March 5th. This is v3.
Rob
Quoted 26 lines · Rob Herring
Quoted 18 lines · Daniel Golle
On embedded devices using an eMMC it is common that one or more (hw/sw) partitions on the eMMC are used to store MAC addresses and Wi-Fi calibration EEPROM data.
Implement an NVMEM provider backed by a block device as typically the NVMEM framework is used to have kernel drivers read and use binary data from EEPROMs, efuses, flash memory (MTD), ...
In order to be able to reference hardware partitions on an eMMC, add code to bind each hardware partition to a specific firmware subnode.
Overall, this enables uniform handling across practially all flash storage types used for this purpose (MTD, UBI, and now also MMC).
As part of this series it was necessary to define a device tree schema for block devices and partitions on them, which (similar to how it now works also for UBI volumes) can be matched by one or more properties.
Quoted 6 lines
---
This series has previously been submitted as RFC on July 19th 2023[1] and most of the basic idea did not change since. Another round of RFC was submitted on March 5th 2024[2] which has received overall positive feedback and only minor corrections have been done since (see changelog below).
Quoted 2 lines
Also, please version your patches. 'RFC' is a tag, not a version. v1 was July. v2 was March 5th. This is v3.
According to "Submitting patches: the essential guide to getting your code into the kernel" [1] a version is also a tag.
Quote:
Common tags might include a version descriptor if the [sic] multiple versions of the patch have been sent out in response to comments (i.e., “v1, v2, v3”), or “RFC” to indicate a request for comments.
Maybe this should be clarified, exclusive or inclusive "or" is up to the reader to interpret at this point, and I've often seen RFC, RFCv2, v1, v2, ... as a sequence of tags applied for the same series, which is why I followed what I used to believe was the most common interpretation of the guidelines.
In any way, thank you for pointing it out, I assume the next iteration should then be v4.
[1]: https://docs.kernel.org/process/submitting-patches.html