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 unsigned long rxbitmap, txbitmap;/* Bitmap of channels who are willing to send/receive data */
158 unsigned long 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 = kcalloc(cosa->nchannels, sizeof(struct channel_data), GFP_KERNEL);
580 for (i=0; i<cosa->nchannels; i++) {
581 cosa->chan[i].cosa = cosa;
582 cosa->chan[i].num = i;
583 channel_init(cosa->chan+i);
586 printk (KERN_INFO "cosa%d: %s (%s at 0x%x irq %d dma %d), %d channels\n",
587 cosa->num, cosa->id_string, cosa->type,
588 cosa->datareg, cosa->irq, cosa->dma, cosa->nchannels);
592 kfree(cosa->bouncebuf);
596 free_irq(cosa->irq, cosa);
598 release_region(cosa->datareg,is_8bit(cosa)?2:4);
599 printk(KERN_NOTICE "cosa%d: allocating resources failed\n",
605 /*---------- SPPP/HDLC netdevice ---------- */
607 static void cosa_setup(struct net_device *d)
609 d->open = cosa_sppp_open;
610 d->stop = cosa_sppp_close;
611 d->hard_start_xmit = cosa_sppp_tx;
612 d->do_ioctl = cosa_sppp_ioctl;
613 d->get_stats = cosa_net_stats;
614 d->tx_timeout = cosa_sppp_timeout;
615 d->watchdog_timeo = TX_TIMEOUT;
618 static void sppp_channel_init(struct channel_data *chan)
620 struct net_device *d;
621 chan->if_ptr = &chan->pppdev;
622 d = alloc_netdev(0, chan->name, cosa_setup);
624 printk(KERN_WARNING "%s: alloc_netdev failed.\n", chan->name);
627 chan->pppdev.dev = d;
628 d->base_addr = chan->cosa->datareg;
629 d->irq = chan->cosa->irq;
630 d->dma = chan->cosa->dma;
632 sppp_attach(&chan->pppdev);
633 if (register_netdev(d)) {
634 printk(KERN_WARNING "%s: register_netdev failed.\n", d->name);
637 chan->pppdev.dev = NULL;
642 static void sppp_channel_delete(struct channel_data *chan)
644 unregister_netdev(chan->pppdev.dev);
645 sppp_detach(chan->pppdev.dev);
646 free_netdev(chan->pppdev.dev);
647 chan->pppdev.dev = NULL;
650 static int cosa_sppp_open(struct net_device *d)
652 struct channel_data *chan = d->priv;
656 if (!(chan->cosa->firmware_status & COSA_FW_START)) {
657 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
658 chan->cosa->name, chan->cosa->firmware_status);
661 spin_lock_irqsave(&chan->cosa->lock, flags);
662 if (chan->usage != 0) {
663 printk(KERN_WARNING "%s: sppp_open called with usage count %d\n",
664 chan->name, chan->usage);
665 spin_unlock_irqrestore(&chan->cosa->lock, flags);
668 chan->setup_rx = sppp_setup_rx;
669 chan->tx_done = sppp_tx_done;
670 chan->rx_done = sppp_rx_done;
673 spin_unlock_irqrestore(&chan->cosa->lock, flags);
677 spin_lock_irqsave(&chan->cosa->lock, flags);
681 spin_unlock_irqrestore(&chan->cosa->lock, flags);
685 netif_start_queue(d);
686 cosa_enable_rx(chan);
690 static int cosa_sppp_tx(struct sk_buff *skb, struct net_device *dev)
692 struct channel_data *chan = dev->priv;
694 netif_stop_queue(dev);
697 cosa_start_tx(chan, skb->data, skb->len);
701 static void cosa_sppp_timeout(struct net_device *dev)
703 struct channel_data *chan = dev->priv;
705 if (test_bit(RXBIT, &chan->cosa->rxtx)) {
706 chan->stats.rx_errors++;
707 chan->stats.rx_missed_errors++;
709 chan->stats.tx_errors++;
710 chan->stats.tx_aborted_errors++;
712 cosa_kick(chan->cosa);
714 dev_kfree_skb(chan->tx_skb);
717 netif_wake_queue(dev);
720 static int cosa_sppp_close(struct net_device *d)
722 struct channel_data *chan = d->priv;
727 cosa_disable_rx(chan);
728 spin_lock_irqsave(&chan->cosa->lock, flags);
730 kfree_skb(chan->rx_skb);
734 kfree_skb(chan->tx_skb);
739 spin_unlock_irqrestore(&chan->cosa->lock, flags);
743 static char *sppp_setup_rx(struct channel_data *chan, int size)
746 * We can safely fall back to non-dma-able memory, because we have
747 * the cosa->bouncebuf pre-allocated.
750 kfree_skb(chan->rx_skb);
751 chan->rx_skb = dev_alloc_skb(size);
752 if (chan->rx_skb == NULL) {
753 printk(KERN_NOTICE "%s: Memory squeeze, dropping packet\n",
755 chan->stats.rx_dropped++;
758 chan->pppdev.dev->trans_start = jiffies;
759 return skb_put(chan->rx_skb, size);
762 static int sppp_rx_done(struct channel_data *chan)
765 printk(KERN_WARNING "%s: rx_done with empty skb!\n",
767 chan->stats.rx_errors++;
768 chan->stats.rx_frame_errors++;
771 chan->rx_skb->protocol = htons(ETH_P_WAN_PPP);
772 chan->rx_skb->dev = chan->pppdev.dev;
773 skb_reset_mac_header(chan->rx_skb);
774 chan->stats.rx_packets++;
775 chan->stats.rx_bytes += chan->cosa->rxsize;
776 netif_rx(chan->rx_skb);
778 chan->pppdev.dev->last_rx = jiffies;
783 static int sppp_tx_done(struct channel_data *chan, int size)
786 printk(KERN_WARNING "%s: tx_done with empty skb!\n",
788 chan->stats.tx_errors++;
789 chan->stats.tx_aborted_errors++;
792 dev_kfree_skb_irq(chan->tx_skb);
794 chan->stats.tx_packets++;
795 chan->stats.tx_bytes += size;
796 netif_wake_queue(chan->pppdev.dev);
800 static struct net_device_stats *cosa_net_stats(struct net_device *dev)
802 struct channel_data *chan = dev->priv;
807 /*---------- Character device ---------- */
809 static void chardev_channel_init(struct channel_data *chan)
811 init_MUTEX(&chan->rsem);
812 init_MUTEX(&chan->wsem);
815 static ssize_t cosa_read(struct file *file,
816 char __user *buf, size_t count, loff_t *ppos)
818 DECLARE_WAITQUEUE(wait, current);
820 struct channel_data *chan = file->private_data;
821 struct cosa_data *cosa = chan->cosa;
824 if (!(cosa->firmware_status & COSA_FW_START)) {
825 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
826 cosa->name, cosa->firmware_status);
829 if (down_interruptible(&chan->rsem))
832 if ((chan->rxdata = kmalloc(COSA_MTU, GFP_DMA|GFP_KERNEL)) == NULL) {
833 printk(KERN_INFO "%s: cosa_read() - OOM\n", cosa->name);
839 cosa_enable_rx(chan);
840 spin_lock_irqsave(&cosa->lock, flags);
841 add_wait_queue(&chan->rxwaitq, &wait);
842 while(!chan->rx_status) {
843 current->state = TASK_INTERRUPTIBLE;
844 spin_unlock_irqrestore(&cosa->lock, flags);
846 spin_lock_irqsave(&cosa->lock, flags);
847 if (signal_pending(current) && chan->rx_status == 0) {
849 remove_wait_queue(&chan->rxwaitq, &wait);
850 current->state = TASK_RUNNING;
851 spin_unlock_irqrestore(&cosa->lock, flags);
856 remove_wait_queue(&chan->rxwaitq, &wait);
857 current->state = TASK_RUNNING;
859 count = chan->rxsize;
860 spin_unlock_irqrestore(&cosa->lock, flags);
863 if (copy_to_user(buf, kbuf, count)) {
871 static char *chrdev_setup_rx(struct channel_data *chan, int size)
873 /* Expect size <= COSA_MTU */
878 static int chrdev_rx_done(struct channel_data *chan)
880 if (chan->rx_status) { /* Reader has died */
885 wake_up_interruptible(&chan->rxwaitq);
890 static ssize_t cosa_write(struct file *file,
891 const char __user *buf, size_t count, loff_t *ppos)
893 DECLARE_WAITQUEUE(wait, current);
894 struct channel_data *chan = file->private_data;
895 struct cosa_data *cosa = chan->cosa;
899 if (!(cosa->firmware_status & COSA_FW_START)) {
900 printk(KERN_NOTICE "%s: start the firmware first (status %d)\n",
901 cosa->name, cosa->firmware_status);
904 if (down_interruptible(&chan->wsem))
907 if (count > COSA_MTU)
910 /* Allocate the buffer */
911 if ((kbuf = kmalloc(count, GFP_KERNEL|GFP_DMA)) == NULL) {
912 printk(KERN_NOTICE "%s: cosa_write() OOM - dropping packet\n",
917 if (copy_from_user(kbuf, buf, count)) {
923 cosa_start_tx(chan, kbuf, count);
925 spin_lock_irqsave(&cosa->lock, flags);
926 add_wait_queue(&chan->txwaitq, &wait);
927 while(!chan->tx_status) {
928 current->state = TASK_INTERRUPTIBLE;
929 spin_unlock_irqrestore(&cosa->lock, flags);
931 spin_lock_irqsave(&cosa->lock, flags);
932 if (signal_pending(current) && chan->tx_status == 0) {
934 remove_wait_queue(&chan->txwaitq, &wait);
935 current->state = TASK_RUNNING;
937 spin_unlock_irqrestore(&cosa->lock, flags);
941 remove_wait_queue(&chan->txwaitq, &wait);
942 current->state = TASK_RUNNING;
944 spin_unlock_irqrestore(&cosa->lock, flags);
949 static int chrdev_tx_done(struct channel_data *chan, int size)
951 if (chan->tx_status) { /* Writer was interrupted */
956 wake_up_interruptible(&chan->txwaitq);
960 static unsigned int cosa_poll(struct file *file, poll_table *poll)
962 printk(KERN_INFO "cosa_poll is here\n");
966 static int cosa_open(struct inode *inode, struct file *file)
968 struct cosa_data *cosa;
969 struct channel_data *chan;
973 if ((n=iminor(file->f_path.dentry->d_inode)>>CARD_MINOR_BITS)
978 if ((n=iminor(file->f_path.dentry->d_inode)
979 & ((1<<CARD_MINOR_BITS)-1)) >= cosa->nchannels)
981 chan = cosa->chan + n;
983 file->private_data = chan;
985 spin_lock_irqsave(&cosa->lock, flags);
987 if (chan->usage < 0) { /* in netdev mode */
988 spin_unlock_irqrestore(&cosa->lock, flags);
994 chan->tx_done = chrdev_tx_done;
995 chan->setup_rx = chrdev_setup_rx;
996 chan->rx_done = chrdev_rx_done;
997 spin_unlock_irqrestore(&cosa->lock, flags);
1001 static int cosa_release(struct inode *inode, struct file *file)
1003 struct channel_data *channel = file->private_data;
1004 struct cosa_data *cosa;
1005 unsigned long flags;
1007 cosa = channel->cosa;
1008 spin_lock_irqsave(&cosa->lock, flags);
1011 spin_unlock_irqrestore(&cosa->lock, flags);
1015 #ifdef COSA_FASYNC_WORKING
1016 static struct fasync_struct *fasync[256] = { NULL, };
1018 /* To be done ... */
1019 static int cosa_fasync(struct inode *inode, struct file *file, int on)
1021 int port = iminor(inode);
1022 int rv = fasync_helper(inode, file, on, &fasync[port]);
1023 return rv < 0 ? rv : 0;
1028 /* ---------- Ioctls ---------- */
1031 * Ioctl subroutines can safely be made inline, because they are called
1032 * only from cosa_ioctl().
1034 static inline int cosa_reset(struct cosa_data *cosa)
1036 char idstring[COSA_MAX_ID_STRING];
1037 if (cosa->usage > 1)
1038 printk(KERN_INFO "cosa%d: WARNING: reset requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1039 cosa->num, cosa->usage);
1040 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_START);
1041 if (cosa_reset_and_read_id(cosa, idstring) < 0) {
1042 printk(KERN_NOTICE "cosa%d: reset failed\n", cosa->num);
1045 printk(KERN_INFO "cosa%d: resetting device: %s\n", cosa->num,
1047 cosa->firmware_status |= COSA_FW_RESET;
1051 /* High-level function to download data into COSA memory. Calls download() */
1052 static inline int cosa_download(struct cosa_data *cosa, void __user *arg)
1054 struct cosa_download d;
1057 if (cosa->usage > 1)
1058 printk(KERN_INFO "%s: WARNING: download of microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1059 cosa->name, cosa->usage);
1060 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1061 printk(KERN_NOTICE "%s: reset the card first (status %d).\n",
1062 cosa->name, cosa->firmware_status);
1066 if (copy_from_user(&d, arg, sizeof(d)))
1069 if (d.addr < 0 || d.addr > COSA_MAX_FIRMWARE_SIZE)
1071 if (d.len < 0 || d.len > COSA_MAX_FIRMWARE_SIZE)
1075 /* If something fails, force the user to reset the card */
1076 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_DOWNLOAD);
1078 i = download(cosa, d.code, d.len, d.addr);
1080 printk(KERN_NOTICE "cosa%d: microcode download failed: %d\n",
1084 printk(KERN_INFO "cosa%d: downloading microcode - 0x%04x bytes at 0x%04x\n",
1085 cosa->num, d.len, d.addr);
1086 cosa->firmware_status |= COSA_FW_RESET|COSA_FW_DOWNLOAD;
1090 /* High-level function to read COSA memory. Calls readmem() */
1091 static inline int cosa_readmem(struct cosa_data *cosa, void __user *arg)
1093 struct cosa_download d;
1096 if (cosa->usage > 1)
1097 printk(KERN_INFO "cosa%d: WARNING: readmem requested with "
1098 "cosa->usage > 1 (%d). Odd things may happen.\n",
1099 cosa->num, cosa->usage);
1100 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1101 printk(KERN_NOTICE "%s: reset the card first (status %d).\n",
1102 cosa->name, cosa->firmware_status);
1106 if (copy_from_user(&d, arg, sizeof(d)))
1109 /* If something fails, force the user to reset the card */
1110 cosa->firmware_status &= ~COSA_FW_RESET;
1112 i = readmem(cosa, d.code, d.len, d.addr);
1114 printk(KERN_NOTICE "cosa%d: reading memory failed: %d\n",
1118 printk(KERN_INFO "cosa%d: reading card memory - 0x%04x bytes at 0x%04x\n",
1119 cosa->num, d.len, d.addr);
1120 cosa->firmware_status |= COSA_FW_RESET;
1124 /* High-level function to start microcode. Calls startmicrocode(). */
1125 static inline int cosa_start(struct cosa_data *cosa, int address)
1129 if (cosa->usage > 1)
1130 printk(KERN_INFO "cosa%d: WARNING: start microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1131 cosa->num, cosa->usage);
1133 if ((cosa->firmware_status & (COSA_FW_RESET|COSA_FW_DOWNLOAD))
1134 != (COSA_FW_RESET|COSA_FW_DOWNLOAD)) {
1135 printk(KERN_NOTICE "%s: download the microcode and/or reset the card first (status %d).\n",
1136 cosa->name, cosa->firmware_status);
1139 cosa->firmware_status &= ~COSA_FW_RESET;
1140 if ((i=startmicrocode(cosa, address)) < 0) {
1141 printk(KERN_NOTICE "cosa%d: start microcode at 0x%04x failed: %d\n",
1142 cosa->num, address, i);
1145 printk(KERN_INFO "cosa%d: starting microcode at 0x%04x\n",
1146 cosa->num, address);
1147 cosa->startaddr = address;
1148 cosa->firmware_status |= COSA_FW_START;
1152 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1153 static inline int cosa_getidstr(struct cosa_data *cosa, char __user *string)
1155 int l = strlen(cosa->id_string)+1;
1156 if (copy_to_user(string, cosa->id_string, l))
1161 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1162 static inline int cosa_gettype(struct cosa_data *cosa, char __user *string)
1164 int l = strlen(cosa->type)+1;
1165 if (copy_to_user(string, cosa->type, l))
1170 static int cosa_ioctl_common(struct cosa_data *cosa,
1171 struct channel_data *channel, unsigned int cmd, unsigned long arg)
1173 void __user *argp = (void __user *)arg;
1175 case COSAIORSET: /* Reset the device */
1176 if (!capable(CAP_NET_ADMIN))
1178 return cosa_reset(cosa);
1179 case COSAIOSTRT: /* Start the firmware */
1180 if (!capable(CAP_SYS_RAWIO))
1182 return cosa_start(cosa, arg);
1183 case COSAIODOWNLD: /* Download the firmware */
1184 if (!capable(CAP_SYS_RAWIO))
1187 return cosa_download(cosa, argp);
1189 if (!capable(CAP_SYS_RAWIO))
1191 return cosa_readmem(cosa, argp);
1193 return cosa_gettype(cosa, argp);
1195 return cosa_getidstr(cosa, argp);
1199 return cosa->nchannels;
1201 if (!capable(CAP_SYS_RAWIO))
1205 if (arg != COSA_BM_OFF && arg != COSA_BM_ON)
1207 cosa->busmaster = arg;
1210 return cosa->busmaster;
1212 return -ENOIOCTLCMD;
1215 static int cosa_sppp_ioctl(struct net_device *dev, struct ifreq *ifr,
1219 struct channel_data *chan = dev->priv;
1220 rv = cosa_ioctl_common(chan->cosa, chan, cmd, (unsigned long)ifr->ifr_data);
1221 if (rv == -ENOIOCTLCMD) {
1222 return sppp_do_ioctl(dev, ifr, cmd);
1227 static int cosa_chardev_ioctl(struct inode *inode, struct file *file,
1228 unsigned int cmd, unsigned long arg)
1230 struct channel_data *channel = file->private_data;
1231 struct cosa_data *cosa = channel->cosa;
1232 return cosa_ioctl_common(cosa, channel, cmd, arg);
1236 /*---------- HW layer interface ---------- */
1239 * The higher layer can bind itself to the HW layer by setting the callbacks
1240 * in the channel_data structure and by using these routines.
1242 static void cosa_enable_rx(struct channel_data *chan)
1244 struct cosa_data *cosa = chan->cosa;
1246 if (!test_and_set_bit(chan->num, &cosa->rxbitmap))
1247 put_driver_status(cosa);
1250 static void cosa_disable_rx(struct channel_data *chan)
1252 struct cosa_data *cosa = chan->cosa;
1254 if (test_and_clear_bit(chan->num, &cosa->rxbitmap))
1255 put_driver_status(cosa);
1259 * FIXME: This routine probably should check for cosa_start_tx() called when
1260 * the previous transmit is still unfinished. In this case the non-zero
1261 * return value should indicate to the caller that the queuing(sp?) up
1262 * the transmit has failed.
1264 static int cosa_start_tx(struct channel_data *chan, char *buf, int len)
1266 struct cosa_data *cosa = chan->cosa;
1267 unsigned long flags;
1271 printk(KERN_INFO "cosa%dc%d: starting tx(0x%x)", chan->cosa->num,
1273 for (i=0; i<len; i++)
1274 printk(" %02x", buf[i]&0xff);
1277 spin_lock_irqsave(&cosa->lock, flags);
1281 chan->txsize = COSA_MTU;
1282 spin_unlock_irqrestore(&cosa->lock, flags);
1284 /* Tell the firmware we are ready */
1285 set_bit(chan->num, &cosa->txbitmap);
1286 put_driver_status(cosa);
1291 static void put_driver_status(struct cosa_data *cosa)
1293 unsigned long flags;
1296 spin_lock_irqsave(&cosa->lock, flags);
1298 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1299 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1300 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1301 &DRIVER_TXMAP_MASK : 0);
1303 if (cosa->rxbitmap|cosa->txbitmap) {
1304 if (!cosa->enabled) {
1305 cosa_putstatus(cosa, SR_RX_INT_ENA);
1307 debug_status_out(cosa, SR_RX_INT_ENA);
1311 } else if (cosa->enabled) {
1313 cosa_putstatus(cosa, 0);
1315 debug_status_out(cosa, 0);
1318 cosa_putdata8(cosa, status);
1320 debug_data_cmd(cosa, status);
1323 spin_unlock_irqrestore(&cosa->lock, flags);
1326 static void put_driver_status_nolock(struct cosa_data *cosa)
1330 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1331 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1332 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1333 &DRIVER_TXMAP_MASK : 0);
1335 if (cosa->rxbitmap|cosa->txbitmap) {
1336 cosa_putstatus(cosa, SR_RX_INT_ENA);
1338 debug_status_out(cosa, SR_RX_INT_ENA);
1342 cosa_putstatus(cosa, 0);
1344 debug_status_out(cosa, 0);
1348 cosa_putdata8(cosa, status);
1350 debug_data_cmd(cosa, status);
1355 * The "kickme" function: When the DMA times out, this is called to
1356 * clean up the driver status.
1357 * FIXME: Preliminary support, the interface is probably wrong.
1359 static void cosa_kick(struct cosa_data *cosa)
1361 unsigned long flags, flags1;
1362 char *s = "(probably) IRQ";
1364 if (test_bit(RXBIT, &cosa->rxtx))
1366 if (test_bit(TXBIT, &cosa->rxtx))
1369 printk(KERN_INFO "%s: %s timeout - restarting.\n", cosa->name, s);
1370 spin_lock_irqsave(&cosa->lock, flags);
1373 flags1 = claim_dma_lock();
1374 disable_dma(cosa->dma);
1375 clear_dma_ff(cosa->dma);
1376 release_dma_lock(flags1);
1378 /* FIXME: Anything else? */
1380 cosa_putstatus(cosa, 0);
1382 (void) cosa_getdata8(cosa);
1384 cosa_putdata8(cosa, 0);
1386 put_driver_status_nolock(cosa);
1387 spin_unlock_irqrestore(&cosa->lock, flags);
1391 * Check if the whole buffer is DMA-able. It means it is below the 16M of
1392 * physical memory and doesn't span the 64k boundary. For now it seems
1393 * SKB's never do this, but we'll check this anyway.
1395 static int cosa_dma_able(struct channel_data *chan, char *buf, int len)
1398 unsigned long b = (unsigned long)buf;
1399 if (b+len >= MAX_DMA_ADDRESS)
1401 if ((b^ (b+len)) & 0x10000) {
1403 printk(KERN_INFO "%s: packet spanning a 64k boundary\n",
1411 /* ---------- The SRP/COSA ROM monitor functions ---------- */
1414 * Downloading SRP microcode: say "w" to SRP monitor, it answers by "w=",
1415 * drivers need to say 4-digit hex number meaning start address of the microcode
1416 * separated by a single space. Monitor replies by saying " =". Now driver
1417 * has to write 4-digit hex number meaning the last byte address ended
1418 * by a single space. Monitor has to reply with a space. Now the download
1419 * begins. After the download monitor replies with "\r\n." (CR LF dot).
1421 static int download(struct cosa_data *cosa, const char __user *microcode, int length, int address)
1425 if (put_wait_data(cosa, 'w') == -1) return -1;
1426 if ((i=get_wait_data(cosa)) != 'w') { printk("dnld: 0x%04x\n",i); return -2;}
1427 if (get_wait_data(cosa) != '=') return -3;
1429 if (puthexnumber(cosa, address) < 0) return -4;
1430 if (put_wait_data(cosa, ' ') == -1) return -10;
1431 if (get_wait_data(cosa) != ' ') return -11;
1432 if (get_wait_data(cosa) != '=') return -12;
1434 if (puthexnumber(cosa, address+length-1) < 0) return -13;
1435 if (put_wait_data(cosa, ' ') == -1) return -18;
1436 if (get_wait_data(cosa) != ' ') return -19;
1440 #ifndef SRP_DOWNLOAD_AT_BOOT
1441 if (get_user(c, microcode))
1442 return -23; /* ??? */
1446 if (put_wait_data(cosa, c) == -1)
1451 if (get_wait_data(cosa) != '\r') return -21;
1452 if (get_wait_data(cosa) != '\n') return -22;
1453 if (get_wait_data(cosa) != '.') return -23;
1455 printk(KERN_DEBUG "cosa%d: download completed.\n", cosa->num);
1462 * Starting microcode is done via the "g" command of the SRP monitor.
1463 * The chat should be the following: "g" "g=" "<addr><CR>"
1464 * "<CR><CR><LF><CR><LF>".
1466 static int startmicrocode(struct cosa_data *cosa, int address)
1468 if (put_wait_data(cosa, 'g') == -1) return -1;
1469 if (get_wait_data(cosa) != 'g') return -2;
1470 if (get_wait_data(cosa) != '=') return -3;
1472 if (puthexnumber(cosa, address) < 0) return -4;
1473 if (put_wait_data(cosa, '\r') == -1) return -5;
1475 if (get_wait_data(cosa) != '\r') return -6;
1476 if (get_wait_data(cosa) != '\r') return -7;
1477 if (get_wait_data(cosa) != '\n') return -8;
1478 if (get_wait_data(cosa) != '\r') return -9;
1479 if (get_wait_data(cosa) != '\n') return -10;
1481 printk(KERN_DEBUG "cosa%d: microcode started\n", cosa->num);
1487 * Reading memory is done via the "r" command of the SRP monitor.
1488 * The chat is the following "r" "r=" "<addr> " " =" "<last_byte> " " "
1489 * Then driver can read the data and the conversation is finished
1490 * by SRP monitor sending "<CR><LF>." (dot at the end).
1492 * This routine is not needed during the normal operation and serves
1493 * for debugging purposes only.
1495 static int readmem(struct cosa_data *cosa, char __user *microcode, int length, int address)
1497 if (put_wait_data(cosa, 'r') == -1) return -1;
1498 if ((get_wait_data(cosa)) != 'r') return -2;
1499 if ((get_wait_data(cosa)) != '=') return -3;
1501 if (puthexnumber(cosa, address) < 0) return -4;
1502 if (put_wait_data(cosa, ' ') == -1) return -5;
1503 if (get_wait_data(cosa) != ' ') return -6;
1504 if (get_wait_data(cosa) != '=') return -7;
1506 if (puthexnumber(cosa, address+length-1) < 0) return -8;
1507 if (put_wait_data(cosa, ' ') == -1) return -9;
1508 if (get_wait_data(cosa) != ' ') return -10;
1513 if ((i=get_wait_data(cosa)) == -1) {
1514 printk (KERN_INFO "cosa: 0x%04x bytes remaining\n",
1520 if (put_user(c, microcode))
1521 return -23; /* ??? */
1528 if (get_wait_data(cosa) != '\r') return -21;
1529 if (get_wait_data(cosa) != '\n') return -22;
1530 if (get_wait_data(cosa) != '.') return -23;
1532 printk(KERN_DEBUG "cosa%d: readmem completed.\n", cosa->num);
1538 * This function resets the device and reads the initial prompt
1539 * of the device's ROM monitor.
1541 static int cosa_reset_and_read_id(struct cosa_data *cosa, char *idstring)
1543 int i=0, id=0, prev=0, curr=0;
1545 /* Reset the card ... */
1546 cosa_putstatus(cosa, 0);
1547 cosa_getdata8(cosa);
1548 cosa_putstatus(cosa, SR_RST);
1554 /* Disable all IRQs from the card */
1555 cosa_putstatus(cosa, 0);
1558 * Try to read the ID string. The card then prints out the
1559 * identification string ended by the "\n\x2e".
1561 * The following loop is indexed through i (instead of id)
1562 * to avoid looping forever when for any reason
1563 * the port returns '\r', '\n' or '\x2e' permanently.
1565 for (i=0; i<COSA_MAX_ID_STRING-1; i++, prev=curr) {
1566 if ((curr = get_wait_data(cosa)) == -1) {
1570 if (curr != '\r' && curr != '\n' && curr != 0x2e)
1571 idstring[id++] = curr;
1572 if (curr == 0x2e && prev == '\n')
1575 /* Perhaps we should fail when i==COSA_MAX_ID_STRING-1 ? */
1576 idstring[id] = '\0';
1581 /* ---------- Auxiliary routines for COSA/SRP monitor ---------- */
1584 * This routine gets the data byte from the card waiting for the SR_RX_RDY
1585 * bit to be set in a loop. It should be used in the exceptional cases
1586 * only (for example when resetting the card or downloading the firmware.
1588 static int get_wait_data(struct cosa_data *cosa)
1593 /* read data and return them */
1594 if (cosa_getstatus(cosa) & SR_RX_RDY) {
1596 r = cosa_getdata8(cosa);
1598 printk(KERN_INFO "cosa: get_wait_data returning after %d retries\n", 999-retries);
1602 /* sleep if not ready to read */
1603 schedule_timeout_interruptible(1);
1605 printk(KERN_INFO "cosa: timeout in get_wait_data (status 0x%x)\n",
1606 cosa_getstatus(cosa));
1611 * This routine puts the data byte to the card waiting for the SR_TX_RDY
1612 * bit to be set in a loop. It should be used in the exceptional cases
1613 * only (for example when resetting the card or downloading the firmware).
1615 static int put_wait_data(struct cosa_data *cosa, int data)
1619 /* read data and return them */
1620 if (cosa_getstatus(cosa) & SR_TX_RDY) {
1621 cosa_putdata8(cosa, data);
1623 printk(KERN_INFO "Putdata: %d retries\n", 999-retries);
1628 /* sleep if not ready to read */
1629 schedule_timeout_interruptible(1);
1632 printk(KERN_INFO "cosa%d: timeout in put_wait_data (status 0x%x)\n",
1633 cosa->num, cosa_getstatus(cosa));
1638 * The following routine puts the hexadecimal number into the SRP monitor
1639 * and verifies the proper echo of the sent bytes. Returns 0 on success,
1640 * negative number on failure (-1,-3,-5,-7) means that put_wait_data() failed,
1641 * (-2,-4,-6,-8) means that reading echo failed.
1643 static int puthexnumber(struct cosa_data *cosa, int number)
1648 /* Well, I should probably replace this by something faster. */
1649 sprintf(temp, "%04X", number);
1650 for (i=0; i<4; i++) {
1651 if (put_wait_data(cosa, temp[i]) == -1) {
1652 printk(KERN_NOTICE "cosa%d: puthexnumber failed to write byte %d\n",
1656 if (get_wait_data(cosa) != temp[i]) {
1657 printk(KERN_NOTICE "cosa%d: puthexhumber failed to read echo of byte %d\n",
1666 /* ---------- Interrupt routines ---------- */
1669 * There are three types of interrupt:
1670 * At the beginning of transmit - this handled is in tx_interrupt(),
1671 * at the beginning of receive - it is in rx_interrupt() and
1672 * at the end of transmit/receive - it is the eot_interrupt() function.
1673 * These functions are multiplexed by cosa_interrupt() according to the
1674 * COSA status byte. I have moved the rx/tx/eot interrupt handling into
1675 * separate functions to make it more readable. These functions are inline,
1676 * so there should be no overhead of function call.
1678 * In the COSA bus-master mode, we need to tell the card the address of a
1679 * buffer. Unfortunately, COSA may be too slow for us, so we must busy-wait.
1680 * It's time to use the bottom half :-(
1684 * Transmit interrupt routine - called when COSA is willing to obtain
1685 * data from the OS. The most tricky part of the routine is selection
1686 * of channel we (OS) want to send packet for. For SRP we should probably
1687 * use the round-robin approach. The newer COSA firmwares have a simple
1688 * flow-control - in the status word has bits 2 and 3 set to 1 means that the
1689 * channel 0 or 1 doesn't want to receive data.
1691 * It seems there is a bug in COSA firmware (need to trace it further):
1692 * When the driver status says that the kernel has no more data for transmit
1693 * (e.g. at the end of TX DMA) and then the kernel changes its mind
1694 * (e.g. new packet is queued to hard_start_xmit()), the card issues
1695 * the TX interrupt but does not mark the channel as ready-to-transmit.
1696 * The fix seems to be to push the packet to COSA despite its request.
1697 * We first try to obey the card's opinion, and then fall back to forced TX.
1699 static inline void tx_interrupt(struct cosa_data *cosa, int status)
1701 unsigned long flags, flags1;
1703 printk(KERN_INFO "cosa%d: SR_DOWN_REQUEST status=0x%04x\n",
1706 spin_lock_irqsave(&cosa->lock, flags);
1707 set_bit(TXBIT, &cosa->rxtx);
1708 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1709 /* flow control, see the comment above */
1711 if (!cosa->txbitmap) {
1712 printk(KERN_WARNING "%s: No channel wants data "
1713 "in TX IRQ. Expect DMA timeout.",
1715 put_driver_status_nolock(cosa);
1716 clear_bit(TXBIT, &cosa->rxtx);
1717 spin_unlock_irqrestore(&cosa->lock, flags);
1723 if (cosa->txchan >= cosa->nchannels)
1725 if (!(cosa->txbitmap & (1<<cosa->txchan)))
1727 if (~status & (1 << (cosa->txchan+DRIVER_TXMAP_SHIFT)))
1729 /* in second pass, accept first ready-to-TX channel */
1730 if (i > cosa->nchannels) {
1731 /* Can be safely ignored */
1733 printk(KERN_DEBUG "%s: Forcing TX "
1734 "to not-ready channel %d\n",
1735 cosa->name, cosa->txchan);
1741 cosa->txsize = cosa->chan[cosa->txchan].txsize;
1742 if (cosa_dma_able(cosa->chan+cosa->txchan,
1743 cosa->chan[cosa->txchan].txbuf, cosa->txsize)) {
1744 cosa->txbuf = cosa->chan[cosa->txchan].txbuf;
1746 memcpy(cosa->bouncebuf, cosa->chan[cosa->txchan].txbuf,
1748 cosa->txbuf = cosa->bouncebuf;
1752 if (is_8bit(cosa)) {
1753 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1754 cosa_putstatus(cosa, SR_TX_INT_ENA);
1755 cosa_putdata8(cosa, ((cosa->txchan << 5) & 0xe0)|
1756 ((cosa->txsize >> 8) & 0x1f));
1758 debug_status_out(cosa, SR_TX_INT_ENA);
1759 debug_data_out(cosa, ((cosa->txchan << 5) & 0xe0)|
1760 ((cosa->txsize >> 8) & 0x1f));
1761 debug_data_in(cosa, cosa_getdata8(cosa));
1763 cosa_getdata8(cosa);
1765 set_bit(IRQBIT, &cosa->rxtx);
1766 spin_unlock_irqrestore(&cosa->lock, flags);
1769 clear_bit(IRQBIT, &cosa->rxtx);
1770 cosa_putstatus(cosa, 0);
1771 cosa_putdata8(cosa, cosa->txsize&0xff);
1773 debug_status_out(cosa, 0);
1774 debug_data_out(cosa, cosa->txsize&0xff);
1778 cosa_putstatus(cosa, SR_TX_INT_ENA);
1779 cosa_putdata16(cosa, ((cosa->txchan<<13) & 0xe000)
1780 | (cosa->txsize & 0x1fff));
1782 debug_status_out(cosa, SR_TX_INT_ENA);
1783 debug_data_out(cosa, ((cosa->txchan<<13) & 0xe000)
1784 | (cosa->txsize & 0x1fff));
1785 debug_data_in(cosa, cosa_getdata8(cosa));
1786 debug_status_out(cosa, 0);
1788 cosa_getdata8(cosa);
1790 cosa_putstatus(cosa, 0);
1793 if (cosa->busmaster) {
1794 unsigned long addr = virt_to_bus(cosa->txbuf);
1796 printk(KERN_INFO "busmaster IRQ\n");
1797 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1800 if (count > 1000) break;
1802 printk(KERN_INFO "status %x\n", cosa_getstatus(cosa));
1803 printk(KERN_INFO "ready after %d loops\n", count);
1804 cosa_putdata16(cosa, (addr >> 16)&0xffff);
1807 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1809 if (count > 1000) break;
1812 printk(KERN_INFO "ready after %d loops\n", count);
1813 cosa_putdata16(cosa, addr &0xffff);
1814 flags1 = claim_dma_lock();
1815 set_dma_mode(cosa->dma, DMA_MODE_CASCADE);
1816 enable_dma(cosa->dma);
1817 release_dma_lock(flags1);
1820 flags1 = claim_dma_lock();
1821 disable_dma(cosa->dma);
1822 clear_dma_ff(cosa->dma);
1823 set_dma_mode(cosa->dma, DMA_MODE_WRITE);
1824 set_dma_addr(cosa->dma, virt_to_bus(cosa->txbuf));
1825 set_dma_count(cosa->dma, cosa->txsize);
1826 enable_dma(cosa->dma);
1827 release_dma_lock(flags1);
1829 cosa_putstatus(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1831 debug_status_out(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1833 spin_unlock_irqrestore(&cosa->lock, flags);
1836 static inline void rx_interrupt(struct cosa_data *cosa, int status)
1838 unsigned long flags;
1840 printk(KERN_INFO "cosa%d: SR_UP_REQUEST\n", cosa->num);
1843 spin_lock_irqsave(&cosa->lock, flags);
1844 set_bit(RXBIT, &cosa->rxtx);
1846 if (is_8bit(cosa)) {
1847 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1848 set_bit(IRQBIT, &cosa->rxtx);
1849 put_driver_status_nolock(cosa);
1850 cosa->rxsize = cosa_getdata8(cosa) <<8;
1852 debug_data_in(cosa, cosa->rxsize >> 8);
1854 spin_unlock_irqrestore(&cosa->lock, flags);
1857 clear_bit(IRQBIT, &cosa->rxtx);
1858 cosa->rxsize |= cosa_getdata8(cosa) & 0xff;
1860 debug_data_in(cosa, cosa->rxsize & 0xff);
1863 printk(KERN_INFO "cosa%d: receive rxsize = (0x%04x).\n",
1864 cosa->num, cosa->rxsize);
1868 cosa->rxsize = cosa_getdata16(cosa);
1870 debug_data_in(cosa, cosa->rxsize);
1873 printk(KERN_INFO "cosa%d: receive rxsize = (0x%04x).\n",
1874 cosa->num, cosa->rxsize);
1877 if (((cosa->rxsize & 0xe000) >> 13) >= cosa->nchannels) {
1878 printk(KERN_WARNING "%s: rx for unknown channel (0x%04x)\n",
1879 cosa->name, cosa->rxsize);
1880 spin_unlock_irqrestore(&cosa->lock, flags);
1883 cosa->rxchan = cosa->chan + ((cosa->rxsize & 0xe000) >> 13);
1884 cosa->rxsize &= 0x1fff;
1885 spin_unlock_irqrestore(&cosa->lock, flags);
1888 if (cosa->rxchan->setup_rx)
1889 cosa->rxbuf = cosa->rxchan->setup_rx(cosa->rxchan, cosa->rxsize);
1892 reject: /* Reject the packet */
1893 printk(KERN_INFO "cosa%d: rejecting packet on channel %d\n",
1894 cosa->num, cosa->rxchan->num);
1895 cosa->rxbuf = cosa->bouncebuf;
1899 flags = claim_dma_lock();
1900 disable_dma(cosa->dma);
1901 clear_dma_ff(cosa->dma);
1902 set_dma_mode(cosa->dma, DMA_MODE_READ);
1903 if (cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize & 0x1fff)) {
1904 set_dma_addr(cosa->dma, virt_to_bus(cosa->rxbuf));
1906 set_dma_addr(cosa->dma, virt_to_bus(cosa->bouncebuf));
1908 set_dma_count(cosa->dma, (cosa->rxsize&0x1fff));
1909 enable_dma(cosa->dma);
1910 release_dma_lock(flags);
1911 spin_lock_irqsave(&cosa->lock, flags);
1912 cosa_putstatus(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1913 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1914 cosa_putdata8(cosa, DRIVER_RX_READY);
1916 debug_status_out(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1917 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1918 debug_data_cmd(cosa, DRIVER_RX_READY);
1920 spin_unlock_irqrestore(&cosa->lock, flags);
1923 static inline void eot_interrupt(struct cosa_data *cosa, int status)
1925 unsigned long flags, flags1;
1926 spin_lock_irqsave(&cosa->lock, flags);
1927 flags1 = claim_dma_lock();
1928 disable_dma(cosa->dma);
1929 clear_dma_ff(cosa->dma);
1930 release_dma_lock(flags1);
1931 if (test_bit(TXBIT, &cosa->rxtx)) {
1932 struct channel_data *chan = cosa->chan+cosa->txchan;
1934 if (chan->tx_done(chan, cosa->txsize))
1935 clear_bit(chan->num, &cosa->txbitmap);
1936 } else if (test_bit(RXBIT, &cosa->rxtx)) {
1940 printk(KERN_INFO "cosa%dc%d: done rx(0x%x)", cosa->num,
1941 cosa->rxchan->num, cosa->rxsize);
1942 for (i=0; i<cosa->rxsize; i++)
1943 printk (" %02x", cosa->rxbuf[i]&0xff);
1947 /* Packet for unknown channel? */
1948 if (cosa->rxbuf == cosa->bouncebuf)
1950 if (!cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize))
1951 memcpy(cosa->rxbuf, cosa->bouncebuf, cosa->rxsize);
1952 if (cosa->rxchan->rx_done)
1953 if (cosa->rxchan->rx_done(cosa->rxchan))
1954 clear_bit(cosa->rxchan->num, &cosa->rxbitmap);
1956 printk(KERN_NOTICE "cosa%d: unexpected EOT interrupt\n",
1960 * Clear the RXBIT, TXBIT and IRQBIT (the latest should be
1961 * cleared anyway). We should do it as soon as possible
1962 * so that we can tell the COSA we are done and to give it a time
1967 put_driver_status_nolock(cosa);
1968 spin_unlock_irqrestore(&cosa->lock, flags);
1971 static irqreturn_t cosa_interrupt(int irq, void *cosa_)
1975 struct cosa_data *cosa = cosa_;
1977 status = cosa_getstatus(cosa);
1979 printk(KERN_INFO "cosa%d: got IRQ, status 0x%02x\n", cosa->num,
1983 debug_status_in(cosa, status);
1985 switch (status & SR_CMD_FROM_SRP_MASK) {
1986 case SR_DOWN_REQUEST:
1987 tx_interrupt(cosa, status);
1990 rx_interrupt(cosa, status);
1992 case SR_END_OF_TRANSFER:
1993 eot_interrupt(cosa, status);
1996 /* We may be too fast for SRP. Try to wait a bit more. */
1997 if (count++ < 100) {
2001 printk(KERN_INFO "cosa%d: unknown status 0x%02x in IRQ after %d retries\n",
2002 cosa->num, status & 0xff, count);
2006 printk(KERN_INFO "%s: %d-times got unknown status in IRQ\n",
2009 printk(KERN_INFO "%s: returning from IRQ\n", cosa->name);
2015 /* ---------- I/O debugging routines ---------- */
2017 * These routines can be used to monitor COSA/SRP I/O and to printk()
2018 * the data being transferred on the data and status I/O port in a
2023 static void debug_status_in(struct cosa_data *cosa, int status)
2026 switch(status & SR_CMD_FROM_SRP_MASK) {
2030 case SR_DOWN_REQUEST:
2033 case SR_END_OF_TRANSFER:
2040 printk(KERN_INFO "%s: IO: status -> 0x%02x (%s%s%s%s)\n",
2043 status & SR_USR_RQ ? "USR_RQ|":"",
2044 status & SR_TX_RDY ? "TX_RDY|":"",
2045 status & SR_RX_RDY ? "RX_RDY|":"",
2049 static void debug_status_out(struct cosa_data *cosa, int status)
2051 printk(KERN_INFO "%s: IO: status <- 0x%02x (%s%s%s%s%s%s)\n",
2054 status & SR_RX_DMA_ENA ? "RXDMA|":"!rxdma|",
2055 status & SR_TX_DMA_ENA ? "TXDMA|":"!txdma|",
2056 status & SR_RST ? "RESET|":"",
2057 status & SR_USR_INT_ENA ? "USRINT|":"!usrint|",
2058 status & SR_TX_INT_ENA ? "TXINT|":"!txint|",
2059 status & SR_RX_INT_ENA ? "RXINT":"!rxint");
2062 static void debug_data_in(struct cosa_data *cosa, int data)
2064 printk(KERN_INFO "%s: IO: data -> 0x%04x\n", cosa->name, data);
2067 static void debug_data_out(struct cosa_data *cosa, int data)
2069 printk(KERN_INFO "%s: IO: data <- 0x%04x\n", cosa->name, data);
2072 static void debug_data_cmd(struct cosa_data *cosa, int data)
2074 printk(KERN_INFO "%s: IO: data <- 0x%04x (%s|%s)\n",
2076 data & SR_RDY_RCV ? "RX_RDY" : "!rx_rdy",
2077 data & SR_RDY_SND ? "TX_RDY" : "!tx_rdy");
2081 /* EOF -- this file has not been truncated */