linux-imx/Documentation/ABI/testing/sysfs-class-fpga-manager
Mauro Carvalho Chehab 54a19b4d3f docs: ABI: cleanup several ABI documents
There are some ABI documents that, while they don't generate
any warnings, they have issues when parsed by get_abi.pl script
on its output result.

Address them, in order to provide a clean output.

Reviewed-by: Tom Rix <trix@redhat.com> # for fpga-manager
Reviewed-By: Kajol Jain<kjain@linux.ibm.com> # for sysfs-bus-event_source-devices-hv_gpci and sysfs-bus-event_source-devices-hv_24x7
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO
Acked-by: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs
Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem
Acked-by: Cezary Rojewski <cezary.rojewski@intel.com> # for catpt
Acked-by: Suzuki K Poulose <suzuki.poulose@arm.com>
Acked-by: Ilya Dryomov <idryomov@gmail.com> # for rbd
Acked-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2020-10-30 13:14:29 +01:00

2.5 KiB

What: /sys/class/fpga_manager//name Date: August 2015 KernelVersion: 4.3 Contact: Alan Tull atull@opensource.altera.com Description: Name of low level fpga manager driver.

What: /sys/class/fpga_manager//state Date: August 2015 KernelVersion: 4.3 Contact: Alan Tull atull@opensource.altera.com Description: Read fpga manager state as a string. The intent is to provide enough detail that if something goes wrong during FPGA programming (something that the driver can't fix) then userspace can know, i.e. if the firmware request fails, that could be due to not being able to find the firmware file.

	This is a superset of FPGA states and fpga manager driver
	states.  The fpga manager driver is walking through these steps
	to get the FPGA into a known operating state.  It's a sequence,
	though some steps may get skipped.  Valid FPGA states will vary
	by manufacturer; this is a superset.

	* unknown		= can't determine state
	* power off		= FPGA power is off
	* power up		= FPGA reports power is up
	* reset			= FPGA held in reset state
	* firmware request	= firmware class request in progress
	* firmware request error = firmware request failed
	* write init		= preparing FPGA for programming
	* write init error	= Error while preparing FPGA for programming
	* write			= FPGA ready to receive image data
	* write error		= Error while programming
	* write complete	= Doing post programming steps
	* write complete error	= Error while doing post programming
	* operating		= FPGA is programmed and operating

What: /sys/class/fpga_manager//status Date: June 2018 KernelVersion: 4.19 Contact: Wu Hao hao.wu@intel.com Description: Read fpga manager status as a string. If FPGA programming operation fails, it could be caused by crc error or incompatible bitstream image. The intent of this interface is to provide more detailed information for FPGA programming errors to userspace. This is a list of strings for the supported status.

	* reconfig operation error	- invalid operations detected by
					  reconfiguration hardware.
					  e.g. start reconfiguration
					  with errors not cleared
	* reconfig CRC error		- CRC error detected by
					  reconfiguration hardware.
	* reconfig incompatible image	- reconfiguration image is
					  incompatible with hardware
	* reconfig IP protocol error	- protocol errors detected by
					  reconfiguration hardware
	* reconfig fifo overflow error	- FIFO overflow detected by
					  reconfiguration hardware