1 /* $Id: cosa.c,v 1.31 2000/03/08 17:47:16 kas Exp $ */
4 * Copyright (C) 1995-1997 Jan "Yenya" Kasprzak <kas@fi.muni.cz>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 * The driver for the SRP and COSA synchronous serial cards.
26 * Both cards are developed at the Institute of Computer Science,
27 * Masaryk University (http://www.ics.muni.cz/). The hardware is
28 * developed by Jiri Novotny <novotny@ics.muni.cz>. More information
29 * and the photo of both cards is available at
30 * http://www.pavoucek.cz/cosa.html. The card documentation, firmwares
31 * and other goods can be downloaded from ftp://ftp.ics.muni.cz/pub/cosa/.
32 * For Linux-specific utilities, see below in the "Software info" section.
33 * If you want to order the card, contact Jiri Novotny.
35 * The SRP (serial port?, the Czech word "srp" means "sickle") card
36 * is a 2-port intelligent (with its own 8-bit CPU) synchronous serial card
37 * with V.24 interfaces up to 80kb/s each.
39 * The COSA (communication serial adapter?, the Czech word "kosa" means
40 * "scythe") is a next-generation sync/async board with two interfaces
41 * - currently any of V.24, X.21, V.35 and V.36 can be selected.
42 * It has a 16-bit SAB80166 CPU and can do up to 10 Mb/s per channel.
43 * The 8-channels version is in development.
45 * Both types have downloadable firmware and communicate via ISA DMA.
46 * COSA can be also a bus-mastering device.
50 * The homepage of the Linux driver is at http://www.fi.muni.cz/~kas/cosa/.
51 * The CVS tree of Linux driver can be viewed there, as well as the
52 * firmware binaries and user-space utilities for downloading the firmware
53 * into the card and setting up the card.
55 * The Linux driver (unlike the present *BSD drivers :-) can work even
56 * for the COSA and SRP in one computer and allows each channel to work
57 * in one of the three modes (character device, Cisco HDLC, Sync PPP).
61 * The Linux driver was written by Jan "Yenya" Kasprzak <kas@fi.muni.cz>.
63 * You can mail me bugfixes and even success reports. I am especially
64 * interested in the SMP and/or muliti-channel success/failure reports
65 * (I wonder if I did the locking properly :-).
67 * THE AUTHOR USED THE FOLLOWING SOURCES WHEN PROGRAMMING THE DRIVER
69 * The COSA/SRP NetBSD driver by Zdenek Salvet and Ivos Cernohlavek
70 * The skeleton.c by Donald Becker
71 * The SDL Riscom/N2 driver by Mike Natale
72 * The Comtrol Hostess SV11 driver by Alan Cox
73 * The Sync PPP/Cisco HDLC layer (syncppp.c) ported to Linux by Alan Cox
76 * 5/25/1999 : Marcelo Tosatti <marcelo@conectiva.com.br>
77 * fixed a deadlock in cosa_sppp_open
80 /* ---------- Headers, macros, data structures ---------- */
82 #include <linux/module.h>
83 #include <linux/kernel.h>
84 #include <linux/slab.h>
85 #include <linux/poll.h>
87 #include <linux/interrupt.h>
88 #include <linux/delay.h>
89 #include <linux/errno.h>
90 #include <linux/ioport.h>
91 #include <linux/netdevice.h>
92 #include <linux/spinlock.h>
93 #include <linux/mutex.h>
94 #include <linux/device.h>
96 #undef COSA_SLOW_IO /* for testing purposes only */
100 #include <asm/byteorder.h>
102 #include <net/syncppp.h>
105 /* Maximum length of the identification string. */
106 #define COSA_MAX_ID_STRING 128
108 /* Maximum length of the channel name */
109 #define COSA_MAX_NAME (sizeof("cosaXXXcXXX")+1)
111 /* Per-channel data structure */
113 struct channel_data {
114 void *if_ptr; /* General purpose pointer (used by SPPP) */
115 int usage; /* Usage count; >0 for chrdev, -1 for netdev */
116 int num; /* Number of the channel */
117 struct cosa_data *cosa; /* Pointer to the per-card structure */
118 int txsize; /* Size of transmitted data */
119 char *txbuf; /* Transmit buffer */
120 char name[COSA_MAX_NAME]; /* channel name */
122 /* The HW layer interface */
123 /* routine called from the RX interrupt */
124 char *(*setup_rx)(struct channel_data *channel, int size);
125 /* routine called when the RX is done (from the EOT interrupt) */
126 int (*rx_done)(struct channel_data *channel);
127 /* routine called when the TX is done (from the EOT interrupt) */
128 int (*tx_done)(struct channel_data *channel, int size);
130 /* Character device parts */
132 struct semaphore wsem;
135 wait_queue_head_t txwaitq, rxwaitq;
136 int tx_status, rx_status;
138 /* SPPP/HDLC device parts */
139 struct ppp_device pppdev;
140 struct sk_buff *rx_skb, *tx_skb;
141 struct net_device_stats stats;
144 /* cosa->firmware_status bits */
145 #define COSA_FW_RESET (1<<0) /* Is the ROM monitor active? */
146 #define COSA_FW_DOWNLOAD (1<<1) /* Is the microcode downloaded? */
147 #define COSA_FW_START (1<<2) /* Is the microcode running? */
150 int num; /* Card number */
151 char name[COSA_MAX_NAME]; /* Card name - e.g "cosa0" */
152 unsigned int datareg, statusreg; /* I/O ports */
153 unsigned short irq, dma; /* IRQ and DMA number */
154 unsigned short startaddr; /* Firmware start address */
155 unsigned short busmaster; /* Use busmastering? */
156 int nchannels; /* # of channels on this card */
157 int driver_status; /* For communicating with firmware */
158 int firmware_status; /* Downloaded, reseted, etc. */
159 unsigned long rxbitmap, txbitmap;/* Bitmap of channels who are willing to send/receive data */
160 unsigned long rxtx; /* RX or TX in progress? */
162 int usage; /* usage count */
163 int txchan, txsize, rxsize;
164 struct channel_data *rxchan;
167 struct channel_data *chan;
168 spinlock_t lock; /* For exclusive operations on this structure */
169 char id_string[COSA_MAX_ID_STRING]; /* ROM monitor ID string */
170 char *type; /* card type */
174 * Define this if you want all the possible ports to be autoprobed.
175 * It is here but it probably is not a good idea to use this.
177 /* #define COSA_ISA_AUTOPROBE 1 */
180 * Character device major number. 117 was allocated for us.
181 * The value of 0 means to allocate a first free one.
183 static int cosa_major = 117;
186 * Encoding of the minor numbers:
187 * The lowest CARD_MINOR_BITS bits means the channel on the single card,
188 * the highest bits means the card number.
190 #define CARD_MINOR_BITS 4 /* How many bits in minor number are reserved
191 * for the single card */
193 * The following depends on CARD_MINOR_BITS. Unfortunately, the "MODULE_STRING"
194 * macro doesn't like anything other than the raw number as an argument :-(
197 /* #define MAX_CARDS (1 << (8-CARD_MINOR_BITS)) */
199 #define DRIVER_RX_READY 0x0001
200 #define DRIVER_TX_READY 0x0002
201 #define DRIVER_TXMAP_SHIFT 2
202 #define DRIVER_TXMAP_MASK 0x0c /* FIXME: 0xfc for 8-channel version */
205 * for cosa->rxtx - indicates whether either transmit or receive is
206 * in progress. These values are mean number of the bit.
212 #define COSA_MTU 2000 /* FIXME: I don't know this exactly */
214 #undef DEBUG_DATA //1 /* Dump the data read or written to the channel */
215 #undef DEBUG_IRQS //1 /* Print the message when the IRQ is received */
216 #undef DEBUG_IO //1 /* Dump the I/O traffic */
218 #define TX_TIMEOUT (5*HZ)
220 /* Maybe the following should be allocated dynamically */
221 static struct cosa_data cosa_cards[MAX_CARDS];
224 #ifdef COSA_ISA_AUTOPROBE
225 static int io[MAX_CARDS+1] = { 0x220, 0x228, 0x210, 0x218, 0, };
226 /* NOTE: DMA is not autoprobed!!! */
227 static int dma[MAX_CARDS+1] = { 1, 7, 1, 7, 1, 7, 1, 7, 0, };
229 static int io[MAX_CARDS+1];
230 static int dma[MAX_CARDS+1];
232 /* IRQ can be safely autoprobed */
233 static int irq[MAX_CARDS+1] = { -1, -1, -1, -1, -1, -1, 0, };
236 static struct class *cosa_class;
239 module_param_array(io, int, NULL, 0);
240 MODULE_PARM_DESC(io, "The I/O bases of the COSA or SRP cards");
241 module_param_array(irq, int, NULL, 0);
242 MODULE_PARM_DESC(irq, "The IRQ lines of the COSA or SRP cards");
243 module_param_array(dma, int, NULL, 0);
244 MODULE_PARM_DESC(dma, "The DMA channels of the COSA or SRP cards");
246 MODULE_AUTHOR("Jan \"Yenya\" Kasprzak, <kas@fi.muni.cz>");
247 MODULE_DESCRIPTION("Modular driver for the COSA or SRP synchronous card");
248 MODULE_LICENSE("GPL");
251 /* I use this mainly for testing purposes */
253 #define cosa_outb outb_p
254 #define cosa_outw outw_p
255 #define cosa_inb inb_p
256 #define cosa_inw inw_p
258 #define cosa_outb outb
259 #define cosa_outw outw
264 #define is_8bit(cosa) (!(cosa->datareg & 0x08))
266 #define cosa_getstatus(cosa) (cosa_inb(cosa->statusreg))
267 #define cosa_putstatus(cosa, stat) (cosa_outb(stat, cosa->statusreg))
268 #define cosa_getdata16(cosa) (cosa_inw(cosa->datareg))
269 #define cosa_getdata8(cosa) (cosa_inb(cosa->datareg))
270 #define cosa_putdata16(cosa, dt) (cosa_outw(dt, cosa->datareg))
271 #define cosa_putdata8(cosa, dt) (cosa_outb(dt, cosa->datareg))
273 /* Initialization stuff */
274 static int cosa_probe(int ioaddr, int irq, int dma);
277 static void cosa_enable_rx(struct channel_data *chan);
278 static void cosa_disable_rx(struct channel_data *chan);
279 static int cosa_start_tx(struct channel_data *channel, char *buf, int size);
280 static void cosa_kick(struct cosa_data *cosa);
281 static int cosa_dma_able(struct channel_data *chan, char *buf, int data);
283 /* SPPP/HDLC stuff */
284 static void sppp_channel_init(struct channel_data *chan);
285 static void sppp_channel_delete(struct channel_data *chan);
286 static int cosa_sppp_open(struct net_device *d);
287 static int cosa_sppp_close(struct net_device *d);
288 static void cosa_sppp_timeout(struct net_device *d);
289 static int cosa_sppp_tx(struct sk_buff *skb, struct net_device *d);
290 static char *sppp_setup_rx(struct channel_data *channel, int size);
291 static int sppp_rx_done(struct channel_data *channel);
292 static int sppp_tx_done(struct channel_data *channel, int size);
293 static int cosa_sppp_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
294 static struct net_device_stats *cosa_net_stats(struct net_device *dev);
296 /* Character device */
297 static void chardev_channel_init(struct channel_data *chan);
298 static char *chrdev_setup_rx(struct channel_data *channel, int size);
299 static int chrdev_rx_done(struct channel_data *channel);
300 static int chrdev_tx_done(struct channel_data *channel, int size);
301 static ssize_t cosa_read(struct file *file,
302 char __user *buf, size_t count, loff_t *ppos);
303 static ssize_t cosa_write(struct file *file,
304 const char __user *buf, size_t count, loff_t *ppos);
305 static unsigned int cosa_poll(struct file *file, poll_table *poll);
306 static int cosa_open(struct inode *inode, struct file *file);
307 static int cosa_release(struct inode *inode, struct file *file);
308 static int cosa_chardev_ioctl(struct inode *inode, struct file *file,
309 unsigned int cmd, unsigned long arg);
310 #ifdef COSA_FASYNC_WORKING
311 static int cosa_fasync(struct inode *inode, struct file *file, int on);
314 static const struct file_operations cosa_fops = {
315 .owner = THIS_MODULE,
320 .ioctl = cosa_chardev_ioctl,
322 .release = cosa_release,
323 #ifdef COSA_FASYNC_WORKING
324 .fasync = cosa_fasync,
329 static int cosa_start(struct cosa_data *cosa, int address);
330 static int cosa_reset(struct cosa_data *cosa);
331 static int cosa_download(struct cosa_data *cosa, void __user *a);
332 static int cosa_readmem(struct cosa_data *cosa, void __user *a);
334 /* COSA/SRP ROM monitor */
335 static int download(struct cosa_data *cosa, const char __user *data, int addr, int len);
336 static int startmicrocode(struct cosa_data *cosa, int address);
337 static int readmem(struct cosa_data *cosa, char __user *data, int addr, int len);
338 static int cosa_reset_and_read_id(struct cosa_data *cosa, char *id);
340 /* Auxilliary functions */
341 static int get_wait_data(struct cosa_data *cosa);
342 static int put_wait_data(struct cosa_data *cosa, int data);
343 static int puthexnumber(struct cosa_data *cosa, int number);
344 static void put_driver_status(struct cosa_data *cosa);
345 static void put_driver_status_nolock(struct cosa_data *cosa);
347 /* Interrupt handling */
348 static irqreturn_t cosa_interrupt(int irq, void *cosa);
350 /* I/O ops debugging */
352 static void debug_data_in(struct cosa_data *cosa, int data);
353 static void debug_data_out(struct cosa_data *cosa, int data);
354 static void debug_data_cmd(struct cosa_data *cosa, int data);
355 static void debug_status_in(struct cosa_data *cosa, int status);
356 static void debug_status_out(struct cosa_data *cosa, int status);
360 /* ---------- Initialization stuff ---------- */
362 static int __init cosa_init(void)
366 printk(KERN_INFO "cosa v1.08 (c) 1997-2000 Jan Kasprzak <kas@fi.muni.cz>\n");
368 printk(KERN_INFO "cosa: SMP found. Please mail any success/failure reports to the author.\n");
370 if (cosa_major > 0) {
371 if (register_chrdev(cosa_major, "cosa", &cosa_fops)) {
372 printk(KERN_WARNING "cosa: unable to get major %d\n",
378 if (!(cosa_major=register_chrdev(0, "cosa", &cosa_fops))) {
379 printk(KERN_WARNING "cosa: unable to register chardev\n");
384 for (i=0; i<MAX_CARDS; i++)
385 cosa_cards[i].num = -1;
386 for (i=0; io[i] != 0 && i < MAX_CARDS; i++)
387 cosa_probe(io[i], irq[i], dma[i]);
389 printk(KERN_WARNING "cosa: no devices found.\n");
390 unregister_chrdev(cosa_major, "cosa");
394 cosa_class = class_create(THIS_MODULE, "cosa");
395 if (IS_ERR(cosa_class)) {
396 err = PTR_ERR(cosa_class);
399 for (i=0; i<nr_cards; i++) {
400 device_create(cosa_class, NULL, MKDEV(cosa_major, i), "cosa%d", i);
406 unregister_chrdev(cosa_major, "cosa");
410 module_init(cosa_init);
412 static void __exit cosa_exit(void)
414 struct cosa_data *cosa;
416 printk(KERN_INFO "Unloading the cosa module\n");
418 for (i=0; i<nr_cards; i++)
419 device_destroy(cosa_class, MKDEV(cosa_major, i));
420 class_destroy(cosa_class);
421 for (cosa=cosa_cards; nr_cards--; cosa++) {
422 /* Clean up the per-channel data */
423 for (i=0; i<cosa->nchannels; i++) {
424 /* Chardev driver has no alloc'd per-channel data */
425 sppp_channel_delete(cosa->chan+i);
427 /* Clean up the per-card data */
429 kfree(cosa->bouncebuf);
430 free_irq(cosa->irq, cosa);
432 release_region(cosa->datareg,is_8bit(cosa)?2:4);
434 unregister_chrdev(cosa_major, "cosa");
436 module_exit(cosa_exit);
439 * This function should register all the net devices needed for the
442 static __inline__ void channel_init(struct channel_data *chan)
444 sprintf(chan->name, "cosa%dc%d", chan->cosa->num, chan->num);
446 /* Initialize the chardev data structures */
447 chardev_channel_init(chan);
449 /* Register the sppp interface */
450 sppp_channel_init(chan);
453 static int cosa_probe(int base, int irq, int dma)
455 struct cosa_data *cosa = cosa_cards+nr_cards;
458 memset(cosa, 0, sizeof(struct cosa_data));
460 /* Checking validity of parameters: */
461 /* IRQ should be 2-7 or 10-15; negative IRQ means autoprobe */
462 if ((irq >= 0 && irq < 2) || irq > 15 || (irq < 10 && irq > 7)) {
463 printk (KERN_INFO "cosa_probe: invalid IRQ %d\n", irq);
466 /* I/O address should be between 0x100 and 0x3ff and should be
468 if (base < 0x100 || base > 0x3ff || base & 0x7) {
469 printk (KERN_INFO "cosa_probe: invalid I/O address 0x%x\n",
473 /* DMA should be 0,1 or 3-7 */
474 if (dma < 0 || dma == 4 || dma > 7) {
475 printk (KERN_INFO "cosa_probe: invalid DMA %d\n", dma);
478 /* and finally, on 16-bit COSA DMA should be 4-7 and
479 * I/O base should not be multiple of 0x10 */
480 if (((base & 0x8) && dma < 4) || (!(base & 0x8) && dma > 3)) {
481 printk (KERN_INFO "cosa_probe: 8/16 bit base and DMA mismatch"
482 " (base=0x%x, dma=%d)\n", base, dma);
487 cosa->datareg = base;
488 cosa->statusreg = is_8bit(cosa)?base+1:base+2;
489 spin_lock_init(&cosa->lock);
491 if (!request_region(base, is_8bit(cosa)?2:4,"cosa"))
494 if (cosa_reset_and_read_id(cosa, cosa->id_string) < 0) {
495 printk(KERN_DEBUG "cosa: probe at 0x%x failed.\n", base);
500 /* Test the validity of identification string */
501 if (!strncmp(cosa->id_string, "SRP", 3))
503 else if (!strncmp(cosa->id_string, "COSA", 4))
504 cosa->type = is_8bit(cosa)? "cosa8": "cosa16";
506 /* Print a warning only if we are not autoprobing */
507 #ifndef COSA_ISA_AUTOPROBE
508 printk(KERN_INFO "cosa: valid signature not found at 0x%x.\n",
514 /* Update the name of the region now we know the type of card */
515 release_region(base, is_8bit(cosa)?2:4);
516 if (!request_region(base, is_8bit(cosa)?2:4, cosa->type)) {
517 printk(KERN_DEBUG "cosa: changing name at 0x%x failed.\n", base);
521 /* Now do IRQ autoprobe */
524 /* printk(KERN_INFO "IRQ autoprobe\n"); */
525 irqs = probe_irq_on();
527 * Enable interrupt on tx buffer empty (it sure is)
529 * FIXME: When this code is not used as module, we should
530 * probably call udelay() instead of the interruptible sleep.
532 set_current_state(TASK_INTERRUPTIBLE);
533 cosa_putstatus(cosa, SR_TX_INT_ENA);
534 schedule_timeout(30);
535 irq = probe_irq_off(irqs);
536 /* Disable all IRQs from the card */
537 cosa_putstatus(cosa, 0);
538 /* Empty the received data register */
542 printk (KERN_INFO "cosa IRQ autoprobe: multiple interrupts obtained (%d, board at 0x%x)\n",
548 printk (KERN_INFO "cosa IRQ autoprobe: no interrupt obtained (board at 0x%x)\n",
555 cosa->num = nr_cards;
557 cosa->nchannels = 2; /* FIXME: how to determine this? */
559 if (request_irq(cosa->irq, cosa_interrupt, 0, cosa->type, cosa)) {
563 if (request_dma(cosa->dma, cosa->type)) {
568 cosa->bouncebuf = kmalloc(COSA_MTU, GFP_KERNEL|GFP_DMA);
569 if (!cosa->bouncebuf) {
573 sprintf(cosa->name, "cosa%d", cosa->num);
575 /* Initialize the per-channel data */
576 cosa->chan = kcalloc(cosa->nchannels, sizeof(struct channel_data), GFP_KERNEL);
581 for (i=0; i<cosa->nchannels; i++) {
582 cosa->chan[i].cosa = cosa;
583 cosa->chan[i].num = i;
584 channel_init(cosa->chan+i);
587 printk (KERN_INFO "cosa%d: %s (%s at 0x%x irq %d dma %d), %d channels\n",
588 cosa->num, cosa->id_string, cosa->type,
589 cosa->datareg, cosa->irq, cosa->dma, cosa->nchannels);
593 kfree(cosa->bouncebuf);
597 free_irq(cosa->irq, cosa);
599 release_region(cosa->datareg,is_8bit(cosa)?2:4);
600 printk(KERN_NOTICE "cosa%d: allocating resources failed\n",
606 /*---------- SPPP/HDLC netdevice ---------- */
608 static void cosa_setup(struct net_device *d)
610 d->open = cosa_sppp_open;
611 d->stop = cosa_sppp_close;
612 d->hard_start_xmit = cosa_sppp_tx;
613 d->do_ioctl = cosa_sppp_ioctl;
614 d->get_stats = cosa_net_stats;
615 d->tx_timeout = cosa_sppp_timeout;
616 d->watchdog_timeo = TX_TIMEOUT;
619 static void sppp_channel_init(struct channel_data *chan)
621 struct net_device *d;
622 chan->if_ptr = &chan->pppdev;
623 d = alloc_netdev(0, chan->name, cosa_setup);
625 printk(KERN_WARNING "%s: alloc_netdev failed.\n", chan->name);
628 chan->pppdev.dev = d;
629 d->base_addr = chan->cosa->datareg;
630 d->irq = chan->cosa->irq;
631 d->dma = chan->cosa->dma;
633 sppp_attach(&chan->pppdev);
634 if (register_netdev(d)) {
635 printk(KERN_WARNING "%s: register_netdev failed.\n", d->name);
638 chan->pppdev.dev = NULL;
643 static void sppp_channel_delete(struct channel_data *chan)
645 unregister_netdev(chan->pppdev.dev);
646 sppp_detach(chan->pppdev.dev);
647 free_netdev(chan->pppdev.dev);
648 chan->pppdev.dev = NULL;
651 static int cosa_sppp_open(struct net_device *d)
653 struct channel_data *chan = d->ml_priv;
657 if (!(chan->cosa->firmware_status & COSA_FW_START)) {
658 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
659 chan->cosa->name, chan->cosa->firmware_status);
662 spin_lock_irqsave(&chan->cosa->lock, flags);
663 if (chan->usage != 0) {
664 printk(KERN_WARNING "%s: sppp_open called with usage count %d\n",
665 chan->name, chan->usage);
666 spin_unlock_irqrestore(&chan->cosa->lock, flags);
669 chan->setup_rx = sppp_setup_rx;
670 chan->tx_done = sppp_tx_done;
671 chan->rx_done = sppp_rx_done;
674 spin_unlock_irqrestore(&chan->cosa->lock, flags);
678 spin_lock_irqsave(&chan->cosa->lock, flags);
682 spin_unlock_irqrestore(&chan->cosa->lock, flags);
686 netif_start_queue(d);
687 cosa_enable_rx(chan);
691 static int cosa_sppp_tx(struct sk_buff *skb, struct net_device *dev)
693 struct channel_data *chan = dev->ml_priv;
695 netif_stop_queue(dev);
698 cosa_start_tx(chan, skb->data, skb->len);
702 static void cosa_sppp_timeout(struct net_device *dev)
704 struct channel_data *chan = dev->ml_priv;
706 if (test_bit(RXBIT, &chan->cosa->rxtx)) {
707 chan->stats.rx_errors++;
708 chan->stats.rx_missed_errors++;
710 chan->stats.tx_errors++;
711 chan->stats.tx_aborted_errors++;
713 cosa_kick(chan->cosa);
715 dev_kfree_skb(chan->tx_skb);
718 netif_wake_queue(dev);
721 static int cosa_sppp_close(struct net_device *d)
723 struct channel_data *chan = d->ml_priv;
728 cosa_disable_rx(chan);
729 spin_lock_irqsave(&chan->cosa->lock, flags);
731 kfree_skb(chan->rx_skb);
735 kfree_skb(chan->tx_skb);
740 spin_unlock_irqrestore(&chan->cosa->lock, flags);
744 static char *sppp_setup_rx(struct channel_data *chan, int size)
747 * We can safely fall back to non-dma-able memory, because we have
748 * the cosa->bouncebuf pre-allocated.
751 kfree_skb(chan->rx_skb);
752 chan->rx_skb = dev_alloc_skb(size);
753 if (chan->rx_skb == NULL) {
754 printk(KERN_NOTICE "%s: Memory squeeze, dropping packet\n",
756 chan->stats.rx_dropped++;
759 chan->pppdev.dev->trans_start = jiffies;
760 return skb_put(chan->rx_skb, size);
763 static int sppp_rx_done(struct channel_data *chan)
766 printk(KERN_WARNING "%s: rx_done with empty skb!\n",
768 chan->stats.rx_errors++;
769 chan->stats.rx_frame_errors++;
772 chan->rx_skb->protocol = htons(ETH_P_WAN_PPP);
773 chan->rx_skb->dev = chan->pppdev.dev;
774 skb_reset_mac_header(chan->rx_skb);
775 chan->stats.rx_packets++;
776 chan->stats.rx_bytes += chan->cosa->rxsize;
777 netif_rx(chan->rx_skb);
779 chan->pppdev.dev->last_rx = jiffies;
784 static int sppp_tx_done(struct channel_data *chan, int size)
787 printk(KERN_WARNING "%s: tx_done with empty skb!\n",
789 chan->stats.tx_errors++;
790 chan->stats.tx_aborted_errors++;
793 dev_kfree_skb_irq(chan->tx_skb);
795 chan->stats.tx_packets++;
796 chan->stats.tx_bytes += size;
797 netif_wake_queue(chan->pppdev.dev);
801 static struct net_device_stats *cosa_net_stats(struct net_device *dev)
803 struct channel_data *chan = dev->ml_priv;
808 /*---------- Character device ---------- */
810 static void chardev_channel_init(struct channel_data *chan)
812 mutex_init(&chan->rlock);
813 init_MUTEX(&chan->wsem);
816 static ssize_t cosa_read(struct file *file,
817 char __user *buf, size_t count, loff_t *ppos)
819 DECLARE_WAITQUEUE(wait, current);
821 struct channel_data *chan = file->private_data;
822 struct cosa_data *cosa = chan->cosa;
825 if (!(cosa->firmware_status & COSA_FW_START)) {
826 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
827 cosa->name, cosa->firmware_status);
830 if (mutex_lock_interruptible(&chan->rlock))
833 if ((chan->rxdata = kmalloc(COSA_MTU, GFP_DMA|GFP_KERNEL)) == NULL) {
834 printk(KERN_INFO "%s: cosa_read() - OOM\n", cosa->name);
835 mutex_unlock(&chan->rlock);
840 cosa_enable_rx(chan);
841 spin_lock_irqsave(&cosa->lock, flags);
842 add_wait_queue(&chan->rxwaitq, &wait);
843 while(!chan->rx_status) {
844 current->state = TASK_INTERRUPTIBLE;
845 spin_unlock_irqrestore(&cosa->lock, flags);
847 spin_lock_irqsave(&cosa->lock, flags);
848 if (signal_pending(current) && chan->rx_status == 0) {
850 remove_wait_queue(&chan->rxwaitq, &wait);
851 current->state = TASK_RUNNING;
852 spin_unlock_irqrestore(&cosa->lock, flags);
853 mutex_unlock(&chan->rlock);
857 remove_wait_queue(&chan->rxwaitq, &wait);
858 current->state = TASK_RUNNING;
860 count = chan->rxsize;
861 spin_unlock_irqrestore(&cosa->lock, flags);
862 mutex_unlock(&chan->rlock);
864 if (copy_to_user(buf, kbuf, count)) {
872 static char *chrdev_setup_rx(struct channel_data *chan, int size)
874 /* Expect size <= COSA_MTU */
879 static int chrdev_rx_done(struct channel_data *chan)
881 if (chan->rx_status) { /* Reader has died */
886 wake_up_interruptible(&chan->rxwaitq);
891 static ssize_t cosa_write(struct file *file,
892 const char __user *buf, size_t count, loff_t *ppos)
894 DECLARE_WAITQUEUE(wait, current);
895 struct channel_data *chan = file->private_data;
896 struct cosa_data *cosa = chan->cosa;
900 if (!(cosa->firmware_status & COSA_FW_START)) {
901 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
902 cosa->name, cosa->firmware_status);
905 if (down_interruptible(&chan->wsem))
908 if (count > COSA_MTU)
911 /* Allocate the buffer */
912 if ((kbuf = kmalloc(count, GFP_KERNEL|GFP_DMA)) == NULL) {
913 printk(KERN_NOTICE "%s: cosa_write() OOM - dropping packet\n",
918 if (copy_from_user(kbuf, buf, count)) {
924 cosa_start_tx(chan, kbuf, count);
926 spin_lock_irqsave(&cosa->lock, flags);
927 add_wait_queue(&chan->txwaitq, &wait);
928 while(!chan->tx_status) {
929 current->state = TASK_INTERRUPTIBLE;
930 spin_unlock_irqrestore(&cosa->lock, flags);
932 spin_lock_irqsave(&cosa->lock, flags);
933 if (signal_pending(current) && chan->tx_status == 0) {
935 remove_wait_queue(&chan->txwaitq, &wait);
936 current->state = TASK_RUNNING;
938 spin_unlock_irqrestore(&cosa->lock, flags);
942 remove_wait_queue(&chan->txwaitq, &wait);
943 current->state = TASK_RUNNING;
945 spin_unlock_irqrestore(&cosa->lock, flags);
950 static int chrdev_tx_done(struct channel_data *chan, int size)
952 if (chan->tx_status) { /* Writer was interrupted */
957 wake_up_interruptible(&chan->txwaitq);
961 static unsigned int cosa_poll(struct file *file, poll_table *poll)
963 printk(KERN_INFO "cosa_poll is here\n");
967 static int cosa_open(struct inode *inode, struct file *file)
969 struct cosa_data *cosa;
970 struct channel_data *chan;
974 if ((n=iminor(file->f_path.dentry->d_inode)>>CARD_MINOR_BITS)
979 if ((n=iminor(file->f_path.dentry->d_inode)
980 & ((1<<CARD_MINOR_BITS)-1)) >= cosa->nchannels)
982 chan = cosa->chan + n;
984 file->private_data = chan;
986 spin_lock_irqsave(&cosa->lock, flags);
988 if (chan->usage < 0) { /* in netdev mode */
989 spin_unlock_irqrestore(&cosa->lock, flags);
995 chan->tx_done = chrdev_tx_done;
996 chan->setup_rx = chrdev_setup_rx;
997 chan->rx_done = chrdev_rx_done;
998 spin_unlock_irqrestore(&cosa->lock, flags);
1002 static int cosa_release(struct inode *inode, struct file *file)
1004 struct channel_data *channel = file->private_data;
1005 struct cosa_data *cosa;
1006 unsigned long flags;
1008 cosa = channel->cosa;
1009 spin_lock_irqsave(&cosa->lock, flags);
1012 spin_unlock_irqrestore(&cosa->lock, flags);
1016 #ifdef COSA_FASYNC_WORKING
1017 static struct fasync_struct *fasync[256] = { NULL, };
1019 /* To be done ... */
1020 static int cosa_fasync(struct inode *inode, struct file *file, int on)
1022 int port = iminor(inode);
1023 int rv = fasync_helper(inode, file, on, &fasync[port]);
1024 return rv < 0 ? rv : 0;
1029 /* ---------- Ioctls ---------- */
1032 * Ioctl subroutines can safely be made inline, because they are called
1033 * only from cosa_ioctl().
1035 static inline int cosa_reset(struct cosa_data *cosa)
1037 char idstring[COSA_MAX_ID_STRING];
1038 if (cosa->usage > 1)
1039 printk(KERN_INFO "cosa%d: WARNING: reset requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1040 cosa->num, cosa->usage);
1041 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_START);
1042 if (cosa_reset_and_read_id(cosa, idstring) < 0) {
1043 printk(KERN_NOTICE "cosa%d: reset failed\n", cosa->num);
1046 printk(KERN_INFO "cosa%d: resetting device: %s\n", cosa->num,
1048 cosa->firmware_status |= COSA_FW_RESET;
1052 /* High-level function to download data into COSA memory. Calls download() */
1053 static inline int cosa_download(struct cosa_data *cosa, void __user *arg)
1055 struct cosa_download d;
1058 if (cosa->usage > 1)
1059 printk(KERN_INFO "%s: WARNING: download of microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1060 cosa->name, cosa->usage);
1061 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1062 printk(KERN_NOTICE "%s: reset the card first (status %d).\n",
1063 cosa->name, cosa->firmware_status);
1067 if (copy_from_user(&d, arg, sizeof(d)))
1070 if (d.addr < 0 || d.addr > COSA_MAX_FIRMWARE_SIZE)
1072 if (d.len < 0 || d.len > COSA_MAX_FIRMWARE_SIZE)
1076 /* If something fails, force the user to reset the card */
1077 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_DOWNLOAD);
1079 i = download(cosa, d.code, d.len, d.addr);
1081 printk(KERN_NOTICE "cosa%d: microcode download failed: %d\n",
1085 printk(KERN_INFO "cosa%d: downloading microcode - 0x%04x bytes at 0x%04x\n",
1086 cosa->num, d.len, d.addr);
1087 cosa->firmware_status |= COSA_FW_RESET|COSA_FW_DOWNLOAD;
1091 /* High-level function to read COSA memory. Calls readmem() */
1092 static inline int cosa_readmem(struct cosa_data *cosa, void __user *arg)
1094 struct cosa_download d;
1097 if (cosa->usage > 1)
1098 printk(KERN_INFO "cosa%d: WARNING: readmem requested with "
1099 "cosa->usage > 1 (%d). Odd things may happen.\n",
1100 cosa->num, cosa->usage);
1101 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1102 printk(KERN_NOTICE "%s: reset the card first (status %d).\n",
1103 cosa->name, cosa->firmware_status);
1107 if (copy_from_user(&d, arg, sizeof(d)))
1110 /* If something fails, force the user to reset the card */
1111 cosa->firmware_status &= ~COSA_FW_RESET;
1113 i = readmem(cosa, d.code, d.len, d.addr);
1115 printk(KERN_NOTICE "cosa%d: reading memory failed: %d\n",
1119 printk(KERN_INFO "cosa%d: reading card memory - 0x%04x bytes at 0x%04x\n",
1120 cosa->num, d.len, d.addr);
1121 cosa->firmware_status |= COSA_FW_RESET;
1125 /* High-level function to start microcode. Calls startmicrocode(). */
1126 static inline int cosa_start(struct cosa_data *cosa, int address)
1130 if (cosa->usage > 1)
1131 printk(KERN_INFO "cosa%d: WARNING: start microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1132 cosa->num, cosa->usage);
1134 if ((cosa->firmware_status & (COSA_FW_RESET|COSA_FW_DOWNLOAD))
1135 != (COSA_FW_RESET|COSA_FW_DOWNLOAD)) {
1136 printk(KERN_NOTICE "%s: download the microcode and/or reset the card first (status %d).\n",
1137 cosa->name, cosa->firmware_status);
1140 cosa->firmware_status &= ~COSA_FW_RESET;
1141 if ((i=startmicrocode(cosa, address)) < 0) {
1142 printk(KERN_NOTICE "cosa%d: start microcode at 0x%04x failed: %d\n",
1143 cosa->num, address, i);
1146 printk(KERN_INFO "cosa%d: starting microcode at 0x%04x\n",
1147 cosa->num, address);
1148 cosa->startaddr = address;
1149 cosa->firmware_status |= COSA_FW_START;
1153 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1154 static inline int cosa_getidstr(struct cosa_data *cosa, char __user *string)
1156 int l = strlen(cosa->id_string)+1;
1157 if (copy_to_user(string, cosa->id_string, l))
1162 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1163 static inline int cosa_gettype(struct cosa_data *cosa, char __user *string)
1165 int l = strlen(cosa->type)+1;
1166 if (copy_to_user(string, cosa->type, l))
1171 static int cosa_ioctl_common(struct cosa_data *cosa,
1172 struct channel_data *channel, unsigned int cmd, unsigned long arg)
1174 void __user *argp = (void __user *)arg;
1176 case COSAIORSET: /* Reset the device */
1177 if (!capable(CAP_NET_ADMIN))
1179 return cosa_reset(cosa);
1180 case COSAIOSTRT: /* Start the firmware */
1181 if (!capable(CAP_SYS_RAWIO))
1183 return cosa_start(cosa, arg);
1184 case COSAIODOWNLD: /* Download the firmware */
1185 if (!capable(CAP_SYS_RAWIO))
1188 return cosa_download(cosa, argp);
1190 if (!capable(CAP_SYS_RAWIO))
1192 return cosa_readmem(cosa, argp);
1194 return cosa_gettype(cosa, argp);
1196 return cosa_getidstr(cosa, argp);
1200 return cosa->nchannels;
1202 if (!capable(CAP_SYS_RAWIO))
1206 if (arg != COSA_BM_OFF && arg != COSA_BM_ON)
1208 cosa->busmaster = arg;
1211 return cosa->busmaster;
1213 return -ENOIOCTLCMD;
1216 static int cosa_sppp_ioctl(struct net_device *dev, struct ifreq *ifr,
1220 struct channel_data *chan = dev->ml_priv;
1221 rv = cosa_ioctl_common(chan->cosa, chan, cmd, (unsigned long)ifr->ifr_data);
1222 if (rv == -ENOIOCTLCMD) {
1223 return sppp_do_ioctl(dev, ifr, cmd);
1228 static int cosa_chardev_ioctl(struct inode *inode, struct file *file,
1229 unsigned int cmd, unsigned long arg)
1231 struct channel_data *channel = file->private_data;
1232 struct cosa_data *cosa = channel->cosa;
1233 return cosa_ioctl_common(cosa, channel, cmd, arg);
1237 /*---------- HW layer interface ---------- */
1240 * The higher layer can bind itself to the HW layer by setting the callbacks
1241 * in the channel_data structure and by using these routines.
1243 static void cosa_enable_rx(struct channel_data *chan)
1245 struct cosa_data *cosa = chan->cosa;
1247 if (!test_and_set_bit(chan->num, &cosa->rxbitmap))
1248 put_driver_status(cosa);
1251 static void cosa_disable_rx(struct channel_data *chan)
1253 struct cosa_data *cosa = chan->cosa;
1255 if (test_and_clear_bit(chan->num, &cosa->rxbitmap))
1256 put_driver_status(cosa);
1260 * FIXME: This routine probably should check for cosa_start_tx() called when
1261 * the previous transmit is still unfinished. In this case the non-zero
1262 * return value should indicate to the caller that the queuing(sp?) up
1263 * the transmit has failed.
1265 static int cosa_start_tx(struct channel_data *chan, char *buf, int len)
1267 struct cosa_data *cosa = chan->cosa;
1268 unsigned long flags;
1272 printk(KERN_INFO "cosa%dc%d: starting tx(0x%x)", chan->cosa->num,
1274 for (i=0; i<len; i++)
1275 printk(" %02x", buf[i]&0xff);
1278 spin_lock_irqsave(&cosa->lock, flags);
1282 chan->txsize = COSA_MTU;
1283 spin_unlock_irqrestore(&cosa->lock, flags);
1285 /* Tell the firmware we are ready */
1286 set_bit(chan->num, &cosa->txbitmap);
1287 put_driver_status(cosa);
1292 static void put_driver_status(struct cosa_data *cosa)
1294 unsigned long flags;
1297 spin_lock_irqsave(&cosa->lock, flags);
1299 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1300 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1301 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1302 &DRIVER_TXMAP_MASK : 0);
1304 if (cosa->rxbitmap|cosa->txbitmap) {
1305 if (!cosa->enabled) {
1306 cosa_putstatus(cosa, SR_RX_INT_ENA);
1308 debug_status_out(cosa, SR_RX_INT_ENA);
1312 } else if (cosa->enabled) {
1314 cosa_putstatus(cosa, 0);
1316 debug_status_out(cosa, 0);
1319 cosa_putdata8(cosa, status);
1321 debug_data_cmd(cosa, status);
1324 spin_unlock_irqrestore(&cosa->lock, flags);
1327 static void put_driver_status_nolock(struct cosa_data *cosa)
1331 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1332 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1333 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1334 &DRIVER_TXMAP_MASK : 0);
1336 if (cosa->rxbitmap|cosa->txbitmap) {
1337 cosa_putstatus(cosa, SR_RX_INT_ENA);
1339 debug_status_out(cosa, SR_RX_INT_ENA);
1343 cosa_putstatus(cosa, 0);
1345 debug_status_out(cosa, 0);
1349 cosa_putdata8(cosa, status);
1351 debug_data_cmd(cosa, status);
1356 * The "kickme" function: When the DMA times out, this is called to
1357 * clean up the driver status.
1358 * FIXME: Preliminary support, the interface is probably wrong.
1360 static void cosa_kick(struct cosa_data *cosa)
1362 unsigned long flags, flags1;
1363 char *s = "(probably) IRQ";
1365 if (test_bit(RXBIT, &cosa->rxtx))
1367 if (test_bit(TXBIT, &cosa->rxtx))
1370 printk(KERN_INFO "%s: %s timeout - restarting.\n", cosa->name, s);
1371 spin_lock_irqsave(&cosa->lock, flags);
1374 flags1 = claim_dma_lock();
1375 disable_dma(cosa->dma);
1376 clear_dma_ff(cosa->dma);
1377 release_dma_lock(flags1);
1379 /* FIXME: Anything else? */
1381 cosa_putstatus(cosa, 0);
1383 (void) cosa_getdata8(cosa);
1385 cosa_putdata8(cosa, 0);
1387 put_driver_status_nolock(cosa);
1388 spin_unlock_irqrestore(&cosa->lock, flags);
1392 * Check if the whole buffer is DMA-able. It means it is below the 16M of
1393 * physical memory and doesn't span the 64k boundary. For now it seems
1394 * SKB's never do this, but we'll check this anyway.
1396 static int cosa_dma_able(struct channel_data *chan, char *buf, int len)
1399 unsigned long b = (unsigned long)buf;
1400 if (b+len >= MAX_DMA_ADDRESS)
1402 if ((b^ (b+len)) & 0x10000) {
1404 printk(KERN_INFO "%s: packet spanning a 64k boundary\n",
1412 /* ---------- The SRP/COSA ROM monitor functions ---------- */
1415 * Downloading SRP microcode: say "w" to SRP monitor, it answers by "w=",
1416 * drivers need to say 4-digit hex number meaning start address of the microcode
1417 * separated by a single space. Monitor replies by saying " =". Now driver
1418 * has to write 4-digit hex number meaning the last byte address ended
1419 * by a single space. Monitor has to reply with a space. Now the download
1420 * begins. After the download monitor replies with "\r\n." (CR LF dot).
1422 static int download(struct cosa_data *cosa, const char __user *microcode, int length, int address)
1426 if (put_wait_data(cosa, 'w') == -1) return -1;
1427 if ((i=get_wait_data(cosa)) != 'w') { printk("dnld: 0x%04x\n",i); return -2;}
1428 if (get_wait_data(cosa) != '=') return -3;
1430 if (puthexnumber(cosa, address) < 0) return -4;
1431 if (put_wait_data(cosa, ' ') == -1) return -10;
1432 if (get_wait_data(cosa) != ' ') return -11;
1433 if (get_wait_data(cosa) != '=') return -12;
1435 if (puthexnumber(cosa, address+length-1) < 0) return -13;
1436 if (put_wait_data(cosa, ' ') == -1) return -18;
1437 if (get_wait_data(cosa) != ' ') return -19;
1441 #ifndef SRP_DOWNLOAD_AT_BOOT
1442 if (get_user(c, microcode))
1443 return -23; /* ??? */
1447 if (put_wait_data(cosa, c) == -1)
1452 if (get_wait_data(cosa) != '\r') return -21;
1453 if (get_wait_data(cosa) != '\n') return -22;
1454 if (get_wait_data(cosa) != '.') return -23;
1456 printk(KERN_DEBUG "cosa%d: download completed.\n", cosa->num);
1463 * Starting microcode is done via the "g" command of the SRP monitor.
1464 * The chat should be the following: "g" "g=" "<addr><CR>"
1465 * "<CR><CR><LF><CR><LF>".
1467 static int startmicrocode(struct cosa_data *cosa, int address)
1469 if (put_wait_data(cosa, 'g') == -1) return -1;
1470 if (get_wait_data(cosa) != 'g') return -2;
1471 if (get_wait_data(cosa) != '=') return -3;
1473 if (puthexnumber(cosa, address) < 0) return -4;
1474 if (put_wait_data(cosa, '\r') == -1) return -5;
1476 if (get_wait_data(cosa) != '\r') return -6;
1477 if (get_wait_data(cosa) != '\r') return -7;
1478 if (get_wait_data(cosa) != '\n') return -8;
1479 if (get_wait_data(cosa) != '\r') return -9;
1480 if (get_wait_data(cosa) != '\n') return -10;
1482 printk(KERN_DEBUG "cosa%d: microcode started\n", cosa->num);
1488 * Reading memory is done via the "r" command of the SRP monitor.
1489 * The chat is the following "r" "r=" "<addr> " " =" "<last_byte> " " "
1490 * Then driver can read the data and the conversation is finished
1491 * by SRP monitor sending "<CR><LF>." (dot at the end).
1493 * This routine is not needed during the normal operation and serves
1494 * for debugging purposes only.
1496 static int readmem(struct cosa_data *cosa, char __user *microcode, int length, int address)
1498 if (put_wait_data(cosa, 'r') == -1) return -1;
1499 if ((get_wait_data(cosa)) != 'r') return -2;
1500 if ((get_wait_data(cosa)) != '=') return -3;
1502 if (puthexnumber(cosa, address) < 0) return -4;
1503 if (put_wait_data(cosa, ' ') == -1) return -5;
1504 if (get_wait_data(cosa) != ' ') return -6;
1505 if (get_wait_data(cosa) != '=') return -7;
1507 if (puthexnumber(cosa, address+length-1) < 0) return -8;
1508 if (put_wait_data(cosa, ' ') == -1) return -9;
1509 if (get_wait_data(cosa) != ' ') return -10;
1514 if ((i=get_wait_data(cosa)) == -1) {
1515 printk (KERN_INFO "cosa: 0x%04x bytes remaining\n",
1521 if (put_user(c, microcode))
1522 return -23; /* ??? */
1529 if (get_wait_data(cosa) != '\r') return -21;
1530 if (get_wait_data(cosa) != '\n') return -22;
1531 if (get_wait_data(cosa) != '.') return -23;
1533 printk(KERN_DEBUG "cosa%d: readmem completed.\n", cosa->num);
1539 * This function resets the device and reads the initial prompt
1540 * of the device's ROM monitor.
1542 static int cosa_reset_and_read_id(struct cosa_data *cosa, char *idstring)
1544 int i=0, id=0, prev=0, curr=0;
1546 /* Reset the card ... */
1547 cosa_putstatus(cosa, 0);
1548 cosa_getdata8(cosa);
1549 cosa_putstatus(cosa, SR_RST);
1555 /* Disable all IRQs from the card */
1556 cosa_putstatus(cosa, 0);
1559 * Try to read the ID string. The card then prints out the
1560 * identification string ended by the "\n\x2e".
1562 * The following loop is indexed through i (instead of id)
1563 * to avoid looping forever when for any reason
1564 * the port returns '\r', '\n' or '\x2e' permanently.
1566 for (i=0; i<COSA_MAX_ID_STRING-1; i++, prev=curr) {
1567 if ((curr = get_wait_data(cosa)) == -1) {
1571 if (curr != '\r' && curr != '\n' && curr != 0x2e)
1572 idstring[id++] = curr;
1573 if (curr == 0x2e && prev == '\n')
1576 /* Perhaps we should fail when i==COSA_MAX_ID_STRING-1 ? */
1577 idstring[id] = '\0';
1582 /* ---------- Auxiliary routines for COSA/SRP monitor ---------- */
1585 * This routine gets the data byte from the card waiting for the SR_RX_RDY
1586 * bit to be set in a loop. It should be used in the exceptional cases
1587 * only (for example when resetting the card or downloading the firmware.
1589 static int get_wait_data(struct cosa_data *cosa)
1594 /* read data and return them */
1595 if (cosa_getstatus(cosa) & SR_RX_RDY) {
1597 r = cosa_getdata8(cosa);
1599 printk(KERN_INFO "cosa: get_wait_data returning after %d retries\n", 999-retries);
1603 /* sleep if not ready to read */
1604 schedule_timeout_interruptible(1);
1606 printk(KERN_INFO "cosa: timeout in get_wait_data (status 0x%x)\n",
1607 cosa_getstatus(cosa));
1612 * This routine puts the data byte to the card waiting for the SR_TX_RDY
1613 * bit to be set in a loop. It should be used in the exceptional cases
1614 * only (for example when resetting the card or downloading the firmware).
1616 static int put_wait_data(struct cosa_data *cosa, int data)
1620 /* read data and return them */
1621 if (cosa_getstatus(cosa) & SR_TX_RDY) {
1622 cosa_putdata8(cosa, data);
1624 printk(KERN_INFO "Putdata: %d retries\n", 999-retries);
1629 /* sleep if not ready to read */
1630 schedule_timeout_interruptible(1);
1633 printk(KERN_INFO "cosa%d: timeout in put_wait_data (status 0x%x)\n",
1634 cosa->num, cosa_getstatus(cosa));
1639 * The following routine puts the hexadecimal number into the SRP monitor
1640 * and verifies the proper echo of the sent bytes. Returns 0 on success,
1641 * negative number on failure (-1,-3,-5,-7) means that put_wait_data() failed,
1642 * (-2,-4,-6,-8) means that reading echo failed.
1644 static int puthexnumber(struct cosa_data *cosa, int number)
1649 /* Well, I should probably replace this by something faster. */
1650 sprintf(temp, "%04X", number);
1651 for (i=0; i<4; i++) {
1652 if (put_wait_data(cosa, temp[i]) == -1) {
1653 printk(KERN_NOTICE "cosa%d: puthexnumber failed to write byte %d\n",
1657 if (get_wait_data(cosa) != temp[i]) {
1658 printk(KERN_NOTICE "cosa%d: puthexhumber failed to read echo of byte %d\n",
1667 /* ---------- Interrupt routines ---------- */
1670 * There are three types of interrupt:
1671 * At the beginning of transmit - this handled is in tx_interrupt(),
1672 * at the beginning of receive - it is in rx_interrupt() and
1673 * at the end of transmit/receive - it is the eot_interrupt() function.
1674 * These functions are multiplexed by cosa_interrupt() according to the
1675 * COSA status byte. I have moved the rx/tx/eot interrupt handling into
1676 * separate functions to make it more readable. These functions are inline,
1677 * so there should be no overhead of function call.
1679 * In the COSA bus-master mode, we need to tell the card the address of a
1680 * buffer. Unfortunately, COSA may be too slow for us, so we must busy-wait.
1681 * It's time to use the bottom half :-(
1685 * Transmit interrupt routine - called when COSA is willing to obtain
1686 * data from the OS. The most tricky part of the routine is selection
1687 * of channel we (OS) want to send packet for. For SRP we should probably
1688 * use the round-robin approach. The newer COSA firmwares have a simple
1689 * flow-control - in the status word has bits 2 and 3 set to 1 means that the
1690 * channel 0 or 1 doesn't want to receive data.
1692 * It seems there is a bug in COSA firmware (need to trace it further):
1693 * When the driver status says that the kernel has no more data for transmit
1694 * (e.g. at the end of TX DMA) and then the kernel changes its mind
1695 * (e.g. new packet is queued to hard_start_xmit()), the card issues
1696 * the TX interrupt but does not mark the channel as ready-to-transmit.
1697 * The fix seems to be to push the packet to COSA despite its request.
1698 * We first try to obey the card's opinion, and then fall back to forced TX.
1700 static inline void tx_interrupt(struct cosa_data *cosa, int status)
1702 unsigned long flags, flags1;
1704 printk(KERN_INFO "cosa%d: SR_DOWN_REQUEST status=0x%04x\n",
1707 spin_lock_irqsave(&cosa->lock, flags);
1708 set_bit(TXBIT, &cosa->rxtx);
1709 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1710 /* flow control, see the comment above */
1712 if (!cosa->txbitmap) {
1713 printk(KERN_WARNING "%s: No channel wants data "
1714 "in TX IRQ. Expect DMA timeout.",
1716 put_driver_status_nolock(cosa);
1717 clear_bit(TXBIT, &cosa->rxtx);
1718 spin_unlock_irqrestore(&cosa->lock, flags);
1724 if (cosa->txchan >= cosa->nchannels)
1726 if (!(cosa->txbitmap & (1<<cosa->txchan)))
1728 if (~status & (1 << (cosa->txchan+DRIVER_TXMAP_SHIFT)))
1730 /* in second pass, accept first ready-to-TX channel */
1731 if (i > cosa->nchannels) {
1732 /* Can be safely ignored */
1734 printk(KERN_DEBUG "%s: Forcing TX "
1735 "to not-ready channel %d\n",
1736 cosa->name, cosa->txchan);
1742 cosa->txsize = cosa->chan[cosa->txchan].txsize;
1743 if (cosa_dma_able(cosa->chan+cosa->txchan,
1744 cosa->chan[cosa->txchan].txbuf, cosa->txsize)) {
1745 cosa->txbuf = cosa->chan[cosa->txchan].txbuf;
1747 memcpy(cosa->bouncebuf, cosa->chan[cosa->txchan].txbuf,
1749 cosa->txbuf = cosa->bouncebuf;
1753 if (is_8bit(cosa)) {
1754 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1755 cosa_putstatus(cosa, SR_TX_INT_ENA);
1756 cosa_putdata8(cosa, ((cosa->txchan << 5) & 0xe0)|
1757 ((cosa->txsize >> 8) & 0x1f));
1759 debug_status_out(cosa, SR_TX_INT_ENA);
1760 debug_data_out(cosa, ((cosa->txchan << 5) & 0xe0)|
1761 ((cosa->txsize >> 8) & 0x1f));
1762 debug_data_in(cosa, cosa_getdata8(cosa));
1764 cosa_getdata8(cosa);
1766 set_bit(IRQBIT, &cosa->rxtx);
1767 spin_unlock_irqrestore(&cosa->lock, flags);
1770 clear_bit(IRQBIT, &cosa->rxtx);
1771 cosa_putstatus(cosa, 0);
1772 cosa_putdata8(cosa, cosa->txsize&0xff);
1774 debug_status_out(cosa, 0);
1775 debug_data_out(cosa, cosa->txsize&0xff);
1779 cosa_putstatus(cosa, SR_TX_INT_ENA);
1780 cosa_putdata16(cosa, ((cosa->txchan<<13) & 0xe000)
1781 | (cosa->txsize & 0x1fff));
1783 debug_status_out(cosa, SR_TX_INT_ENA);
1784 debug_data_out(cosa, ((cosa->txchan<<13) & 0xe000)
1785 | (cosa->txsize & 0x1fff));
1786 debug_data_in(cosa, cosa_getdata8(cosa));
1787 debug_status_out(cosa, 0);
1789 cosa_getdata8(cosa);
1791 cosa_putstatus(cosa, 0);
1794 if (cosa->busmaster) {
1795 unsigned long addr = virt_to_bus(cosa->txbuf);
1797 printk(KERN_INFO "busmaster IRQ\n");
1798 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1801 if (count > 1000) break;
1803 printk(KERN_INFO "status %x\n", cosa_getstatus(cosa));
1804 printk(KERN_INFO "ready after %d loops\n", count);
1805 cosa_putdata16(cosa, (addr >> 16)&0xffff);
1808 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1810 if (count > 1000) break;
1813 printk(KERN_INFO "ready after %d loops\n", count);
1814 cosa_putdata16(cosa, addr &0xffff);
1815 flags1 = claim_dma_lock();
1816 set_dma_mode(cosa->dma, DMA_MODE_CASCADE);
1817 enable_dma(cosa->dma);
1818 release_dma_lock(flags1);
1821 flags1 = claim_dma_lock();
1822 disable_dma(cosa->dma);
1823 clear_dma_ff(cosa->dma);
1824 set_dma_mode(cosa->dma, DMA_MODE_WRITE);
1825 set_dma_addr(cosa->dma, virt_to_bus(cosa->txbuf));
1826 set_dma_count(cosa->dma, cosa->txsize);
1827 enable_dma(cosa->dma);
1828 release_dma_lock(flags1);
1830 cosa_putstatus(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1832 debug_status_out(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1834 spin_unlock_irqrestore(&cosa->lock, flags);
1837 static inline void rx_interrupt(struct cosa_data *cosa, int status)
1839 unsigned long flags;
1841 printk(KERN_INFO "cosa%d: SR_UP_REQUEST\n", cosa->num);
1844 spin_lock_irqsave(&cosa->lock, flags);
1845 set_bit(RXBIT, &cosa->rxtx);
1847 if (is_8bit(cosa)) {
1848 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1849 set_bit(IRQBIT, &cosa->rxtx);
1850 put_driver_status_nolock(cosa);
1851 cosa->rxsize = cosa_getdata8(cosa) <<8;
1853 debug_data_in(cosa, cosa->rxsize >> 8);
1855 spin_unlock_irqrestore(&cosa->lock, flags);
1858 clear_bit(IRQBIT, &cosa->rxtx);
1859 cosa->rxsize |= cosa_getdata8(cosa) & 0xff;
1861 debug_data_in(cosa, cosa->rxsize & 0xff);
1864 printk(KERN_INFO "cosa%d: receive rxsize = (0x%04x).\n",
1865 cosa->num, cosa->rxsize);
1869 cosa->rxsize = cosa_getdata16(cosa);
1871 debug_data_in(cosa, cosa->rxsize);
1874 printk(KERN_INFO "cosa%d: receive rxsize = (0x%04x).\n",
1875 cosa->num, cosa->rxsize);
1878 if (((cosa->rxsize & 0xe000) >> 13) >= cosa->nchannels) {
1879 printk(KERN_WARNING "%s: rx for unknown channel (0x%04x)\n",
1880 cosa->name, cosa->rxsize);
1881 spin_unlock_irqrestore(&cosa->lock, flags);
1884 cosa->rxchan = cosa->chan + ((cosa->rxsize & 0xe000) >> 13);
1885 cosa->rxsize &= 0x1fff;
1886 spin_unlock_irqrestore(&cosa->lock, flags);
1889 if (cosa->rxchan->setup_rx)
1890 cosa->rxbuf = cosa->rxchan->setup_rx(cosa->rxchan, cosa->rxsize);
1893 reject: /* Reject the packet */
1894 printk(KERN_INFO "cosa%d: rejecting packet on channel %d\n",
1895 cosa->num, cosa->rxchan->num);
1896 cosa->rxbuf = cosa->bouncebuf;
1900 flags = claim_dma_lock();
1901 disable_dma(cosa->dma);
1902 clear_dma_ff(cosa->dma);
1903 set_dma_mode(cosa->dma, DMA_MODE_READ);
1904 if (cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize & 0x1fff)) {
1905 set_dma_addr(cosa->dma, virt_to_bus(cosa->rxbuf));
1907 set_dma_addr(cosa->dma, virt_to_bus(cosa->bouncebuf));
1909 set_dma_count(cosa->dma, (cosa->rxsize&0x1fff));
1910 enable_dma(cosa->dma);
1911 release_dma_lock(flags);
1912 spin_lock_irqsave(&cosa->lock, flags);
1913 cosa_putstatus(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1914 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1915 cosa_putdata8(cosa, DRIVER_RX_READY);
1917 debug_status_out(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1918 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1919 debug_data_cmd(cosa, DRIVER_RX_READY);
1921 spin_unlock_irqrestore(&cosa->lock, flags);
1924 static inline void eot_interrupt(struct cosa_data *cosa, int status)
1926 unsigned long flags, flags1;
1927 spin_lock_irqsave(&cosa->lock, flags);
1928 flags1 = claim_dma_lock();
1929 disable_dma(cosa->dma);
1930 clear_dma_ff(cosa->dma);
1931 release_dma_lock(flags1);
1932 if (test_bit(TXBIT, &cosa->rxtx)) {
1933 struct channel_data *chan = cosa->chan+cosa->txchan;
1935 if (chan->tx_done(chan, cosa->txsize))
1936 clear_bit(chan->num, &cosa->txbitmap);
1937 } else if (test_bit(RXBIT, &cosa->rxtx)) {
1941 printk(KERN_INFO "cosa%dc%d: done rx(0x%x)", cosa->num,
1942 cosa->rxchan->num, cosa->rxsize);
1943 for (i=0; i<cosa->rxsize; i++)
1944 printk (" %02x", cosa->rxbuf[i]&0xff);
1948 /* Packet for unknown channel? */
1949 if (cosa->rxbuf == cosa->bouncebuf)
1951 if (!cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize))
1952 memcpy(cosa->rxbuf, cosa->bouncebuf, cosa->rxsize);
1953 if (cosa->rxchan->rx_done)
1954 if (cosa->rxchan->rx_done(cosa->rxchan))
1955 clear_bit(cosa->rxchan->num, &cosa->rxbitmap);
1957 printk(KERN_NOTICE "cosa%d: unexpected EOT interrupt\n",
1961 * Clear the RXBIT, TXBIT and IRQBIT (the latest should be
1962 * cleared anyway). We should do it as soon as possible
1963 * so that we can tell the COSA we are done and to give it a time
1968 put_driver_status_nolock(cosa);
1969 spin_unlock_irqrestore(&cosa->lock, flags);
1972 static irqreturn_t cosa_interrupt(int irq, void *cosa_)
1976 struct cosa_data *cosa = cosa_;
1978 status = cosa_getstatus(cosa);
1980 printk(KERN_INFO "cosa%d: got IRQ, status 0x%02x\n", cosa->num,
1984 debug_status_in(cosa, status);
1986 switch (status & SR_CMD_FROM_SRP_MASK) {
1987 case SR_DOWN_REQUEST:
1988 tx_interrupt(cosa, status);
1991 rx_interrupt(cosa, status);
1993 case SR_END_OF_TRANSFER:
1994 eot_interrupt(cosa, status);
1997 /* We may be too fast for SRP. Try to wait a bit more. */
1998 if (count++ < 100) {
2002 printk(KERN_INFO "cosa%d: unknown status 0x%02x in IRQ after %d retries\n",
2003 cosa->num, status & 0xff, count);
2007 printk(KERN_INFO "%s: %d-times got unknown status in IRQ\n",
2010 printk(KERN_INFO "%s: returning from IRQ\n", cosa->name);
2016 /* ---------- I/O debugging routines ---------- */
2018 * These routines can be used to monitor COSA/SRP I/O and to printk()
2019 * the data being transferred on the data and status I/O port in a
2024 static void debug_status_in(struct cosa_data *cosa, int status)
2027 switch(status & SR_CMD_FROM_SRP_MASK) {
2031 case SR_DOWN_REQUEST:
2034 case SR_END_OF_TRANSFER:
2041 printk(KERN_INFO "%s: IO: status -> 0x%02x (%s%s%s%s)\n",
2044 status & SR_USR_RQ ? "USR_RQ|":"",
2045 status & SR_TX_RDY ? "TX_RDY|":"",
2046 status & SR_RX_RDY ? "RX_RDY|":"",
2050 static void debug_status_out(struct cosa_data *cosa, int status)
2052 printk(KERN_INFO "%s: IO: status <- 0x%02x (%s%s%s%s%s%s)\n",
2055 status & SR_RX_DMA_ENA ? "RXDMA|":"!rxdma|",
2056 status & SR_TX_DMA_ENA ? "TXDMA|":"!txdma|",
2057 status & SR_RST ? "RESET|":"",
2058 status & SR_USR_INT_ENA ? "USRINT|":"!usrint|",
2059 status & SR_TX_INT_ENA ? "TXINT|":"!txint|",
2060 status & SR_RX_INT_ENA ? "RXINT":"!rxint");
2063 static void debug_data_in(struct cosa_data *cosa, int data)
2065 printk(KERN_INFO "%s: IO: data -> 0x%04x\n", cosa->name, data);
2068 static void debug_data_out(struct cosa_data *cosa, int data)
2070 printk(KERN_INFO "%s: IO: data <- 0x%04x\n", cosa->name, data);
2073 static void debug_data_cmd(struct cosa_data *cosa, int data)
2075 printk(KERN_INFO "%s: IO: data <- 0x%04x (%s|%s)\n",
2077 data & SR_RDY_RCV ? "RX_RDY" : "!rx_rdy",
2078 data & SR_RDY_SND ? "TX_RDY" : "!tx_rdy");
2082 /* EOF -- this file has not been truncated */