firewire: nosy: misc cleanups
[linux-2.6.git] / drivers / firewire / nosy.c
1 /*
2  * nosy - Snoop mode driver for TI PCILynx 1394 controllers
3  * Copyright (C) 2002-2007 Kristian Høgsberg
4  *
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.
9  *
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.
14  *
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.
18  */
19
20 #include <linux/errno.h>
21 #include <linux/fs.h>
22 #include <linux/init.h>
23 #include <linux/interrupt.h>
24 #include <linux/io.h>
25 #include <linux/kernel.h>
26 #include <linux/miscdevice.h>
27 #include <linux/module.h>
28 #include <linux/pci.h>
29 #include <linux/poll.h>
30 #include <linux/sched.h> /* required for linux/wait.h */
31 #include <linux/slab.h>
32 #include <linux/spinlock.h>
33 #include <linux/timex.h>
34 #include <linux/uaccess.h>
35 #include <linux/wait.h>
36
37 #include <asm/atomic.h>
38 #include <asm/byteorder.h>
39
40 #include "nosy.h"
41 #include "nosy-user.h"
42
43 #define TCODE_PHY_PACKET                0x10
44 #define PCI_DEVICE_ID_TI_PCILYNX        0x8000
45
46 #define notify(s, args...) printk(KERN_NOTICE s, ## args)
47 #define error(s, args...) printk(KERN_ERR s, ## args)
48 #define debug(s, args...) printk(KERN_DEBUG s, ## args)
49
50 static char driver_name[] = KBUILD_MODNAME;
51
52 struct pcl_status {
53         unsigned int transfer_count : 13;
54         unsigned int reserved0 : 1;
55         unsigned int ack_type : 1;
56         unsigned int ack : 4;
57         unsigned int rcv_speed : 2;
58         unsigned int rcv_dma_channel : 6;
59         unsigned int packet_complete : 1;
60         unsigned int packet_error : 1;
61         unsigned int master_error : 1;
62         unsigned int iso_mode : 1;
63         unsigned int self_id : 1;
64 };
65
66 /* this is the physical layout of a PCL, its size is 128 bytes */
67 struct pcl {
68         u32 next;
69         u32 async_error_next;
70         u32 user_data;
71         struct pcl_status pcl_status;
72         u32 remaining_transfer_count;
73         u32 next_data_buffer;
74         struct {
75                 u32 control;
76                 u32 pointer;
77         } buffer[13] __attribute__ ((packed));
78 } __attribute__ ((packed));
79
80 struct packet {
81         unsigned int length;
82         char data[0];
83 };
84
85 struct packet_buffer {
86         char *data;
87         size_t capacity;
88         long total_packet_count, lost_packet_count;
89         atomic_t size;
90         struct packet *head, *tail;
91         wait_queue_head_t wait;
92 };
93
94 struct pcilynx {
95         struct pci_dev *pci_device;
96         unsigned char *registers;
97
98         struct pcl *rcv_start_pcl, *rcv_pcl;
99         u32 *rcv_buffer;
100
101         dma_addr_t rcv_start_pcl_bus, rcv_pcl_bus, rcv_buffer_bus;
102
103         spinlock_t client_list_lock;
104         struct list_head client_list;
105
106         struct miscdevice misc;
107 };
108
109 struct client {
110         struct pcilynx *lynx;
111         unsigned long tcode_mask;
112         struct packet_buffer buffer;
113         struct list_head link;
114 };
115
116 #define MAX_MINORS 64
117 static struct pcilynx *minors[MAX_MINORS];
118
119 static int
120 packet_buffer_init(struct packet_buffer *buffer, size_t capacity)
121 {
122         buffer->data = kmalloc(capacity, GFP_KERNEL);
123         if (buffer->data == NULL)
124                 return -ENOMEM;
125         buffer->head = (struct packet *) buffer->data;
126         buffer->tail = (struct packet *) buffer->data;
127         buffer->capacity = capacity;
128         buffer->lost_packet_count = 0;
129         atomic_set(&buffer->size, 0);
130         init_waitqueue_head(&buffer->wait);
131
132         return 0;
133 }
134
135 static void
136 packet_buffer_destroy(struct packet_buffer *buffer)
137 {
138         kfree(buffer->data);
139 }
140
141 static int
142 packet_buffer_get(struct packet_buffer *buffer, void *data, size_t user_length)
143 {
144         size_t length;
145         char *end;
146
147         if (wait_event_interruptible(buffer->wait,
148                                      atomic_read(&buffer->size) > 0))
149                 return -ERESTARTSYS;
150
151         /* FIXME: Check length <= user_length. */
152
153         end = buffer->data + buffer->capacity;
154         length = buffer->head->length;
155
156         if (&buffer->head->data[length] < end) {
157                 if (copy_to_user(data, buffer->head->data, length))
158                         return -EFAULT;
159                 buffer->head = (struct packet *) &buffer->head->data[length];
160         } else {
161                 size_t split = end - buffer->head->data;
162
163                 if (copy_to_user(data, buffer->head->data, split))
164                         return -EFAULT;
165                 if (copy_to_user(data + split, buffer->data, length - split))
166                         return -EFAULT;
167                 buffer->head = (struct packet *) &buffer->data[length - split];
168         }
169
170         /*
171          * Decrease buffer->size as the last thing, since this is what
172          * keeps the interrupt from overwriting the packet we are
173          * retrieving from the buffer.
174          */
175         atomic_sub(sizeof(struct packet) + length, &buffer->size);
176
177         return length;
178 }
179
180 static void
181 packet_buffer_put(struct packet_buffer *buffer, void *data, size_t length)
182 {
183         char *end;
184
185         buffer->total_packet_count++;
186
187         if (buffer->capacity <
188             atomic_read(&buffer->size) + sizeof(struct packet) + length) {
189                 buffer->lost_packet_count++;
190                 return;
191         }
192
193         end = buffer->data + buffer->capacity;
194         buffer->tail->length = length;
195
196         if (&buffer->tail->data[length] < end) {
197                 memcpy(buffer->tail->data, data, length);
198                 buffer->tail = (struct packet *) &buffer->tail->data[length];
199         } else {
200                 size_t split = end - buffer->tail->data;
201
202                 memcpy(buffer->tail->data, data, split);
203                 memcpy(buffer->data, data + split, length - split);
204                 buffer->tail = (struct packet *) &buffer->data[length - split];
205         }
206
207         /* Finally, adjust buffer size and wake up userspace reader. */
208
209         atomic_add(sizeof(struct packet) + length, &buffer->size);
210         wake_up_interruptible(&buffer->wait);
211 }
212
213 static inline void
214 reg_write(struct pcilynx *lynx, int offset, u32 data)
215 {
216         writel(data, lynx->registers + offset);
217 }
218
219 static inline u32
220 reg_read(struct pcilynx *lynx, int offset)
221 {
222         return readl(lynx->registers + offset);
223 }
224
225 static inline void
226 reg_set_bits(struct pcilynx *lynx, int offset, u32 mask)
227 {
228         reg_write(lynx, offset, (reg_read(lynx, offset) | mask));
229 }
230
231 /*
232  * Maybe the pcl programs could be set up to just append data instead
233  * of using a whole packet.
234  */
235 static inline void
236 run_pcl(struct pcilynx *lynx, dma_addr_t pcl_bus,
237                            int dmachan)
238 {
239         reg_write(lynx, DMA0_CURRENT_PCL + dmachan * 0x20, pcl_bus);
240         reg_write(lynx, DMA0_CHAN_CTRL + dmachan * 0x20,
241                   DMA_CHAN_CTRL_ENABLE | DMA_CHAN_CTRL_LINK);
242 }
243
244 static int
245 set_phy_reg(struct pcilynx *lynx, int addr, int val)
246 {
247         if (addr > 15) {
248                 debug("PHY register address %d out of range\n", addr);
249                 return -1;
250         }
251
252         if (val > 0xff) {
253                 debug("PHY register value %d out of range\n", val);
254                 return -1;
255         }
256
257         reg_write(lynx, LINK_PHY, LINK_PHY_WRITE |
258                   LINK_PHY_ADDR(addr) | LINK_PHY_WDATA(val));
259
260         return 0;
261 }
262
263 static void
264 nosy_start_snoop(struct client *client)
265 {
266         unsigned long flags;
267
268         spin_lock_irqsave(&client->lynx->client_list_lock, flags);
269         list_add_tail(&client->link, &client->lynx->client_list);
270         spin_unlock_irqrestore(&client->lynx->client_list_lock, flags);
271 }
272
273 static void
274 nosy_stop_snoop(struct client *client)
275 {
276         unsigned long flags;
277
278         spin_lock_irqsave(&client->lynx->client_list_lock, flags);
279         list_del(&client->link);
280         spin_unlock_irqrestore(&client->lynx->client_list_lock, flags);
281 }
282
283 static struct client *
284 nosy_add_client(struct pcilynx *lynx)
285 {
286         struct client *client;
287
288         client = kmalloc(sizeof *client, GFP_KERNEL);
289         client->tcode_mask = ~0;
290         client->lynx = lynx;
291         INIT_LIST_HEAD(&client->link);
292
293         if (packet_buffer_init(&client->buffer, 128 * 1024) < 0) {
294                 kfree(client);
295                 debug("Failed to allocate packet buffer\n");
296                 return NULL;
297         }
298
299         return client;
300 }
301
302 static void
303 nosy_remove_client(struct client *client)
304 {
305         nosy_stop_snoop(client);
306         packet_buffer_destroy(&client->buffer);
307         kfree(client);
308 }
309
310 static int
311 nosy_open(struct inode *inode, struct file *file)
312 {
313         int minor = iminor(inode);
314
315         if (minor > MAX_MINORS || minors[minor] == NULL)
316                 return -ENODEV;
317
318         file->private_data = nosy_add_client(minors[minor]);
319         if (file->private_data == NULL)
320                 return -ENOMEM;
321         else
322                 return 0;
323 }
324
325 static int
326 nosy_release(struct inode *inode, struct file *file)
327 {
328         nosy_remove_client(file->private_data);
329
330         return 0;
331 }
332
333 static unsigned int
334 nosy_poll(struct file *file, poll_table *pt)
335 {
336         struct client *client = file->private_data;
337
338         poll_wait(file, &client->buffer.wait, pt);
339
340         if (atomic_read(&client->buffer.size) > 0)
341                 return POLLIN | POLLRDNORM;
342         else
343                 return 0;
344 }
345
346 static ssize_t
347 nosy_read(struct file *file, char *buffer, size_t count, loff_t *offset)
348 {
349         struct client *client = file->private_data;
350
351         return packet_buffer_get(&client->buffer, buffer, count);
352 }
353
354 static int
355 nosy_ioctl(struct inode *inode, struct file *file,
356            unsigned int cmd, unsigned long arg)
357 {
358         struct client *client = file->private_data;
359         struct nosy_stats stats;
360
361         switch (cmd) {
362         case NOSY_IOC_GET_STATS:
363                 stats.total_packet_count = client->buffer.total_packet_count;
364                 stats.lost_packet_count = client->buffer.lost_packet_count;
365                 if (copy_to_user((void *) arg, &stats, sizeof stats))
366                         return -EFAULT;
367                 else
368                         return 0;
369
370         case NOSY_IOC_START:
371                 nosy_start_snoop(client);
372                 return 0;
373
374         case NOSY_IOC_STOP:
375                 nosy_stop_snoop(client);
376                 return 0;
377
378         case NOSY_IOC_FILTER:
379                 client->tcode_mask = arg;
380                 return 0;
381
382         default:
383                 return -EINVAL;
384                 /* Flush buffer, configure filter. */
385         }
386 }
387
388 static const struct file_operations nosy_ops = {
389         .owner =        THIS_MODULE,
390         .read =         nosy_read,
391         .ioctl =        nosy_ioctl,
392         .poll =         nosy_poll,
393         .open =         nosy_open,
394         .release =      nosy_release,
395 };
396
397 #define PHY_PACKET_SIZE 12 /* 1 payload, 1 inverse, 1 ack = 3 quadlets */
398
399 struct link_packet {
400         unsigned int priority : 4;
401         unsigned int tcode : 4;
402         unsigned int rt : 2;
403         unsigned int tlabel : 6;
404         unsigned int destination : 16;
405 };
406
407 static void
408 packet_handler(struct pcilynx *lynx)
409 {
410         unsigned long flags;
411         struct client *client;
412         unsigned long tcode_mask;
413         size_t length;
414         struct link_packet *packet;
415         struct timeval tv;
416
417         /* FIXME: Also report rcv_speed. */
418
419         length = lynx->rcv_pcl->pcl_status.transfer_count;
420         packet = (struct link_packet *) &lynx->rcv_buffer[1];
421
422         do_gettimeofday(&tv);
423         lynx->rcv_buffer[0] = tv.tv_usec;
424
425         if (length == PHY_PACKET_SIZE)
426                 tcode_mask = 1 << TCODE_PHY_PACKET;
427         else
428                 tcode_mask = 1 << packet->tcode;
429
430         spin_lock_irqsave(&lynx->client_list_lock, flags);
431
432         list_for_each_entry(client, &lynx->client_list, link)
433                 if (client->tcode_mask & tcode_mask)
434                         packet_buffer_put(&client->buffer,
435                                           lynx->rcv_buffer, length + 4);
436
437         spin_unlock_irqrestore(&lynx->client_list_lock, flags);
438 }
439
440 static void
441 bus_reset_handler(struct pcilynx *lynx)
442 {
443         unsigned long flags;
444         struct client *client;
445         struct timeval tv;
446
447         do_gettimeofday(&tv);
448
449         spin_lock_irqsave(&lynx->client_list_lock, flags);
450
451         list_for_each_entry(client, &lynx->client_list, link)
452                 packet_buffer_put(&client->buffer, &tv.tv_usec, 4);
453
454         spin_unlock_irqrestore(&lynx->client_list_lock, flags);
455 }
456
457 static irqreturn_t
458 irq_handler(int irq, void *device)
459 {
460         struct pcilynx *lynx = device;
461         u32 pci_int_status;
462
463         pci_int_status = reg_read(lynx, PCI_INT_STATUS);
464
465         if ((pci_int_status & PCI_INT_INT_PEND) == 0)
466                 /* Not our interrupt, bail out quickly. */
467                 return IRQ_NONE;
468
469         if ((pci_int_status & PCI_INT_P1394_INT) != 0) {
470                 u32 link_int_status;
471
472                 link_int_status = reg_read(lynx, LINK_INT_STATUS);
473                 reg_write(lynx, LINK_INT_STATUS, link_int_status);
474
475                 if ((link_int_status & LINK_INT_PHY_BUSRESET) > 0)
476                         bus_reset_handler(lynx);
477         }
478
479         /* Clear the PCI_INT_STATUS register only after clearing the
480          * LINK_INT_STATUS register; otherwise the PCI_INT_P1394 will
481          * be set again immediately. */
482
483         reg_write(lynx, PCI_INT_STATUS, pci_int_status);
484
485         if ((pci_int_status & PCI_INT_DMA0_HLT) > 0) {
486                 packet_handler(lynx);
487                 run_pcl(lynx, lynx->rcv_start_pcl_bus, 0);
488         }
489
490         return IRQ_HANDLED;
491 }
492
493 static void
494 remove_card(struct pci_dev *dev)
495 {
496         struct pcilynx *lynx;
497
498         lynx = pci_get_drvdata(dev);
499         if (!lynx)
500                 return;
501         pci_set_drvdata(dev, NULL);
502
503         reg_write(lynx, PCI_INT_ENABLE, 0);
504         free_irq(lynx->pci_device->irq, lynx);
505
506         pci_free_consistent(lynx->pci_device, sizeof(struct pcl),
507                             lynx->rcv_start_pcl, lynx->rcv_start_pcl_bus);
508         pci_free_consistent(lynx->pci_device, sizeof(struct pcl),
509                             lynx->rcv_pcl, lynx->rcv_pcl_bus);
510         pci_free_consistent(lynx->pci_device, PAGE_SIZE,
511                             lynx->rcv_buffer, lynx->rcv_buffer_bus);
512
513         iounmap(lynx->registers);
514
515         minors[lynx->misc.minor] = NULL;
516         misc_deregister(&lynx->misc);
517
518         kfree(lynx);
519 }
520
521 #define RCV_BUFFER_SIZE (16 * 1024)
522
523 static int __devinit
524 add_card(struct pci_dev *dev, const struct pci_device_id *unused)
525 {
526         struct pcilynx *lynx;
527         u32 p, end;
528         int i;
529
530         if (pci_set_dma_mask(dev, 0xffffffff)) {
531                 error("DMA address limits not supported "
532                       "for PCILynx hardware\n");
533                 return -ENXIO;
534         }
535         if (pci_enable_device(dev)) {
536                 error("Failed to enable PCILynx hardware\n");
537                 return -ENXIO;
538         }
539         pci_set_master(dev);
540
541         lynx = kzalloc(sizeof *lynx, GFP_KERNEL);
542         if (lynx == NULL) {
543                 error("Failed to allocate control structure memory\n");
544                 return -ENOMEM;
545         }
546         lynx->pci_device = dev;
547         pci_set_drvdata(dev, lynx);
548
549         spin_lock_init(&lynx->client_list_lock);
550         INIT_LIST_HEAD(&lynx->client_list);
551
552         lynx->registers = ioremap_nocache(pci_resource_start(dev, 0),
553                                           PCILYNX_MAX_REGISTER);
554
555         lynx->rcv_start_pcl = pci_alloc_consistent(lynx->pci_device,
556                                 sizeof(struct pcl), &lynx->rcv_start_pcl_bus);
557         lynx->rcv_pcl = pci_alloc_consistent(lynx->pci_device,
558                                 sizeof(struct pcl), &lynx->rcv_pcl_bus);
559         lynx->rcv_buffer = pci_alloc_consistent(lynx->pci_device,
560                                 RCV_BUFFER_SIZE, &lynx->rcv_buffer_bus);
561         if (lynx->rcv_start_pcl == NULL ||
562             lynx->rcv_pcl == NULL ||
563             lynx->rcv_buffer == NULL) {
564                 /* FIXME: do proper error handling. */
565                 error("Failed to allocate receive buffer\n");
566                 return -ENOMEM;
567         }
568         lynx->rcv_start_pcl->next = lynx->rcv_pcl_bus;
569         lynx->rcv_pcl->next = PCL_NEXT_INVALID;
570         lynx->rcv_pcl->async_error_next = PCL_NEXT_INVALID;
571
572         lynx->rcv_pcl->buffer[0].control =
573                 PCL_CMD_RCV | PCL_BIGENDIAN | 2044;
574         lynx->rcv_pcl->buffer[0].pointer = lynx->rcv_buffer_bus + 4;
575         p = lynx->rcv_buffer_bus + 2048;
576         end = lynx->rcv_buffer_bus + RCV_BUFFER_SIZE;
577         for (i = 1; p < end; i++, p += 2048) {
578                 lynx->rcv_pcl->buffer[i].control =
579                         PCL_CMD_RCV | PCL_BIGENDIAN | 2048;
580                 lynx->rcv_pcl->buffer[i].pointer = p;
581         }
582         lynx->rcv_pcl->buffer[i - 1].control |= PCL_LAST_BUFF;
583
584         reg_set_bits(lynx, MISC_CONTROL, MISC_CONTROL_SWRESET);
585         /* Fix buggy cards with autoboot pin not tied low: */
586         reg_write(lynx, DMA0_CHAN_CTRL, 0);
587         reg_write(lynx, DMA_GLOBAL_REGISTER, 0x00 << 24);
588
589 #if 0
590         /* now, looking for PHY register set */
591         if ((get_phy_reg(lynx, 2) & 0xe0) == 0xe0) {
592                 lynx->phyic.reg_1394a = 1;
593                 PRINT(KERN_INFO, lynx->id,
594                       "found 1394a conform PHY (using extended register set)");
595                 lynx->phyic.vendor = get_phy_vendorid(lynx);
596                 lynx->phyic.product = get_phy_productid(lynx);
597         } else {
598                 lynx->phyic.reg_1394a = 0;
599                 PRINT(KERN_INFO, lynx->id, "found old 1394 PHY");
600         }
601 #endif
602
603         /* Setup the general receive FIFO max size. */
604         reg_write(lynx, FIFO_SIZES, 255);
605
606         reg_set_bits(lynx, PCI_INT_ENABLE, PCI_INT_DMA_ALL);
607
608         reg_write(lynx, LINK_INT_ENABLE,
609                   LINK_INT_PHY_TIME_OUT | LINK_INT_PHY_REG_RCVD |
610                   LINK_INT_PHY_BUSRESET | LINK_INT_IT_STUCK |
611                   LINK_INT_AT_STUCK | LINK_INT_SNTRJ |
612                   LINK_INT_TC_ERR | LINK_INT_GRF_OVER_FLOW |
613                   LINK_INT_ITF_UNDER_FLOW | LINK_INT_ATF_UNDER_FLOW);
614
615         /* Disable the L flag in self ID packets. */
616         set_phy_reg(lynx, 4, 0);
617
618         /* Put this baby into snoop mode */
619         reg_set_bits(lynx, LINK_CONTROL, LINK_CONTROL_SNOOP_ENABLE);
620
621         run_pcl(lynx, lynx->rcv_start_pcl_bus, 0);
622
623         if (request_irq(dev->irq, irq_handler, IRQF_SHARED,
624                         driver_name, lynx)) {
625                 error("Failed to allocate shared interrupt %d\n", dev->irq);
626                 return -EIO;
627         }
628
629         lynx->misc.parent = &dev->dev;
630         lynx->misc.minor = MISC_DYNAMIC_MINOR;
631         lynx->misc.name = "nosy";
632         lynx->misc.fops = &nosy_ops;
633         if (misc_register(&lynx->misc)) {
634                 error("Failed to register misc char device\n");
635                 return -ENOMEM;
636         }
637         minors[lynx->misc.minor] = lynx;
638
639         notify("Initialized PCILynx IEEE1394 card, irq=%d\n", dev->irq);
640
641         return 0;
642 }
643
644 static struct pci_device_id pci_table[] __devinitdata = {
645         {
646                 .vendor =    PCI_VENDOR_ID_TI,
647                 .device =    PCI_DEVICE_ID_TI_PCILYNX,
648                 .subvendor = PCI_ANY_ID,
649                 .subdevice = PCI_ANY_ID,
650         },
651         { }     /* Terminating entry */
652 };
653
654 static struct pci_driver lynx_pci_driver = {
655         .name =         driver_name,
656         .id_table =     pci_table,
657         .probe =        add_card,
658         .remove =       remove_card,
659 };
660
661 MODULE_AUTHOR("Kristian Hoegsberg");
662 MODULE_DESCRIPTION("Snoop mode driver for TI pcilynx 1394 controllers");
663 MODULE_LICENSE("GPL");
664 MODULE_DEVICE_TABLE(pci, pci_table);
665
666 static int __init nosy_init(void)
667 {
668         return pci_register_driver(&lynx_pci_driver);
669 }
670
671 static void __exit nosy_cleanup(void)
672 {
673         pci_unregister_driver(&lynx_pci_driver);
674
675         notify("Unloaded %s.\n", driver_name);
676 }
677
678 module_init(nosy_init);
679 module_exit(nosy_cleanup);