Merge tag 'scsi-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/jejb/scsi
[sfrench/cifs-2.6.git] / Documentation / ABI / testing / sysfs-platform-dfl-port
1 What:           /sys/bus/platform/devices/dfl-port.0/id
2 Date:           June 2018
3 KernelVersion:  4.19
4 Contact:        Wu Hao <hao.wu@intel.com>
5 Description:    Read-only. It returns id of this port. One DFL FPGA device
6                 may have more than one port. Userspace could use this id to
7                 distinguish different ports under same FPGA device.
8
9 What:           /sys/bus/platform/devices/dfl-port.0/afu_id
10 Date:           June 2018
11 KernelVersion:  4.19
12 Contact:        Wu Hao <hao.wu@intel.com>
13 Description:    Read-only. User can program different PR bitstreams to FPGA
14                 Accelerator Function Unit (AFU) for different functions. It
15                 returns uuid which could be used to identify which PR bitstream
16                 is programmed in this AFU.
17
18 What:           /sys/bus/platform/devices/dfl-port.0/power_state
19 Date:           August 2019
20 KernelVersion:  5.4
21 Contact:        Wu Hao <hao.wu@intel.com>
22 Description:    Read-only. It reports the APx (AFU Power) state, different APx
23                 means different throttling level. When reading this file, it
24                 returns "0" - Normal / "1" - AP1 / "2" - AP2 / "6" - AP6.
25
26 What:           /sys/bus/platform/devices/dfl-port.0/ap1_event
27 Date:           August 2019
28 KernelVersion:  5.4
29 Contact:        Wu Hao <hao.wu@intel.com>
30 Description:    Read-write. Read this file for AP1 (AFU Power State 1) event.
31                 It's used to indicate transient AP1 state. Write 1 to this
32                 file to clear AP1 event.
33
34 What:           /sys/bus/platform/devices/dfl-port.0/ap2_event
35 Date:           August 2019
36 KernelVersion:  5.4
37 Contact:        Wu Hao <hao.wu@intel.com>
38 Description:    Read-write. Read this file for AP2 (AFU Power State 2) event.
39                 It's used to indicate transient AP2 state. Write 1 to this
40                 file to clear AP2 event.
41
42 What:           /sys/bus/platform/devices/dfl-port.0/ltr
43 Date:           August 2019
44 KernelVersion:  5.4
45 Contact:        Wu Hao <hao.wu@intel.com>
46 Description:    Read-write. Read or set AFU latency tolerance reporting value.
47                 Set ltr to 1 if the AFU can tolerate latency >= 40us or set it
48                 to 0 if it is latency sensitive.
49
50 What:           /sys/bus/platform/devices/dfl-port.0/userclk_freqcmd
51 Date:           August 2019
52 KernelVersion:  5.4
53 Contact:        Wu Hao <hao.wu@intel.com>
54 Description:    Write-only. User writes command to this interface to set
55                 userclock to AFU.
56
57 What:           /sys/bus/platform/devices/dfl-port.0/userclk_freqsts
58 Date:           August 2019
59 KernelVersion:  5.4
60 Contact:        Wu Hao <hao.wu@intel.com>
61 Description:    Read-only. Read this file to get the status of issued command
62                 to userclck_freqcmd.
63
64 What:           /sys/bus/platform/devices/dfl-port.0/userclk_freqcntrcmd
65 Date:           August 2019
66 KernelVersion:  5.4
67 Contact:        Wu Hao <hao.wu@intel.com>
68 Description:    Write-only. User writes command to this interface to set
69                 userclock counter.
70
71 What:           /sys/bus/platform/devices/dfl-port.0/userclk_freqcntrsts
72 Date:           August 2019
73 KernelVersion:  5.4
74 Contact:        Wu Hao <hao.wu@intel.com>
75 Description:    Read-only. Read this file to get the status of issued command
76                 to userclck_freqcntrcmd.
77
78 What:           /sys/bus/platform/devices/dfl-port.0/errors/errors
79 Date:           August 2019
80 KernelVersion:  5.4
81 Contact:        Wu Hao <hao.wu@intel.com>
82 Description:    Read-Write. Read this file to get errors detected on port and
83                 Accelerated Function Unit (AFU). Write error code to this file
84                 to clear errors. Write fails with -EINVAL if input parsing
85                 fails or input error code doesn't match. Write fails with
86                 -EBUSY or -ETIMEDOUT if error can't be cleared as hardware
87                 in low power state (-EBUSY) or not respoding (-ETIMEDOUT).
88
89 What:           /sys/bus/platform/devices/dfl-port.0/errors/first_error
90 Date:           August 2019
91 KernelVersion:  5.4
92 Contact:        Wu Hao <hao.wu@intel.com>
93 Description:    Read-only. Read this file to get the first error detected by
94                 hardware.
95
96 What:           /sys/bus/platform/devices/dfl-port.0/errors/first_malformed_req
97 Date:           August 2019
98 KernelVersion:  5.4
99 Contact:        Wu Hao <hao.wu@intel.com>
100 Description:    Read-only. Read this file to get the first malformed request
101                 captured by hardware.