1 // SPDX-License-Identifier: GPL-2.0+
3 #include <linux/kernel.h>
4 #include <linux/init.h>
5 #include <linux/module.h>
6 #include <linux/types.h>
7 #include <linux/device.h>
8 #include <linux/string.h>
9 #include <linux/slab.h>
11 #include <linux/platform_device.h>
13 #include <linux/delay.h>
15 #include <linux/firmware.h>
16 #include <asm/unaligned.h>
18 #include "gs_fpgaboot.h"
21 #define DEVICE_NAME "device"
22 #define CLASS_NAME "fpgaboot"
24 static u8 bits_magic[] = {
25 0x0, 0x9, 0xf, 0xf0, 0xf, 0xf0,
26 0xf, 0xf0, 0xf, 0xf0, 0x0, 0x0, 0x1};
28 /* fake device for request_firmware */
29 static struct platform_device *firmware_pdev;
31 static char *file = "xlinx_fpga_firmware.bit";
32 module_param(file, charp, 0444);
33 MODULE_PARM_DESC(file, "Xilinx FPGA firmware file.");
35 static void read_bitstream(u8 *bitdata, u8 *buf, int *offset, int rdsize)
37 memcpy(buf, bitdata + *offset, rdsize);
41 static int readinfo_bitstream(u8 *bitdata, u8 *buf, int size, int *offset)
46 /* read section char */
47 read_bitstream(bitdata, tbuf, offset, 1);
50 read_bitstream(bitdata, tbuf, offset, 2);
52 len = get_unaligned_be16(tbuf);
54 pr_err("error: readinfo buffer too small\n");
58 read_bitstream(bitdata, buf, offset, len);
67 static int readlength_bitstream(u8 *bitdata, int *lendata, int *offset)
71 /* read section char */
72 read_bitstream(bitdata, tbuf, offset, 1);
74 /* make sure it is section 'e' */
76 pr_err("error: length section is not 'e', but %c\n", tbuf[0]);
80 /* read 4bytes length */
81 read_bitstream(bitdata, tbuf, offset, 4);
83 *lendata = get_unaligned_be32(tbuf);
89 * read first 13 bytes to check bitstream magic number
91 static int readmagic_bitstream(u8 *bitdata, int *offset)
96 read_bitstream(bitdata, buf, offset, 13);
97 r = memcmp(buf, bits_magic, 13);
99 pr_err("error: corrupted header\n");
102 pr_info("bitstream file magic number Ok\n");
104 *offset = 13; /* magic length */
110 * NOTE: supports only bitstream format
112 static enum fmt_image get_imageformat(void)
117 static void gs_print_header(struct fpgaimage *fimage)
119 pr_info("file: %s\n", fimage->filename);
120 pr_info("part: %s\n", fimage->part);
121 pr_info("date: %s\n", fimage->date);
122 pr_info("time: %s\n", fimage->time);
123 pr_info("lendata: %d\n", fimage->lendata);
126 static int gs_read_bitstream(struct fpgaimage *fimage)
133 bitdata = (u8 *)fimage->fw_entry->data;
135 err = readmagic_bitstream(bitdata, &offset);
139 err = readinfo_bitstream(bitdata, fimage->filename, MAX_STR, &offset);
142 err = readinfo_bitstream(bitdata, fimage->part, MAX_STR, &offset);
145 err = readinfo_bitstream(bitdata, fimage->date, MAX_STR, &offset);
148 err = readinfo_bitstream(bitdata, fimage->time, MAX_STR, &offset);
152 err = readlength_bitstream(bitdata, &fimage->lendata, &offset);
156 fimage->fpgadata = bitdata + offset;
161 static int gs_read_image(struct fpgaimage *fimage)
166 img_fmt = get_imageformat();
170 pr_info("image is bitstream format\n");
171 err = gs_read_bitstream(fimage);
176 pr_err("unsupported fpga image format\n");
180 gs_print_header(fimage);
185 static int gs_load_image(struct fpgaimage *fimage, char *fw_file)
189 pr_info("load fpgaimage %s\n", fw_file);
191 err = request_firmware(&fimage->fw_entry, fw_file, &firmware_pdev->dev);
193 pr_err("firmware %s is missing, cannot continue.\n", fw_file);
200 static int gs_download_image(struct fpgaimage *fimage, enum wbus bus_bytes)
206 bitdata = (u8 *)fimage->fpgadata;
207 size = fimage->lendata;
210 print_hex_dump_bytes("bitfile sample: ", DUMP_PREFIX_OFFSET,
212 #endif /* DEBUG_FPGA */
213 if (!xl_supported_prog_bus_width(bus_bytes)) {
214 pr_err("unsupported program bus width %d\n",
219 /* Bring csi_b, rdwr_b Low and program_b High */
224 /* Configuration reset */
229 /* Wait for Device Initialization */
230 while (xl_get_init_b() == 0)
233 pr_info("device init done\n");
235 for (i = 0; i < size; i += bus_bytes)
236 xl_shift_bytes_out(bus_bytes, bitdata + i);
238 pr_info("program done\n");
241 if (xl_get_init_b() == 0) {
242 pr_err("init_b 0\n");
246 while (xl_get_done_b() == 0) {
247 if (cnt++ > MAX_WAIT_DONE) {
248 pr_err("init_B %d\n", xl_get_init_b());
253 if (cnt > MAX_WAIT_DONE) {
254 pr_err("fpga download fail\n");
258 pr_info("download fpgaimage\n");
260 /* Compensate for Special Startup Conditions */
266 static int gs_release_image(struct fpgaimage *fimage)
268 release_firmware(fimage->fw_entry);
269 pr_info("release fpgaimage\n");
275 * NOTE: supports systemmap parallel programming
277 static int gs_set_download_method(struct fpgaimage *fimage)
279 pr_info("set program method\n");
281 fimage->dmethod = m_systemmap;
283 pr_info("systemmap program method\n");
288 static int init_driver(void)
290 firmware_pdev = platform_device_register_simple("fpgaboot", -1,
292 return PTR_ERR_OR_ZERO(firmware_pdev);
295 static int gs_fpgaboot(void)
298 struct fpgaimage *fimage;
300 fimage = kmalloc(sizeof(*fimage), GFP_KERNEL);
304 err = gs_load_image(fimage, file);
306 pr_err("gs_load_image error\n");
310 err = gs_read_image(fimage);
312 pr_err("gs_read_image error\n");
316 err = gs_set_download_method(fimage);
318 pr_err("gs_set_download_method error\n");
322 err = gs_download_image(fimage, bus_2byte);
324 pr_err("gs_download_image error\n");
328 err = gs_release_image(fimage);
330 pr_err("gs_release_image error\n");
338 err = gs_release_image(fimage);
340 pr_err("gs_release_image error\n");
347 static int __init gs_fpgaboot_init(void)
351 pr_info("FPGA DOWNLOAD --->\n");
353 pr_info("FPGA image file name: %s\n", file);
357 pr_err("FPGA DRIVER INIT FAIL!!\n");
363 pr_err("GPIO INIT FAIL!!\n");
369 pr_err("FPGA DOWNLOAD FAIL!!\n");
373 pr_info("FPGA DOWNLOAD DONE <---\n");
378 platform_device_unregister(firmware_pdev);
383 static void __exit gs_fpgaboot_exit(void)
385 platform_device_unregister(firmware_pdev);
386 pr_info("FPGA image download module removed\n");
389 module_init(gs_fpgaboot_init);
390 module_exit(gs_fpgaboot_exit);
392 MODULE_AUTHOR("Insop Song");
393 MODULE_DESCRIPTION("Xlinix FPGA firmware download");
394 MODULE_LICENSE("GPL");