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/smp_lock.h>
94 #include <linux/device.h>
96 #undef COSA_SLOW_IO /* for testing purposes only */
101 #include <asm/byteorder.h>
103 #include <net/syncppp.h>
106 /* Maximum length of the identification string. */
107 #define COSA_MAX_ID_STRING 128
109 /* Maximum length of the channel name */
110 #define COSA_MAX_NAME (sizeof("cosaXXXcXXX")+1)
112 /* Per-channel data structure */
114 struct channel_data {
115 void *if_ptr; /* General purpose pointer (used by SPPP) */
116 int usage; /* Usage count; >0 for chrdev, -1 for netdev */
117 int num; /* Number of the channel */
118 struct cosa_data *cosa; /* Pointer to the per-card structure */
119 int txsize; /* Size of transmitted data */
120 char *txbuf; /* Transmit buffer */
121 char name[COSA_MAX_NAME]; /* channel name */
123 /* The HW layer interface */
124 /* routine called from the RX interrupt */
125 char *(*setup_rx)(struct channel_data *channel, int size);
126 /* routine called when the RX is done (from the EOT interrupt) */
127 int (*rx_done)(struct channel_data *channel);
128 /* routine called when the TX is done (from the EOT interrupt) */
129 int (*tx_done)(struct channel_data *channel, int size);
131 /* Character device parts */
132 struct semaphore rsem, 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 long int rxbitmap, txbitmap; /* Bitmap of channels who are willing to send/receive data */
160 long int 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 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, struct pt_regs *regs);
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 class_device_create(cosa_class, NULL, MKDEV(cosa_major, i),
407 unregister_chrdev(cosa_major, "cosa");
411 module_init(cosa_init);
413 static void __exit cosa_exit(void)
415 struct cosa_data *cosa;
417 printk(KERN_INFO "Unloading the cosa module\n");
419 for (i=0; i<nr_cards; i++)
420 class_device_destroy(cosa_class, MKDEV(cosa_major, i));
421 class_destroy(cosa_class);
422 for (cosa=cosa_cards; nr_cards--; cosa++) {
423 /* Clean up the per-channel data */
424 for (i=0; i<cosa->nchannels; i++) {
425 /* Chardev driver has no alloc'd per-channel data */
426 sppp_channel_delete(cosa->chan+i);
428 /* Clean up the per-card data */
430 kfree(cosa->bouncebuf);
431 free_irq(cosa->irq, cosa);
433 release_region(cosa->datareg,is_8bit(cosa)?2:4);
435 unregister_chrdev(cosa_major, "cosa");
437 module_exit(cosa_exit);
440 * This function should register all the net devices needed for the
443 static __inline__ void channel_init(struct channel_data *chan)
445 sprintf(chan->name, "cosa%dc%d", chan->cosa->num, chan->num);
447 /* Initialize the chardev data structures */
448 chardev_channel_init(chan);
450 /* Register the sppp interface */
451 sppp_channel_init(chan);
454 static int cosa_probe(int base, int irq, int dma)
456 struct cosa_data *cosa = cosa_cards+nr_cards;
459 memset(cosa, 0, sizeof(struct cosa_data));
461 /* Checking validity of parameters: */
462 /* IRQ should be 2-7 or 10-15; negative IRQ means autoprobe */
463 if ((irq >= 0 && irq < 2) || irq > 15 || (irq < 10 && irq > 7)) {
464 printk (KERN_INFO "cosa_probe: invalid IRQ %d\n", irq);
467 /* I/O address should be between 0x100 and 0x3ff and should be
469 if (base < 0x100 || base > 0x3ff || base & 0x7) {
470 printk (KERN_INFO "cosa_probe: invalid I/O address 0x%x\n",
474 /* DMA should be 0,1 or 3-7 */
475 if (dma < 0 || dma == 4 || dma > 7) {
476 printk (KERN_INFO "cosa_probe: invalid DMA %d\n", dma);
479 /* and finally, on 16-bit COSA DMA should be 4-7 and
480 * I/O base should not be multiple of 0x10 */
481 if (((base & 0x8) && dma < 4) || (!(base & 0x8) && dma > 3)) {
482 printk (KERN_INFO "cosa_probe: 8/16 bit base and DMA mismatch"
483 " (base=0x%x, dma=%d)\n", base, dma);
488 cosa->datareg = base;
489 cosa->statusreg = is_8bit(cosa)?base+1:base+2;
490 spin_lock_init(&cosa->lock);
492 if (!request_region(base, is_8bit(cosa)?2:4,"cosa"))
495 if (cosa_reset_and_read_id(cosa, cosa->id_string) < 0) {
496 printk(KERN_DEBUG "cosa: probe at 0x%x failed.\n", base);
501 /* Test the validity of identification string */
502 if (!strncmp(cosa->id_string, "SRP", 3))
504 else if (!strncmp(cosa->id_string, "COSA", 4))
505 cosa->type = is_8bit(cosa)? "cosa8": "cosa16";
507 /* Print a warning only if we are not autoprobing */
508 #ifndef COSA_ISA_AUTOPROBE
509 printk(KERN_INFO "cosa: valid signature not found at 0x%x.\n",
515 /* Update the name of the region now we know the type of card */
516 release_region(base, is_8bit(cosa)?2:4);
517 if (!request_region(base, is_8bit(cosa)?2:4, cosa->type)) {
518 printk(KERN_DEBUG "cosa: changing name at 0x%x failed.\n", base);
522 /* Now do IRQ autoprobe */
525 /* printk(KERN_INFO "IRQ autoprobe\n"); */
526 irqs = probe_irq_on();
528 * Enable interrupt on tx buffer empty (it sure is)
530 * FIXME: When this code is not used as module, we should
531 * probably call udelay() instead of the interruptible sleep.
533 set_current_state(TASK_INTERRUPTIBLE);
534 cosa_putstatus(cosa, SR_TX_INT_ENA);
535 schedule_timeout(30);
536 irq = probe_irq_off(irqs);
537 /* Disable all IRQs from the card */
538 cosa_putstatus(cosa, 0);
539 /* Empty the received data register */
543 printk (KERN_INFO "cosa IRQ autoprobe: multiple interrupts obtained (%d, board at 0x%x)\n",
549 printk (KERN_INFO "cosa IRQ autoprobe: no interrupt obtained (board at 0x%x)\n",
556 cosa->num = nr_cards;
558 cosa->nchannels = 2; /* FIXME: how to determine this? */
560 if (request_irq(cosa->irq, cosa_interrupt, 0, cosa->type, cosa)) {
564 if (request_dma(cosa->dma, cosa->type)) {
569 cosa->bouncebuf = kmalloc(COSA_MTU, GFP_KERNEL|GFP_DMA);
570 if (!cosa->bouncebuf) {
574 sprintf(cosa->name, "cosa%d", cosa->num);
576 /* Initialize the per-channel data */
577 cosa->chan = kmalloc(sizeof(struct channel_data)*cosa->nchannels,
583 memset(cosa->chan, 0, sizeof(struct channel_data)*cosa->nchannels);
584 for (i=0; i<cosa->nchannels; i++) {
585 cosa->chan[i].cosa = cosa;
586 cosa->chan[i].num = i;
587 channel_init(cosa->chan+i);
590 printk (KERN_INFO "cosa%d: %s (%s at 0x%x irq %d dma %d), %d channels\n",
591 cosa->num, cosa->id_string, cosa->type,
592 cosa->datareg, cosa->irq, cosa->dma, cosa->nchannels);
596 kfree(cosa->bouncebuf);
600 free_irq(cosa->irq, cosa);
602 release_region(cosa->datareg,is_8bit(cosa)?2:4);
603 printk(KERN_NOTICE "cosa%d: allocating resources failed\n",
609 /*---------- SPPP/HDLC netdevice ---------- */
611 static void cosa_setup(struct net_device *d)
613 d->open = cosa_sppp_open;
614 d->stop = cosa_sppp_close;
615 d->hard_start_xmit = cosa_sppp_tx;
616 d->do_ioctl = cosa_sppp_ioctl;
617 d->get_stats = cosa_net_stats;
618 d->tx_timeout = cosa_sppp_timeout;
619 d->watchdog_timeo = TX_TIMEOUT;
622 static void sppp_channel_init(struct channel_data *chan)
624 struct net_device *d;
625 chan->if_ptr = &chan->pppdev;
626 d = alloc_netdev(0, chan->name, cosa_setup);
628 printk(KERN_WARNING "%s: alloc_netdev failed.\n", chan->name);
631 chan->pppdev.dev = d;
632 d->base_addr = chan->cosa->datareg;
633 d->irq = chan->cosa->irq;
634 d->dma = chan->cosa->dma;
636 sppp_attach(&chan->pppdev);
637 if (register_netdev(d)) {
638 printk(KERN_WARNING "%s: register_netdev failed.\n", d->name);
641 chan->pppdev.dev = NULL;
646 static void sppp_channel_delete(struct channel_data *chan)
648 unregister_netdev(chan->pppdev.dev);
649 sppp_detach(chan->pppdev.dev);
650 free_netdev(chan->pppdev.dev);
651 chan->pppdev.dev = NULL;
654 static int cosa_sppp_open(struct net_device *d)
656 struct channel_data *chan = d->priv;
660 if (!(chan->cosa->firmware_status & COSA_FW_START)) {
661 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
662 chan->cosa->name, chan->cosa->firmware_status);
665 spin_lock_irqsave(&chan->cosa->lock, flags);
666 if (chan->usage != 0) {
667 printk(KERN_WARNING "%s: sppp_open called with usage count %d\n",
668 chan->name, chan->usage);
669 spin_unlock_irqrestore(&chan->cosa->lock, flags);
672 chan->setup_rx = sppp_setup_rx;
673 chan->tx_done = sppp_tx_done;
674 chan->rx_done = sppp_rx_done;
677 spin_unlock_irqrestore(&chan->cosa->lock, flags);
681 spin_lock_irqsave(&chan->cosa->lock, flags);
685 spin_unlock_irqrestore(&chan->cosa->lock, flags);
689 netif_start_queue(d);
690 cosa_enable_rx(chan);
694 static int cosa_sppp_tx(struct sk_buff *skb, struct net_device *dev)
696 struct channel_data *chan = dev->priv;
698 netif_stop_queue(dev);
701 cosa_start_tx(chan, skb->data, skb->len);
705 static void cosa_sppp_timeout(struct net_device *dev)
707 struct channel_data *chan = dev->priv;
709 if (test_bit(RXBIT, &chan->cosa->rxtx)) {
710 chan->stats.rx_errors++;
711 chan->stats.rx_missed_errors++;
713 chan->stats.tx_errors++;
714 chan->stats.tx_aborted_errors++;
716 cosa_kick(chan->cosa);
718 dev_kfree_skb(chan->tx_skb);
721 netif_wake_queue(dev);
724 static int cosa_sppp_close(struct net_device *d)
726 struct channel_data *chan = d->priv;
731 cosa_disable_rx(chan);
732 spin_lock_irqsave(&chan->cosa->lock, flags);
734 kfree_skb(chan->rx_skb);
738 kfree_skb(chan->tx_skb);
743 spin_unlock_irqrestore(&chan->cosa->lock, flags);
747 static char *sppp_setup_rx(struct channel_data *chan, int size)
750 * We can safely fall back to non-dma-able memory, because we have
751 * the cosa->bouncebuf pre-allocated.
754 kfree_skb(chan->rx_skb);
755 chan->rx_skb = dev_alloc_skb(size);
756 if (chan->rx_skb == NULL) {
757 printk(KERN_NOTICE "%s: Memory squeeze, dropping packet\n",
759 chan->stats.rx_dropped++;
762 chan->pppdev.dev->trans_start = jiffies;
763 return skb_put(chan->rx_skb, size);
766 static int sppp_rx_done(struct channel_data *chan)
769 printk(KERN_WARNING "%s: rx_done with empty skb!\n",
771 chan->stats.rx_errors++;
772 chan->stats.rx_frame_errors++;
775 chan->rx_skb->protocol = htons(ETH_P_WAN_PPP);
776 chan->rx_skb->dev = chan->pppdev.dev;
777 chan->rx_skb->mac.raw = chan->rx_skb->data;
778 chan->stats.rx_packets++;
779 chan->stats.rx_bytes += chan->cosa->rxsize;
780 netif_rx(chan->rx_skb);
782 chan->pppdev.dev->last_rx = jiffies;
787 static int sppp_tx_done(struct channel_data *chan, int size)
790 printk(KERN_WARNING "%s: tx_done with empty skb!\n",
792 chan->stats.tx_errors++;
793 chan->stats.tx_aborted_errors++;
796 dev_kfree_skb_irq(chan->tx_skb);
798 chan->stats.tx_packets++;
799 chan->stats.tx_bytes += size;
800 netif_wake_queue(chan->pppdev.dev);
804 static struct net_device_stats *cosa_net_stats(struct net_device *dev)
806 struct channel_data *chan = dev->priv;
811 /*---------- Character device ---------- */
813 static void chardev_channel_init(struct channel_data *chan)
815 init_MUTEX(&chan->rsem);
816 init_MUTEX(&chan->wsem);
819 static ssize_t cosa_read(struct file *file,
820 char __user *buf, size_t count, loff_t *ppos)
822 DECLARE_WAITQUEUE(wait, current);
824 struct channel_data *chan = file->private_data;
825 struct cosa_data *cosa = chan->cosa;
828 if (!(cosa->firmware_status & COSA_FW_START)) {
829 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
830 cosa->name, cosa->firmware_status);
833 if (down_interruptible(&chan->rsem))
836 if ((chan->rxdata = kmalloc(COSA_MTU, GFP_DMA|GFP_KERNEL)) == NULL) {
837 printk(KERN_INFO "%s: cosa_read() - OOM\n", cosa->name);
843 cosa_enable_rx(chan);
844 spin_lock_irqsave(&cosa->lock, flags);
845 add_wait_queue(&chan->rxwaitq, &wait);
846 while(!chan->rx_status) {
847 current->state = TASK_INTERRUPTIBLE;
848 spin_unlock_irqrestore(&cosa->lock, flags);
850 spin_lock_irqsave(&cosa->lock, flags);
851 if (signal_pending(current) && chan->rx_status == 0) {
853 remove_wait_queue(&chan->rxwaitq, &wait);
854 current->state = TASK_RUNNING;
855 spin_unlock_irqrestore(&cosa->lock, flags);
860 remove_wait_queue(&chan->rxwaitq, &wait);
861 current->state = TASK_RUNNING;
863 count = chan->rxsize;
864 spin_unlock_irqrestore(&cosa->lock, flags);
867 if (copy_to_user(buf, kbuf, count)) {
875 static char *chrdev_setup_rx(struct channel_data *chan, int size)
877 /* Expect size <= COSA_MTU */
882 static int chrdev_rx_done(struct channel_data *chan)
884 if (chan->rx_status) { /* Reader has died */
889 wake_up_interruptible(&chan->rxwaitq);
894 static ssize_t cosa_write(struct file *file,
895 const char __user *buf, size_t count, loff_t *ppos)
897 DECLARE_WAITQUEUE(wait, current);
898 struct channel_data *chan = file->private_data;
899 struct cosa_data *cosa = chan->cosa;
903 if (!(cosa->firmware_status & COSA_FW_START)) {
904 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
905 cosa->name, cosa->firmware_status);
908 if (down_interruptible(&chan->wsem))
911 if (count > COSA_MTU)
914 /* Allocate the buffer */
915 if ((kbuf = kmalloc(count, GFP_KERNEL|GFP_DMA)) == NULL) {
916 printk(KERN_NOTICE "%s: cosa_write() OOM - dropping packet\n",
921 if (copy_from_user(kbuf, buf, count)) {
927 cosa_start_tx(chan, kbuf, count);
929 spin_lock_irqsave(&cosa->lock, flags);
930 add_wait_queue(&chan->txwaitq, &wait);
931 while(!chan->tx_status) {
932 current->state = TASK_INTERRUPTIBLE;
933 spin_unlock_irqrestore(&cosa->lock, flags);
935 spin_lock_irqsave(&cosa->lock, flags);
936 if (signal_pending(current) && chan->tx_status == 0) {
938 remove_wait_queue(&chan->txwaitq, &wait);
939 current->state = TASK_RUNNING;
941 spin_unlock_irqrestore(&cosa->lock, flags);
945 remove_wait_queue(&chan->txwaitq, &wait);
946 current->state = TASK_RUNNING;
948 spin_unlock_irqrestore(&cosa->lock, flags);
953 static int chrdev_tx_done(struct channel_data *chan, int size)
955 if (chan->tx_status) { /* Writer was interrupted */
960 wake_up_interruptible(&chan->txwaitq);
964 static unsigned int cosa_poll(struct file *file, poll_table *poll)
966 printk(KERN_INFO "cosa_poll is here\n");
970 static int cosa_open(struct inode *inode, struct file *file)
972 struct cosa_data *cosa;
973 struct channel_data *chan;
977 if ((n=iminor(file->f_dentry->d_inode)>>CARD_MINOR_BITS)
982 if ((n=iminor(file->f_dentry->d_inode)
983 & ((1<<CARD_MINOR_BITS)-1)) >= cosa->nchannels)
985 chan = cosa->chan + n;
987 file->private_data = chan;
989 spin_lock_irqsave(&cosa->lock, flags);
991 if (chan->usage < 0) { /* in netdev mode */
992 spin_unlock_irqrestore(&cosa->lock, flags);
998 chan->tx_done = chrdev_tx_done;
999 chan->setup_rx = chrdev_setup_rx;
1000 chan->rx_done = chrdev_rx_done;
1001 spin_unlock_irqrestore(&cosa->lock, flags);
1005 static int cosa_release(struct inode *inode, struct file *file)
1007 struct channel_data *channel = file->private_data;
1008 struct cosa_data *cosa;
1009 unsigned long flags;
1011 cosa = channel->cosa;
1012 spin_lock_irqsave(&cosa->lock, flags);
1015 spin_unlock_irqrestore(&cosa->lock, flags);
1019 #ifdef COSA_FASYNC_WORKING
1020 static struct fasync_struct *fasync[256] = { NULL, };
1022 /* To be done ... */
1023 static int cosa_fasync(struct inode *inode, struct file *file, int on)
1025 int port = iminor(inode);
1026 int rv = fasync_helper(inode, file, on, &fasync[port]);
1027 return rv < 0 ? rv : 0;
1032 /* ---------- Ioctls ---------- */
1035 * Ioctl subroutines can safely be made inline, because they are called
1036 * only from cosa_ioctl().
1038 static inline int cosa_reset(struct cosa_data *cosa)
1040 char idstring[COSA_MAX_ID_STRING];
1041 if (cosa->usage > 1)
1042 printk(KERN_INFO "cosa%d: WARNING: reset requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1043 cosa->num, cosa->usage);
1044 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_START);
1045 if (cosa_reset_and_read_id(cosa, idstring) < 0) {
1046 printk(KERN_NOTICE "cosa%d: reset failed\n", cosa->num);
1049 printk(KERN_INFO "cosa%d: resetting device: %s\n", cosa->num,
1051 cosa->firmware_status |= COSA_FW_RESET;
1055 /* High-level function to download data into COSA memory. Calls download() */
1056 static inline int cosa_download(struct cosa_data *cosa, void __user *arg)
1058 struct cosa_download d;
1061 if (cosa->usage > 1)
1062 printk(KERN_INFO "%s: WARNING: download of microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1063 cosa->name, cosa->usage);
1064 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1065 printk(KERN_NOTICE "%s: reset the card first (status %d).\n",
1066 cosa->name, cosa->firmware_status);
1070 if (copy_from_user(&d, arg, sizeof(d)))
1073 if (d.addr < 0 || d.addr > COSA_MAX_FIRMWARE_SIZE)
1075 if (d.len < 0 || d.len > COSA_MAX_FIRMWARE_SIZE)
1079 /* If something fails, force the user to reset the card */
1080 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_DOWNLOAD);
1082 i = download(cosa, d.code, d.len, d.addr);
1084 printk(KERN_NOTICE "cosa%d: microcode download failed: %d\n",
1088 printk(KERN_INFO "cosa%d: downloading microcode - 0x%04x bytes at 0x%04x\n",
1089 cosa->num, d.len, d.addr);
1090 cosa->firmware_status |= COSA_FW_RESET|COSA_FW_DOWNLOAD;
1094 /* High-level function to read COSA memory. Calls readmem() */
1095 static inline int cosa_readmem(struct cosa_data *cosa, void __user *arg)
1097 struct cosa_download d;
1100 if (cosa->usage > 1)
1101 printk(KERN_INFO "cosa%d: WARNING: readmem requested with "
1102 "cosa->usage > 1 (%d). Odd things may happen.\n",
1103 cosa->num, cosa->usage);
1104 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1105 printk(KERN_NOTICE "%s: reset the card first (status %d).\n",
1106 cosa->name, cosa->firmware_status);
1110 if (copy_from_user(&d, arg, sizeof(d)))
1113 /* If something fails, force the user to reset the card */
1114 cosa->firmware_status &= ~COSA_FW_RESET;
1116 i = readmem(cosa, d.code, d.len, d.addr);
1118 printk(KERN_NOTICE "cosa%d: reading memory failed: %d\n",
1122 printk(KERN_INFO "cosa%d: reading card memory - 0x%04x bytes at 0x%04x\n",
1123 cosa->num, d.len, d.addr);
1124 cosa->firmware_status |= COSA_FW_RESET;
1128 /* High-level function to start microcode. Calls startmicrocode(). */
1129 static inline int cosa_start(struct cosa_data *cosa, int address)
1133 if (cosa->usage > 1)
1134 printk(KERN_INFO "cosa%d: WARNING: start microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1135 cosa->num, cosa->usage);
1137 if ((cosa->firmware_status & (COSA_FW_RESET|COSA_FW_DOWNLOAD))
1138 != (COSA_FW_RESET|COSA_FW_DOWNLOAD)) {
1139 printk(KERN_NOTICE "%s: download the microcode and/or reset the card first (status %d).\n",
1140 cosa->name, cosa->firmware_status);
1143 cosa->firmware_status &= ~COSA_FW_RESET;
1144 if ((i=startmicrocode(cosa, address)) < 0) {
1145 printk(KERN_NOTICE "cosa%d: start microcode at 0x%04x failed: %d\n",
1146 cosa->num, address, i);
1149 printk(KERN_INFO "cosa%d: starting microcode at 0x%04x\n",
1150 cosa->num, address);
1151 cosa->startaddr = address;
1152 cosa->firmware_status |= COSA_FW_START;
1156 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1157 static inline int cosa_getidstr(struct cosa_data *cosa, char __user *string)
1159 int l = strlen(cosa->id_string)+1;
1160 if (copy_to_user(string, cosa->id_string, l))
1165 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1166 static inline int cosa_gettype(struct cosa_data *cosa, char __user *string)
1168 int l = strlen(cosa->type)+1;
1169 if (copy_to_user(string, cosa->type, l))
1174 static int cosa_ioctl_common(struct cosa_data *cosa,
1175 struct channel_data *channel, unsigned int cmd, unsigned long arg)
1177 void __user *argp = (void __user *)arg;
1179 case COSAIORSET: /* Reset the device */
1180 if (!capable(CAP_NET_ADMIN))
1182 return cosa_reset(cosa);
1183 case COSAIOSTRT: /* Start the firmware */
1184 if (!capable(CAP_SYS_RAWIO))
1186 return cosa_start(cosa, arg);
1187 case COSAIODOWNLD: /* Download the firmware */
1188 if (!capable(CAP_SYS_RAWIO))
1191 return cosa_download(cosa, argp);
1193 if (!capable(CAP_SYS_RAWIO))
1195 return cosa_readmem(cosa, argp);
1197 return cosa_gettype(cosa, argp);
1199 return cosa_getidstr(cosa, argp);
1203 return cosa->nchannels;
1205 if (!capable(CAP_SYS_RAWIO))
1209 if (arg != COSA_BM_OFF && arg != COSA_BM_ON)
1211 cosa->busmaster = arg;
1214 return cosa->busmaster;
1216 return -ENOIOCTLCMD;
1219 static int cosa_sppp_ioctl(struct net_device *dev, struct ifreq *ifr,
1223 struct channel_data *chan = dev->priv;
1224 rv = cosa_ioctl_common(chan->cosa, chan, cmd, (unsigned long)ifr->ifr_data);
1225 if (rv == -ENOIOCTLCMD) {
1226 return sppp_do_ioctl(dev, ifr, cmd);
1231 static int cosa_chardev_ioctl(struct inode *inode, struct file *file,
1232 unsigned int cmd, unsigned long arg)
1234 struct channel_data *channel = file->private_data;
1235 struct cosa_data *cosa = channel->cosa;
1236 return cosa_ioctl_common(cosa, channel, cmd, arg);
1240 /*---------- HW layer interface ---------- */
1243 * The higher layer can bind itself to the HW layer by setting the callbacks
1244 * in the channel_data structure and by using these routines.
1246 static void cosa_enable_rx(struct channel_data *chan)
1248 struct cosa_data *cosa = chan->cosa;
1250 if (!test_and_set_bit(chan->num, &cosa->rxbitmap))
1251 put_driver_status(cosa);
1254 static void cosa_disable_rx(struct channel_data *chan)
1256 struct cosa_data *cosa = chan->cosa;
1258 if (test_and_clear_bit(chan->num, &cosa->rxbitmap))
1259 put_driver_status(cosa);
1263 * FIXME: This routine probably should check for cosa_start_tx() called when
1264 * the previous transmit is still unfinished. In this case the non-zero
1265 * return value should indicate to the caller that the queuing(sp?) up
1266 * the transmit has failed.
1268 static int cosa_start_tx(struct channel_data *chan, char *buf, int len)
1270 struct cosa_data *cosa = chan->cosa;
1271 unsigned long flags;
1275 printk(KERN_INFO "cosa%dc%d: starting tx(0x%x)", chan->cosa->num,
1277 for (i=0; i<len; i++)
1278 printk(" %02x", buf[i]&0xff);
1281 spin_lock_irqsave(&cosa->lock, flags);
1285 chan->txsize = COSA_MTU;
1286 spin_unlock_irqrestore(&cosa->lock, flags);
1288 /* Tell the firmware we are ready */
1289 set_bit(chan->num, &cosa->txbitmap);
1290 put_driver_status(cosa);
1295 static void put_driver_status(struct cosa_data *cosa)
1297 unsigned long flags;
1300 spin_lock_irqsave(&cosa->lock, flags);
1302 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1303 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1304 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1305 &DRIVER_TXMAP_MASK : 0);
1307 if (cosa->rxbitmap|cosa->txbitmap) {
1308 if (!cosa->enabled) {
1309 cosa_putstatus(cosa, SR_RX_INT_ENA);
1311 debug_status_out(cosa, SR_RX_INT_ENA);
1315 } else if (cosa->enabled) {
1317 cosa_putstatus(cosa, 0);
1319 debug_status_out(cosa, 0);
1322 cosa_putdata8(cosa, status);
1324 debug_data_cmd(cosa, status);
1327 spin_unlock_irqrestore(&cosa->lock, flags);
1330 static void put_driver_status_nolock(struct cosa_data *cosa)
1334 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1335 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1336 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1337 &DRIVER_TXMAP_MASK : 0);
1339 if (cosa->rxbitmap|cosa->txbitmap) {
1340 cosa_putstatus(cosa, SR_RX_INT_ENA);
1342 debug_status_out(cosa, SR_RX_INT_ENA);
1346 cosa_putstatus(cosa, 0);
1348 debug_status_out(cosa, 0);
1352 cosa_putdata8(cosa, status);
1354 debug_data_cmd(cosa, status);
1359 * The "kickme" function: When the DMA times out, this is called to
1360 * clean up the driver status.
1361 * FIXME: Preliminary support, the interface is probably wrong.
1363 static void cosa_kick(struct cosa_data *cosa)
1365 unsigned long flags, flags1;
1366 char *s = "(probably) IRQ";
1368 if (test_bit(RXBIT, &cosa->rxtx))
1370 if (test_bit(TXBIT, &cosa->rxtx))
1373 printk(KERN_INFO "%s: %s timeout - restarting.\n", cosa->name, s);
1374 spin_lock_irqsave(&cosa->lock, flags);
1377 flags1 = claim_dma_lock();
1378 disable_dma(cosa->dma);
1379 clear_dma_ff(cosa->dma);
1380 release_dma_lock(flags1);
1382 /* FIXME: Anything else? */
1384 cosa_putstatus(cosa, 0);
1386 (void) cosa_getdata8(cosa);
1388 cosa_putdata8(cosa, 0);
1390 put_driver_status_nolock(cosa);
1391 spin_unlock_irqrestore(&cosa->lock, flags);
1395 * Check if the whole buffer is DMA-able. It means it is below the 16M of
1396 * physical memory and doesn't span the 64k boundary. For now it seems
1397 * SKB's never do this, but we'll check this anyway.
1399 static int cosa_dma_able(struct channel_data *chan, char *buf, int len)
1402 unsigned long b = (unsigned long)buf;
1403 if (b+len >= MAX_DMA_ADDRESS)
1405 if ((b^ (b+len)) & 0x10000) {
1407 printk(KERN_INFO "%s: packet spanning a 64k boundary\n",
1415 /* ---------- The SRP/COSA ROM monitor functions ---------- */
1418 * Downloading SRP microcode: say "w" to SRP monitor, it answers by "w=",
1419 * drivers need to say 4-digit hex number meaning start address of the microcode
1420 * separated by a single space. Monitor replies by saying " =". Now driver
1421 * has to write 4-digit hex number meaning the last byte address ended
1422 * by a single space. Monitor has to reply with a space. Now the download
1423 * begins. After the download monitor replies with "\r\n." (CR LF dot).
1425 static int download(struct cosa_data *cosa, const char __user *microcode, int length, int address)
1429 if (put_wait_data(cosa, 'w') == -1) return -1;
1430 if ((i=get_wait_data(cosa)) != 'w') { printk("dnld: 0x%04x\n",i); return -2;}
1431 if (get_wait_data(cosa) != '=') return -3;
1433 if (puthexnumber(cosa, address) < 0) return -4;
1434 if (put_wait_data(cosa, ' ') == -1) return -10;
1435 if (get_wait_data(cosa) != ' ') return -11;
1436 if (get_wait_data(cosa) != '=') return -12;
1438 if (puthexnumber(cosa, address+length-1) < 0) return -13;
1439 if (put_wait_data(cosa, ' ') == -1) return -18;
1440 if (get_wait_data(cosa) != ' ') return -19;
1444 #ifndef SRP_DOWNLOAD_AT_BOOT
1445 if (get_user(c, microcode))
1446 return -23; /* ??? */
1450 if (put_wait_data(cosa, c) == -1)
1455 if (get_wait_data(cosa) != '\r') return -21;
1456 if (get_wait_data(cosa) != '\n') return -22;
1457 if (get_wait_data(cosa) != '.') return -23;
1459 printk(KERN_DEBUG "cosa%d: download completed.\n", cosa->num);
1466 * Starting microcode is done via the "g" command of the SRP monitor.
1467 * The chat should be the following: "g" "g=" "<addr><CR>"
1468 * "<CR><CR><LF><CR><LF>".
1470 static int startmicrocode(struct cosa_data *cosa, int address)
1472 if (put_wait_data(cosa, 'g') == -1) return -1;
1473 if (get_wait_data(cosa) != 'g') return -2;
1474 if (get_wait_data(cosa) != '=') return -3;
1476 if (puthexnumber(cosa, address) < 0) return -4;
1477 if (put_wait_data(cosa, '\r') == -1) return -5;
1479 if (get_wait_data(cosa) != '\r') return -6;
1480 if (get_wait_data(cosa) != '\r') return -7;
1481 if (get_wait_data(cosa) != '\n') return -8;
1482 if (get_wait_data(cosa) != '\r') return -9;
1483 if (get_wait_data(cosa) != '\n') return -10;
1485 printk(KERN_DEBUG "cosa%d: microcode started\n", cosa->num);
1491 * Reading memory is done via the "r" command of the SRP monitor.
1492 * The chat is the following "r" "r=" "<addr> " " =" "<last_byte> " " "
1493 * Then driver can read the data and the conversation is finished
1494 * by SRP monitor sending "<CR><LF>." (dot at the end).
1496 * This routine is not needed during the normal operation and serves
1497 * for debugging purposes only.
1499 static int readmem(struct cosa_data *cosa, char __user *microcode, int length, int address)
1501 if (put_wait_data(cosa, 'r') == -1) return -1;
1502 if ((get_wait_data(cosa)) != 'r') return -2;
1503 if ((get_wait_data(cosa)) != '=') return -3;
1505 if (puthexnumber(cosa, address) < 0) return -4;
1506 if (put_wait_data(cosa, ' ') == -1) return -5;
1507 if (get_wait_data(cosa) != ' ') return -6;
1508 if (get_wait_data(cosa) != '=') return -7;
1510 if (puthexnumber(cosa, address+length-1) < 0) return -8;
1511 if (put_wait_data(cosa, ' ') == -1) return -9;
1512 if (get_wait_data(cosa) != ' ') return -10;
1517 if ((i=get_wait_data(cosa)) == -1) {
1518 printk (KERN_INFO "cosa: 0x%04x bytes remaining\n",
1524 if (put_user(c, microcode))
1525 return -23; /* ??? */
1532 if (get_wait_data(cosa) != '\r') return -21;
1533 if (get_wait_data(cosa) != '\n') return -22;
1534 if (get_wait_data(cosa) != '.') return -23;
1536 printk(KERN_DEBUG "cosa%d: readmem completed.\n", cosa->num);
1542 * This function resets the device and reads the initial prompt
1543 * of the device's ROM monitor.
1545 static int cosa_reset_and_read_id(struct cosa_data *cosa, char *idstring)
1547 int i=0, id=0, prev=0, curr=0;
1549 /* Reset the card ... */
1550 cosa_putstatus(cosa, 0);
1551 cosa_getdata8(cosa);
1552 cosa_putstatus(cosa, SR_RST);
1558 /* Disable all IRQs from the card */
1559 cosa_putstatus(cosa, 0);
1562 * Try to read the ID string. The card then prints out the
1563 * identification string ended by the "\n\x2e".
1565 * The following loop is indexed through i (instead of id)
1566 * to avoid looping forever when for any reason
1567 * the port returns '\r', '\n' or '\x2e' permanently.
1569 for (i=0; i<COSA_MAX_ID_STRING-1; i++, prev=curr) {
1570 if ((curr = get_wait_data(cosa)) == -1) {
1574 if (curr != '\r' && curr != '\n' && curr != 0x2e)
1575 idstring[id++] = curr;
1576 if (curr == 0x2e && prev == '\n')
1579 /* Perhaps we should fail when i==COSA_MAX_ID_STRING-1 ? */
1580 idstring[id] = '\0';
1585 /* ---------- Auxiliary routines for COSA/SRP monitor ---------- */
1588 * This routine gets the data byte from the card waiting for the SR_RX_RDY
1589 * bit to be set in a loop. It should be used in the exceptional cases
1590 * only (for example when resetting the card or downloading the firmware.
1592 static int get_wait_data(struct cosa_data *cosa)
1597 /* read data and return them */
1598 if (cosa_getstatus(cosa) & SR_RX_RDY) {
1600 r = cosa_getdata8(cosa);
1602 printk(KERN_INFO "cosa: get_wait_data returning after %d retries\n", 999-retries);
1606 /* sleep if not ready to read */
1607 schedule_timeout_interruptible(1);
1609 printk(KERN_INFO "cosa: timeout in get_wait_data (status 0x%x)\n",
1610 cosa_getstatus(cosa));
1615 * This routine puts the data byte to the card waiting for the SR_TX_RDY
1616 * bit to be set in a loop. It should be used in the exceptional cases
1617 * only (for example when resetting the card or downloading the firmware).
1619 static int put_wait_data(struct cosa_data *cosa, int data)
1623 /* read data and return them */
1624 if (cosa_getstatus(cosa) & SR_TX_RDY) {
1625 cosa_putdata8(cosa, data);
1627 printk(KERN_INFO "Putdata: %d retries\n", 999-retries);
1632 /* sleep if not ready to read */
1633 schedule_timeout_interruptible(1);
1636 printk(KERN_INFO "cosa%d: timeout in put_wait_data (status 0x%x)\n",
1637 cosa->num, cosa_getstatus(cosa));
1642 * The following routine puts the hexadecimal number into the SRP monitor
1643 * and verifies the proper echo of the sent bytes. Returns 0 on success,
1644 * negative number on failure (-1,-3,-5,-7) means that put_wait_data() failed,
1645 * (-2,-4,-6,-8) means that reading echo failed.
1647 static int puthexnumber(struct cosa_data *cosa, int number)
1652 /* Well, I should probably replace this by something faster. */
1653 sprintf(temp, "%04X", number);
1654 for (i=0; i<4; i++) {
1655 if (put_wait_data(cosa, temp[i]) == -1) {
1656 printk(KERN_NOTICE "cosa%d: puthexnumber failed to write byte %d\n",
1660 if (get_wait_data(cosa) != temp[i]) {
1661 printk(KERN_NOTICE "cosa%d: puthexhumber failed to read echo of byte %d\n",
1670 /* ---------- Interrupt routines ---------- */
1673 * There are three types of interrupt:
1674 * At the beginning of transmit - this handled is in tx_interrupt(),
1675 * at the beginning of receive - it is in rx_interrupt() and
1676 * at the end of transmit/receive - it is the eot_interrupt() function.
1677 * These functions are multiplexed by cosa_interrupt() according to the
1678 * COSA status byte. I have moved the rx/tx/eot interrupt handling into
1679 * separate functions to make it more readable. These functions are inline,
1680 * so there should be no overhead of function call.
1682 * In the COSA bus-master mode, we need to tell the card the address of a
1683 * buffer. Unfortunately, COSA may be too slow for us, so we must busy-wait.
1684 * It's time to use the bottom half :-(
1688 * Transmit interrupt routine - called when COSA is willing to obtain
1689 * data from the OS. The most tricky part of the routine is selection
1690 * of channel we (OS) want to send packet for. For SRP we should probably
1691 * use the round-robin approach. The newer COSA firmwares have a simple
1692 * flow-control - in the status word has bits 2 and 3 set to 1 means that the
1693 * channel 0 or 1 doesn't want to receive data.
1695 * It seems there is a bug in COSA firmware (need to trace it further):
1696 * When the driver status says that the kernel has no more data for transmit
1697 * (e.g. at the end of TX DMA) and then the kernel changes its mind
1698 * (e.g. new packet is queued to hard_start_xmit()), the card issues
1699 * the TX interrupt but does not mark the channel as ready-to-transmit.
1700 * The fix seems to be to push the packet to COSA despite its request.
1701 * We first try to obey the card's opinion, and then fall back to forced TX.
1703 static inline void tx_interrupt(struct cosa_data *cosa, int status)
1705 unsigned long flags, flags1;
1707 printk(KERN_INFO "cosa%d: SR_DOWN_REQUEST status=0x%04x\n",
1710 spin_lock_irqsave(&cosa->lock, flags);
1711 set_bit(TXBIT, &cosa->rxtx);
1712 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1713 /* flow control, see the comment above */
1715 if (!cosa->txbitmap) {
1716 printk(KERN_WARNING "%s: No channel wants data "
1717 "in TX IRQ. Expect DMA timeout.",
1719 put_driver_status_nolock(cosa);
1720 clear_bit(TXBIT, &cosa->rxtx);
1721 spin_unlock_irqrestore(&cosa->lock, flags);
1727 if (cosa->txchan >= cosa->nchannels)
1729 if (!(cosa->txbitmap & (1<<cosa->txchan)))
1731 if (~status & (1 << (cosa->txchan+DRIVER_TXMAP_SHIFT)))
1733 /* in second pass, accept first ready-to-TX channel */
1734 if (i > cosa->nchannels) {
1735 /* Can be safely ignored */
1737 printk(KERN_DEBUG "%s: Forcing TX "
1738 "to not-ready channel %d\n",
1739 cosa->name, cosa->txchan);
1745 cosa->txsize = cosa->chan[cosa->txchan].txsize;
1746 if (cosa_dma_able(cosa->chan+cosa->txchan,
1747 cosa->chan[cosa->txchan].txbuf, cosa->txsize)) {
1748 cosa->txbuf = cosa->chan[cosa->txchan].txbuf;
1750 memcpy(cosa->bouncebuf, cosa->chan[cosa->txchan].txbuf,
1752 cosa->txbuf = cosa->bouncebuf;
1756 if (is_8bit(cosa)) {
1757 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1758 cosa_putstatus(cosa, SR_TX_INT_ENA);
1759 cosa_putdata8(cosa, ((cosa->txchan << 5) & 0xe0)|
1760 ((cosa->txsize >> 8) & 0x1f));
1762 debug_status_out(cosa, SR_TX_INT_ENA);
1763 debug_data_out(cosa, ((cosa->txchan << 5) & 0xe0)|
1764 ((cosa->txsize >> 8) & 0x1f));
1765 debug_data_in(cosa, cosa_getdata8(cosa));
1767 cosa_getdata8(cosa);
1769 set_bit(IRQBIT, &cosa->rxtx);
1770 spin_unlock_irqrestore(&cosa->lock, flags);
1773 clear_bit(IRQBIT, &cosa->rxtx);
1774 cosa_putstatus(cosa, 0);
1775 cosa_putdata8(cosa, cosa->txsize&0xff);
1777 debug_status_out(cosa, 0);
1778 debug_data_out(cosa, cosa->txsize&0xff);
1782 cosa_putstatus(cosa, SR_TX_INT_ENA);
1783 cosa_putdata16(cosa, ((cosa->txchan<<13) & 0xe000)
1784 | (cosa->txsize & 0x1fff));
1786 debug_status_out(cosa, SR_TX_INT_ENA);
1787 debug_data_out(cosa, ((cosa->txchan<<13) & 0xe000)
1788 | (cosa->txsize & 0x1fff));
1789 debug_data_in(cosa, cosa_getdata8(cosa));
1790 debug_status_out(cosa, 0);
1792 cosa_getdata8(cosa);
1794 cosa_putstatus(cosa, 0);
1797 if (cosa->busmaster) {
1798 unsigned long addr = virt_to_bus(cosa->txbuf);
1800 printk(KERN_INFO "busmaster IRQ\n");
1801 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1804 if (count > 1000) break;
1806 printk(KERN_INFO "status %x\n", cosa_getstatus(cosa));
1807 printk(KERN_INFO "ready after %d loops\n", count);
1808 cosa_putdata16(cosa, (addr >> 16)&0xffff);
1811 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1813 if (count > 1000) break;
1816 printk(KERN_INFO "ready after %d loops\n", count);
1817 cosa_putdata16(cosa, addr &0xffff);
1818 flags1 = claim_dma_lock();
1819 set_dma_mode(cosa->dma, DMA_MODE_CASCADE);
1820 enable_dma(cosa->dma);
1821 release_dma_lock(flags1);
1824 flags1 = claim_dma_lock();
1825 disable_dma(cosa->dma);
1826 clear_dma_ff(cosa->dma);
1827 set_dma_mode(cosa->dma, DMA_MODE_WRITE);
1828 set_dma_addr(cosa->dma, virt_to_bus(cosa->txbuf));
1829 set_dma_count(cosa->dma, cosa->txsize);
1830 enable_dma(cosa->dma);
1831 release_dma_lock(flags1);
1833 cosa_putstatus(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1835 debug_status_out(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1837 spin_unlock_irqrestore(&cosa->lock, flags);
1840 static inline void rx_interrupt(struct cosa_data *cosa, int status)
1842 unsigned long flags;
1844 printk(KERN_INFO "cosa%d: SR_UP_REQUEST\n", cosa->num);
1847 spin_lock_irqsave(&cosa->lock, flags);
1848 set_bit(RXBIT, &cosa->rxtx);
1850 if (is_8bit(cosa)) {
1851 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1852 set_bit(IRQBIT, &cosa->rxtx);
1853 put_driver_status_nolock(cosa);
1854 cosa->rxsize = cosa_getdata8(cosa) <<8;
1856 debug_data_in(cosa, cosa->rxsize >> 8);
1858 spin_unlock_irqrestore(&cosa->lock, flags);
1861 clear_bit(IRQBIT, &cosa->rxtx);
1862 cosa->rxsize |= cosa_getdata8(cosa) & 0xff;
1864 debug_data_in(cosa, cosa->rxsize & 0xff);
1867 printk(KERN_INFO "cosa%d: receive rxsize = (0x%04x).\n",
1868 cosa->num, cosa->rxsize);
1872 cosa->rxsize = cosa_getdata16(cosa);
1874 debug_data_in(cosa, cosa->rxsize);
1877 printk(KERN_INFO "cosa%d: receive rxsize = (0x%04x).\n",
1878 cosa->num, cosa->rxsize);
1881 if (((cosa->rxsize & 0xe000) >> 13) >= cosa->nchannels) {
1882 printk(KERN_WARNING "%s: rx for unknown channel (0x%04x)\n",
1883 cosa->name, cosa->rxsize);
1884 spin_unlock_irqrestore(&cosa->lock, flags);
1887 cosa->rxchan = cosa->chan + ((cosa->rxsize & 0xe000) >> 13);
1888 cosa->rxsize &= 0x1fff;
1889 spin_unlock_irqrestore(&cosa->lock, flags);
1892 if (cosa->rxchan->setup_rx)
1893 cosa->rxbuf = cosa->rxchan->setup_rx(cosa->rxchan, cosa->rxsize);
1896 reject: /* Reject the packet */
1897 printk(KERN_INFO "cosa%d: rejecting packet on channel %d\n",
1898 cosa->num, cosa->rxchan->num);
1899 cosa->rxbuf = cosa->bouncebuf;
1903 flags = claim_dma_lock();
1904 disable_dma(cosa->dma);
1905 clear_dma_ff(cosa->dma);
1906 set_dma_mode(cosa->dma, DMA_MODE_READ);
1907 if (cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize & 0x1fff)) {
1908 set_dma_addr(cosa->dma, virt_to_bus(cosa->rxbuf));
1910 set_dma_addr(cosa->dma, virt_to_bus(cosa->bouncebuf));
1912 set_dma_count(cosa->dma, (cosa->rxsize&0x1fff));
1913 enable_dma(cosa->dma);
1914 release_dma_lock(flags);
1915 spin_lock_irqsave(&cosa->lock, flags);
1916 cosa_putstatus(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1917 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1918 cosa_putdata8(cosa, DRIVER_RX_READY);
1920 debug_status_out(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1921 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1922 debug_data_cmd(cosa, DRIVER_RX_READY);
1924 spin_unlock_irqrestore(&cosa->lock, flags);
1927 static inline void eot_interrupt(struct cosa_data *cosa, int status)
1929 unsigned long flags, flags1;
1930 spin_lock_irqsave(&cosa->lock, flags);
1931 flags1 = claim_dma_lock();
1932 disable_dma(cosa->dma);
1933 clear_dma_ff(cosa->dma);
1934 release_dma_lock(flags1);
1935 if (test_bit(TXBIT, &cosa->rxtx)) {
1936 struct channel_data *chan = cosa->chan+cosa->txchan;
1938 if (chan->tx_done(chan, cosa->txsize))
1939 clear_bit(chan->num, &cosa->txbitmap);
1940 } else if (test_bit(RXBIT, &cosa->rxtx)) {
1944 printk(KERN_INFO "cosa%dc%d: done rx(0x%x)", cosa->num,
1945 cosa->rxchan->num, cosa->rxsize);
1946 for (i=0; i<cosa->rxsize; i++)
1947 printk (" %02x", cosa->rxbuf[i]&0xff);
1951 /* Packet for unknown channel? */
1952 if (cosa->rxbuf == cosa->bouncebuf)
1954 if (!cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize))
1955 memcpy(cosa->rxbuf, cosa->bouncebuf, cosa->rxsize);
1956 if (cosa->rxchan->rx_done)
1957 if (cosa->rxchan->rx_done(cosa->rxchan))
1958 clear_bit(cosa->rxchan->num, &cosa->rxbitmap);
1960 printk(KERN_NOTICE "cosa%d: unexpected EOT interrupt\n",
1964 * Clear the RXBIT, TXBIT and IRQBIT (the latest should be
1965 * cleared anyway). We should do it as soon as possible
1966 * so that we can tell the COSA we are done and to give it a time
1971 put_driver_status_nolock(cosa);
1972 spin_unlock_irqrestore(&cosa->lock, flags);
1975 static irqreturn_t cosa_interrupt(int irq, void *cosa_, struct pt_regs *regs)
1979 struct cosa_data *cosa = cosa_;
1981 status = cosa_getstatus(cosa);
1983 printk(KERN_INFO "cosa%d: got IRQ, status 0x%02x\n", cosa->num,
1987 debug_status_in(cosa, status);
1989 switch (status & SR_CMD_FROM_SRP_MASK) {
1990 case SR_DOWN_REQUEST:
1991 tx_interrupt(cosa, status);
1994 rx_interrupt(cosa, status);
1996 case SR_END_OF_TRANSFER:
1997 eot_interrupt(cosa, status);
2000 /* We may be too fast for SRP. Try to wait a bit more. */
2001 if (count++ < 100) {
2005 printk(KERN_INFO "cosa%d: unknown status 0x%02x in IRQ after %d retries\n",
2006 cosa->num, status & 0xff, count);
2010 printk(KERN_INFO "%s: %d-times got unknown status in IRQ\n",
2013 printk(KERN_INFO "%s: returning from IRQ\n", cosa->name);
2019 /* ---------- I/O debugging routines ---------- */
2021 * These routines can be used to monitor COSA/SRP I/O and to printk()
2022 * the data being transferred on the data and status I/O port in a
2027 static void debug_status_in(struct cosa_data *cosa, int status)
2030 switch(status & SR_CMD_FROM_SRP_MASK) {
2034 case SR_DOWN_REQUEST:
2037 case SR_END_OF_TRANSFER:
2044 printk(KERN_INFO "%s: IO: status -> 0x%02x (%s%s%s%s)\n",
2047 status & SR_USR_RQ ? "USR_RQ|":"",
2048 status & SR_TX_RDY ? "TX_RDY|":"",
2049 status & SR_RX_RDY ? "RX_RDY|":"",
2053 static void debug_status_out(struct cosa_data *cosa, int status)
2055 printk(KERN_INFO "%s: IO: status <- 0x%02x (%s%s%s%s%s%s)\n",
2058 status & SR_RX_DMA_ENA ? "RXDMA|":"!rxdma|",
2059 status & SR_TX_DMA_ENA ? "TXDMA|":"!txdma|",
2060 status & SR_RST ? "RESET|":"",
2061 status & SR_USR_INT_ENA ? "USRINT|":"!usrint|",
2062 status & SR_TX_INT_ENA ? "TXINT|":"!txint|",
2063 status & SR_RX_INT_ENA ? "RXINT":"!rxint");
2066 static void debug_data_in(struct cosa_data *cosa, int data)
2068 printk(KERN_INFO "%s: IO: data -> 0x%04x\n", cosa->name, data);
2071 static void debug_data_out(struct cosa_data *cosa, int data)
2073 printk(KERN_INFO "%s: IO: data <- 0x%04x\n", cosa->name, data);
2076 static void debug_data_cmd(struct cosa_data *cosa, int data)
2078 printk(KERN_INFO "%s: IO: data <- 0x%04x (%s|%s)\n",
2080 data & SR_RDY_RCV ? "RX_RDY" : "!rx_rdy",
2081 data & SR_RDY_SND ? "TX_RDY" : "!tx_rdy");
2085 /* EOF -- this file has not been truncated */