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