Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

ABI: sysfs-nvmem-cells: Expose cells through sysfs

The binary content of nvmem devices is available to the user so in the
easiest cases, finding the content of a cell is rather easy as it is
just a matter of looking at a known and fixed offset. However, nvmem
layouts have been recently introduced to cope with more advanced
situations, where the offset and size of the cells is not known in
advance or is dynamic. When using layouts, more advanced parsers are
used by the kernel in order to give direct access to the content of each
cell regardless of their position/size in the underlying device, but
these information were not accessible to the user.

By exposing the nvmem cells to the user through a dedicated cell/ folder
containing one file per cell, we provide a straightforward access to
useful user information without the need for re-writing a userland
parser. Content of nvmem cells is usually: product names, manufacturing
date, MAC addresses, etc,

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Link: https://lore.kernel.org/r/20231215111536.316972-8-srinivas.kandagatla@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Miquel Raynal and committed by
Greg Kroah-Hartman
192048e5 fc29fd82

+21
+21
Documentation/ABI/testing/sysfs-nvmem-cells
··· 1 + What: /sys/bus/nvmem/devices/.../cells/<cell-name> 2 + Date: May 2023 3 + KernelVersion: 6.5 4 + Contact: Miquel Raynal <miquel.raynal@bootlin.com> 5 + Description: 6 + The "cells" folder contains one file per cell exposed by the 7 + NVMEM device. The name of the file is: <name>@<where>, with 8 + <name> being the cell name and <where> its location in the NVMEM 9 + device, in hexadecimal (without the '0x' prefix, to mimic device 10 + tree node names). The length of the file is the size of the cell 11 + (when known). The content of the file is the binary content of 12 + the cell (may sometimes be ASCII, likely without trailing 13 + character). 14 + Note: This file is only present if CONFIG_NVMEM_SYSFS 15 + is enabled. 16 + 17 + Example:: 18 + 19 + hexdump -C /sys/bus/nvmem/devices/1-00563/cells/product-name@d 20 + 00000000 54 4e 34 38 4d 2d 50 2d 44 4e |TN48M-P-DN| 21 + 0000000a