xref: /linux/Documentation/ABI/testing/sysfs-platform-dfl-port (revision 82e8d723e9e6698572098bf2976223d5069b34b5)
1What:		/sys/bus/platform/devices/dfl-port.0/id
2Date:		June 2018
3KernelVersion:	4.19
4Contact:	Wu Hao <hao.wu@intel.com>
5Description:	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
9What:		/sys/bus/platform/devices/dfl-port.0/afu_id
10Date:		June 2018
11KernelVersion:	4.19
12Contact:	Wu Hao <hao.wu@intel.com>
13Description:	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
18What:		/sys/bus/platform/devices/dfl-port.0/power_state
19Date:		August 2019
20KernelVersion:	5.4
21Contact:	Wu Hao <hao.wu@intel.com>
22Description:	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
26What:		/sys/bus/platform/devices/dfl-port.0/ap1_event
27Date:		August 2019
28KernelVersion:	5.4
29Contact:	Wu Hao <hao.wu@intel.com>
30Description:	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
34What:		/sys/bus/platform/devices/dfl-port.0/ap2_event
35Date:		August 2019
36KernelVersion:	5.4
37Contact:	Wu Hao <hao.wu@intel.com>
38Description:	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
42What:		/sys/bus/platform/devices/dfl-port.0/ltr
43Date:		August 2019
44KernelVersion:	5.4
45Contact:	Wu Hao <hao.wu@intel.com>
46Description:	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
50What:		/sys/bus/platform/devices/dfl-port.0/userclk_freqcmd
51Date:		August 2019
52KernelVersion:	5.4
53Contact:	Wu Hao <hao.wu@intel.com>
54Description:	Write-only. User writes command to this interface to set
55		userclock to AFU.
56
57What:		/sys/bus/platform/devices/dfl-port.0/userclk_freqsts
58Date:		August 2019
59KernelVersion:	5.4
60Contact:	Wu Hao <hao.wu@intel.com>
61Description:	Read-only. Read this file to get the status of issued command
62		to userclck_freqcmd.
63
64What:		/sys/bus/platform/devices/dfl-port.0/userclk_freqcntrcmd
65Date:		August 2019
66KernelVersion:	5.4
67Contact:	Wu Hao <hao.wu@intel.com>
68Description:	Write-only. User writes command to this interface to set
69		userclock counter.
70
71What:		/sys/bus/platform/devices/dfl-port.0/userclk_freqcntrsts
72Date:		August 2019
73KernelVersion:	5.4
74Contact:	Wu Hao <hao.wu@intel.com>
75Description:	Read-only. Read this file to get the status of issued command
76		to userclck_freqcntrcmd.
77
78What:		/sys/bus/platform/devices/dfl-port.0/errors/errors
79Date:		August 2019
80KernelVersion:	5.4
81Contact:	Wu Hao <hao.wu@intel.com>
82Description:	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
89What:		/sys/bus/platform/devices/dfl-port.0/errors/first_error
90Date:		August 2019
91KernelVersion:	5.4
92Contact:	Wu Hao <hao.wu@intel.com>
93Description:	Read-only. Read this file to get the first error detected by
94		hardware.
95
96What:		/sys/bus/platform/devices/dfl-port.0/errors/first_malformed_req
97Date:		August 2019
98KernelVersion:	5.4
99Contact:	Wu Hao <hao.wu@intel.com>
100Description:	Read-only. Read this file to get the first malformed request
101		captured by hardware.
102