1 /* $Id: cosa.c,v 1.31 2000/03/08 17:47:16 kas Exp $ */
4 * Copyright (C) 1995-1997 Jan "Yenya" Kasprzak <kas@fi.muni.cz>
5 * Generic HDLC port Copyright (C) 2008 Krzysztof Halasa <khc@pm.waw.pl>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * The driver for the SRP and COSA synchronous serial cards.
27 * Both cards are developed at the Institute of Computer Science,
28 * Masaryk University (http://www.ics.muni.cz/). The hardware is
29 * developed by Jiri Novotny <novotny@ics.muni.cz>. More information
30 * and the photo of both cards is available at
31 * http://www.pavoucek.cz/cosa.html. The card documentation, firmwares
32 * and other goods can be downloaded from ftp://ftp.ics.muni.cz/pub/cosa/.
33 * For Linux-specific utilities, see below in the "Software info" section.
34 * If you want to order the card, contact Jiri Novotny.
36 * The SRP (serial port?, the Czech word "srp" means "sickle") card
37 * is a 2-port intelligent (with its own 8-bit CPU) synchronous serial card
38 * with V.24 interfaces up to 80kb/s each.
40 * The COSA (communication serial adapter?, the Czech word "kosa" means
41 * "scythe") is a next-generation sync/async board with two interfaces
42 * - currently any of V.24, X.21, V.35 and V.36 can be selected.
43 * It has a 16-bit SAB80166 CPU and can do up to 10 Mb/s per channel.
44 * The 8-channels version is in development.
46 * Both types have downloadable firmware and communicate via ISA DMA.
47 * COSA can be also a bus-mastering device.
51 * The homepage of the Linux driver is at http://www.fi.muni.cz/~kas/cosa/.
52 * The CVS tree of Linux driver can be viewed there, as well as the
53 * firmware binaries and user-space utilities for downloading the firmware
54 * into the card and setting up the card.
56 * The Linux driver (unlike the present *BSD drivers :-) can work even
57 * for the COSA and SRP in one computer and allows each channel to work
58 * in one of the two modes (character or network device).
62 * The Linux driver was written by Jan "Yenya" Kasprzak <kas@fi.muni.cz>.
64 * You can mail me bugfixes and even success reports. I am especially
65 * interested in the SMP and/or muliti-channel success/failure reports
66 * (I wonder if I did the locking properly :-).
68 * THE AUTHOR USED THE FOLLOWING SOURCES WHEN PROGRAMMING THE DRIVER
70 * The COSA/SRP NetBSD driver by Zdenek Salvet and Ivos Cernohlavek
71 * The skeleton.c by Donald Becker
72 * The SDL Riscom/N2 driver by Mike Natale
73 * The Comtrol Hostess SV11 driver by Alan Cox
74 * The Sync PPP/Cisco HDLC layer (syncppp.c) ported to Linux by Alan Cox
77 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
79 #include <linux/module.h>
80 #include <linux/kernel.h>
81 #include <linux/sched.h>
82 #include <linux/slab.h>
83 #include <linux/poll.h>
85 #include <linux/interrupt.h>
86 #include <linux/delay.h>
87 #include <linux/hdlc.h>
88 #include <linux/errno.h>
89 #include <linux/ioport.h>
90 #include <linux/netdevice.h>
91 #include <linux/spinlock.h>
92 #include <linux/mutex.h>
93 #include <linux/device.h>
96 #include <asm/byteorder.h>
98 #undef COSA_SLOW_IO /* for testing purposes only */
102 /* Maximum length of the identification string. */
103 #define COSA_MAX_ID_STRING 128
105 /* Maximum length of the channel name */
106 #define COSA_MAX_NAME (sizeof("cosaXXXcXXX")+1)
108 /* Per-channel data structure */
110 struct channel_data
{
111 int usage
; /* Usage count; >0 for chrdev, -1 for netdev */
112 int num
; /* Number of the channel */
113 struct cosa_data
*cosa
; /* Pointer to the per-card structure */
114 int txsize
; /* Size of transmitted data */
115 char *txbuf
; /* Transmit buffer */
116 char name
[COSA_MAX_NAME
]; /* channel name */
118 /* The HW layer interface */
119 /* routine called from the RX interrupt */
120 char *(*setup_rx
)(struct channel_data
*channel
, int size
);
121 /* routine called when the RX is done (from the EOT interrupt) */
122 int (*rx_done
)(struct channel_data
*channel
);
123 /* routine called when the TX is done (from the EOT interrupt) */
124 int (*tx_done
)(struct channel_data
*channel
, int size
);
126 /* Character device parts */
128 struct semaphore wsem
;
131 wait_queue_head_t txwaitq
, rxwaitq
;
132 int tx_status
, rx_status
;
134 /* generic HDLC device parts */
135 struct net_device
*netdev
;
136 struct sk_buff
*rx_skb
, *tx_skb
;
139 /* cosa->firmware_status bits */
140 #define COSA_FW_RESET (1<<0) /* Is the ROM monitor active? */
141 #define COSA_FW_DOWNLOAD (1<<1) /* Is the microcode downloaded? */
142 #define COSA_FW_START (1<<2) /* Is the microcode running? */
145 int num
; /* Card number */
146 char name
[COSA_MAX_NAME
]; /* Card name - e.g "cosa0" */
147 unsigned int datareg
, statusreg
; /* I/O ports */
148 unsigned short irq
, dma
; /* IRQ and DMA number */
149 unsigned short startaddr
; /* Firmware start address */
150 unsigned short busmaster
; /* Use busmastering? */
151 int nchannels
; /* # of channels on this card */
152 int driver_status
; /* For communicating with firmware */
153 int firmware_status
; /* Downloaded, reseted, etc. */
154 unsigned long rxbitmap
, txbitmap
;/* Bitmap of channels who are willing to send/receive data */
155 unsigned long rxtx
; /* RX or TX in progress? */
157 int usage
; /* usage count */
158 int txchan
, txsize
, rxsize
;
159 struct channel_data
*rxchan
;
162 struct channel_data
*chan
;
163 spinlock_t lock
; /* For exclusive operations on this structure */
164 char id_string
[COSA_MAX_ID_STRING
]; /* ROM monitor ID string */
165 char *type
; /* card type */
169 * Define this if you want all the possible ports to be autoprobed.
170 * It is here but it probably is not a good idea to use this.
172 /* #define COSA_ISA_AUTOPROBE 1 */
175 * Character device major number. 117 was allocated for us.
176 * The value of 0 means to allocate a first free one.
178 static DEFINE_MUTEX(cosa_chardev_mutex
);
179 static int cosa_major
= 117;
182 * Encoding of the minor numbers:
183 * The lowest CARD_MINOR_BITS bits means the channel on the single card,
184 * the highest bits means the card number.
186 #define CARD_MINOR_BITS 4 /* How many bits in minor number are reserved
187 * for the single card */
189 * The following depends on CARD_MINOR_BITS. Unfortunately, the "MODULE_STRING"
190 * macro doesn't like anything other than the raw number as an argument :-(
193 /* #define MAX_CARDS (1 << (8-CARD_MINOR_BITS)) */
195 #define DRIVER_RX_READY 0x0001
196 #define DRIVER_TX_READY 0x0002
197 #define DRIVER_TXMAP_SHIFT 2
198 #define DRIVER_TXMAP_MASK 0x0c /* FIXME: 0xfc for 8-channel version */
201 * for cosa->rxtx - indicates whether either transmit or receive is
202 * in progress. These values are mean number of the bit.
208 #define COSA_MTU 2000 /* FIXME: I don't know this exactly */
210 #undef DEBUG_DATA //1 /* Dump the data read or written to the channel */
211 #undef DEBUG_IRQS //1 /* Print the message when the IRQ is received */
212 #undef DEBUG_IO //1 /* Dump the I/O traffic */
214 #define TX_TIMEOUT (5*HZ)
216 /* Maybe the following should be allocated dynamically */
217 static struct cosa_data cosa_cards
[MAX_CARDS
];
220 #ifdef COSA_ISA_AUTOPROBE
221 static int io
[MAX_CARDS
+1] = { 0x220, 0x228, 0x210, 0x218, 0, };
222 /* NOTE: DMA is not autoprobed!!! */
223 static int dma
[MAX_CARDS
+1] = { 1, 7, 1, 7, 1, 7, 1, 7, 0, };
225 static int io
[MAX_CARDS
+1];
226 static int dma
[MAX_CARDS
+1];
228 /* IRQ can be safely autoprobed */
229 static int irq
[MAX_CARDS
+1] = { -1, -1, -1, -1, -1, -1, 0, };
232 static struct class *cosa_class
;
235 module_param_array(io
, int, NULL
, 0);
236 MODULE_PARM_DESC(io
, "The I/O bases of the COSA or SRP cards");
237 module_param_array(irq
, int, NULL
, 0);
238 MODULE_PARM_DESC(irq
, "The IRQ lines of the COSA or SRP cards");
239 module_param_array(dma
, int, NULL
, 0);
240 MODULE_PARM_DESC(dma
, "The DMA channels of the COSA or SRP cards");
242 MODULE_AUTHOR("Jan \"Yenya\" Kasprzak, <kas@fi.muni.cz>");
243 MODULE_DESCRIPTION("Modular driver for the COSA or SRP synchronous card");
244 MODULE_LICENSE("GPL");
247 /* I use this mainly for testing purposes */
249 #define cosa_outb outb_p
250 #define cosa_outw outw_p
251 #define cosa_inb inb_p
252 #define cosa_inw inw_p
254 #define cosa_outb outb
255 #define cosa_outw outw
260 #define is_8bit(cosa) (!(cosa->datareg & 0x08))
262 #define cosa_getstatus(cosa) (cosa_inb(cosa->statusreg))
263 #define cosa_putstatus(cosa, stat) (cosa_outb(stat, cosa->statusreg))
264 #define cosa_getdata16(cosa) (cosa_inw(cosa->datareg))
265 #define cosa_getdata8(cosa) (cosa_inb(cosa->datareg))
266 #define cosa_putdata16(cosa, dt) (cosa_outw(dt, cosa->datareg))
267 #define cosa_putdata8(cosa, dt) (cosa_outb(dt, cosa->datareg))
269 /* Initialization stuff */
270 static int cosa_probe(int ioaddr
, int irq
, int dma
);
273 static void cosa_enable_rx(struct channel_data
*chan
);
274 static void cosa_disable_rx(struct channel_data
*chan
);
275 static int cosa_start_tx(struct channel_data
*channel
, char *buf
, int size
);
276 static void cosa_kick(struct cosa_data
*cosa
);
277 static int cosa_dma_able(struct channel_data
*chan
, char *buf
, int data
);
279 /* Network device stuff */
280 static int cosa_net_attach(struct net_device
*dev
, unsigned short encoding
,
281 unsigned short parity
);
282 static int cosa_net_open(struct net_device
*d
);
283 static int cosa_net_close(struct net_device
*d
);
284 static void cosa_net_timeout(struct net_device
*d
);
285 static netdev_tx_t
cosa_net_tx(struct sk_buff
*skb
, struct net_device
*d
);
286 static char *cosa_net_setup_rx(struct channel_data
*channel
, int size
);
287 static int cosa_net_rx_done(struct channel_data
*channel
);
288 static int cosa_net_tx_done(struct channel_data
*channel
, int size
);
289 static int cosa_net_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
);
291 /* Character device */
292 static char *chrdev_setup_rx(struct channel_data
*channel
, int size
);
293 static int chrdev_rx_done(struct channel_data
*channel
);
294 static int chrdev_tx_done(struct channel_data
*channel
, int size
);
295 static ssize_t
cosa_read(struct file
*file
,
296 char __user
*buf
, size_t count
, loff_t
*ppos
);
297 static ssize_t
cosa_write(struct file
*file
,
298 const char __user
*buf
, size_t count
, loff_t
*ppos
);
299 static unsigned int cosa_poll(struct file
*file
, poll_table
*poll
);
300 static int cosa_open(struct inode
*inode
, struct file
*file
);
301 static int cosa_release(struct inode
*inode
, struct file
*file
);
302 static long cosa_chardev_ioctl(struct file
*file
, unsigned int cmd
,
304 #ifdef COSA_FASYNC_WORKING
305 static int cosa_fasync(struct inode
*inode
, struct file
*file
, int on
);
308 static const struct file_operations cosa_fops
= {
309 .owner
= THIS_MODULE
,
314 .unlocked_ioctl
= cosa_chardev_ioctl
,
316 .release
= cosa_release
,
317 #ifdef COSA_FASYNC_WORKING
318 .fasync
= cosa_fasync
,
323 static int cosa_start(struct cosa_data
*cosa
, int address
);
324 static int cosa_reset(struct cosa_data
*cosa
);
325 static int cosa_download(struct cosa_data
*cosa
, void __user
*a
);
326 static int cosa_readmem(struct cosa_data
*cosa
, void __user
*a
);
328 /* COSA/SRP ROM monitor */
329 static int download(struct cosa_data
*cosa
, const char __user
*data
, int addr
, int len
);
330 static int startmicrocode(struct cosa_data
*cosa
, int address
);
331 static int readmem(struct cosa_data
*cosa
, char __user
*data
, int addr
, int len
);
332 static int cosa_reset_and_read_id(struct cosa_data
*cosa
, char *id
);
334 /* Auxiliary functions */
335 static int get_wait_data(struct cosa_data
*cosa
);
336 static int put_wait_data(struct cosa_data
*cosa
, int data
);
337 static int puthexnumber(struct cosa_data
*cosa
, int number
);
338 static void put_driver_status(struct cosa_data
*cosa
);
339 static void put_driver_status_nolock(struct cosa_data
*cosa
);
341 /* Interrupt handling */
342 static irqreturn_t
cosa_interrupt(int irq
, void *cosa
);
344 /* I/O ops debugging */
346 static void debug_data_in(struct cosa_data
*cosa
, int data
);
347 static void debug_data_out(struct cosa_data
*cosa
, int data
);
348 static void debug_data_cmd(struct cosa_data
*cosa
, int data
);
349 static void debug_status_in(struct cosa_data
*cosa
, int status
);
350 static void debug_status_out(struct cosa_data
*cosa
, int status
);
353 static inline struct channel_data
* dev_to_chan(struct net_device
*dev
)
355 return (struct channel_data
*)dev_to_hdlc(dev
)->priv
;
358 /* ---------- Initialization stuff ---------- */
360 static int __init
cosa_init(void)
364 if (cosa_major
> 0) {
365 if (register_chrdev(cosa_major
, "cosa", &cosa_fops
)) {
366 pr_warn("unable to get major %d\n", cosa_major
);
371 if (!(cosa_major
=register_chrdev(0, "cosa", &cosa_fops
))) {
372 pr_warn("unable to register chardev\n");
377 for (i
=0; i
<MAX_CARDS
; i
++)
378 cosa_cards
[i
].num
= -1;
379 for (i
=0; io
[i
] != 0 && i
< MAX_CARDS
; i
++)
380 cosa_probe(io
[i
], irq
[i
], dma
[i
]);
382 pr_warn("no devices found\n");
383 unregister_chrdev(cosa_major
, "cosa");
387 cosa_class
= class_create(THIS_MODULE
, "cosa");
388 if (IS_ERR(cosa_class
)) {
389 err
= PTR_ERR(cosa_class
);
392 for (i
= 0; i
< nr_cards
; i
++)
393 device_create(cosa_class
, NULL
, MKDEV(cosa_major
, i
), NULL
,
399 unregister_chrdev(cosa_major
, "cosa");
403 module_init(cosa_init
);
405 static void __exit
cosa_exit(void)
407 struct cosa_data
*cosa
;
410 for (i
= 0; i
< nr_cards
; i
++)
411 device_destroy(cosa_class
, MKDEV(cosa_major
, i
));
412 class_destroy(cosa_class
);
414 for (cosa
= cosa_cards
; nr_cards
--; cosa
++) {
415 /* Clean up the per-channel data */
416 for (i
= 0; i
< cosa
->nchannels
; i
++) {
417 /* Chardev driver has no alloc'd per-channel data */
418 unregister_hdlc_device(cosa
->chan
[i
].netdev
);
419 free_netdev(cosa
->chan
[i
].netdev
);
421 /* Clean up the per-card data */
423 kfree(cosa
->bouncebuf
);
424 free_irq(cosa
->irq
, cosa
);
426 release_region(cosa
->datareg
, is_8bit(cosa
) ? 2 : 4);
428 unregister_chrdev(cosa_major
, "cosa");
430 module_exit(cosa_exit
);
432 static const struct net_device_ops cosa_ops
= {
433 .ndo_open
= cosa_net_open
,
434 .ndo_stop
= cosa_net_close
,
435 .ndo_change_mtu
= hdlc_change_mtu
,
436 .ndo_start_xmit
= hdlc_start_xmit
,
437 .ndo_do_ioctl
= cosa_net_ioctl
,
438 .ndo_tx_timeout
= cosa_net_timeout
,
441 static int cosa_probe(int base
, int irq
, int dma
)
443 struct cosa_data
*cosa
= cosa_cards
+nr_cards
;
446 memset(cosa
, 0, sizeof(struct cosa_data
));
448 /* Checking validity of parameters: */
449 /* IRQ should be 2-7 or 10-15; negative IRQ means autoprobe */
450 if ((irq
>= 0 && irq
< 2) || irq
> 15 || (irq
< 10 && irq
> 7)) {
451 pr_info("invalid IRQ %d\n", irq
);
454 /* I/O address should be between 0x100 and 0x3ff and should be
456 if (base
< 0x100 || base
> 0x3ff || base
& 0x7) {
457 pr_info("invalid I/O address 0x%x\n", base
);
460 /* DMA should be 0,1 or 3-7 */
461 if (dma
< 0 || dma
== 4 || dma
> 7) {
462 pr_info("invalid DMA %d\n", dma
);
465 /* and finally, on 16-bit COSA DMA should be 4-7 and
466 * I/O base should not be multiple of 0x10 */
467 if (((base
& 0x8) && dma
< 4) || (!(base
& 0x8) && dma
> 3)) {
468 pr_info("8/16 bit base and DMA mismatch (base=0x%x, dma=%d)\n",
474 cosa
->datareg
= base
;
475 cosa
->statusreg
= is_8bit(cosa
)?base
+1:base
+2;
476 spin_lock_init(&cosa
->lock
);
478 if (!request_region(base
, is_8bit(cosa
)?2:4,"cosa"))
481 if (cosa_reset_and_read_id(cosa
, cosa
->id_string
) < 0) {
482 printk(KERN_DEBUG
"probe at 0x%x failed.\n", base
);
487 /* Test the validity of identification string */
488 if (!strncmp(cosa
->id_string
, "SRP", 3))
490 else if (!strncmp(cosa
->id_string
, "COSA", 4))
491 cosa
->type
= is_8bit(cosa
)? "cosa8": "cosa16";
493 /* Print a warning only if we are not autoprobing */
494 #ifndef COSA_ISA_AUTOPROBE
495 pr_info("valid signature not found at 0x%x\n", base
);
500 /* Update the name of the region now we know the type of card */
501 release_region(base
, is_8bit(cosa
)?2:4);
502 if (!request_region(base
, is_8bit(cosa
)?2:4, cosa
->type
)) {
503 printk(KERN_DEBUG
"changing name at 0x%x failed.\n", base
);
507 /* Now do IRQ autoprobe */
510 /* pr_info("IRQ autoprobe\n"); */
511 irqs
= probe_irq_on();
513 * Enable interrupt on tx buffer empty (it sure is)
515 * FIXME: When this code is not used as module, we should
516 * probably call udelay() instead of the interruptible sleep.
518 set_current_state(TASK_INTERRUPTIBLE
);
519 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
520 schedule_timeout(msecs_to_jiffies(300));
521 irq
= probe_irq_off(irqs
);
522 /* Disable all IRQs from the card */
523 cosa_putstatus(cosa
, 0);
524 /* Empty the received data register */
528 pr_info("multiple interrupts obtained (%d, board at 0x%x)\n",
534 pr_info("no interrupt obtained (board at 0x%x)\n",
541 cosa
->num
= nr_cards
;
543 cosa
->nchannels
= 2; /* FIXME: how to determine this? */
545 if (request_irq(cosa
->irq
, cosa_interrupt
, 0, cosa
->type
, cosa
)) {
549 if (request_dma(cosa
->dma
, cosa
->type
)) {
554 cosa
->bouncebuf
= kmalloc(COSA_MTU
, GFP_KERNEL
|GFP_DMA
);
555 if (!cosa
->bouncebuf
) {
559 sprintf(cosa
->name
, "cosa%d", cosa
->num
);
561 /* Initialize the per-channel data */
562 cosa
->chan
= kcalloc(cosa
->nchannels
, sizeof(struct channel_data
), GFP_KERNEL
);
568 for (i
= 0; i
< cosa
->nchannels
; i
++) {
569 struct channel_data
*chan
= &cosa
->chan
[i
];
573 sprintf(chan
->name
, "cosa%dc%d", chan
->cosa
->num
, i
);
575 /* Initialize the chardev data structures */
576 mutex_init(&chan
->rlock
);
577 sema_init(&chan
->wsem
, 1);
579 /* Register the network interface */
580 if (!(chan
->netdev
= alloc_hdlcdev(chan
))) {
581 pr_warn("%s: alloc_hdlcdev failed\n", chan
->name
);
585 dev_to_hdlc(chan
->netdev
)->attach
= cosa_net_attach
;
586 dev_to_hdlc(chan
->netdev
)->xmit
= cosa_net_tx
;
587 chan
->netdev
->netdev_ops
= &cosa_ops
;
588 chan
->netdev
->watchdog_timeo
= TX_TIMEOUT
;
589 chan
->netdev
->base_addr
= chan
->cosa
->datareg
;
590 chan
->netdev
->irq
= chan
->cosa
->irq
;
591 chan
->netdev
->dma
= chan
->cosa
->dma
;
592 err
= register_hdlc_device(chan
->netdev
);
594 netdev_warn(chan
->netdev
,
595 "register_hdlc_device() failed\n");
596 free_netdev(chan
->netdev
);
601 pr_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 pr_notice("cosa%d: allocating resources failed\n", cosa
->num
);
626 /*---------- network device ---------- */
628 static int cosa_net_attach(struct net_device
*dev
, unsigned short encoding
,
629 unsigned short parity
)
631 if (encoding
== ENCODING_NRZ
&& parity
== PARITY_CRC16_PR1_CCITT
)
636 static int cosa_net_open(struct net_device
*dev
)
638 struct channel_data
*chan
= dev_to_chan(dev
);
642 if (!(chan
->cosa
->firmware_status
& COSA_FW_START
)) {
643 pr_notice("%s: start the firmware first (status %d)\n",
644 chan
->cosa
->name
, chan
->cosa
->firmware_status
);
647 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
648 if (chan
->usage
!= 0) {
649 pr_warn("%s: cosa_net_open called with usage count %d\n",
650 chan
->name
, chan
->usage
);
651 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
654 chan
->setup_rx
= cosa_net_setup_rx
;
655 chan
->tx_done
= cosa_net_tx_done
;
656 chan
->rx_done
= cosa_net_rx_done
;
659 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
661 err
= hdlc_open(dev
);
663 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
666 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
670 netif_start_queue(dev
);
671 cosa_enable_rx(chan
);
675 static netdev_tx_t
cosa_net_tx(struct sk_buff
*skb
,
676 struct net_device
*dev
)
678 struct channel_data
*chan
= dev_to_chan(dev
);
680 netif_stop_queue(dev
);
683 cosa_start_tx(chan
, skb
->data
, skb
->len
);
687 static void cosa_net_timeout(struct net_device
*dev
)
689 struct channel_data
*chan
= dev_to_chan(dev
);
691 if (test_bit(RXBIT
, &chan
->cosa
->rxtx
)) {
692 chan
->netdev
->stats
.rx_errors
++;
693 chan
->netdev
->stats
.rx_missed_errors
++;
695 chan
->netdev
->stats
.tx_errors
++;
696 chan
->netdev
->stats
.tx_aborted_errors
++;
698 cosa_kick(chan
->cosa
);
700 dev_kfree_skb(chan
->tx_skb
);
703 netif_wake_queue(dev
);
706 static int cosa_net_close(struct net_device
*dev
)
708 struct channel_data
*chan
= dev_to_chan(dev
);
711 netif_stop_queue(dev
);
713 cosa_disable_rx(chan
);
714 spin_lock_irqsave(&chan
->cosa
->lock
, flags
);
716 kfree_skb(chan
->rx_skb
);
720 kfree_skb(chan
->tx_skb
);
725 spin_unlock_irqrestore(&chan
->cosa
->lock
, flags
);
729 static char *cosa_net_setup_rx(struct channel_data
*chan
, int size
)
732 * We can safely fall back to non-dma-able memory, because we have
733 * the cosa->bouncebuf pre-allocated.
735 kfree_skb(chan
->rx_skb
);
736 chan
->rx_skb
= dev_alloc_skb(size
);
737 if (chan
->rx_skb
== NULL
) {
738 pr_notice("%s: Memory squeeze, dropping packet\n", chan
->name
);
739 chan
->netdev
->stats
.rx_dropped
++;
742 chan
->netdev
->trans_start
= jiffies
;
743 return skb_put(chan
->rx_skb
, size
);
746 static int cosa_net_rx_done(struct channel_data
*chan
)
749 pr_warn("%s: rx_done with empty skb!\n", chan
->name
);
750 chan
->netdev
->stats
.rx_errors
++;
751 chan
->netdev
->stats
.rx_frame_errors
++;
754 chan
->rx_skb
->protocol
= hdlc_type_trans(chan
->rx_skb
, chan
->netdev
);
755 chan
->rx_skb
->dev
= chan
->netdev
;
756 skb_reset_mac_header(chan
->rx_skb
);
757 chan
->netdev
->stats
.rx_packets
++;
758 chan
->netdev
->stats
.rx_bytes
+= chan
->cosa
->rxsize
;
759 netif_rx(chan
->rx_skb
);
765 static int cosa_net_tx_done(struct channel_data
*chan
, int size
)
768 pr_warn("%s: tx_done with empty skb!\n", chan
->name
);
769 chan
->netdev
->stats
.tx_errors
++;
770 chan
->netdev
->stats
.tx_aborted_errors
++;
773 dev_kfree_skb_irq(chan
->tx_skb
);
775 chan
->netdev
->stats
.tx_packets
++;
776 chan
->netdev
->stats
.tx_bytes
+= size
;
777 netif_wake_queue(chan
->netdev
);
781 /*---------- Character device ---------- */
783 static ssize_t
cosa_read(struct file
*file
,
784 char __user
*buf
, size_t count
, loff_t
*ppos
)
786 DECLARE_WAITQUEUE(wait
, current
);
788 struct channel_data
*chan
= file
->private_data
;
789 struct cosa_data
*cosa
= chan
->cosa
;
792 if (!(cosa
->firmware_status
& COSA_FW_START
)) {
793 pr_notice("%s: start the firmware first (status %d)\n",
794 cosa
->name
, cosa
->firmware_status
);
797 if (mutex_lock_interruptible(&chan
->rlock
))
800 chan
->rxdata
= kmalloc(COSA_MTU
, GFP_DMA
|GFP_KERNEL
);
801 if (chan
->rxdata
== NULL
) {
802 mutex_unlock(&chan
->rlock
);
807 cosa_enable_rx(chan
);
808 spin_lock_irqsave(&cosa
->lock
, flags
);
809 add_wait_queue(&chan
->rxwaitq
, &wait
);
810 while (!chan
->rx_status
) {
811 set_current_state(TASK_INTERRUPTIBLE
);
812 spin_unlock_irqrestore(&cosa
->lock
, flags
);
814 spin_lock_irqsave(&cosa
->lock
, flags
);
815 if (signal_pending(current
) && chan
->rx_status
== 0) {
817 remove_wait_queue(&chan
->rxwaitq
, &wait
);
818 __set_current_state(TASK_RUNNING
);
819 spin_unlock_irqrestore(&cosa
->lock
, flags
);
820 mutex_unlock(&chan
->rlock
);
824 remove_wait_queue(&chan
->rxwaitq
, &wait
);
825 __set_current_state(TASK_RUNNING
);
827 count
= chan
->rxsize
;
828 spin_unlock_irqrestore(&cosa
->lock
, flags
);
829 mutex_unlock(&chan
->rlock
);
831 if (copy_to_user(buf
, kbuf
, count
)) {
839 static char *chrdev_setup_rx(struct channel_data
*chan
, int size
)
841 /* Expect size <= COSA_MTU */
846 static int chrdev_rx_done(struct channel_data
*chan
)
848 if (chan
->rx_status
) { /* Reader has died */
853 wake_up_interruptible(&chan
->rxwaitq
);
858 static ssize_t
cosa_write(struct file
*file
,
859 const char __user
*buf
, size_t count
, loff_t
*ppos
)
861 DECLARE_WAITQUEUE(wait
, current
);
862 struct channel_data
*chan
= file
->private_data
;
863 struct cosa_data
*cosa
= chan
->cosa
;
867 if (!(cosa
->firmware_status
& COSA_FW_START
)) {
868 pr_notice("%s: start the firmware first (status %d)\n",
869 cosa
->name
, cosa
->firmware_status
);
872 if (down_interruptible(&chan
->wsem
))
875 if (count
> COSA_MTU
)
878 /* Allocate the buffer */
879 kbuf
= kmalloc(count
, GFP_KERNEL
|GFP_DMA
);
884 if (copy_from_user(kbuf
, buf
, count
)) {
890 cosa_start_tx(chan
, kbuf
, count
);
892 spin_lock_irqsave(&cosa
->lock
, flags
);
893 add_wait_queue(&chan
->txwaitq
, &wait
);
894 while (!chan
->tx_status
) {
895 set_current_state(TASK_INTERRUPTIBLE
);
896 spin_unlock_irqrestore(&cosa
->lock
, flags
);
898 spin_lock_irqsave(&cosa
->lock
, flags
);
899 if (signal_pending(current
) && chan
->tx_status
== 0) {
901 remove_wait_queue(&chan
->txwaitq
, &wait
);
902 __set_current_state(TASK_RUNNING
);
904 spin_unlock_irqrestore(&cosa
->lock
, flags
);
909 remove_wait_queue(&chan
->txwaitq
, &wait
);
910 __set_current_state(TASK_RUNNING
);
912 spin_unlock_irqrestore(&cosa
->lock
, flags
);
917 static int chrdev_tx_done(struct channel_data
*chan
, int size
)
919 if (chan
->tx_status
) { /* Writer was interrupted */
924 wake_up_interruptible(&chan
->txwaitq
);
928 static unsigned int cosa_poll(struct file
*file
, poll_table
*poll
)
930 pr_info("cosa_poll is here\n");
934 static int cosa_open(struct inode
*inode
, struct file
*file
)
936 struct cosa_data
*cosa
;
937 struct channel_data
*chan
;
942 mutex_lock(&cosa_chardev_mutex
);
943 if ((n
=iminor(file_inode(file
))>>CARD_MINOR_BITS
)
950 if ((n
=iminor(file_inode(file
))
951 & ((1<<CARD_MINOR_BITS
)-1)) >= cosa
->nchannels
) {
955 chan
= cosa
->chan
+ n
;
957 file
->private_data
= chan
;
959 spin_lock_irqsave(&cosa
->lock
, flags
);
961 if (chan
->usage
< 0) { /* in netdev mode */
962 spin_unlock_irqrestore(&cosa
->lock
, flags
);
969 chan
->tx_done
= chrdev_tx_done
;
970 chan
->setup_rx
= chrdev_setup_rx
;
971 chan
->rx_done
= chrdev_rx_done
;
972 spin_unlock_irqrestore(&cosa
->lock
, flags
);
974 mutex_unlock(&cosa_chardev_mutex
);
978 static int cosa_release(struct inode
*inode
, struct file
*file
)
980 struct channel_data
*channel
= file
->private_data
;
981 struct cosa_data
*cosa
;
984 cosa
= channel
->cosa
;
985 spin_lock_irqsave(&cosa
->lock
, flags
);
988 spin_unlock_irqrestore(&cosa
->lock
, flags
);
992 #ifdef COSA_FASYNC_WORKING
993 static struct fasync_struct
*fasync
[256] = { NULL
, };
996 static int cosa_fasync(struct inode
*inode
, struct file
*file
, int on
)
998 int port
= iminor(inode
);
1000 return fasync_helper(inode
, file
, on
, &fasync
[port
]);
1005 /* ---------- Ioctls ---------- */
1008 * Ioctl subroutines can safely be made inline, because they are called
1009 * only from cosa_ioctl().
1011 static inline int cosa_reset(struct cosa_data
*cosa
)
1013 char idstring
[COSA_MAX_ID_STRING
];
1014 if (cosa
->usage
> 1)
1015 pr_info("cosa%d: WARNING: reset requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1016 cosa
->num
, cosa
->usage
);
1017 cosa
->firmware_status
&= ~(COSA_FW_RESET
|COSA_FW_START
);
1018 if (cosa_reset_and_read_id(cosa
, idstring
) < 0) {
1019 pr_notice("cosa%d: reset failed\n", cosa
->num
);
1022 pr_info("cosa%d: resetting device: %s\n", cosa
->num
, idstring
);
1023 cosa
->firmware_status
|= COSA_FW_RESET
;
1027 /* High-level function to download data into COSA memory. Calls download() */
1028 static inline int cosa_download(struct cosa_data
*cosa
, void __user
*arg
)
1030 struct cosa_download d
;
1033 if (cosa
->usage
> 1)
1034 pr_info("%s: WARNING: download of microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1035 cosa
->name
, cosa
->usage
);
1036 if (!(cosa
->firmware_status
& COSA_FW_RESET
)) {
1037 pr_notice("%s: reset the card first (status %d)\n",
1038 cosa
->name
, cosa
->firmware_status
);
1042 if (copy_from_user(&d
, arg
, sizeof(d
)))
1045 if (d
.addr
< 0 || d
.addr
> COSA_MAX_FIRMWARE_SIZE
)
1047 if (d
.len
< 0 || d
.len
> COSA_MAX_FIRMWARE_SIZE
)
1051 /* If something fails, force the user to reset the card */
1052 cosa
->firmware_status
&= ~(COSA_FW_RESET
|COSA_FW_DOWNLOAD
);
1054 i
= download(cosa
, d
.code
, d
.len
, d
.addr
);
1056 pr_notice("cosa%d: microcode download failed: %d\n",
1060 pr_info("cosa%d: downloading microcode - 0x%04x bytes at 0x%04x\n",
1061 cosa
->num
, d
.len
, d
.addr
);
1062 cosa
->firmware_status
|= COSA_FW_RESET
|COSA_FW_DOWNLOAD
;
1066 /* High-level function to read COSA memory. Calls readmem() */
1067 static inline int cosa_readmem(struct cosa_data
*cosa
, void __user
*arg
)
1069 struct cosa_download d
;
1072 if (cosa
->usage
> 1)
1073 pr_info("cosa%d: WARNING: readmem requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1074 cosa
->num
, cosa
->usage
);
1075 if (!(cosa
->firmware_status
& COSA_FW_RESET
)) {
1076 pr_notice("%s: reset the card first (status %d)\n",
1077 cosa
->name
, cosa
->firmware_status
);
1081 if (copy_from_user(&d
, arg
, sizeof(d
)))
1084 /* If something fails, force the user to reset the card */
1085 cosa
->firmware_status
&= ~COSA_FW_RESET
;
1087 i
= readmem(cosa
, d
.code
, d
.len
, d
.addr
);
1089 pr_notice("cosa%d: reading memory failed: %d\n", cosa
->num
, i
);
1092 pr_info("cosa%d: reading card memory - 0x%04x bytes at 0x%04x\n",
1093 cosa
->num
, d
.len
, d
.addr
);
1094 cosa
->firmware_status
|= COSA_FW_RESET
;
1098 /* High-level function to start microcode. Calls startmicrocode(). */
1099 static inline int cosa_start(struct cosa_data
*cosa
, int address
)
1103 if (cosa
->usage
> 1)
1104 pr_info("cosa%d: WARNING: start microcode requested with cosa->usage > 1 (%d). Odd things may happen.\n",
1105 cosa
->num
, cosa
->usage
);
1107 if ((cosa
->firmware_status
& (COSA_FW_RESET
|COSA_FW_DOWNLOAD
))
1108 != (COSA_FW_RESET
|COSA_FW_DOWNLOAD
)) {
1109 pr_notice("%s: download the microcode and/or reset the card first (status %d)\n",
1110 cosa
->name
, cosa
->firmware_status
);
1113 cosa
->firmware_status
&= ~COSA_FW_RESET
;
1114 if ((i
=startmicrocode(cosa
, address
)) < 0) {
1115 pr_notice("cosa%d: start microcode at 0x%04x failed: %d\n",
1116 cosa
->num
, address
, i
);
1119 pr_info("cosa%d: starting microcode at 0x%04x\n", cosa
->num
, address
);
1120 cosa
->startaddr
= address
;
1121 cosa
->firmware_status
|= COSA_FW_START
;
1125 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1126 static inline int cosa_getidstr(struct cosa_data
*cosa
, char __user
*string
)
1128 int l
= strlen(cosa
->id_string
)+1;
1129 if (copy_to_user(string
, cosa
->id_string
, l
))
1134 /* Buffer of size at least COSA_MAX_ID_STRING is expected */
1135 static inline int cosa_gettype(struct cosa_data
*cosa
, char __user
*string
)
1137 int l
= strlen(cosa
->type
)+1;
1138 if (copy_to_user(string
, cosa
->type
, l
))
1143 static int cosa_ioctl_common(struct cosa_data
*cosa
,
1144 struct channel_data
*channel
, unsigned int cmd
, unsigned long arg
)
1146 void __user
*argp
= (void __user
*)arg
;
1148 case COSAIORSET
: /* Reset the device */
1149 if (!capable(CAP_NET_ADMIN
))
1151 return cosa_reset(cosa
);
1152 case COSAIOSTRT
: /* Start the firmware */
1153 if (!capable(CAP_SYS_RAWIO
))
1155 return cosa_start(cosa
, arg
);
1156 case COSAIODOWNLD
: /* Download the firmware */
1157 if (!capable(CAP_SYS_RAWIO
))
1160 return cosa_download(cosa
, argp
);
1162 if (!capable(CAP_SYS_RAWIO
))
1164 return cosa_readmem(cosa
, argp
);
1166 return cosa_gettype(cosa
, argp
);
1168 return cosa_getidstr(cosa
, argp
);
1172 return cosa
->nchannels
;
1174 if (!capable(CAP_SYS_RAWIO
))
1178 if (arg
!= COSA_BM_OFF
&& arg
!= COSA_BM_ON
)
1180 cosa
->busmaster
= arg
;
1183 return cosa
->busmaster
;
1185 return -ENOIOCTLCMD
;
1188 static int cosa_net_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
)
1191 struct channel_data
*chan
= dev_to_chan(dev
);
1192 rv
= cosa_ioctl_common(chan
->cosa
, chan
, cmd
,
1193 (unsigned long)ifr
->ifr_data
);
1194 if (rv
!= -ENOIOCTLCMD
)
1196 return hdlc_ioctl(dev
, ifr
, cmd
);
1199 static long cosa_chardev_ioctl(struct file
*file
, unsigned int cmd
,
1202 struct channel_data
*channel
= file
->private_data
;
1203 struct cosa_data
*cosa
;
1206 mutex_lock(&cosa_chardev_mutex
);
1207 cosa
= channel
->cosa
;
1208 ret
= cosa_ioctl_common(cosa
, channel
, cmd
, arg
);
1209 mutex_unlock(&cosa_chardev_mutex
);
1214 /*---------- HW layer interface ---------- */
1217 * The higher layer can bind itself to the HW layer by setting the callbacks
1218 * in the channel_data structure and by using these routines.
1220 static void cosa_enable_rx(struct channel_data
*chan
)
1222 struct cosa_data
*cosa
= chan
->cosa
;
1224 if (!test_and_set_bit(chan
->num
, &cosa
->rxbitmap
))
1225 put_driver_status(cosa
);
1228 static void cosa_disable_rx(struct channel_data
*chan
)
1230 struct cosa_data
*cosa
= chan
->cosa
;
1232 if (test_and_clear_bit(chan
->num
, &cosa
->rxbitmap
))
1233 put_driver_status(cosa
);
1237 * FIXME: This routine probably should check for cosa_start_tx() called when
1238 * the previous transmit is still unfinished. In this case the non-zero
1239 * return value should indicate to the caller that the queuing(sp?) up
1240 * the transmit has failed.
1242 static int cosa_start_tx(struct channel_data
*chan
, char *buf
, int len
)
1244 struct cosa_data
*cosa
= chan
->cosa
;
1245 unsigned long flags
;
1249 pr_info("cosa%dc%d: starting tx(0x%x)",
1250 chan
->cosa
->num
, chan
->num
, len
);
1251 for (i
=0; i
<len
; i
++)
1252 pr_cont(" %02x", buf
[i
]&0xff);
1255 spin_lock_irqsave(&cosa
->lock
, flags
);
1259 chan
->txsize
= COSA_MTU
;
1260 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1262 /* Tell the firmware we are ready */
1263 set_bit(chan
->num
, &cosa
->txbitmap
);
1264 put_driver_status(cosa
);
1269 static void put_driver_status(struct cosa_data
*cosa
)
1271 unsigned long flags
;
1274 spin_lock_irqsave(&cosa
->lock
, flags
);
1276 status
= (cosa
->rxbitmap
? DRIVER_RX_READY
: 0)
1277 | (cosa
->txbitmap
? DRIVER_TX_READY
: 0)
1278 | (cosa
->txbitmap
? ~(cosa
->txbitmap
<<DRIVER_TXMAP_SHIFT
)
1279 &DRIVER_TXMAP_MASK
: 0);
1281 if (cosa
->rxbitmap
|cosa
->txbitmap
) {
1282 if (!cosa
->enabled
) {
1283 cosa_putstatus(cosa
, SR_RX_INT_ENA
);
1285 debug_status_out(cosa
, SR_RX_INT_ENA
);
1289 } else if (cosa
->enabled
) {
1291 cosa_putstatus(cosa
, 0);
1293 debug_status_out(cosa
, 0);
1296 cosa_putdata8(cosa
, status
);
1298 debug_data_cmd(cosa
, status
);
1301 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1304 static void put_driver_status_nolock(struct cosa_data
*cosa
)
1308 status
= (cosa
->rxbitmap
? DRIVER_RX_READY
: 0)
1309 | (cosa
->txbitmap
? DRIVER_TX_READY
: 0)
1310 | (cosa
->txbitmap
? ~(cosa
->txbitmap
<<DRIVER_TXMAP_SHIFT
)
1311 &DRIVER_TXMAP_MASK
: 0);
1313 if (cosa
->rxbitmap
|cosa
->txbitmap
) {
1314 cosa_putstatus(cosa
, SR_RX_INT_ENA
);
1316 debug_status_out(cosa
, SR_RX_INT_ENA
);
1320 cosa_putstatus(cosa
, 0);
1322 debug_status_out(cosa
, 0);
1326 cosa_putdata8(cosa
, status
);
1328 debug_data_cmd(cosa
, status
);
1333 * The "kickme" function: When the DMA times out, this is called to
1334 * clean up the driver status.
1335 * FIXME: Preliminary support, the interface is probably wrong.
1337 static void cosa_kick(struct cosa_data
*cosa
)
1339 unsigned long flags
, flags1
;
1340 char *s
= "(probably) IRQ";
1342 if (test_bit(RXBIT
, &cosa
->rxtx
))
1344 if (test_bit(TXBIT
, &cosa
->rxtx
))
1347 pr_info("%s: %s timeout - restarting\n", cosa
->name
, s
);
1348 spin_lock_irqsave(&cosa
->lock
, flags
);
1351 flags1
= claim_dma_lock();
1352 disable_dma(cosa
->dma
);
1353 clear_dma_ff(cosa
->dma
);
1354 release_dma_lock(flags1
);
1356 /* FIXME: Anything else? */
1358 cosa_putstatus(cosa
, 0);
1360 (void) cosa_getdata8(cosa
);
1362 cosa_putdata8(cosa
, 0);
1364 put_driver_status_nolock(cosa
);
1365 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1369 * Check if the whole buffer is DMA-able. It means it is below the 16M of
1370 * physical memory and doesn't span the 64k boundary. For now it seems
1371 * SKB's never do this, but we'll check this anyway.
1373 static int cosa_dma_able(struct channel_data
*chan
, char *buf
, int len
)
1376 unsigned long b
= (unsigned long)buf
;
1377 if (b
+len
>= MAX_DMA_ADDRESS
)
1379 if ((b
^ (b
+len
)) & 0x10000) {
1381 pr_info("%s: packet spanning a 64k boundary\n",
1389 /* ---------- The SRP/COSA ROM monitor functions ---------- */
1392 * Downloading SRP microcode: say "w" to SRP monitor, it answers by "w=",
1393 * drivers need to say 4-digit hex number meaning start address of the microcode
1394 * separated by a single space. Monitor replies by saying " =". Now driver
1395 * has to write 4-digit hex number meaning the last byte address ended
1396 * by a single space. Monitor has to reply with a space. Now the download
1397 * begins. After the download monitor replies with "\r\n." (CR LF dot).
1399 static int download(struct cosa_data
*cosa
, const char __user
*microcode
, int length
, int address
)
1403 if (put_wait_data(cosa
, 'w') == -1) return -1;
1404 if ((i
=get_wait_data(cosa
)) != 'w') { printk("dnld: 0x%04x\n",i
); return -2;}
1405 if (get_wait_data(cosa
) != '=') return -3;
1407 if (puthexnumber(cosa
, address
) < 0) return -4;
1408 if (put_wait_data(cosa
, ' ') == -1) return -10;
1409 if (get_wait_data(cosa
) != ' ') return -11;
1410 if (get_wait_data(cosa
) != '=') return -12;
1412 if (puthexnumber(cosa
, address
+length
-1) < 0) return -13;
1413 if (put_wait_data(cosa
, ' ') == -1) return -18;
1414 if (get_wait_data(cosa
) != ' ') return -19;
1418 #ifndef SRP_DOWNLOAD_AT_BOOT
1419 if (get_user(c
, microcode
))
1420 return -23; /* ??? */
1424 if (put_wait_data(cosa
, c
) == -1)
1429 if (get_wait_data(cosa
) != '\r') return -21;
1430 if (get_wait_data(cosa
) != '\n') return -22;
1431 if (get_wait_data(cosa
) != '.') return -23;
1433 printk(KERN_DEBUG
"cosa%d: download completed.\n", cosa
->num
);
1440 * Starting microcode is done via the "g" command of the SRP monitor.
1441 * The chat should be the following: "g" "g=" "<addr><CR>"
1442 * "<CR><CR><LF><CR><LF>".
1444 static int startmicrocode(struct cosa_data
*cosa
, int address
)
1446 if (put_wait_data(cosa
, 'g') == -1) return -1;
1447 if (get_wait_data(cosa
) != 'g') return -2;
1448 if (get_wait_data(cosa
) != '=') return -3;
1450 if (puthexnumber(cosa
, address
) < 0) return -4;
1451 if (put_wait_data(cosa
, '\r') == -1) return -5;
1453 if (get_wait_data(cosa
) != '\r') return -6;
1454 if (get_wait_data(cosa
) != '\r') return -7;
1455 if (get_wait_data(cosa
) != '\n') return -8;
1456 if (get_wait_data(cosa
) != '\r') return -9;
1457 if (get_wait_data(cosa
) != '\n') return -10;
1459 printk(KERN_DEBUG
"cosa%d: microcode started\n", cosa
->num
);
1465 * Reading memory is done via the "r" command of the SRP monitor.
1466 * The chat is the following "r" "r=" "<addr> " " =" "<last_byte> " " "
1467 * Then driver can read the data and the conversation is finished
1468 * by SRP monitor sending "<CR><LF>." (dot at the end).
1470 * This routine is not needed during the normal operation and serves
1471 * for debugging purposes only.
1473 static int readmem(struct cosa_data
*cosa
, char __user
*microcode
, int length
, int address
)
1475 if (put_wait_data(cosa
, 'r') == -1) return -1;
1476 if ((get_wait_data(cosa
)) != 'r') return -2;
1477 if ((get_wait_data(cosa
)) != '=') return -3;
1479 if (puthexnumber(cosa
, address
) < 0) return -4;
1480 if (put_wait_data(cosa
, ' ') == -1) return -5;
1481 if (get_wait_data(cosa
) != ' ') return -6;
1482 if (get_wait_data(cosa
) != '=') return -7;
1484 if (puthexnumber(cosa
, address
+length
-1) < 0) return -8;
1485 if (put_wait_data(cosa
, ' ') == -1) return -9;
1486 if (get_wait_data(cosa
) != ' ') return -10;
1491 if ((i
=get_wait_data(cosa
)) == -1) {
1492 pr_info("0x%04x bytes remaining\n", length
);
1497 if (put_user(c
, microcode
))
1498 return -23; /* ??? */
1505 if (get_wait_data(cosa
) != '\r') return -21;
1506 if (get_wait_data(cosa
) != '\n') return -22;
1507 if (get_wait_data(cosa
) != '.') return -23;
1509 printk(KERN_DEBUG
"cosa%d: readmem completed.\n", cosa
->num
);
1515 * This function resets the device and reads the initial prompt
1516 * of the device's ROM monitor.
1518 static int cosa_reset_and_read_id(struct cosa_data
*cosa
, char *idstring
)
1520 int i
=0, id
=0, prev
=0, curr
=0;
1522 /* Reset the card ... */
1523 cosa_putstatus(cosa
, 0);
1524 cosa_getdata8(cosa
);
1525 cosa_putstatus(cosa
, SR_RST
);
1527 /* Disable all IRQs from the card */
1528 cosa_putstatus(cosa
, 0);
1531 * Try to read the ID string. The card then prints out the
1532 * identification string ended by the "\n\x2e".
1534 * The following loop is indexed through i (instead of id)
1535 * to avoid looping forever when for any reason
1536 * the port returns '\r', '\n' or '\x2e' permanently.
1538 for (i
=0; i
<COSA_MAX_ID_STRING
-1; i
++, prev
=curr
) {
1539 if ((curr
= get_wait_data(cosa
)) == -1) {
1543 if (curr
!= '\r' && curr
!= '\n' && curr
!= 0x2e)
1544 idstring
[id
++] = curr
;
1545 if (curr
== 0x2e && prev
== '\n')
1548 /* Perhaps we should fail when i==COSA_MAX_ID_STRING-1 ? */
1549 idstring
[id
] = '\0';
1554 /* ---------- Auxiliary routines for COSA/SRP monitor ---------- */
1557 * This routine gets the data byte from the card waiting for the SR_RX_RDY
1558 * bit to be set in a loop. It should be used in the exceptional cases
1559 * only (for example when resetting the card or downloading the firmware.
1561 static int get_wait_data(struct cosa_data
*cosa
)
1566 /* read data and return them */
1567 if (cosa_getstatus(cosa
) & SR_RX_RDY
) {
1569 r
= cosa_getdata8(cosa
);
1571 pr_info("get_wait_data returning after %d retries\n",
1576 /* sleep if not ready to read */
1577 schedule_timeout_interruptible(1);
1579 pr_info("timeout in get_wait_data (status 0x%x)\n",
1580 cosa_getstatus(cosa
));
1585 * This routine puts the data byte to the card waiting for the SR_TX_RDY
1586 * bit to be set in a loop. It should be used in the exceptional cases
1587 * only (for example when resetting the card or downloading the firmware).
1589 static int put_wait_data(struct cosa_data
*cosa
, int data
)
1593 /* read data and return them */
1594 if (cosa_getstatus(cosa
) & SR_TX_RDY
) {
1595 cosa_putdata8(cosa
, data
);
1597 pr_info("Putdata: %d retries\n", 999-retries
);
1602 /* sleep if not ready to read */
1603 schedule_timeout_interruptible(1);
1606 pr_info("cosa%d: timeout in put_wait_data (status 0x%x)\n",
1607 cosa
->num
, cosa_getstatus(cosa
));
1612 * The following routine puts the hexadecimal number into the SRP monitor
1613 * and verifies the proper echo of the sent bytes. Returns 0 on success,
1614 * negative number on failure (-1,-3,-5,-7) means that put_wait_data() failed,
1615 * (-2,-4,-6,-8) means that reading echo failed.
1617 static int puthexnumber(struct cosa_data
*cosa
, int number
)
1622 /* Well, I should probably replace this by something faster. */
1623 sprintf(temp
, "%04X", number
);
1624 for (i
=0; i
<4; i
++) {
1625 if (put_wait_data(cosa
, temp
[i
]) == -1) {
1626 pr_notice("cosa%d: puthexnumber failed to write byte %d\n",
1630 if (get_wait_data(cosa
) != temp
[i
]) {
1631 pr_notice("cosa%d: puthexhumber failed to read echo of byte %d\n",
1640 /* ---------- Interrupt routines ---------- */
1643 * There are three types of interrupt:
1644 * At the beginning of transmit - this handled is in tx_interrupt(),
1645 * at the beginning of receive - it is in rx_interrupt() and
1646 * at the end of transmit/receive - it is the eot_interrupt() function.
1647 * These functions are multiplexed by cosa_interrupt() according to the
1648 * COSA status byte. I have moved the rx/tx/eot interrupt handling into
1649 * separate functions to make it more readable. These functions are inline,
1650 * so there should be no overhead of function call.
1652 * In the COSA bus-master mode, we need to tell the card the address of a
1653 * buffer. Unfortunately, COSA may be too slow for us, so we must busy-wait.
1654 * It's time to use the bottom half :-(
1658 * Transmit interrupt routine - called when COSA is willing to obtain
1659 * data from the OS. The most tricky part of the routine is selection
1660 * of channel we (OS) want to send packet for. For SRP we should probably
1661 * use the round-robin approach. The newer COSA firmwares have a simple
1662 * flow-control - in the status word has bits 2 and 3 set to 1 means that the
1663 * channel 0 or 1 doesn't want to receive data.
1665 * It seems there is a bug in COSA firmware (need to trace it further):
1666 * When the driver status says that the kernel has no more data for transmit
1667 * (e.g. at the end of TX DMA) and then the kernel changes its mind
1668 * (e.g. new packet is queued to hard_start_xmit()), the card issues
1669 * the TX interrupt but does not mark the channel as ready-to-transmit.
1670 * The fix seems to be to push the packet to COSA despite its request.
1671 * We first try to obey the card's opinion, and then fall back to forced TX.
1673 static inline void tx_interrupt(struct cosa_data
*cosa
, int status
)
1675 unsigned long flags
, flags1
;
1677 pr_info("cosa%d: SR_DOWN_REQUEST status=0x%04x\n", cosa
->num
, status
);
1679 spin_lock_irqsave(&cosa
->lock
, flags
);
1680 set_bit(TXBIT
, &cosa
->rxtx
);
1681 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1682 /* flow control, see the comment above */
1684 if (!cosa
->txbitmap
) {
1685 pr_warn("%s: No channel wants data in TX IRQ. Expect DMA timeout.\n",
1687 put_driver_status_nolock(cosa
);
1688 clear_bit(TXBIT
, &cosa
->rxtx
);
1689 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1695 if (cosa
->txchan
>= cosa
->nchannels
)
1697 if (!(cosa
->txbitmap
& (1<<cosa
->txchan
)))
1699 if (~status
& (1 << (cosa
->txchan
+DRIVER_TXMAP_SHIFT
)))
1701 /* in second pass, accept first ready-to-TX channel */
1702 if (i
> cosa
->nchannels
) {
1703 /* Can be safely ignored */
1705 printk(KERN_DEBUG
"%s: Forcing TX "
1706 "to not-ready channel %d\n",
1707 cosa
->name
, cosa
->txchan
);
1713 cosa
->txsize
= cosa
->chan
[cosa
->txchan
].txsize
;
1714 if (cosa_dma_able(cosa
->chan
+cosa
->txchan
,
1715 cosa
->chan
[cosa
->txchan
].txbuf
, cosa
->txsize
)) {
1716 cosa
->txbuf
= cosa
->chan
[cosa
->txchan
].txbuf
;
1718 memcpy(cosa
->bouncebuf
, cosa
->chan
[cosa
->txchan
].txbuf
,
1720 cosa
->txbuf
= cosa
->bouncebuf
;
1724 if (is_8bit(cosa
)) {
1725 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1726 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
1727 cosa_putdata8(cosa
, ((cosa
->txchan
<< 5) & 0xe0)|
1728 ((cosa
->txsize
>> 8) & 0x1f));
1730 debug_status_out(cosa
, SR_TX_INT_ENA
);
1731 debug_data_out(cosa
, ((cosa
->txchan
<< 5) & 0xe0)|
1732 ((cosa
->txsize
>> 8) & 0x1f));
1733 debug_data_in(cosa
, cosa_getdata8(cosa
));
1735 cosa_getdata8(cosa
);
1737 set_bit(IRQBIT
, &cosa
->rxtx
);
1738 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1741 clear_bit(IRQBIT
, &cosa
->rxtx
);
1742 cosa_putstatus(cosa
, 0);
1743 cosa_putdata8(cosa
, cosa
->txsize
&0xff);
1745 debug_status_out(cosa
, 0);
1746 debug_data_out(cosa
, cosa
->txsize
&0xff);
1750 cosa_putstatus(cosa
, SR_TX_INT_ENA
);
1751 cosa_putdata16(cosa
, ((cosa
->txchan
<<13) & 0xe000)
1752 | (cosa
->txsize
& 0x1fff));
1754 debug_status_out(cosa
, SR_TX_INT_ENA
);
1755 debug_data_out(cosa
, ((cosa
->txchan
<<13) & 0xe000)
1756 | (cosa
->txsize
& 0x1fff));
1757 debug_data_in(cosa
, cosa_getdata8(cosa
));
1758 debug_status_out(cosa
, 0);
1760 cosa_getdata8(cosa
);
1762 cosa_putstatus(cosa
, 0);
1765 if (cosa
->busmaster
) {
1766 unsigned long addr
= virt_to_bus(cosa
->txbuf
);
1768 pr_info("busmaster IRQ\n");
1769 while (!(cosa_getstatus(cosa
)&SR_TX_RDY
)) {
1772 if (count
> 1000) break;
1774 pr_info("status %x\n", cosa_getstatus(cosa
));
1775 pr_info("ready after %d loops\n", count
);
1776 cosa_putdata16(cosa
, (addr
>> 16)&0xffff);
1779 while (!(cosa_getstatus(cosa
)&SR_TX_RDY
)) {
1781 if (count
> 1000) break;
1784 pr_info("ready after %d loops\n", count
);
1785 cosa_putdata16(cosa
, addr
&0xffff);
1786 flags1
= claim_dma_lock();
1787 set_dma_mode(cosa
->dma
, DMA_MODE_CASCADE
);
1788 enable_dma(cosa
->dma
);
1789 release_dma_lock(flags1
);
1792 flags1
= claim_dma_lock();
1793 disable_dma(cosa
->dma
);
1794 clear_dma_ff(cosa
->dma
);
1795 set_dma_mode(cosa
->dma
, DMA_MODE_WRITE
);
1796 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->txbuf
));
1797 set_dma_count(cosa
->dma
, cosa
->txsize
);
1798 enable_dma(cosa
->dma
);
1799 release_dma_lock(flags1
);
1801 cosa_putstatus(cosa
, SR_TX_DMA_ENA
|SR_USR_INT_ENA
);
1803 debug_status_out(cosa
, SR_TX_DMA_ENA
|SR_USR_INT_ENA
);
1805 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1808 static inline void rx_interrupt(struct cosa_data
*cosa
, int status
)
1810 unsigned long flags
;
1812 pr_info("cosa%d: SR_UP_REQUEST\n", cosa
->num
);
1815 spin_lock_irqsave(&cosa
->lock
, flags
);
1816 set_bit(RXBIT
, &cosa
->rxtx
);
1818 if (is_8bit(cosa
)) {
1819 if (!test_bit(IRQBIT
, &cosa
->rxtx
)) {
1820 set_bit(IRQBIT
, &cosa
->rxtx
);
1821 put_driver_status_nolock(cosa
);
1822 cosa
->rxsize
= cosa_getdata8(cosa
) <<8;
1824 debug_data_in(cosa
, cosa
->rxsize
>> 8);
1826 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1829 clear_bit(IRQBIT
, &cosa
->rxtx
);
1830 cosa
->rxsize
|= cosa_getdata8(cosa
) & 0xff;
1832 debug_data_in(cosa
, cosa
->rxsize
& 0xff);
1835 pr_info("cosa%d: receive rxsize = (0x%04x)\n",
1836 cosa
->num
, cosa
->rxsize
);
1840 cosa
->rxsize
= cosa_getdata16(cosa
);
1842 debug_data_in(cosa
, cosa
->rxsize
);
1845 pr_info("cosa%d: receive rxsize = (0x%04x)\n",
1846 cosa
->num
, cosa
->rxsize
);
1849 if (((cosa
->rxsize
& 0xe000) >> 13) >= cosa
->nchannels
) {
1850 pr_warn("%s: rx for unknown channel (0x%04x)\n",
1851 cosa
->name
, cosa
->rxsize
);
1852 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1855 cosa
->rxchan
= cosa
->chan
+ ((cosa
->rxsize
& 0xe000) >> 13);
1856 cosa
->rxsize
&= 0x1fff;
1857 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1860 if (cosa
->rxchan
->setup_rx
)
1861 cosa
->rxbuf
= cosa
->rxchan
->setup_rx(cosa
->rxchan
, cosa
->rxsize
);
1864 reject
: /* Reject the packet */
1865 pr_info("cosa%d: rejecting packet on channel %d\n",
1866 cosa
->num
, cosa
->rxchan
->num
);
1867 cosa
->rxbuf
= cosa
->bouncebuf
;
1871 flags
= claim_dma_lock();
1872 disable_dma(cosa
->dma
);
1873 clear_dma_ff(cosa
->dma
);
1874 set_dma_mode(cosa
->dma
, DMA_MODE_READ
);
1875 if (cosa_dma_able(cosa
->rxchan
, cosa
->rxbuf
, cosa
->rxsize
& 0x1fff)) {
1876 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->rxbuf
));
1878 set_dma_addr(cosa
->dma
, virt_to_bus(cosa
->bouncebuf
));
1880 set_dma_count(cosa
->dma
, (cosa
->rxsize
&0x1fff));
1881 enable_dma(cosa
->dma
);
1882 release_dma_lock(flags
);
1883 spin_lock_irqsave(&cosa
->lock
, flags
);
1884 cosa_putstatus(cosa
, SR_RX_DMA_ENA
|SR_USR_INT_ENA
);
1885 if (!is_8bit(cosa
) && (status
& SR_TX_RDY
))
1886 cosa_putdata8(cosa
, DRIVER_RX_READY
);
1888 debug_status_out(cosa
, SR_RX_DMA_ENA
|SR_USR_INT_ENA
);
1889 if (!is_8bit(cosa
) && (status
& SR_TX_RDY
))
1890 debug_data_cmd(cosa
, DRIVER_RX_READY
);
1892 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1895 static inline void eot_interrupt(struct cosa_data
*cosa
, int status
)
1897 unsigned long flags
, flags1
;
1898 spin_lock_irqsave(&cosa
->lock
, flags
);
1899 flags1
= claim_dma_lock();
1900 disable_dma(cosa
->dma
);
1901 clear_dma_ff(cosa
->dma
);
1902 release_dma_lock(flags1
);
1903 if (test_bit(TXBIT
, &cosa
->rxtx
)) {
1904 struct channel_data
*chan
= cosa
->chan
+cosa
->txchan
;
1906 if (chan
->tx_done(chan
, cosa
->txsize
))
1907 clear_bit(chan
->num
, &cosa
->txbitmap
);
1908 } else if (test_bit(RXBIT
, &cosa
->rxtx
)) {
1912 pr_info("cosa%dc%d: done rx(0x%x)",
1913 cosa
->num
, cosa
->rxchan
->num
, cosa
->rxsize
);
1914 for (i
=0; i
<cosa
->rxsize
; i
++)
1915 pr_cont(" %02x", cosa
->rxbuf
[i
]&0xff);
1919 /* Packet for unknown channel? */
1920 if (cosa
->rxbuf
== cosa
->bouncebuf
)
1922 if (!cosa_dma_able(cosa
->rxchan
, cosa
->rxbuf
, cosa
->rxsize
))
1923 memcpy(cosa
->rxbuf
, cosa
->bouncebuf
, cosa
->rxsize
);
1924 if (cosa
->rxchan
->rx_done
)
1925 if (cosa
->rxchan
->rx_done(cosa
->rxchan
))
1926 clear_bit(cosa
->rxchan
->num
, &cosa
->rxbitmap
);
1928 pr_notice("cosa%d: unexpected EOT interrupt\n", cosa
->num
);
1931 * Clear the RXBIT, TXBIT and IRQBIT (the latest should be
1932 * cleared anyway). We should do it as soon as possible
1933 * so that we can tell the COSA we are done and to give it a time
1938 put_driver_status_nolock(cosa
);
1939 spin_unlock_irqrestore(&cosa
->lock
, flags
);
1942 static irqreturn_t
cosa_interrupt(int irq
, void *cosa_
)
1946 struct cosa_data
*cosa
= cosa_
;
1948 status
= cosa_getstatus(cosa
);
1950 pr_info("cosa%d: got IRQ, status 0x%02x\n", cosa
->num
, status
& 0xff);
1953 debug_status_in(cosa
, status
);
1955 switch (status
& SR_CMD_FROM_SRP_MASK
) {
1956 case SR_DOWN_REQUEST
:
1957 tx_interrupt(cosa
, status
);
1960 rx_interrupt(cosa
, status
);
1962 case SR_END_OF_TRANSFER
:
1963 eot_interrupt(cosa
, status
);
1966 /* We may be too fast for SRP. Try to wait a bit more. */
1967 if (count
++ < 100) {
1971 pr_info("cosa%d: unknown status 0x%02x in IRQ after %d retries\n",
1972 cosa
->num
, status
& 0xff, count
);
1976 pr_info("%s: %d-times got unknown status in IRQ\n",
1979 pr_info("%s: returning from IRQ\n", cosa
->name
);
1985 /* ---------- I/O debugging routines ---------- */
1987 * These routines can be used to monitor COSA/SRP I/O and to printk()
1988 * the data being transferred on the data and status I/O port in a
1993 static void debug_status_in(struct cosa_data
*cosa
, int status
)
1996 switch (status
& SR_CMD_FROM_SRP_MASK
) {
2000 case SR_DOWN_REQUEST
:
2003 case SR_END_OF_TRANSFER
:
2010 pr_info("%s: IO: status -> 0x%02x (%s%s%s%s)\n",
2013 status
& SR_USR_RQ
? "USR_RQ|" : "",
2014 status
& SR_TX_RDY
? "TX_RDY|" : "",
2015 status
& SR_RX_RDY
? "RX_RDY|" : "",
2019 static void debug_status_out(struct cosa_data
*cosa
, int status
)
2021 pr_info("%s: IO: status <- 0x%02x (%s%s%s%s%s%s)\n",
2024 status
& SR_RX_DMA_ENA
? "RXDMA|" : "!rxdma|",
2025 status
& SR_TX_DMA_ENA
? "TXDMA|" : "!txdma|",
2026 status
& SR_RST
? "RESET|" : "",
2027 status
& SR_USR_INT_ENA
? "USRINT|" : "!usrint|",
2028 status
& SR_TX_INT_ENA
? "TXINT|" : "!txint|",
2029 status
& SR_RX_INT_ENA
? "RXINT" : "!rxint");
2032 static void debug_data_in(struct cosa_data
*cosa
, int data
)
2034 pr_info("%s: IO: data -> 0x%04x\n", cosa
->name
, data
);
2037 static void debug_data_out(struct cosa_data
*cosa
, int data
)
2039 pr_info("%s: IO: data <- 0x%04x\n", cosa
->name
, data
);
2042 static void debug_data_cmd(struct cosa_data
*cosa
, int data
)
2044 pr_info("%s: IO: data <- 0x%04x (%s|%s)\n",
2046 data
& SR_RDY_RCV
? "RX_RDY" : "!rx_rdy",
2047 data
& SR_RDY_SND
? "TX_RDY" : "!tx_rdy");
2051 /* EOF -- this file has not been truncated */