linux/fpga/fpga-mgr.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * FPGA Framework
5  *  Copyright (C) 2013-2016 Altera Corporation
18  * enum fpga_mgr_states - fpga framework states
20  * @FPGA_MGR_STATE_POWER_OFF: FPGA power is off
21  * @FPGA_MGR_STATE_POWER_UP: FPGA reports power is up
22  * @FPGA_MGR_STATE_RESET: FPGA in reset state
25  * @FPGA_MGR_STATE_PARSE_HEADER: parse FPGA image header
27  * @FPGA_MGR_STATE_WRITE_INIT: preparing FPGA for programming
29  * @FPGA_MGR_STATE_WRITE: writing image to FPGA
30  * @FPGA_MGR_STATE_WRITE_ERR: Error while writing FPGA
33  * @FPGA_MGR_STATE_OPERATING: FPGA is programmed and operating
36 	/* default FPGA states */
56 	/* fpga is programmed and operating */
61  * DOC: FPGA Manager flags
63  * Flags used in the &fpga_image_info->flags field
67  * %FPGA_MGR_EXTERNAL_CONFIG: FPGA has been configured prior to Linux booting
73  * %FPGA_MGR_COMPRESSED_BITSTREAM: FPGA bitstream is compressed
77 #define FPGA_MGR_ENCRYPTED_BITSTREAM	BIT(2)
82  * struct fpga_image_info - information specific to an FPGA image
86  * @config_complete_timeout_us: maximum time for FPGA to switch to operating
88  * @firmware_name: name of FPGA image firmware file
89  * @sgt: scatter/gather table containing FPGA image
90  * @buf: contiguous buffer containing FPGA image
118  * struct fpga_compat_id - id for compatibility check
129  * struct fpga_manager_info - collection of parameters for an FPGA Manager
130  * @name: fpga manager name
131  * @compat_id: FPGA manager id for compatibility check.
132  * @mops: pointer to structure of fpga manager ops
133  * @priv: fpga manager private data
148  * struct fpga_manager_ops - ops for low level fpga manager drivers
151  * @skip_header: bool flag to tell fpga-mgr core whether it should skip
152  *	info->header_size part at the beginning of the image when invoking
154  * @state: returns an enum value of the FPGA's state
155  * @status: returns status of the FPGA, including reconfiguration error code
156  * @parse_header: parse FPGA image header to set info->header_size and
157  *	info->data_size. In case the input buffer is not large enough, set
158  *	required size to info->header_size and return -EAGAIN.
159  * @write_init: prepare the FPGA to receive configuration data
160  * @write: write count bytes of configuration data to the FPGA
161  * @write_sg: write the scatter list of configuration data to the FPGA
162  * @write_complete: set FPGA to operating state after writing is done
163  * @fpga_remove: optional: Set FPGA into a specific state during driver remove
167  * fpga manager driver.  The optional ones are tested for NULL before being
189 /* FPGA manager status: Partial/Full Reconfiguration errors */
192 #define FPGA_MGR_STATUS_INCOMPATIBLE_IMAGE_ERR	BIT(2)
197  * struct fpga_manager - fpga manager structure
198  * @name: name of low level fpga manager
199  * @dev: fpga manager device
200  * @ref_mutex: only allows one reference to fpga manager
201  * @state: state of fpga manager
202  * @compat_id: FPGA manager id for compatibility check.
203  * @mops: pointer to struct of fpga manager ops