2 * nosy - Snoop mode driver for TI PCILynx 1394 controllers
3 * Copyright (C) 2002-2007 Kristian Høgsberg
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software Foundation,
17 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 #include <linux/errno.h>
22 #include <linux/init.h>
23 #include <linux/interrupt.h>
25 #include <linux/kernel.h>
26 #include <linux/kref.h>
27 #include <linux/miscdevice.h>
28 #include <linux/module.h>
29 #include <linux/mutex.h>
30 #include <linux/pci.h>
31 #include <linux/poll.h>
32 #include <linux/sched.h> /* required for linux/wait.h */
33 #include <linux/slab.h>
34 #include <linux/spinlock.h>
35 #include <linux/timex.h>
36 #include <linux/uaccess.h>
37 #include <linux/wait.h>
39 #include <asm/atomic.h>
40 #include <asm/byteorder.h>
43 #include "nosy-user.h"
45 #define TCODE_PHY_PACKET 0x10
46 #define PCI_DEVICE_ID_TI_PCILYNX 0x8000
48 #define notify(s, args...) printk(KERN_NOTICE s, ## args)
49 #define error(s, args...) printk(KERN_ERR s, ## args)
50 #define debug(s, args...) printk(KERN_DEBUG s, ## args)
52 static char driver_name[] = KBUILD_MODNAME;
54 /* this is the physical layout of a PCL, its size is 128 bytes */
57 __le32 async_error_next;
60 __le32 remaining_transfer_count;
61 __le32 next_data_buffer;
73 struct packet_buffer {
76 long total_packet_count, lost_packet_count;
78 struct packet *head, *tail;
79 wait_queue_head_t wait;
83 struct pci_dev *pci_device;
84 __iomem char *registers;
86 struct pcl *rcv_start_pcl, *rcv_pcl;
89 dma_addr_t rcv_start_pcl_bus, rcv_pcl_bus, rcv_buffer_bus;
91 spinlock_t client_list_lock;
92 struct list_head client_list;
94 struct miscdevice misc;
95 struct list_head link;
99 static inline struct pcilynx *
100 lynx_get(struct pcilynx *lynx)
102 kref_get(&lynx->kref);
108 lynx_release(struct kref *kref)
110 kfree(container_of(kref, struct pcilynx, kref));
114 lynx_put(struct pcilynx *lynx)
116 kref_put(&lynx->kref, lynx_release);
120 struct pcilynx *lynx;
122 struct packet_buffer buffer;
123 struct list_head link;
126 static DEFINE_MUTEX(card_mutex);
127 static LIST_HEAD(card_list);
130 packet_buffer_init(struct packet_buffer *buffer, size_t capacity)
132 buffer->data = kmalloc(capacity, GFP_KERNEL);
133 if (buffer->data == NULL)
135 buffer->head = (struct packet *) buffer->data;
136 buffer->tail = (struct packet *) buffer->data;
137 buffer->capacity = capacity;
138 buffer->lost_packet_count = 0;
139 atomic_set(&buffer->size, 0);
140 init_waitqueue_head(&buffer->wait);
146 packet_buffer_destroy(struct packet_buffer *buffer)
152 packet_buffer_get(struct client *client, char __user *data, size_t user_length)
154 struct packet_buffer *buffer = &client->buffer;
158 if (wait_event_interruptible(buffer->wait,
159 atomic_read(&buffer->size) > 0) ||
160 list_empty(&client->lynx->link))
163 if (atomic_read(&buffer->size) == 0)
166 /* FIXME: Check length <= user_length. */
168 end = buffer->data + buffer->capacity;
169 length = buffer->head->length;
171 if (&buffer->head->data[length] < end) {
172 if (copy_to_user(data, buffer->head->data, length))
174 buffer->head = (struct packet *) &buffer->head->data[length];
176 size_t split = end - buffer->head->data;
178 if (copy_to_user(data, buffer->head->data, split))
180 if (copy_to_user(data + split, buffer->data, length - split))
182 buffer->head = (struct packet *) &buffer->data[length - split];
186 * Decrease buffer->size as the last thing, since this is what
187 * keeps the interrupt from overwriting the packet we are
188 * retrieving from the buffer.
190 atomic_sub(sizeof(struct packet) + length, &buffer->size);
196 packet_buffer_put(struct packet_buffer *buffer, void *data, size_t length)
200 buffer->total_packet_count++;
202 if (buffer->capacity <
203 atomic_read(&buffer->size) + sizeof(struct packet) + length) {
204 buffer->lost_packet_count++;
208 end = buffer->data + buffer->capacity;
209 buffer->tail->length = length;
211 if (&buffer->tail->data[length] < end) {
212 memcpy(buffer->tail->data, data, length);
213 buffer->tail = (struct packet *) &buffer->tail->data[length];
215 size_t split = end - buffer->tail->data;
217 memcpy(buffer->tail->data, data, split);
218 memcpy(buffer->data, data + split, length - split);
219 buffer->tail = (struct packet *) &buffer->data[length - split];
222 /* Finally, adjust buffer size and wake up userspace reader. */
224 atomic_add(sizeof(struct packet) + length, &buffer->size);
225 wake_up_interruptible(&buffer->wait);
229 reg_write(struct pcilynx *lynx, int offset, u32 data)
231 writel(data, lynx->registers + offset);
235 reg_read(struct pcilynx *lynx, int offset)
237 return readl(lynx->registers + offset);
241 reg_set_bits(struct pcilynx *lynx, int offset, u32 mask)
243 reg_write(lynx, offset, (reg_read(lynx, offset) | mask));
247 * Maybe the pcl programs could be set up to just append data instead
248 * of using a whole packet.
251 run_pcl(struct pcilynx *lynx, dma_addr_t pcl_bus,
254 reg_write(lynx, DMA0_CURRENT_PCL + dmachan * 0x20, pcl_bus);
255 reg_write(lynx, DMA0_CHAN_CTRL + dmachan * 0x20,
256 DMA_CHAN_CTRL_ENABLE | DMA_CHAN_CTRL_LINK);
260 set_phy_reg(struct pcilynx *lynx, int addr, int val)
263 debug("PHY register address %d out of range\n", addr);
268 debug("PHY register value %d out of range\n", val);
272 reg_write(lynx, LINK_PHY, LINK_PHY_WRITE |
273 LINK_PHY_ADDR(addr) | LINK_PHY_WDATA(val));
279 nosy_open(struct inode *inode, struct file *file)
281 int minor = iminor(inode);
282 struct client *client;
283 struct pcilynx *tmp, *lynx = NULL;
285 mutex_lock(&card_mutex);
286 list_for_each_entry(tmp, &card_list, link)
287 if (tmp->misc.minor == minor) {
288 lynx = lynx_get(tmp);
291 mutex_unlock(&card_mutex);
295 client = kmalloc(sizeof *client, GFP_KERNEL);
299 client->tcode_mask = ~0;
301 INIT_LIST_HEAD(&client->link);
303 if (packet_buffer_init(&client->buffer, 128 * 1024) < 0)
306 file->private_data = client;
317 nosy_release(struct inode *inode, struct file *file)
319 struct client *client = file->private_data;
320 struct pcilynx *lynx = client->lynx;
322 spin_lock_irq(&lynx->client_list_lock);
323 list_del_init(&client->link);
324 spin_unlock_irq(&lynx->client_list_lock);
326 packet_buffer_destroy(&client->buffer);
334 nosy_poll(struct file *file, poll_table *pt)
336 struct client *client = file->private_data;
337 unsigned int ret = 0;
339 poll_wait(file, &client->buffer.wait, pt);
341 if (atomic_read(&client->buffer.size) > 0)
342 ret = POLLIN | POLLRDNORM;
344 if (list_empty(&client->lynx->link))
351 nosy_read(struct file *file, char __user *buffer, size_t count, loff_t *offset)
353 struct client *client = file->private_data;
355 return packet_buffer_get(client, buffer, count);
359 nosy_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
361 struct client *client = file->private_data;
362 spinlock_t *client_list_lock = &client->lynx->client_list_lock;
363 struct nosy_stats stats;
366 case NOSY_IOC_GET_STATS:
367 spin_lock_irq(client_list_lock);
368 stats.total_packet_count = client->buffer.total_packet_count;
369 stats.lost_packet_count = client->buffer.lost_packet_count;
370 spin_unlock_irq(client_list_lock);
372 if (copy_to_user((void __user *) arg, &stats, sizeof stats))
378 spin_lock_irq(client_list_lock);
379 list_add_tail(&client->link, &client->lynx->client_list);
380 spin_unlock_irq(client_list_lock);
385 spin_lock_irq(client_list_lock);
386 list_del_init(&client->link);
387 spin_unlock_irq(client_list_lock);
391 case NOSY_IOC_FILTER:
392 spin_lock_irq(client_list_lock);
393 client->tcode_mask = arg;
394 spin_unlock_irq(client_list_lock);
400 /* Flush buffer, configure filter. */
404 static const struct file_operations nosy_ops = {
405 .owner = THIS_MODULE,
407 .unlocked_ioctl = nosy_ioctl,
410 .release = nosy_release,
413 #define PHY_PACKET_SIZE 12 /* 1 payload, 1 inverse, 1 ack = 3 quadlets */
416 packet_irq_handler(struct pcilynx *lynx)
418 struct client *client;
419 u32 tcode_mask, tcode;
423 /* FIXME: Also report rcv_speed. */
425 length = __le32_to_cpu(lynx->rcv_pcl->pcl_status) & 0x00001fff;
426 tcode = __le32_to_cpu(lynx->rcv_buffer[1]) >> 4 & 0xf;
428 do_gettimeofday(&tv);
429 lynx->rcv_buffer[0] = (__force __le32)tv.tv_usec;
431 if (length == PHY_PACKET_SIZE)
432 tcode_mask = 1 << TCODE_PHY_PACKET;
434 tcode_mask = 1 << tcode;
436 spin_lock(&lynx->client_list_lock);
438 list_for_each_entry(client, &lynx->client_list, link)
439 if (client->tcode_mask & tcode_mask)
440 packet_buffer_put(&client->buffer,
441 lynx->rcv_buffer, length + 4);
443 spin_unlock(&lynx->client_list_lock);
447 bus_reset_irq_handler(struct pcilynx *lynx)
449 struct client *client;
452 do_gettimeofday(&tv);
454 spin_lock(&lynx->client_list_lock);
456 list_for_each_entry(client, &lynx->client_list, link)
457 packet_buffer_put(&client->buffer, &tv.tv_usec, 4);
459 spin_unlock(&lynx->client_list_lock);
463 irq_handler(int irq, void *device)
465 struct pcilynx *lynx = device;
468 pci_int_status = reg_read(lynx, PCI_INT_STATUS);
470 if (pci_int_status == ~0)
471 /* Card was ejected. */
474 if ((pci_int_status & PCI_INT_INT_PEND) == 0)
475 /* Not our interrupt, bail out quickly. */
478 if ((pci_int_status & PCI_INT_P1394_INT) != 0) {
481 link_int_status = reg_read(lynx, LINK_INT_STATUS);
482 reg_write(lynx, LINK_INT_STATUS, link_int_status);
484 if ((link_int_status & LINK_INT_PHY_BUSRESET) > 0)
485 bus_reset_irq_handler(lynx);
488 /* Clear the PCI_INT_STATUS register only after clearing the
489 * LINK_INT_STATUS register; otherwise the PCI_INT_P1394 will
490 * be set again immediately. */
492 reg_write(lynx, PCI_INT_STATUS, pci_int_status);
494 if ((pci_int_status & PCI_INT_DMA0_HLT) > 0) {
495 packet_irq_handler(lynx);
496 run_pcl(lynx, lynx->rcv_start_pcl_bus, 0);
503 remove_card(struct pci_dev *dev)
505 struct pcilynx *lynx = pci_get_drvdata(dev);
506 struct client *client;
508 mutex_lock(&card_mutex);
509 list_del_init(&lynx->link);
510 misc_deregister(&lynx->misc);
511 mutex_unlock(&card_mutex);
513 reg_write(lynx, PCI_INT_ENABLE, 0);
514 free_irq(lynx->pci_device->irq, lynx);
516 spin_lock_irq(&lynx->client_list_lock);
517 list_for_each_entry(client, &lynx->client_list, link)
518 wake_up_interruptible(&client->buffer.wait);
519 spin_unlock_irq(&lynx->client_list_lock);
521 pci_free_consistent(lynx->pci_device, sizeof(struct pcl),
522 lynx->rcv_start_pcl, lynx->rcv_start_pcl_bus);
523 pci_free_consistent(lynx->pci_device, sizeof(struct pcl),
524 lynx->rcv_pcl, lynx->rcv_pcl_bus);
525 pci_free_consistent(lynx->pci_device, PAGE_SIZE,
526 lynx->rcv_buffer, lynx->rcv_buffer_bus);
528 iounmap(lynx->registers);
529 pci_disable_device(dev);
533 #define RCV_BUFFER_SIZE (16 * 1024)
536 add_card(struct pci_dev *dev, const struct pci_device_id *unused)
538 struct pcilynx *lynx;
542 if (pci_set_dma_mask(dev, 0xffffffff)) {
543 error("DMA address limits not supported "
544 "for PCILynx hardware\n");
547 if (pci_enable_device(dev)) {
548 error("Failed to enable PCILynx hardware\n");
553 lynx = kzalloc(sizeof *lynx, GFP_KERNEL);
555 error("Failed to allocate control structure memory\n");
559 lynx->pci_device = dev;
560 pci_set_drvdata(dev, lynx);
562 spin_lock_init(&lynx->client_list_lock);
563 INIT_LIST_HEAD(&lynx->client_list);
564 kref_init(&lynx->kref);
566 lynx->registers = ioremap_nocache(pci_resource_start(dev, 0),
567 PCILYNX_MAX_REGISTER);
569 lynx->rcv_start_pcl = pci_alloc_consistent(lynx->pci_device,
570 sizeof(struct pcl), &lynx->rcv_start_pcl_bus);
571 lynx->rcv_pcl = pci_alloc_consistent(lynx->pci_device,
572 sizeof(struct pcl), &lynx->rcv_pcl_bus);
573 lynx->rcv_buffer = pci_alloc_consistent(lynx->pci_device,
574 RCV_BUFFER_SIZE, &lynx->rcv_buffer_bus);
575 if (lynx->rcv_start_pcl == NULL ||
576 lynx->rcv_pcl == NULL ||
577 lynx->rcv_buffer == NULL) {
578 error("Failed to allocate receive buffer\n");
580 goto fail_deallocate;
582 lynx->rcv_start_pcl->next = cpu_to_le32(lynx->rcv_pcl_bus);
583 lynx->rcv_pcl->next = cpu_to_le32(PCL_NEXT_INVALID);
584 lynx->rcv_pcl->async_error_next = cpu_to_le32(PCL_NEXT_INVALID);
586 lynx->rcv_pcl->buffer[0].control =
587 cpu_to_le32(PCL_CMD_RCV | PCL_BIGENDIAN | 2044);
588 lynx->rcv_pcl->buffer[0].pointer =
589 cpu_to_le32(lynx->rcv_buffer_bus + 4);
590 p = lynx->rcv_buffer_bus + 2048;
591 end = lynx->rcv_buffer_bus + RCV_BUFFER_SIZE;
592 for (i = 1; p < end; i++, p += 2048) {
593 lynx->rcv_pcl->buffer[i].control =
594 cpu_to_le32(PCL_CMD_RCV | PCL_BIGENDIAN | 2048);
595 lynx->rcv_pcl->buffer[i].pointer = cpu_to_le32(p);
597 lynx->rcv_pcl->buffer[i - 1].control |= cpu_to_le32(PCL_LAST_BUFF);
599 reg_set_bits(lynx, MISC_CONTROL, MISC_CONTROL_SWRESET);
600 /* Fix buggy cards with autoboot pin not tied low: */
601 reg_write(lynx, DMA0_CHAN_CTRL, 0);
602 reg_write(lynx, DMA_GLOBAL_REGISTER, 0x00 << 24);
605 /* now, looking for PHY register set */
606 if ((get_phy_reg(lynx, 2) & 0xe0) == 0xe0) {
607 lynx->phyic.reg_1394a = 1;
608 PRINT(KERN_INFO, lynx->id,
609 "found 1394a conform PHY (using extended register set)");
610 lynx->phyic.vendor = get_phy_vendorid(lynx);
611 lynx->phyic.product = get_phy_productid(lynx);
613 lynx->phyic.reg_1394a = 0;
614 PRINT(KERN_INFO, lynx->id, "found old 1394 PHY");
618 /* Setup the general receive FIFO max size. */
619 reg_write(lynx, FIFO_SIZES, 255);
621 reg_set_bits(lynx, PCI_INT_ENABLE, PCI_INT_DMA_ALL);
623 reg_write(lynx, LINK_INT_ENABLE,
624 LINK_INT_PHY_TIME_OUT | LINK_INT_PHY_REG_RCVD |
625 LINK_INT_PHY_BUSRESET | LINK_INT_IT_STUCK |
626 LINK_INT_AT_STUCK | LINK_INT_SNTRJ |
627 LINK_INT_TC_ERR | LINK_INT_GRF_OVER_FLOW |
628 LINK_INT_ITF_UNDER_FLOW | LINK_INT_ATF_UNDER_FLOW);
630 /* Disable the L flag in self ID packets. */
631 set_phy_reg(lynx, 4, 0);
633 /* Put this baby into snoop mode */
634 reg_set_bits(lynx, LINK_CONTROL, LINK_CONTROL_SNOOP_ENABLE);
636 run_pcl(lynx, lynx->rcv_start_pcl_bus, 0);
638 if (request_irq(dev->irq, irq_handler, IRQF_SHARED,
639 driver_name, lynx)) {
640 error("Failed to allocate shared interrupt %d\n", dev->irq);
642 goto fail_deallocate;
645 lynx->misc.parent = &dev->dev;
646 lynx->misc.minor = MISC_DYNAMIC_MINOR;
647 lynx->misc.name = "nosy";
648 lynx->misc.fops = &nosy_ops;
650 mutex_lock(&card_mutex);
651 ret = misc_register(&lynx->misc);
653 error("Failed to register misc char device\n");
654 mutex_unlock(&card_mutex);
657 list_add_tail(&lynx->link, &card_list);
658 mutex_unlock(&card_mutex);
660 notify("Initialized PCILynx IEEE1394 card, irq=%d\n", dev->irq);
665 reg_write(lynx, PCI_INT_ENABLE, 0);
666 free_irq(lynx->pci_device->irq, lynx);
669 if (lynx->rcv_start_pcl)
670 pci_free_consistent(lynx->pci_device, sizeof(struct pcl),
671 lynx->rcv_start_pcl, lynx->rcv_start_pcl_bus);
673 pci_free_consistent(lynx->pci_device, sizeof(struct pcl),
674 lynx->rcv_pcl, lynx->rcv_pcl_bus);
675 if (lynx->rcv_buffer)
676 pci_free_consistent(lynx->pci_device, PAGE_SIZE,
677 lynx->rcv_buffer, lynx->rcv_buffer_bus);
678 iounmap(lynx->registers);
682 pci_disable_device(dev);
687 static struct pci_device_id pci_table[] __devinitdata = {
689 .vendor = PCI_VENDOR_ID_TI,
690 .device = PCI_DEVICE_ID_TI_PCILYNX,
691 .subvendor = PCI_ANY_ID,
692 .subdevice = PCI_ANY_ID,
694 { } /* Terminating entry */
697 static struct pci_driver lynx_pci_driver = {
699 .id_table = pci_table,
701 .remove = remove_card,
704 MODULE_AUTHOR("Kristian Hoegsberg");
705 MODULE_DESCRIPTION("Snoop mode driver for TI pcilynx 1394 controllers");
706 MODULE_LICENSE("GPL");
707 MODULE_DEVICE_TABLE(pci, pci_table);
709 static int __init nosy_init(void)
711 return pci_register_driver(&lynx_pci_driver);
714 static void __exit nosy_cleanup(void)
716 pci_unregister_driver(&lynx_pci_driver);
718 notify("Unloaded %s.\n", driver_name);
721 module_init(nosy_init);
722 module_exit(nosy_cleanup);