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>
---
v2: changed to use tab everywhere and wrap lines at 72 colums
s/soc:firmware:svc:rsu/stratix10-rsu.0
added for watchdog
v3: s/KernelVersion:5.2/KernelVersion:5.3
v4: replaced /sys/devices/platform/stratix10-rsu.0/ with
/sys/devices/.../stratix10-rsu.0/driver/
removed spaces
---
.../testing/sysfs-devices-platform-stratix10-rsu | 100 +++++++++++++++++++++
1 file changed, 100 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..29ae1c7
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
@@ -0,0 +1,100 @@
+ Intel Stratix10 Remote System Update (RSU) device attributes
+
+What: /sys/devices/.../stratix10-rsu.0/driver/current_image
+Date: May 2019
+KernelVersion: 5.3
+Contact: Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+ (RO) the address of image currently running in flash.
+
+What: /sys/devices/.../stratix10-rsu.0/driver/fail_image
+Date: May 2019
+KernelVersion: 5.3
+Contact: Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+ (RO) the address of failed image in flash.
+
+What: /sys/devices/.../stratix10-rsu.0/driver/state
+Date: May 2019
+KernelVersion: 5.3
+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.
+
+ Major error code:
+ 0xF001 bitstream error
+ 0xF002 hardware access failure
+ 0xF003 bitstream corruption
+ 0xF004 internal error
+ 0xF005 device error
+ 0xF006 CPU watchdog timeout
+ 0xF007 internal unknown error
+ Minor error code:
+ Currently used only when major error is 0xF006
+ (CPU watchdog timeout), in which case the minor
+ error code is the value reported by CPU to
+ firmware through the RSU notify command before
+ the watchdog timeout occurs.
+
+What: /sys/devices/.../stratix10-rsu.0/driver/fail_image
+Date: May 2019
+KernelVersion: 5.3
+Contact: Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+ (RO) the version number of RSU firmware.
+
+What: /sys/devices/.../stratix10-rsu.0/driver/error_location
+Date: May 2019
+KernelVersion: 5.3
+Contact: Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+ (RO) the error offset inside the image that failed.
+
+What: /sys/devices/.../stratix10-rsu.0/driver/error_details
+Date: May 2019
+KernelVersion: 5.3
+Contact: Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+ (RO) error code.
+
+What: /sys/devices/.../stratix10-rsu.0/driver/reboot_image
+Date: May 2019
+KernelVersion: 5.3
+Contact: Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+ (WO) the address of image to be loaded on next reboot command.
+
+What: /sys/devices/.../stratix10-rsu.0/driver/notify
+Date: May 2019
+KernelVersion: 5.3
+Contact: Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+ (WO) inform firmware that the current software state as
+ a 16-bit numerical value below:
+ 0 is for the first stage bootloader didn't run
+ or didn't reach the point of launching second
+ stage bootloader.
+ 1 is for failed in second bootloader or didn't
+ get to the point of launching the operating
+ system.
+ 2 is for both first and second stage bootloader
+ ran and the operating system launch was
+ attempted.
+
+What: /sys/devices/.../stratix10-rsu.0/driver/watchdog
+Date: May 2019
+KernelVersion: 5.3
+Contact: Richard Gong <richard.gong@xxxxxxxxx>
+Description:
+ (WO) instruct firmware what to do when rebooting due to
+ a watchdog timer expiration. The attribute takes a
+ 32 bits word as the parameter indicating the action for
+ firmware to take:
+
+ b[0] is set to 0, the firmware should reboot
+ with the normal RSU flow.
+ b[0] is set to 1, the firmware shall always
+ reboot with the current running image.
+ b[31:1] reserved.
--
2.7.4
