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/device.h>
95 #undef COSA_SLOW_IO /* for testing purposes only */
99 #include <asm/byteorder.h>
101 #include <net/syncppp.h>
104 /* Maximum length of the identification string. */
105 #define COSA_MAX_ID_STRING 128
107 /* Maximum length of the channel name */
108 #define COSA_MAX_NAME (sizeof("cosaXXXcXXX")+1)
110 /* Per-channel data structure */
112 struct channel_data {
113 void *if_ptr; /* General purpose pointer (used by SPPP) */
114 int usage; /* Usage count; >0 for chrdev, -1 for netdev */
115 int num; /* Number of the channel */
116 struct cosa_data *cosa; /* Pointer to the per-card structure */
117 int txsize; /* Size of transmitted data */
118 char *txbuf; /* Transmit buffer */
119 char name[COSA_MAX_NAME]; /* channel name */
121 /* The HW layer interface */
122 /* routine called from the RX interrupt */
123 char *(*setup_rx)(struct channel_data *channel, int size);
124 /* routine called when the RX is done (from the EOT interrupt) */
125 int (*rx_done)(struct channel_data *channel);
126 /* routine called when the TX is done (from the EOT interrupt) */
127 int (*tx_done)(struct channel_data *channel, int size);
129 /* Character device parts */
130 struct semaphore rsem, wsem;
133 wait_queue_head_t txwaitq, rxwaitq;
134 int tx_status, rx_status;
136 /* SPPP/HDLC device parts */
137 struct ppp_device pppdev;
138 struct sk_buff *rx_skb, *tx_skb;
139 struct net_device_stats stats;
142 /* cosa->firmware_status bits */
143 #define COSA_FW_RESET (1<<0) /* Is the ROM monitor active? */
144 #define COSA_FW_DOWNLOAD (1<<1) /* Is the microcode downloaded? */
145 #define COSA_FW_START (1<<2) /* Is the microcode running? */
148 int num; /* Card number */
149 char name[COSA_MAX_NAME]; /* Card name - e.g "cosa0" */
150 unsigned int datareg, statusreg; /* I/O ports */
151 unsigned short irq, dma; /* IRQ and DMA number */
152 unsigned short startaddr; /* Firmware start address */
153 unsigned short busmaster; /* Use busmastering? */
154 int nchannels; /* # of channels on this card */
155 int driver_status; /* For communicating with firmware */
156 int firmware_status; /* Downloaded, reseted, etc. */
157 long int rxbitmap, txbitmap; /* Bitmap of channels who are willing to send/receive data */
158 long int rxtx; /* RX or TX in progress? */
160 int usage; /* usage count */
161 int txchan, txsize, rxsize;
162 struct channel_data *rxchan;
165 struct channel_data *chan;
166 spinlock_t lock; /* For exclusive operations on this structure */
167 char id_string[COSA_MAX_ID_STRING]; /* ROM monitor ID string */
168 char *type; /* card type */
172 * Define this if you want all the possible ports to be autoprobed.
173 * It is here but it probably is not a good idea to use this.
175 /* #define COSA_ISA_AUTOPROBE 1 */
178 * Character device major number. 117 was allocated for us.
179 * The value of 0 means to allocate a first free one.
181 static int cosa_major = 117;
184 * Encoding of the minor numbers:
185 * The lowest CARD_MINOR_BITS bits means the channel on the single card,
186 * the highest bits means the card number.
188 #define CARD_MINOR_BITS 4 /* How many bits in minor number are reserved
189 * for the single card */
191 * The following depends on CARD_MINOR_BITS. Unfortunately, the "MODULE_STRING"
192 * macro doesn't like anything other than the raw number as an argument :-(
195 /* #define MAX_CARDS (1 << (8-CARD_MINOR_BITS)) */
197 #define DRIVER_RX_READY 0x0001
198 #define DRIVER_TX_READY 0x0002
199 #define DRIVER_TXMAP_SHIFT 2
200 #define DRIVER_TXMAP_MASK 0x0c /* FIXME: 0xfc for 8-channel version */
203 * for cosa->rxtx - indicates whether either transmit or receive is
204 * in progress. These values are mean number of the bit.
210 #define COSA_MTU 2000 /* FIXME: I don't know this exactly */
212 #undef DEBUG_DATA //1 /* Dump the data read or written to the channel */
213 #undef DEBUG_IRQS //1 /* Print the message when the IRQ is received */
214 #undef DEBUG_IO //1 /* Dump the I/O traffic */
216 #define TX_TIMEOUT (5*HZ)
218 /* Maybe the following should be allocated dynamically */
219 static struct cosa_data cosa_cards[MAX_CARDS];
222 #ifdef COSA_ISA_AUTOPROBE
223 static int io[MAX_CARDS+1] = { 0x220, 0x228, 0x210, 0x218, 0, };
224 /* NOTE: DMA is not autoprobed!!! */
225 static int dma[MAX_CARDS+1] = { 1, 7, 1, 7, 1, 7, 1, 7, 0, };
227 static int io[MAX_CARDS+1];
228 static int dma[MAX_CARDS+1];
230 /* IRQ can be safely autoprobed */
231 static int irq[MAX_CARDS+1] = { -1, -1, -1, -1, -1, -1, 0, };
234 static struct class *cosa_class;
237 module_param_array(io, int, NULL, 0);
238 MODULE_PARM_DESC(io, "The I/O bases of the COSA or SRP cards");
239 module_param_array(irq, int, NULL, 0);
240 MODULE_PARM_DESC(irq, "The IRQ lines of the COSA or SRP cards");
241 module_param_array(dma, int, NULL, 0);
242 MODULE_PARM_DESC(dma, "The DMA channels of the COSA or SRP cards");
244 MODULE_AUTHOR("Jan \"Yenya\" Kasprzak, <kas@fi.muni.cz>");
245 MODULE_DESCRIPTION("Modular driver for the COSA or SRP synchronous card");
246 MODULE_LICENSE("GPL");
249 /* I use this mainly for testing purposes */
251 #define cosa_outb outb_p
252 #define cosa_outw outw_p
253 #define cosa_inb inb_p
254 #define cosa_inw inw_p
256 #define cosa_outb outb
257 #define cosa_outw outw
262 #define is_8bit(cosa) (!(cosa->datareg & 0x08))
264 #define cosa_getstatus(cosa) (cosa_inb(cosa->statusreg))
265 #define cosa_putstatus(cosa, stat) (cosa_outb(stat, cosa->statusreg))
266 #define cosa_getdata16(cosa) (cosa_inw(cosa->datareg))
267 #define cosa_getdata8(cosa) (cosa_inb(cosa->datareg))
268 #define cosa_putdata16(cosa, dt) (cosa_outw(dt, cosa->datareg))
269 #define cosa_putdata8(cosa, dt) (cosa_outb(dt, cosa->datareg))
271 /* Initialization stuff */
272 static int cosa_probe(int ioaddr, int irq, int dma);
275 static void cosa_enable_rx(struct channel_data *chan);
276 static void cosa_disable_rx(struct channel_data *chan);
277 static int cosa_start_tx(struct channel_data *channel, char *buf, int size);
278 static void cosa_kick(struct cosa_data *cosa);
279 static int cosa_dma_able(struct channel_data *chan, char *buf, int data);
281 /* SPPP/HDLC stuff */
282 static void sppp_channel_init(struct channel_data *chan);
283 static void sppp_channel_delete(struct channel_data *chan);
284 static int cosa_sppp_open(struct net_device *d);
285 static int cosa_sppp_close(struct net_device *d);
286 static void cosa_sppp_timeout(struct net_device *d);
287 static int cosa_sppp_tx(struct sk_buff *skb, struct net_device *d);
288 static char *sppp_setup_rx(struct channel_data *channel, int size);
289 static int sppp_rx_done(struct channel_data *channel);
290 static int sppp_tx_done(struct channel_data *channel, int size);
291 static int cosa_sppp_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
292 static struct net_device_stats *cosa_net_stats(struct net_device *dev);
294 /* Character device */
295 static void chardev_channel_init(struct channel_data *chan);
296 static char *chrdev_setup_rx(struct channel_data *channel, int size);
297 static int chrdev_rx_done(struct channel_data *channel);
298 static int chrdev_tx_done(struct channel_data *channel, int size);
299 static ssize_t cosa_read(struct file *file,
300 char __user *buf, size_t count, loff_t *ppos);
301 static ssize_t cosa_write(struct file *file,
302 const char __user *buf, size_t count, loff_t *ppos);
303 static unsigned int cosa_poll(struct file *file, poll_table *poll);
304 static int cosa_open(struct inode *inode, struct file *file);
305 static int cosa_release(struct inode *inode, struct file *file);
306 static int cosa_chardev_ioctl(struct inode *inode, struct file *file,
307 unsigned int cmd, unsigned long arg);
308 #ifdef COSA_FASYNC_WORKING
309 static int cosa_fasync(struct inode *inode, struct file *file, int on);
312 static const struct file_operations cosa_fops = {
313 .owner = THIS_MODULE,
318 .ioctl = cosa_chardev_ioctl,
320 .release = cosa_release,
321 #ifdef COSA_FASYNC_WORKING
322 .fasync = cosa_fasync,
327 static int cosa_start(struct cosa_data *cosa, int address);
328 static int cosa_reset(struct cosa_data *cosa);
329 static int cosa_download(struct cosa_data *cosa, void __user *a);
330 static int cosa_readmem(struct cosa_data *cosa, void __user *a);
332 /* COSA/SRP ROM monitor */
333 static int download(struct cosa_data *cosa, const char __user *data, int addr, int len);
334 static int startmicrocode(struct cosa_data *cosa, int address);
335 static int readmem(struct cosa_data *cosa, char __user *data, int addr, int len);
336 static int cosa_reset_and_read_id(struct cosa_data *cosa, char *id);
338 /* Auxilliary functions */
339 static int get_wait_data(struct cosa_data *cosa);
340 static int put_wait_data(struct cosa_data *cosa, int data);
341 static int puthexnumber(struct cosa_data *cosa, int number);
342 static void put_driver_status(struct cosa_data *cosa);
343 static void put_driver_status_nolock(struct cosa_data *cosa);
345 /* Interrupt handling */
346 static irqreturn_t cosa_interrupt(int irq, void *cosa);
348 /* I/O ops debugging */
350 static void debug_data_in(struct cosa_data *cosa, int data);
351 static void debug_data_out(struct cosa_data *cosa, int data);
352 static void debug_data_cmd(struct cosa_data *cosa, int data);
353 static void debug_status_in(struct cosa_data *cosa, int status);
354 static void debug_status_out(struct cosa_data *cosa, int status);
358 /* ---------- Initialization stuff ---------- */
360 static int __init cosa_init(void)
364 printk(KERN_INFO "cosa v1.08 (c) 1997-2000 Jan Kasprzak <kas@fi.muni.cz>\n");
366 printk(KERN_INFO "cosa: SMP found. Please mail any success/failure reports to the author.\n");
368 if (cosa_major > 0) {
369 if (register_chrdev(cosa_major, "cosa", &cosa_fops)) {
370 printk(KERN_WARNING "cosa: unable to get major %d\n",
376 if (!(cosa_major=register_chrdev(0, "cosa", &cosa_fops))) {
377 printk(KERN_WARNING "cosa: unable to register chardev\n");
382 for (i=0; i<MAX_CARDS; i++)
383 cosa_cards[i].num = -1;
384 for (i=0; io[i] != 0 && i < MAX_CARDS; i++)
385 cosa_probe(io[i], irq[i], dma[i]);
387 printk(KERN_WARNING "cosa: no devices found.\n");
388 unregister_chrdev(cosa_major, "cosa");
392 cosa_class = class_create(THIS_MODULE, "cosa");
393 if (IS_ERR(cosa_class)) {
394 err = PTR_ERR(cosa_class);
397 for (i=0; i<nr_cards; i++) {
398 class_device_create(cosa_class, NULL, MKDEV(cosa_major, i),
405 unregister_chrdev(cosa_major, "cosa");
409 module_init(cosa_init);
411 static void __exit cosa_exit(void)
413 struct cosa_data *cosa;
415 printk(KERN_INFO "Unloading the cosa module\n");
417 for (i=0; i<nr_cards; i++)
418 class_device_destroy(cosa_class, MKDEV(cosa_major, i));
419 class_destroy(cosa_class);
420 for (cosa=cosa_cards; nr_cards--; cosa++) {
421 /* Clean up the per-channel data */
422 for (i=0; i<cosa->nchannels; i++) {
423 /* Chardev driver has no alloc'd per-channel data */
424 sppp_channel_delete(cosa->chan+i);
426 /* Clean up the per-card data */
428 kfree(cosa->bouncebuf);
429 free_irq(cosa->irq, cosa);
431 release_region(cosa->datareg,is_8bit(cosa)?2:4);
433 unregister_chrdev(cosa_major, "cosa");
435 module_exit(cosa_exit);
438 * This function should register all the net devices needed for the
441 static __inline__ void channel_init(struct channel_data *chan)
443 sprintf(chan->name, "cosa%dc%d", chan->cosa->num, chan->num);
445 /* Initialize the chardev data structures */
446 chardev_channel_init(chan);
448 /* Register the sppp interface */
449 sppp_channel_init(chan);
452 static int cosa_probe(int base, int irq, int dma)
454 struct cosa_data *cosa = cosa_cards+nr_cards;
457 memset(cosa, 0, sizeof(struct cosa_data));
459 /* Checking validity of parameters: */
460 /* IRQ should be 2-7 or 10-15; negative IRQ means autoprobe */
461 if ((irq >= 0 && irq < 2) || irq > 15 || (irq < 10 && irq > 7)) {
462 printk (KERN_INFO "cosa_probe: invalid IRQ %d\n", irq);
465 /* I/O address should be between 0x100 and 0x3ff and should be
467 if (base < 0x100 || base > 0x3ff || base & 0x7) {
468 printk (KERN_INFO "cosa_probe: invalid I/O address 0x%x\n",
472 /* DMA should be 0,1 or 3-7 */
473 if (dma < 0 || dma == 4 || dma > 7) {
474 printk (KERN_INFO "cosa_probe: invalid DMA %d\n", dma);
477 /* and finally, on 16-bit COSA DMA should be 4-7 and
478 * I/O base should not be multiple of 0x10 */
479 if (((base & 0x8) && dma < 4) || (!(base & 0x8) && dma > 3)) {
480 printk (KERN_INFO "cosa_probe: 8/16 bit base and DMA mismatch"
481 " (base=0x%x, dma=%d)\n", base, dma);
486 cosa->datareg = base;
487 cosa->statusreg = is_8bit(cosa)?base+1:base+2;
488 spin_lock_init(&cosa->lock);
490 if (!request_region(base, is_8bit(cosa)?2:4,"cosa"))
493 if (cosa_reset_and_read_id(cosa, cosa->id_string) < 0) {
494 printk(KERN_DEBUG "cosa: probe at 0x%x failed.\n", base);
499 /* Test the validity of identification string */
500 if (!strncmp(cosa->id_string, "SRP", 3))
502 else if (!strncmp(cosa->id_string, "COSA", 4))
503 cosa->type = is_8bit(cosa)? "cosa8": "cosa16";
505 /* Print a warning only if we are not autoprobing */
506 #ifndef COSA_ISA_AUTOPROBE
507 printk(KERN_INFO "cosa: valid signature not found at 0x%x.\n",
513 /* Update the name of the region now we know the type of card */
514 release_region(base, is_8bit(cosa)?2:4);
515 if (!request_region(base, is_8bit(cosa)?2:4, cosa->type)) {
516 printk(KERN_DEBUG "cosa: changing name at 0x%x failed.\n", base);
520 /* Now do IRQ autoprobe */
523 /* printk(KERN_INFO "IRQ autoprobe\n"); */
524 irqs = probe_irq_on();
526 * Enable interrupt on tx buffer empty (it sure is)
528 * FIXME: When this code is not used as module, we should
529 * probably call udelay() instead of the interruptible sleep.
531 set_current_state(TASK_INTERRUPTIBLE);
532 cosa_putstatus(cosa, SR_TX_INT_ENA);
533 schedule_timeout(30);
534 irq = probe_irq_off(irqs);
535 /* Disable all IRQs from the card */
536 cosa_putstatus(cosa, 0);
537 /* Empty the received data register */
541 printk (KERN_INFO "cosa IRQ autoprobe: multiple interrupts obtained (%d, board at 0x%x)\n",
547 printk (KERN_INFO "cosa IRQ autoprobe: no interrupt obtained (board at 0x%x)\n",
554 cosa->num = nr_cards;
556 cosa->nchannels = 2; /* FIXME: how to determine this? */
558 if (request_irq(cosa->irq, cosa_interrupt, 0, cosa->type, cosa)) {
562 if (request_dma(cosa->dma, cosa->type)) {
567 cosa->bouncebuf = kmalloc(COSA_MTU, GFP_KERNEL|GFP_DMA);
568 if (!cosa->bouncebuf) {
572 sprintf(cosa->name, "cosa%d", cosa->num);
574 /* Initialize the per-channel data */
575 cosa->chan = kmalloc(sizeof(struct channel_data)*cosa->nchannels,
581 memset(cosa->chan, 0, sizeof(struct channel_data)*cosa->nchannels);
582 for (i=0; i<cosa->nchannels; i++) {
583 cosa->chan[i].cosa = cosa;
584 cosa->chan[i].num = i;
585 channel_init(cosa->chan+i);
588 printk (KERN_INFO "cosa%d: %s (%s at 0x%x irq %d dma %d), %d channels\n",
589 cosa->num, cosa->id_string, cosa->type,
590 cosa->datareg, cosa->irq, cosa->dma, cosa->nchannels);
594 kfree(cosa->bouncebuf);
598 free_irq(cosa->irq, cosa);
600 release_region(cosa->datareg,is_8bit(cosa)?2:4);
601 printk(KERN_NOTICE "cosa%d: allocating resources failed\n",
607 /*---------- SPPP/HDLC netdevice ---------- */
609 static void cosa_setup(struct net_device *d)
611 d->open = cosa_sppp_open;
612 d->stop = cosa_sppp_close;
613 d->hard_start_xmit = cosa_sppp_tx;
614 d->do_ioctl = cosa_sppp_ioctl;
615 d->get_stats = cosa_net_stats;
616 d->tx_timeout = cosa_sppp_timeout;
617 d->watchdog_timeo = TX_TIMEOUT;
620 static void sppp_channel_init(struct channel_data *chan)
622 struct net_device *d;
623 chan->if_ptr = &chan->pppdev;
624 d = alloc_netdev(0, chan->name, cosa_setup);
626 printk(KERN_WARNING "%s: alloc_netdev failed.\n", chan->name);
629 chan->pppdev.dev = d;
630 d->base_addr = chan->cosa->datareg;
631 d->irq = chan->cosa->irq;
632 d->dma = chan->cosa->dma;
634 sppp_attach(&chan->pppdev);
635 if (register_netdev(d)) {
636 printk(KERN_WARNING "%s: register_netdev failed.\n", d->name);
639 chan->pppdev.dev = NULL;
644 static void sppp_channel_delete(struct channel_data *chan)
646 unregister_netdev(chan->pppdev.dev);
647 sppp_detach(chan->pppdev.dev);
648 free_netdev(chan->pppdev.dev);
649 chan->pppdev.dev = NULL;
652 static int cosa_sppp_open(struct net_device *d)
654 struct channel_data *chan = d->priv;
658 if (!(chan->cosa->firmware_status & COSA_FW_START)) {
659 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
660 chan->cosa->name, chan->cosa->firmware_status);
663 spin_lock_irqsave(&chan->cosa->lock, flags);
664 if (chan->usage != 0) {
665 printk(KERN_WARNING "%s: sppp_open called with usage count %d\n",
666 chan->name, chan->usage);
667 spin_unlock_irqrestore(&chan->cosa->lock, flags);
670 chan->setup_rx = sppp_setup_rx;
671 chan->tx_done = sppp_tx_done;
672 chan->rx_done = sppp_rx_done;
675 spin_unlock_irqrestore(&chan->cosa->lock, flags);
679 spin_lock_irqsave(&chan->cosa->lock, flags);
683 spin_unlock_irqrestore(&chan->cosa->lock, flags);
687 netif_start_queue(d);
688 cosa_enable_rx(chan);
692 static int cosa_sppp_tx(struct sk_buff *skb, struct net_device *dev)
694 struct channel_data *chan = dev->priv;
696 netif_stop_queue(dev);
699 cosa_start_tx(chan, skb->data, skb->len);
703 static void cosa_sppp_timeout(struct net_device *dev)
705 struct channel_data *chan = dev->priv;
707 if (test_bit(RXBIT, &chan->cosa->rxtx)) {
708 chan->stats.rx_errors++;
709 chan->stats.rx_missed_errors++;
711 chan->stats.tx_errors++;
712 chan->stats.tx_aborted_errors++;
714 cosa_kick(chan->cosa);
716 dev_kfree_skb(chan->tx_skb);
719 netif_wake_queue(dev);
722 static int cosa_sppp_close(struct net_device *d)
724 struct channel_data *chan = d->priv;
729 cosa_disable_rx(chan);
730 spin_lock_irqsave(&chan->cosa->lock, flags);
732 kfree_skb(chan->rx_skb);
736 kfree_skb(chan->tx_skb);
741 spin_unlock_irqrestore(&chan->cosa->lock, flags);
745 static char *sppp_setup_rx(struct channel_data *chan, int size)
748 * We can safely fall back to non-dma-able memory, because we have
749 * the cosa->bouncebuf pre-allocated.
752 kfree_skb(chan->rx_skb);
753 chan->rx_skb = dev_alloc_skb(size);
754 if (chan->rx_skb == NULL) {
755 printk(KERN_NOTICE "%s: Memory squeeze, dropping packet\n",
757 chan->stats.rx_dropped++;
760 chan->pppdev.dev->trans_start = jiffies;
761 return skb_put(chan->rx_skb, size);
764 static int sppp_rx_done(struct channel_data *chan)
767 printk(KERN_WARNING "%s: rx_done with empty skb!\n",
769 chan->stats.rx_errors++;
770 chan->stats.rx_frame_errors++;
773 chan->rx_skb->protocol = htons(ETH_P_WAN_PPP);
774 chan->rx_skb->dev = chan->pppdev.dev;
775 skb_reset_mac_header(chan->rx_skb);
776 chan->stats.rx_packets++;
777 chan->stats.rx_bytes += chan->cosa->rxsize;
778 netif_rx(chan->rx_skb);
780 chan->pppdev.dev->last_rx = jiffies;
785 static int sppp_tx_done(struct channel_data *chan, int size)
788 printk(KERN_WARNING "%s: tx_done with empty skb!\n",
790 chan->stats.tx_errors++;
791 chan->stats.tx_aborted_errors++;
794 dev_kfree_skb_irq(chan->tx_skb);
796 chan->stats.tx_packets++;
797 chan->stats.tx_bytes += size;
798 netif_wake_queue(chan->pppdev.dev);
802 static struct net_device_stats *cosa_net_stats(struct net_device *dev)
804 struct channel_data *chan = dev->priv;
809 /*---------- Character device ---------- */
811 static void chardev_channel_init(struct channel_data *chan)
813 init_MUTEX(&chan->rsem);
814 init_MUTEX(&chan->wsem);
817 static ssize_t cosa_read(struct file *file,
818 char __user *buf, size_t count, loff_t *ppos)
820 DECLARE_WAITQUEUE(wait, current);
822 struct channel_data *chan = file->private_data;
823 struct cosa_data *cosa = chan->cosa;
826 if (!(cosa->firmware_status & COSA_FW_START)) {
827 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
828 cosa->name, cosa->firmware_status);
831 if (down_interruptible(&chan->rsem))
834 if ((chan->rxdata = kmalloc(COSA_MTU, GFP_DMA|GFP_KERNEL)) == NULL) {
835 printk(KERN_INFO "%s: cosa_read() - OOM\n", cosa->name);
841 cosa_enable_rx(chan);
842 spin_lock_irqsave(&cosa->lock, flags);
843 add_wait_queue(&chan->rxwaitq, &wait);
844 while(!chan->rx_status) {
845 current->state = TASK_INTERRUPTIBLE;
846 spin_unlock_irqrestore(&cosa->lock, flags);
848 spin_lock_irqsave(&cosa->lock, flags);
849 if (signal_pending(current) && chan->rx_status == 0) {
851 remove_wait_queue(&chan->rxwaitq, &wait);
852 current->state = TASK_RUNNING;
853 spin_unlock_irqrestore(&cosa->lock, flags);
858 remove_wait_queue(&chan->rxwaitq, &wait);
859 current->state = TASK_RUNNING;
861 count = chan->rxsize;
862 spin_unlock_irqrestore(&cosa->lock, flags);
865 if (copy_to_user(buf, kbuf, count)) {
873 static char *chrdev_setup_rx(struct channel_data *chan, int size)
875 /* Expect size <= COSA_MTU */
880 static int chrdev_rx_done(struct channel_data *chan)
882 if (chan->rx_status) { /* Reader has died */
887 wake_up_interruptible(&chan->rxwaitq);
892 static ssize_t cosa_write(struct file *file,
893 const char __user *buf, size_t count, loff_t *ppos)
895 DECLARE_WAITQUEUE(wait, current);
896 struct channel_data *chan = file->private_data;
897 struct cosa_data *cosa = chan->cosa;
901 if (!(cosa->firmware_status & COSA_FW_START)) {
902 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
903 cosa->name, cosa->firmware_status);
906 if (down_interruptible(&chan->wsem))
909 if (count > COSA_MTU)
912 /* Allocate the buffer */
913 if ((kbuf = kmalloc(count, GFP_KERNEL|GFP_DMA)) == NULL) {
914 printk(KERN_NOTICE "%s: cosa_write() OOM - dropping packet\n",
919 if (copy_from_user(kbuf, buf, count)) {
925 cosa_start_tx(chan, kbuf, count);
927 spin_lock_irqsave(&cosa->lock, flags);
928 add_wait_queue(&chan->txwaitq, &wait);
929 while(!chan->tx_status) {
930 current->state = TASK_INTERRUPTIBLE;
931 spin_unlock_irqrestore(&cosa->lock, flags);
933 spin_lock_irqsave(&cosa->lock, flags);
934 if (signal_pending(current) && chan->tx_status == 0) {
936 remove_wait_queue(&chan->txwaitq, &wait);
937 current->state = TASK_RUNNING;
939 spin_unlock_irqrestore(&cosa->lock, flags);
943 remove_wait_queue(&chan->txwaitq, &wait);
944 current->state = TASK_RUNNING;
946 spin_unlock_irqrestore(&cosa->lock, flags);
951 static int chrdev_tx_done(struct channel_data *chan, int size)
953 if (chan->tx_status) { /* Writer was interrupted */
958 wake_up_interruptible(&chan->txwaitq);
962 static unsigned int cosa_poll(struct file *file, poll_table *poll)
964 printk(KERN_INFO "cosa_poll is here\n");
968 static int cosa_open(struct inode *inode, struct file *file)
970 struct cosa_data *cosa;
971 struct channel_data *chan;
975 if ((n=iminor(file->f_path.dentry->d_inode)>>CARD_MINOR_BITS)
980 if ((n=iminor(file->f_path.dentry->d_inode)
981 & ((1<<CARD_MINOR_BITS)-1)) >= cosa->nchannels)
983 chan = cosa->chan + n;
985 file->private_data = chan;
987 spin_lock_irqsave(&cosa->lock, flags);
989 if (chan->usage < 0) { /* in netdev mode */
990 spin_unlock_irqrestore(&cosa->lock, flags);
996 chan->tx_done = chrdev_tx_done;
997 chan->setup_rx = chrdev_setup_rx;
998 chan->rx_done = chrdev_rx_done;
999 spin_unlock_irqrestore(&cosa->lock, flags);
1003 static int cosa_release(struct inode *inode, struct file *file)
1005 struct channel_data *channel = file->private_data;
1006 struct cosa_data *cosa;
1007 unsigned long flags;
1009 cosa = channel->cosa;
1010 spin_lock_irqsave(&cosa->lock, flags);
1013 spin_unlock_irqrestore(&cosa->lock, flags);
1017 #ifdef COSA_FASYNC_WORKING
1018 static struct fasync_struct *fasync[256] = { NULL, };
1020 /* To be done ... */
1021 static int cosa_fasync(struct inode *inode, struct file *file, int on)
1023 int port = iminor(inode);
1024 int rv = fasync_helper(inode, file, on, &fasync[port]);
1025 return rv < 0 ? rv : 0;
1030 /* ---------- Ioctls ---------- */
1033 * Ioctl subroutines can safely be made inline, because they are called
1034 * only from cosa_ioctl().
1036 static inline int cosa_reset(struct cosa_data *cosa)
1038 char idstring[COSA_MAX_ID_STRING];
1039 if (cosa->usage > 1)
1040 printk(KERN_INFO "cosa%d: WARNING: reset requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1041 cosa->num, cosa->usage);
1042 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_START);
1043 if (cosa_reset_and_read_id(cosa, idstring) < 0) {
1044 printk(KERN_NOTICE "cosa%d: reset failed\n", cosa->num);
1047 printk(KERN_INFO "cosa%d: resetting device: %s\n", cosa->num,
1049 cosa->firmware_status |= COSA_FW_RESET;
1053 /* High-level function to download data into COSA memory. Calls download() */
1054 static inline int cosa_download(struct cosa_data *cosa, void __user *arg)
1056 struct cosa_download d;
1059 if (cosa->usage > 1)
1060 printk(KERN_INFO "%s: WARNING: download of microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1061 cosa->name, cosa->usage);
1062 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1063 printk(KERN_NOTICE "%s: reset the card first (status %d).\n",
1064 cosa->name, cosa->firmware_status);
1068 if (copy_from_user(&d, arg, sizeof(d)))
1071 if (d.addr < 0 || d.addr > COSA_MAX_FIRMWARE_SIZE)
1073 if (d.len < 0 || d.len > COSA_MAX_FIRMWARE_SIZE)
1077 /* If something fails, force the user to reset the card */
1078 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_DOWNLOAD);
1080 i = download(cosa, d.code, d.len, d.addr);
1082 printk(KERN_NOTICE "cosa%d: microcode download failed: %d\n",
1086 printk(KERN_INFO "cosa%d: downloading microcode - 0x%04x bytes at 0x%04x\n",
1087 cosa->num, d.len, d.addr);
1088 cosa->firmware_status |= COSA_FW_RESET|COSA_FW_DOWNLOAD;
1092 /* High-level function to read COSA memory. Calls readmem() */
1093 static inline int cosa_readmem(struct cosa_data *cosa, void __user *arg)
1095 struct cosa_download d;
1098 if (cosa->usage > 1)
1099 printk(KERN_INFO "cosa%d: WARNING: readmem requested with "
1100 "cosa->usage > 1 (%d). Odd things may happen.\n",
1101 cosa->num, cosa->usage);
1102 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1103 printk(KERN_NOTICE "%s: reset the card first (status %d).\n",
1104 cosa->name, cosa->firmware_status);
1108 if (copy_from_user(&d, arg, sizeof(d)))
1111 /* If something fails, force the user to reset the card */
1112 cosa->firmware_status &= ~COSA_FW_RESET;
1114 i = readmem(cosa, d.code, d.len, d.addr);
1116 printk(KERN_NOTICE "cosa%d: reading memory failed: %d\n",
1120 printk(KERN_INFO "cosa%d: reading card memory - 0x%04x bytes at 0x%04x\n",
1121 cosa->num, d.len, d.addr);
1122 cosa->firmware_status |= COSA_FW_RESET;
1126 /* High-level function to start microcode. Calls startmicrocode(). */
1127 static inline int cosa_start(struct cosa_data *cosa, int address)
1131 if (cosa->usage > 1)
1132 printk(KERN_INFO "cosa%d: WARNING: start microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1133 cosa->num, cosa->usage);
1135 if ((cosa->firmware_status & (COSA_FW_RESET|COSA_FW_DOWNLOAD))
1136 != (COSA_FW_RESET|COSA_FW_DOWNLOAD)) {
1137 printk(KERN_NOTICE "%s: download the microcode and/or reset the card first (status %d).\n",
1138 cosa->name, cosa->firmware_status);
1141 cosa->firmware_status &= ~COSA_FW_RESET;
1142 if ((i=startmicrocode(cosa, address)) < 0) {
1143 printk(KERN_NOTICE "cosa%d: start microcode at 0x%04x failed: %d\n",
1144 cosa->num, address, i);
1147 printk(KERN_INFO "cosa%d: starting microcode at 0x%04x\n",
1148 cosa->num, address);
1149 cosa->startaddr = address;
1150 cosa->firmware_status |= COSA_FW_START;
1154 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1155 static inline int cosa_getidstr(struct cosa_data *cosa, char __user *string)
1157 int l = strlen(cosa->id_string)+1;
1158 if (copy_to_user(string, cosa->id_string, l))
1163 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1164 static inline int cosa_gettype(struct cosa_data *cosa, char __user *string)
1166 int l = strlen(cosa->type)+1;
1167 if (copy_to_user(string, cosa->type, l))
1172 static int cosa_ioctl_common(struct cosa_data *cosa,
1173 struct channel_data *channel, unsigned int cmd, unsigned long arg)
1175 void __user *argp = (void __user *)arg;
1177 case COSAIORSET: /* Reset the device */
1178 if (!capable(CAP_NET_ADMIN))
1180 return cosa_reset(cosa);
1181 case COSAIOSTRT: /* Start the firmware */
1182 if (!capable(CAP_SYS_RAWIO))
1184 return cosa_start(cosa, arg);
1185 case COSAIODOWNLD: /* Download the firmware */
1186 if (!capable(CAP_SYS_RAWIO))
1189 return cosa_download(cosa, argp);
1191 if (!capable(CAP_SYS_RAWIO))
1193 return cosa_readmem(cosa, argp);
1195 return cosa_gettype(cosa, argp);
1197 return cosa_getidstr(cosa, argp);
1201 return cosa->nchannels;
1203 if (!capable(CAP_SYS_RAWIO))
1207 if (arg != COSA_BM_OFF && arg != COSA_BM_ON)
1209 cosa->busmaster = arg;
1212 return cosa->busmaster;
1214 return -ENOIOCTLCMD;
1217 static int cosa_sppp_ioctl(struct net_device *dev, struct ifreq *ifr,
1221 struct channel_data *chan = dev->priv;
1222 rv = cosa_ioctl_common(chan->cosa, chan, cmd, (unsigned long)ifr->ifr_data);
1223 if (rv == -ENOIOCTLCMD) {
1224 return sppp_do_ioctl(dev, ifr, cmd);
1229 static int cosa_chardev_ioctl(struct inode *inode, struct file *file,
1230 unsigned int cmd, unsigned long arg)
1232 struct channel_data *channel = file->private_data;
1233 struct cosa_data *cosa = channel->cosa;
1234 return cosa_ioctl_common(cosa, channel, cmd, arg);
1238 /*---------- HW layer interface ---------- */
1241 * The higher layer can bind itself to the HW layer by setting the callbacks
1242 * in the channel_data structure and by using these routines.
1244 static void cosa_enable_rx(struct channel_data *chan)
1246 struct cosa_data *cosa = chan->cosa;
1248 if (!test_and_set_bit(chan->num, &cosa->rxbitmap))
1249 put_driver_status(cosa);
1252 static void cosa_disable_rx(struct channel_data *chan)
1254 struct cosa_data *cosa = chan->cosa;
1256 if (test_and_clear_bit(chan->num, &cosa->rxbitmap))
1257 put_driver_status(cosa);
1261 * FIXME: This routine probably should check for cosa_start_tx() called when
1262 * the previous transmit is still unfinished. In this case the non-zero
1263 * return value should indicate to the caller that the queuing(sp?) up
1264 * the transmit has failed.
1266 static int cosa_start_tx(struct channel_data *chan, char *buf, int len)
1268 struct cosa_data *cosa = chan->cosa;
1269 unsigned long flags;
1273 printk(KERN_INFO "cosa%dc%d: starting tx(0x%x)", chan->cosa->num,
1275 for (i=0; i<len; i++)
1276 printk(" %02x", buf[i]&0xff);
1279 spin_lock_irqsave(&cosa->lock, flags);
1283 chan->txsize = COSA_MTU;
1284 spin_unlock_irqrestore(&cosa->lock, flags);
1286 /* Tell the firmware we are ready */
1287 set_bit(chan->num, &cosa->txbitmap);
1288 put_driver_status(cosa);
1293 static void put_driver_status(struct cosa_data *cosa)
1295 unsigned long flags;
1298 spin_lock_irqsave(&cosa->lock, flags);
1300 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1301 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1302 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1303 &DRIVER_TXMAP_MASK : 0);
1305 if (cosa->rxbitmap|cosa->txbitmap) {
1306 if (!cosa->enabled) {
1307 cosa_putstatus(cosa, SR_RX_INT_ENA);
1309 debug_status_out(cosa, SR_RX_INT_ENA);
1313 } else if (cosa->enabled) {
1315 cosa_putstatus(cosa, 0);
1317 debug_status_out(cosa, 0);
1320 cosa_putdata8(cosa, status);
1322 debug_data_cmd(cosa, status);
1325 spin_unlock_irqrestore(&cosa->lock, flags);
1328 static void put_driver_status_nolock(struct cosa_data *cosa)
1332 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1333 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1334 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1335 &DRIVER_TXMAP_MASK : 0);
1337 if (cosa->rxbitmap|cosa->txbitmap) {
1338 cosa_putstatus(cosa, SR_RX_INT_ENA);
1340 debug_status_out(cosa, SR_RX_INT_ENA);
1344 cosa_putstatus(cosa, 0);
1346 debug_status_out(cosa, 0);
1350 cosa_putdata8(cosa, status);
1352 debug_data_cmd(cosa, status);
1357 * The "kickme" function: When the DMA times out, this is called to
1358 * clean up the driver status.
1359 * FIXME: Preliminary support, the interface is probably wrong.
1361 static void cosa_kick(struct cosa_data *cosa)
1363 unsigned long flags, flags1;
1364 char *s = "(probably) IRQ";
1366 if (test_bit(RXBIT, &cosa->rxtx))
1368 if (test_bit(TXBIT, &cosa->rxtx))
1371 printk(KERN_INFO "%s: %s timeout - restarting.\n", cosa->name, s);
1372 spin_lock_irqsave(&cosa->lock, flags);
1375 flags1 = claim_dma_lock();
1376 disable_dma(cosa->dma);
1377 clear_dma_ff(cosa->dma);
1378 release_dma_lock(flags1);
1380 /* FIXME: Anything else? */
1382 cosa_putstatus(cosa, 0);
1384 (void) cosa_getdata8(cosa);
1386 cosa_putdata8(cosa, 0);
1388 put_driver_status_nolock(cosa);
1389 spin_unlock_irqrestore(&cosa->lock, flags);
1393 * Check if the whole buffer is DMA-able. It means it is below the 16M of
1394 * physical memory and doesn't span the 64k boundary. For now it seems
1395 * SKB's never do this, but we'll check this anyway.
1397 static int cosa_dma_able(struct channel_data *chan, char *buf, int len)
1400 unsigned long b = (unsigned long)buf;
1401 if (b+len >= MAX_DMA_ADDRESS)
1403 if ((b^ (b+len)) & 0x10000) {
1405 printk(KERN_INFO "%s: packet spanning a 64k boundary\n",
1413 /* ---------- The SRP/COSA ROM monitor functions ---------- */
1416 * Downloading SRP microcode: say "w" to SRP monitor, it answers by "w=",
1417 * drivers need to say 4-digit hex number meaning start address of the microcode
1418 * separated by a single space. Monitor replies by saying " =". Now driver
1419 * has to write 4-digit hex number meaning the last byte address ended
1420 * by a single space. Monitor has to reply with a space. Now the download
1421 * begins. After the download monitor replies with "\r\n." (CR LF dot).
1423 static int download(struct cosa_data *cosa, const char __user *microcode, int length, int address)
1427 if (put_wait_data(cosa, 'w') == -1) return -1;
1428 if ((i=get_wait_data(cosa)) != 'w') { printk("dnld: 0x%04x\n",i); return -2;}
1429 if (get_wait_data(cosa) != '=') return -3;
1431 if (puthexnumber(cosa, address) < 0) return -4;
1432 if (put_wait_data(cosa, ' ') == -1) return -10;
1433 if (get_wait_data(cosa) != ' ') return -11;
1434 if (get_wait_data(cosa) != '=') return -12;
1436 if (puthexnumber(cosa, address+length-1) < 0) return -13;
1437 if (put_wait_data(cosa, ' ') == -1) return -18;
1438 if (get_wait_data(cosa) != ' ') return -19;
1442 #ifndef SRP_DOWNLOAD_AT_BOOT
1443 if (get_user(c, microcode))
1444 return -23; /* ??? */
1448 if (put_wait_data(cosa, c) == -1)
1453 if (get_wait_data(cosa) != '\r') return -21;
1454 if (get_wait_data(cosa) != '\n') return -22;
1455 if (get_wait_data(cosa) != '.') return -23;
1457 printk(KERN_DEBUG "cosa%d: download completed.\n", cosa->num);
1464 * Starting microcode is done via the "g" command of the SRP monitor.
1465 * The chat should be the following: "g" "g=" "<addr><CR>"
1466 * "<CR><CR><LF><CR><LF>".
1468 static int startmicrocode(struct cosa_data *cosa, int address)
1470 if (put_wait_data(cosa, 'g') == -1) return -1;
1471 if (get_wait_data(cosa) != 'g') return -2;
1472 if (get_wait_data(cosa) != '=') return -3;
1474 if (puthexnumber(cosa, address) < 0) return -4;
1475 if (put_wait_data(cosa, '\r') == -1) return -5;
1477 if (get_wait_data(cosa) != '\r') return -6;
1478 if (get_wait_data(cosa) != '\r') return -7;
1479 if (get_wait_data(cosa) != '\n') return -8;
1480 if (get_wait_data(cosa) != '\r') return -9;
1481 if (get_wait_data(cosa) != '\n') return -10;
1483 printk(KERN_DEBUG "cosa%d: microcode started\n", cosa->num);
1489 * Reading memory is done via the "r" command of the SRP monitor.
1490 * The chat is the following "r" "r=" "<addr> " " =" "<last_byte> " " "
1491 * Then driver can read the data and the conversation is finished
1492 * by SRP monitor sending "<CR><LF>." (dot at the end).
1494 * This routine is not needed during the normal operation and serves
1495 * for debugging purposes only.
1497 static int readmem(struct cosa_data *cosa, char __user *microcode, int length, int address)
1499 if (put_wait_data(cosa, 'r') == -1) return -1;
1500 if ((get_wait_data(cosa)) != 'r') return -2;
1501 if ((get_wait_data(cosa)) != '=') return -3;
1503 if (puthexnumber(cosa, address) < 0) return -4;
1504 if (put_wait_data(cosa, ' ') == -1) return -5;
1505 if (get_wait_data(cosa) != ' ') return -6;
1506 if (get_wait_data(cosa) != '=') return -7;
1508 if (puthexnumber(cosa, address+length-1) < 0) return -8;
1509 if (put_wait_data(cosa, ' ') == -1) return -9;
1510 if (get_wait_data(cosa) != ' ') return -10;
1515 if ((i=get_wait_data(cosa)) == -1) {
1516 printk (KERN_INFO "cosa: 0x%04x bytes remaining\n",
1522 if (put_user(c, microcode))
1523 return -23; /* ??? */
1530 if (get_wait_data(cosa) != '\r') return -21;
1531 if (get_wait_data(cosa) != '\n') return -22;
1532 if (get_wait_data(cosa) != '.') return -23;
1534 printk(KERN_DEBUG "cosa%d: readmem completed.\n", cosa->num);
1540 * This function resets the device and reads the initial prompt
1541 * of the device's ROM monitor.
1543 static int cosa_reset_and_read_id(struct cosa_data *cosa, char *idstring)
1545 int i=0, id=0, prev=0, curr=0;
1547 /* Reset the card ... */
1548 cosa_putstatus(cosa, 0);
1549 cosa_getdata8(cosa);
1550 cosa_putstatus(cosa, SR_RST);
1556 /* Disable all IRQs from the card */
1557 cosa_putstatus(cosa, 0);
1560 * Try to read the ID string. The card then prints out the
1561 * identification string ended by the "\n\x2e".
1563 * The following loop is indexed through i (instead of id)
1564 * to avoid looping forever when for any reason
1565 * the port returns '\r', '\n' or '\x2e' permanently.
1567 for (i=0; i<COSA_MAX_ID_STRING-1; i++, prev=curr) {
1568 if ((curr = get_wait_data(cosa)) == -1) {
1572 if (curr != '\r' && curr != '\n' && curr != 0x2e)
1573 idstring[id++] = curr;
1574 if (curr == 0x2e && prev == '\n')
1577 /* Perhaps we should fail when i==COSA_MAX_ID_STRING-1 ? */
1578 idstring[id] = '\0';
1583 /* ---------- Auxiliary routines for COSA/SRP monitor ---------- */
1586 * This routine gets the data byte from the card waiting for the SR_RX_RDY
1587 * bit to be set in a loop. It should be used in the exceptional cases
1588 * only (for example when resetting the card or downloading the firmware.
1590 static int get_wait_data(struct cosa_data *cosa)
1595 /* read data and return them */
1596 if (cosa_getstatus(cosa) & SR_RX_RDY) {
1598 r = cosa_getdata8(cosa);
1600 printk(KERN_INFO "cosa: get_wait_data returning after %d retries\n", 999-retries);
1604 /* sleep if not ready to read */
1605 schedule_timeout_interruptible(1);
1607 printk(KERN_INFO "cosa: timeout in get_wait_data (status 0x%x)\n",
1608 cosa_getstatus(cosa));
1613 * This routine puts the data byte to the card waiting for the SR_TX_RDY
1614 * bit to be set in a loop. It should be used in the exceptional cases
1615 * only (for example when resetting the card or downloading the firmware).
1617 static int put_wait_data(struct cosa_data *cosa, int data)
1621 /* read data and return them */
1622 if (cosa_getstatus(cosa) & SR_TX_RDY) {
1623 cosa_putdata8(cosa, data);
1625 printk(KERN_INFO "Putdata: %d retries\n", 999-retries);
1630 /* sleep if not ready to read */
1631 schedule_timeout_interruptible(1);
1634 printk(KERN_INFO "cosa%d: timeout in put_wait_data (status 0x%x)\n",
1635 cosa->num, cosa_getstatus(cosa));
1640 * The following routine puts the hexadecimal number into the SRP monitor
1641 * and verifies the proper echo of the sent bytes. Returns 0 on success,
1642 * negative number on failure (-1,-3,-5,-7) means that put_wait_data() failed,
1643 * (-2,-4,-6,-8) means that reading echo failed.
1645 static int puthexnumber(struct cosa_data *cosa, int number)
1650 /* Well, I should probably replace this by something faster. */
1651 sprintf(temp, "%04X", number);
1652 for (i=0; i<4; i++) {
1653 if (put_wait_data(cosa, temp[i]) == -1) {
1654 printk(KERN_NOTICE "cosa%d: puthexnumber failed to write byte %d\n",
1658 if (get_wait_data(cosa) != temp[i]) {
1659 printk(KERN_NOTICE "cosa%d: puthexhumber failed to read echo of byte %d\n",
1668 /* ---------- Interrupt routines ---------- */
1671 * There are three types of interrupt:
1672 * At the beginning of transmit - this handled is in tx_interrupt(),
1673 * at the beginning of receive - it is in rx_interrupt() and
1674 * at the end of transmit/receive - it is the eot_interrupt() function.
1675 * These functions are multiplexed by cosa_interrupt() according to the
1676 * COSA status byte. I have moved the rx/tx/eot interrupt handling into
1677 * separate functions to make it more readable. These functions are inline,
1678 * so there should be no overhead of function call.
1680 * In the COSA bus-master mode, we need to tell the card the address of a
1681 * buffer. Unfortunately, COSA may be too slow for us, so we must busy-wait.
1682 * It's time to use the bottom half :-(
1686 * Transmit interrupt routine - called when COSA is willing to obtain
1687 * data from the OS. The most tricky part of the routine is selection
1688 * of channel we (OS) want to send packet for. For SRP we should probably
1689 * use the round-robin approach. The newer COSA firmwares have a simple
1690 * flow-control - in the status word has bits 2 and 3 set to 1 means that the
1691 * channel 0 or 1 doesn't want to receive data.
1693 * It seems there is a bug in COSA firmware (need to trace it further):
1694 * When the driver status says that the kernel has no more data for transmit
1695 * (e.g. at the end of TX DMA) and then the kernel changes its mind
1696 * (e.g. new packet is queued to hard_start_xmit()), the card issues
1697 * the TX interrupt but does not mark the channel as ready-to-transmit.
1698 * The fix seems to be to push the packet to COSA despite its request.
1699 * We first try to obey the card's opinion, and then fall back to forced TX.
1701 static inline void tx_interrupt(struct cosa_data *cosa, int status)
1703 unsigned long flags, flags1;
1705 printk(KERN_INFO "cosa%d: SR_DOWN_REQUEST status=0x%04x\n",
1708 spin_lock_irqsave(&cosa->lock, flags);
1709 set_bit(TXBIT, &cosa->rxtx);
1710 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1711 /* flow control, see the comment above */
1713 if (!cosa->txbitmap) {
1714 printk(KERN_WARNING "%s: No channel wants data "
1715 "in TX IRQ. Expect DMA timeout.",
1717 put_driver_status_nolock(cosa);
1718 clear_bit(TXBIT, &cosa->rxtx);
1719 spin_unlock_irqrestore(&cosa->lock, flags);
1725 if (cosa->txchan >= cosa->nchannels)
1727 if (!(cosa->txbitmap & (1<<cosa->txchan)))
1729 if (~status & (1 << (cosa->txchan+DRIVER_TXMAP_SHIFT)))
1731 /* in second pass, accept first ready-to-TX channel */
1732 if (i > cosa->nchannels) {
1733 /* Can be safely ignored */
1735 printk(KERN_DEBUG "%s: Forcing TX "
1736 "to not-ready channel %d\n",
1737 cosa->name, cosa->txchan);
1743 cosa->txsize = cosa->chan[cosa->txchan].txsize;
1744 if (cosa_dma_able(cosa->chan+cosa->txchan,
1745 cosa->chan[cosa->txchan].txbuf, cosa->txsize)) {
1746 cosa->txbuf = cosa->chan[cosa->txchan].txbuf;
1748 memcpy(cosa->bouncebuf, cosa->chan[cosa->txchan].txbuf,
1750 cosa->txbuf = cosa->bouncebuf;
1754 if (is_8bit(cosa)) {
1755 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1756 cosa_putstatus(cosa, SR_TX_INT_ENA);
1757 cosa_putdata8(cosa, ((cosa->txchan << 5) & 0xe0)|
1758 ((cosa->txsize >> 8) & 0x1f));
1760 debug_status_out(cosa, SR_TX_INT_ENA);
1761 debug_data_out(cosa, ((cosa->txchan << 5) & 0xe0)|
1762 ((cosa->txsize >> 8) & 0x1f));
1763 debug_data_in(cosa, cosa_getdata8(cosa));
1765 cosa_getdata8(cosa);
1767 set_bit(IRQBIT, &cosa->rxtx);
1768 spin_unlock_irqrestore(&cosa->lock, flags);
1771 clear_bit(IRQBIT, &cosa->rxtx);
1772 cosa_putstatus(cosa, 0);
1773 cosa_putdata8(cosa, cosa->txsize&0xff);
1775 debug_status_out(cosa, 0);
1776 debug_data_out(cosa, cosa->txsize&0xff);
1780 cosa_putstatus(cosa, SR_TX_INT_ENA);
1781 cosa_putdata16(cosa, ((cosa->txchan<<13) & 0xe000)
1782 | (cosa->txsize & 0x1fff));
1784 debug_status_out(cosa, SR_TX_INT_ENA);
1785 debug_data_out(cosa, ((cosa->txchan<<13) & 0xe000)
1786 | (cosa->txsize & 0x1fff));
1787 debug_data_in(cosa, cosa_getdata8(cosa));
1788 debug_status_out(cosa, 0);
1790 cosa_getdata8(cosa);
1792 cosa_putstatus(cosa, 0);
1795 if (cosa->busmaster) {
1796 unsigned long addr = virt_to_bus(cosa->txbuf);
1798 printk(KERN_INFO "busmaster IRQ\n");
1799 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1802 if (count > 1000) break;
1804 printk(KERN_INFO "status %x\n", cosa_getstatus(cosa));
1805 printk(KERN_INFO "ready after %d loops\n", count);
1806 cosa_putdata16(cosa, (addr >> 16)&0xffff);
1809 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1811 if (count > 1000) break;
1814 printk(KERN_INFO "ready after %d loops\n", count);
1815 cosa_putdata16(cosa, addr &0xffff);
1816 flags1 = claim_dma_lock();
1817 set_dma_mode(cosa->dma, DMA_MODE_CASCADE);
1818 enable_dma(cosa->dma);
1819 release_dma_lock(flags1);
1822 flags1 = claim_dma_lock();
1823 disable_dma(cosa->dma);
1824 clear_dma_ff(cosa->dma);
1825 set_dma_mode(cosa->dma, DMA_MODE_WRITE);
1826 set_dma_addr(cosa->dma, virt_to_bus(cosa->txbuf));
1827 set_dma_count(cosa->dma, cosa->txsize);
1828 enable_dma(cosa->dma);
1829 release_dma_lock(flags1);
1831 cosa_putstatus(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1833 debug_status_out(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1835 spin_unlock_irqrestore(&cosa->lock, flags);
1838 static inline void rx_interrupt(struct cosa_data *cosa, int status)
1840 unsigned long flags;
1842 printk(KERN_INFO "cosa%d: SR_UP_REQUEST\n", cosa->num);
1845 spin_lock_irqsave(&cosa->lock, flags);
1846 set_bit(RXBIT, &cosa->rxtx);
1848 if (is_8bit(cosa)) {
1849 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1850 set_bit(IRQBIT, &cosa->rxtx);
1851 put_driver_status_nolock(cosa);
1852 cosa->rxsize = cosa_getdata8(cosa) <<8;
1854 debug_data_in(cosa, cosa->rxsize >> 8);
1856 spin_unlock_irqrestore(&cosa->lock, flags);
1859 clear_bit(IRQBIT, &cosa->rxtx);
1860 cosa->rxsize |= cosa_getdata8(cosa) & 0xff;
1862 debug_data_in(cosa, cosa->rxsize & 0xff);
1865 printk(KERN_INFO "cosa%d: receive rxsize = (0x%04x).\n",
1866 cosa->num, cosa->rxsize);
1870 cosa->rxsize = cosa_getdata16(cosa);
1872 debug_data_in(cosa, cosa->rxsize);
1875 printk(KERN_INFO "cosa%d: receive rxsize = (0x%04x).\n",
1876 cosa->num, cosa->rxsize);
1879 if (((cosa->rxsize & 0xe000) >> 13) >= cosa->nchannels) {
1880 printk(KERN_WARNING "%s: rx for unknown channel (0x%04x)\n",
1881 cosa->name, cosa->rxsize);
1882 spin_unlock_irqrestore(&cosa->lock, flags);
1885 cosa->rxchan = cosa->chan + ((cosa->rxsize & 0xe000) >> 13);
1886 cosa->rxsize &= 0x1fff;
1887 spin_unlock_irqrestore(&cosa->lock, flags);
1890 if (cosa->rxchan->setup_rx)
1891 cosa->rxbuf = cosa->rxchan->setup_rx(cosa->rxchan, cosa->rxsize);
1894 reject: /* Reject the packet */
1895 printk(KERN_INFO "cosa%d: rejecting packet on channel %d\n",
1896 cosa->num, cosa->rxchan->num);
1897 cosa->rxbuf = cosa->bouncebuf;
1901 flags = claim_dma_lock();
1902 disable_dma(cosa->dma);
1903 clear_dma_ff(cosa->dma);
1904 set_dma_mode(cosa->dma, DMA_MODE_READ);
1905 if (cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize & 0x1fff)) {
1906 set_dma_addr(cosa->dma, virt_to_bus(cosa->rxbuf));
1908 set_dma_addr(cosa->dma, virt_to_bus(cosa->bouncebuf));
1910 set_dma_count(cosa->dma, (cosa->rxsize&0x1fff));
1911 enable_dma(cosa->dma);
1912 release_dma_lock(flags);
1913 spin_lock_irqsave(&cosa->lock, flags);
1914 cosa_putstatus(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1915 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1916 cosa_putdata8(cosa, DRIVER_RX_READY);
1918 debug_status_out(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1919 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1920 debug_data_cmd(cosa, DRIVER_RX_READY);
1922 spin_unlock_irqrestore(&cosa->lock, flags);
1925 static inline void eot_interrupt(struct cosa_data *cosa, int status)
1927 unsigned long flags, flags1;
1928 spin_lock_irqsave(&cosa->lock, flags);
1929 flags1 = claim_dma_lock();
1930 disable_dma(cosa->dma);
1931 clear_dma_ff(cosa->dma);
1932 release_dma_lock(flags1);
1933 if (test_bit(TXBIT, &cosa->rxtx)) {
1934 struct channel_data *chan = cosa->chan+cosa->txchan;
1936 if (chan->tx_done(chan, cosa->txsize))
1937 clear_bit(chan->num, &cosa->txbitmap);
1938 } else if (test_bit(RXBIT, &cosa->rxtx)) {
1942 printk(KERN_INFO "cosa%dc%d: done rx(0x%x)", cosa->num,
1943 cosa->rxchan->num, cosa->rxsize);
1944 for (i=0; i<cosa->rxsize; i++)
1945 printk (" %02x", cosa->rxbuf[i]&0xff);
1949 /* Packet for unknown channel? */
1950 if (cosa->rxbuf == cosa->bouncebuf)
1952 if (!cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize))
1953 memcpy(cosa->rxbuf, cosa->bouncebuf, cosa->rxsize);
1954 if (cosa->rxchan->rx_done)
1955 if (cosa->rxchan->rx_done(cosa->rxchan))
1956 clear_bit(cosa->rxchan->num, &cosa->rxbitmap);
1958 printk(KERN_NOTICE "cosa%d: unexpected EOT interrupt\n",
1962 * Clear the RXBIT, TXBIT and IRQBIT (the latest should be
1963 * cleared anyway). We should do it as soon as possible
1964 * so that we can tell the COSA we are done and to give it a time
1969 put_driver_status_nolock(cosa);
1970 spin_unlock_irqrestore(&cosa->lock, flags);
1973 static irqreturn_t cosa_interrupt(int irq, void *cosa_)
1977 struct cosa_data *cosa = cosa_;
1979 status = cosa_getstatus(cosa);
1981 printk(KERN_INFO "cosa%d: got IRQ, status 0x%02x\n", cosa->num,
1985 debug_status_in(cosa, status);
1987 switch (status & SR_CMD_FROM_SRP_MASK) {
1988 case SR_DOWN_REQUEST:
1989 tx_interrupt(cosa, status);
1992 rx_interrupt(cosa, status);
1994 case SR_END_OF_TRANSFER:
1995 eot_interrupt(cosa, status);
1998 /* We may be too fast for SRP. Try to wait a bit more. */
1999 if (count++ < 100) {
2003 printk(KERN_INFO "cosa%d: unknown status 0x%02x in IRQ after %d retries\n",
2004 cosa->num, status & 0xff, count);
2008 printk(KERN_INFO "%s: %d-times got unknown status in IRQ\n",
2011 printk(KERN_INFO "%s: returning from IRQ\n", cosa->name);
2017 /* ---------- I/O debugging routines ---------- */
2019 * These routines can be used to monitor COSA/SRP I/O and to printk()
2020 * the data being transferred on the data and status I/O port in a
2025 static void debug_status_in(struct cosa_data *cosa, int status)
2028 switch(status & SR_CMD_FROM_SRP_MASK) {
2032 case SR_DOWN_REQUEST:
2035 case SR_END_OF_TRANSFER:
2042 printk(KERN_INFO "%s: IO: status -> 0x%02x (%s%s%s%s)\n",
2045 status & SR_USR_RQ ? "USR_RQ|":"",
2046 status & SR_TX_RDY ? "TX_RDY|":"",
2047 status & SR_RX_RDY ? "RX_RDY|":"",
2051 static void debug_status_out(struct cosa_data *cosa, int status)
2053 printk(KERN_INFO "%s: IO: status <- 0x%02x (%s%s%s%s%s%s)\n",
2056 status & SR_RX_DMA_ENA ? "RXDMA|":"!rxdma|",
2057 status & SR_TX_DMA_ENA ? "TXDMA|":"!txdma|",
2058 status & SR_RST ? "RESET|":"",
2059 status & SR_USR_INT_ENA ? "USRINT|":"!usrint|",
2060 status & SR_TX_INT_ENA ? "TXINT|":"!txint|",
2061 status & SR_RX_INT_ENA ? "RXINT":"!rxint");
2064 static void debug_data_in(struct cosa_data *cosa, int data)
2066 printk(KERN_INFO "%s: IO: data -> 0x%04x\n", cosa->name, data);
2069 static void debug_data_out(struct cosa_data *cosa, int data)
2071 printk(KERN_INFO "%s: IO: data <- 0x%04x\n", cosa->name, data);
2074 static void debug_data_cmd(struct cosa_data *cosa, int data)
2076 printk(KERN_INFO "%s: IO: data <- 0x%04x (%s|%s)\n",
2078 data & SR_RDY_RCV ? "RX_RDY" : "!rx_rdy",
2079 data & SR_RDY_SND ? "TX_RDY" : "!tx_rdy");
2083 /* EOF -- this file has not been truncated */