bus: moxtet: Add sysfs and debugfs documentation

Add sysfs ABI documentation for the attribute files module_id and
module_name

Add debugfs ABI documentation for reading input from the shift registers
and reading last written output or write output to the shift registers.

Link: https://lore.kernel.org/r/20190812161118.21476-4-marek.behun@nic.cz
Signed-off-by: Marek Behún <marek.behun@nic.cz>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Arnd Bergmann <arnd@arndb.de>

diff --git a/Documentation/ABI/testing/debugfs-moxtet b/Documentation/ABI/testing/debugfs-moxtet
new file mode 100644 (file)
index 0000000..67b1717
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-moxtet
@@ -0,0 +1,23 @@
+What:          /sys/kernel/debug/moxtet/input
+Date:          March 2019
+KernelVersion: 5.3
+Contact:       Marek Behún <marek.behun@nic.cz>
+Description:   (R) Read input from the shift registers, in hexadecimal.
+               Returns N+1 bytes, where N is the number of Moxtet connected
+               modules. The first byte is from the CPU board itself.
+               Example: 101214
+                        10: CPU board with SD card
+                        12: 2 = PCIe module, 1 = IRQ not active
+                        14: 4 = Peridot module, 1 = IRQ not active
+
+What:          /sys/kernel/debug/moxtet/output
+Date:          March 2019
+KernelVersion: 5.3
+Contact:       Marek Behún <marek.behun@nic.cz>
+Description:   (RW) Read last written value to the shift registers, in
+               hexadecimal, or write values to the shift registers, also
+               in hexadecimal.
+               Example: 0102
+                        01: 01 was last written, or is to be written, to the
+                            first module's shift register
+                        02: the same for second module

diff --git a/Documentation/ABI/testing/sysfs-bus-moxtet-devices b/Documentation/ABI/testing/sysfs-bus-moxtet-devices
new file mode 100644 (file)
index 0000000..3559585
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-moxtet-devices
@@ -0,0 +1,17 @@
+What:          /sys/bus/moxtet/devices/moxtet-<name>.<addr>/module_description
+Date:          March 2019
+KernelVersion: 5.3
+Contact:       Marek Behún <marek.behun@nic.cz>
+Description:   (R) Moxtet module description. Format: string
+
+What:          /sys/bus/moxtet/devices/moxtet-<name>.<addr>/module_id
+Date:          March 2019
+KernelVersion: 5.3
+Contact:       Marek Behún <marek.behun@nic.cz>
+Description:   (R) Moxtet module ID. Format: %x
+
+What:          /sys/bus/moxtet/devices/moxtet-<name>.<addr>/module_name
+Date:          March 2019
+KernelVersion: 5.3
+Contact:       Marek Behún <marek.behun@nic.cz>
+Description:   (R) Moxtet module name. Format: string

diff --git a/MAINTAINERS b/MAINTAINERS
index e0b803b..1869e83 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1630,6 +1630,8 @@ ARM/CZ.NIC TURRIS MOX SUPPORT
 M:     Marek Behun <marek.behun@nic.cz>
 W:     http://mox.turris.cz
 S:     Maintained
+F:     Documentation/ABI/testing/debugfs-moxtet
+F:     Documentation/ABI/testing/sysfs-bus-moxtet-devices
 F:     Documentation/devicetree/bindings/bus/moxtet.txt
 F:     include/linux/moxtet.h
 F:     drivers/bus/moxtet.c