1What:		/sys/class/fpga_manager/<fpga>/name
2Date:		August 2015
3KernelVersion:	4.3
4Contact:	Alan Tull <atull@opensource.altera.com>
5Description:	Name of low level fpga manager driver.
6
7What:		/sys/class/fpga_manager/<fpga>/state
8Date:		August 2015
9KernelVersion:	4.3
10Contact:	Alan Tull <atull@opensource.altera.com>
11Description:	Read fpga manager state as a string.
12		The intent is to provide enough detail that if something goes
13		wrong during FPGA programming (something that the driver can't
14		fix) then userspace can know, i.e. if the firmware request
15		fails, that could be due to not being able to find the firmware
16		file.
17
18		This is a superset of FPGA states and fpga manager driver
19		states.  The fpga manager driver is walking through these steps
20		to get the FPGA into a known operating state.  It's a sequence,
21		though some steps may get skipped.  Valid FPGA states will vary
22		by manufacturer; this is a superset.
23
24		* unknown		= can't determine state
25		* power off		= FPGA power is off
26		* power up		= FPGA reports power is up
27		* reset			= FPGA held in reset state
28		* firmware request	= firmware class request in progress
29		* firmware request error = firmware request failed
30		* write init		= preparing FPGA for programming
31		* write init error	= Error while preparing FPGA for programming
32		* write			= FPGA ready to receive image data
33		* write error		= Error while programming
34		* write complete	= Doing post programming steps
35		* write complete error	= Error while doing post programming
36		* operating		= FPGA is programmed and operating
37
38What:		/sys/class/fpga_manager/<fpga>/status
39Date:		June 2018
40KernelVersion:	4.19
41Contact:	Wu Hao <hao.wu@intel.com>
42Description:	Read fpga manager status as a string.
43		If FPGA programming operation fails, it could be caused by crc
44		error or incompatible bitstream image. The intent of this
45		interface is to provide more detailed information for FPGA
46		programming errors to userspace. This is a list of strings for
47		the supported status.
48
49		* reconfig operation error	- invalid operations detected by
50						  reconfiguration hardware.
51						  e.g. start reconfiguration
52						  with errors not cleared
53		* reconfig CRC error		- CRC error detected by
54						  reconfiguration hardware.
55		* reconfig incompatible image	- reconfiguration image is
56						  incompatible with hardware
57		* reconfig IP protocol error	- protocol errors detected by
58						  reconfiguration hardware
59		* reconfig fifo overflow error	- FIFO overflow detected by
60						  reconfiguration hardware
61