3  * FPGA Manager Core
12 #include <linux/fpga/fpga-mgr.h>
56  * After all the FPGA image has been written, do the device specific steps to
57  * finish and set the FPGA into operating mode.
68 		dev_err(&mgr->dev, "Error after writing image data to FPGA\n");  in fpga_mgr_write_complete()
104  * fpga_image_info_alloc - Allocate an FPGA image info struct
128  * fpga_image_info_free - Free an FPGA image info struct
129  * @info: FPGA image info struct to free
148  * Call the low level driver's parse_header function with entire FPGA image
161 		dev_err(&mgr->dev, "Bitstream data outruns FPGA image\n");  in fpga_mgr_parse_header_mapped()
166 		dev_err(&mgr->dev, "Error while parsing FPGA image header\n");  in fpga_mgr_parse_header_mapped()
175  * scattered FPGA image on the input. If header fits first fragment,
198 		dev_err(&mgr->dev, "Error while parsing FPGA image header\n");  in fpga_mgr_parse_header_sg_first()
206  * Copy scattered FPGA image fragments to temporary buffer and call the
250 		dev_err(&mgr->dev, "Error while parsing FPGA image header\n");  in fpga_mgr_parse_header_sg()
263  * device-specific things to get the FPGA into the state where it is ready to
264  * receive an FPGA image. The low level driver gets to see at least first
285 		dev_err(&mgr->dev, "Error preparing FPGA for writing\n");  in fpga_mgr_write_init_buf()
345  * fpga_mgr_buf_load_sg - load fpga from image in buffer from a scatter list
346  * @mgr:	fpga manager
347  * @info:	fpga image specific information
350  * Step the low level fpga manager through the device-specific steps of getting
351  * an FPGA ready to be configured, writing the image to it, then doing whatever
356  * This is the preferred entry point for FPGA programming, it does not require
371 	/* Write the FPGA image to the FPGA. */  in fpga_mgr_buf_load_sg()
406 		dev_err(&mgr->dev, "Error while writing image data to FPGA\n");  in fpga_mgr_buf_load_sg()
437 	 * Write the FPGA image to the FPGA.  in fpga_mgr_buf_load_mapped()
442 		dev_err(&mgr->dev, "Error while writing image data to FPGA\n");  in fpga_mgr_buf_load_mapped()
451  * fpga_mgr_buf_load - load fpga from image in buffer
452  * @mgr:	fpga manager
453  * @info:	fpga image info
454  * @buf:	buffer contain fpga image
457  * Step the low level fpga manager through the device-specific steps of getting
458  * an FPGA ready to be configured, writing the image to it, then doing whatever
523  * fpga_mgr_firmware_load - request firmware and load to fpga
524  * @mgr:	fpga manager
525  * @info:	fpga image specific information
528  * Request an FPGA image using the firmware class, then write out to the FPGA.
563  * fpga_mgr_load - load FPGA from scatter/gather table, buffer, or firmware
564  * @mgr:	fpga manager
565  * @info:	fpga image information.
567  * Load the FPGA from an image which is indicated in @info.  If successful, the
568  * FPGA ends up in operating mode.
592 	/* requesting FPGA image from firmware */
596 	/* Parse FPGA image header */
600 	/* Preparing FPGA to receive image */
604 	/* Writing image to FPGA */
612 	/* FPGA reports to be in normal operating mode */
689  * fpga_mgr_get - Given a device, get a reference to an fpga mgr.
690  * @dev:	parent device that fpga mgr was registered with
692  * Return: fpga manager struct or IS_ERR() condition containing error code.
706  * of_fpga_mgr_get - Given a device node, get a reference to an fpga mgr.
710  * Return: fpga manager struct or IS_ERR() condition containing error code.
725  * fpga_mgr_put - release a reference to an fpga manager
726  * @mgr:	fpga manager structure
736  * fpga_mgr_lock - Lock FPGA manager for exclusive use
737  * @mgr:	fpga manager
739  * Given a pointer to FPGA Manager (from fpga_mgr_get() or
742  * program the FPGA.  Likewise, the user should call fpga_mgr_unlock
743  * when done programming the FPGA.
750 		dev_err(&mgr->dev, "FPGA manager is in use.\n");  in fpga_mgr_lock()
759  * fpga_mgr_unlock - Unlock FPGA manager after done programming
760  * @mgr:	fpga manager
769  * fpga_mgr_register_full - create and register an FPGA Manager device
770  * @parent:	fpga manager device from pdev
771  * @info:	parameters for fpga manager
818 	ret = dev_set_name(&mgr->dev, "fpga%d", id);  in fpga_mgr_register_full()
824 	 * from device.  FPGA may be in reset mode or may have been programmed  in fpga_mgr_register_full()
847  * fpga_mgr_register - create and register an FPGA Manager device
848  * @parent:	fpga manager device from pdev
849  * @name:	fpga manager name
850  * @mops:	pointer to structure of fpga manager ops
851  * @priv:	fpga manager private data
876  * fpga_mgr_unregister - unregister an FPGA manager
877  * @mgr: fpga manager struct
879  * This function is intended for use in an FPGA manager driver's remove function.
886 	 * If the low level driver provides a method for putting fpga into  in fpga_mgr_unregister()
904  * @parent:	fpga manager device from pdev
905  * @info:	parameters for fpga manager
907  * Return:  fpga manager pointer on success, negative error code otherwise.
937  * @parent:	fpga manager device from pdev
938  * @name:	fpga manager name
939  * @mops:	pointer to structure of fpga manager ops
940  * @priv:	fpga manager private data
942  * Return:  fpga manager pointer on success, negative error code otherwise.
972 	pr_info("FPGA manager framework\n");  in fpga_mgr_class_init()
991 MODULE_DESCRIPTION("FPGA manager framework");