[PATCH v7 0/7] mtd: ubi: allow UBI volumes to provide NVMEM

[Daniel Golle]

Dear MTD and UBI maintainers,

On Tue, Dec 19, 2023 at 02:31:44AM +0000, Daniel Golle wrote:
> Similar to how MAC addresses and Wi-Fi calibration data would be
> stored inside an MTD partition on devices coming with NOR flash, a UBI
> volume is used by some vendors in the same way on devices with NAND
> flash.
> 
> The goal of this series is to support such embedded Linux devices which
> got NVMEM bits stored inside a UBI volume.
> 
> Representing the UBI volume in the Device Tree and adding a phandle to
> be referenced by NVMEM consumers allows such devices to come up with
> their correct MAC addresses and device-specific Wi-Fi calibration data
> loaded.
> 

I hope I don't nag too much but please someone review (and ideally
merge) this very series, also found on Patchwork:

https://patchwork.ozlabs.org/project/linux-mtd/list/?series=387243

In case any part needs further fixing, it would be great to even only
have the dt-bindings part merged already so we can start using this
feature in OpenWrt knowing that dt-bindings will not change any more.
(instead of piling up device-specific fixup-scripts in userspace...)

A good example of why this is needed in the wild is the ASUS RT-AC58U
router which is the first device we found having almost everything
stored in UBI, including NVMEM-areas for WiFi calibration as well as
MAC addresses for both WiFi and Ethernet.

https://openwrt.org/toh/asus/rt-ac58u#flash_layout

Even more devices with all-UBI layout are likely to show up in the
near future as by now even ARM TrustedFirmware-A which is used as
first-stage loader (like MBR on PC or U-Boot SPL on ARMv7) on Aarch64
platforms by now supports UBI to load further bootloader stages. MTD
layout on such devices becomes simply something like

0x0      ~ 0x200000 : ARM TrustedFirmware-A bl2 (redundant if supported
                                                 by SoC's BootROM)
0x200000 ~ END      : UBI

See this (pending) commit adding UBI support to TF-A:
https://github.com/mtk-openwrt/arm-trusted-firmware/commit/e7a7b94373cf2b8baca66b3b0ced8e70bdbb273a


Obviously this is better than what vendors have been doing previously
(using UBI only for the rootfs, if at all) and having proper support
for that in vanilla Linux would further encourage this development.

PS: Also the planned OpenWrt One router to celebrate the 20th
anniversary of OpenWrt will use an all-UBI layout and we will hence
need to load NVMEM-bits from UBI volumes...


Thank you!


Best regards


Daniel

> In order for NVMEM bits to be available for other drivers, attaching
> UBI devices has to be moved from late_initcall (which is too late for
> other drivers) to happen earlier. As an alternative to the existing
> kernel cmdline parameter the Device Tree property 'compatible =
> "linux,ubi";' inside an MTD partition can be used to have that MTD
> device attached as UBI device. MTD partitions which serve as UBI
> devices may have a "volumes" subnode with volumes, and volumes may
> have an "nvmem-layout" object which will trigger the creation of an
> emulated NVMEM device on top of the UBI volume.
> 
> In this way, other drivers (think: Ethernet, Wi-Fi) can resolve and
> acquire NVMEM bits using the usual device tree phandle, just this time
> the NVMEM content is read from a UBI volume.
> 
> This series is a follow-up and contains most patches of the previous
> series "mtd: ubi: behave like a good MTD citizen"[1] which was meant in
> preparation for implementing the NVMEM provider.
> 
> [1]: https://patchwork.ozlabs.org/project/linux-mtd/list/?series=353177&state=%2A&archive=both
> 
> Changes since v6:
>  * dt-bindings fixes got squashed into the wrong patch, fix that and
>    newly introduced YAML white space issues
> 
> Changes since v5:
>  * fix whitespace problems in dt-schema additions
> 
> Changes since v4:
>  * split ubi_open_volume_path() breaking out reusable parts for
>    new match_volume_desc() function as suggested by Richard Weinberger.
>    Doing the same for ubi_open_volume_nm() doesn't work as we are working
>    on struct ubi_volume_info in match_volume_desc() while ubi_open_volume_nm()
>    is working on struct ubi_volume. That reduces the common part to a string
>    comparision and length check which doesn't seem worth breaking out of the
>    existing function.
>  * drop patches and changes not strictly needed for NVMEM use-case:
>    - don't handle ubi detach on MTD removal notification. It was not done
>      until now and the locking hell I was facing when trying to implement
>      that is non trivial.
>    - don't relocate the call to ubiblock device creation to the
>      notification handler
>    - change ubiblock only as far as needed to handle creation from cmdline
>      parameter when a volume is added.
>  * improve commit messages and comments
> 
> Changes since v3:
>  * dt-bindings fixes as requested
> 
> Changes since v2:
>  * include dt-bindings additions
> 
> Changes since v1:
>  * include patch to fix exiting Kconfig formatting issues
>  * fix typo and indentation in Kconfig
> 
> 
> 
> Daniel Golle (7):
>   dt-bindings: mtd: add basic bindings for UBI
>   dt-bindings: mtd: ubi-volume: allow UBI volumes to provide NVMEM
>   mtd: ubi: block: use notifier to create ubiblock from parameter
>   mtd: ubi: attach from device tree
>   mtd: ubi: introduce pre-removal notification for UBI volumes
>   mtd: ubi: populate ubi volume fwnode
>   mtd: ubi: provide NVMEM layer over UBI volumes
> 
>  .../bindings/mtd/partitions/linux,ubi.yaml    |  75 +++++++
>  .../bindings/mtd/partitions/ubi-volume.yaml   |  40 ++++
>  drivers/mtd/ubi/Kconfig                       |  12 ++
>  drivers/mtd/ubi/Makefile                      |   1 +
>  drivers/mtd/ubi/block.c                       | 136 ++++++-------
>  drivers/mtd/ubi/build.c                       | 154 ++++++++++----
>  drivers/mtd/ubi/kapi.c                        |  56 ++++--
>  drivers/mtd/ubi/nvmem.c                       | 188 ++++++++++++++++++
>  drivers/mtd/ubi/ubi.h                         |   3 +
>  drivers/mtd/ubi/vmt.c                         |  44 +++-
>  include/linux/mtd/ubi.h                       |   2 +
>  11 files changed, 579 insertions(+), 132 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/mtd/partitions/linux,ubi.yaml
>  create mode 100644 Documentation/devicetree/bindings/mtd/partitions/ubi-volume.yaml
>  create mode 100644 drivers/mtd/ubi/nvmem.c
> 
> -- 
> 2.43.0
> 
> ______________________________________________________
> Linux MTD discussion mailing list
> http://lists.infradead.org/mailman/listinfo/linux-mtd/