diff mbox

Documentation/ABI: document the nvmem sysfs files

Message ID 20170726100902.28955-1-srinivas.kandagatla@linaro.org
State Accepted
Commit c26bbb3ca9c4c58b886497efbeccac7cbd9e98a4
Headers show

Commit Message

Srinivas Kandagatla July 26, 2017, 10:09 a.m. UTC 
From: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>


NVMEM has been in kernel since v4.2 but the ABI document was missing
since then. userspace interface did not change since then and seems
stable, so this patch documents the nvmem ABI.

Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>

---
 Documentation/ABI/stable/sysfs-bus-nvmem | 19 +++++++++++++++++++
 MAINTAINERS                              |  1 +
 2 files changed, 20 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-bus-nvmem

-- 
2.9.3
diff mbox

Patch

diff --git a/Documentation/ABI/stable/sysfs-bus-nvmem b/Documentation/ABI/stable/sysfs-bus-nvmem
new file mode 100644
index 0000000..5923ab4
--- /dev/null
+++ b/Documentation/ABI/stable/sysfs-bus-nvmem
@@ -0,0 +1,19 @@ 
+What:		/sys/bus/nvmem/devices/.../nvmem
+Date:		July 2015
+KernelVersion:  4.2
+Contact:	Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
+Description:
+		This file allows user to read/write the raw NVMEM contents.
+		Permissions for write to this file depends on the nvmem
+		provider configuration.
+
+		ex:
+		hexdump /sys/bus/nvmem/devices/qfprom0/nvmem
+
+		0000000 0000 0000 0000 0000 0000 0000 0000 0000
+		*
+		00000a0 db10 2240 0000 e000 0c00 0c00 0000 0c00
+		0000000 0000 0000 0000 0000 0000 0000 0000 0000
+		...
+		*
+		0001000
diff --git a/MAINTAINERS b/MAINTAINERS
index 205d397..a76e794 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9480,6 +9480,7 @@  M:	Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
 S:	Maintained
 F:	drivers/nvmem/
 F:	Documentation/devicetree/bindings/nvmem/
+F:	Documentation/ABI/stable/sysfs-bus-nvmem
 F:	include/linux/nvmem-consumer.h
 F:	include/linux/nvmem-provider.h