[PATCHv1 5/6] firmware: rsu: document sysfs interface

[richard . gong]

From: Richard Gong <richard.gong@xxxxxxxxx>

Describe Intel Stratix10 Remote System Update (RSU) device attributes

Signed-off-by: Richard Gong <richard.gong@xxxxxxxxx>
Reviewed-by: Alan Tull <atull@xxxxxxxxxx>
---
 .../testing/sysfs-devices-platform-stratix10-rsu   | 78 ++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu

diff --git a/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
new file mode 100644
index 0000000..cb461ee
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
@@ -0,0 +1,78 @@
+		Intel Stratix10 Remote System Update (RSU) device attributes
+
+What:		/sys/devices/platform/soc:firmware:svc/soc:firmware:svc:rsu/current_image
+Date:		April 2019
+KernelVersion:	5.2
+Contact:	Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+		(RO) the address of image currently running in flash.
+
+What:           /sys/devices/platform/soc:firmware:svc/soc:firmware:svc:rsu/fail_image
+Date:           April 2019
+KernelVersion:  5.2
+Contact:        Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+		(RO) the address of failed image in flash.
+
+What:           /sys/devices/platform/soc:firmware:svc/soc:firmware:svc:rsu/state
+Date:           April 2019
+KernelVersion:  5.2
+Contact:        Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+		(RO) the state of RSU system.
+		The state field has two parts: major error code in upper 16 bits and minor error code
+		in lower 16 bits.
+		1. Major error code
+			0xF001 -- bitstream error
+			0xF002 -- hardware access failure
+			0xF003 -- bitstream corruption
+			0xF004 -- internal error
+			0xF005 -- device error
+			0xF006 -- HPS watchdog timeout
+			0xF007 -- internal unknown error
+		2: Minor error code
+			Currently used only when major error is 0xF006 (HPS watchdog timeout), in which
+		case the minor error code is the value reported by HPS to firmware through the RSU notify
+		command before the watchdog timeout occurs.
+
+What:           /sys/devices/platform/soc:firmware:svc/soc:firmware:svc:rsu/version
+Date:           April 2019
+KernelVersion:  5.2
+Contact:        Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+		(RO) the version number of RSU firmware.
+
+What:           /sys/devices/platform/soc:firmware:svc/soc:firmware:svc:rsu/error_location
+Date:           April 2019
+KernelVersion:  5.2
+Contact:        Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+		(RO) the error offset inside the image that failed.
+
+What:           /sys/devices/platform/soc:firmware:svc/soc:firmware:svc:rsu/error_details
+Date:           April 2019
+KernelVersion:  5.2
+Contact:        Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+		(RO) error code.
+
+What:           /sys/devices/platform/soc:firmware:svc/soc:firmware:svc:rsu/reboot_image
+Date:           April 2019
+KernelVersion:  5.2
+Contact:        Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+		(WO) the address of image to be loaded on next reboot command.
+
+What:           /sys/devices/platform/soc:firmware:svc/soc:firmware:svc:rsu/notify
+Date:           April 2019
+KernelVersion:  5.2
+Contact:        Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+		(WO) inform firmware that the current software state as a 16-bit
+		numerical value below:
+		0 -- the first stage bootloader didn't run or didn't reach the
+		     point of launching second stage bootloader
+		1 -- failed in second bootloader or didn't get to the point of
+		     launching the operating system
+		2 -- both first and second stage bootloader ran and the operating
+		     system launch was attempted.
-- 
2.7.4