1 /* $Id: cosa.c,v 1.31 2000/03/08 17:47:16 kas Exp $ */
4 * Copyright (C) 1995-1997 Jan "Yenya" Kasprzak <kas@fi.muni.cz>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 * The driver for the SRP and COSA synchronous serial cards.
26 * Both cards are developed at the Institute of Computer Science,
27 * Masaryk University (http://www.ics.muni.cz/). The hardware is
28 * developed by Jiri Novotny <novotny@ics.muni.cz>. More information
29 * and the photo of both cards is available at
30 * http://www.pavoucek.cz/cosa.html. The card documentation, firmwares
31 * and other goods can be downloaded from ftp://ftp.ics.muni.cz/pub/cosa/.
32 * For Linux-specific utilities, see below in the "Software info" section.
33 * If you want to order the card, contact Jiri Novotny.
35 * The SRP (serial port?, the Czech word "srp" means "sickle") card
36 * is a 2-port intelligent (with its own 8-bit CPU) synchronous serial card
37 * with V.24 interfaces up to 80kb/s each.
39 * The COSA (communication serial adapter?, the Czech word "kosa" means
40 * "scythe") is a next-generation sync/async board with two interfaces
41 * - currently any of V.24, X.21, V.35 and V.36 can be selected.
42 * It has a 16-bit SAB80166 CPU and can do up to 10 Mb/s per channel.
43 * The 8-channels version is in development.
45 * Both types have downloadable firmware and communicate via ISA DMA.
46 * COSA can be also a bus-mastering device.
50 * The homepage of the Linux driver is at http://www.fi.muni.cz/~kas/cosa/.
51 * The CVS tree of Linux driver can be viewed there, as well as the
52 * firmware binaries and user-space utilities for downloading the firmware
53 * into the card and setting up the card.
55 * The Linux driver (unlike the present *BSD drivers :-) can work even
56 * for the COSA and SRP in one computer and allows each channel to work
57 * in one of the three modes (character device, Cisco HDLC, Sync PPP).
61 * The Linux driver was written by Jan "Yenya" Kasprzak <kas@fi.muni.cz>.
63 * You can mail me bugfixes and even success reports. I am especially
64 * interested in the SMP and/or muliti-channel success/failure reports
65 * (I wonder if I did the locking properly :-).
67 * THE AUTHOR USED THE FOLLOWING SOURCES WHEN PROGRAMMING THE DRIVER
69 * The COSA/SRP NetBSD driver by Zdenek Salvet and Ivos Cernohlavek
70 * The skeleton.c by Donald Becker
71 * The SDL Riscom/N2 driver by Mike Natale
72 * The Comtrol Hostess SV11 driver by Alan Cox
73 * The Sync PPP/Cisco HDLC layer (syncppp.c) ported to Linux by Alan Cox
76 * 5/25/1999 : Marcelo Tosatti <marcelo@conectiva.com.br>
77 * fixed a deadlock in cosa_sppp_open
80 /* ---------- Headers, macros, data structures ---------- */
82 #include <linux/module.h>
83 #include <linux/kernel.h>
84 #include <linux/slab.h>
85 #include <linux/poll.h>
87 #include <linux/interrupt.h>
88 #include <linux/delay.h>
89 #include <linux/errno.h>
90 #include <linux/ioport.h>
91 #include <linux/netdevice.h>
92 #include <linux/spinlock.h>
93 #include <linux/device.h>
95 #undef COSA_SLOW_IO /* for testing purposes only */
99 #include <asm/byteorder.h>
101 #include <net/syncppp.h>
104 /* Maximum length of the identification string. */
105 #define COSA_MAX_ID_STRING 128
107 /* Maximum length of the channel name */
108 #define COSA_MAX_NAME (sizeof("cosaXXXcXXX")+1)
110 /* Per-channel data structure */
112 struct channel_data
{
113 void *if_ptr
; /* General purpose pointer (used by SPPP) */
114 int usage
; /* Usage count; >0 for chrdev, -1 for netdev */
115 int num
; /* Number of the channel */
116 struct cosa_data
*cosa
; /* Pointer to the per-card structure */
117 int txsize
; /* Size of transmitted data */
118 char *txbuf
; /* Transmit buffer */
119 char name
[COSA_MAX_NAME
]; /* channel name */
121 /* The HW layer interface */
122 /* routine called from the RX interrupt */
123 char *(*setup_rx
)(struct channel_data
*channel
, int size
);
124 /* routine called when the RX is done (from the EOT interrupt) */
125 int (*rx_done
)(struct channel_data
*channel
);
126 /* routine called when the TX is done (from the EOT interrupt) */
127 int (*tx_done
)(struct channel_data
*channel
, int size
);
129 /* Character device parts */
130 struct semaphore rsem
, wsem
;
133 wait_queue_head_t txwaitq
, rxwaitq
;
134 int tx_status
, rx_status
;
136 /* SPPP/HDLC device parts */
137 struct ppp_device pppdev
;
138 struct sk_buff
*rx_skb
, *tx_skb
;
139 struct net_device_stats stats
;
142 /* cosa->firmware_status bits */
143 #define COSA_FW_RESET (1<<0) /* Is the ROM monitor active? */
144 #define COSA_FW_DOWNLOAD (1<<1) /* Is the microcode downloaded? */
145 #define COSA_FW_START (1<<2) /* Is the microcode running? */
148 int num
; /* Card number */
149 char name
[COSA_MAX_NAME
]; /* Card name - e.g "cosa0" */
150 unsigned int datareg
, statusreg
; /* I/O ports */
151 unsigned short irq
, dma
; /* IRQ and DMA number */
152 unsigned short startaddr
; /* Firmware start address */
153 unsigned short busmaster
; /* Use busmastering? */
154 int nchannels
; /* # of channels on this card */
155 int driver_status
; /* For communicating with firmware */
156 int firmware_status
; /* Downloaded, reseted, etc. */
157 unsigned long rxbitmap
, txbitmap
;/* Bitmap of channels who are willing to send/receive data */
158 unsigned long rxtx
; /* RX or TX in progress? */
160 int usage
; /* usage count */
161 int txchan
, txsize
, rxsize
;
162 struct channel_data
*rxchan
;
165 struct channel_data
*chan
;
166 spinlock_t lock
; /* For exclusive operations on this structure */
167 char id_string
[COSA_MAX_ID_STRING
]; /* ROM monitor ID string */
168 char *type
; /* card type */
172 * Define this if you want all the possible ports to be autoprobed.
173 * It is here but it probably is not a good idea to use this.
175 /* #define COSA_ISA_AUTOPROBE 1 */
178 * Character device major number. 117 was allocated for us.
179 * The value of 0 means to allocate a first free one.
181 static int cosa_major
= 117;
184 * Encoding of the minor numbers:
185 * The lowest CARD_MINOR_BITS bits means the channel on the single card,
186 * the highest bits means the card number.
188 #define CARD_MINOR_BITS 4 /* How many bits in minor number are reserved
189 * for the single card */
191 * The following depends on CARD_MINOR_BITS. Unfortunately, the "MODULE_STRING"
192 * macro doesn't like anything other than the raw number as an argument :-(
195 /* #define MAX_CARDS (1 << (8-CARD_MINOR_BITS)) */
197 #define DRIVER_RX_READY 0x0001
198 #define DRIVER_TX_READY 0x0002
199 #define DRIVER_TXMAP_SHIFT 2
200 #define DRIVER_TXMAP_MASK 0x0c /* FIXME: 0xfc for 8-channel version */
203 * for cosa->rxtx - indicates whether either transmit or receive is
204 * in progress. These values are mean number of the bit.
210 #define COSA_MTU 2000 /* FIXME: I don't know this exactly */
212 #undef DEBUG_DATA //1 /* Dump the data read or written to the channel */
213 #undef DEBUG_IRQS //1 /* Print the message when the IRQ is received */
214 #undef DEBUG_IO //1 /* Dump the I/O traffic */
216 #define TX_TIMEOUT (5*HZ)
218 /* Maybe the following should be allocated dynamically */
219 static struct cosa_data cosa_cards
[MAX_CARDS
];
222 #ifdef COSA_ISA_AUTOPROBE
223 static int io
[MAX_CARDS
+1] = { 0x220, 0x228, 0x210, 0x218, 0, };
224 /* NOTE: DMA is not autoprobed!!! */
225 static int dma
[MAX_CARDS
+1] = { 1, 7, 1, 7, 1, 7, 1, 7, 0, };
227 static int io
[MAX_CARDS
+1];
228 static int dma
[MAX_CARDS
+1];
230 /* IRQ can be safely autoprobed */
231 static int irq
[MAX_CARDS
+1] = { -1, -1, -1, -1, -1, -1, 0, };
234 static struct class *cosa_class
;
237 module_param_array(io
, int, NULL
, 0);
238 MODULE_PARM_DESC(io
, "The I/O bases of the COSA or SRP cards");
239 module_param_array(irq
, int, NULL
, 0);
240 MODULE_PARM_DESC(irq
, "The IRQ lines of the COSA or SRP cards");
241 module_param_array(dma
, int, NULL
, 0);
242 MODULE_PARM_DESC(dma
, "The DMA channels of the COSA or SRP cards");
244 MODULE_AUTHOR("Jan \"Yenya\" Kasprzak, <kas@fi.muni.cz>");
245 MODULE_DESCRIPTION("Modular driver for the COSA or SRP synchronous card");
246 MODULE_LICENSE("GPL");
249 /* I use this mainly for testing purposes */
251 #define cosa_outb outb_p
252 #define cosa_outw outw_p
253 #define cosa_inb inb_p
254 #define cosa_inw inw_p
256 #define cosa_outb outb
257 #define cosa_outw outw
262 #define is_8bit(cosa) (!(cosa->datareg & 0x08))
264 #define cosa_getstatus(cosa) (cosa_inb(cosa->statusreg))
265 #define cosa_putstatus(cosa, stat) (cosa_outb(stat, cosa->statusreg))
266 #define cosa_getdata16(cosa) (cosa_inw(cosa->datareg))
267 #define cosa_getdata8(cosa) (cosa_inb(cosa->datareg))
268 #define cosa_putdata16(cosa, dt) (cosa_outw(dt, cosa->datareg))
269 #define cosa_putdata8(cosa, dt) (cosa_outb(dt, cosa->datareg))
271 /* Initialization stuff */
272 static int cosa_probe(int ioaddr
, int irq
, int dma
);
275 static void cosa_enable_rx(struct channel_data
*chan
);
276 static void cosa_disable_rx(struct channel_data
*chan
);
277 static int cosa_start_tx(struct channel_data
*channel
, char *buf
, int size
);
278 static void cosa_kick(struct cosa_data
*cosa
);
279 static int cosa_dma_able(struct channel_data
*chan
, char *buf
, int data
);
281 /* SPPP/HDLC stuff */
282 static void sppp_channel_init(struct channel_data
*chan
);
283 static void sppp_channel_delete(struct channel_data
*chan
);
284 static int cosa_sppp_open(struct net_device
*d
);
285 static int cosa_sppp_close(struct net_device
*d
);
286 static void cosa_sppp_timeout(struct net_device
*d
);
287 static int cosa_sppp_tx(struct sk_buff
*skb
, struct net_device
*d
);
288 static char *sppp_setup_rx(struct channel_data
*channel
, int size
);
289 static int sppp_rx_done(struct channel_data
*channel
);
290 static int sppp_tx_done(struct channel_data
*channel
, int size
);
291 static int cosa_sppp_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
);
292 static struct net_device_stats
*cosa_net_stats(struct net_device
*dev
);
294 /* Character device */
295 static void chardev_channel_init(struct channel_data
*chan
);
296 static char *chrdev_setup_rx(struct channel_data
*channel
, int size
);
297 static int chrdev_rx_done(struct channel_data
*channel
);
298 static int chrdev_tx_done(struct channel_data
*channel
, int size
);
299 static ssize_t
cosa_read(struct file
*file
,
300 char __user
*buf
, size_t count
, loff_t
*ppos
);
301 static ssize_t
cosa_write(struct file
*file
,
302 const char __user
*buf
, size_t count
, loff_t
*ppos
);
303 static unsigned int cosa_poll(struct file
*file
, poll_table
*poll
);
304 static int cosa_open(struct inode
*inode
, struct file
*file
);
305 static int cosa_release(struct inode
*inode
, struct file
*file
);
306 static int cosa_chardev_ioctl(struct inode
*inode
, struct file
*file
,
307 unsigned int cmd
, unsigned long arg
);
308 #ifdef COSA_FASYNC_WORKING
309 static int cosa_fasync(struct inode
*inode
, struct file
*file
, int on
);
312 static const struct file_operations cosa_fops
= {
313 .owner
= THIS_MODULE
,
318 .ioctl
= cosa_chardev_ioctl
,
320 .release
= cosa_release
,
321 #ifdef COSA_FASYNC_WORKING
322 .fasync
= cosa_fasync
,
327 static int cosa_start(struct cosa_data
*cosa
, int address
);
328 static int cosa_reset(struct cosa_data
*cosa
);
329 static int cosa_download(struct cosa_data
*cosa
, void __user
*a
);
330 static int cosa_readmem(struct cosa_data
*cosa
, void __user
*a
);
332 /* COSA/SRP ROM monitor */
333 static int download(struct cosa_data
*cosa
, const char __user
*data
, int addr
, int len
);
334 static int startmicrocode(struct cosa_data
*cosa
, int address
);
335 static int readmem(struct cosa_data
*cosa
, char __user
*data
, int addr
, int len
);
336 static int cosa_reset_and_read_id(struct cosa_data
*cosa
, char *id
);
338 /* Auxilliary functions */
339 static int get_wait_data(struct cosa_data
*cosa
);
340 static int put_wait_data(struct cosa_data
*cosa
, int data
);
341 static int puthexnumber(struct cosa_data
*cosa
, int number
);
342 static void put_driver_status(struct cosa_data
*cosa
);
343 static void put_driver_status_nolock(struct cosa_data
*cosa
);
345 /* Interrupt handling */
346 static irqreturn_t
cosa_interrupt(int irq
, void *cosa
);
348 /* I/O ops debugging */
350 static void debug_data_in(struct cosa_data
*cosa
, int data
);
351 static void debug_data_out(struct cosa_data
*cosa
, int data
);
352 static void debug_data_cmd(struct cosa_data
*cosa
, int data
);
353 static void debug_status_in(struct cosa_data
*cosa
, int status
);
354 static void debug_status_out(struct cosa_data
*cosa
, int status
);
358 /* ---------- Initialization stuff ---------- */
360 static int __init
cosa_init(void)
364 printk(KERN_INFO
"cosa v1.08 (c) 1997-2000 Jan Kasprzak <kas@fi.muni.cz>\n");
366 printk(KERN_INFO
"cosa: SMP found. Please mail any success/failure reports to the author.\n");
368 if (cosa_major
> 0) {
369 if (register_chrdev(cosa_major
, "cosa", &cosa_fops
)) {
370 printk(KERN_WARNING
"cosa: unable to get major %d\n",
376 if (!(cosa_major
=register_chrdev(0, "cosa", &cosa_fops
))) {
377 printk(KERN_WARNING
"cosa: unable to register chardev\n");
382 for (i
=0; i
<MAX_CARDS
; i
++)
383 cosa_cards
[i
].num
= -1;
384 for (i
=0; io
[i
] != 0 && i
< MAX_CARDS
; i
++)
385 cosa_probe(io
[i
], irq
[i
], dma
[i
]);
387 printk(KERN_WARNING
"cosa: no devices found.\n");
388 unregister_chrdev(cosa_major
, "cosa");
392 cosa_class
= class_create(THIS_MODULE
, "cosa");
393 if (IS_ERR(cosa_class
)) {
394 err
= PTR_ERR(cosa_class
);
397 for (i
=0; i
<nr_cards
; i
++) {
398 device_create(cosa_class
, NULL
, MKDEV(cosa_major
, i
), "cosa%d", i
);
404 unregister_chrdev(cosa_major
, "cosa");
408 module_init(cosa_init
);
410 static void __exit
cosa_exit(void)
412 struct cosa_data
*cosa
;
414 printk(KERN_INFO
"Unloading the cosa module\n");
416 for (i
=0; i
<nr_cards
; i
++)
417 device_destroy(cosa_class
, MKDEV(cosa_major
, i
));
418 class_destroy(cosa_class
);
419 for (cosa
=cosa_cards
; nr_cards
--; cosa
++) {
420 /* Clean up the per-channel data */
421 for (i
=0; i
<cosa
->nchannels
; i
++) {
422 /* Chardev driver has no alloc'd per-channel data */
423 sppp_channel_delete(cosa
->chan
+i
);
425 /* Clean up the per-card data */
427 kfree(cosa
->bouncebuf
);
428 free_irq(cosa
->irq
, cosa
);
430 release_region(cosa
->datareg
,is_8bit(cosa
)?2:4);
432 unregister_chrdev(cosa_major
, "cosa");
434 module_exit(cosa_exit
);
437 * This function should register all the net devices needed for the
440 static __inline__
void channel_init(struct channel_data
*chan
)
442 sprintf(chan
->name
, "cosa%dc%d", chan
->cosa
->num
, chan
->num
);
444 /* Initialize the chardev data structures */
445 chardev_channel_init(chan
);
447 /* Register the sppp interface */
448 sppp_channel_init(chan
);
451 static int cosa_probe(int base
, int irq
, int dma
)
453 struct cosa_data
*cosa
= cosa_cards
+nr_cards
;
456 memset(cosa
, 0, sizeof(struct cosa_data
));
458 /* Checking validity of parameters: */
459 /* IRQ should be 2-7 or 10-15; negative IRQ means autoprobe */
460 if ((irq
>= 0 && irq
< 2) || irq
> 15 || (irq
< 10 && irq
> 7)) {
461 printk (KERN_INFO
"cosa_probe: invalid IRQ %d\n", irq
);
464 /* I/O address should be between 0x100 and 0x3ff and should be
466 if (base
< 0x100 || base
> 0x3ff || base
& 0x7) {
467 printk (KERN_INFO
"cosa_probe: invalid I/O address 0x%x\n",
471 /* DMA should be 0,1 or 3-7 */
472 if (dma
< 0 || dma
== 4 || dma
> 7) {
473 printk (KERN_INFO
"cosa_probe: invalid DMA %d\n", dma
);
476 /* and finally, on 16-bit COSA DMA should be 4-7 and
477 * I/O base should not be multiple of 0x10 */
478 if (((base
& 0x8) && dma
< 4) || (!(base
& 0x8) && dma
> 3)) {
479 printk (KERN_INFO
"cosa_probe: 8/16 bit base and DMA mismatch"
480 " (base=0x%x, dma=%d)\n", base
, dma
);
485 cosa
->datareg
= base
;
486 cosa
->statusreg
= is_8bit(cosa
)?base
+1:base
+2;
487 spin_lock_init(&cosa
->lock
);
489 if (!request_region(base
, is_8bit(cosa
)?2:4,"cosa"))
492 if (cosa_reset_and_read_id(cosa
, cosa
->id_string
) < 0) {
493 printk(KERN_DEBUG
"cosa: probe at 0x%x failed.\n", base
);
498 /* Test the validity of identification string */
499 if (!strncmp(cosa
->id_string
, "SRP", 3))
501 else if (!strncmp(cosa
->id_string
, "COSA", 4))
502 cosa
->type
= is_8bit(cosa
)? "cosa8": "cosa16";
504 /* Print a warning only if we are not autoprobing */
505 #ifndef COSA_ISA_AUTOPROBE
506 printk(KERN_INFO
"cosa: valid signature not found at 0x%x.\n",
512 /* Update the name of the region now we know the type of card */
513 release_region(base
, is_8bit(cosa
)?2:4);
514 if (!request_region(base
, is_8bit(cosa
)?2:4, cosa
->type
)) {
515 printk(KERN_DEBUG
"cosa: changing name at 0x%x failed.\n", base
);
519 /* Now do IRQ autoprobe */
522 /* printk(KERN_INFO "IRQ autoprobe\n"); */
523 irqs
= probe_irq_on();
525 * Enable interrupt on tx buffer empty (it sure is)
527 * FIXME: When this code is not used as module, we should
528 * probably call udelay() instead of the interruptible sleep.
530 set_current_state(TASK_INTERRUPTIBLE
);
531 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
532 schedule_timeout(30);
533 irq
= probe_irq_off(irqs
);
534 /* Disable all IRQs from the card */
535 cosa_putstatus(cosa
, 0);
536 /* Empty the received data register */
540 printk (KERN_INFO
"cosa IRQ autoprobe: multiple interrupts obtained (%d, board at 0x%x)\n",
546 printk (KERN_INFO
"cosa IRQ autoprobe: no interrupt obtained (board at 0x%x)\n",
553 cosa
->num
= nr_cards
;
555 cosa
->nchannels
= 2; /* FIXME: how to determine this? */
557 if (request_irq(cosa
->irq
, cosa_interrupt
, 0, cosa
->type
, cosa
)) {
561 if (request_dma(cosa
->dma
, cosa
->type
)) {
566 cosa
->bouncebuf
= kmalloc(COSA_MTU
, GFP_KERNEL
|GFP_DMA
);
567 if (!cosa
->bouncebuf
) {
571 sprintf(cosa
->name
, "cosa%d", cosa
->num
);
573 /* Initialize the per-channel data */
574 cosa
->chan
= kcalloc(cosa
->nchannels
, sizeof(struct channel_data
), GFP_KERNEL
);
579 for (i
=0; i
<cosa
->nchannels
; i
++) {
580 cosa
->chan
[i
].cosa
= cosa
;
581 cosa
->chan
[i
].num
= i
;
582 channel_init(cosa
->chan
+i
);
585 printk (KERN_INFO
"cosa%d: %s (%s at 0x%x irq %d dma %d), %d channels\n",
586 cosa
->num
, cosa
->id_string
, cosa
->type
,
587 cosa
->datareg
, cosa
->irq
, cosa
->dma
, cosa
->nchannels
);
591 kfree(cosa
->bouncebuf
);
595 free_irq(cosa
->irq
, cosa
);
597 release_region(cosa
->datareg
,is_8bit(cosa
)?2:4);
598 printk(KERN_NOTICE
"cosa%d: allocating resources failed\n",
604 /*---------- SPPP/HDLC netdevice ---------- */
606 static void cosa_setup(struct net_device
*d
)
608 d
->open
= cosa_sppp_open
;
609 d
->stop
= cosa_sppp_close
;
610 d
->hard_start_xmit
= cosa_sppp_tx
;
611 d
->do_ioctl
= cosa_sppp_ioctl
;
612 d
->get_stats
= cosa_net_stats
;
613 d
->tx_timeout
= cosa_sppp_timeout
;
614 d
->watchdog_timeo
= TX_TIMEOUT
;
617 static void sppp_channel_init(struct channel_data
*chan
)
619 struct net_device
*d
;
620 chan
->if_ptr
= &chan
->pppdev
;
621 d
= alloc_netdev(0, chan
->name
, cosa_setup
);
623 printk(KERN_WARNING
"%s: alloc_netdev failed.\n", chan
->name
);
626 chan
->pppdev
.dev
= d
;
627 d
->base_addr
= chan
->cosa
->datareg
;
628 d
->irq
= chan
->cosa
->irq
;
629 d
->dma
= chan
->cosa
->dma
;
631 sppp_attach(&chan
->pppdev
);
632 if (register_netdev(d
)) {
633 printk(KERN_WARNING
"%s: register_netdev failed.\n", d
->name
);
636 chan
->pppdev
.dev
= NULL
;
641 static void sppp_channel_delete(struct channel_data
*chan
)
643 unregister_netdev(chan
->pppdev
.dev
);
644 sppp_detach(chan
->pppdev
.dev
);
645 free_netdev(chan
->pppdev
.dev
);
646 chan
->pppdev
.dev
= NULL
;
649 static int cosa_sppp_open(struct net_device
*d
)
651 struct channel_data
*chan
= d
->priv
;
655 if (!(chan
->cosa
->firmware_status
& COSA_FW_START
)) {
656 printk(KERN_NOTICE
"%s: start the firmware first (status %d)\n",
657 chan
->cosa
->name
, chan
->cosa
->firmware_status
);
660 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
661 if (chan
->usage
!= 0) {
662 printk(KERN_WARNING
"%s: sppp_open called with usage count %d\n",
663 chan
->name
, chan
->usage
);
664 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
667 chan
->setup_rx
= sppp_setup_rx
;
668 chan
->tx_done
= sppp_tx_done
;
669 chan
->rx_done
= sppp_rx_done
;
672 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
676 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
680 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
684 netif_start_queue(d
);
685 cosa_enable_rx(chan
);
689 static int cosa_sppp_tx(struct sk_buff
*skb
, struct net_device
*dev
)
691 struct channel_data
*chan
= dev
->priv
;
693 netif_stop_queue(dev
);
696 cosa_start_tx(chan
, skb
->data
, skb
->len
);
700 static void cosa_sppp_timeout(struct net_device
*dev
)
702 struct channel_data
*chan
= dev
->priv
;
704 if (test_bit(RXBIT
, &chan
->cosa
->rxtx
)) {
705 chan
->stats
.rx_errors
++;
706 chan
->stats
.rx_missed_errors
++;
708 chan
->stats
.tx_errors
++;
709 chan
->stats
.tx_aborted_errors
++;
711 cosa_kick(chan
->cosa
);
713 dev_kfree_skb(chan
->tx_skb
);
716 netif_wake_queue(dev
);
719 static int cosa_sppp_close(struct net_device
*d
)
721 struct channel_data
*chan
= d
->priv
;
726 cosa_disable_rx(chan
);
727 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
729 kfree_skb(chan
->rx_skb
);
733 kfree_skb(chan
->tx_skb
);
738 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
742 static char *sppp_setup_rx(struct channel_data
*chan
, int size
)
745 * We can safely fall back to non-dma-able memory, because we have
746 * the cosa->bouncebuf pre-allocated.
749 kfree_skb(chan
->rx_skb
);
750 chan
->rx_skb
= dev_alloc_skb(size
);
751 if (chan
->rx_skb
== NULL
) {
752 printk(KERN_NOTICE
"%s: Memory squeeze, dropping packet\n",
754 chan
->stats
.rx_dropped
++;
757 chan
->pppdev
.dev
->trans_start
= jiffies
;
758 return skb_put(chan
->rx_skb
, size
);
761 static int sppp_rx_done(struct channel_data
*chan
)
764 printk(KERN_WARNING
"%s: rx_done with empty skb!\n",
766 chan
->stats
.rx_errors
++;
767 chan
->stats
.rx_frame_errors
++;
770 chan
->rx_skb
->protocol
= htons(ETH_P_WAN_PPP
);
771 chan
->rx_skb
->dev
= chan
->pppdev
.dev
;
772 skb_reset_mac_header(chan
->rx_skb
);
773 chan
->stats
.rx_packets
++;
774 chan
->stats
.rx_bytes
+= chan
->cosa
->rxsize
;
775 netif_rx(chan
->rx_skb
);
777 chan
->pppdev
.dev
->last_rx
= jiffies
;
782 static int sppp_tx_done(struct channel_data
*chan
, int size
)
785 printk(KERN_WARNING
"%s: tx_done with empty skb!\n",
787 chan
->stats
.tx_errors
++;
788 chan
->stats
.tx_aborted_errors
++;
791 dev_kfree_skb_irq(chan
->tx_skb
);
793 chan
->stats
.tx_packets
++;
794 chan
->stats
.tx_bytes
+= size
;
795 netif_wake_queue(chan
->pppdev
.dev
);
799 static struct net_device_stats
*cosa_net_stats(struct net_device
*dev
)
801 struct channel_data
*chan
= dev
->priv
;
806 /*---------- Character device ---------- */
808 static void chardev_channel_init(struct channel_data
*chan
)
810 init_MUTEX(&chan
->rsem
);
811 init_MUTEX(&chan
->wsem
);
814 static ssize_t
cosa_read(struct file
*file
,
815 char __user
*buf
, size_t count
, loff_t
*ppos
)
817 DECLARE_WAITQUEUE(wait
, current
);
819 struct channel_data
*chan
= file
->private_data
;
820 struct cosa_data
*cosa
= chan
->cosa
;
823 if (!(cosa
->firmware_status
& COSA_FW_START
)) {
824 printk(KERN_NOTICE
"%s: start the firmware first (status %d)\n",
825 cosa
->name
, cosa
->firmware_status
);
828 if (down_interruptible(&chan
->rsem
))
831 if ((chan
->rxdata
= kmalloc(COSA_MTU
, GFP_DMA
|GFP_KERNEL
)) == NULL
) {
832 printk(KERN_INFO
"%s: cosa_read() - OOM\n", cosa
->name
);
838 cosa_enable_rx(chan
);
839 spin_lock_irqsave(&cosa
->lock
, flags
);
840 add_wait_queue(&chan
->rxwaitq
, &wait
);
841 while(!chan
->rx_status
) {
842 current
->state
= TASK_INTERRUPTIBLE
;
843 spin_unlock_irqrestore(&cosa
->lock
, flags
);
845 spin_lock_irqsave(&cosa
->lock
, flags
);
846 if (signal_pending(current
) && chan
->rx_status
== 0) {
848 remove_wait_queue(&chan
->rxwaitq
, &wait
);
849 current
->state
= TASK_RUNNING
;
850 spin_unlock_irqrestore(&cosa
->lock
, flags
);
855 remove_wait_queue(&chan
->rxwaitq
, &wait
);
856 current
->state
= TASK_RUNNING
;
858 count
= chan
->rxsize
;
859 spin_unlock_irqrestore(&cosa
->lock
, flags
);
862 if (copy_to_user(buf
, kbuf
, count
)) {
870 static char *chrdev_setup_rx(struct channel_data
*chan
, int size
)
872 /* Expect size <= COSA_MTU */
877 static int chrdev_rx_done(struct channel_data
*chan
)
879 if (chan
->rx_status
) { /* Reader has died */
884 wake_up_interruptible(&chan
->rxwaitq
);
889 static ssize_t
cosa_write(struct file
*file
,
890 const char __user
*buf
, size_t count
, loff_t
*ppos
)
892 DECLARE_WAITQUEUE(wait
, current
);
893 struct channel_data
*chan
= file
->private_data
;
894 struct cosa_data
*cosa
= chan
->cosa
;
898 if (!(cosa
->firmware_status
& COSA_FW_START
)) {
899 printk(KERN_NOTICE
"%s: start the firmware first (status %d)\n",
900 cosa
->name
, cosa
->firmware_status
);
903 if (down_interruptible(&chan
->wsem
))
906 if (count
> COSA_MTU
)
909 /* Allocate the buffer */
910 if ((kbuf
= kmalloc(count
, GFP_KERNEL
|GFP_DMA
)) == NULL
) {
911 printk(KERN_NOTICE
"%s: cosa_write() OOM - dropping packet\n",
916 if (copy_from_user(kbuf
, buf
, count
)) {
922 cosa_start_tx(chan
, kbuf
, count
);
924 spin_lock_irqsave(&cosa
->lock
, flags
);
925 add_wait_queue(&chan
->txwaitq
, &wait
);
926 while(!chan
->tx_status
) {
927 current
->state
= TASK_INTERRUPTIBLE
;
928 spin_unlock_irqrestore(&cosa
->lock
, flags
);
930 spin_lock_irqsave(&cosa
->lock
, flags
);
931 if (signal_pending(current
) && chan
->tx_status
== 0) {
933 remove_wait_queue(&chan
->txwaitq
, &wait
);
934 current
->state
= TASK_RUNNING
;
936 spin_unlock_irqrestore(&cosa
->lock
, flags
);
940 remove_wait_queue(&chan
->txwaitq
, &wait
);
941 current
->state
= TASK_RUNNING
;
943 spin_unlock_irqrestore(&cosa
->lock
, flags
);
948 static int chrdev_tx_done(struct channel_data
*chan
, int size
)
950 if (chan
->tx_status
) { /* Writer was interrupted */
955 wake_up_interruptible(&chan
->txwaitq
);
959 static unsigned int cosa_poll(struct file
*file
, poll_table
*poll
)
961 printk(KERN_INFO
"cosa_poll is here\n");
965 static int cosa_open(struct inode
*inode
, struct file
*file
)
967 struct cosa_data
*cosa
;
968 struct channel_data
*chan
;
972 if ((n
=iminor(file
->f_path
.dentry
->d_inode
)>>CARD_MINOR_BITS
)
977 if ((n
=iminor(file
->f_path
.dentry
->d_inode
)
978 & ((1<<CARD_MINOR_BITS
)-1)) >= cosa
->nchannels
)
980 chan
= cosa
->chan
+ n
;
982 file
->private_data
= chan
;
984 spin_lock_irqsave(&cosa
->lock
, flags
);
986 if (chan
->usage
< 0) { /* in netdev mode */
987 spin_unlock_irqrestore(&cosa
->lock
, flags
);
993 chan
->tx_done
= chrdev_tx_done
;
994 chan
->setup_rx
= chrdev_setup_rx
;
995 chan
->rx_done
= chrdev_rx_done
;
996 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1000 static int cosa_release(struct inode
*inode
, struct file
*file
)
1002 struct channel_data
*channel
= file
->private_data
;
1003 struct cosa_data
*cosa
;
1004 unsigned long flags
;
1006 cosa
= channel
->cosa
;
1007 spin_lock_irqsave(&cosa
->lock
, flags
);
1010 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1014 #ifdef COSA_FASYNC_WORKING
1015 static struct fasync_struct
*fasync
[256] = { NULL
, };
1017 /* To be done ... */
1018 static int cosa_fasync(struct inode
*inode
, struct file
*file
, int on
)
1020 int port
= iminor(inode
);
1021 int rv
= fasync_helper(inode
, file
, on
, &fasync
[port
]);
1022 return rv
< 0 ? rv
: 0;
1027 /* ---------- Ioctls ---------- */
1030 * Ioctl subroutines can safely be made inline, because they are called
1031 * only from cosa_ioctl().
1033 static inline int cosa_reset(struct cosa_data
*cosa
)
1035 char idstring
[COSA_MAX_ID_STRING
];
1036 if (cosa
->usage
> 1)
1037 printk(KERN_INFO
"cosa%d: WARNING: reset requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1038 cosa
->num
, cosa
->usage
);
1039 cosa
->firmware_status
&= ~(COSA_FW_RESET
|COSA_FW_START
);
1040 if (cosa_reset_and_read_id(cosa
, idstring
) < 0) {
1041 printk(KERN_NOTICE
"cosa%d: reset failed\n", cosa
->num
);
1044 printk(KERN_INFO
"cosa%d: resetting device: %s\n", cosa
->num
,
1046 cosa
->firmware_status
|= COSA_FW_RESET
;
1050 /* High-level function to download data into COSA memory. Calls download() */
1051 static inline int cosa_download(struct cosa_data
*cosa
, void __user
*arg
)
1053 struct cosa_download d
;
1056 if (cosa
->usage
> 1)
1057 printk(KERN_INFO
"%s: WARNING: download of microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1058 cosa
->name
, cosa
->usage
);
1059 if (!(cosa
->firmware_status
& COSA_FW_RESET
)) {
1060 printk(KERN_NOTICE
"%s: reset the card first (status %d).\n",
1061 cosa
->name
, cosa
->firmware_status
);
1065 if (copy_from_user(&d
, arg
, sizeof(d
)))
1068 if (d
.addr
< 0 || d
.addr
> COSA_MAX_FIRMWARE_SIZE
)
1070 if (d
.len
< 0 || d
.len
> COSA_MAX_FIRMWARE_SIZE
)
1074 /* If something fails, force the user to reset the card */
1075 cosa
->firmware_status
&= ~(COSA_FW_RESET
|COSA_FW_DOWNLOAD
);
1077 i
= download(cosa
, d
.code
, d
.len
, d
.addr
);
1079 printk(KERN_NOTICE
"cosa%d: microcode download failed: %d\n",
1083 printk(KERN_INFO
"cosa%d: downloading microcode - 0x%04x bytes at 0x%04x\n",
1084 cosa
->num
, d
.len
, d
.addr
);
1085 cosa
->firmware_status
|= COSA_FW_RESET
|COSA_FW_DOWNLOAD
;
1089 /* High-level function to read COSA memory. Calls readmem() */
1090 static inline int cosa_readmem(struct cosa_data
*cosa
, void __user
*arg
)
1092 struct cosa_download d
;
1095 if (cosa
->usage
> 1)
1096 printk(KERN_INFO
"cosa%d: WARNING: readmem requested with "
1097 "cosa->usage > 1 (%d). Odd things may happen.\n",
1098 cosa
->num
, cosa
->usage
);
1099 if (!(cosa
->firmware_status
& COSA_FW_RESET
)) {
1100 printk(KERN_NOTICE
"%s: reset the card first (status %d).\n",
1101 cosa
->name
, cosa
->firmware_status
);
1105 if (copy_from_user(&d
, arg
, sizeof(d
)))
1108 /* If something fails, force the user to reset the card */
1109 cosa
->firmware_status
&= ~COSA_FW_RESET
;
1111 i
= readmem(cosa
, d
.code
, d
.len
, d
.addr
);
1113 printk(KERN_NOTICE
"cosa%d: reading memory failed: %d\n",
1117 printk(KERN_INFO
"cosa%d: reading card memory - 0x%04x bytes at 0x%04x\n",
1118 cosa
->num
, d
.len
, d
.addr
);
1119 cosa
->firmware_status
|= COSA_FW_RESET
;
1123 /* High-level function to start microcode. Calls startmicrocode(). */
1124 static inline int cosa_start(struct cosa_data
*cosa
, int address
)
1128 if (cosa
->usage
> 1)
1129 printk(KERN_INFO
"cosa%d: WARNING: start microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1130 cosa
->num
, cosa
->usage
);
1132 if ((cosa
->firmware_status
& (COSA_FW_RESET
|COSA_FW_DOWNLOAD
))
1133 != (COSA_FW_RESET
|COSA_FW_DOWNLOAD
)) {
1134 printk(KERN_NOTICE
"%s: download the microcode and/or reset the card first (status %d).\n",
1135 cosa
->name
, cosa
->firmware_status
);
1138 cosa
->firmware_status
&= ~COSA_FW_RESET
;
1139 if ((i
=startmicrocode(cosa
, address
)) < 0) {
1140 printk(KERN_NOTICE
"cosa%d: start microcode at 0x%04x failed: %d\n",
1141 cosa
->num
, address
, i
);
1144 printk(KERN_INFO
"cosa%d: starting microcode at 0x%04x\n",
1145 cosa
->num
, address
);
1146 cosa
->startaddr
= address
;
1147 cosa
->firmware_status
|= COSA_FW_START
;
1151 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1152 static inline int cosa_getidstr(struct cosa_data
*cosa
, char __user
*string
)
1154 int l
= strlen(cosa
->id_string
)+1;
1155 if (copy_to_user(string
, cosa
->id_string
, l
))
1160 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1161 static inline int cosa_gettype(struct cosa_data
*cosa
, char __user
*string
)
1163 int l
= strlen(cosa
->type
)+1;
1164 if (copy_to_user(string
, cosa
->type
, l
))
1169 static int cosa_ioctl_common(struct cosa_data
*cosa
,
1170 struct channel_data
*channel
, unsigned int cmd
, unsigned long arg
)
1172 void __user
*argp
= (void __user
*)arg
;
1174 case COSAIORSET
: /* Reset the device */
1175 if (!capable(CAP_NET_ADMIN
))
1177 return cosa_reset(cosa
);
1178 case COSAIOSTRT
: /* Start the firmware */
1179 if (!capable(CAP_SYS_RAWIO
))
1181 return cosa_start(cosa
, arg
);
1182 case COSAIODOWNLD
: /* Download the firmware */
1183 if (!capable(CAP_SYS_RAWIO
))
1186 return cosa_download(cosa
, argp
);
1188 if (!capable(CAP_SYS_RAWIO
))
1190 return cosa_readmem(cosa
, argp
);
1192 return cosa_gettype(cosa
, argp
);
1194 return cosa_getidstr(cosa
, argp
);
1198 return cosa
->nchannels
;
1200 if (!capable(CAP_SYS_RAWIO
))
1204 if (arg
!= COSA_BM_OFF
&& arg
!= COSA_BM_ON
)
1206 cosa
->busmaster
= arg
;
1209 return cosa
->busmaster
;
1211 return -ENOIOCTLCMD
;
1214 static int cosa_sppp_ioctl(struct net_device
*dev
, struct ifreq
*ifr
,
1218 struct channel_data
*chan
= dev
->priv
;
1219 rv
= cosa_ioctl_common(chan
->cosa
, chan
, cmd
, (unsigned long)ifr
->ifr_data
);
1220 if (rv
== -ENOIOCTLCMD
) {
1221 return sppp_do_ioctl(dev
, ifr
, cmd
);
1226 static int cosa_chardev_ioctl(struct inode
*inode
, struct file
*file
,
1227 unsigned int cmd
, unsigned long arg
)
1229 struct channel_data
*channel
= file
->private_data
;
1230 struct cosa_data
*cosa
= channel
->cosa
;
1231 return cosa_ioctl_common(cosa
, channel
, cmd
, arg
);
1235 /*---------- HW layer interface ---------- */
1238 * The higher layer can bind itself to the HW layer by setting the callbacks
1239 * in the channel_data structure and by using these routines.
1241 static void cosa_enable_rx(struct channel_data
*chan
)
1243 struct cosa_data
*cosa
= chan
->cosa
;
1245 if (!test_and_set_bit(chan
->num
, &cosa
->rxbitmap
))
1246 put_driver_status(cosa
);
1249 static void cosa_disable_rx(struct channel_data
*chan
)
1251 struct cosa_data
*cosa
= chan
->cosa
;
1253 if (test_and_clear_bit(chan
->num
, &cosa
->rxbitmap
))
1254 put_driver_status(cosa
);
1258 * FIXME: This routine probably should check for cosa_start_tx() called when
1259 * the previous transmit is still unfinished. In this case the non-zero
1260 * return value should indicate to the caller that the queuing(sp?) up
1261 * the transmit has failed.
1263 static int cosa_start_tx(struct channel_data
*chan
, char *buf
, int len
)
1265 struct cosa_data
*cosa
= chan
->cosa
;
1266 unsigned long flags
;
1270 printk(KERN_INFO
"cosa%dc%d: starting tx(0x%x)", chan
->cosa
->num
,
1272 for (i
=0; i
<len
; i
++)
1273 printk(" %02x", buf
[i
]&0xff);
1276 spin_lock_irqsave(&cosa
->lock
, flags
);
1280 chan
->txsize
= COSA_MTU
;
1281 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1283 /* Tell the firmware we are ready */
1284 set_bit(chan
->num
, &cosa
->txbitmap
);
1285 put_driver_status(cosa
);
1290 static void put_driver_status(struct cosa_data
*cosa
)
1292 unsigned long flags
;
1295 spin_lock_irqsave(&cosa
->lock
, flags
);
1297 status
= (cosa
->rxbitmap
? DRIVER_RX_READY
: 0)
1298 | (cosa
->txbitmap
? DRIVER_TX_READY
: 0)
1299 | (cosa
->txbitmap
? ~(cosa
->txbitmap
<<DRIVER_TXMAP_SHIFT
)
1300 &DRIVER_TXMAP_MASK
: 0);
1302 if (cosa
->rxbitmap
|cosa
->txbitmap
) {
1303 if (!cosa
->enabled
) {
1304 cosa_putstatus(cosa
, SR_RX_INT_ENA
);
1306 debug_status_out(cosa
, SR_RX_INT_ENA
);
1310 } else if (cosa
->enabled
) {
1312 cosa_putstatus(cosa
, 0);
1314 debug_status_out(cosa
, 0);
1317 cosa_putdata8(cosa
, status
);
1319 debug_data_cmd(cosa
, status
);
1322 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1325 static void put_driver_status_nolock(struct cosa_data
*cosa
)
1329 status
= (cosa
->rxbitmap
? DRIVER_RX_READY
: 0)
1330 | (cosa
->txbitmap
? DRIVER_TX_READY
: 0)
1331 | (cosa
->txbitmap
? ~(cosa
->txbitmap
<<DRIVER_TXMAP_SHIFT
)
1332 &DRIVER_TXMAP_MASK
: 0);
1334 if (cosa
->rxbitmap
|cosa
->txbitmap
) {
1335 cosa_putstatus(cosa
, SR_RX_INT_ENA
);
1337 debug_status_out(cosa
, SR_RX_INT_ENA
);
1341 cosa_putstatus(cosa
, 0);
1343 debug_status_out(cosa
, 0);
1347 cosa_putdata8(cosa
, status
);
1349 debug_data_cmd(cosa
, status
);
1354 * The "kickme" function: When the DMA times out, this is called to
1355 * clean up the driver status.
1356 * FIXME: Preliminary support, the interface is probably wrong.
1358 static void cosa_kick(struct cosa_data
*cosa
)
1360 unsigned long flags
, flags1
;
1361 char *s
= "(probably) IRQ";
1363 if (test_bit(RXBIT
, &cosa
->rxtx
))
1365 if (test_bit(TXBIT
, &cosa
->rxtx
))
1368 printk(KERN_INFO
"%s: %s timeout - restarting.\n", cosa
->name
, s
);
1369 spin_lock_irqsave(&cosa
->lock
, flags
);
1372 flags1
= claim_dma_lock();
1373 disable_dma(cosa
->dma
);
1374 clear_dma_ff(cosa
->dma
);
1375 release_dma_lock(flags1
);
1377 /* FIXME: Anything else? */
1379 cosa_putstatus(cosa
, 0);
1381 (void) cosa_getdata8(cosa
);
1383 cosa_putdata8(cosa
, 0);
1385 put_driver_status_nolock(cosa
);
1386 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1390 * Check if the whole buffer is DMA-able. It means it is below the 16M of
1391 * physical memory and doesn't span the 64k boundary. For now it seems
1392 * SKB's never do this, but we'll check this anyway.
1394 static int cosa_dma_able(struct channel_data
*chan
, char *buf
, int len
)
1397 unsigned long b
= (unsigned long)buf
;
1398 if (b
+len
>= MAX_DMA_ADDRESS
)
1400 if ((b
^ (b
+len
)) & 0x10000) {
1402 printk(KERN_INFO
"%s: packet spanning a 64k boundary\n",
1410 /* ---------- The SRP/COSA ROM monitor functions ---------- */
1413 * Downloading SRP microcode: say "w" to SRP monitor, it answers by "w=",
1414 * drivers need to say 4-digit hex number meaning start address of the microcode
1415 * separated by a single space. Monitor replies by saying " =". Now driver
1416 * has to write 4-digit hex number meaning the last byte address ended
1417 * by a single space. Monitor has to reply with a space. Now the download
1418 * begins. After the download monitor replies with "\r\n." (CR LF dot).
1420 static int download(struct cosa_data
*cosa
, const char __user
*microcode
, int length
, int address
)
1424 if (put_wait_data(cosa
, 'w') == -1) return -1;
1425 if ((i
=get_wait_data(cosa
)) != 'w') { printk("dnld: 0x%04x\n",i
); return -2;}
1426 if (get_wait_data(cosa
) != '=') return -3;
1428 if (puthexnumber(cosa
, address
) < 0) return -4;
1429 if (put_wait_data(cosa
, ' ') == -1) return -10;
1430 if (get_wait_data(cosa
) != ' ') return -11;
1431 if (get_wait_data(cosa
) != '=') return -12;
1433 if (puthexnumber(cosa
, address
+length
-1) < 0) return -13;
1434 if (put_wait_data(cosa
, ' ') == -1) return -18;
1435 if (get_wait_data(cosa
) != ' ') return -19;
1439 #ifndef SRP_DOWNLOAD_AT_BOOT
1440 if (get_user(c
, microcode
))
1441 return -23; /* ??? */
1445 if (put_wait_data(cosa
, c
) == -1)
1450 if (get_wait_data(cosa
) != '\r') return -21;
1451 if (get_wait_data(cosa
) != '\n') return -22;
1452 if (get_wait_data(cosa
) != '.') return -23;
1454 printk(KERN_DEBUG
"cosa%d: download completed.\n", cosa
->num
);
1461 * Starting microcode is done via the "g" command of the SRP monitor.
1462 * The chat should be the following: "g" "g=" "<addr><CR>"
1463 * "<CR><CR><LF><CR><LF>".
1465 static int startmicrocode(struct cosa_data
*cosa
, int address
)
1467 if (put_wait_data(cosa
, 'g') == -1) return -1;
1468 if (get_wait_data(cosa
) != 'g') return -2;
1469 if (get_wait_data(cosa
) != '=') return -3;
1471 if (puthexnumber(cosa
, address
) < 0) return -4;
1472 if (put_wait_data(cosa
, '\r') == -1) return -5;
1474 if (get_wait_data(cosa
) != '\r') return -6;
1475 if (get_wait_data(cosa
) != '\r') return -7;
1476 if (get_wait_data(cosa
) != '\n') return -8;
1477 if (get_wait_data(cosa
) != '\r') return -9;
1478 if (get_wait_data(cosa
) != '\n') return -10;
1480 printk(KERN_DEBUG
"cosa%d: microcode started\n", cosa
->num
);
1486 * Reading memory is done via the "r" command of the SRP monitor.
1487 * The chat is the following "r" "r=" "<addr> " " =" "<last_byte> " " "
1488 * Then driver can read the data and the conversation is finished
1489 * by SRP monitor sending "<CR><LF>." (dot at the end).
1491 * This routine is not needed during the normal operation and serves
1492 * for debugging purposes only.
1494 static int readmem(struct cosa_data
*cosa
, char __user
*microcode
, int length
, int address
)
1496 if (put_wait_data(cosa
, 'r') == -1) return -1;
1497 if ((get_wait_data(cosa
)) != 'r') return -2;
1498 if ((get_wait_data(cosa
)) != '=') return -3;
1500 if (puthexnumber(cosa
, address
) < 0) return -4;
1501 if (put_wait_data(cosa
, ' ') == -1) return -5;
1502 if (get_wait_data(cosa
) != ' ') return -6;
1503 if (get_wait_data(cosa
) != '=') return -7;
1505 if (puthexnumber(cosa
, address
+length
-1) < 0) return -8;
1506 if (put_wait_data(cosa
, ' ') == -1) return -9;
1507 if (get_wait_data(cosa
) != ' ') return -10;
1512 if ((i
=get_wait_data(cosa
)) == -1) {
1513 printk (KERN_INFO
"cosa: 0x%04x bytes remaining\n",
1519 if (put_user(c
, microcode
))
1520 return -23; /* ??? */
1527 if (get_wait_data(cosa
) != '\r') return -21;
1528 if (get_wait_data(cosa
) != '\n') return -22;
1529 if (get_wait_data(cosa
) != '.') return -23;
1531 printk(KERN_DEBUG
"cosa%d: readmem completed.\n", cosa
->num
);
1537 * This function resets the device and reads the initial prompt
1538 * of the device's ROM monitor.
1540 static int cosa_reset_and_read_id(struct cosa_data
*cosa
, char *idstring
)
1542 int i
=0, id
=0, prev
=0, curr
=0;
1544 /* Reset the card ... */
1545 cosa_putstatus(cosa
, 0);
1546 cosa_getdata8(cosa
);
1547 cosa_putstatus(cosa
, SR_RST
);
1553 /* Disable all IRQs from the card */
1554 cosa_putstatus(cosa
, 0);
1557 * Try to read the ID string. The card then prints out the
1558 * identification string ended by the "\n\x2e".
1560 * The following loop is indexed through i (instead of id)
1561 * to avoid looping forever when for any reason
1562 * the port returns '\r', '\n' or '\x2e' permanently.
1564 for (i
=0; i
<COSA_MAX_ID_STRING
-1; i
++, prev
=curr
) {
1565 if ((curr
= get_wait_data(cosa
)) == -1) {
1569 if (curr
!= '\r' && curr
!= '\n' && curr
!= 0x2e)
1570 idstring
[id
++] = curr
;
1571 if (curr
== 0x2e && prev
== '\n')
1574 /* Perhaps we should fail when i==COSA_MAX_ID_STRING-1 ? */
1575 idstring
[id
] = '\0';
1580 /* ---------- Auxiliary routines for COSA/SRP monitor ---------- */
1583 * This routine gets the data byte from the card waiting for the SR_RX_RDY
1584 * bit to be set in a loop. It should be used in the exceptional cases
1585 * only (for example when resetting the card or downloading the firmware.
1587 static int get_wait_data(struct cosa_data
*cosa
)
1592 /* read data and return them */
1593 if (cosa_getstatus(cosa
) & SR_RX_RDY
) {
1595 r
= cosa_getdata8(cosa
);
1597 printk(KERN_INFO
"cosa: get_wait_data returning after %d retries\n", 999-retries
);
1601 /* sleep if not ready to read */
1602 schedule_timeout_interruptible(1);
1604 printk(KERN_INFO
"cosa: timeout in get_wait_data (status 0x%x)\n",
1605 cosa_getstatus(cosa
));
1610 * This routine puts the data byte to the card waiting for the SR_TX_RDY
1611 * bit to be set in a loop. It should be used in the exceptional cases
1612 * only (for example when resetting the card or downloading the firmware).
1614 static int put_wait_data(struct cosa_data
*cosa
, int data
)
1618 /* read data and return them */
1619 if (cosa_getstatus(cosa
) & SR_TX_RDY
) {
1620 cosa_putdata8(cosa
, data
);
1622 printk(KERN_INFO
"Putdata: %d retries\n", 999-retries
);
1627 /* sleep if not ready to read */
1628 schedule_timeout_interruptible(1);
1631 printk(KERN_INFO
"cosa%d: timeout in put_wait_data (status 0x%x)\n",
1632 cosa
->num
, cosa_getstatus(cosa
));
1637 * The following routine puts the hexadecimal number into the SRP monitor
1638 * and verifies the proper echo of the sent bytes. Returns 0 on success,
1639 * negative number on failure (-1,-3,-5,-7) means that put_wait_data() failed,
1640 * (-2,-4,-6,-8) means that reading echo failed.
1642 static int puthexnumber(struct cosa_data
*cosa
, int number
)
1647 /* Well, I should probably replace this by something faster. */
1648 sprintf(temp
, "%04X", number
);
1649 for (i
=0; i
<4; i
++) {
1650 if (put_wait_data(cosa
, temp
[i
]) == -1) {
1651 printk(KERN_NOTICE
"cosa%d: puthexnumber failed to write byte %d\n",
1655 if (get_wait_data(cosa
) != temp
[i
]) {
1656 printk(KERN_NOTICE
"cosa%d: puthexhumber failed to read echo of byte %d\n",
1665 /* ---------- Interrupt routines ---------- */
1668 * There are three types of interrupt:
1669 * At the beginning of transmit - this handled is in tx_interrupt(),
1670 * at the beginning of receive - it is in rx_interrupt() and
1671 * at the end of transmit/receive - it is the eot_interrupt() function.
1672 * These functions are multiplexed by cosa_interrupt() according to the
1673 * COSA status byte. I have moved the rx/tx/eot interrupt handling into
1674 * separate functions to make it more readable. These functions are inline,
1675 * so there should be no overhead of function call.
1677 * In the COSA bus-master mode, we need to tell the card the address of a
1678 * buffer. Unfortunately, COSA may be too slow for us, so we must busy-wait.
1679 * It's time to use the bottom half :-(
1683 * Transmit interrupt routine - called when COSA is willing to obtain
1684 * data from the OS. The most tricky part of the routine is selection
1685 * of channel we (OS) want to send packet for. For SRP we should probably
1686 * use the round-robin approach. The newer COSA firmwares have a simple
1687 * flow-control - in the status word has bits 2 and 3 set to 1 means that the
1688 * channel 0 or 1 doesn't want to receive data.
1690 * It seems there is a bug in COSA firmware (need to trace it further):
1691 * When the driver status says that the kernel has no more data for transmit
1692 * (e.g. at the end of TX DMA) and then the kernel changes its mind
1693 * (e.g. new packet is queued to hard_start_xmit()), the card issues
1694 * the TX interrupt but does not mark the channel as ready-to-transmit.
1695 * The fix seems to be to push the packet to COSA despite its request.
1696 * We first try to obey the card's opinion, and then fall back to forced TX.
1698 static inline void tx_interrupt(struct cosa_data
*cosa
, int status
)
1700 unsigned long flags
, flags1
;
1702 printk(KERN_INFO
"cosa%d: SR_DOWN_REQUEST status=0x%04x\n",
1705 spin_lock_irqsave(&cosa
->lock
, flags
);
1706 set_bit(TXBIT
, &cosa
->rxtx
);
1707 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1708 /* flow control, see the comment above */
1710 if (!cosa
->txbitmap
) {
1711 printk(KERN_WARNING
"%s: No channel wants data "
1712 "in TX IRQ. Expect DMA timeout.",
1714 put_driver_status_nolock(cosa
);
1715 clear_bit(TXBIT
, &cosa
->rxtx
);
1716 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1722 if (cosa
->txchan
>= cosa
->nchannels
)
1724 if (!(cosa
->txbitmap
& (1<<cosa
->txchan
)))
1726 if (~status
& (1 << (cosa
->txchan
+DRIVER_TXMAP_SHIFT
)))
1728 /* in second pass, accept first ready-to-TX channel */
1729 if (i
> cosa
->nchannels
) {
1730 /* Can be safely ignored */
1732 printk(KERN_DEBUG
"%s: Forcing TX "
1733 "to not-ready channel %d\n",
1734 cosa
->name
, cosa
->txchan
);
1740 cosa
->txsize
= cosa
->chan
[cosa
->txchan
].txsize
;
1741 if (cosa_dma_able(cosa
->chan
+cosa
->txchan
,
1742 cosa
->chan
[cosa
->txchan
].txbuf
, cosa
->txsize
)) {
1743 cosa
->txbuf
= cosa
->chan
[cosa
->txchan
].txbuf
;
1745 memcpy(cosa
->bouncebuf
, cosa
->chan
[cosa
->txchan
].txbuf
,
1747 cosa
->txbuf
= cosa
->bouncebuf
;
1751 if (is_8bit(cosa
)) {
1752 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1753 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
1754 cosa_putdata8(cosa
, ((cosa
->txchan
<< 5) & 0xe0)|
1755 ((cosa
->txsize
>> 8) & 0x1f));
1757 debug_status_out(cosa
, SR_TX_INT_ENA
);
1758 debug_data_out(cosa
, ((cosa
->txchan
<< 5) & 0xe0)|
1759 ((cosa
->txsize
>> 8) & 0x1f));
1760 debug_data_in(cosa
, cosa_getdata8(cosa
));
1762 cosa_getdata8(cosa
);
1764 set_bit(IRQBIT
, &cosa
->rxtx
);
1765 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1768 clear_bit(IRQBIT
, &cosa
->rxtx
);
1769 cosa_putstatus(cosa
, 0);
1770 cosa_putdata8(cosa
, cosa
->txsize
&0xff);
1772 debug_status_out(cosa
, 0);
1773 debug_data_out(cosa
, cosa
->txsize
&0xff);
1777 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
1778 cosa_putdata16(cosa
, ((cosa
->txchan
<<13) & 0xe000)
1779 | (cosa
->txsize
& 0x1fff));
1781 debug_status_out(cosa
, SR_TX_INT_ENA
);
1782 debug_data_out(cosa
, ((cosa
->txchan
<<13) & 0xe000)
1783 | (cosa
->txsize
& 0x1fff));
1784 debug_data_in(cosa
, cosa_getdata8(cosa
));
1785 debug_status_out(cosa
, 0);
1787 cosa_getdata8(cosa
);
1789 cosa_putstatus(cosa
, 0);
1792 if (cosa
->busmaster
) {
1793 unsigned long addr
= virt_to_bus(cosa
->txbuf
);
1795 printk(KERN_INFO
"busmaster IRQ\n");
1796 while (!(cosa_getstatus(cosa
)&SR_TX_RDY
)) {
1799 if (count
> 1000) break;
1801 printk(KERN_INFO
"status %x\n", cosa_getstatus(cosa
));
1802 printk(KERN_INFO
"ready after %d loops\n", count
);
1803 cosa_putdata16(cosa
, (addr
>> 16)&0xffff);
1806 while (!(cosa_getstatus(cosa
)&SR_TX_RDY
)) {
1808 if (count
> 1000) break;
1811 printk(KERN_INFO
"ready after %d loops\n", count
);
1812 cosa_putdata16(cosa
, addr
&0xffff);
1813 flags1
= claim_dma_lock();
1814 set_dma_mode(cosa
->dma
, DMA_MODE_CASCADE
);
1815 enable_dma(cosa
->dma
);
1816 release_dma_lock(flags1
);
1819 flags1
= claim_dma_lock();
1820 disable_dma(cosa
->dma
);
1821 clear_dma_ff(cosa
->dma
);
1822 set_dma_mode(cosa
->dma
, DMA_MODE_WRITE
);
1823 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->txbuf
));
1824 set_dma_count(cosa
->dma
, cosa
->txsize
);
1825 enable_dma(cosa
->dma
);
1826 release_dma_lock(flags1
);
1828 cosa_putstatus(cosa
, SR_TX_DMA_ENA
|SR_USR_INT_ENA
);
1830 debug_status_out(cosa
, SR_TX_DMA_ENA
|SR_USR_INT_ENA
);
1832 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1835 static inline void rx_interrupt(struct cosa_data
*cosa
, int status
)
1837 unsigned long flags
;
1839 printk(KERN_INFO
"cosa%d: SR_UP_REQUEST\n", cosa
->num
);
1842 spin_lock_irqsave(&cosa
->lock
, flags
);
1843 set_bit(RXBIT
, &cosa
->rxtx
);
1845 if (is_8bit(cosa
)) {
1846 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1847 set_bit(IRQBIT
, &cosa
->rxtx
);
1848 put_driver_status_nolock(cosa
);
1849 cosa
->rxsize
= cosa_getdata8(cosa
) <<8;
1851 debug_data_in(cosa
, cosa
->rxsize
>> 8);
1853 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1856 clear_bit(IRQBIT
, &cosa
->rxtx
);
1857 cosa
->rxsize
|= cosa_getdata8(cosa
) & 0xff;
1859 debug_data_in(cosa
, cosa
->rxsize
& 0xff);
1862 printk(KERN_INFO
"cosa%d: receive rxsize = (0x%04x).\n",
1863 cosa
->num
, cosa
->rxsize
);
1867 cosa
->rxsize
= cosa_getdata16(cosa
);
1869 debug_data_in(cosa
, cosa
->rxsize
);
1872 printk(KERN_INFO
"cosa%d: receive rxsize = (0x%04x).\n",
1873 cosa
->num
, cosa
->rxsize
);
1876 if (((cosa
->rxsize
& 0xe000) >> 13) >= cosa
->nchannels
) {
1877 printk(KERN_WARNING
"%s: rx for unknown channel (0x%04x)\n",
1878 cosa
->name
, cosa
->rxsize
);
1879 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1882 cosa
->rxchan
= cosa
->chan
+ ((cosa
->rxsize
& 0xe000) >> 13);
1883 cosa
->rxsize
&= 0x1fff;
1884 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1887 if (cosa
->rxchan
->setup_rx
)
1888 cosa
->rxbuf
= cosa
->rxchan
->setup_rx(cosa
->rxchan
, cosa
->rxsize
);
1891 reject
: /* Reject the packet */
1892 printk(KERN_INFO
"cosa%d: rejecting packet on channel %d\n",
1893 cosa
->num
, cosa
->rxchan
->num
);
1894 cosa
->rxbuf
= cosa
->bouncebuf
;
1898 flags
= claim_dma_lock();
1899 disable_dma(cosa
->dma
);
1900 clear_dma_ff(cosa
->dma
);
1901 set_dma_mode(cosa
->dma
, DMA_MODE_READ
);
1902 if (cosa_dma_able(cosa
->rxchan
, cosa
->rxbuf
, cosa
->rxsize
& 0x1fff)) {
1903 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->rxbuf
));
1905 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->bouncebuf
));
1907 set_dma_count(cosa
->dma
, (cosa
->rxsize
&0x1fff));
1908 enable_dma(cosa
->dma
);
1909 release_dma_lock(flags
);
1910 spin_lock_irqsave(&cosa
->lock
, flags
);
1911 cosa_putstatus(cosa
, SR_RX_DMA_ENA
|SR_USR_INT_ENA
);
1912 if (!is_8bit(cosa
) && (status
& SR_TX_RDY
))
1913 cosa_putdata8(cosa
, DRIVER_RX_READY
);
1915 debug_status_out(cosa
, SR_RX_DMA_ENA
|SR_USR_INT_ENA
);
1916 if (!is_8bit(cosa
) && (status
& SR_TX_RDY
))
1917 debug_data_cmd(cosa
, DRIVER_RX_READY
);
1919 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1922 static inline void eot_interrupt(struct cosa_data
*cosa
, int status
)
1924 unsigned long flags
, flags1
;
1925 spin_lock_irqsave(&cosa
->lock
, flags
);
1926 flags1
= claim_dma_lock();
1927 disable_dma(cosa
->dma
);
1928 clear_dma_ff(cosa
->dma
);
1929 release_dma_lock(flags1
);
1930 if (test_bit(TXBIT
, &cosa
->rxtx
)) {
1931 struct channel_data
*chan
= cosa
->chan
+cosa
->txchan
;
1933 if (chan
->tx_done(chan
, cosa
->txsize
))
1934 clear_bit(chan
->num
, &cosa
->txbitmap
);
1935 } else if (test_bit(RXBIT
, &cosa
->rxtx
)) {
1939 printk(KERN_INFO
"cosa%dc%d: done rx(0x%x)", cosa
->num
,
1940 cosa
->rxchan
->num
, cosa
->rxsize
);
1941 for (i
=0; i
<cosa
->rxsize
; i
++)
1942 printk (" %02x", cosa
->rxbuf
[i
]&0xff);
1946 /* Packet for unknown channel? */
1947 if (cosa
->rxbuf
== cosa
->bouncebuf
)
1949 if (!cosa_dma_able(cosa
->rxchan
, cosa
->rxbuf
, cosa
->rxsize
))
1950 memcpy(cosa
->rxbuf
, cosa
->bouncebuf
, cosa
->rxsize
);
1951 if (cosa
->rxchan
->rx_done
)
1952 if (cosa
->rxchan
->rx_done(cosa
->rxchan
))
1953 clear_bit(cosa
->rxchan
->num
, &cosa
->rxbitmap
);
1955 printk(KERN_NOTICE
"cosa%d: unexpected EOT interrupt\n",
1959 * Clear the RXBIT, TXBIT and IRQBIT (the latest should be
1960 * cleared anyway). We should do it as soon as possible
1961 * so that we can tell the COSA we are done and to give it a time
1966 put_driver_status_nolock(cosa
);
1967 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1970 static irqreturn_t
cosa_interrupt(int irq
, void *cosa_
)
1974 struct cosa_data
*cosa
= cosa_
;
1976 status
= cosa_getstatus(cosa
);
1978 printk(KERN_INFO
"cosa%d: got IRQ, status 0x%02x\n", cosa
->num
,
1982 debug_status_in(cosa
, status
);
1984 switch (status
& SR_CMD_FROM_SRP_MASK
) {
1985 case SR_DOWN_REQUEST
:
1986 tx_interrupt(cosa
, status
);
1989 rx_interrupt(cosa
, status
);
1991 case SR_END_OF_TRANSFER
:
1992 eot_interrupt(cosa
, status
);
1995 /* We may be too fast for SRP. Try to wait a bit more. */
1996 if (count
++ < 100) {
2000 printk(KERN_INFO
"cosa%d: unknown status 0x%02x in IRQ after %d retries\n",
2001 cosa
->num
, status
& 0xff, count
);
2005 printk(KERN_INFO
"%s: %d-times got unknown status in IRQ\n",
2008 printk(KERN_INFO
"%s: returning from IRQ\n", cosa
->name
);
2014 /* ---------- I/O debugging routines ---------- */
2016 * These routines can be used to monitor COSA/SRP I/O and to printk()
2017 * the data being transferred on the data and status I/O port in a
2022 static void debug_status_in(struct cosa_data
*cosa
, int status
)
2025 switch(status
& SR_CMD_FROM_SRP_MASK
) {
2029 case SR_DOWN_REQUEST
:
2032 case SR_END_OF_TRANSFER
:
2039 printk(KERN_INFO
"%s: IO: status -> 0x%02x (%s%s%s%s)\n",
2042 status
& SR_USR_RQ
? "USR_RQ|":"",
2043 status
& SR_TX_RDY
? "TX_RDY|":"",
2044 status
& SR_RX_RDY
? "RX_RDY|":"",
2048 static void debug_status_out(struct cosa_data
*cosa
, int status
)
2050 printk(KERN_INFO
"%s: IO: status <- 0x%02x (%s%s%s%s%s%s)\n",
2053 status
& SR_RX_DMA_ENA
? "RXDMA|":"!rxdma|",
2054 status
& SR_TX_DMA_ENA
? "TXDMA|":"!txdma|",
2055 status
& SR_RST
? "RESET|":"",
2056 status
& SR_USR_INT_ENA
? "USRINT|":"!usrint|",
2057 status
& SR_TX_INT_ENA
? "TXINT|":"!txint|",
2058 status
& SR_RX_INT_ENA
? "RXINT":"!rxint");
2061 static void debug_data_in(struct cosa_data
*cosa
, int data
)
2063 printk(KERN_INFO
"%s: IO: data -> 0x%04x\n", cosa
->name
, data
);
2066 static void debug_data_out(struct cosa_data
*cosa
, int data
)
2068 printk(KERN_INFO
"%s: IO: data <- 0x%04x\n", cosa
->name
, data
);
2071 static void debug_data_cmd(struct cosa_data
*cosa
, int data
)
2073 printk(KERN_INFO
"%s: IO: data <- 0x%04x (%s|%s)\n",
2075 data
& SR_RDY_RCV
? "RX_RDY" : "!rx_rdy",
2076 data
& SR_RDY_SND
? "TX_RDY" : "!tx_rdy");
2080 /* EOF -- this file has not been truncated */