Documentation/ABI: document the nvmem sysfs files

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>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/Documentation/ABI/stable/sysfs-bus-nvmem b/Documentation/ABI/stable/sysfs-bus-nvmem
new file mode 100644 (file)
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 58c3bb7fc61513b7a1be663ddaa2aa1cbd342e3c..999dce6a8115b85fe92fc80cadd9c6acd93a1abd 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9466,6 +9466,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