1 /*****************************************************************************
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
10 * XILINX IS PROVIDING THIS DESIGN, CODE, OR INFORMATION "AS IS"
11 * AS A COURTESY TO YOU, SOLELY FOR USE IN DEVELOPING PROGRAMS AND
12 * SOLUTIONS FOR XILINX DEVICES. BY PROVIDING THIS DESIGN, CODE,
13 * OR INFORMATION AS ONE POSSIBLE IMPLEMENTATION OF THIS FEATURE,
14 * APPLICATION OR STANDARD, XILINX IS MAKING NO REPRESENTATION
15 * THAT THIS IMPLEMENTATION IS FREE FROM ANY CLAIMS OF INFRINGEMENT,
16 * AND YOU ARE RESPONSIBLE FOR OBTAINING ANY RIGHTS YOU MAY REQUIRE
17 * FOR YOUR IMPLEMENTATION. XILINX EXPRESSLY DISCLAIMS ANY
18 * WARRANTY WHATSOEVER WITH RESPECT TO THE ADEQUACY OF THE
19 * IMPLEMENTATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OR
20 * REPRESENTATIONS THAT THIS IMPLEMENTATION IS FREE FROM CLAIMS OF
21 * INFRINGEMENT, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 * FOR A PARTICULAR PURPOSE.
24 * (c) Copyright 2002 Xilinx Inc., Systems Engineering Group
25 * (c) Copyright 2004 Xilinx Inc., Systems Engineering Group
26 * (c) Copyright 2007-2008 Xilinx Inc.
27 * All rights reserved.
29 * You should have received a copy of the GNU General Public License along
30 * with this program; if not, write to the Free Software Foundation, Inc.,
31 * 675 Mass Ave, Cambridge, MA 02139, USA.
33 *****************************************************************************/
36 * This is the code behind /dev/icap* -- it allows a user-space
37 * application to use the Xilinx ICAP subsystem.
39 * The following operations are possible:
41 * open open the port and initialize for access.
42 * release release port
43 * write Write a bitstream to the configuration processor.
44 * read Read a data stream from the configuration processor.
46 * After being opened, the port is initialized and accessed to avoid a
47 * corrupted first read which may occur with some hardware. The port
48 * is left in a desynched state, requiring that a synch sequence be
49 * transmitted before any valid configuration data. A user will have
50 * exclusive access to the device while it remains open, and the state
51 * of the ICAP cannot be guaranteed after the device is closed. Note
52 * that a complete reset of the core and the state of the ICAP cannot
53 * be performed on many versions of the cores, hence users of this
54 * device should avoid making inconsistent accesses to the device. In
55 * particular, accessing the read interface, without first generating
56 * a write containing a readback packet can leave the ICAP in an
59 * Note that in order to use the read interface, it is first necessary
60 * to write a request packet to the write interface. i.e., it is not
61 * possible to simply readback the bitstream (or any configuration
62 * bits) from a device without specifically requesting them first.
63 * The code to craft such packets is intended to be part of the
64 * user-space application code that uses this device. The simplest
65 * way to use this interface is simply:
67 * cp foo.bit /dev/icap0
69 * Note that unless foo.bit is an appropriately constructed partial
70 * bitstream, this has a high likelihood of overwriting the design
71 * currently programmed in the FPGA.
74 #include <linux/module.h>
75 #include <linux/kernel.h>
76 #include <linux/types.h>
77 #include <linux/ioport.h>
78 #include <linux/interrupt.h>
79 #include <linux/fcntl.h>
80 #include <linux/init.h>
81 #include <linux/poll.h>
82 #include <linux/proc_fs.h>
83 #include <linux/mutex.h>
84 #include <linux/sysctl.h>
86 #include <linux/cdev.h>
87 #include <linux/platform_device.h>
88 #include <linux/slab.h>
91 #include <asm/uaccess.h>
92 #include <asm/system.h>
95 /* For open firmware. */
96 #include <linux/of_address.h>
97 #include <linux/of_device.h>
98 #include <linux/of_platform.h>
101 #include "xilinx_hwicap.h"
102 #include "buffer_icap.h"
103 #include "fifo_icap.h"
105 #define DRIVER_NAME "icap"
107 #define HWICAP_REGS (0x10000)
109 #define XHWICAP_MAJOR 259
110 #define XHWICAP_MINOR 0
111 #define HWICAP_DEVICES 1
113 /* An array, which is set to true when the device is registered. */
114 static DEFINE_MUTEX(hwicap_mutex
);
115 static bool probed_devices
[HWICAP_DEVICES
];
116 static struct mutex icap_sem
;
118 static struct class *icap_class
;
120 #define UNIMPLEMENTED 0xFFFF
122 static const struct config_registers v2_config_registers
= {
138 .AXSS
= UNIMPLEMENTED
,
139 .C0R_1
= UNIMPLEMENTED
,
140 .CSOB
= UNIMPLEMENTED
,
141 .WBSTAR
= UNIMPLEMENTED
,
142 .TIMER
= UNIMPLEMENTED
,
143 .BOOTSTS
= UNIMPLEMENTED
,
144 .CTL_1
= UNIMPLEMENTED
,
147 static const struct config_registers v4_config_registers
= {
159 .FLR
= UNIMPLEMENTED
,
160 .KEY
= UNIMPLEMENTED
,
164 .C0R_1
= UNIMPLEMENTED
,
165 .CSOB
= UNIMPLEMENTED
,
166 .WBSTAR
= UNIMPLEMENTED
,
167 .TIMER
= UNIMPLEMENTED
,
168 .BOOTSTS
= UNIMPLEMENTED
,
169 .CTL_1
= UNIMPLEMENTED
,
171 static const struct config_registers v5_config_registers
= {
183 .FLR
= UNIMPLEMENTED
,
184 .KEY
= UNIMPLEMENTED
,
197 * hwicap_command_desync - Send a DESYNC command to the ICAP port.
198 * @drvdata: a pointer to the drvdata.
200 * This command desynchronizes the ICAP After this command, a
201 * bitstream containing a NULL packet, followed by a SYNCH packet is
202 * required before the ICAP will recognize commands.
204 static int hwicap_command_desync(struct hwicap_drvdata
*drvdata
)
210 * Create the data to be written to the ICAP.
212 buffer
[index
++] = hwicap_type_1_write(drvdata
->config_regs
->CMD
) | 1;
213 buffer
[index
++] = XHI_CMD_DESYNCH
;
214 buffer
[index
++] = XHI_NOOP_PACKET
;
215 buffer
[index
++] = XHI_NOOP_PACKET
;
218 * Write the data to the FIFO and intiate the transfer of data present
219 * in the FIFO to the ICAP device.
221 return drvdata
->config
->set_configuration(drvdata
,
226 * hwicap_get_configuration_register - Query a configuration register.
227 * @drvdata: a pointer to the drvdata.
228 * @reg: a constant which represents the configuration
229 * register value to be returned.
230 * Examples: XHI_IDCODE, XHI_FLR.
231 * @reg_data: returns the value of the register.
233 * Sends a query packet to the ICAP and then receives the response.
234 * The icap is left in Synched state.
236 static int hwicap_get_configuration_register(struct hwicap_drvdata
*drvdata
,
237 u32 reg
, u32
*reg_data
)
244 * Create the data to be written to the ICAP.
246 buffer
[index
++] = XHI_DUMMY_PACKET
;
247 buffer
[index
++] = XHI_NOOP_PACKET
;
248 buffer
[index
++] = XHI_SYNC_PACKET
;
249 buffer
[index
++] = XHI_NOOP_PACKET
;
250 buffer
[index
++] = XHI_NOOP_PACKET
;
253 * Write the data to the FIFO and initiate the transfer of data present
254 * in the FIFO to the ICAP device.
256 status
= drvdata
->config
->set_configuration(drvdata
,
261 /* If the syncword was not found, then we need to start over. */
262 status
= drvdata
->config
->get_status(drvdata
);
263 if ((status
& XHI_SR_DALIGN_MASK
) != XHI_SR_DALIGN_MASK
)
267 buffer
[index
++] = hwicap_type_1_read(reg
) | 1;
268 buffer
[index
++] = XHI_NOOP_PACKET
;
269 buffer
[index
++] = XHI_NOOP_PACKET
;
272 * Write the data to the FIFO and intiate the transfer of data present
273 * in the FIFO to the ICAP device.
275 status
= drvdata
->config
->set_configuration(drvdata
,
281 * Read the configuration register
283 status
= drvdata
->config
->get_configuration(drvdata
, reg_data
, 1);
290 static int hwicap_initialize_hwicap(struct hwicap_drvdata
*drvdata
)
295 dev_dbg(drvdata
->dev
, "initializing\n");
297 /* Abort any current transaction, to make sure we have the
298 * ICAP in a good state. */
299 dev_dbg(drvdata
->dev
, "Reset...\n");
300 drvdata
->config
->reset(drvdata
);
302 dev_dbg(drvdata
->dev
, "Desync...\n");
303 status
= hwicap_command_desync(drvdata
);
307 /* Attempt to read the IDCODE from ICAP. This
308 * may not be returned correctly, due to the design of the
311 dev_dbg(drvdata
->dev
, "Reading IDCODE...\n");
312 status
= hwicap_get_configuration_register(
313 drvdata
, drvdata
->config_regs
->IDCODE
, &idcode
);
314 dev_dbg(drvdata
->dev
, "IDCODE = %x\n", idcode
);
318 dev_dbg(drvdata
->dev
, "Desync...\n");
319 status
= hwicap_command_desync(drvdata
);
327 hwicap_read(struct file
*file
, char __user
*buf
, size_t count
, loff_t
*ppos
)
329 struct hwicap_drvdata
*drvdata
= file
->private_data
;
330 ssize_t bytes_to_read
= 0;
336 status
= mutex_lock_interruptible(&drvdata
->sem
);
340 if (drvdata
->read_buffer_in_use
) {
341 /* If there are leftover bytes in the buffer, just */
342 /* return them and don't try to read more from the */
345 (count
< drvdata
->read_buffer_in_use
) ? count
:
346 drvdata
->read_buffer_in_use
;
348 /* Return the data currently in the read buffer. */
349 if (copy_to_user(buf
, drvdata
->read_buffer
, bytes_to_read
)) {
353 drvdata
->read_buffer_in_use
-= bytes_to_read
;
354 memmove(drvdata
->read_buffer
,
355 drvdata
->read_buffer
+ bytes_to_read
,
358 /* Get new data from the ICAP, and return was was requested. */
359 kbuf
= (u32
*) get_zeroed_page(GFP_KERNEL
);
365 /* The ICAP device is only able to read complete */
366 /* words. If a number of bytes that do not correspond */
367 /* to complete words is requested, then we read enough */
368 /* words to get the required number of bytes, and then */
369 /* save the remaining bytes for the next read. */
371 /* Determine the number of words to read, rounding up */
373 words
= ((count
+ 3) >> 2);
374 bytes_to_read
= words
<< 2;
376 if (bytes_to_read
> PAGE_SIZE
)
377 bytes_to_read
= PAGE_SIZE
;
379 /* Ensure we only read a complete number of words. */
380 bytes_remaining
= bytes_to_read
& 3;
382 words
= bytes_to_read
>> 2;
384 status
= drvdata
->config
->get_configuration(drvdata
,
387 /* If we didn't read correctly, then bail out. */
389 free_page((unsigned long)kbuf
);
393 /* If we fail to return the data to the user, then bail out. */
394 if (copy_to_user(buf
, kbuf
, bytes_to_read
)) {
395 free_page((unsigned long)kbuf
);
399 memcpy(drvdata
->read_buffer
,
402 drvdata
->read_buffer_in_use
= bytes_remaining
;
403 free_page((unsigned long)kbuf
);
405 status
= bytes_to_read
;
407 mutex_unlock(&drvdata
->sem
);
412 hwicap_write(struct file
*file
, const char __user
*buf
,
413 size_t count
, loff_t
*ppos
)
415 struct hwicap_drvdata
*drvdata
= file
->private_data
;
417 ssize_t left
= count
;
422 status
= mutex_lock_interruptible(&drvdata
->sem
);
426 left
+= drvdata
->write_buffer_in_use
;
428 /* Only write multiples of 4 bytes. */
434 kbuf
= (u32
*) __get_free_page(GFP_KERNEL
);
441 /* only write multiples of 4 bytes, so there might */
442 /* be as many as 3 bytes left (at the end). */
449 if (drvdata
->write_buffer_in_use
) {
450 memcpy(kbuf
, drvdata
->write_buffer
,
451 drvdata
->write_buffer_in_use
);
453 (((char *)kbuf
) + drvdata
->write_buffer_in_use
),
455 len
- (drvdata
->write_buffer_in_use
))) {
456 free_page((unsigned long)kbuf
);
461 if (copy_from_user(kbuf
, buf
+ written
, len
)) {
462 free_page((unsigned long)kbuf
);
468 status
= drvdata
->config
->set_configuration(drvdata
,
472 free_page((unsigned long)kbuf
);
476 if (drvdata
->write_buffer_in_use
) {
477 len
-= drvdata
->write_buffer_in_use
;
478 left
-= drvdata
->write_buffer_in_use
;
479 drvdata
->write_buffer_in_use
= 0;
484 if ((left
> 0) && (left
< 4)) {
485 if (!copy_from_user(drvdata
->write_buffer
,
486 buf
+ written
, left
)) {
487 drvdata
->write_buffer_in_use
= left
;
493 free_page((unsigned long)kbuf
);
496 mutex_unlock(&drvdata
->sem
);
500 static int hwicap_open(struct inode
*inode
, struct file
*file
)
502 struct hwicap_drvdata
*drvdata
;
505 mutex_lock(&hwicap_mutex
);
506 drvdata
= container_of(inode
->i_cdev
, struct hwicap_drvdata
, cdev
);
508 status
= mutex_lock_interruptible(&drvdata
->sem
);
512 if (drvdata
->is_open
) {
517 status
= hwicap_initialize_hwicap(drvdata
);
519 dev_err(drvdata
->dev
, "Failed to open file");
523 file
->private_data
= drvdata
;
524 drvdata
->write_buffer_in_use
= 0;
525 drvdata
->read_buffer_in_use
= 0;
526 drvdata
->is_open
= 1;
529 mutex_unlock(&drvdata
->sem
);
531 mutex_unlock(&hwicap_mutex
);
535 static int hwicap_release(struct inode
*inode
, struct file
*file
)
537 struct hwicap_drvdata
*drvdata
= file
->private_data
;
541 mutex_lock(&drvdata
->sem
);
543 if (drvdata
->write_buffer_in_use
) {
544 /* Flush write buffer. */
545 for (i
= drvdata
->write_buffer_in_use
; i
< 4; i
++)
546 drvdata
->write_buffer
[i
] = 0;
548 status
= drvdata
->config
->set_configuration(drvdata
,
549 (u32
*) drvdata
->write_buffer
, 1);
554 status
= hwicap_command_desync(drvdata
);
559 drvdata
->is_open
= 0;
560 mutex_unlock(&drvdata
->sem
);
564 static const struct file_operations hwicap_fops
= {
565 .owner
= THIS_MODULE
,
566 .write
= hwicap_write
,
569 .release
= hwicap_release
,
570 .llseek
= noop_llseek
,
573 static int __devinit
hwicap_setup(struct device
*dev
, int id
,
574 const struct resource
*regs_res
,
575 const struct hwicap_driver_config
*config
,
576 const struct config_registers
*config_regs
)
579 struct hwicap_drvdata
*drvdata
= NULL
;
582 dev_info(dev
, "Xilinx icap port driver\n");
584 mutex_lock(&icap_sem
);
587 for (id
= 0; id
< HWICAP_DEVICES
; id
++)
588 if (!probed_devices
[id
])
591 if (id
< 0 || id
>= HWICAP_DEVICES
) {
592 mutex_unlock(&icap_sem
);
593 dev_err(dev
, "%s%i too large\n", DRIVER_NAME
, id
);
596 if (probed_devices
[id
]) {
597 mutex_unlock(&icap_sem
);
598 dev_err(dev
, "cannot assign to %s%i; it is already in use\n",
603 probed_devices
[id
] = 1;
604 mutex_unlock(&icap_sem
);
606 devt
= MKDEV(XHWICAP_MAJOR
, XHWICAP_MINOR
+ id
);
608 drvdata
= kzalloc(sizeof(struct hwicap_drvdata
), GFP_KERNEL
);
610 dev_err(dev
, "Couldn't allocate device private record\n");
614 dev_set_drvdata(dev
, (void *)drvdata
);
617 dev_err(dev
, "Couldn't get registers resource\n");
622 drvdata
->mem_start
= regs_res
->start
;
623 drvdata
->mem_end
= regs_res
->end
;
624 drvdata
->mem_size
= resource_size(regs_res
);
626 if (!request_mem_region(drvdata
->mem_start
,
627 drvdata
->mem_size
, DRIVER_NAME
)) {
628 dev_err(dev
, "Couldn't lock memory region at %Lx\n",
629 (unsigned long long) regs_res
->start
);
634 drvdata
->devt
= devt
;
636 drvdata
->base_address
= ioremap(drvdata
->mem_start
, drvdata
->mem_size
);
637 if (!drvdata
->base_address
) {
638 dev_err(dev
, "ioremap() failed\n");
642 drvdata
->config
= config
;
643 drvdata
->config_regs
= config_regs
;
645 mutex_init(&drvdata
->sem
);
646 drvdata
->is_open
= 0;
648 dev_info(dev
, "ioremap %llx to %p with size %llx\n",
649 (unsigned long long) drvdata
->mem_start
,
650 drvdata
->base_address
,
651 (unsigned long long) drvdata
->mem_size
);
653 cdev_init(&drvdata
->cdev
, &hwicap_fops
);
654 drvdata
->cdev
.owner
= THIS_MODULE
;
655 retval
= cdev_add(&drvdata
->cdev
, devt
, 1);
657 dev_err(dev
, "cdev_add() failed\n");
661 device_create(icap_class
, dev
, devt
, NULL
, "%s%d", DRIVER_NAME
, id
);
662 return 0; /* success */
665 iounmap(drvdata
->base_address
);
668 release_mem_region(regs_res
->start
, drvdata
->mem_size
);
674 mutex_lock(&icap_sem
);
675 probed_devices
[id
] = 0;
676 mutex_unlock(&icap_sem
);
681 static struct hwicap_driver_config buffer_icap_config
= {
682 .get_configuration
= buffer_icap_get_configuration
,
683 .set_configuration
= buffer_icap_set_configuration
,
684 .get_status
= buffer_icap_get_status
,
685 .reset
= buffer_icap_reset
,
688 static struct hwicap_driver_config fifo_icap_config
= {
689 .get_configuration
= fifo_icap_get_configuration
,
690 .set_configuration
= fifo_icap_set_configuration
,
691 .get_status
= fifo_icap_get_status
,
692 .reset
= fifo_icap_reset
,
695 static int __devexit
hwicap_remove(struct device
*dev
)
697 struct hwicap_drvdata
*drvdata
;
699 drvdata
= (struct hwicap_drvdata
*)dev_get_drvdata(dev
);
704 device_destroy(icap_class
, drvdata
->devt
);
705 cdev_del(&drvdata
->cdev
);
706 iounmap(drvdata
->base_address
);
707 release_mem_region(drvdata
->mem_start
, drvdata
->mem_size
);
709 dev_set_drvdata(dev
, NULL
);
711 mutex_lock(&icap_sem
);
712 probed_devices
[MINOR(dev
->devt
)-XHWICAP_MINOR
] = 0;
713 mutex_unlock(&icap_sem
);
714 return 0; /* success */
718 static int __devinit
hwicap_of_probe(struct platform_device
*op
,
719 const struct hwicap_driver_config
*config
)
722 const unsigned int *id
;
725 const struct config_registers
*regs
;
728 rc
= of_address_to_resource(op
->dev
.of_node
, 0, &res
);
730 dev_err(&op
->dev
, "invalid address\n");
734 id
= of_get_property(op
->dev
.of_node
, "port-number", NULL
);
736 /* It's most likely that we're using V4, if the family is not
738 regs
= &v4_config_registers
;
739 family
= of_get_property(op
->dev
.of_node
, "xlnx,family", NULL
);
742 if (!strcmp(family
, "virtex2p")) {
743 regs
= &v2_config_registers
;
744 } else if (!strcmp(family
, "virtex4")) {
745 regs
= &v4_config_registers
;
746 } else if (!strcmp(family
, "virtex5")) {
747 regs
= &v5_config_registers
;
750 return hwicap_setup(&op
->dev
, id
? *id
: -1, &res
, config
,
754 static inline int hwicap_of_probe(struct platform_device
*op
,
755 const struct hwicap_driver_config
*config
)
759 #endif /* CONFIG_OF */
761 static const struct of_device_id __devinitconst hwicap_of_match
[];
762 static int __devinit
hwicap_drv_probe(struct platform_device
*pdev
)
764 const struct of_device_id
*match
;
765 struct resource
*res
;
766 const struct config_registers
*regs
;
769 match
= of_match_device(hwicap_of_match
, &pdev
->dev
);
771 return hwicap_of_probe(pdev
, match
->data
);
773 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
777 /* It's most likely that we're using V4, if the family is not
779 regs
= &v4_config_registers
;
780 family
= pdev
->dev
.platform_data
;
783 if (!strcmp(family
, "virtex2p")) {
784 regs
= &v2_config_registers
;
785 } else if (!strcmp(family
, "virtex4")) {
786 regs
= &v4_config_registers
;
787 } else if (!strcmp(family
, "virtex5")) {
788 regs
= &v5_config_registers
;
792 return hwicap_setup(&pdev
->dev
, pdev
->id
, res
,
793 &buffer_icap_config
, regs
);
796 static int __devexit
hwicap_drv_remove(struct platform_device
*pdev
)
798 return hwicap_remove(&pdev
->dev
);
802 /* Match table for device tree binding */
803 static const struct of_device_id __devinitconst hwicap_of_match
[] = {
804 { .compatible
= "xlnx,opb-hwicap-1.00.b", .data
= &buffer_icap_config
},
805 { .compatible
= "xlnx,xps-hwicap-1.00.a", .data
= &fifo_icap_config
},
808 MODULE_DEVICE_TABLE(of
, hwicap_of_match
);
810 #define hwicap_of_match NULL
813 static struct platform_driver hwicap_platform_driver
= {
814 .probe
= hwicap_drv_probe
,
815 .remove
= hwicap_drv_remove
,
817 .owner
= THIS_MODULE
,
819 .of_match_table
= hwicap_of_match
,
823 static int __init
hwicap_module_init(void)
828 icap_class
= class_create(THIS_MODULE
, "xilinx_config");
829 mutex_init(&icap_sem
);
831 devt
= MKDEV(XHWICAP_MAJOR
, XHWICAP_MINOR
);
832 retval
= register_chrdev_region(devt
,
838 retval
= platform_driver_register(&hwicap_platform_driver
);
845 unregister_chrdev_region(devt
, HWICAP_DEVICES
);
850 static void __exit
hwicap_module_cleanup(void)
852 dev_t devt
= MKDEV(XHWICAP_MAJOR
, XHWICAP_MINOR
);
854 class_destroy(icap_class
);
856 platform_driver_unregister(&hwicap_platform_driver
);
858 unregister_chrdev_region(devt
, HWICAP_DEVICES
);
861 module_init(hwicap_module_init
);
862 module_exit(hwicap_module_cleanup
);
864 MODULE_AUTHOR("Xilinx, Inc; Xilinx Research Labs Group");
865 MODULE_DESCRIPTION("Xilinx ICAP Port Driver");
866 MODULE_LICENSE("GPL");