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>
5 * Generic HDLC port Copyright (C) 2008 Krzysztof Halasa <khc@pm.waw.pl>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * The driver for the SRP and COSA synchronous serial cards.
27 * Both cards are developed at the Institute of Computer Science,
28 * Masaryk University (http://www.ics.muni.cz/). The hardware is
29 * developed by Jiri Novotny <novotny@ics.muni.cz>. More information
30 * and the photo of both cards is available at
31 * http://www.pavoucek.cz/cosa.html. The card documentation, firmwares
32 * and other goods can be downloaded from ftp://ftp.ics.muni.cz/pub/cosa/.
33 * For Linux-specific utilities, see below in the "Software info" section.
34 * If you want to order the card, contact Jiri Novotny.
36 * The SRP (serial port?, the Czech word "srp" means "sickle") card
37 * is a 2-port intelligent (with its own 8-bit CPU) synchronous serial card
38 * with V.24 interfaces up to 80kb/s each.
40 * The COSA (communication serial adapter?, the Czech word "kosa" means
41 * "scythe") is a next-generation sync/async board with two interfaces
42 * - currently any of V.24, X.21, V.35 and V.36 can be selected.
43 * It has a 16-bit SAB80166 CPU and can do up to 10 Mb/s per channel.
44 * The 8-channels version is in development.
46 * Both types have downloadable firmware and communicate via ISA DMA.
47 * COSA can be also a bus-mastering device.
51 * The homepage of the Linux driver is at http://www.fi.muni.cz/~kas/cosa/.
52 * The CVS tree of Linux driver can be viewed there, as well as the
53 * firmware binaries and user-space utilities for downloading the firmware
54 * into the card and setting up the card.
56 * The Linux driver (unlike the present *BSD drivers :-) can work even
57 * for the COSA and SRP in one computer and allows each channel to work
58 * in one of the two modes (character or network device).
62 * The Linux driver was written by Jan "Yenya" Kasprzak <kas@fi.muni.cz>.
64 * You can mail me bugfixes and even success reports. I am especially
65 * interested in the SMP and/or muliti-channel success/failure reports
66 * (I wonder if I did the locking properly :-).
68 * THE AUTHOR USED THE FOLLOWING SOURCES WHEN PROGRAMMING THE DRIVER
70 * The COSA/SRP NetBSD driver by Zdenek Salvet and Ivos Cernohlavek
71 * The skeleton.c by Donald Becker
72 * The SDL Riscom/N2 driver by Mike Natale
73 * The Comtrol Hostess SV11 driver by Alan Cox
74 * The Sync PPP/Cisco HDLC layer (syncppp.c) ported to Linux by Alan Cox
77 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
79 #include <linux/module.h>
80 #include <linux/kernel.h>
81 #include <linux/sched.h>
82 #include <linux/slab.h>
83 #include <linux/poll.h>
85 #include <linux/interrupt.h>
86 #include <linux/delay.h>
87 #include <linux/hdlc.h>
88 #include <linux/errno.h>
89 #include <linux/ioport.h>
90 #include <linux/netdevice.h>
91 #include <linux/spinlock.h>
92 #include <linux/mutex.h>
93 #include <linux/device.h>
96 #include <asm/byteorder.h>
98 #undef COSA_SLOW_IO /* for testing purposes only */
102 /* Maximum length of the identification string. */
103 #define COSA_MAX_ID_STRING 128
105 /* Maximum length of the channel name */
106 #define COSA_MAX_NAME (sizeof("cosaXXXcXXX")+1)
108 /* Per-channel data structure */
110 struct channel_data {
111 int usage; /* Usage count; >0 for chrdev, -1 for netdev */
112 int num; /* Number of the channel */
113 struct cosa_data *cosa; /* Pointer to the per-card structure */
114 int txsize; /* Size of transmitted data */
115 char *txbuf; /* Transmit buffer */
116 char name[COSA_MAX_NAME]; /* channel name */
118 /* The HW layer interface */
119 /* routine called from the RX interrupt */
120 char *(*setup_rx)(struct channel_data *channel, int size);
121 /* routine called when the RX is done (from the EOT interrupt) */
122 int (*rx_done)(struct channel_data *channel);
123 /* routine called when the TX is done (from the EOT interrupt) */
124 int (*tx_done)(struct channel_data *channel, int size);
126 /* Character device parts */
128 struct semaphore wsem;
131 wait_queue_head_t txwaitq, rxwaitq;
132 int tx_status, rx_status;
134 /* generic HDLC device parts */
135 struct net_device *netdev;
136 struct sk_buff *rx_skb, *tx_skb;
139 /* cosa->firmware_status bits */
140 #define COSA_FW_RESET (1<<0) /* Is the ROM monitor active? */
141 #define COSA_FW_DOWNLOAD (1<<1) /* Is the microcode downloaded? */
142 #define COSA_FW_START (1<<2) /* Is the microcode running? */
145 int num; /* Card number */
146 char name[COSA_MAX_NAME]; /* Card name - e.g "cosa0" */
147 unsigned int datareg, statusreg; /* I/O ports */
148 unsigned short irq, dma; /* IRQ and DMA number */
149 unsigned short startaddr; /* Firmware start address */
150 unsigned short busmaster; /* Use busmastering? */
151 int nchannels; /* # of channels on this card */
152 int driver_status; /* For communicating with firmware */
153 int firmware_status; /* Downloaded, reseted, etc. */
154 unsigned long rxbitmap, txbitmap;/* Bitmap of channels who are willing to send/receive data */
155 unsigned long rxtx; /* RX or TX in progress? */
157 int usage; /* usage count */
158 int txchan, txsize, rxsize;
159 struct channel_data *rxchan;
162 struct channel_data *chan;
163 spinlock_t lock; /* For exclusive operations on this structure */
164 char id_string[COSA_MAX_ID_STRING]; /* ROM monitor ID string */
165 char *type; /* card type */
169 * Define this if you want all the possible ports to be autoprobed.
170 * It is here but it probably is not a good idea to use this.
172 /* #define COSA_ISA_AUTOPROBE 1 */
175 * Character device major number. 117 was allocated for us.
176 * The value of 0 means to allocate a first free one.
178 static DEFINE_MUTEX(cosa_chardev_mutex);
179 static int cosa_major = 117;
182 * Encoding of the minor numbers:
183 * The lowest CARD_MINOR_BITS bits means the channel on the single card,
184 * the highest bits means the card number.
186 #define CARD_MINOR_BITS 4 /* How many bits in minor number are reserved
187 * for the single card */
189 * The following depends on CARD_MINOR_BITS. Unfortunately, the "MODULE_STRING"
190 * macro doesn't like anything other than the raw number as an argument :-(
193 /* #define MAX_CARDS (1 << (8-CARD_MINOR_BITS)) */
195 #define DRIVER_RX_READY 0x0001
196 #define DRIVER_TX_READY 0x0002
197 #define DRIVER_TXMAP_SHIFT 2
198 #define DRIVER_TXMAP_MASK 0x0c /* FIXME: 0xfc for 8-channel version */
201 * for cosa->rxtx - indicates whether either transmit or receive is
202 * in progress. These values are mean number of the bit.
208 #define COSA_MTU 2000 /* FIXME: I don't know this exactly */
210 #undef DEBUG_DATA //1 /* Dump the data read or written to the channel */
211 #undef DEBUG_IRQS //1 /* Print the message when the IRQ is received */
212 #undef DEBUG_IO //1 /* Dump the I/O traffic */
214 #define TX_TIMEOUT (5*HZ)
216 /* Maybe the following should be allocated dynamically */
217 static struct cosa_data cosa_cards[MAX_CARDS];
220 #ifdef COSA_ISA_AUTOPROBE
221 static int io[MAX_CARDS+1] = { 0x220, 0x228, 0x210, 0x218, 0, };
222 /* NOTE: DMA is not autoprobed!!! */
223 static int dma[MAX_CARDS+1] = { 1, 7, 1, 7, 1, 7, 1, 7, 0, };
225 static int io[MAX_CARDS+1];
226 static int dma[MAX_CARDS+1];
228 /* IRQ can be safely autoprobed */
229 static int irq[MAX_CARDS+1] = { -1, -1, -1, -1, -1, -1, 0, };
232 static struct class *cosa_class;
235 module_param_array(io, int, NULL, 0);
236 MODULE_PARM_DESC(io, "The I/O bases of the COSA or SRP cards");
237 module_param_array(irq, int, NULL, 0);
238 MODULE_PARM_DESC(irq, "The IRQ lines of the COSA or SRP cards");
239 module_param_array(dma, int, NULL, 0);
240 MODULE_PARM_DESC(dma, "The DMA channels of the COSA or SRP cards");
242 MODULE_AUTHOR("Jan \"Yenya\" Kasprzak, <kas@fi.muni.cz>");
243 MODULE_DESCRIPTION("Modular driver for the COSA or SRP synchronous card");
244 MODULE_LICENSE("GPL");
247 /* I use this mainly for testing purposes */
249 #define cosa_outb outb_p
250 #define cosa_outw outw_p
251 #define cosa_inb inb_p
252 #define cosa_inw inw_p
254 #define cosa_outb outb
255 #define cosa_outw outw
260 #define is_8bit(cosa) (!(cosa->datareg & 0x08))
262 #define cosa_getstatus(cosa) (cosa_inb(cosa->statusreg))
263 #define cosa_putstatus(cosa, stat) (cosa_outb(stat, cosa->statusreg))
264 #define cosa_getdata16(cosa) (cosa_inw(cosa->datareg))
265 #define cosa_getdata8(cosa) (cosa_inb(cosa->datareg))
266 #define cosa_putdata16(cosa, dt) (cosa_outw(dt, cosa->datareg))
267 #define cosa_putdata8(cosa, dt) (cosa_outb(dt, cosa->datareg))
269 /* Initialization stuff */
270 static int cosa_probe(int ioaddr, int irq, int dma);
273 static void cosa_enable_rx(struct channel_data *chan);
274 static void cosa_disable_rx(struct channel_data *chan);
275 static int cosa_start_tx(struct channel_data *channel, char *buf, int size);
276 static void cosa_kick(struct cosa_data *cosa);
277 static int cosa_dma_able(struct channel_data *chan, char *buf, int data);
279 /* Network device stuff */
280 static int cosa_net_attach(struct net_device *dev, unsigned short encoding,
281 unsigned short parity);
282 static int cosa_net_open(struct net_device *d);
283 static int cosa_net_close(struct net_device *d);
284 static void cosa_net_timeout(struct net_device *d);
285 static netdev_tx_t cosa_net_tx(struct sk_buff *skb, struct net_device *d);
286 static char *cosa_net_setup_rx(struct channel_data *channel, int size);
287 static int cosa_net_rx_done(struct channel_data *channel);
288 static int cosa_net_tx_done(struct channel_data *channel, int size);
289 static int cosa_net_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
291 /* Character device */
292 static char *chrdev_setup_rx(struct channel_data *channel, int size);
293 static int chrdev_rx_done(struct channel_data *channel);
294 static int chrdev_tx_done(struct channel_data *channel, int size);
295 static ssize_t cosa_read(struct file *file,
296 char __user *buf, size_t count, loff_t *ppos);
297 static ssize_t cosa_write(struct file *file,
298 const char __user *buf, size_t count, loff_t *ppos);
299 static unsigned int cosa_poll(struct file *file, poll_table *poll);
300 static int cosa_open(struct inode *inode, struct file *file);
301 static int cosa_release(struct inode *inode, struct file *file);
302 static long cosa_chardev_ioctl(struct file *file, unsigned int cmd,
304 #ifdef COSA_FASYNC_WORKING
305 static int cosa_fasync(struct inode *inode, struct file *file, int on);
308 static const struct file_operations cosa_fops = {
309 .owner = THIS_MODULE,
314 .unlocked_ioctl = cosa_chardev_ioctl,
316 .release = cosa_release,
317 #ifdef COSA_FASYNC_WORKING
318 .fasync = cosa_fasync,
323 static int cosa_start(struct cosa_data *cosa, int address);
324 static int cosa_reset(struct cosa_data *cosa);
325 static int cosa_download(struct cosa_data *cosa, void __user *a);
326 static int cosa_readmem(struct cosa_data *cosa, void __user *a);
328 /* COSA/SRP ROM monitor */
329 static int download(struct cosa_data *cosa, const char __user *data, int addr, int len);
330 static int startmicrocode(struct cosa_data *cosa, int address);
331 static int readmem(struct cosa_data *cosa, char __user *data, int addr, int len);
332 static int cosa_reset_and_read_id(struct cosa_data *cosa, char *id);
334 /* Auxiliary functions */
335 static int get_wait_data(struct cosa_data *cosa);
336 static int put_wait_data(struct cosa_data *cosa, int data);
337 static int puthexnumber(struct cosa_data *cosa, int number);
338 static void put_driver_status(struct cosa_data *cosa);
339 static void put_driver_status_nolock(struct cosa_data *cosa);
341 /* Interrupt handling */
342 static irqreturn_t cosa_interrupt(int irq, void *cosa);
344 /* I/O ops debugging */
346 static void debug_data_in(struct cosa_data *cosa, int data);
347 static void debug_data_out(struct cosa_data *cosa, int data);
348 static void debug_data_cmd(struct cosa_data *cosa, int data);
349 static void debug_status_in(struct cosa_data *cosa, int status);
350 static void debug_status_out(struct cosa_data *cosa, int status);
353 static inline struct channel_data* dev_to_chan(struct net_device *dev)
355 return (struct channel_data *)dev_to_hdlc(dev)->priv;
358 /* ---------- Initialization stuff ---------- */
360 static int __init cosa_init(void)
364 if (cosa_major > 0) {
365 if (register_chrdev(cosa_major, "cosa", &cosa_fops)) {
366 pr_warn("unable to get major %d\n", cosa_major);
371 if (!(cosa_major=register_chrdev(0, "cosa", &cosa_fops))) {
372 pr_warn("unable to register chardev\n");
377 for (i=0; i<MAX_CARDS; i++)
378 cosa_cards[i].num = -1;
379 for (i=0; io[i] != 0 && i < MAX_CARDS; i++)
380 cosa_probe(io[i], irq[i], dma[i]);
382 pr_warn("no devices found\n");
383 unregister_chrdev(cosa_major, "cosa");
387 cosa_class = class_create(THIS_MODULE, "cosa");
388 if (IS_ERR(cosa_class)) {
389 err = PTR_ERR(cosa_class);
392 for (i = 0; i < nr_cards; i++)
393 device_create(cosa_class, NULL, MKDEV(cosa_major, i), NULL,
399 unregister_chrdev(cosa_major, "cosa");
403 module_init(cosa_init);
405 static void __exit cosa_exit(void)
407 struct cosa_data *cosa;
410 for (i = 0; i < nr_cards; i++)
411 device_destroy(cosa_class, MKDEV(cosa_major, i));
412 class_destroy(cosa_class);
414 for (cosa = cosa_cards; nr_cards--; cosa++) {
415 /* Clean up the per-channel data */
416 for (i = 0; i < cosa->nchannels; i++) {
417 /* Chardev driver has no alloc'd per-channel data */
418 unregister_hdlc_device(cosa->chan[i].netdev);
419 free_netdev(cosa->chan[i].netdev);
421 /* Clean up the per-card data */
423 kfree(cosa->bouncebuf);
424 free_irq(cosa->irq, cosa);
426 release_region(cosa->datareg, is_8bit(cosa) ? 2 : 4);
428 unregister_chrdev(cosa_major, "cosa");
430 module_exit(cosa_exit);
432 static const struct net_device_ops cosa_ops = {
433 .ndo_open = cosa_net_open,
434 .ndo_stop = cosa_net_close,
435 .ndo_change_mtu = hdlc_change_mtu,
436 .ndo_start_xmit = hdlc_start_xmit,
437 .ndo_do_ioctl = cosa_net_ioctl,
438 .ndo_tx_timeout = cosa_net_timeout,
441 static int cosa_probe(int base, int irq, int dma)
443 struct cosa_data *cosa = cosa_cards+nr_cards;
446 memset(cosa, 0, sizeof(struct cosa_data));
448 /* Checking validity of parameters: */
449 /* IRQ should be 2-7 or 10-15; negative IRQ means autoprobe */
450 if ((irq >= 0 && irq < 2) || irq > 15 || (irq < 10 && irq > 7)) {
451 pr_info("invalid IRQ %d\n", irq);
454 /* I/O address should be between 0x100 and 0x3ff and should be
456 if (base < 0x100 || base > 0x3ff || base & 0x7) {
457 pr_info("invalid I/O address 0x%x\n", base);
460 /* DMA should be 0,1 or 3-7 */
461 if (dma < 0 || dma == 4 || dma > 7) {
462 pr_info("invalid DMA %d\n", dma);
465 /* and finally, on 16-bit COSA DMA should be 4-7 and
466 * I/O base should not be multiple of 0x10 */
467 if (((base & 0x8) && dma < 4) || (!(base & 0x8) && dma > 3)) {
468 pr_info("8/16 bit base and DMA mismatch (base=0x%x, dma=%d)\n",
474 cosa->datareg = base;
475 cosa->statusreg = is_8bit(cosa)?base+1:base+2;
476 spin_lock_init(&cosa->lock);
478 if (!request_region(base, is_8bit(cosa)?2:4,"cosa"))
481 if (cosa_reset_and_read_id(cosa, cosa->id_string) < 0) {
482 printk(KERN_DEBUG "probe at 0x%x failed.\n", base);
487 /* Test the validity of identification string */
488 if (!strncmp(cosa->id_string, "SRP", 3))
490 else if (!strncmp(cosa->id_string, "COSA", 4))
491 cosa->type = is_8bit(cosa)? "cosa8": "cosa16";
493 /* Print a warning only if we are not autoprobing */
494 #ifndef COSA_ISA_AUTOPROBE
495 pr_info("valid signature not found at 0x%x\n", base);
500 /* Update the name of the region now we know the type of card */
501 release_region(base, is_8bit(cosa)?2:4);
502 if (!request_region(base, is_8bit(cosa)?2:4, cosa->type)) {
503 printk(KERN_DEBUG "changing name at 0x%x failed.\n", base);
507 /* Now do IRQ autoprobe */
510 /* pr_info("IRQ autoprobe\n"); */
511 irqs = probe_irq_on();
513 * Enable interrupt on tx buffer empty (it sure is)
515 * FIXME: When this code is not used as module, we should
516 * probably call udelay() instead of the interruptible sleep.
518 set_current_state(TASK_INTERRUPTIBLE);
519 cosa_putstatus(cosa, SR_TX_INT_ENA);
520 schedule_timeout(30);
521 irq = probe_irq_off(irqs);
522 /* Disable all IRQs from the card */
523 cosa_putstatus(cosa, 0);
524 /* Empty the received data register */
528 pr_info("multiple interrupts obtained (%d, board at 0x%x)\n",
534 pr_info("no interrupt obtained (board at 0x%x)\n",
541 cosa->num = nr_cards;
543 cosa->nchannels = 2; /* FIXME: how to determine this? */
545 if (request_irq(cosa->irq, cosa_interrupt, 0, cosa->type, cosa)) {
549 if (request_dma(cosa->dma, cosa->type)) {
554 cosa->bouncebuf = kmalloc(COSA_MTU, GFP_KERNEL|GFP_DMA);
555 if (!cosa->bouncebuf) {
559 sprintf(cosa->name, "cosa%d", cosa->num);
561 /* Initialize the per-channel data */
562 cosa->chan = kcalloc(cosa->nchannels, sizeof(struct channel_data), GFP_KERNEL);
568 for (i = 0; i < cosa->nchannels; i++) {
569 struct channel_data *chan = &cosa->chan[i];
573 sprintf(chan->name, "cosa%dc%d", chan->cosa->num, i);
575 /* Initialize the chardev data structures */
576 mutex_init(&chan->rlock);
577 sema_init(&chan->wsem, 1);
579 /* Register the network interface */
580 if (!(chan->netdev = alloc_hdlcdev(chan))) {
581 pr_warn("%s: alloc_hdlcdev failed\n", chan->name);
584 dev_to_hdlc(chan->netdev)->attach = cosa_net_attach;
585 dev_to_hdlc(chan->netdev)->xmit = cosa_net_tx;
586 chan->netdev->netdev_ops = &cosa_ops;
587 chan->netdev->watchdog_timeo = TX_TIMEOUT;
588 chan->netdev->base_addr = chan->cosa->datareg;
589 chan->netdev->irq = chan->cosa->irq;
590 chan->netdev->dma = chan->cosa->dma;
591 if (register_hdlc_device(chan->netdev)) {
592 netdev_warn(chan->netdev,
593 "register_hdlc_device() failed\n");
594 free_netdev(chan->netdev);
599 pr_info("cosa%d: %s (%s at 0x%x irq %d dma %d), %d channels\n",
600 cosa->num, cosa->id_string, cosa->type,
601 cosa->datareg, cosa->irq, cosa->dma, cosa->nchannels);
607 unregister_hdlc_device(cosa->chan[i].netdev);
608 free_netdev(cosa->chan[i].netdev);
612 kfree(cosa->bouncebuf);
616 free_irq(cosa->irq, cosa);
618 release_region(cosa->datareg,is_8bit(cosa)?2:4);
619 pr_notice("cosa%d: allocating resources failed\n", cosa->num);
624 /*---------- network device ---------- */
626 static int cosa_net_attach(struct net_device *dev, unsigned short encoding,
627 unsigned short parity)
629 if (encoding == ENCODING_NRZ && parity == PARITY_CRC16_PR1_CCITT)
634 static int cosa_net_open(struct net_device *dev)
636 struct channel_data *chan = dev_to_chan(dev);
640 if (!(chan->cosa->firmware_status & COSA_FW_START)) {
641 pr_notice("%s: start the firmware first (status %d)\n",
642 chan->cosa->name, chan->cosa->firmware_status);
645 spin_lock_irqsave(&chan->cosa->lock, flags);
646 if (chan->usage != 0) {
647 pr_warn("%s: cosa_net_open called with usage count %d\n",
648 chan->name, chan->usage);
649 spin_unlock_irqrestore(&chan->cosa->lock, flags);
652 chan->setup_rx = cosa_net_setup_rx;
653 chan->tx_done = cosa_net_tx_done;
654 chan->rx_done = cosa_net_rx_done;
657 spin_unlock_irqrestore(&chan->cosa->lock, flags);
659 err = hdlc_open(dev);
661 spin_lock_irqsave(&chan->cosa->lock, flags);
664 spin_unlock_irqrestore(&chan->cosa->lock, flags);
668 netif_start_queue(dev);
669 cosa_enable_rx(chan);
673 static netdev_tx_t cosa_net_tx(struct sk_buff *skb,
674 struct net_device *dev)
676 struct channel_data *chan = dev_to_chan(dev);
678 netif_stop_queue(dev);
681 cosa_start_tx(chan, skb->data, skb->len);
685 static void cosa_net_timeout(struct net_device *dev)
687 struct channel_data *chan = dev_to_chan(dev);
689 if (test_bit(RXBIT, &chan->cosa->rxtx)) {
690 chan->netdev->stats.rx_errors++;
691 chan->netdev->stats.rx_missed_errors++;
693 chan->netdev->stats.tx_errors++;
694 chan->netdev->stats.tx_aborted_errors++;
696 cosa_kick(chan->cosa);
698 dev_kfree_skb(chan->tx_skb);
701 netif_wake_queue(dev);
704 static int cosa_net_close(struct net_device *dev)
706 struct channel_data *chan = dev_to_chan(dev);
709 netif_stop_queue(dev);
711 cosa_disable_rx(chan);
712 spin_lock_irqsave(&chan->cosa->lock, flags);
714 kfree_skb(chan->rx_skb);
718 kfree_skb(chan->tx_skb);
723 spin_unlock_irqrestore(&chan->cosa->lock, flags);
727 static char *cosa_net_setup_rx(struct channel_data *chan, int size)
730 * We can safely fall back to non-dma-able memory, because we have
731 * the cosa->bouncebuf pre-allocated.
733 kfree_skb(chan->rx_skb);
734 chan->rx_skb = dev_alloc_skb(size);
735 if (chan->rx_skb == NULL) {
736 pr_notice("%s: Memory squeeze, dropping packet\n", chan->name);
737 chan->netdev->stats.rx_dropped++;
740 chan->netdev->trans_start = jiffies;
741 return skb_put(chan->rx_skb, size);
744 static int cosa_net_rx_done(struct channel_data *chan)
747 pr_warn("%s: rx_done with empty skb!\n", chan->name);
748 chan->netdev->stats.rx_errors++;
749 chan->netdev->stats.rx_frame_errors++;
752 chan->rx_skb->protocol = hdlc_type_trans(chan->rx_skb, chan->netdev);
753 chan->rx_skb->dev = chan->netdev;
754 skb_reset_mac_header(chan->rx_skb);
755 chan->netdev->stats.rx_packets++;
756 chan->netdev->stats.rx_bytes += chan->cosa->rxsize;
757 netif_rx(chan->rx_skb);
763 static int cosa_net_tx_done(struct channel_data *chan, int size)
766 pr_warn("%s: tx_done with empty skb!\n", chan->name);
767 chan->netdev->stats.tx_errors++;
768 chan->netdev->stats.tx_aborted_errors++;
771 dev_kfree_skb_irq(chan->tx_skb);
773 chan->netdev->stats.tx_packets++;
774 chan->netdev->stats.tx_bytes += size;
775 netif_wake_queue(chan->netdev);
779 /*---------- Character device ---------- */
781 static ssize_t cosa_read(struct file *file,
782 char __user *buf, size_t count, loff_t *ppos)
784 DECLARE_WAITQUEUE(wait, current);
786 struct channel_data *chan = file->private_data;
787 struct cosa_data *cosa = chan->cosa;
790 if (!(cosa->firmware_status & COSA_FW_START)) {
791 pr_notice("%s: start the firmware first (status %d)\n",
792 cosa->name, cosa->firmware_status);
795 if (mutex_lock_interruptible(&chan->rlock))
798 chan->rxdata = kmalloc(COSA_MTU, GFP_DMA|GFP_KERNEL);
799 if (chan->rxdata == NULL) {
800 mutex_unlock(&chan->rlock);
805 cosa_enable_rx(chan);
806 spin_lock_irqsave(&cosa->lock, flags);
807 add_wait_queue(&chan->rxwaitq, &wait);
808 while (!chan->rx_status) {
809 current->state = TASK_INTERRUPTIBLE;
810 spin_unlock_irqrestore(&cosa->lock, flags);
812 spin_lock_irqsave(&cosa->lock, flags);
813 if (signal_pending(current) && chan->rx_status == 0) {
815 remove_wait_queue(&chan->rxwaitq, &wait);
816 current->state = TASK_RUNNING;
817 spin_unlock_irqrestore(&cosa->lock, flags);
818 mutex_unlock(&chan->rlock);
822 remove_wait_queue(&chan->rxwaitq, &wait);
823 current->state = TASK_RUNNING;
825 count = chan->rxsize;
826 spin_unlock_irqrestore(&cosa->lock, flags);
827 mutex_unlock(&chan->rlock);
829 if (copy_to_user(buf, kbuf, count)) {
837 static char *chrdev_setup_rx(struct channel_data *chan, int size)
839 /* Expect size <= COSA_MTU */
844 static int chrdev_rx_done(struct channel_data *chan)
846 if (chan->rx_status) { /* Reader has died */
851 wake_up_interruptible(&chan->rxwaitq);
856 static ssize_t cosa_write(struct file *file,
857 const char __user *buf, size_t count, loff_t *ppos)
859 DECLARE_WAITQUEUE(wait, current);
860 struct channel_data *chan = file->private_data;
861 struct cosa_data *cosa = chan->cosa;
865 if (!(cosa->firmware_status & COSA_FW_START)) {
866 pr_notice("%s: start the firmware first (status %d)\n",
867 cosa->name, cosa->firmware_status);
870 if (down_interruptible(&chan->wsem))
873 if (count > COSA_MTU)
876 /* Allocate the buffer */
877 kbuf = kmalloc(count, GFP_KERNEL|GFP_DMA);
882 if (copy_from_user(kbuf, buf, count)) {
888 cosa_start_tx(chan, kbuf, count);
890 spin_lock_irqsave(&cosa->lock, flags);
891 add_wait_queue(&chan->txwaitq, &wait);
892 while (!chan->tx_status) {
893 current->state = TASK_INTERRUPTIBLE;
894 spin_unlock_irqrestore(&cosa->lock, flags);
896 spin_lock_irqsave(&cosa->lock, flags);
897 if (signal_pending(current) && chan->tx_status == 0) {
899 remove_wait_queue(&chan->txwaitq, &wait);
900 current->state = TASK_RUNNING;
902 spin_unlock_irqrestore(&cosa->lock, flags);
907 remove_wait_queue(&chan->txwaitq, &wait);
908 current->state = TASK_RUNNING;
910 spin_unlock_irqrestore(&cosa->lock, flags);
915 static int chrdev_tx_done(struct channel_data *chan, int size)
917 if (chan->tx_status) { /* Writer was interrupted */
922 wake_up_interruptible(&chan->txwaitq);
926 static unsigned int cosa_poll(struct file *file, poll_table *poll)
928 pr_info("cosa_poll is here\n");
932 static int cosa_open(struct inode *inode, struct file *file)
934 struct cosa_data *cosa;
935 struct channel_data *chan;
940 mutex_lock(&cosa_chardev_mutex);
941 if ((n=iminor(file_inode(file))>>CARD_MINOR_BITS)
948 if ((n=iminor(file_inode(file))
949 & ((1<<CARD_MINOR_BITS)-1)) >= cosa->nchannels) {
953 chan = cosa->chan + n;
955 file->private_data = chan;
957 spin_lock_irqsave(&cosa->lock, flags);
959 if (chan->usage < 0) { /* in netdev mode */
960 spin_unlock_irqrestore(&cosa->lock, flags);
967 chan->tx_done = chrdev_tx_done;
968 chan->setup_rx = chrdev_setup_rx;
969 chan->rx_done = chrdev_rx_done;
970 spin_unlock_irqrestore(&cosa->lock, flags);
972 mutex_unlock(&cosa_chardev_mutex);
976 static int cosa_release(struct inode *inode, struct file *file)
978 struct channel_data *channel = file->private_data;
979 struct cosa_data *cosa;
982 cosa = channel->cosa;
983 spin_lock_irqsave(&cosa->lock, flags);
986 spin_unlock_irqrestore(&cosa->lock, flags);
990 #ifdef COSA_FASYNC_WORKING
991 static struct fasync_struct *fasync[256] = { NULL, };
994 static int cosa_fasync(struct inode *inode, struct file *file, int on)
996 int port = iminor(inode);
998 return fasync_helper(inode, file, on, &fasync[port]);
1003 /* ---------- Ioctls ---------- */
1006 * Ioctl subroutines can safely be made inline, because they are called
1007 * only from cosa_ioctl().
1009 static inline int cosa_reset(struct cosa_data *cosa)
1011 char idstring[COSA_MAX_ID_STRING];
1012 if (cosa->usage > 1)
1013 pr_info("cosa%d: WARNING: reset requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1014 cosa->num, cosa->usage);
1015 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_START);
1016 if (cosa_reset_and_read_id(cosa, idstring) < 0) {
1017 pr_notice("cosa%d: reset failed\n", cosa->num);
1020 pr_info("cosa%d: resetting device: %s\n", cosa->num, idstring);
1021 cosa->firmware_status |= COSA_FW_RESET;
1025 /* High-level function to download data into COSA memory. Calls download() */
1026 static inline int cosa_download(struct cosa_data *cosa, void __user *arg)
1028 struct cosa_download d;
1031 if (cosa->usage > 1)
1032 pr_info("%s: WARNING: download of microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1033 cosa->name, cosa->usage);
1034 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1035 pr_notice("%s: reset the card first (status %d)\n",
1036 cosa->name, cosa->firmware_status);
1040 if (copy_from_user(&d, arg, sizeof(d)))
1043 if (d.addr < 0 || d.addr > COSA_MAX_FIRMWARE_SIZE)
1045 if (d.len < 0 || d.len > COSA_MAX_FIRMWARE_SIZE)
1049 /* If something fails, force the user to reset the card */
1050 cosa->firmware_status &= ~(COSA_FW_RESET|COSA_FW_DOWNLOAD);
1052 i = download(cosa, d.code, d.len, d.addr);
1054 pr_notice("cosa%d: microcode download failed: %d\n",
1058 pr_info("cosa%d: downloading microcode - 0x%04x bytes at 0x%04x\n",
1059 cosa->num, d.len, d.addr);
1060 cosa->firmware_status |= COSA_FW_RESET|COSA_FW_DOWNLOAD;
1064 /* High-level function to read COSA memory. Calls readmem() */
1065 static inline int cosa_readmem(struct cosa_data *cosa, void __user *arg)
1067 struct cosa_download d;
1070 if (cosa->usage > 1)
1071 pr_info("cosa%d: WARNING: readmem requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1072 cosa->num, cosa->usage);
1073 if (!(cosa->firmware_status & COSA_FW_RESET)) {
1074 pr_notice("%s: reset the card first (status %d)\n",
1075 cosa->name, cosa->firmware_status);
1079 if (copy_from_user(&d, arg, sizeof(d)))
1082 /* If something fails, force the user to reset the card */
1083 cosa->firmware_status &= ~COSA_FW_RESET;
1085 i = readmem(cosa, d.code, d.len, d.addr);
1087 pr_notice("cosa%d: reading memory failed: %d\n", cosa->num, i);
1090 pr_info("cosa%d: reading card memory - 0x%04x bytes at 0x%04x\n",
1091 cosa->num, d.len, d.addr);
1092 cosa->firmware_status |= COSA_FW_RESET;
1096 /* High-level function to start microcode. Calls startmicrocode(). */
1097 static inline int cosa_start(struct cosa_data *cosa, int address)
1101 if (cosa->usage > 1)
1102 pr_info("cosa%d: WARNING: start microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1103 cosa->num, cosa->usage);
1105 if ((cosa->firmware_status & (COSA_FW_RESET|COSA_FW_DOWNLOAD))
1106 != (COSA_FW_RESET|COSA_FW_DOWNLOAD)) {
1107 pr_notice("%s: download the microcode and/or reset the card first (status %d)\n",
1108 cosa->name, cosa->firmware_status);
1111 cosa->firmware_status &= ~COSA_FW_RESET;
1112 if ((i=startmicrocode(cosa, address)) < 0) {
1113 pr_notice("cosa%d: start microcode at 0x%04x failed: %d\n",
1114 cosa->num, address, i);
1117 pr_info("cosa%d: starting microcode at 0x%04x\n", cosa->num, address);
1118 cosa->startaddr = address;
1119 cosa->firmware_status |= COSA_FW_START;
1123 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1124 static inline int cosa_getidstr(struct cosa_data *cosa, char __user *string)
1126 int l = strlen(cosa->id_string)+1;
1127 if (copy_to_user(string, cosa->id_string, l))
1132 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1133 static inline int cosa_gettype(struct cosa_data *cosa, char __user *string)
1135 int l = strlen(cosa->type)+1;
1136 if (copy_to_user(string, cosa->type, l))
1141 static int cosa_ioctl_common(struct cosa_data *cosa,
1142 struct channel_data *channel, unsigned int cmd, unsigned long arg)
1144 void __user *argp = (void __user *)arg;
1146 case COSAIORSET: /* Reset the device */
1147 if (!capable(CAP_NET_ADMIN))
1149 return cosa_reset(cosa);
1150 case COSAIOSTRT: /* Start the firmware */
1151 if (!capable(CAP_SYS_RAWIO))
1153 return cosa_start(cosa, arg);
1154 case COSAIODOWNLD: /* Download the firmware */
1155 if (!capable(CAP_SYS_RAWIO))
1158 return cosa_download(cosa, argp);
1160 if (!capable(CAP_SYS_RAWIO))
1162 return cosa_readmem(cosa, argp);
1164 return cosa_gettype(cosa, argp);
1166 return cosa_getidstr(cosa, argp);
1170 return cosa->nchannels;
1172 if (!capable(CAP_SYS_RAWIO))
1176 if (arg != COSA_BM_OFF && arg != COSA_BM_ON)
1178 cosa->busmaster = arg;
1181 return cosa->busmaster;
1183 return -ENOIOCTLCMD;
1186 static int cosa_net_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
1189 struct channel_data *chan = dev_to_chan(dev);
1190 rv = cosa_ioctl_common(chan->cosa, chan, cmd,
1191 (unsigned long)ifr->ifr_data);
1192 if (rv != -ENOIOCTLCMD)
1194 return hdlc_ioctl(dev, ifr, cmd);
1197 static long cosa_chardev_ioctl(struct file *file, unsigned int cmd,
1200 struct channel_data *channel = file->private_data;
1201 struct cosa_data *cosa;
1204 mutex_lock(&cosa_chardev_mutex);
1205 cosa = channel->cosa;
1206 ret = cosa_ioctl_common(cosa, channel, cmd, arg);
1207 mutex_unlock(&cosa_chardev_mutex);
1212 /*---------- HW layer interface ---------- */
1215 * The higher layer can bind itself to the HW layer by setting the callbacks
1216 * in the channel_data structure and by using these routines.
1218 static void cosa_enable_rx(struct channel_data *chan)
1220 struct cosa_data *cosa = chan->cosa;
1222 if (!test_and_set_bit(chan->num, &cosa->rxbitmap))
1223 put_driver_status(cosa);
1226 static void cosa_disable_rx(struct channel_data *chan)
1228 struct cosa_data *cosa = chan->cosa;
1230 if (test_and_clear_bit(chan->num, &cosa->rxbitmap))
1231 put_driver_status(cosa);
1235 * FIXME: This routine probably should check for cosa_start_tx() called when
1236 * the previous transmit is still unfinished. In this case the non-zero
1237 * return value should indicate to the caller that the queuing(sp?) up
1238 * the transmit has failed.
1240 static int cosa_start_tx(struct channel_data *chan, char *buf, int len)
1242 struct cosa_data *cosa = chan->cosa;
1243 unsigned long flags;
1247 pr_info("cosa%dc%d: starting tx(0x%x)",
1248 chan->cosa->num, chan->num, len);
1249 for (i=0; i<len; i++)
1250 pr_cont(" %02x", buf[i]&0xff);
1253 spin_lock_irqsave(&cosa->lock, flags);
1257 chan->txsize = COSA_MTU;
1258 spin_unlock_irqrestore(&cosa->lock, flags);
1260 /* Tell the firmware we are ready */
1261 set_bit(chan->num, &cosa->txbitmap);
1262 put_driver_status(cosa);
1267 static void put_driver_status(struct cosa_data *cosa)
1269 unsigned long flags;
1272 spin_lock_irqsave(&cosa->lock, flags);
1274 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1275 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1276 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1277 &DRIVER_TXMAP_MASK : 0);
1279 if (cosa->rxbitmap|cosa->txbitmap) {
1280 if (!cosa->enabled) {
1281 cosa_putstatus(cosa, SR_RX_INT_ENA);
1283 debug_status_out(cosa, SR_RX_INT_ENA);
1287 } else if (cosa->enabled) {
1289 cosa_putstatus(cosa, 0);
1291 debug_status_out(cosa, 0);
1294 cosa_putdata8(cosa, status);
1296 debug_data_cmd(cosa, status);
1299 spin_unlock_irqrestore(&cosa->lock, flags);
1302 static void put_driver_status_nolock(struct cosa_data *cosa)
1306 status = (cosa->rxbitmap ? DRIVER_RX_READY : 0)
1307 | (cosa->txbitmap ? DRIVER_TX_READY : 0)
1308 | (cosa->txbitmap? ~(cosa->txbitmap<<DRIVER_TXMAP_SHIFT)
1309 &DRIVER_TXMAP_MASK : 0);
1311 if (cosa->rxbitmap|cosa->txbitmap) {
1312 cosa_putstatus(cosa, SR_RX_INT_ENA);
1314 debug_status_out(cosa, SR_RX_INT_ENA);
1318 cosa_putstatus(cosa, 0);
1320 debug_status_out(cosa, 0);
1324 cosa_putdata8(cosa, status);
1326 debug_data_cmd(cosa, status);
1331 * The "kickme" function: When the DMA times out, this is called to
1332 * clean up the driver status.
1333 * FIXME: Preliminary support, the interface is probably wrong.
1335 static void cosa_kick(struct cosa_data *cosa)
1337 unsigned long flags, flags1;
1338 char *s = "(probably) IRQ";
1340 if (test_bit(RXBIT, &cosa->rxtx))
1342 if (test_bit(TXBIT, &cosa->rxtx))
1345 pr_info("%s: %s timeout - restarting\n", cosa->name, s);
1346 spin_lock_irqsave(&cosa->lock, flags);
1349 flags1 = claim_dma_lock();
1350 disable_dma(cosa->dma);
1351 clear_dma_ff(cosa->dma);
1352 release_dma_lock(flags1);
1354 /* FIXME: Anything else? */
1356 cosa_putstatus(cosa, 0);
1358 (void) cosa_getdata8(cosa);
1360 cosa_putdata8(cosa, 0);
1362 put_driver_status_nolock(cosa);
1363 spin_unlock_irqrestore(&cosa->lock, flags);
1367 * Check if the whole buffer is DMA-able. It means it is below the 16M of
1368 * physical memory and doesn't span the 64k boundary. For now it seems
1369 * SKB's never do this, but we'll check this anyway.
1371 static int cosa_dma_able(struct channel_data *chan, char *buf, int len)
1374 unsigned long b = (unsigned long)buf;
1375 if (b+len >= MAX_DMA_ADDRESS)
1377 if ((b^ (b+len)) & 0x10000) {
1379 pr_info("%s: packet spanning a 64k boundary\n",
1387 /* ---------- The SRP/COSA ROM monitor functions ---------- */
1390 * Downloading SRP microcode: say "w" to SRP monitor, it answers by "w=",
1391 * drivers need to say 4-digit hex number meaning start address of the microcode
1392 * separated by a single space. Monitor replies by saying " =". Now driver
1393 * has to write 4-digit hex number meaning the last byte address ended
1394 * by a single space. Monitor has to reply with a space. Now the download
1395 * begins. After the download monitor replies with "\r\n." (CR LF dot).
1397 static int download(struct cosa_data *cosa, const char __user *microcode, int length, int address)
1401 if (put_wait_data(cosa, 'w') == -1) return -1;
1402 if ((i=get_wait_data(cosa)) != 'w') { printk("dnld: 0x%04x\n",i); return -2;}
1403 if (get_wait_data(cosa) != '=') return -3;
1405 if (puthexnumber(cosa, address) < 0) return -4;
1406 if (put_wait_data(cosa, ' ') == -1) return -10;
1407 if (get_wait_data(cosa) != ' ') return -11;
1408 if (get_wait_data(cosa) != '=') return -12;
1410 if (puthexnumber(cosa, address+length-1) < 0) return -13;
1411 if (put_wait_data(cosa, ' ') == -1) return -18;
1412 if (get_wait_data(cosa) != ' ') return -19;
1416 #ifndef SRP_DOWNLOAD_AT_BOOT
1417 if (get_user(c, microcode))
1418 return -23; /* ??? */
1422 if (put_wait_data(cosa, c) == -1)
1427 if (get_wait_data(cosa) != '\r') return -21;
1428 if (get_wait_data(cosa) != '\n') return -22;
1429 if (get_wait_data(cosa) != '.') return -23;
1431 printk(KERN_DEBUG "cosa%d: download completed.\n", cosa->num);
1438 * Starting microcode is done via the "g" command of the SRP monitor.
1439 * The chat should be the following: "g" "g=" "<addr><CR>"
1440 * "<CR><CR><LF><CR><LF>".
1442 static int startmicrocode(struct cosa_data *cosa, int address)
1444 if (put_wait_data(cosa, 'g') == -1) return -1;
1445 if (get_wait_data(cosa) != 'g') return -2;
1446 if (get_wait_data(cosa) != '=') return -3;
1448 if (puthexnumber(cosa, address) < 0) return -4;
1449 if (put_wait_data(cosa, '\r') == -1) return -5;
1451 if (get_wait_data(cosa) != '\r') return -6;
1452 if (get_wait_data(cosa) != '\r') return -7;
1453 if (get_wait_data(cosa) != '\n') return -8;
1454 if (get_wait_data(cosa) != '\r') return -9;
1455 if (get_wait_data(cosa) != '\n') return -10;
1457 printk(KERN_DEBUG "cosa%d: microcode started\n", cosa->num);
1463 * Reading memory is done via the "r" command of the SRP monitor.
1464 * The chat is the following "r" "r=" "<addr> " " =" "<last_byte> " " "
1465 * Then driver can read the data and the conversation is finished
1466 * by SRP monitor sending "<CR><LF>." (dot at the end).
1468 * This routine is not needed during the normal operation and serves
1469 * for debugging purposes only.
1471 static int readmem(struct cosa_data *cosa, char __user *microcode, int length, int address)
1473 if (put_wait_data(cosa, 'r') == -1) return -1;
1474 if ((get_wait_data(cosa)) != 'r') return -2;
1475 if ((get_wait_data(cosa)) != '=') return -3;
1477 if (puthexnumber(cosa, address) < 0) return -4;
1478 if (put_wait_data(cosa, ' ') == -1) return -5;
1479 if (get_wait_data(cosa) != ' ') return -6;
1480 if (get_wait_data(cosa) != '=') return -7;
1482 if (puthexnumber(cosa, address+length-1) < 0) return -8;
1483 if (put_wait_data(cosa, ' ') == -1) return -9;
1484 if (get_wait_data(cosa) != ' ') return -10;
1489 if ((i=get_wait_data(cosa)) == -1) {
1490 pr_info("0x%04x bytes remaining\n", length);
1495 if (put_user(c, microcode))
1496 return -23; /* ??? */
1503 if (get_wait_data(cosa) != '\r') return -21;
1504 if (get_wait_data(cosa) != '\n') return -22;
1505 if (get_wait_data(cosa) != '.') return -23;
1507 printk(KERN_DEBUG "cosa%d: readmem completed.\n", cosa->num);
1513 * This function resets the device and reads the initial prompt
1514 * of the device's ROM monitor.
1516 static int cosa_reset_and_read_id(struct cosa_data *cosa, char *idstring)
1518 int i=0, id=0, prev=0, curr=0;
1520 /* Reset the card ... */
1521 cosa_putstatus(cosa, 0);
1522 cosa_getdata8(cosa);
1523 cosa_putstatus(cosa, SR_RST);
1529 /* Disable all IRQs from the card */
1530 cosa_putstatus(cosa, 0);
1533 * Try to read the ID string. The card then prints out the
1534 * identification string ended by the "\n\x2e".
1536 * The following loop is indexed through i (instead of id)
1537 * to avoid looping forever when for any reason
1538 * the port returns '\r', '\n' or '\x2e' permanently.
1540 for (i=0; i<COSA_MAX_ID_STRING-1; i++, prev=curr) {
1541 if ((curr = get_wait_data(cosa)) == -1) {
1545 if (curr != '\r' && curr != '\n' && curr != 0x2e)
1546 idstring[id++] = curr;
1547 if (curr == 0x2e && prev == '\n')
1550 /* Perhaps we should fail when i==COSA_MAX_ID_STRING-1 ? */
1551 idstring[id] = '\0';
1556 /* ---------- Auxiliary routines for COSA/SRP monitor ---------- */
1559 * This routine gets the data byte from the card waiting for the SR_RX_RDY
1560 * bit to be set in a loop. It should be used in the exceptional cases
1561 * only (for example when resetting the card or downloading the firmware.
1563 static int get_wait_data(struct cosa_data *cosa)
1568 /* read data and return them */
1569 if (cosa_getstatus(cosa) & SR_RX_RDY) {
1571 r = cosa_getdata8(cosa);
1573 pr_info("get_wait_data returning after %d retries\n",
1578 /* sleep if not ready to read */
1579 schedule_timeout_interruptible(1);
1581 pr_info("timeout in get_wait_data (status 0x%x)\n",
1582 cosa_getstatus(cosa));
1587 * This routine puts the data byte to the card waiting for the SR_TX_RDY
1588 * bit to be set in a loop. It should be used in the exceptional cases
1589 * only (for example when resetting the card or downloading the firmware).
1591 static int put_wait_data(struct cosa_data *cosa, int data)
1595 /* read data and return them */
1596 if (cosa_getstatus(cosa) & SR_TX_RDY) {
1597 cosa_putdata8(cosa, data);
1599 pr_info("Putdata: %d retries\n", 999-retries);
1604 /* sleep if not ready to read */
1605 schedule_timeout_interruptible(1);
1608 pr_info("cosa%d: timeout in put_wait_data (status 0x%x)\n",
1609 cosa->num, cosa_getstatus(cosa));
1614 * The following routine puts the hexadecimal number into the SRP monitor
1615 * and verifies the proper echo of the sent bytes. Returns 0 on success,
1616 * negative number on failure (-1,-3,-5,-7) means that put_wait_data() failed,
1617 * (-2,-4,-6,-8) means that reading echo failed.
1619 static int puthexnumber(struct cosa_data *cosa, int number)
1624 /* Well, I should probably replace this by something faster. */
1625 sprintf(temp, "%04X", number);
1626 for (i=0; i<4; i++) {
1627 if (put_wait_data(cosa, temp[i]) == -1) {
1628 pr_notice("cosa%d: puthexnumber failed to write byte %d\n",
1632 if (get_wait_data(cosa) != temp[i]) {
1633 pr_notice("cosa%d: puthexhumber failed to read echo of byte %d\n",
1642 /* ---------- Interrupt routines ---------- */
1645 * There are three types of interrupt:
1646 * At the beginning of transmit - this handled is in tx_interrupt(),
1647 * at the beginning of receive - it is in rx_interrupt() and
1648 * at the end of transmit/receive - it is the eot_interrupt() function.
1649 * These functions are multiplexed by cosa_interrupt() according to the
1650 * COSA status byte. I have moved the rx/tx/eot interrupt handling into
1651 * separate functions to make it more readable. These functions are inline,
1652 * so there should be no overhead of function call.
1654 * In the COSA bus-master mode, we need to tell the card the address of a
1655 * buffer. Unfortunately, COSA may be too slow for us, so we must busy-wait.
1656 * It's time to use the bottom half :-(
1660 * Transmit interrupt routine - called when COSA is willing to obtain
1661 * data from the OS. The most tricky part of the routine is selection
1662 * of channel we (OS) want to send packet for. For SRP we should probably
1663 * use the round-robin approach. The newer COSA firmwares have a simple
1664 * flow-control - in the status word has bits 2 and 3 set to 1 means that the
1665 * channel 0 or 1 doesn't want to receive data.
1667 * It seems there is a bug in COSA firmware (need to trace it further):
1668 * When the driver status says that the kernel has no more data for transmit
1669 * (e.g. at the end of TX DMA) and then the kernel changes its mind
1670 * (e.g. new packet is queued to hard_start_xmit()), the card issues
1671 * the TX interrupt but does not mark the channel as ready-to-transmit.
1672 * The fix seems to be to push the packet to COSA despite its request.
1673 * We first try to obey the card's opinion, and then fall back to forced TX.
1675 static inline void tx_interrupt(struct cosa_data *cosa, int status)
1677 unsigned long flags, flags1;
1679 pr_info("cosa%d: SR_DOWN_REQUEST status=0x%04x\n", cosa->num, status);
1681 spin_lock_irqsave(&cosa->lock, flags);
1682 set_bit(TXBIT, &cosa->rxtx);
1683 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1684 /* flow control, see the comment above */
1686 if (!cosa->txbitmap) {
1687 pr_warn("%s: No channel wants data in TX IRQ. Expect DMA timeout.\n",
1689 put_driver_status_nolock(cosa);
1690 clear_bit(TXBIT, &cosa->rxtx);
1691 spin_unlock_irqrestore(&cosa->lock, flags);
1697 if (cosa->txchan >= cosa->nchannels)
1699 if (!(cosa->txbitmap & (1<<cosa->txchan)))
1701 if (~status & (1 << (cosa->txchan+DRIVER_TXMAP_SHIFT)))
1703 /* in second pass, accept first ready-to-TX channel */
1704 if (i > cosa->nchannels) {
1705 /* Can be safely ignored */
1707 printk(KERN_DEBUG "%s: Forcing TX "
1708 "to not-ready channel %d\n",
1709 cosa->name, cosa->txchan);
1715 cosa->txsize = cosa->chan[cosa->txchan].txsize;
1716 if (cosa_dma_able(cosa->chan+cosa->txchan,
1717 cosa->chan[cosa->txchan].txbuf, cosa->txsize)) {
1718 cosa->txbuf = cosa->chan[cosa->txchan].txbuf;
1720 memcpy(cosa->bouncebuf, cosa->chan[cosa->txchan].txbuf,
1722 cosa->txbuf = cosa->bouncebuf;
1726 if (is_8bit(cosa)) {
1727 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1728 cosa_putstatus(cosa, SR_TX_INT_ENA);
1729 cosa_putdata8(cosa, ((cosa->txchan << 5) & 0xe0)|
1730 ((cosa->txsize >> 8) & 0x1f));
1732 debug_status_out(cosa, SR_TX_INT_ENA);
1733 debug_data_out(cosa, ((cosa->txchan << 5) & 0xe0)|
1734 ((cosa->txsize >> 8) & 0x1f));
1735 debug_data_in(cosa, cosa_getdata8(cosa));
1737 cosa_getdata8(cosa);
1739 set_bit(IRQBIT, &cosa->rxtx);
1740 spin_unlock_irqrestore(&cosa->lock, flags);
1743 clear_bit(IRQBIT, &cosa->rxtx);
1744 cosa_putstatus(cosa, 0);
1745 cosa_putdata8(cosa, cosa->txsize&0xff);
1747 debug_status_out(cosa, 0);
1748 debug_data_out(cosa, cosa->txsize&0xff);
1752 cosa_putstatus(cosa, SR_TX_INT_ENA);
1753 cosa_putdata16(cosa, ((cosa->txchan<<13) & 0xe000)
1754 | (cosa->txsize & 0x1fff));
1756 debug_status_out(cosa, SR_TX_INT_ENA);
1757 debug_data_out(cosa, ((cosa->txchan<<13) & 0xe000)
1758 | (cosa->txsize & 0x1fff));
1759 debug_data_in(cosa, cosa_getdata8(cosa));
1760 debug_status_out(cosa, 0);
1762 cosa_getdata8(cosa);
1764 cosa_putstatus(cosa, 0);
1767 if (cosa->busmaster) {
1768 unsigned long addr = virt_to_bus(cosa->txbuf);
1770 pr_info("busmaster IRQ\n");
1771 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1774 if (count > 1000) break;
1776 pr_info("status %x\n", cosa_getstatus(cosa));
1777 pr_info("ready after %d loops\n", count);
1778 cosa_putdata16(cosa, (addr >> 16)&0xffff);
1781 while (!(cosa_getstatus(cosa)&SR_TX_RDY)) {
1783 if (count > 1000) break;
1786 pr_info("ready after %d loops\n", count);
1787 cosa_putdata16(cosa, addr &0xffff);
1788 flags1 = claim_dma_lock();
1789 set_dma_mode(cosa->dma, DMA_MODE_CASCADE);
1790 enable_dma(cosa->dma);
1791 release_dma_lock(flags1);
1794 flags1 = claim_dma_lock();
1795 disable_dma(cosa->dma);
1796 clear_dma_ff(cosa->dma);
1797 set_dma_mode(cosa->dma, DMA_MODE_WRITE);
1798 set_dma_addr(cosa->dma, virt_to_bus(cosa->txbuf));
1799 set_dma_count(cosa->dma, cosa->txsize);
1800 enable_dma(cosa->dma);
1801 release_dma_lock(flags1);
1803 cosa_putstatus(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1805 debug_status_out(cosa, SR_TX_DMA_ENA|SR_USR_INT_ENA);
1807 spin_unlock_irqrestore(&cosa->lock, flags);
1810 static inline void rx_interrupt(struct cosa_data *cosa, int status)
1812 unsigned long flags;
1814 pr_info("cosa%d: SR_UP_REQUEST\n", cosa->num);
1817 spin_lock_irqsave(&cosa->lock, flags);
1818 set_bit(RXBIT, &cosa->rxtx);
1820 if (is_8bit(cosa)) {
1821 if (!test_bit(IRQBIT, &cosa->rxtx)) {
1822 set_bit(IRQBIT, &cosa->rxtx);
1823 put_driver_status_nolock(cosa);
1824 cosa->rxsize = cosa_getdata8(cosa) <<8;
1826 debug_data_in(cosa, cosa->rxsize >> 8);
1828 spin_unlock_irqrestore(&cosa->lock, flags);
1831 clear_bit(IRQBIT, &cosa->rxtx);
1832 cosa->rxsize |= cosa_getdata8(cosa) & 0xff;
1834 debug_data_in(cosa, cosa->rxsize & 0xff);
1837 pr_info("cosa%d: receive rxsize = (0x%04x)\n",
1838 cosa->num, cosa->rxsize);
1842 cosa->rxsize = cosa_getdata16(cosa);
1844 debug_data_in(cosa, cosa->rxsize);
1847 pr_info("cosa%d: receive rxsize = (0x%04x)\n",
1848 cosa->num, cosa->rxsize);
1851 if (((cosa->rxsize & 0xe000) >> 13) >= cosa->nchannels) {
1852 pr_warn("%s: rx for unknown channel (0x%04x)\n",
1853 cosa->name, cosa->rxsize);
1854 spin_unlock_irqrestore(&cosa->lock, flags);
1857 cosa->rxchan = cosa->chan + ((cosa->rxsize & 0xe000) >> 13);
1858 cosa->rxsize &= 0x1fff;
1859 spin_unlock_irqrestore(&cosa->lock, flags);
1862 if (cosa->rxchan->setup_rx)
1863 cosa->rxbuf = cosa->rxchan->setup_rx(cosa->rxchan, cosa->rxsize);
1866 reject: /* Reject the packet */
1867 pr_info("cosa%d: rejecting packet on channel %d\n",
1868 cosa->num, cosa->rxchan->num);
1869 cosa->rxbuf = cosa->bouncebuf;
1873 flags = claim_dma_lock();
1874 disable_dma(cosa->dma);
1875 clear_dma_ff(cosa->dma);
1876 set_dma_mode(cosa->dma, DMA_MODE_READ);
1877 if (cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize & 0x1fff)) {
1878 set_dma_addr(cosa->dma, virt_to_bus(cosa->rxbuf));
1880 set_dma_addr(cosa->dma, virt_to_bus(cosa->bouncebuf));
1882 set_dma_count(cosa->dma, (cosa->rxsize&0x1fff));
1883 enable_dma(cosa->dma);
1884 release_dma_lock(flags);
1885 spin_lock_irqsave(&cosa->lock, flags);
1886 cosa_putstatus(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1887 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1888 cosa_putdata8(cosa, DRIVER_RX_READY);
1890 debug_status_out(cosa, SR_RX_DMA_ENA|SR_USR_INT_ENA);
1891 if (!is_8bit(cosa) && (status & SR_TX_RDY))
1892 debug_data_cmd(cosa, DRIVER_RX_READY);
1894 spin_unlock_irqrestore(&cosa->lock, flags);
1897 static inline void eot_interrupt(struct cosa_data *cosa, int status)
1899 unsigned long flags, flags1;
1900 spin_lock_irqsave(&cosa->lock, flags);
1901 flags1 = claim_dma_lock();
1902 disable_dma(cosa->dma);
1903 clear_dma_ff(cosa->dma);
1904 release_dma_lock(flags1);
1905 if (test_bit(TXBIT, &cosa->rxtx)) {
1906 struct channel_data *chan = cosa->chan+cosa->txchan;
1908 if (chan->tx_done(chan, cosa->txsize))
1909 clear_bit(chan->num, &cosa->txbitmap);
1910 } else if (test_bit(RXBIT, &cosa->rxtx)) {
1914 pr_info("cosa%dc%d: done rx(0x%x)",
1915 cosa->num, cosa->rxchan->num, cosa->rxsize);
1916 for (i=0; i<cosa->rxsize; i++)
1917 pr_cont(" %02x", cosa->rxbuf[i]&0xff);
1921 /* Packet for unknown channel? */
1922 if (cosa->rxbuf == cosa->bouncebuf)
1924 if (!cosa_dma_able(cosa->rxchan, cosa->rxbuf, cosa->rxsize))
1925 memcpy(cosa->rxbuf, cosa->bouncebuf, cosa->rxsize);
1926 if (cosa->rxchan->rx_done)
1927 if (cosa->rxchan->rx_done(cosa->rxchan))
1928 clear_bit(cosa->rxchan->num, &cosa->rxbitmap);
1930 pr_notice("cosa%d: unexpected EOT interrupt\n", cosa->num);
1933 * Clear the RXBIT, TXBIT and IRQBIT (the latest should be
1934 * cleared anyway). We should do it as soon as possible
1935 * so that we can tell the COSA we are done and to give it a time
1940 put_driver_status_nolock(cosa);
1941 spin_unlock_irqrestore(&cosa->lock, flags);
1944 static irqreturn_t cosa_interrupt(int irq, void *cosa_)
1948 struct cosa_data *cosa = cosa_;
1950 status = cosa_getstatus(cosa);
1952 pr_info("cosa%d: got IRQ, status 0x%02x\n", cosa->num, status & 0xff);
1955 debug_status_in(cosa, status);
1957 switch (status & SR_CMD_FROM_SRP_MASK) {
1958 case SR_DOWN_REQUEST:
1959 tx_interrupt(cosa, status);
1962 rx_interrupt(cosa, status);
1964 case SR_END_OF_TRANSFER:
1965 eot_interrupt(cosa, status);
1968 /* We may be too fast for SRP. Try to wait a bit more. */
1969 if (count++ < 100) {
1973 pr_info("cosa%d: unknown status 0x%02x in IRQ after %d retries\n",
1974 cosa->num, status & 0xff, count);
1978 pr_info("%s: %d-times got unknown status in IRQ\n",
1981 pr_info("%s: returning from IRQ\n", cosa->name);
1987 /* ---------- I/O debugging routines ---------- */
1989 * These routines can be used to monitor COSA/SRP I/O and to printk()
1990 * the data being transferred on the data and status I/O port in a
1995 static void debug_status_in(struct cosa_data *cosa, int status)
1998 switch (status & SR_CMD_FROM_SRP_MASK) {
2002 case SR_DOWN_REQUEST:
2005 case SR_END_OF_TRANSFER:
2012 pr_info("%s: IO: status -> 0x%02x (%s%s%s%s)\n",
2015 status & SR_USR_RQ ? "USR_RQ|" : "",
2016 status & SR_TX_RDY ? "TX_RDY|" : "",
2017 status & SR_RX_RDY ? "RX_RDY|" : "",
2021 static void debug_status_out(struct cosa_data *cosa, int status)
2023 pr_info("%s: IO: status <- 0x%02x (%s%s%s%s%s%s)\n",
2026 status & SR_RX_DMA_ENA ? "RXDMA|" : "!rxdma|",
2027 status & SR_TX_DMA_ENA ? "TXDMA|" : "!txdma|",
2028 status & SR_RST ? "RESET|" : "",
2029 status & SR_USR_INT_ENA ? "USRINT|" : "!usrint|",
2030 status & SR_TX_INT_ENA ? "TXINT|" : "!txint|",
2031 status & SR_RX_INT_ENA ? "RXINT" : "!rxint");
2034 static void debug_data_in(struct cosa_data *cosa, int data)
2036 pr_info("%s: IO: data -> 0x%04x\n", cosa->name, data);
2039 static void debug_data_out(struct cosa_data *cosa, int data)
2041 pr_info("%s: IO: data <- 0x%04x\n", cosa->name, data);
2044 static void debug_data_cmd(struct cosa_data *cosa, int data)
2046 pr_info("%s: IO: data <- 0x%04x (%s|%s)\n",
2048 data & SR_RDY_RCV ? "RX_RDY" : "!rx_rdy",
2049 data & SR_RDY_SND ? "TX_RDY" : "!tx_rdy");
2053 /* EOF -- this file has not been truncated */