Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/hid/hid
[sfrench/cifs-2.6.git] / Documentation / ABI / testing / sysfs-devices-platform-stratix10-rsu
1         Intel Stratix10 Remote System Update (RSU) device attributes
2
3 What:           /sys/devices/platform/stratix10-rsu.0/current_image
4 Date:           August 2019
5 KernelVersion:  5.4
6 Contact:        Richard Gong <richard.gong@linux.intel.com>
7 Description:
8                 (RO) the address in flash of currently running image.
9
10 What:           /sys/devices/platform/stratix10-rsu.0/fail_image
11 Date:           August 2019
12 KernelVersion:  5.4
13 Contact:        Richard Gong <richard.gong@linux.intel.com>
14 Description:
15                 (RO) the address in flash of failed image.
16
17 What:           /sys/devices/platform/stratix10-rsu.0/state
18 Date:           August 2019
19 KernelVersion:  5.4
20 Contact:        Richard Gong <richard.gong@linux.intel.com>
21 Description:
22                 (RO) the state of RSU system.
23                 The state field has two parts: major error code in
24                 upper 16 bits and minor error code in lower 16 bits.
25
26                 b[15:0]
27                         Currently used only when major error is 0xF006
28                         (CPU watchdog timeout), in which case the minor
29                         error code is the value reported by CPU to
30                         firmware through the RSU notify command before
31                         the watchdog timeout occurs.
32
33                 b[31:16]
34                         0xF001  bitstream error
35                         0xF002  hardware access failure
36                         0xF003  bitstream corruption
37                         0xF004  internal error
38                         0xF005  device error
39                         0xF006  CPU watchdog timeout
40                         0xF007  internal unknown error
41
42 What:           /sys/devices/platform/stratix10-rsu.0/version
43 Date:           August 2019
44 KernelVersion:  5.4
45 Contact:        Richard Gong <richard.gong@linux.intel.com>
46 Description:
47                 (RO) the version number of RSU firmware. 19.3 or late
48                 version includes information about the firmware which
49                 reported the error.
50
51                 pre 19.3:
52                         b[31:0]
53                                 0x0     version number
54
55                 19.3 or late:
56                         b[15:0]
57                                 0x1     version number
58                         b[31:16]
59                                 0x0     no error
60                                 0x0DCF  Decision CMF error
61                                 0x0ACF  Application CMF error
62
63 What:           /sys/devices/platform/stratix10-rsu.0/error_location
64 Date:           August 2019
65 KernelVersion:  5.4
66 Contact:        Richard Gong <richard.gong@linux.intel.com>
67 Description:
68                 (RO) the error offset inside the image that failed.
69
70 What:           /sys/devices/platform/stratix10-rsu.0/error_details
71 Date:           August 2019
72 KernelVersion:  5.4
73 Contact:        Richard Gong <richard.gong@linux.intel.com>
74 Description:
75                 (RO) error code.
76
77 What:           /sys/devices/platform/stratix10-rsu.0/retry_counter
78 Date:           August 2019
79 KernelVersion:  5.4
80 Contact:        Richard Gong <richard.gong@linux.intel.com>
81 Description:
82                 (RO) the current image's retry counter, which is used by
83                 user to know how many times the images is still allowed
84                 to reload itself before giving up and starting RSU
85                 fail-over flow.
86
87 What:           /sys/devices/platform/stratix10-rsu.0/reboot_image
88 Date:           August 2019
89 KernelVersion:  5.4
90 Contact:        Richard Gong <richard.gong@linux.intel.com>
91 Description:
92                 (WO) the address in flash of image to be loaded on next
93                 reboot command.
94
95 What:           /sys/devices/platform/stratix10-rsu.0/notify
96 Date:           August 2019
97 KernelVersion:  5.4
98 Contact:        Richard Gong <richard.gong@linux.intel.com>
99 Description:
100                 (WO) client to notify firmware with different actions.
101
102                 b[15:0]
103                         inform firmware the current software execution
104                         stage.
105                         0       the first stage bootloader didn't run or
106                                 didn't reach the point of launching second
107                                 stage bootloader.
108                         1       failed in second bootloader or didn't get
109                                 to the point of launching the operating
110                                 system.
111                         2       both first and second stage bootloader ran
112                                 and the operating system launch was
113                                 attempted.
114
115                 b[16]
116                         1       firmware to reset current image retry
117                                 counter.
118                         0       no action.
119
120                 b[17]
121                         1       firmware to clear RSU log
122                         0       no action.
123
124                 b[18]
125                         this is negative logic
126                         1       no action
127                         0       firmware record the notify code defined
128                                 in b[15:0].