doc: fpga-mgr: add fpga image info to api
authorAlan Tull <atull@opensource.altera.com>
Tue, 1 Nov 2016 19:14:24 +0000 (14:14 -0500)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 10 Nov 2016 16:03:35 +0000 (17:03 +0100)
commit40e83578fd1e503cf3b7b2707d3985e53505cb3b
treef729c2b2b8e6c041c682ca11abaa3e82744f5578
parent9dce0287a60d72656a787b075f1b9162ff3cb142
doc: fpga-mgr: add fpga image info to api

This patch adds a minor change in the FPGA Manager API
to hold information that is specific to an FPGA image
file.  This change is expected to bring little, if any,
pain.

An FPGA image file will have particulars that affect how the
image is programmed to the FPGA.  One example is that
current 'flags' currently has one bit which shows whether the
FPGA image was built for full reconfiguration or partial
reconfiguration.  Another example is timeout values for
enabling or disabling the bridges in the FPGA.  As the
complexity of the FPGA design increases, the bridges in the
FPGA may take longer times to enable or disable.

This patch documents the change in the FPGA Manager API
functions, replacing the 'u32 flag' parameter with a pointer
to struct fpga_image_info.

Signed-off-by: Alan Tull <atull@opensource.altera.com>
Acked-by: Moritz Fischer <moritz.fischer@ettus.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/fpga/fpga-mgr.txt