Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 492ecf6d authored by Alan Tull's avatar Alan Tull Committed by Greg Kroah-Hartman
Browse files

docs: fpga: document fpga manager flags 



Add flags #defines to kerneldoc documentation in a
useful place.

Signed-off-by: default avatarAlan Tull <atull@kernel.org>
Acked-by: default avatarMoritz Fischer <mdf@kernel.org>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent b4d9a0e5

Documentation/driver-api/fpga/fpga-mgr.rst

+5 −0
Original line number Diff line number Diff line
@@ -184,6 +184,11 @@ API for implementing a new FPGA Manager driver 
API for programming an FPGA

---------------------------



FPGA Manager flags



.. kernel-doc:: include/linux/fpga/fpga-mgr.h

   :doc: FPGA Manager flags



.. kernel-doc:: include/linux/fpga/fpga-mgr.h

   :functions: fpga_image_info

include/linux/fpga/fpga-mgr.h

+14 −6
Original line number Diff line number Diff line
@@ -53,12 +53,20 @@ enum fpga_mgr_states { 
	FPGA_MGR_STATE_OPERATING,

};



/*

 * FPGA Manager flags

 * FPGA_MGR_PARTIAL_RECONFIG: do partial reconfiguration if supported

 * FPGA_MGR_EXTERNAL_CONFIG: FPGA has been configured prior to Linux booting

 * FPGA_MGR_BITSTREAM_LSB_FIRST: SPI bitstream bit order is LSB first

 * FPGA_MGR_COMPRESSED_BITSTREAM: FPGA bitstream is compressed

/**

 * DOC: FPGA Manager flags

 *

 * Flags used in the &fpga_image_info->flags field

 *

 * %FPGA_MGR_PARTIAL_RECONFIG: do partial reconfiguration if supported

 *

 * %FPGA_MGR_EXTERNAL_CONFIG: FPGA has been configured prior to Linux booting

 *

 * %FPGA_MGR_ENCRYPTED_BITSTREAM: indicates bitstream is encrypted

 *

 * %FPGA_MGR_BITSTREAM_LSB_FIRST: SPI bitstream bit order is LSB first

 *

 * %FPGA_MGR_COMPRESSED_BITSTREAM: FPGA bitstream is compressed

 */

#define FPGA_MGR_PARTIAL_RECONFIG	BIT(0)

#define FPGA_MGR_EXTERNAL_CONFIG	BIT(1)