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