1 /* $Id: cosa.c,v 1.31 2000/03/08 17:47:16 kas Exp $ */
4 * Copyright (C) 1995-1997 Jan "Yenya" Kasprzak <kas@fi.muni.cz>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 * The driver for the SRP and COSA synchronous serial cards.
26 * Both cards are developed at the Institute of Computer Science,
27 * Masaryk University (http://www.ics.muni.cz/). The hardware is
28 * developed by Jiri Novotny <novotny@ics.muni.cz>. More information
29 * and the photo of both cards is available at
30 * http://www.pavoucek.cz/cosa.html. The card documentation, firmwares
31 * and other goods can be downloaded from ftp://ftp.ics.muni.cz/pub/cosa/.
32 * For Linux-specific utilities, see below in the "Software info" section.
33 * If you want to order the card, contact Jiri Novotny.
35 * The SRP (serial port?, the Czech word "srp" means "sickle") card
36 * is a 2-port intelligent (with its own 8-bit CPU) synchronous serial card
37 * with V.24 interfaces up to 80kb/s each.
39 * The COSA (communication serial adapter?, the Czech word "kosa" means
40 * "scythe") is a next-generation sync/async board with two interfaces
41 * - currently any of V.24, X.21, V.35 and V.36 can be selected.
42 * It has a 16-bit SAB80166 CPU and can do up to 10 Mb/s per channel.
43 * The 8-channels version is in development.
45 * Both types have downloadable firmware and communicate via ISA DMA.
46 * COSA can be also a bus-mastering device.
50 * The homepage of the Linux driver is at http://www.fi.muni.cz/~kas/cosa/.
51 * The CVS tree of Linux driver can be viewed there, as well as the
52 * firmware binaries and user-space utilities for downloading the firmware
53 * into the card and setting up the card.
55 * The Linux driver (unlike the present *BSD drivers :-) can work even
56 * for the COSA and SRP in one computer and allows each channel to work
57 * in one of the three modes (character device, Cisco HDLC, Sync PPP).
61 * The Linux driver was written by Jan "Yenya" Kasprzak <kas@fi.muni.cz>.
63 * You can mail me bugfixes and even success reports. I am especially
64 * interested in the SMP and/or muliti-channel success/failure reports
65 * (I wonder if I did the locking properly :-).
67 * THE AUTHOR USED THE FOLLOWING SOURCES WHEN PROGRAMMING THE DRIVER
69 * The COSA/SRP NetBSD driver by Zdenek Salvet and Ivos Cernohlavek
70 * The skeleton.c by Donald Becker
71 * The SDL Riscom/N2 driver by Mike Natale
72 * The Comtrol Hostess SV11 driver by Alan Cox
73 * The Sync PPP/Cisco HDLC layer (syncppp.c) ported to Linux by Alan Cox
76 * 5/25/1999 : Marcelo Tosatti <marcelo@conectiva.com.br>
77 * fixed a deadlock in cosa_sppp_open
80 /* ---------- Headers, macros, data structures ---------- */
82 #include <linux/module.h>
83 #include <linux/kernel.h>
84 #include <linux/slab.h>
85 #include <linux/poll.h>
87 #include <linux/interrupt.h>
88 #include <linux/delay.h>
89 #include <linux/errno.h>
90 #include <linux/ioport.h>
91 #include <linux/netdevice.h>
92 #include <linux/spinlock.h>
93 #include <linux/mutex.h>
94 #include <linux/device.h>
95 #include <linux/smp_lock.h>
97 #undef COSA_SLOW_IO /* for testing purposes only */
101 #include <asm/byteorder.h>
103 #include <net/syncppp.h>
106 /* Maximum length of the identification string. */
107 #define COSA_MAX_ID_STRING 128
109 /* Maximum length of the channel name */
110 #define COSA_MAX_NAME (sizeof("cosaXXXcXXX")+1)
112 /* Per-channel data structure */
114 struct channel_data
{
115 void *if_ptr
; /* General purpose pointer (used by SPPP) */
116 int usage
; /* Usage count; >0 for chrdev, -1 for netdev */
117 int num
; /* Number of the channel */
118 struct cosa_data
*cosa
; /* Pointer to the per-card structure */
119 int txsize
; /* Size of transmitted data */
120 char *txbuf
; /* Transmit buffer */
121 char name
[COSA_MAX_NAME
]; /* channel name */
123 /* The HW layer interface */
124 /* routine called from the RX interrupt */
125 char *(*setup_rx
)(struct channel_data
*channel
, int size
);
126 /* routine called when the RX is done (from the EOT interrupt) */
127 int (*rx_done
)(struct channel_data
*channel
);
128 /* routine called when the TX is done (from the EOT interrupt) */
129 int (*tx_done
)(struct channel_data
*channel
, int size
);
131 /* Character device parts */
133 struct semaphore wsem
;
136 wait_queue_head_t txwaitq
, rxwaitq
;
137 int tx_status
, rx_status
;
139 /* SPPP/HDLC device parts */
140 struct ppp_device pppdev
;
141 struct sk_buff
*rx_skb
, *tx_skb
;
142 struct net_device_stats stats
;
145 /* cosa->firmware_status bits */
146 #define COSA_FW_RESET (1<<0) /* Is the ROM monitor active? */
147 #define COSA_FW_DOWNLOAD (1<<1) /* Is the microcode downloaded? */
148 #define COSA_FW_START (1<<2) /* Is the microcode running? */
151 int num
; /* Card number */
152 char name
[COSA_MAX_NAME
]; /* Card name - e.g "cosa0" */
153 unsigned int datareg
, statusreg
; /* I/O ports */
154 unsigned short irq
, dma
; /* IRQ and DMA number */
155 unsigned short startaddr
; /* Firmware start address */
156 unsigned short busmaster
; /* Use busmastering? */
157 int nchannels
; /* # of channels on this card */
158 int driver_status
; /* For communicating with firmware */
159 int firmware_status
; /* Downloaded, reseted, etc. */
160 unsigned long rxbitmap
, txbitmap
;/* Bitmap of channels who are willing to send/receive data */
161 unsigned long rxtx
; /* RX or TX in progress? */
163 int usage
; /* usage count */
164 int txchan
, txsize
, rxsize
;
165 struct channel_data
*rxchan
;
168 struct channel_data
*chan
;
169 spinlock_t lock
; /* For exclusive operations on this structure */
170 char id_string
[COSA_MAX_ID_STRING
]; /* ROM monitor ID string */
171 char *type
; /* card type */
175 * Define this if you want all the possible ports to be autoprobed.
176 * It is here but it probably is not a good idea to use this.
178 /* #define COSA_ISA_AUTOPROBE 1 */
181 * Character device major number. 117 was allocated for us.
182 * The value of 0 means to allocate a first free one.
184 static int cosa_major
= 117;
187 * Encoding of the minor numbers:
188 * The lowest CARD_MINOR_BITS bits means the channel on the single card,
189 * the highest bits means the card number.
191 #define CARD_MINOR_BITS 4 /* How many bits in minor number are reserved
192 * for the single card */
194 * The following depends on CARD_MINOR_BITS. Unfortunately, the "MODULE_STRING"
195 * macro doesn't like anything other than the raw number as an argument :-(
198 /* #define MAX_CARDS (1 << (8-CARD_MINOR_BITS)) */
200 #define DRIVER_RX_READY 0x0001
201 #define DRIVER_TX_READY 0x0002
202 #define DRIVER_TXMAP_SHIFT 2
203 #define DRIVER_TXMAP_MASK 0x0c /* FIXME: 0xfc for 8-channel version */
206 * for cosa->rxtx - indicates whether either transmit or receive is
207 * in progress. These values are mean number of the bit.
213 #define COSA_MTU 2000 /* FIXME: I don't know this exactly */
215 #undef DEBUG_DATA //1 /* Dump the data read or written to the channel */
216 #undef DEBUG_IRQS //1 /* Print the message when the IRQ is received */
217 #undef DEBUG_IO //1 /* Dump the I/O traffic */
219 #define TX_TIMEOUT (5*HZ)
221 /* Maybe the following should be allocated dynamically */
222 static struct cosa_data cosa_cards
[MAX_CARDS
];
225 #ifdef COSA_ISA_AUTOPROBE
226 static int io
[MAX_CARDS
+1] = { 0x220, 0x228, 0x210, 0x218, 0, };
227 /* NOTE: DMA is not autoprobed!!! */
228 static int dma
[MAX_CARDS
+1] = { 1, 7, 1, 7, 1, 7, 1, 7, 0, };
230 static int io
[MAX_CARDS
+1];
231 static int dma
[MAX_CARDS
+1];
233 /* IRQ can be safely autoprobed */
234 static int irq
[MAX_CARDS
+1] = { -1, -1, -1, -1, -1, -1, 0, };
237 static struct class *cosa_class
;
240 module_param_array(io
, int, NULL
, 0);
241 MODULE_PARM_DESC(io
, "The I/O bases of the COSA or SRP cards");
242 module_param_array(irq
, int, NULL
, 0);
243 MODULE_PARM_DESC(irq
, "The IRQ lines of the COSA or SRP cards");
244 module_param_array(dma
, int, NULL
, 0);
245 MODULE_PARM_DESC(dma
, "The DMA channels of the COSA or SRP cards");
247 MODULE_AUTHOR("Jan \"Yenya\" Kasprzak, <kas@fi.muni.cz>");
248 MODULE_DESCRIPTION("Modular driver for the COSA or SRP synchronous card");
249 MODULE_LICENSE("GPL");
252 /* I use this mainly for testing purposes */
254 #define cosa_outb outb_p
255 #define cosa_outw outw_p
256 #define cosa_inb inb_p
257 #define cosa_inw inw_p
259 #define cosa_outb outb
260 #define cosa_outw outw
265 #define is_8bit(cosa) (!(cosa->datareg & 0x08))
267 #define cosa_getstatus(cosa) (cosa_inb(cosa->statusreg))
268 #define cosa_putstatus(cosa, stat) (cosa_outb(stat, cosa->statusreg))
269 #define cosa_getdata16(cosa) (cosa_inw(cosa->datareg))
270 #define cosa_getdata8(cosa) (cosa_inb(cosa->datareg))
271 #define cosa_putdata16(cosa, dt) (cosa_outw(dt, cosa->datareg))
272 #define cosa_putdata8(cosa, dt) (cosa_outb(dt, cosa->datareg))
274 /* Initialization stuff */
275 static int cosa_probe(int ioaddr
, int irq
, int dma
);
278 static void cosa_enable_rx(struct channel_data
*chan
);
279 static void cosa_disable_rx(struct channel_data
*chan
);
280 static int cosa_start_tx(struct channel_data
*channel
, char *buf
, int size
);
281 static void cosa_kick(struct cosa_data
*cosa
);
282 static int cosa_dma_able(struct channel_data
*chan
, char *buf
, int data
);
284 /* SPPP/HDLC stuff */
285 static void sppp_channel_init(struct channel_data
*chan
);
286 static void sppp_channel_delete(struct channel_data
*chan
);
287 static int cosa_sppp_open(struct net_device
*d
);
288 static int cosa_sppp_close(struct net_device
*d
);
289 static void cosa_sppp_timeout(struct net_device
*d
);
290 static int cosa_sppp_tx(struct sk_buff
*skb
, struct net_device
*d
);
291 static char *sppp_setup_rx(struct channel_data
*channel
, int size
);
292 static int sppp_rx_done(struct channel_data
*channel
);
293 static int sppp_tx_done(struct channel_data
*channel
, int size
);
294 static int cosa_sppp_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
);
295 static struct net_device_stats
*cosa_net_stats(struct net_device
*dev
);
297 /* Character device */
298 static void chardev_channel_init(struct channel_data
*chan
);
299 static char *chrdev_setup_rx(struct channel_data
*channel
, int size
);
300 static int chrdev_rx_done(struct channel_data
*channel
);
301 static int chrdev_tx_done(struct channel_data
*channel
, int size
);
302 static ssize_t
cosa_read(struct file
*file
,
303 char __user
*buf
, size_t count
, loff_t
*ppos
);
304 static ssize_t
cosa_write(struct file
*file
,
305 const char __user
*buf
, size_t count
, loff_t
*ppos
);
306 static unsigned int cosa_poll(struct file
*file
, poll_table
*poll
);
307 static int cosa_open(struct inode
*inode
, struct file
*file
);
308 static int cosa_release(struct inode
*inode
, struct file
*file
);
309 static int cosa_chardev_ioctl(struct inode
*inode
, struct file
*file
,
310 unsigned int cmd
, unsigned long arg
);
311 #ifdef COSA_FASYNC_WORKING
312 static int cosa_fasync(struct inode
*inode
, struct file
*file
, int on
);
315 static const struct file_operations cosa_fops
= {
316 .owner
= THIS_MODULE
,
321 .ioctl
= cosa_chardev_ioctl
,
323 .release
= cosa_release
,
324 #ifdef COSA_FASYNC_WORKING
325 .fasync
= cosa_fasync
,
330 static int cosa_start(struct cosa_data
*cosa
, int address
);
331 static int cosa_reset(struct cosa_data
*cosa
);
332 static int cosa_download(struct cosa_data
*cosa
, void __user
*a
);
333 static int cosa_readmem(struct cosa_data
*cosa
, void __user
*a
);
335 /* COSA/SRP ROM monitor */
336 static int download(struct cosa_data
*cosa
, const char __user
*data
, int addr
, int len
);
337 static int startmicrocode(struct cosa_data
*cosa
, int address
);
338 static int readmem(struct cosa_data
*cosa
, char __user
*data
, int addr
, int len
);
339 static int cosa_reset_and_read_id(struct cosa_data
*cosa
, char *id
);
341 /* Auxilliary functions */
342 static int get_wait_data(struct cosa_data
*cosa
);
343 static int put_wait_data(struct cosa_data
*cosa
, int data
);
344 static int puthexnumber(struct cosa_data
*cosa
, int number
);
345 static void put_driver_status(struct cosa_data
*cosa
);
346 static void put_driver_status_nolock(struct cosa_data
*cosa
);
348 /* Interrupt handling */
349 static irqreturn_t
cosa_interrupt(int irq
, void *cosa
);
351 /* I/O ops debugging */
353 static void debug_data_in(struct cosa_data
*cosa
, int data
);
354 static void debug_data_out(struct cosa_data
*cosa
, int data
);
355 static void debug_data_cmd(struct cosa_data
*cosa
, int data
);
356 static void debug_status_in(struct cosa_data
*cosa
, int status
);
357 static void debug_status_out(struct cosa_data
*cosa
, int status
);
361 /* ---------- Initialization stuff ---------- */
363 static int __init
cosa_init(void)
367 printk(KERN_INFO
"cosa v1.08 (c) 1997-2000 Jan Kasprzak <kas@fi.muni.cz>\n");
369 printk(KERN_INFO
"cosa: SMP found. Please mail any success/failure reports to the author.\n");
371 if (cosa_major
> 0) {
372 if (register_chrdev(cosa_major
, "cosa", &cosa_fops
)) {
373 printk(KERN_WARNING
"cosa: unable to get major %d\n",
379 if (!(cosa_major
=register_chrdev(0, "cosa", &cosa_fops
))) {
380 printk(KERN_WARNING
"cosa: unable to register chardev\n");
385 for (i
=0; i
<MAX_CARDS
; i
++)
386 cosa_cards
[i
].num
= -1;
387 for (i
=0; io
[i
] != 0 && i
< MAX_CARDS
; i
++)
388 cosa_probe(io
[i
], irq
[i
], dma
[i
]);
390 printk(KERN_WARNING
"cosa: no devices found.\n");
391 unregister_chrdev(cosa_major
, "cosa");
395 cosa_class
= class_create(THIS_MODULE
, "cosa");
396 if (IS_ERR(cosa_class
)) {
397 err
= PTR_ERR(cosa_class
);
400 for (i
=0; i
<nr_cards
; i
++) {
401 device_create(cosa_class
, NULL
, MKDEV(cosa_major
, i
), "cosa%d", i
);
407 unregister_chrdev(cosa_major
, "cosa");
411 module_init(cosa_init
);
413 static void __exit
cosa_exit(void)
415 struct cosa_data
*cosa
;
417 printk(KERN_INFO
"Unloading the cosa module\n");
419 for (i
=0; i
<nr_cards
; i
++)
420 device_destroy(cosa_class
, MKDEV(cosa_major
, i
));
421 class_destroy(cosa_class
);
422 for (cosa
=cosa_cards
; nr_cards
--; cosa
++) {
423 /* Clean up the per-channel data */
424 for (i
=0; i
<cosa
->nchannels
; i
++) {
425 /* Chardev driver has no alloc'd per-channel data */
426 sppp_channel_delete(cosa
->chan
+i
);
428 /* Clean up the per-card data */
430 kfree(cosa
->bouncebuf
);
431 free_irq(cosa
->irq
, cosa
);
433 release_region(cosa
->datareg
,is_8bit(cosa
)?2:4);
435 unregister_chrdev(cosa_major
, "cosa");
437 module_exit(cosa_exit
);
440 * This function should register all the net devices needed for the
443 static __inline__
void channel_init(struct channel_data
*chan
)
445 sprintf(chan
->name
, "cosa%dc%d", chan
->cosa
->num
, chan
->num
);
447 /* Initialize the chardev data structures */
448 chardev_channel_init(chan
);
450 /* Register the sppp interface */
451 sppp_channel_init(chan
);
454 static int cosa_probe(int base
, int irq
, int dma
)
456 struct cosa_data
*cosa
= cosa_cards
+nr_cards
;
459 memset(cosa
, 0, sizeof(struct cosa_data
));
461 /* Checking validity of parameters: */
462 /* IRQ should be 2-7 or 10-15; negative IRQ means autoprobe */
463 if ((irq
>= 0 && irq
< 2) || irq
> 15 || (irq
< 10 && irq
> 7)) {
464 printk (KERN_INFO
"cosa_probe: invalid IRQ %d\n", irq
);
467 /* I/O address should be between 0x100 and 0x3ff and should be
469 if (base
< 0x100 || base
> 0x3ff || base
& 0x7) {
470 printk (KERN_INFO
"cosa_probe: invalid I/O address 0x%x\n",
474 /* DMA should be 0,1 or 3-7 */
475 if (dma
< 0 || dma
== 4 || dma
> 7) {
476 printk (KERN_INFO
"cosa_probe: invalid DMA %d\n", dma
);
479 /* and finally, on 16-bit COSA DMA should be 4-7 and
480 * I/O base should not be multiple of 0x10 */
481 if (((base
& 0x8) && dma
< 4) || (!(base
& 0x8) && dma
> 3)) {
482 printk (KERN_INFO
"cosa_probe: 8/16 bit base and DMA mismatch"
483 " (base=0x%x, dma=%d)\n", base
, dma
);
488 cosa
->datareg
= base
;
489 cosa
->statusreg
= is_8bit(cosa
)?base
+1:base
+2;
490 spin_lock_init(&cosa
->lock
);
492 if (!request_region(base
, is_8bit(cosa
)?2:4,"cosa"))
495 if (cosa_reset_and_read_id(cosa
, cosa
->id_string
) < 0) {
496 printk(KERN_DEBUG
"cosa: probe at 0x%x failed.\n", base
);
501 /* Test the validity of identification string */
502 if (!strncmp(cosa
->id_string
, "SRP", 3))
504 else if (!strncmp(cosa
->id_string
, "COSA", 4))
505 cosa
->type
= is_8bit(cosa
)? "cosa8": "cosa16";
507 /* Print a warning only if we are not autoprobing */
508 #ifndef COSA_ISA_AUTOPROBE
509 printk(KERN_INFO
"cosa: valid signature not found at 0x%x.\n",
515 /* Update the name of the region now we know the type of card */
516 release_region(base
, is_8bit(cosa
)?2:4);
517 if (!request_region(base
, is_8bit(cosa
)?2:4, cosa
->type
)) {
518 printk(KERN_DEBUG
"cosa: changing name at 0x%x failed.\n", base
);
522 /* Now do IRQ autoprobe */
525 /* printk(KERN_INFO "IRQ autoprobe\n"); */
526 irqs
= probe_irq_on();
528 * Enable interrupt on tx buffer empty (it sure is)
530 * FIXME: When this code is not used as module, we should
531 * probably call udelay() instead of the interruptible sleep.
533 set_current_state(TASK_INTERRUPTIBLE
);
534 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
535 schedule_timeout(30);
536 irq
= probe_irq_off(irqs
);
537 /* Disable all IRQs from the card */
538 cosa_putstatus(cosa
, 0);
539 /* Empty the received data register */
543 printk (KERN_INFO
"cosa IRQ autoprobe: multiple interrupts obtained (%d, board at 0x%x)\n",
549 printk (KERN_INFO
"cosa IRQ autoprobe: no interrupt obtained (board at 0x%x)\n",
556 cosa
->num
= nr_cards
;
558 cosa
->nchannels
= 2; /* FIXME: how to determine this? */
560 if (request_irq(cosa
->irq
, cosa_interrupt
, 0, cosa
->type
, cosa
)) {
564 if (request_dma(cosa
->dma
, cosa
->type
)) {
569 cosa
->bouncebuf
= kmalloc(COSA_MTU
, GFP_KERNEL
|GFP_DMA
);
570 if (!cosa
->bouncebuf
) {
574 sprintf(cosa
->name
, "cosa%d", cosa
->num
);
576 /* Initialize the per-channel data */
577 cosa
->chan
= kcalloc(cosa
->nchannels
, sizeof(struct channel_data
), GFP_KERNEL
);
582 for (i
=0; i
<cosa
->nchannels
; i
++) {
583 cosa
->chan
[i
].cosa
= cosa
;
584 cosa
->chan
[i
].num
= i
;
585 channel_init(cosa
->chan
+i
);
588 printk (KERN_INFO
"cosa%d: %s (%s at 0x%x irq %d dma %d), %d channels\n",
589 cosa
->num
, cosa
->id_string
, cosa
->type
,
590 cosa
->datareg
, cosa
->irq
, cosa
->dma
, cosa
->nchannels
);
594 kfree(cosa
->bouncebuf
);
598 free_irq(cosa
->irq
, cosa
);
600 release_region(cosa
->datareg
,is_8bit(cosa
)?2:4);
601 printk(KERN_NOTICE
"cosa%d: allocating resources failed\n",
607 /*---------- SPPP/HDLC netdevice ---------- */
609 static void cosa_setup(struct net_device
*d
)
611 d
->open
= cosa_sppp_open
;
612 d
->stop
= cosa_sppp_close
;
613 d
->hard_start_xmit
= cosa_sppp_tx
;
614 d
->do_ioctl
= cosa_sppp_ioctl
;
615 d
->get_stats
= cosa_net_stats
;
616 d
->tx_timeout
= cosa_sppp_timeout
;
617 d
->watchdog_timeo
= TX_TIMEOUT
;
620 static void sppp_channel_init(struct channel_data
*chan
)
622 struct net_device
*d
;
623 chan
->if_ptr
= &chan
->pppdev
;
624 d
= alloc_netdev(0, chan
->name
, cosa_setup
);
626 printk(KERN_WARNING
"%s: alloc_netdev failed.\n", chan
->name
);
629 chan
->pppdev
.dev
= d
;
630 d
->base_addr
= chan
->cosa
->datareg
;
631 d
->irq
= chan
->cosa
->irq
;
632 d
->dma
= chan
->cosa
->dma
;
634 sppp_attach(&chan
->pppdev
);
635 if (register_netdev(d
)) {
636 printk(KERN_WARNING
"%s: register_netdev failed.\n", d
->name
);
639 chan
->pppdev
.dev
= NULL
;
644 static void sppp_channel_delete(struct channel_data
*chan
)
646 unregister_netdev(chan
->pppdev
.dev
);
647 sppp_detach(chan
->pppdev
.dev
);
648 free_netdev(chan
->pppdev
.dev
);
649 chan
->pppdev
.dev
= NULL
;
652 static int cosa_sppp_open(struct net_device
*d
)
654 struct channel_data
*chan
= d
->ml_priv
;
658 if (!(chan
->cosa
->firmware_status
& COSA_FW_START
)) {
659 printk(KERN_NOTICE
"%s: start the firmware first (status %d)\n",
660 chan
->cosa
->name
, chan
->cosa
->firmware_status
);
663 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
664 if (chan
->usage
!= 0) {
665 printk(KERN_WARNING
"%s: sppp_open called with usage count %d\n",
666 chan
->name
, chan
->usage
);
667 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
670 chan
->setup_rx
= sppp_setup_rx
;
671 chan
->tx_done
= sppp_tx_done
;
672 chan
->rx_done
= sppp_rx_done
;
675 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
679 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
683 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
687 netif_start_queue(d
);
688 cosa_enable_rx(chan
);
692 static int cosa_sppp_tx(struct sk_buff
*skb
, struct net_device
*dev
)
694 struct channel_data
*chan
= dev
->ml_priv
;
696 netif_stop_queue(dev
);
699 cosa_start_tx(chan
, skb
->data
, skb
->len
);
703 static void cosa_sppp_timeout(struct net_device
*dev
)
705 struct channel_data
*chan
= dev
->ml_priv
;
707 if (test_bit(RXBIT
, &chan
->cosa
->rxtx
)) {
708 chan
->stats
.rx_errors
++;
709 chan
->stats
.rx_missed_errors
++;
711 chan
->stats
.tx_errors
++;
712 chan
->stats
.tx_aborted_errors
++;
714 cosa_kick(chan
->cosa
);
716 dev_kfree_skb(chan
->tx_skb
);
719 netif_wake_queue(dev
);
722 static int cosa_sppp_close(struct net_device
*d
)
724 struct channel_data
*chan
= d
->ml_priv
;
729 cosa_disable_rx(chan
);
730 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
732 kfree_skb(chan
->rx_skb
);
736 kfree_skb(chan
->tx_skb
);
741 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
745 static char *sppp_setup_rx(struct channel_data
*chan
, int size
)
748 * We can safely fall back to non-dma-able memory, because we have
749 * the cosa->bouncebuf pre-allocated.
752 kfree_skb(chan
->rx_skb
);
753 chan
->rx_skb
= dev_alloc_skb(size
);
754 if (chan
->rx_skb
== NULL
) {
755 printk(KERN_NOTICE
"%s: Memory squeeze, dropping packet\n",
757 chan
->stats
.rx_dropped
++;
760 chan
->pppdev
.dev
->trans_start
= jiffies
;
761 return skb_put(chan
->rx_skb
, size
);
764 static int sppp_rx_done(struct channel_data
*chan
)
767 printk(KERN_WARNING
"%s: rx_done with empty skb!\n",
769 chan
->stats
.rx_errors
++;
770 chan
->stats
.rx_frame_errors
++;
773 chan
->rx_skb
->protocol
= htons(ETH_P_WAN_PPP
);
774 chan
->rx_skb
->dev
= chan
->pppdev
.dev
;
775 skb_reset_mac_header(chan
->rx_skb
);
776 chan
->stats
.rx_packets
++;
777 chan
->stats
.rx_bytes
+= chan
->cosa
->rxsize
;
778 netif_rx(chan
->rx_skb
);
780 chan
->pppdev
.dev
->last_rx
= jiffies
;
785 static int sppp_tx_done(struct channel_data
*chan
, int size
)
788 printk(KERN_WARNING
"%s: tx_done with empty skb!\n",
790 chan
->stats
.tx_errors
++;
791 chan
->stats
.tx_aborted_errors
++;
794 dev_kfree_skb_irq(chan
->tx_skb
);
796 chan
->stats
.tx_packets
++;
797 chan
->stats
.tx_bytes
+= size
;
798 netif_wake_queue(chan
->pppdev
.dev
);
802 static struct net_device_stats
*cosa_net_stats(struct net_device
*dev
)
804 struct channel_data
*chan
= dev
->ml_priv
;
809 /*---------- Character device ---------- */
811 static void chardev_channel_init(struct channel_data
*chan
)
813 mutex_init(&chan
->rlock
);
814 init_MUTEX(&chan
->wsem
);
817 static ssize_t
cosa_read(struct file
*file
,
818 char __user
*buf
, size_t count
, loff_t
*ppos
)
820 DECLARE_WAITQUEUE(wait
, current
);
822 struct channel_data
*chan
= file
->private_data
;
823 struct cosa_data
*cosa
= chan
->cosa
;
826 if (!(cosa
->firmware_status
& COSA_FW_START
)) {
827 printk(KERN_NOTICE
"%s: start the firmware first (status %d)\n",
828 cosa
->name
, cosa
->firmware_status
);
831 if (mutex_lock_interruptible(&chan
->rlock
))
834 if ((chan
->rxdata
= kmalloc(COSA_MTU
, GFP_DMA
|GFP_KERNEL
)) == NULL
) {
835 printk(KERN_INFO
"%s: cosa_read() - OOM\n", cosa
->name
);
836 mutex_unlock(&chan
->rlock
);
841 cosa_enable_rx(chan
);
842 spin_lock_irqsave(&cosa
->lock
, flags
);
843 add_wait_queue(&chan
->rxwaitq
, &wait
);
844 while(!chan
->rx_status
) {
845 current
->state
= TASK_INTERRUPTIBLE
;
846 spin_unlock_irqrestore(&cosa
->lock
, flags
);
848 spin_lock_irqsave(&cosa
->lock
, flags
);
849 if (signal_pending(current
) && chan
->rx_status
== 0) {
851 remove_wait_queue(&chan
->rxwaitq
, &wait
);
852 current
->state
= TASK_RUNNING
;
853 spin_unlock_irqrestore(&cosa
->lock
, flags
);
854 mutex_unlock(&chan
->rlock
);
858 remove_wait_queue(&chan
->rxwaitq
, &wait
);
859 current
->state
= TASK_RUNNING
;
861 count
= chan
->rxsize
;
862 spin_unlock_irqrestore(&cosa
->lock
, flags
);
863 mutex_unlock(&chan
->rlock
);
865 if (copy_to_user(buf
, kbuf
, count
)) {
873 static char *chrdev_setup_rx(struct channel_data
*chan
, int size
)
875 /* Expect size <= COSA_MTU */
880 static int chrdev_rx_done(struct channel_data
*chan
)
882 if (chan
->rx_status
) { /* Reader has died */
887 wake_up_interruptible(&chan
->rxwaitq
);
892 static ssize_t
cosa_write(struct file
*file
,
893 const char __user
*buf
, size_t count
, loff_t
*ppos
)
895 DECLARE_WAITQUEUE(wait
, current
);
896 struct channel_data
*chan
= file
->private_data
;
897 struct cosa_data
*cosa
= chan
->cosa
;
901 if (!(cosa
->firmware_status
& COSA_FW_START
)) {
902 printk(KERN_NOTICE
"%s: start the firmware first (status %d)\n",
903 cosa
->name
, cosa
->firmware_status
);
906 if (down_interruptible(&chan
->wsem
))
909 if (count
> COSA_MTU
)
912 /* Allocate the buffer */
913 if ((kbuf
= kmalloc(count
, GFP_KERNEL
|GFP_DMA
)) == NULL
) {
914 printk(KERN_NOTICE
"%s: cosa_write() OOM - dropping packet\n",
919 if (copy_from_user(kbuf
, buf
, count
)) {
925 cosa_start_tx(chan
, kbuf
, count
);
927 spin_lock_irqsave(&cosa
->lock
, flags
);
928 add_wait_queue(&chan
->txwaitq
, &wait
);
929 while(!chan
->tx_status
) {
930 current
->state
= TASK_INTERRUPTIBLE
;
931 spin_unlock_irqrestore(&cosa
->lock
, flags
);
933 spin_lock_irqsave(&cosa
->lock
, flags
);
934 if (signal_pending(current
) && chan
->tx_status
== 0) {
936 remove_wait_queue(&chan
->txwaitq
, &wait
);
937 current
->state
= TASK_RUNNING
;
939 spin_unlock_irqrestore(&cosa
->lock
, flags
);
943 remove_wait_queue(&chan
->txwaitq
, &wait
);
944 current
->state
= TASK_RUNNING
;
946 spin_unlock_irqrestore(&cosa
->lock
, flags
);
951 static int chrdev_tx_done(struct channel_data
*chan
, int size
)
953 if (chan
->tx_status
) { /* Writer was interrupted */
958 wake_up_interruptible(&chan
->txwaitq
);
962 static unsigned int cosa_poll(struct file
*file
, poll_table
*poll
)
964 printk(KERN_INFO
"cosa_poll is here\n");
968 static int cosa_open(struct inode
*inode
, struct file
*file
)
970 struct cosa_data
*cosa
;
971 struct channel_data
*chan
;
977 if ((n
=iminor(file
->f_path
.dentry
->d_inode
)>>CARD_MINOR_BITS
)
984 if ((n
=iminor(file
->f_path
.dentry
->d_inode
)
985 & ((1<<CARD_MINOR_BITS
)-1)) >= cosa
->nchannels
) {
989 chan
= cosa
->chan
+ n
;
991 file
->private_data
= chan
;
993 spin_lock_irqsave(&cosa
->lock
, flags
);
995 if (chan
->usage
< 0) { /* in netdev mode */
996 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1003 chan
->tx_done
= chrdev_tx_done
;
1004 chan
->setup_rx
= chrdev_setup_rx
;
1005 chan
->rx_done
= chrdev_rx_done
;
1006 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1012 static int cosa_release(struct inode
*inode
, struct file
*file
)
1014 struct channel_data
*channel
= file
->private_data
;
1015 struct cosa_data
*cosa
;
1016 unsigned long flags
;
1018 cosa
= channel
->cosa
;
1019 spin_lock_irqsave(&cosa
->lock
, flags
);
1022 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1026 #ifdef COSA_FASYNC_WORKING
1027 static struct fasync_struct
*fasync
[256] = { NULL
, };
1029 /* To be done ... */
1030 static int cosa_fasync(struct inode
*inode
, struct file
*file
, int on
)
1032 int port
= iminor(inode
);
1033 int rv
= fasync_helper(inode
, file
, on
, &fasync
[port
]);
1034 return rv
< 0 ? rv
: 0;
1039 /* ---------- Ioctls ---------- */
1042 * Ioctl subroutines can safely be made inline, because they are called
1043 * only from cosa_ioctl().
1045 static inline int cosa_reset(struct cosa_data
*cosa
)
1047 char idstring
[COSA_MAX_ID_STRING
];
1048 if (cosa
->usage
> 1)
1049 printk(KERN_INFO
"cosa%d: WARNING: reset requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1050 cosa
->num
, cosa
->usage
);
1051 cosa
->firmware_status
&= ~(COSA_FW_RESET
|COSA_FW_START
);
1052 if (cosa_reset_and_read_id(cosa
, idstring
) < 0) {
1053 printk(KERN_NOTICE
"cosa%d: reset failed\n", cosa
->num
);
1056 printk(KERN_INFO
"cosa%d: resetting device: %s\n", cosa
->num
,
1058 cosa
->firmware_status
|= COSA_FW_RESET
;
1062 /* High-level function to download data into COSA memory. Calls download() */
1063 static inline int cosa_download(struct cosa_data
*cosa
, void __user
*arg
)
1065 struct cosa_download d
;
1068 if (cosa
->usage
> 1)
1069 printk(KERN_INFO
"%s: WARNING: download of microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1070 cosa
->name
, cosa
->usage
);
1071 if (!(cosa
->firmware_status
& COSA_FW_RESET
)) {
1072 printk(KERN_NOTICE
"%s: reset the card first (status %d).\n",
1073 cosa
->name
, cosa
->firmware_status
);
1077 if (copy_from_user(&d
, arg
, sizeof(d
)))
1080 if (d
.addr
< 0 || d
.addr
> COSA_MAX_FIRMWARE_SIZE
)
1082 if (d
.len
< 0 || d
.len
> COSA_MAX_FIRMWARE_SIZE
)
1086 /* If something fails, force the user to reset the card */
1087 cosa
->firmware_status
&= ~(COSA_FW_RESET
|COSA_FW_DOWNLOAD
);
1089 i
= download(cosa
, d
.code
, d
.len
, d
.addr
);
1091 printk(KERN_NOTICE
"cosa%d: microcode download failed: %d\n",
1095 printk(KERN_INFO
"cosa%d: downloading microcode - 0x%04x bytes at 0x%04x\n",
1096 cosa
->num
, d
.len
, d
.addr
);
1097 cosa
->firmware_status
|= COSA_FW_RESET
|COSA_FW_DOWNLOAD
;
1101 /* High-level function to read COSA memory. Calls readmem() */
1102 static inline int cosa_readmem(struct cosa_data
*cosa
, void __user
*arg
)
1104 struct cosa_download d
;
1107 if (cosa
->usage
> 1)
1108 printk(KERN_INFO
"cosa%d: WARNING: readmem requested with "
1109 "cosa->usage > 1 (%d). Odd things may happen.\n",
1110 cosa
->num
, cosa
->usage
);
1111 if (!(cosa
->firmware_status
& COSA_FW_RESET
)) {
1112 printk(KERN_NOTICE
"%s: reset the card first (status %d).\n",
1113 cosa
->name
, cosa
->firmware_status
);
1117 if (copy_from_user(&d
, arg
, sizeof(d
)))
1120 /* If something fails, force the user to reset the card */
1121 cosa
->firmware_status
&= ~COSA_FW_RESET
;
1123 i
= readmem(cosa
, d
.code
, d
.len
, d
.addr
);
1125 printk(KERN_NOTICE
"cosa%d: reading memory failed: %d\n",
1129 printk(KERN_INFO
"cosa%d: reading card memory - 0x%04x bytes at 0x%04x\n",
1130 cosa
->num
, d
.len
, d
.addr
);
1131 cosa
->firmware_status
|= COSA_FW_RESET
;
1135 /* High-level function to start microcode. Calls startmicrocode(). */
1136 static inline int cosa_start(struct cosa_data
*cosa
, int address
)
1140 if (cosa
->usage
> 1)
1141 printk(KERN_INFO
"cosa%d: WARNING: start microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1142 cosa
->num
, cosa
->usage
);
1144 if ((cosa
->firmware_status
& (COSA_FW_RESET
|COSA_FW_DOWNLOAD
))
1145 != (COSA_FW_RESET
|COSA_FW_DOWNLOAD
)) {
1146 printk(KERN_NOTICE
"%s: download the microcode and/or reset the card first (status %d).\n",
1147 cosa
->name
, cosa
->firmware_status
);
1150 cosa
->firmware_status
&= ~COSA_FW_RESET
;
1151 if ((i
=startmicrocode(cosa
, address
)) < 0) {
1152 printk(KERN_NOTICE
"cosa%d: start microcode at 0x%04x failed: %d\n",
1153 cosa
->num
, address
, i
);
1156 printk(KERN_INFO
"cosa%d: starting microcode at 0x%04x\n",
1157 cosa
->num
, address
);
1158 cosa
->startaddr
= address
;
1159 cosa
->firmware_status
|= COSA_FW_START
;
1163 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1164 static inline int cosa_getidstr(struct cosa_data
*cosa
, char __user
*string
)
1166 int l
= strlen(cosa
->id_string
)+1;
1167 if (copy_to_user(string
, cosa
->id_string
, l
))
1172 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1173 static inline int cosa_gettype(struct cosa_data
*cosa
, char __user
*string
)
1175 int l
= strlen(cosa
->type
)+1;
1176 if (copy_to_user(string
, cosa
->type
, l
))
1181 static int cosa_ioctl_common(struct cosa_data
*cosa
,
1182 struct channel_data
*channel
, unsigned int cmd
, unsigned long arg
)
1184 void __user
*argp
= (void __user
*)arg
;
1186 case COSAIORSET
: /* Reset the device */
1187 if (!capable(CAP_NET_ADMIN
))
1189 return cosa_reset(cosa
);
1190 case COSAIOSTRT
: /* Start the firmware */
1191 if (!capable(CAP_SYS_RAWIO
))
1193 return cosa_start(cosa
, arg
);
1194 case COSAIODOWNLD
: /* Download the firmware */
1195 if (!capable(CAP_SYS_RAWIO
))
1198 return cosa_download(cosa
, argp
);
1200 if (!capable(CAP_SYS_RAWIO
))
1202 return cosa_readmem(cosa
, argp
);
1204 return cosa_gettype(cosa
, argp
);
1206 return cosa_getidstr(cosa
, argp
);
1210 return cosa
->nchannels
;
1212 if (!capable(CAP_SYS_RAWIO
))
1216 if (arg
!= COSA_BM_OFF
&& arg
!= COSA_BM_ON
)
1218 cosa
->busmaster
= arg
;
1221 return cosa
->busmaster
;
1223 return -ENOIOCTLCMD
;
1226 static int cosa_sppp_ioctl(struct net_device
*dev
, struct ifreq
*ifr
,
1230 struct channel_data
*chan
= dev
->ml_priv
;
1231 rv
= cosa_ioctl_common(chan
->cosa
, chan
, cmd
, (unsigned long)ifr
->ifr_data
);
1232 if (rv
== -ENOIOCTLCMD
) {
1233 return sppp_do_ioctl(dev
, ifr
, cmd
);
1238 static int cosa_chardev_ioctl(struct inode
*inode
, struct file
*file
,
1239 unsigned int cmd
, unsigned long arg
)
1241 struct channel_data
*channel
= file
->private_data
;
1242 struct cosa_data
*cosa
= channel
->cosa
;
1243 return cosa_ioctl_common(cosa
, channel
, cmd
, arg
);
1247 /*---------- HW layer interface ---------- */
1250 * The higher layer can bind itself to the HW layer by setting the callbacks
1251 * in the channel_data structure and by using these routines.
1253 static void cosa_enable_rx(struct channel_data
*chan
)
1255 struct cosa_data
*cosa
= chan
->cosa
;
1257 if (!test_and_set_bit(chan
->num
, &cosa
->rxbitmap
))
1258 put_driver_status(cosa
);
1261 static void cosa_disable_rx(struct channel_data
*chan
)
1263 struct cosa_data
*cosa
= chan
->cosa
;
1265 if (test_and_clear_bit(chan
->num
, &cosa
->rxbitmap
))
1266 put_driver_status(cosa
);
1270 * FIXME: This routine probably should check for cosa_start_tx() called when
1271 * the previous transmit is still unfinished. In this case the non-zero
1272 * return value should indicate to the caller that the queuing(sp?) up
1273 * the transmit has failed.
1275 static int cosa_start_tx(struct channel_data
*chan
, char *buf
, int len
)
1277 struct cosa_data
*cosa
= chan
->cosa
;
1278 unsigned long flags
;
1282 printk(KERN_INFO
"cosa%dc%d: starting tx(0x%x)", chan
->cosa
->num
,
1284 for (i
=0; i
<len
; i
++)
1285 printk(" %02x", buf
[i
]&0xff);
1288 spin_lock_irqsave(&cosa
->lock
, flags
);
1292 chan
->txsize
= COSA_MTU
;
1293 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1295 /* Tell the firmware we are ready */
1296 set_bit(chan
->num
, &cosa
->txbitmap
);
1297 put_driver_status(cosa
);
1302 static void put_driver_status(struct cosa_data
*cosa
)
1304 unsigned long flags
;
1307 spin_lock_irqsave(&cosa
->lock
, flags
);
1309 status
= (cosa
->rxbitmap
? DRIVER_RX_READY
: 0)
1310 | (cosa
->txbitmap
? DRIVER_TX_READY
: 0)
1311 | (cosa
->txbitmap
? ~(cosa
->txbitmap
<<DRIVER_TXMAP_SHIFT
)
1312 &DRIVER_TXMAP_MASK
: 0);
1314 if (cosa
->rxbitmap
|cosa
->txbitmap
) {
1315 if (!cosa
->enabled
) {
1316 cosa_putstatus(cosa
, SR_RX_INT_ENA
);
1318 debug_status_out(cosa
, SR_RX_INT_ENA
);
1322 } else if (cosa
->enabled
) {
1324 cosa_putstatus(cosa
, 0);
1326 debug_status_out(cosa
, 0);
1329 cosa_putdata8(cosa
, status
);
1331 debug_data_cmd(cosa
, status
);
1334 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1337 static void put_driver_status_nolock(struct cosa_data
*cosa
)
1341 status
= (cosa
->rxbitmap
? DRIVER_RX_READY
: 0)
1342 | (cosa
->txbitmap
? DRIVER_TX_READY
: 0)
1343 | (cosa
->txbitmap
? ~(cosa
->txbitmap
<<DRIVER_TXMAP_SHIFT
)
1344 &DRIVER_TXMAP_MASK
: 0);
1346 if (cosa
->rxbitmap
|cosa
->txbitmap
) {
1347 cosa_putstatus(cosa
, SR_RX_INT_ENA
);
1349 debug_status_out(cosa
, SR_RX_INT_ENA
);
1353 cosa_putstatus(cosa
, 0);
1355 debug_status_out(cosa
, 0);
1359 cosa_putdata8(cosa
, status
);
1361 debug_data_cmd(cosa
, status
);
1366 * The "kickme" function: When the DMA times out, this is called to
1367 * clean up the driver status.
1368 * FIXME: Preliminary support, the interface is probably wrong.
1370 static void cosa_kick(struct cosa_data
*cosa
)
1372 unsigned long flags
, flags1
;
1373 char *s
= "(probably) IRQ";
1375 if (test_bit(RXBIT
, &cosa
->rxtx
))
1377 if (test_bit(TXBIT
, &cosa
->rxtx
))
1380 printk(KERN_INFO
"%s: %s timeout - restarting.\n", cosa
->name
, s
);
1381 spin_lock_irqsave(&cosa
->lock
, flags
);
1384 flags1
= claim_dma_lock();
1385 disable_dma(cosa
->dma
);
1386 clear_dma_ff(cosa
->dma
);
1387 release_dma_lock(flags1
);
1389 /* FIXME: Anything else? */
1391 cosa_putstatus(cosa
, 0);
1393 (void) cosa_getdata8(cosa
);
1395 cosa_putdata8(cosa
, 0);
1397 put_driver_status_nolock(cosa
);
1398 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1402 * Check if the whole buffer is DMA-able. It means it is below the 16M of
1403 * physical memory and doesn't span the 64k boundary. For now it seems
1404 * SKB's never do this, but we'll check this anyway.
1406 static int cosa_dma_able(struct channel_data
*chan
, char *buf
, int len
)
1409 unsigned long b
= (unsigned long)buf
;
1410 if (b
+len
>= MAX_DMA_ADDRESS
)
1412 if ((b
^ (b
+len
)) & 0x10000) {
1414 printk(KERN_INFO
"%s: packet spanning a 64k boundary\n",
1422 /* ---------- The SRP/COSA ROM monitor functions ---------- */
1425 * Downloading SRP microcode: say "w" to SRP monitor, it answers by "w=",
1426 * drivers need to say 4-digit hex number meaning start address of the microcode
1427 * separated by a single space. Monitor replies by saying " =". Now driver
1428 * has to write 4-digit hex number meaning the last byte address ended
1429 * by a single space. Monitor has to reply with a space. Now the download
1430 * begins. After the download monitor replies with "\r\n." (CR LF dot).
1432 static int download(struct cosa_data
*cosa
, const char __user
*microcode
, int length
, int address
)
1436 if (put_wait_data(cosa
, 'w') == -1) return -1;
1437 if ((i
=get_wait_data(cosa
)) != 'w') { printk("dnld: 0x%04x\n",i
); return -2;}
1438 if (get_wait_data(cosa
) != '=') return -3;
1440 if (puthexnumber(cosa
, address
) < 0) return -4;
1441 if (put_wait_data(cosa
, ' ') == -1) return -10;
1442 if (get_wait_data(cosa
) != ' ') return -11;
1443 if (get_wait_data(cosa
) != '=') return -12;
1445 if (puthexnumber(cosa
, address
+length
-1) < 0) return -13;
1446 if (put_wait_data(cosa
, ' ') == -1) return -18;
1447 if (get_wait_data(cosa
) != ' ') return -19;
1451 #ifndef SRP_DOWNLOAD_AT_BOOT
1452 if (get_user(c
, microcode
))
1453 return -23; /* ??? */
1457 if (put_wait_data(cosa
, c
) == -1)
1462 if (get_wait_data(cosa
) != '\r') return -21;
1463 if (get_wait_data(cosa
) != '\n') return -22;
1464 if (get_wait_data(cosa
) != '.') return -23;
1466 printk(KERN_DEBUG
"cosa%d: download completed.\n", cosa
->num
);
1473 * Starting microcode is done via the "g" command of the SRP monitor.
1474 * The chat should be the following: "g" "g=" "<addr><CR>"
1475 * "<CR><CR><LF><CR><LF>".
1477 static int startmicrocode(struct cosa_data
*cosa
, int address
)
1479 if (put_wait_data(cosa
, 'g') == -1) return -1;
1480 if (get_wait_data(cosa
) != 'g') return -2;
1481 if (get_wait_data(cosa
) != '=') return -3;
1483 if (puthexnumber(cosa
, address
) < 0) return -4;
1484 if (put_wait_data(cosa
, '\r') == -1) return -5;
1486 if (get_wait_data(cosa
) != '\r') return -6;
1487 if (get_wait_data(cosa
) != '\r') return -7;
1488 if (get_wait_data(cosa
) != '\n') return -8;
1489 if (get_wait_data(cosa
) != '\r') return -9;
1490 if (get_wait_data(cosa
) != '\n') return -10;
1492 printk(KERN_DEBUG
"cosa%d: microcode started\n", cosa
->num
);
1498 * Reading memory is done via the "r" command of the SRP monitor.
1499 * The chat is the following "r" "r=" "<addr> " " =" "<last_byte> " " "
1500 * Then driver can read the data and the conversation is finished
1501 * by SRP monitor sending "<CR><LF>." (dot at the end).
1503 * This routine is not needed during the normal operation and serves
1504 * for debugging purposes only.
1506 static int readmem(struct cosa_data
*cosa
, char __user
*microcode
, int length
, int address
)
1508 if (put_wait_data(cosa
, 'r') == -1) return -1;
1509 if ((get_wait_data(cosa
)) != 'r') return -2;
1510 if ((get_wait_data(cosa
)) != '=') return -3;
1512 if (puthexnumber(cosa
, address
) < 0) return -4;
1513 if (put_wait_data(cosa
, ' ') == -1) return -5;
1514 if (get_wait_data(cosa
) != ' ') return -6;
1515 if (get_wait_data(cosa
) != '=') return -7;
1517 if (puthexnumber(cosa
, address
+length
-1) < 0) return -8;
1518 if (put_wait_data(cosa
, ' ') == -1) return -9;
1519 if (get_wait_data(cosa
) != ' ') return -10;
1524 if ((i
=get_wait_data(cosa
)) == -1) {
1525 printk (KERN_INFO
"cosa: 0x%04x bytes remaining\n",
1531 if (put_user(c
, microcode
))
1532 return -23; /* ??? */
1539 if (get_wait_data(cosa
) != '\r') return -21;
1540 if (get_wait_data(cosa
) != '\n') return -22;
1541 if (get_wait_data(cosa
) != '.') return -23;
1543 printk(KERN_DEBUG
"cosa%d: readmem completed.\n", cosa
->num
);
1549 * This function resets the device and reads the initial prompt
1550 * of the device's ROM monitor.
1552 static int cosa_reset_and_read_id(struct cosa_data
*cosa
, char *idstring
)
1554 int i
=0, id
=0, prev
=0, curr
=0;
1556 /* Reset the card ... */
1557 cosa_putstatus(cosa
, 0);
1558 cosa_getdata8(cosa
);
1559 cosa_putstatus(cosa
, SR_RST
);
1565 /* Disable all IRQs from the card */
1566 cosa_putstatus(cosa
, 0);
1569 * Try to read the ID string. The card then prints out the
1570 * identification string ended by the "\n\x2e".
1572 * The following loop is indexed through i (instead of id)
1573 * to avoid looping forever when for any reason
1574 * the port returns '\r', '\n' or '\x2e' permanently.
1576 for (i
=0; i
<COSA_MAX_ID_STRING
-1; i
++, prev
=curr
) {
1577 if ((curr
= get_wait_data(cosa
)) == -1) {
1581 if (curr
!= '\r' && curr
!= '\n' && curr
!= 0x2e)
1582 idstring
[id
++] = curr
;
1583 if (curr
== 0x2e && prev
== '\n')
1586 /* Perhaps we should fail when i==COSA_MAX_ID_STRING-1 ? */
1587 idstring
[id
] = '\0';
1592 /* ---------- Auxiliary routines for COSA/SRP monitor ---------- */
1595 * This routine gets the data byte from the card waiting for the SR_RX_RDY
1596 * bit to be set in a loop. It should be used in the exceptional cases
1597 * only (for example when resetting the card or downloading the firmware.
1599 static int get_wait_data(struct cosa_data
*cosa
)
1604 /* read data and return them */
1605 if (cosa_getstatus(cosa
) & SR_RX_RDY
) {
1607 r
= cosa_getdata8(cosa
);
1609 printk(KERN_INFO
"cosa: get_wait_data returning after %d retries\n", 999-retries
);
1613 /* sleep if not ready to read */
1614 schedule_timeout_interruptible(1);
1616 printk(KERN_INFO
"cosa: timeout in get_wait_data (status 0x%x)\n",
1617 cosa_getstatus(cosa
));
1622 * This routine puts the data byte to the card waiting for the SR_TX_RDY
1623 * bit to be set in a loop. It should be used in the exceptional cases
1624 * only (for example when resetting the card or downloading the firmware).
1626 static int put_wait_data(struct cosa_data
*cosa
, int data
)
1630 /* read data and return them */
1631 if (cosa_getstatus(cosa
) & SR_TX_RDY
) {
1632 cosa_putdata8(cosa
, data
);
1634 printk(KERN_INFO
"Putdata: %d retries\n", 999-retries
);
1639 /* sleep if not ready to read */
1640 schedule_timeout_interruptible(1);
1643 printk(KERN_INFO
"cosa%d: timeout in put_wait_data (status 0x%x)\n",
1644 cosa
->num
, cosa_getstatus(cosa
));
1649 * The following routine puts the hexadecimal number into the SRP monitor
1650 * and verifies the proper echo of the sent bytes. Returns 0 on success,
1651 * negative number on failure (-1,-3,-5,-7) means that put_wait_data() failed,
1652 * (-2,-4,-6,-8) means that reading echo failed.
1654 static int puthexnumber(struct cosa_data
*cosa
, int number
)
1659 /* Well, I should probably replace this by something faster. */
1660 sprintf(temp
, "%04X", number
);
1661 for (i
=0; i
<4; i
++) {
1662 if (put_wait_data(cosa
, temp
[i
]) == -1) {
1663 printk(KERN_NOTICE
"cosa%d: puthexnumber failed to write byte %d\n",
1667 if (get_wait_data(cosa
) != temp
[i
]) {
1668 printk(KERN_NOTICE
"cosa%d: puthexhumber failed to read echo of byte %d\n",
1677 /* ---------- Interrupt routines ---------- */
1680 * There are three types of interrupt:
1681 * At the beginning of transmit - this handled is in tx_interrupt(),
1682 * at the beginning of receive - it is in rx_interrupt() and
1683 * at the end of transmit/receive - it is the eot_interrupt() function.
1684 * These functions are multiplexed by cosa_interrupt() according to the
1685 * COSA status byte. I have moved the rx/tx/eot interrupt handling into
1686 * separate functions to make it more readable. These functions are inline,
1687 * so there should be no overhead of function call.
1689 * In the COSA bus-master mode, we need to tell the card the address of a
1690 * buffer. Unfortunately, COSA may be too slow for us, so we must busy-wait.
1691 * It's time to use the bottom half :-(
1695 * Transmit interrupt routine - called when COSA is willing to obtain
1696 * data from the OS. The most tricky part of the routine is selection
1697 * of channel we (OS) want to send packet for. For SRP we should probably
1698 * use the round-robin approach. The newer COSA firmwares have a simple
1699 * flow-control - in the status word has bits 2 and 3 set to 1 means that the
1700 * channel 0 or 1 doesn't want to receive data.
1702 * It seems there is a bug in COSA firmware (need to trace it further):
1703 * When the driver status says that the kernel has no more data for transmit
1704 * (e.g. at the end of TX DMA) and then the kernel changes its mind
1705 * (e.g. new packet is queued to hard_start_xmit()), the card issues
1706 * the TX interrupt but does not mark the channel as ready-to-transmit.
1707 * The fix seems to be to push the packet to COSA despite its request.
1708 * We first try to obey the card's opinion, and then fall back to forced TX.
1710 static inline void tx_interrupt(struct cosa_data
*cosa
, int status
)
1712 unsigned long flags
, flags1
;
1714 printk(KERN_INFO
"cosa%d: SR_DOWN_REQUEST status=0x%04x\n",
1717 spin_lock_irqsave(&cosa
->lock
, flags
);
1718 set_bit(TXBIT
, &cosa
->rxtx
);
1719 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1720 /* flow control, see the comment above */
1722 if (!cosa
->txbitmap
) {
1723 printk(KERN_WARNING
"%s: No channel wants data "
1724 "in TX IRQ. Expect DMA timeout.",
1726 put_driver_status_nolock(cosa
);
1727 clear_bit(TXBIT
, &cosa
->rxtx
);
1728 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1734 if (cosa
->txchan
>= cosa
->nchannels
)
1736 if (!(cosa
->txbitmap
& (1<<cosa
->txchan
)))
1738 if (~status
& (1 << (cosa
->txchan
+DRIVER_TXMAP_SHIFT
)))
1740 /* in second pass, accept first ready-to-TX channel */
1741 if (i
> cosa
->nchannels
) {
1742 /* Can be safely ignored */
1744 printk(KERN_DEBUG
"%s: Forcing TX "
1745 "to not-ready channel %d\n",
1746 cosa
->name
, cosa
->txchan
);
1752 cosa
->txsize
= cosa
->chan
[cosa
->txchan
].txsize
;
1753 if (cosa_dma_able(cosa
->chan
+cosa
->txchan
,
1754 cosa
->chan
[cosa
->txchan
].txbuf
, cosa
->txsize
)) {
1755 cosa
->txbuf
= cosa
->chan
[cosa
->txchan
].txbuf
;
1757 memcpy(cosa
->bouncebuf
, cosa
->chan
[cosa
->txchan
].txbuf
,
1759 cosa
->txbuf
= cosa
->bouncebuf
;
1763 if (is_8bit(cosa
)) {
1764 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1765 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
1766 cosa_putdata8(cosa
, ((cosa
->txchan
<< 5) & 0xe0)|
1767 ((cosa
->txsize
>> 8) & 0x1f));
1769 debug_status_out(cosa
, SR_TX_INT_ENA
);
1770 debug_data_out(cosa
, ((cosa
->txchan
<< 5) & 0xe0)|
1771 ((cosa
->txsize
>> 8) & 0x1f));
1772 debug_data_in(cosa
, cosa_getdata8(cosa
));
1774 cosa_getdata8(cosa
);
1776 set_bit(IRQBIT
, &cosa
->rxtx
);
1777 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1780 clear_bit(IRQBIT
, &cosa
->rxtx
);
1781 cosa_putstatus(cosa
, 0);
1782 cosa_putdata8(cosa
, cosa
->txsize
&0xff);
1784 debug_status_out(cosa
, 0);
1785 debug_data_out(cosa
, cosa
->txsize
&0xff);
1789 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
1790 cosa_putdata16(cosa
, ((cosa
->txchan
<<13) & 0xe000)
1791 | (cosa
->txsize
& 0x1fff));
1793 debug_status_out(cosa
, SR_TX_INT_ENA
);
1794 debug_data_out(cosa
, ((cosa
->txchan
<<13) & 0xe000)
1795 | (cosa
->txsize
& 0x1fff));
1796 debug_data_in(cosa
, cosa_getdata8(cosa
));
1797 debug_status_out(cosa
, 0);
1799 cosa_getdata8(cosa
);
1801 cosa_putstatus(cosa
, 0);
1804 if (cosa
->busmaster
) {
1805 unsigned long addr
= virt_to_bus(cosa
->txbuf
);
1807 printk(KERN_INFO
"busmaster IRQ\n");
1808 while (!(cosa_getstatus(cosa
)&SR_TX_RDY
)) {
1811 if (count
> 1000) break;
1813 printk(KERN_INFO
"status %x\n", cosa_getstatus(cosa
));
1814 printk(KERN_INFO
"ready after %d loops\n", count
);
1815 cosa_putdata16(cosa
, (addr
>> 16)&0xffff);
1818 while (!(cosa_getstatus(cosa
)&SR_TX_RDY
)) {
1820 if (count
> 1000) break;
1823 printk(KERN_INFO
"ready after %d loops\n", count
);
1824 cosa_putdata16(cosa
, addr
&0xffff);
1825 flags1
= claim_dma_lock();
1826 set_dma_mode(cosa
->dma
, DMA_MODE_CASCADE
);
1827 enable_dma(cosa
->dma
);
1828 release_dma_lock(flags1
);
1831 flags1
= claim_dma_lock();
1832 disable_dma(cosa
->dma
);
1833 clear_dma_ff(cosa
->dma
);
1834 set_dma_mode(cosa
->dma
, DMA_MODE_WRITE
);
1835 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->txbuf
));
1836 set_dma_count(cosa
->dma
, cosa
->txsize
);
1837 enable_dma(cosa
->dma
);
1838 release_dma_lock(flags1
);
1840 cosa_putstatus(cosa
, SR_TX_DMA_ENA
|SR_USR_INT_ENA
);
1842 debug_status_out(cosa
, SR_TX_DMA_ENA
|SR_USR_INT_ENA
);
1844 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1847 static inline void rx_interrupt(struct cosa_data
*cosa
, int status
)
1849 unsigned long flags
;
1851 printk(KERN_INFO
"cosa%d: SR_UP_REQUEST\n", cosa
->num
);
1854 spin_lock_irqsave(&cosa
->lock
, flags
);
1855 set_bit(RXBIT
, &cosa
->rxtx
);
1857 if (is_8bit(cosa
)) {
1858 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1859 set_bit(IRQBIT
, &cosa
->rxtx
);
1860 put_driver_status_nolock(cosa
);
1861 cosa
->rxsize
= cosa_getdata8(cosa
) <<8;
1863 debug_data_in(cosa
, cosa
->rxsize
>> 8);
1865 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1868 clear_bit(IRQBIT
, &cosa
->rxtx
);
1869 cosa
->rxsize
|= cosa_getdata8(cosa
) & 0xff;
1871 debug_data_in(cosa
, cosa
->rxsize
& 0xff);
1874 printk(KERN_INFO
"cosa%d: receive rxsize = (0x%04x).\n",
1875 cosa
->num
, cosa
->rxsize
);
1879 cosa
->rxsize
= cosa_getdata16(cosa
);
1881 debug_data_in(cosa
, cosa
->rxsize
);
1884 printk(KERN_INFO
"cosa%d: receive rxsize = (0x%04x).\n",
1885 cosa
->num
, cosa
->rxsize
);
1888 if (((cosa
->rxsize
& 0xe000) >> 13) >= cosa
->nchannels
) {
1889 printk(KERN_WARNING
"%s: rx for unknown channel (0x%04x)\n",
1890 cosa
->name
, cosa
->rxsize
);
1891 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1894 cosa
->rxchan
= cosa
->chan
+ ((cosa
->rxsize
& 0xe000) >> 13);
1895 cosa
->rxsize
&= 0x1fff;
1896 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1899 if (cosa
->rxchan
->setup_rx
)
1900 cosa
->rxbuf
= cosa
->rxchan
->setup_rx(cosa
->rxchan
, cosa
->rxsize
);
1903 reject
: /* Reject the packet */
1904 printk(KERN_INFO
"cosa%d: rejecting packet on channel %d\n",
1905 cosa
->num
, cosa
->rxchan
->num
);
1906 cosa
->rxbuf
= cosa
->bouncebuf
;
1910 flags
= claim_dma_lock();
1911 disable_dma(cosa
->dma
);
1912 clear_dma_ff(cosa
->dma
);
1913 set_dma_mode(cosa
->dma
, DMA_MODE_READ
);
1914 if (cosa_dma_able(cosa
->rxchan
, cosa
->rxbuf
, cosa
->rxsize
& 0x1fff)) {
1915 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->rxbuf
));
1917 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->bouncebuf
));
1919 set_dma_count(cosa
->dma
, (cosa
->rxsize
&0x1fff));
1920 enable_dma(cosa
->dma
);
1921 release_dma_lock(flags
);
1922 spin_lock_irqsave(&cosa
->lock
, flags
);
1923 cosa_putstatus(cosa
, SR_RX_DMA_ENA
|SR_USR_INT_ENA
);
1924 if (!is_8bit(cosa
) && (status
& SR_TX_RDY
))
1925 cosa_putdata8(cosa
, DRIVER_RX_READY
);
1927 debug_status_out(cosa
, SR_RX_DMA_ENA
|SR_USR_INT_ENA
);
1928 if (!is_8bit(cosa
) && (status
& SR_TX_RDY
))
1929 debug_data_cmd(cosa
, DRIVER_RX_READY
);
1931 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1934 static inline void eot_interrupt(struct cosa_data
*cosa
, int status
)
1936 unsigned long flags
, flags1
;
1937 spin_lock_irqsave(&cosa
->lock
, flags
);
1938 flags1
= claim_dma_lock();
1939 disable_dma(cosa
->dma
);
1940 clear_dma_ff(cosa
->dma
);
1941 release_dma_lock(flags1
);
1942 if (test_bit(TXBIT
, &cosa
->rxtx
)) {
1943 struct channel_data
*chan
= cosa
->chan
+cosa
->txchan
;
1945 if (chan
->tx_done(chan
, cosa
->txsize
))
1946 clear_bit(chan
->num
, &cosa
->txbitmap
);
1947 } else if (test_bit(RXBIT
, &cosa
->rxtx
)) {
1951 printk(KERN_INFO
"cosa%dc%d: done rx(0x%x)", cosa
->num
,
1952 cosa
->rxchan
->num
, cosa
->rxsize
);
1953 for (i
=0; i
<cosa
->rxsize
; i
++)
1954 printk (" %02x", cosa
->rxbuf
[i
]&0xff);
1958 /* Packet for unknown channel? */
1959 if (cosa
->rxbuf
== cosa
->bouncebuf
)
1961 if (!cosa_dma_able(cosa
->rxchan
, cosa
->rxbuf
, cosa
->rxsize
))
1962 memcpy(cosa
->rxbuf
, cosa
->bouncebuf
, cosa
->rxsize
);
1963 if (cosa
->rxchan
->rx_done
)
1964 if (cosa
->rxchan
->rx_done(cosa
->rxchan
))
1965 clear_bit(cosa
->rxchan
->num
, &cosa
->rxbitmap
);
1967 printk(KERN_NOTICE
"cosa%d: unexpected EOT interrupt\n",
1971 * Clear the RXBIT, TXBIT and IRQBIT (the latest should be
1972 * cleared anyway). We should do it as soon as possible
1973 * so that we can tell the COSA we are done and to give it a time
1978 put_driver_status_nolock(cosa
);
1979 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1982 static irqreturn_t
cosa_interrupt(int irq
, void *cosa_
)
1986 struct cosa_data
*cosa
= cosa_
;
1988 status
= cosa_getstatus(cosa
);
1990 printk(KERN_INFO
"cosa%d: got IRQ, status 0x%02x\n", cosa
->num
,
1994 debug_status_in(cosa
, status
);
1996 switch (status
& SR_CMD_FROM_SRP_MASK
) {
1997 case SR_DOWN_REQUEST
:
1998 tx_interrupt(cosa
, status
);
2001 rx_interrupt(cosa
, status
);
2003 case SR_END_OF_TRANSFER
:
2004 eot_interrupt(cosa
, status
);
2007 /* We may be too fast for SRP. Try to wait a bit more. */
2008 if (count
++ < 100) {
2012 printk(KERN_INFO
"cosa%d: unknown status 0x%02x in IRQ after %d retries\n",
2013 cosa
->num
, status
& 0xff, count
);
2017 printk(KERN_INFO
"%s: %d-times got unknown status in IRQ\n",
2020 printk(KERN_INFO
"%s: returning from IRQ\n", cosa
->name
);
2026 /* ---------- I/O debugging routines ---------- */
2028 * These routines can be used to monitor COSA/SRP I/O and to printk()
2029 * the data being transferred on the data and status I/O port in a
2034 static void debug_status_in(struct cosa_data
*cosa
, int status
)
2037 switch(status
& SR_CMD_FROM_SRP_MASK
) {
2041 case SR_DOWN_REQUEST
:
2044 case SR_END_OF_TRANSFER
:
2051 printk(KERN_INFO
"%s: IO: status -> 0x%02x (%s%s%s%s)\n",
2054 status
& SR_USR_RQ
? "USR_RQ|":"",
2055 status
& SR_TX_RDY
? "TX_RDY|":"",
2056 status
& SR_RX_RDY
? "RX_RDY|":"",
2060 static void debug_status_out(struct cosa_data
*cosa
, int status
)
2062 printk(KERN_INFO
"%s: IO: status <- 0x%02x (%s%s%s%s%s%s)\n",
2065 status
& SR_RX_DMA_ENA
? "RXDMA|":"!rxdma|",
2066 status
& SR_TX_DMA_ENA
? "TXDMA|":"!txdma|",
2067 status
& SR_RST
? "RESET|":"",
2068 status
& SR_USR_INT_ENA
? "USRINT|":"!usrint|",
2069 status
& SR_TX_INT_ENA
? "TXINT|":"!txint|",
2070 status
& SR_RX_INT_ENA
? "RXINT":"!rxint");
2073 static void debug_data_in(struct cosa_data
*cosa
, int data
)
2075 printk(KERN_INFO
"%s: IO: data -> 0x%04x\n", cosa
->name
, data
);
2078 static void debug_data_out(struct cosa_data
*cosa
, int data
)
2080 printk(KERN_INFO
"%s: IO: data <- 0x%04x\n", cosa
->name
, data
);
2083 static void debug_data_cmd(struct cosa_data
*cosa
, int data
)
2085 printk(KERN_INFO
"%s: IO: data <- 0x%04x (%s|%s)\n",
2087 data
& SR_RDY_RCV
? "RX_RDY" : "!rx_rdy",
2088 data
& SR_RDY_SND
? "TX_RDY" : "!tx_rdy");
2092 /* EOF -- this file has not been truncated */