mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Cc: "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Thomas Petazzoni" <thomas.petazzoni@bootlin.com>,
	"Robert Marko" <robert.marko@sartura.hr>,
	"Luka Perkov" <luka.perkov@sartura.hr>,
	"Michael Walle" <michael@walle.cc>,
	linux-kernel@vger.kernel.org,
	"Randy Dunlap" <rdunlap@infradead.org>,
	"Chen-Yu Tsai" <wenst@chromium.org>,
	"Daniel Golle" <daniel@makrotopia.org>,
	"Rafał Miłecki" <rafal@milecki.pl>,
	"Miquel Raynal" <miquel.raynal@bootlin.com>
Subject: [PATCH v8 7/8] ABI: sysfs-nvmem-cells: Expose cells through sysfs
Date: Mon,  7 Aug 2023 10:24:18 +0200	[thread overview]
Message-ID: <20230807082419.38780-8-miquel.raynal@bootlin.com> (raw)
In-Reply-To: <20230807082419.38780-1-miquel.raynal@bootlin.com>

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>
---
 Documentation/ABI/testing/sysfs-nvmem-cells | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-nvmem-cells

diff --git a/Documentation/ABI/testing/sysfs-nvmem-cells b/Documentation/ABI/testing/sysfs-nvmem-cells
new file mode 100644
index 000000000000..7af70adf3690
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-nvmem-cells
@@ -0,0 +1,21 @@
+What:		/sys/bus/nvmem/devices/.../cells/<cell-name>
+Date:		May 2023
+KernelVersion:	6.5
+Contact:	Miquel Raynal <miquel.raynal@bootlin.com>
+Description:
+		The "cells" folder contains one file per cell exposed by the
+		NVMEM device. The name of the file is: <name>@<where>, with
+		<name> being the cell name and <where> its location in the NVMEM
+		device, in hexadecimal (without the '0x' prefix, to mimic device
+		tree node names). The length of the file is the size of the cell
+		(when known). The content of the file is the binary content of
+		the cell (may sometimes be ASCII, likely without trailing
+		character).
+		Note: This file is only present if CONFIG_NVMEM_SYSFS
+		is enabled.
+
+		Example::
+
+		  hexdump -C /sys/bus/nvmem/devices/1-00563/cells/product-name@d
+		  00000000  54 4e 34 38 4d 2d 50 2d  44 4e         |TN48M-P-DN|
+		  0000000a
-- 
2.34.1


  parent reply	other threads:[~2023-08-07  8:24 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-07  8:24 [PATCH v8 0/8] NVMEM cells in sysfs Miquel Raynal
2023-08-07  8:24 ` [PATCH v8 1/8] nvmem: core: Create all cells before adding the nvmem device Miquel Raynal
2023-08-07  8:24 ` [PATCH v8 2/8] nvmem: core: Return NULL when no nvmem layout is found Miquel Raynal
2023-08-07  8:24 ` [PATCH v8 3/8] nvmem: core: Do not open-code existing functions Miquel Raynal
2023-08-07  8:24 ` [PATCH v8 4/8] nvmem: core: Track the registered devices Miquel Raynal
2023-08-07  9:02   ` Greg Kroah-Hartman
2023-08-07 12:10     ` Miquel Raynal
2023-08-07  8:24 ` [PATCH v8 5/8] nvmem: core: Notify when a new layout is registered Miquel Raynal
2023-08-07  8:24 ` [PATCH v8 6/8] nvmem: core: Rework layouts to become platform devices Miquel Raynal
2023-08-07  9:05   ` Greg Kroah-Hartman
2023-08-07  9:33     ` Miquel Raynal
2023-08-07  8:24 ` Miquel Raynal [this message]
2023-08-07  8:24 ` [PATCH v8 8/8] nvmem: core: Expose cells through sysfs Miquel Raynal
2023-08-07  8:57 ` [PATCH v8 0/8] NVMEM cells in sysfs Chen-Yu Tsai
2023-08-07  9:20   ` Miquel Raynal
2023-08-07 14:28     ` Miquel Raynal
2023-08-08  2:56       ` Chen-Yu Tsai
2023-08-08  6:29         ` Miquel Raynal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230807082419.38780-8-miquel.raynal@bootlin.com \
    --to=miquel.raynal@bootlin.com \
    --cc=daniel@makrotopia.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=luka.perkov@sartura.hr \
    --cc=michael@walle.cc \
    --cc=rafal@milecki.pl \
    --cc=rdunlap@infradead.org \
    --cc=robert.marko@sartura.hr \
    --cc=srinivas.kandagatla@linaro.org \
    --cc=thomas.petazzoni@bootlin.com \
    --cc=wenst@chromium.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®