1 /* $Id: cosa.c,v 1.31 2000/03/08 17:47:16 kas Exp $ */
4 * Copyright (C) 1995-1997 Jan "Yenya" Kasprzak <kas@fi.muni.cz>
5 * Generic HDLC port Copyright (C) 2008 Krzysztof Halasa <khc@pm.waw.pl>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * The driver for the SRP and COSA synchronous serial cards.
27 * Both cards are developed at the Institute of Computer Science,
28 * Masaryk University (http://www.ics.muni.cz/). The hardware is
29 * developed by Jiri Novotny <novotny@ics.muni.cz>. More information
30 * and the photo of both cards is available at
31 * http://www.pavoucek.cz/cosa.html. The card documentation, firmwares
32 * and other goods can be downloaded from ftp://ftp.ics.muni.cz/pub/cosa/.
33 * For Linux-specific utilities, see below in the "Software info" section.
34 * If you want to order the card, contact Jiri Novotny.
36 * The SRP (serial port?, the Czech word "srp" means "sickle") card
37 * is a 2-port intelligent (with its own 8-bit CPU) synchronous serial card
38 * with V.24 interfaces up to 80kb/s each.
40 * The COSA (communication serial adapter?, the Czech word "kosa" means
41 * "scythe") is a next-generation sync/async board with two interfaces
42 * - currently any of V.24, X.21, V.35 and V.36 can be selected.
43 * It has a 16-bit SAB80166 CPU and can do up to 10 Mb/s per channel.
44 * The 8-channels version is in development.
46 * Both types have downloadable firmware and communicate via ISA DMA.
47 * COSA can be also a bus-mastering device.
51 * The homepage of the Linux driver is at http://www.fi.muni.cz/~kas/cosa/.
52 * The CVS tree of Linux driver can be viewed there, as well as the
53 * firmware binaries and user-space utilities for downloading the firmware
54 * into the card and setting up the card.
56 * The Linux driver (unlike the present *BSD drivers :-) can work even
57 * for the COSA and SRP in one computer and allows each channel to work
58 * in one of the two modes (character or network device).
62 * The Linux driver was written by Jan "Yenya" Kasprzak <kas@fi.muni.cz>.
64 * You can mail me bugfixes and even success reports. I am especially
65 * interested in the SMP and/or muliti-channel success/failure reports
66 * (I wonder if I did the locking properly :-).
68 * THE AUTHOR USED THE FOLLOWING SOURCES WHEN PROGRAMMING THE DRIVER
70 * The COSA/SRP NetBSD driver by Zdenek Salvet and Ivos Cernohlavek
71 * The skeleton.c by Donald Becker
72 * The SDL Riscom/N2 driver by Mike Natale
73 * The Comtrol Hostess SV11 driver by Alan Cox
74 * The Sync PPP/Cisco HDLC layer (syncppp.c) ported to Linux by Alan Cox
77 #include <linux/module.h>
78 #include <linux/kernel.h>
79 #include <linux/sched.h>
80 #include <linux/slab.h>
81 #include <linux/poll.h>
83 #include <linux/interrupt.h>
84 #include <linux/delay.h>
85 #include <linux/hdlc.h>
86 #include <linux/errno.h>
87 #include <linux/ioport.h>
88 #include <linux/netdevice.h>
89 #include <linux/spinlock.h>
90 #include <linux/mutex.h>
91 #include <linux/device.h>
94 #include <asm/byteorder.h>
96 #undef COSA_SLOW_IO /* for testing purposes only */
100 /* Maximum length of the identification string. */
101 #define COSA_MAX_ID_STRING 128
103 /* Maximum length of the channel name */
104 #define COSA_MAX_NAME (sizeof("cosaXXXcXXX")+1)
106 /* Per-channel data structure */
108 struct channel_data
{
109 int usage
; /* Usage count; >0 for chrdev, -1 for netdev */
110 int num
; /* Number of the channel */
111 struct cosa_data
*cosa
; /* Pointer to the per-card structure */
112 int txsize
; /* Size of transmitted data */
113 char *txbuf
; /* Transmit buffer */
114 char name
[COSA_MAX_NAME
]; /* channel name */
116 /* The HW layer interface */
117 /* routine called from the RX interrupt */
118 char *(*setup_rx
)(struct channel_data
*channel
, int size
);
119 /* routine called when the RX is done (from the EOT interrupt) */
120 int (*rx_done
)(struct channel_data
*channel
);
121 /* routine called when the TX is done (from the EOT interrupt) */
122 int (*tx_done
)(struct channel_data
*channel
, int size
);
124 /* Character device parts */
126 struct semaphore wsem
;
129 wait_queue_head_t txwaitq
, rxwaitq
;
130 int tx_status
, rx_status
;
132 /* generic HDLC device parts */
133 struct net_device
*netdev
;
134 struct sk_buff
*rx_skb
, *tx_skb
;
137 /* cosa->firmware_status bits */
138 #define COSA_FW_RESET (1<<0) /* Is the ROM monitor active? */
139 #define COSA_FW_DOWNLOAD (1<<1) /* Is the microcode downloaded? */
140 #define COSA_FW_START (1<<2) /* Is the microcode running? */
143 int num
; /* Card number */
144 char name
[COSA_MAX_NAME
]; /* Card name - e.g "cosa0" */
145 unsigned int datareg
, statusreg
; /* I/O ports */
146 unsigned short irq
, dma
; /* IRQ and DMA number */
147 unsigned short startaddr
; /* Firmware start address */
148 unsigned short busmaster
; /* Use busmastering? */
149 int nchannels
; /* # of channels on this card */
150 int driver_status
; /* For communicating with firmware */
151 int firmware_status
; /* Downloaded, reseted, etc. */
152 unsigned long rxbitmap
, txbitmap
;/* Bitmap of channels who are willing to send/receive data */
153 unsigned long rxtx
; /* RX or TX in progress? */
155 int usage
; /* usage count */
156 int txchan
, txsize
, rxsize
;
157 struct channel_data
*rxchan
;
160 struct channel_data
*chan
;
161 spinlock_t lock
; /* For exclusive operations on this structure */
162 char id_string
[COSA_MAX_ID_STRING
]; /* ROM monitor ID string */
163 char *type
; /* card type */
167 * Define this if you want all the possible ports to be autoprobed.
168 * It is here but it probably is not a good idea to use this.
170 /* #define COSA_ISA_AUTOPROBE 1 */
173 * Character device major number. 117 was allocated for us.
174 * The value of 0 means to allocate a first free one.
176 static DEFINE_MUTEX(cosa_chardev_mutex
);
177 static int cosa_major
= 117;
180 * Encoding of the minor numbers:
181 * The lowest CARD_MINOR_BITS bits means the channel on the single card,
182 * the highest bits means the card number.
184 #define CARD_MINOR_BITS 4 /* How many bits in minor number are reserved
185 * for the single card */
187 * The following depends on CARD_MINOR_BITS. Unfortunately, the "MODULE_STRING"
188 * macro doesn't like anything other than the raw number as an argument :-(
191 /* #define MAX_CARDS (1 << (8-CARD_MINOR_BITS)) */
193 #define DRIVER_RX_READY 0x0001
194 #define DRIVER_TX_READY 0x0002
195 #define DRIVER_TXMAP_SHIFT 2
196 #define DRIVER_TXMAP_MASK 0x0c /* FIXME: 0xfc for 8-channel version */
199 * for cosa->rxtx - indicates whether either transmit or receive is
200 * in progress. These values are mean number of the bit.
206 #define COSA_MTU 2000 /* FIXME: I don't know this exactly */
208 #undef DEBUG_DATA //1 /* Dump the data read or written to the channel */
209 #undef DEBUG_IRQS //1 /* Print the message when the IRQ is received */
210 #undef DEBUG_IO //1 /* Dump the I/O traffic */
212 #define TX_TIMEOUT (5*HZ)
214 /* Maybe the following should be allocated dynamically */
215 static struct cosa_data cosa_cards
[MAX_CARDS
];
218 #ifdef COSA_ISA_AUTOPROBE
219 static int io
[MAX_CARDS
+1] = { 0x220, 0x228, 0x210, 0x218, 0, };
220 /* NOTE: DMA is not autoprobed!!! */
221 static int dma
[MAX_CARDS
+1] = { 1, 7, 1, 7, 1, 7, 1, 7, 0, };
223 static int io
[MAX_CARDS
+1];
224 static int dma
[MAX_CARDS
+1];
226 /* IRQ can be safely autoprobed */
227 static int irq
[MAX_CARDS
+1] = { -1, -1, -1, -1, -1, -1, 0, };
230 static struct class *cosa_class
;
233 module_param_array(io
, int, NULL
, 0);
234 MODULE_PARM_DESC(io
, "The I/O bases of the COSA or SRP cards");
235 module_param_array(irq
, int, NULL
, 0);
236 MODULE_PARM_DESC(irq
, "The IRQ lines of the COSA or SRP cards");
237 module_param_array(dma
, int, NULL
, 0);
238 MODULE_PARM_DESC(dma
, "The DMA channels of the COSA or SRP cards");
240 MODULE_AUTHOR("Jan \"Yenya\" Kasprzak, <kas@fi.muni.cz>");
241 MODULE_DESCRIPTION("Modular driver for the COSA or SRP synchronous card");
242 MODULE_LICENSE("GPL");
245 /* I use this mainly for testing purposes */
247 #define cosa_outb outb_p
248 #define cosa_outw outw_p
249 #define cosa_inb inb_p
250 #define cosa_inw inw_p
252 #define cosa_outb outb
253 #define cosa_outw outw
258 #define is_8bit(cosa) (!(cosa->datareg & 0x08))
260 #define cosa_getstatus(cosa) (cosa_inb(cosa->statusreg))
261 #define cosa_putstatus(cosa, stat) (cosa_outb(stat, cosa->statusreg))
262 #define cosa_getdata16(cosa) (cosa_inw(cosa->datareg))
263 #define cosa_getdata8(cosa) (cosa_inb(cosa->datareg))
264 #define cosa_putdata16(cosa, dt) (cosa_outw(dt, cosa->datareg))
265 #define cosa_putdata8(cosa, dt) (cosa_outb(dt, cosa->datareg))
267 /* Initialization stuff */
268 static int cosa_probe(int ioaddr
, int irq
, int dma
);
271 static void cosa_enable_rx(struct channel_data
*chan
);
272 static void cosa_disable_rx(struct channel_data
*chan
);
273 static int cosa_start_tx(struct channel_data
*channel
, char *buf
, int size
);
274 static void cosa_kick(struct cosa_data
*cosa
);
275 static int cosa_dma_able(struct channel_data
*chan
, char *buf
, int data
);
277 /* Network device stuff */
278 static int cosa_net_attach(struct net_device
*dev
, unsigned short encoding
,
279 unsigned short parity
);
280 static int cosa_net_open(struct net_device
*d
);
281 static int cosa_net_close(struct net_device
*d
);
282 static void cosa_net_timeout(struct net_device
*d
);
283 static netdev_tx_t
cosa_net_tx(struct sk_buff
*skb
, struct net_device
*d
);
284 static char *cosa_net_setup_rx(struct channel_data
*channel
, int size
);
285 static int cosa_net_rx_done(struct channel_data
*channel
);
286 static int cosa_net_tx_done(struct channel_data
*channel
, int size
);
287 static int cosa_net_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
);
289 /* Character device */
290 static char *chrdev_setup_rx(struct channel_data
*channel
, int size
);
291 static int chrdev_rx_done(struct channel_data
*channel
);
292 static int chrdev_tx_done(struct channel_data
*channel
, int size
);
293 static ssize_t
cosa_read(struct file
*file
,
294 char __user
*buf
, size_t count
, loff_t
*ppos
);
295 static ssize_t
cosa_write(struct file
*file
,
296 const char __user
*buf
, size_t count
, loff_t
*ppos
);
297 static unsigned int cosa_poll(struct file
*file
, poll_table
*poll
);
298 static int cosa_open(struct inode
*inode
, struct file
*file
);
299 static int cosa_release(struct inode
*inode
, struct file
*file
);
300 static long cosa_chardev_ioctl(struct file
*file
, unsigned int cmd
,
302 #ifdef COSA_FASYNC_WORKING
303 static int cosa_fasync(struct inode
*inode
, struct file
*file
, int on
);
306 static const struct file_operations cosa_fops
= {
307 .owner
= THIS_MODULE
,
312 .unlocked_ioctl
= cosa_chardev_ioctl
,
314 .release
= cosa_release
,
315 #ifdef COSA_FASYNC_WORKING
316 .fasync
= cosa_fasync
,
321 static int cosa_start(struct cosa_data
*cosa
, int address
);
322 static int cosa_reset(struct cosa_data
*cosa
);
323 static int cosa_download(struct cosa_data
*cosa
, void __user
*a
);
324 static int cosa_readmem(struct cosa_data
*cosa
, void __user
*a
);
326 /* COSA/SRP ROM monitor */
327 static int download(struct cosa_data
*cosa
, const char __user
*data
, int addr
, int len
);
328 static int startmicrocode(struct cosa_data
*cosa
, int address
);
329 static int readmem(struct cosa_data
*cosa
, char __user
*data
, int addr
, int len
);
330 static int cosa_reset_and_read_id(struct cosa_data
*cosa
, char *id
);
332 /* Auxilliary functions */
333 static int get_wait_data(struct cosa_data
*cosa
);
334 static int put_wait_data(struct cosa_data
*cosa
, int data
);
335 static int puthexnumber(struct cosa_data
*cosa
, int number
);
336 static void put_driver_status(struct cosa_data
*cosa
);
337 static void put_driver_status_nolock(struct cosa_data
*cosa
);
339 /* Interrupt handling */
340 static irqreturn_t
cosa_interrupt(int irq
, void *cosa
);
342 /* I/O ops debugging */
344 static void debug_data_in(struct cosa_data
*cosa
, int data
);
345 static void debug_data_out(struct cosa_data
*cosa
, int data
);
346 static void debug_data_cmd(struct cosa_data
*cosa
, int data
);
347 static void debug_status_in(struct cosa_data
*cosa
, int status
);
348 static void debug_status_out(struct cosa_data
*cosa
, int status
);
351 static inline struct channel_data
* dev_to_chan(struct net_device
*dev
)
353 return (struct channel_data
*)dev_to_hdlc(dev
)->priv
;
356 /* ---------- Initialization stuff ---------- */
358 static int __init
cosa_init(void)
362 if (cosa_major
> 0) {
363 if (register_chrdev(cosa_major
, "cosa", &cosa_fops
)) {
364 printk(KERN_WARNING
"cosa: unable to get major %d\n",
370 if (!(cosa_major
=register_chrdev(0, "cosa", &cosa_fops
))) {
371 printk(KERN_WARNING
"cosa: unable to register chardev\n");
376 for (i
=0; i
<MAX_CARDS
; i
++)
377 cosa_cards
[i
].num
= -1;
378 for (i
=0; io
[i
] != 0 && i
< MAX_CARDS
; i
++)
379 cosa_probe(io
[i
], irq
[i
], dma
[i
]);
381 printk(KERN_WARNING
"cosa: no devices found.\n");
382 unregister_chrdev(cosa_major
, "cosa");
386 cosa_class
= class_create(THIS_MODULE
, "cosa");
387 if (IS_ERR(cosa_class
)) {
388 err
= PTR_ERR(cosa_class
);
391 for (i
= 0; i
< nr_cards
; i
++)
392 device_create(cosa_class
, NULL
, MKDEV(cosa_major
, i
), NULL
,
398 unregister_chrdev(cosa_major
, "cosa");
402 module_init(cosa_init
);
404 static void __exit
cosa_exit(void)
406 struct cosa_data
*cosa
;
409 for (i
= 0; i
< nr_cards
; i
++)
410 device_destroy(cosa_class
, MKDEV(cosa_major
, i
));
411 class_destroy(cosa_class
);
413 for (cosa
= cosa_cards
; nr_cards
--; cosa
++) {
414 /* Clean up the per-channel data */
415 for (i
= 0; i
< cosa
->nchannels
; i
++) {
416 /* Chardev driver has no alloc'd per-channel data */
417 unregister_hdlc_device(cosa
->chan
[i
].netdev
);
418 free_netdev(cosa
->chan
[i
].netdev
);
420 /* Clean up the per-card data */
422 kfree(cosa
->bouncebuf
);
423 free_irq(cosa
->irq
, cosa
);
425 release_region(cosa
->datareg
, is_8bit(cosa
) ? 2 : 4);
427 unregister_chrdev(cosa_major
, "cosa");
429 module_exit(cosa_exit
);
431 static const struct net_device_ops cosa_ops
= {
432 .ndo_open
= cosa_net_open
,
433 .ndo_stop
= cosa_net_close
,
434 .ndo_change_mtu
= hdlc_change_mtu
,
435 .ndo_start_xmit
= hdlc_start_xmit
,
436 .ndo_do_ioctl
= cosa_net_ioctl
,
437 .ndo_tx_timeout
= cosa_net_timeout
,
440 static int cosa_probe(int base
, int irq
, int dma
)
442 struct cosa_data
*cosa
= cosa_cards
+nr_cards
;
445 memset(cosa
, 0, sizeof(struct cosa_data
));
447 /* Checking validity of parameters: */
448 /* IRQ should be 2-7 or 10-15; negative IRQ means autoprobe */
449 if ((irq
>= 0 && irq
< 2) || irq
> 15 || (irq
< 10 && irq
> 7)) {
450 printk (KERN_INFO
"cosa_probe: invalid IRQ %d\n", irq
);
453 /* I/O address should be between 0x100 and 0x3ff and should be
455 if (base
< 0x100 || base
> 0x3ff || base
& 0x7) {
456 printk (KERN_INFO
"cosa_probe: invalid I/O address 0x%x\n",
460 /* DMA should be 0,1 or 3-7 */
461 if (dma
< 0 || dma
== 4 || dma
> 7) {
462 printk (KERN_INFO
"cosa_probe: invalid DMA %d\n", dma
);
465 /* and finally, on 16-bit COSA DMA should be 4-7 and
466 * I/O base should not be multiple of 0x10 */
467 if (((base
& 0x8) && dma
< 4) || (!(base
& 0x8) && dma
> 3)) {
468 printk (KERN_INFO
"cosa_probe: 8/16 bit base and DMA mismatch"
469 " (base=0x%x, dma=%d)\n", base
, dma
);
474 cosa
->datareg
= base
;
475 cosa
->statusreg
= is_8bit(cosa
)?base
+1:base
+2;
476 spin_lock_init(&cosa
->lock
);
478 if (!request_region(base
, is_8bit(cosa
)?2:4,"cosa"))
481 if (cosa_reset_and_read_id(cosa
, cosa
->id_string
) < 0) {
482 printk(KERN_DEBUG
"cosa: probe at 0x%x failed.\n", base
);
487 /* Test the validity of identification string */
488 if (!strncmp(cosa
->id_string
, "SRP", 3))
490 else if (!strncmp(cosa
->id_string
, "COSA", 4))
491 cosa
->type
= is_8bit(cosa
)? "cosa8": "cosa16";
493 /* Print a warning only if we are not autoprobing */
494 #ifndef COSA_ISA_AUTOPROBE
495 printk(KERN_INFO
"cosa: valid signature not found at 0x%x.\n",
501 /* Update the name of the region now we know the type of card */
502 release_region(base
, is_8bit(cosa
)?2:4);
503 if (!request_region(base
, is_8bit(cosa
)?2:4, cosa
->type
)) {
504 printk(KERN_DEBUG
"cosa: changing name at 0x%x failed.\n", base
);
508 /* Now do IRQ autoprobe */
511 /* printk(KERN_INFO "IRQ autoprobe\n"); */
512 irqs
= probe_irq_on();
514 * Enable interrupt on tx buffer empty (it sure is)
516 * FIXME: When this code is not used as module, we should
517 * probably call udelay() instead of the interruptible sleep.
519 set_current_state(TASK_INTERRUPTIBLE
);
520 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
521 schedule_timeout(30);
522 irq
= probe_irq_off(irqs
);
523 /* Disable all IRQs from the card */
524 cosa_putstatus(cosa
, 0);
525 /* Empty the received data register */
529 printk (KERN_INFO
"cosa IRQ autoprobe: multiple interrupts obtained (%d, board at 0x%x)\n",
535 printk (KERN_INFO
"cosa IRQ autoprobe: no interrupt obtained (board at 0x%x)\n",
542 cosa
->num
= nr_cards
;
544 cosa
->nchannels
= 2; /* FIXME: how to determine this? */
546 if (request_irq(cosa
->irq
, cosa_interrupt
, 0, cosa
->type
, cosa
)) {
550 if (request_dma(cosa
->dma
, cosa
->type
)) {
555 cosa
->bouncebuf
= kmalloc(COSA_MTU
, GFP_KERNEL
|GFP_DMA
);
556 if (!cosa
->bouncebuf
) {
560 sprintf(cosa
->name
, "cosa%d", cosa
->num
);
562 /* Initialize the per-channel data */
563 cosa
->chan
= kcalloc(cosa
->nchannels
, sizeof(struct channel_data
), GFP_KERNEL
);
569 for (i
= 0; i
< cosa
->nchannels
; i
++) {
570 struct channel_data
*chan
= &cosa
->chan
[i
];
574 sprintf(chan
->name
, "cosa%dc%d", chan
->cosa
->num
, i
);
576 /* Initialize the chardev data structures */
577 mutex_init(&chan
->rlock
);
578 sema_init(&chan
->wsem
, 1);
580 /* Register the network interface */
581 if (!(chan
->netdev
= alloc_hdlcdev(chan
))) {
582 printk(KERN_WARNING
"%s: alloc_hdlcdev failed.\n",
586 dev_to_hdlc(chan
->netdev
)->attach
= cosa_net_attach
;
587 dev_to_hdlc(chan
->netdev
)->xmit
= cosa_net_tx
;
588 chan
->netdev
->netdev_ops
= &cosa_ops
;
589 chan
->netdev
->watchdog_timeo
= TX_TIMEOUT
;
590 chan
->netdev
->base_addr
= chan
->cosa
->datareg
;
591 chan
->netdev
->irq
= chan
->cosa
->irq
;
592 chan
->netdev
->dma
= chan
->cosa
->dma
;
593 if (register_hdlc_device(chan
->netdev
)) {
594 printk(KERN_WARNING
"%s: register_hdlc_device()"
595 " failed.\n", chan
->netdev
->name
);
596 free_netdev(chan
->netdev
);
601 printk (KERN_INFO
"cosa%d: %s (%s at 0x%x irq %d dma %d), %d channels\n",
602 cosa
->num
, cosa
->id_string
, cosa
->type
,
603 cosa
->datareg
, cosa
->irq
, cosa
->dma
, cosa
->nchannels
);
609 unregister_hdlc_device(cosa
->chan
[i
].netdev
);
610 free_netdev(cosa
->chan
[i
].netdev
);
614 kfree(cosa
->bouncebuf
);
618 free_irq(cosa
->irq
, cosa
);
620 release_region(cosa
->datareg
,is_8bit(cosa
)?2:4);
621 printk(KERN_NOTICE
"cosa%d: allocating resources failed\n",
627 /*---------- network device ---------- */
629 static int cosa_net_attach(struct net_device
*dev
, unsigned short encoding
,
630 unsigned short parity
)
632 if (encoding
== ENCODING_NRZ
&& parity
== PARITY_CRC16_PR1_CCITT
)
637 static int cosa_net_open(struct net_device
*dev
)
639 struct channel_data
*chan
= dev_to_chan(dev
);
643 if (!(chan
->cosa
->firmware_status
& COSA_FW_START
)) {
644 printk(KERN_NOTICE
"%s: start the firmware first (status %d)\n",
645 chan
->cosa
->name
, chan
->cosa
->firmware_status
);
648 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
649 if (chan
->usage
!= 0) {
650 printk(KERN_WARNING
"%s: cosa_net_open called with usage count"
651 " %d\n", chan
->name
, chan
->usage
);
652 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
655 chan
->setup_rx
= cosa_net_setup_rx
;
656 chan
->tx_done
= cosa_net_tx_done
;
657 chan
->rx_done
= cosa_net_rx_done
;
660 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
662 err
= hdlc_open(dev
);
664 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
667 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
671 netif_start_queue(dev
);
672 cosa_enable_rx(chan
);
676 static netdev_tx_t
cosa_net_tx(struct sk_buff
*skb
,
677 struct net_device
*dev
)
679 struct channel_data
*chan
= dev_to_chan(dev
);
681 netif_stop_queue(dev
);
684 cosa_start_tx(chan
, skb
->data
, skb
->len
);
688 static void cosa_net_timeout(struct net_device
*dev
)
690 struct channel_data
*chan
= dev_to_chan(dev
);
692 if (test_bit(RXBIT
, &chan
->cosa
->rxtx
)) {
693 chan
->netdev
->stats
.rx_errors
++;
694 chan
->netdev
->stats
.rx_missed_errors
++;
696 chan
->netdev
->stats
.tx_errors
++;
697 chan
->netdev
->stats
.tx_aborted_errors
++;
699 cosa_kick(chan
->cosa
);
701 dev_kfree_skb(chan
->tx_skb
);
704 netif_wake_queue(dev
);
707 static int cosa_net_close(struct net_device
*dev
)
709 struct channel_data
*chan
= dev_to_chan(dev
);
712 netif_stop_queue(dev
);
714 cosa_disable_rx(chan
);
715 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
717 kfree_skb(chan
->rx_skb
);
721 kfree_skb(chan
->tx_skb
);
726 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
730 static char *cosa_net_setup_rx(struct channel_data
*chan
, int size
)
733 * We can safely fall back to non-dma-able memory, because we have
734 * the cosa->bouncebuf pre-allocated.
736 kfree_skb(chan
->rx_skb
);
737 chan
->rx_skb
= dev_alloc_skb(size
);
738 if (chan
->rx_skb
== NULL
) {
739 printk(KERN_NOTICE
"%s: Memory squeeze, dropping packet\n",
741 chan
->netdev
->stats
.rx_dropped
++;
744 chan
->netdev
->trans_start
= jiffies
;
745 return skb_put(chan
->rx_skb
, size
);
748 static int cosa_net_rx_done(struct channel_data
*chan
)
751 printk(KERN_WARNING
"%s: rx_done with empty skb!\n",
753 chan
->netdev
->stats
.rx_errors
++;
754 chan
->netdev
->stats
.rx_frame_errors
++;
757 chan
->rx_skb
->protocol
= hdlc_type_trans(chan
->rx_skb
, chan
->netdev
);
758 chan
->rx_skb
->dev
= chan
->netdev
;
759 skb_reset_mac_header(chan
->rx_skb
);
760 chan
->netdev
->stats
.rx_packets
++;
761 chan
->netdev
->stats
.rx_bytes
+= chan
->cosa
->rxsize
;
762 netif_rx(chan
->rx_skb
);
768 static int cosa_net_tx_done(struct channel_data
*chan
, int size
)
771 printk(KERN_WARNING
"%s: tx_done with empty skb!\n",
773 chan
->netdev
->stats
.tx_errors
++;
774 chan
->netdev
->stats
.tx_aborted_errors
++;
777 dev_kfree_skb_irq(chan
->tx_skb
);
779 chan
->netdev
->stats
.tx_packets
++;
780 chan
->netdev
->stats
.tx_bytes
+= size
;
781 netif_wake_queue(chan
->netdev
);
785 /*---------- Character device ---------- */
787 static ssize_t
cosa_read(struct file
*file
,
788 char __user
*buf
, size_t count
, loff_t
*ppos
)
790 DECLARE_WAITQUEUE(wait
, current
);
792 struct channel_data
*chan
= file
->private_data
;
793 struct cosa_data
*cosa
= chan
->cosa
;
796 if (!(cosa
->firmware_status
& COSA_FW_START
)) {
797 printk(KERN_NOTICE
"%s: start the firmware first (status %d)\n",
798 cosa
->name
, cosa
->firmware_status
);
801 if (mutex_lock_interruptible(&chan
->rlock
))
804 if ((chan
->rxdata
= kmalloc(COSA_MTU
, GFP_DMA
|GFP_KERNEL
)) == NULL
) {
805 printk(KERN_INFO
"%s: cosa_read() - OOM\n", cosa
->name
);
806 mutex_unlock(&chan
->rlock
);
811 cosa_enable_rx(chan
);
812 spin_lock_irqsave(&cosa
->lock
, flags
);
813 add_wait_queue(&chan
->rxwaitq
, &wait
);
814 while (!chan
->rx_status
) {
815 current
->state
= TASK_INTERRUPTIBLE
;
816 spin_unlock_irqrestore(&cosa
->lock
, flags
);
818 spin_lock_irqsave(&cosa
->lock
, flags
);
819 if (signal_pending(current
) && chan
->rx_status
== 0) {
821 remove_wait_queue(&chan
->rxwaitq
, &wait
);
822 current
->state
= TASK_RUNNING
;
823 spin_unlock_irqrestore(&cosa
->lock
, flags
);
824 mutex_unlock(&chan
->rlock
);
828 remove_wait_queue(&chan
->rxwaitq
, &wait
);
829 current
->state
= TASK_RUNNING
;
831 count
= chan
->rxsize
;
832 spin_unlock_irqrestore(&cosa
->lock
, flags
);
833 mutex_unlock(&chan
->rlock
);
835 if (copy_to_user(buf
, kbuf
, count
)) {
843 static char *chrdev_setup_rx(struct channel_data
*chan
, int size
)
845 /* Expect size <= COSA_MTU */
850 static int chrdev_rx_done(struct channel_data
*chan
)
852 if (chan
->rx_status
) { /* Reader has died */
857 wake_up_interruptible(&chan
->rxwaitq
);
862 static ssize_t
cosa_write(struct file
*file
,
863 const char __user
*buf
, size_t count
, loff_t
*ppos
)
865 DECLARE_WAITQUEUE(wait
, current
);
866 struct channel_data
*chan
= file
->private_data
;
867 struct cosa_data
*cosa
= chan
->cosa
;
871 if (!(cosa
->firmware_status
& COSA_FW_START
)) {
872 printk(KERN_NOTICE
"%s: start the firmware first (status %d)\n",
873 cosa
->name
, cosa
->firmware_status
);
876 if (down_interruptible(&chan
->wsem
))
879 if (count
> COSA_MTU
)
882 /* Allocate the buffer */
883 if ((kbuf
= kmalloc(count
, GFP_KERNEL
|GFP_DMA
)) == NULL
) {
884 printk(KERN_NOTICE
"%s: cosa_write() OOM - dropping packet\n",
889 if (copy_from_user(kbuf
, buf
, count
)) {
895 cosa_start_tx(chan
, kbuf
, count
);
897 spin_lock_irqsave(&cosa
->lock
, flags
);
898 add_wait_queue(&chan
->txwaitq
, &wait
);
899 while (!chan
->tx_status
) {
900 current
->state
= TASK_INTERRUPTIBLE
;
901 spin_unlock_irqrestore(&cosa
->lock
, flags
);
903 spin_lock_irqsave(&cosa
->lock
, flags
);
904 if (signal_pending(current
) && chan
->tx_status
== 0) {
906 remove_wait_queue(&chan
->txwaitq
, &wait
);
907 current
->state
= TASK_RUNNING
;
909 spin_unlock_irqrestore(&cosa
->lock
, flags
);
914 remove_wait_queue(&chan
->txwaitq
, &wait
);
915 current
->state
= TASK_RUNNING
;
917 spin_unlock_irqrestore(&cosa
->lock
, flags
);
922 static int chrdev_tx_done(struct channel_data
*chan
, int size
)
924 if (chan
->tx_status
) { /* Writer was interrupted */
929 wake_up_interruptible(&chan
->txwaitq
);
933 static unsigned int cosa_poll(struct file
*file
, poll_table
*poll
)
935 printk(KERN_INFO
"cosa_poll is here\n");
939 static int cosa_open(struct inode
*inode
, struct file
*file
)
941 struct cosa_data
*cosa
;
942 struct channel_data
*chan
;
947 mutex_lock(&cosa_chardev_mutex
);
948 if ((n
=iminor(file
->f_path
.dentry
->d_inode
)>>CARD_MINOR_BITS
)
955 if ((n
=iminor(file
->f_path
.dentry
->d_inode
)
956 & ((1<<CARD_MINOR_BITS
)-1)) >= cosa
->nchannels
) {
960 chan
= cosa
->chan
+ n
;
962 file
->private_data
= chan
;
964 spin_lock_irqsave(&cosa
->lock
, flags
);
966 if (chan
->usage
< 0) { /* in netdev mode */
967 spin_unlock_irqrestore(&cosa
->lock
, flags
);
974 chan
->tx_done
= chrdev_tx_done
;
975 chan
->setup_rx
= chrdev_setup_rx
;
976 chan
->rx_done
= chrdev_rx_done
;
977 spin_unlock_irqrestore(&cosa
->lock
, flags
);
979 mutex_unlock(&cosa_chardev_mutex
);
983 static int cosa_release(struct inode
*inode
, struct file
*file
)
985 struct channel_data
*channel
= file
->private_data
;
986 struct cosa_data
*cosa
;
989 cosa
= channel
->cosa
;
990 spin_lock_irqsave(&cosa
->lock
, flags
);
993 spin_unlock_irqrestore(&cosa
->lock
, flags
);
997 #ifdef COSA_FASYNC_WORKING
998 static struct fasync_struct
*fasync
[256] = { NULL
, };
1000 /* To be done ... */
1001 static int cosa_fasync(struct inode
*inode
, struct file
*file
, int on
)
1003 int port
= iminor(inode
);
1005 return fasync_helper(inode
, file
, on
, &fasync
[port
]);
1010 /* ---------- Ioctls ---------- */
1013 * Ioctl subroutines can safely be made inline, because they are called
1014 * only from cosa_ioctl().
1016 static inline int cosa_reset(struct cosa_data
*cosa
)
1018 char idstring
[COSA_MAX_ID_STRING
];
1019 if (cosa
->usage
> 1)
1020 printk(KERN_INFO
"cosa%d: WARNING: reset requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1021 cosa
->num
, cosa
->usage
);
1022 cosa
->firmware_status
&= ~(COSA_FW_RESET
|COSA_FW_START
);
1023 if (cosa_reset_and_read_id(cosa
, idstring
) < 0) {
1024 printk(KERN_NOTICE
"cosa%d: reset failed\n", cosa
->num
);
1027 printk(KERN_INFO
"cosa%d: resetting device: %s\n", cosa
->num
,
1029 cosa
->firmware_status
|= COSA_FW_RESET
;
1033 /* High-level function to download data into COSA memory. Calls download() */
1034 static inline int cosa_download(struct cosa_data
*cosa
, void __user
*arg
)
1036 struct cosa_download d
;
1039 if (cosa
->usage
> 1)
1040 printk(KERN_INFO
"%s: WARNING: download of microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1041 cosa
->name
, cosa
->usage
);
1042 if (!(cosa
->firmware_status
& COSA_FW_RESET
)) {
1043 printk(KERN_NOTICE
"%s: reset the card first (status %d).\n",
1044 cosa
->name
, cosa
->firmware_status
);
1048 if (copy_from_user(&d
, arg
, sizeof(d
)))
1051 if (d
.addr
< 0 || d
.addr
> COSA_MAX_FIRMWARE_SIZE
)
1053 if (d
.len
< 0 || d
.len
> COSA_MAX_FIRMWARE_SIZE
)
1057 /* If something fails, force the user to reset the card */
1058 cosa
->firmware_status
&= ~(COSA_FW_RESET
|COSA_FW_DOWNLOAD
);
1060 i
= download(cosa
, d
.code
, d
.len
, d
.addr
);
1062 printk(KERN_NOTICE
"cosa%d: microcode download failed: %d\n",
1066 printk(KERN_INFO
"cosa%d: downloading microcode - 0x%04x bytes at 0x%04x\n",
1067 cosa
->num
, d
.len
, d
.addr
);
1068 cosa
->firmware_status
|= COSA_FW_RESET
|COSA_FW_DOWNLOAD
;
1072 /* High-level function to read COSA memory. Calls readmem() */
1073 static inline int cosa_readmem(struct cosa_data
*cosa
, void __user
*arg
)
1075 struct cosa_download d
;
1078 if (cosa
->usage
> 1)
1079 printk(KERN_INFO
"cosa%d: WARNING: readmem requested with "
1080 "cosa->usage > 1 (%d). Odd things may happen.\n",
1081 cosa
->num
, cosa
->usage
);
1082 if (!(cosa
->firmware_status
& COSA_FW_RESET
)) {
1083 printk(KERN_NOTICE
"%s: reset the card first (status %d).\n",
1084 cosa
->name
, cosa
->firmware_status
);
1088 if (copy_from_user(&d
, arg
, sizeof(d
)))
1091 /* If something fails, force the user to reset the card */
1092 cosa
->firmware_status
&= ~COSA_FW_RESET
;
1094 i
= readmem(cosa
, d
.code
, d
.len
, d
.addr
);
1096 printk(KERN_NOTICE
"cosa%d: reading memory failed: %d\n",
1100 printk(KERN_INFO
"cosa%d: reading card memory - 0x%04x bytes at 0x%04x\n",
1101 cosa
->num
, d
.len
, d
.addr
);
1102 cosa
->firmware_status
|= COSA_FW_RESET
;
1106 /* High-level function to start microcode. Calls startmicrocode(). */
1107 static inline int cosa_start(struct cosa_data
*cosa
, int address
)
1111 if (cosa
->usage
> 1)
1112 printk(KERN_INFO
"cosa%d: WARNING: start microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1113 cosa
->num
, cosa
->usage
);
1115 if ((cosa
->firmware_status
& (COSA_FW_RESET
|COSA_FW_DOWNLOAD
))
1116 != (COSA_FW_RESET
|COSA_FW_DOWNLOAD
)) {
1117 printk(KERN_NOTICE
"%s: download the microcode and/or reset the card first (status %d).\n",
1118 cosa
->name
, cosa
->firmware_status
);
1121 cosa
->firmware_status
&= ~COSA_FW_RESET
;
1122 if ((i
=startmicrocode(cosa
, address
)) < 0) {
1123 printk(KERN_NOTICE
"cosa%d: start microcode at 0x%04x failed: %d\n",
1124 cosa
->num
, address
, i
);
1127 printk(KERN_INFO
"cosa%d: starting microcode at 0x%04x\n",
1128 cosa
->num
, address
);
1129 cosa
->startaddr
= address
;
1130 cosa
->firmware_status
|= COSA_FW_START
;
1134 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1135 static inline int cosa_getidstr(struct cosa_data
*cosa
, char __user
*string
)
1137 int l
= strlen(cosa
->id_string
)+1;
1138 if (copy_to_user(string
, cosa
->id_string
, l
))
1143 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1144 static inline int cosa_gettype(struct cosa_data
*cosa
, char __user
*string
)
1146 int l
= strlen(cosa
->type
)+1;
1147 if (copy_to_user(string
, cosa
->type
, l
))
1152 static int cosa_ioctl_common(struct cosa_data
*cosa
,
1153 struct channel_data
*channel
, unsigned int cmd
, unsigned long arg
)
1155 void __user
*argp
= (void __user
*)arg
;
1157 case COSAIORSET
: /* Reset the device */
1158 if (!capable(CAP_NET_ADMIN
))
1160 return cosa_reset(cosa
);
1161 case COSAIOSTRT
: /* Start the firmware */
1162 if (!capable(CAP_SYS_RAWIO
))
1164 return cosa_start(cosa
, arg
);
1165 case COSAIODOWNLD
: /* Download the firmware */
1166 if (!capable(CAP_SYS_RAWIO
))
1169 return cosa_download(cosa
, argp
);
1171 if (!capable(CAP_SYS_RAWIO
))
1173 return cosa_readmem(cosa
, argp
);
1175 return cosa_gettype(cosa
, argp
);
1177 return cosa_getidstr(cosa
, argp
);
1181 return cosa
->nchannels
;
1183 if (!capable(CAP_SYS_RAWIO
))
1187 if (arg
!= COSA_BM_OFF
&& arg
!= COSA_BM_ON
)
1189 cosa
->busmaster
= arg
;
1192 return cosa
->busmaster
;
1194 return -ENOIOCTLCMD
;
1197 static int cosa_net_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
)
1200 struct channel_data
*chan
= dev_to_chan(dev
);
1201 rv
= cosa_ioctl_common(chan
->cosa
, chan
, cmd
,
1202 (unsigned long)ifr
->ifr_data
);
1203 if (rv
!= -ENOIOCTLCMD
)
1205 return hdlc_ioctl(dev
, ifr
, cmd
);
1208 static long cosa_chardev_ioctl(struct file
*file
, unsigned int cmd
,
1211 struct channel_data
*channel
= file
->private_data
;
1212 struct cosa_data
*cosa
;
1215 mutex_lock(&cosa_chardev_mutex
);
1216 cosa
= channel
->cosa
;
1217 ret
= cosa_ioctl_common(cosa
, channel
, cmd
, arg
);
1218 mutex_unlock(&cosa_chardev_mutex
);
1223 /*---------- HW layer interface ---------- */
1226 * The higher layer can bind itself to the HW layer by setting the callbacks
1227 * in the channel_data structure and by using these routines.
1229 static void cosa_enable_rx(struct channel_data
*chan
)
1231 struct cosa_data
*cosa
= chan
->cosa
;
1233 if (!test_and_set_bit(chan
->num
, &cosa
->rxbitmap
))
1234 put_driver_status(cosa
);
1237 static void cosa_disable_rx(struct channel_data
*chan
)
1239 struct cosa_data
*cosa
= chan
->cosa
;
1241 if (test_and_clear_bit(chan
->num
, &cosa
->rxbitmap
))
1242 put_driver_status(cosa
);
1246 * FIXME: This routine probably should check for cosa_start_tx() called when
1247 * the previous transmit is still unfinished. In this case the non-zero
1248 * return value should indicate to the caller that the queuing(sp?) up
1249 * the transmit has failed.
1251 static int cosa_start_tx(struct channel_data
*chan
, char *buf
, int len
)
1253 struct cosa_data
*cosa
= chan
->cosa
;
1254 unsigned long flags
;
1258 printk(KERN_INFO
"cosa%dc%d: starting tx(0x%x)", chan
->cosa
->num
,
1260 for (i
=0; i
<len
; i
++)
1261 printk(" %02x", buf
[i
]&0xff);
1264 spin_lock_irqsave(&cosa
->lock
, flags
);
1268 chan
->txsize
= COSA_MTU
;
1269 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1271 /* Tell the firmware we are ready */
1272 set_bit(chan
->num
, &cosa
->txbitmap
);
1273 put_driver_status(cosa
);
1278 static void put_driver_status(struct cosa_data
*cosa
)
1280 unsigned long flags
;
1283 spin_lock_irqsave(&cosa
->lock
, flags
);
1285 status
= (cosa
->rxbitmap
? DRIVER_RX_READY
: 0)
1286 | (cosa
->txbitmap
? DRIVER_TX_READY
: 0)
1287 | (cosa
->txbitmap
? ~(cosa
->txbitmap
<<DRIVER_TXMAP_SHIFT
)
1288 &DRIVER_TXMAP_MASK
: 0);
1290 if (cosa
->rxbitmap
|cosa
->txbitmap
) {
1291 if (!cosa
->enabled
) {
1292 cosa_putstatus(cosa
, SR_RX_INT_ENA
);
1294 debug_status_out(cosa
, SR_RX_INT_ENA
);
1298 } else if (cosa
->enabled
) {
1300 cosa_putstatus(cosa
, 0);
1302 debug_status_out(cosa
, 0);
1305 cosa_putdata8(cosa
, status
);
1307 debug_data_cmd(cosa
, status
);
1310 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1313 static void put_driver_status_nolock(struct cosa_data
*cosa
)
1317 status
= (cosa
->rxbitmap
? DRIVER_RX_READY
: 0)
1318 | (cosa
->txbitmap
? DRIVER_TX_READY
: 0)
1319 | (cosa
->txbitmap
? ~(cosa
->txbitmap
<<DRIVER_TXMAP_SHIFT
)
1320 &DRIVER_TXMAP_MASK
: 0);
1322 if (cosa
->rxbitmap
|cosa
->txbitmap
) {
1323 cosa_putstatus(cosa
, SR_RX_INT_ENA
);
1325 debug_status_out(cosa
, SR_RX_INT_ENA
);
1329 cosa_putstatus(cosa
, 0);
1331 debug_status_out(cosa
, 0);
1335 cosa_putdata8(cosa
, status
);
1337 debug_data_cmd(cosa
, status
);
1342 * The "kickme" function: When the DMA times out, this is called to
1343 * clean up the driver status.
1344 * FIXME: Preliminary support, the interface is probably wrong.
1346 static void cosa_kick(struct cosa_data
*cosa
)
1348 unsigned long flags
, flags1
;
1349 char *s
= "(probably) IRQ";
1351 if (test_bit(RXBIT
, &cosa
->rxtx
))
1353 if (test_bit(TXBIT
, &cosa
->rxtx
))
1356 printk(KERN_INFO
"%s: %s timeout - restarting.\n", cosa
->name
, s
);
1357 spin_lock_irqsave(&cosa
->lock
, flags
);
1360 flags1
= claim_dma_lock();
1361 disable_dma(cosa
->dma
);
1362 clear_dma_ff(cosa
->dma
);
1363 release_dma_lock(flags1
);
1365 /* FIXME: Anything else? */
1367 cosa_putstatus(cosa
, 0);
1369 (void) cosa_getdata8(cosa
);
1371 cosa_putdata8(cosa
, 0);
1373 put_driver_status_nolock(cosa
);
1374 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1378 * Check if the whole buffer is DMA-able. It means it is below the 16M of
1379 * physical memory and doesn't span the 64k boundary. For now it seems
1380 * SKB's never do this, but we'll check this anyway.
1382 static int cosa_dma_able(struct channel_data
*chan
, char *buf
, int len
)
1385 unsigned long b
= (unsigned long)buf
;
1386 if (b
+len
>= MAX_DMA_ADDRESS
)
1388 if ((b
^ (b
+len
)) & 0x10000) {
1390 printk(KERN_INFO
"%s: packet spanning a 64k boundary\n",
1398 /* ---------- The SRP/COSA ROM monitor functions ---------- */
1401 * Downloading SRP microcode: say "w" to SRP monitor, it answers by "w=",
1402 * drivers need to say 4-digit hex number meaning start address of the microcode
1403 * separated by a single space. Monitor replies by saying " =". Now driver
1404 * has to write 4-digit hex number meaning the last byte address ended
1405 * by a single space. Monitor has to reply with a space. Now the download
1406 * begins. After the download monitor replies with "\r\n." (CR LF dot).
1408 static int download(struct cosa_data
*cosa
, const char __user
*microcode
, int length
, int address
)
1412 if (put_wait_data(cosa
, 'w') == -1) return -1;
1413 if ((i
=get_wait_data(cosa
)) != 'w') { printk("dnld: 0x%04x\n",i
); return -2;}
1414 if (get_wait_data(cosa
) != '=') return -3;
1416 if (puthexnumber(cosa
, address
) < 0) return -4;
1417 if (put_wait_data(cosa
, ' ') == -1) return -10;
1418 if (get_wait_data(cosa
) != ' ') return -11;
1419 if (get_wait_data(cosa
) != '=') return -12;
1421 if (puthexnumber(cosa
, address
+length
-1) < 0) return -13;
1422 if (put_wait_data(cosa
, ' ') == -1) return -18;
1423 if (get_wait_data(cosa
) != ' ') return -19;
1427 #ifndef SRP_DOWNLOAD_AT_BOOT
1428 if (get_user(c
, microcode
))
1429 return -23; /* ??? */
1433 if (put_wait_data(cosa
, c
) == -1)
1438 if (get_wait_data(cosa
) != '\r') return -21;
1439 if (get_wait_data(cosa
) != '\n') return -22;
1440 if (get_wait_data(cosa
) != '.') return -23;
1442 printk(KERN_DEBUG
"cosa%d: download completed.\n", cosa
->num
);
1449 * Starting microcode is done via the "g" command of the SRP monitor.
1450 * The chat should be the following: "g" "g=" "<addr><CR>"
1451 * "<CR><CR><LF><CR><LF>".
1453 static int startmicrocode(struct cosa_data
*cosa
, int address
)
1455 if (put_wait_data(cosa
, 'g') == -1) return -1;
1456 if (get_wait_data(cosa
) != 'g') return -2;
1457 if (get_wait_data(cosa
) != '=') return -3;
1459 if (puthexnumber(cosa
, address
) < 0) return -4;
1460 if (put_wait_data(cosa
, '\r') == -1) return -5;
1462 if (get_wait_data(cosa
) != '\r') return -6;
1463 if (get_wait_data(cosa
) != '\r') return -7;
1464 if (get_wait_data(cosa
) != '\n') return -8;
1465 if (get_wait_data(cosa
) != '\r') return -9;
1466 if (get_wait_data(cosa
) != '\n') return -10;
1468 printk(KERN_DEBUG
"cosa%d: microcode started\n", cosa
->num
);
1474 * Reading memory is done via the "r" command of the SRP monitor.
1475 * The chat is the following "r" "r=" "<addr> " " =" "<last_byte> " " "
1476 * Then driver can read the data and the conversation is finished
1477 * by SRP monitor sending "<CR><LF>." (dot at the end).
1479 * This routine is not needed during the normal operation and serves
1480 * for debugging purposes only.
1482 static int readmem(struct cosa_data
*cosa
, char __user
*microcode
, int length
, int address
)
1484 if (put_wait_data(cosa
, 'r') == -1) return -1;
1485 if ((get_wait_data(cosa
)) != 'r') return -2;
1486 if ((get_wait_data(cosa
)) != '=') return -3;
1488 if (puthexnumber(cosa
, address
) < 0) return -4;
1489 if (put_wait_data(cosa
, ' ') == -1) return -5;
1490 if (get_wait_data(cosa
) != ' ') return -6;
1491 if (get_wait_data(cosa
) != '=') return -7;
1493 if (puthexnumber(cosa
, address
+length
-1) < 0) return -8;
1494 if (put_wait_data(cosa
, ' ') == -1) return -9;
1495 if (get_wait_data(cosa
) != ' ') return -10;
1500 if ((i
=get_wait_data(cosa
)) == -1) {
1501 printk (KERN_INFO
"cosa: 0x%04x bytes remaining\n",
1507 if (put_user(c
, microcode
))
1508 return -23; /* ??? */
1515 if (get_wait_data(cosa
) != '\r') return -21;
1516 if (get_wait_data(cosa
) != '\n') return -22;
1517 if (get_wait_data(cosa
) != '.') return -23;
1519 printk(KERN_DEBUG
"cosa%d: readmem completed.\n", cosa
->num
);
1525 * This function resets the device and reads the initial prompt
1526 * of the device's ROM monitor.
1528 static int cosa_reset_and_read_id(struct cosa_data
*cosa
, char *idstring
)
1530 int i
=0, id
=0, prev
=0, curr
=0;
1532 /* Reset the card ... */
1533 cosa_putstatus(cosa
, 0);
1534 cosa_getdata8(cosa
);
1535 cosa_putstatus(cosa
, SR_RST
);
1541 /* Disable all IRQs from the card */
1542 cosa_putstatus(cosa
, 0);
1545 * Try to read the ID string. The card then prints out the
1546 * identification string ended by the "\n\x2e".
1548 * The following loop is indexed through i (instead of id)
1549 * to avoid looping forever when for any reason
1550 * the port returns '\r', '\n' or '\x2e' permanently.
1552 for (i
=0; i
<COSA_MAX_ID_STRING
-1; i
++, prev
=curr
) {
1553 if ((curr
= get_wait_data(cosa
)) == -1) {
1557 if (curr
!= '\r' && curr
!= '\n' && curr
!= 0x2e)
1558 idstring
[id
++] = curr
;
1559 if (curr
== 0x2e && prev
== '\n')
1562 /* Perhaps we should fail when i==COSA_MAX_ID_STRING-1 ? */
1563 idstring
[id
] = '\0';
1568 /* ---------- Auxiliary routines for COSA/SRP monitor ---------- */
1571 * This routine gets the data byte from the card waiting for the SR_RX_RDY
1572 * bit to be set in a loop. It should be used in the exceptional cases
1573 * only (for example when resetting the card or downloading the firmware.
1575 static int get_wait_data(struct cosa_data
*cosa
)
1580 /* read data and return them */
1581 if (cosa_getstatus(cosa
) & SR_RX_RDY
) {
1583 r
= cosa_getdata8(cosa
);
1585 printk(KERN_INFO
"cosa: get_wait_data returning after %d retries\n", 999-retries
);
1589 /* sleep if not ready to read */
1590 schedule_timeout_interruptible(1);
1592 printk(KERN_INFO
"cosa: timeout in get_wait_data (status 0x%x)\n",
1593 cosa_getstatus(cosa
));
1598 * This routine puts the data byte to the card waiting for the SR_TX_RDY
1599 * bit to be set in a loop. It should be used in the exceptional cases
1600 * only (for example when resetting the card or downloading the firmware).
1602 static int put_wait_data(struct cosa_data
*cosa
, int data
)
1606 /* read data and return them */
1607 if (cosa_getstatus(cosa
) & SR_TX_RDY
) {
1608 cosa_putdata8(cosa
, data
);
1610 printk(KERN_INFO
"Putdata: %d retries\n", 999-retries
);
1615 /* sleep if not ready to read */
1616 schedule_timeout_interruptible(1);
1619 printk(KERN_INFO
"cosa%d: timeout in put_wait_data (status 0x%x)\n",
1620 cosa
->num
, cosa_getstatus(cosa
));
1625 * The following routine puts the hexadecimal number into the SRP monitor
1626 * and verifies the proper echo of the sent bytes. Returns 0 on success,
1627 * negative number on failure (-1,-3,-5,-7) means that put_wait_data() failed,
1628 * (-2,-4,-6,-8) means that reading echo failed.
1630 static int puthexnumber(struct cosa_data
*cosa
, int number
)
1635 /* Well, I should probably replace this by something faster. */
1636 sprintf(temp
, "%04X", number
);
1637 for (i
=0; i
<4; i
++) {
1638 if (put_wait_data(cosa
, temp
[i
]) == -1) {
1639 printk(KERN_NOTICE
"cosa%d: puthexnumber failed to write byte %d\n",
1643 if (get_wait_data(cosa
) != temp
[i
]) {
1644 printk(KERN_NOTICE
"cosa%d: puthexhumber failed to read echo of byte %d\n",
1653 /* ---------- Interrupt routines ---------- */
1656 * There are three types of interrupt:
1657 * At the beginning of transmit - this handled is in tx_interrupt(),
1658 * at the beginning of receive - it is in rx_interrupt() and
1659 * at the end of transmit/receive - it is the eot_interrupt() function.
1660 * These functions are multiplexed by cosa_interrupt() according to the
1661 * COSA status byte. I have moved the rx/tx/eot interrupt handling into
1662 * separate functions to make it more readable. These functions are inline,
1663 * so there should be no overhead of function call.
1665 * In the COSA bus-master mode, we need to tell the card the address of a
1666 * buffer. Unfortunately, COSA may be too slow for us, so we must busy-wait.
1667 * It's time to use the bottom half :-(
1671 * Transmit interrupt routine - called when COSA is willing to obtain
1672 * data from the OS. The most tricky part of the routine is selection
1673 * of channel we (OS) want to send packet for. For SRP we should probably
1674 * use the round-robin approach. The newer COSA firmwares have a simple
1675 * flow-control - in the status word has bits 2 and 3 set to 1 means that the
1676 * channel 0 or 1 doesn't want to receive data.
1678 * It seems there is a bug in COSA firmware (need to trace it further):
1679 * When the driver status says that the kernel has no more data for transmit
1680 * (e.g. at the end of TX DMA) and then the kernel changes its mind
1681 * (e.g. new packet is queued to hard_start_xmit()), the card issues
1682 * the TX interrupt but does not mark the channel as ready-to-transmit.
1683 * The fix seems to be to push the packet to COSA despite its request.
1684 * We first try to obey the card's opinion, and then fall back to forced TX.
1686 static inline void tx_interrupt(struct cosa_data
*cosa
, int status
)
1688 unsigned long flags
, flags1
;
1690 printk(KERN_INFO
"cosa%d: SR_DOWN_REQUEST status=0x%04x\n",
1693 spin_lock_irqsave(&cosa
->lock
, flags
);
1694 set_bit(TXBIT
, &cosa
->rxtx
);
1695 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1696 /* flow control, see the comment above */
1698 if (!cosa
->txbitmap
) {
1699 printk(KERN_WARNING
"%s: No channel wants data "
1700 "in TX IRQ. Expect DMA timeout.",
1702 put_driver_status_nolock(cosa
);
1703 clear_bit(TXBIT
, &cosa
->rxtx
);
1704 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1710 if (cosa
->txchan
>= cosa
->nchannels
)
1712 if (!(cosa
->txbitmap
& (1<<cosa
->txchan
)))
1714 if (~status
& (1 << (cosa
->txchan
+DRIVER_TXMAP_SHIFT
)))
1716 /* in second pass, accept first ready-to-TX channel */
1717 if (i
> cosa
->nchannels
) {
1718 /* Can be safely ignored */
1720 printk(KERN_DEBUG
"%s: Forcing TX "
1721 "to not-ready channel %d\n",
1722 cosa
->name
, cosa
->txchan
);
1728 cosa
->txsize
= cosa
->chan
[cosa
->txchan
].txsize
;
1729 if (cosa_dma_able(cosa
->chan
+cosa
->txchan
,
1730 cosa
->chan
[cosa
->txchan
].txbuf
, cosa
->txsize
)) {
1731 cosa
->txbuf
= cosa
->chan
[cosa
->txchan
].txbuf
;
1733 memcpy(cosa
->bouncebuf
, cosa
->chan
[cosa
->txchan
].txbuf
,
1735 cosa
->txbuf
= cosa
->bouncebuf
;
1739 if (is_8bit(cosa
)) {
1740 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1741 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
1742 cosa_putdata8(cosa
, ((cosa
->txchan
<< 5) & 0xe0)|
1743 ((cosa
->txsize
>> 8) & 0x1f));
1745 debug_status_out(cosa
, SR_TX_INT_ENA
);
1746 debug_data_out(cosa
, ((cosa
->txchan
<< 5) & 0xe0)|
1747 ((cosa
->txsize
>> 8) & 0x1f));
1748 debug_data_in(cosa
, cosa_getdata8(cosa
));
1750 cosa_getdata8(cosa
);
1752 set_bit(IRQBIT
, &cosa
->rxtx
);
1753 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1756 clear_bit(IRQBIT
, &cosa
->rxtx
);
1757 cosa_putstatus(cosa
, 0);
1758 cosa_putdata8(cosa
, cosa
->txsize
&0xff);
1760 debug_status_out(cosa
, 0);
1761 debug_data_out(cosa
, cosa
->txsize
&0xff);
1765 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
1766 cosa_putdata16(cosa
, ((cosa
->txchan
<<13) & 0xe000)
1767 | (cosa
->txsize
& 0x1fff));
1769 debug_status_out(cosa
, SR_TX_INT_ENA
);
1770 debug_data_out(cosa
, ((cosa
->txchan
<<13) & 0xe000)
1771 | (cosa
->txsize
& 0x1fff));
1772 debug_data_in(cosa
, cosa_getdata8(cosa
));
1773 debug_status_out(cosa
, 0);
1775 cosa_getdata8(cosa
);
1777 cosa_putstatus(cosa
, 0);
1780 if (cosa
->busmaster
) {
1781 unsigned long addr
= virt_to_bus(cosa
->txbuf
);
1783 printk(KERN_INFO
"busmaster IRQ\n");
1784 while (!(cosa_getstatus(cosa
)&SR_TX_RDY
)) {
1787 if (count
> 1000) break;
1789 printk(KERN_INFO
"status %x\n", cosa_getstatus(cosa
));
1790 printk(KERN_INFO
"ready after %d loops\n", count
);
1791 cosa_putdata16(cosa
, (addr
>> 16)&0xffff);
1794 while (!(cosa_getstatus(cosa
)&SR_TX_RDY
)) {
1796 if (count
> 1000) break;
1799 printk(KERN_INFO
"ready after %d loops\n", count
);
1800 cosa_putdata16(cosa
, addr
&0xffff);
1801 flags1
= claim_dma_lock();
1802 set_dma_mode(cosa
->dma
, DMA_MODE_CASCADE
);
1803 enable_dma(cosa
->dma
);
1804 release_dma_lock(flags1
);
1807 flags1
= claim_dma_lock();
1808 disable_dma(cosa
->dma
);
1809 clear_dma_ff(cosa
->dma
);
1810 set_dma_mode(cosa
->dma
, DMA_MODE_WRITE
);
1811 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->txbuf
));
1812 set_dma_count(cosa
->dma
, cosa
->txsize
);
1813 enable_dma(cosa
->dma
);
1814 release_dma_lock(flags1
);
1816 cosa_putstatus(cosa
, SR_TX_DMA_ENA
|SR_USR_INT_ENA
);
1818 debug_status_out(cosa
, SR_TX_DMA_ENA
|SR_USR_INT_ENA
);
1820 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1823 static inline void rx_interrupt(struct cosa_data
*cosa
, int status
)
1825 unsigned long flags
;
1827 printk(KERN_INFO
"cosa%d: SR_UP_REQUEST\n", cosa
->num
);
1830 spin_lock_irqsave(&cosa
->lock
, flags
);
1831 set_bit(RXBIT
, &cosa
->rxtx
);
1833 if (is_8bit(cosa
)) {
1834 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1835 set_bit(IRQBIT
, &cosa
->rxtx
);
1836 put_driver_status_nolock(cosa
);
1837 cosa
->rxsize
= cosa_getdata8(cosa
) <<8;
1839 debug_data_in(cosa
, cosa
->rxsize
>> 8);
1841 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1844 clear_bit(IRQBIT
, &cosa
->rxtx
);
1845 cosa
->rxsize
|= cosa_getdata8(cosa
) & 0xff;
1847 debug_data_in(cosa
, cosa
->rxsize
& 0xff);
1850 printk(KERN_INFO
"cosa%d: receive rxsize = (0x%04x).\n",
1851 cosa
->num
, cosa
->rxsize
);
1855 cosa
->rxsize
= cosa_getdata16(cosa
);
1857 debug_data_in(cosa
, cosa
->rxsize
);
1860 printk(KERN_INFO
"cosa%d: receive rxsize = (0x%04x).\n",
1861 cosa
->num
, cosa
->rxsize
);
1864 if (((cosa
->rxsize
& 0xe000) >> 13) >= cosa
->nchannels
) {
1865 printk(KERN_WARNING
"%s: rx for unknown channel (0x%04x)\n",
1866 cosa
->name
, cosa
->rxsize
);
1867 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1870 cosa
->rxchan
= cosa
->chan
+ ((cosa
->rxsize
& 0xe000) >> 13);
1871 cosa
->rxsize
&= 0x1fff;
1872 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1875 if (cosa
->rxchan
->setup_rx
)
1876 cosa
->rxbuf
= cosa
->rxchan
->setup_rx(cosa
->rxchan
, cosa
->rxsize
);
1879 reject
: /* Reject the packet */
1880 printk(KERN_INFO
"cosa%d: rejecting packet on channel %d\n",
1881 cosa
->num
, cosa
->rxchan
->num
);
1882 cosa
->rxbuf
= cosa
->bouncebuf
;
1886 flags
= claim_dma_lock();
1887 disable_dma(cosa
->dma
);
1888 clear_dma_ff(cosa
->dma
);
1889 set_dma_mode(cosa
->dma
, DMA_MODE_READ
);
1890 if (cosa_dma_able(cosa
->rxchan
, cosa
->rxbuf
, cosa
->rxsize
& 0x1fff)) {
1891 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->rxbuf
));
1893 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->bouncebuf
));
1895 set_dma_count(cosa
->dma
, (cosa
->rxsize
&0x1fff));
1896 enable_dma(cosa
->dma
);
1897 release_dma_lock(flags
);
1898 spin_lock_irqsave(&cosa
->lock
, flags
);
1899 cosa_putstatus(cosa
, SR_RX_DMA_ENA
|SR_USR_INT_ENA
);
1900 if (!is_8bit(cosa
) && (status
& SR_TX_RDY
))
1901 cosa_putdata8(cosa
, DRIVER_RX_READY
);
1903 debug_status_out(cosa
, SR_RX_DMA_ENA
|SR_USR_INT_ENA
);
1904 if (!is_8bit(cosa
) && (status
& SR_TX_RDY
))
1905 debug_data_cmd(cosa
, DRIVER_RX_READY
);
1907 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1910 static inline void eot_interrupt(struct cosa_data
*cosa
, int status
)
1912 unsigned long flags
, flags1
;
1913 spin_lock_irqsave(&cosa
->lock
, flags
);
1914 flags1
= claim_dma_lock();
1915 disable_dma(cosa
->dma
);
1916 clear_dma_ff(cosa
->dma
);
1917 release_dma_lock(flags1
);
1918 if (test_bit(TXBIT
, &cosa
->rxtx
)) {
1919 struct channel_data
*chan
= cosa
->chan
+cosa
->txchan
;
1921 if (chan
->tx_done(chan
, cosa
->txsize
))
1922 clear_bit(chan
->num
, &cosa
->txbitmap
);
1923 } else if (test_bit(RXBIT
, &cosa
->rxtx
)) {
1927 printk(KERN_INFO
"cosa%dc%d: done rx(0x%x)", cosa
->num
,
1928 cosa
->rxchan
->num
, cosa
->rxsize
);
1929 for (i
=0; i
<cosa
->rxsize
; i
++)
1930 printk (" %02x", cosa
->rxbuf
[i
]&0xff);
1934 /* Packet for unknown channel? */
1935 if (cosa
->rxbuf
== cosa
->bouncebuf
)
1937 if (!cosa_dma_able(cosa
->rxchan
, cosa
->rxbuf
, cosa
->rxsize
))
1938 memcpy(cosa
->rxbuf
, cosa
->bouncebuf
, cosa
->rxsize
);
1939 if (cosa
->rxchan
->rx_done
)
1940 if (cosa
->rxchan
->rx_done(cosa
->rxchan
))
1941 clear_bit(cosa
->rxchan
->num
, &cosa
->rxbitmap
);
1943 printk(KERN_NOTICE
"cosa%d: unexpected EOT interrupt\n",
1947 * Clear the RXBIT, TXBIT and IRQBIT (the latest should be
1948 * cleared anyway). We should do it as soon as possible
1949 * so that we can tell the COSA we are done and to give it a time
1954 put_driver_status_nolock(cosa
);
1955 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1958 static irqreturn_t
cosa_interrupt(int irq
, void *cosa_
)
1962 struct cosa_data
*cosa
= cosa_
;
1964 status
= cosa_getstatus(cosa
);
1966 printk(KERN_INFO
"cosa%d: got IRQ, status 0x%02x\n", cosa
->num
,
1970 debug_status_in(cosa
, status
);
1972 switch (status
& SR_CMD_FROM_SRP_MASK
) {
1973 case SR_DOWN_REQUEST
:
1974 tx_interrupt(cosa
, status
);
1977 rx_interrupt(cosa
, status
);
1979 case SR_END_OF_TRANSFER
:
1980 eot_interrupt(cosa
, status
);
1983 /* We may be too fast for SRP. Try to wait a bit more. */
1984 if (count
++ < 100) {
1988 printk(KERN_INFO
"cosa%d: unknown status 0x%02x in IRQ after %d retries\n",
1989 cosa
->num
, status
& 0xff, count
);
1993 printk(KERN_INFO
"%s: %d-times got unknown status in IRQ\n",
1996 printk(KERN_INFO
"%s: returning from IRQ\n", cosa
->name
);
2002 /* ---------- I/O debugging routines ---------- */
2004 * These routines can be used to monitor COSA/SRP I/O and to printk()
2005 * the data being transferred on the data and status I/O port in a
2010 static void debug_status_in(struct cosa_data
*cosa
, int status
)
2013 switch (status
& SR_CMD_FROM_SRP_MASK
) {
2017 case SR_DOWN_REQUEST
:
2020 case SR_END_OF_TRANSFER
:
2027 printk(KERN_INFO
"%s: IO: status -> 0x%02x (%s%s%s%s)\n",
2030 status
& SR_USR_RQ
? "USR_RQ|":"",
2031 status
& SR_TX_RDY
? "TX_RDY|":"",
2032 status
& SR_RX_RDY
? "RX_RDY|":"",
2036 static void debug_status_out(struct cosa_data
*cosa
, int status
)
2038 printk(KERN_INFO
"%s: IO: status <- 0x%02x (%s%s%s%s%s%s)\n",
2041 status
& SR_RX_DMA_ENA
? "RXDMA|":"!rxdma|",
2042 status
& SR_TX_DMA_ENA
? "TXDMA|":"!txdma|",
2043 status
& SR_RST
? "RESET|":"",
2044 status
& SR_USR_INT_ENA
? "USRINT|":"!usrint|",
2045 status
& SR_TX_INT_ENA
? "TXINT|":"!txint|",
2046 status
& SR_RX_INT_ENA
? "RXINT":"!rxint");
2049 static void debug_data_in(struct cosa_data
*cosa
, int data
)
2051 printk(KERN_INFO
"%s: IO: data -> 0x%04x\n", cosa
->name
, data
);
2054 static void debug_data_out(struct cosa_data
*cosa
, int data
)
2056 printk(KERN_INFO
"%s: IO: data <- 0x%04x\n", cosa
->name
, data
);
2059 static void debug_data_cmd(struct cosa_data
*cosa
, int data
)
2061 printk(KERN_INFO
"%s: IO: data <- 0x%04x (%s|%s)\n",
2063 data
& SR_RDY_RCV
? "RX_RDY" : "!rx_rdy",
2064 data
& SR_RDY_SND
? "TX_RDY" : "!tx_rdy");
2068 /* EOF -- this file has not been truncated */