2 * This program is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU General Public License
4 * as published by the Free Software Foundation; either version
5 * 2 of the License, or (at your option) any later version.
7 * Original driver code supplied by Multi-Tech
11 * Merge to 2.0.x kernel tree
12 * Obtain and use official major/minors
13 * Loader switched to a misc device
14 * (fixed range check bug as a side effect)
19 * 10/6/99 sameer Merged the ISA and PCI drivers to
20 * a new unified driver.
22 * 3/9/99 sameer Added support for ISI4616 cards.
24 * 16/9/99 sameer We do not force RTS low anymore.
25 * This is to prevent the firmware
26 * from getting confused.
28 * 26/10/99 sameer Cosmetic changes:The driver now
29 * dumps the Port Count information
30 * along with I/O address and IRQ.
32 * 13/12/99 sameer Fixed the problem with IRQ sharing.
34 * 10/5/00 sameer Fixed isicom_shutdown_board()
35 * to not lower DTR on all the ports
36 * when the last port on the card is
39 * 10/5/00 sameer Signal mask setup command added
40 * to isicom_setup_port and
41 * isicom_shutdown_port.
43 * 24/5/00 sameer The driver is now SMP aware.
46 * 27/11/00 Vinayak P Risbud Fixed the Driver Crash Problem
49 * 03/01/01 anil .s Added support for resetting the
50 * internal modems on ISI cards.
52 * 08/02/01 anil .s Upgraded the driver for kernel
55 * 11/04/01 Kevin Fixed firmware load problem with
58 * 30/04/01 anil .s Fixed the remote login through
59 * ISI port problem. Now the link
60 * does not go down before password
63 * 03/05/01 anil .s Fixed the problem with IRQ sharing
64 * among ISI-PCI cards.
66 * 03/05/01 anil .s Added support to display the version
67 * info during insmod as well as module
70 * 10/05/01 anil .s Done the modifications to the source
71 * file and Install script so that the
72 * same installation can be used for
73 * 2.2.x and 2.4.x kernel.
75 * 06/06/01 anil .s Now we drop both dtr and rts during
76 * shutdown_port as well as raise them
77 * during isicom_config_port.
80 * restore_flags on failure in
81 * isicom_send_break, verify put_user
84 * 11/02/03 ranjeeth Added support for 230 Kbps and 460 Kbps
85 * Baud index extended to 21
87 * 20/03/03 ranjeeth Made to work for Linux Advanced server.
88 * Taken care of license warning.
90 * 10/12/03 Ravindra Made to work for Fedora Core 1 of
91 * Red Hat Distribution
93 * 06/01/05 Alan Cox Merged the ISI and base kernel strands
94 * into a single 2.6 driver
96 * ***********************************************************
98 * To use this driver you also need the support package. You
99 * can find this in RPM format on
100 * ftp://ftp.linux.org.uk/pub/linux/alan
102 * You can find the original tools for this direct from Multitech
103 * ftp://ftp.multitech.com/ISI-Cards/
105 * Having installed the cards the module options (/etc/modprobe.d/)
107 * options isicom io=card1,card2,card3,card4 irq=card1,card2,card3,card4
109 * Omit those entries for boards you don't have installed.
113 * 64-bit verification
116 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
118 #include <linux/module.h>
119 #include <linux/firmware.h>
120 #include <linux/kernel.h>
121 #include <linux/tty.h>
122 #include <linux/tty_flip.h>
123 #include <linux/termios.h>
124 #include <linux/fs.h>
125 #include <linux/sched.h>
126 #include <linux/serial.h>
127 #include <linux/mm.h>
128 #include <linux/interrupt.h>
129 #include <linux/timer.h>
130 #include <linux/delay.h>
131 #include <linux/ioport.h>
132 #include <linux/slab.h>
134 #include <linux/uaccess.h>
135 #include <linux/io.h>
137 #include <linux/pci.h>
139 #include <linux/isicom.h>
141 #define InterruptTheCard(base) outw(0, (base) + 0xc)
142 #define ClearInterrupt(base) inw((base) + 0x0a)
145 #define isicom_paranoia_check(a, b, c) __isicom_paranoia_check((a), (b), (c))
147 #define isicom_paranoia_check(a, b, c) 0
150 static int isicom_probe(struct pci_dev *, const struct pci_device_id *);
151 static void isicom_remove(struct pci_dev *);
153 static struct pci_device_id isicom_pci_tbl[] = {
154 { PCI_DEVICE(VENDOR_ID, 0x2028) },
155 { PCI_DEVICE(VENDOR_ID, 0x2051) },
156 { PCI_DEVICE(VENDOR_ID, 0x2052) },
157 { PCI_DEVICE(VENDOR_ID, 0x2053) },
158 { PCI_DEVICE(VENDOR_ID, 0x2054) },
159 { PCI_DEVICE(VENDOR_ID, 0x2055) },
160 { PCI_DEVICE(VENDOR_ID, 0x2056) },
161 { PCI_DEVICE(VENDOR_ID, 0x2057) },
162 { PCI_DEVICE(VENDOR_ID, 0x2058) },
165 MODULE_DEVICE_TABLE(pci, isicom_pci_tbl);
167 static struct pci_driver isicom_driver = {
169 .id_table = isicom_pci_tbl,
170 .probe = isicom_probe,
171 .remove = isicom_remove
174 static int prev_card = 3; /* start servicing isi_card[0] */
175 static struct tty_driver *isicom_normal;
177 static void isicom_tx(unsigned long _data);
178 static void isicom_start(struct tty_struct *tty);
180 static DEFINE_TIMER(tx, isicom_tx, 0, 0);
182 /* baud index mappings from linux defns to isi */
184 static signed char linuxb_to_isib[] = {
185 -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13, 15, 16, 17, 18, 19, 20, 21
191 unsigned char port_count;
192 unsigned short status;
193 unsigned short port_status; /* each bit for each port */
194 unsigned short shift_count;
195 struct isi_port *ports;
197 spinlock_t card_lock; /* Card wide lock 11/5/00 -sameer */
203 unsigned short magic;
204 struct tty_port port;
207 struct isi_board *card;
208 unsigned char *xmit_buf;
214 static struct isi_board isi_card[BOARD_COUNT];
215 static struct isi_port isi_ports[PORT_COUNT];
218 * Locking functions for card level locking. We need to own both
219 * the kernel lock for the card and have the card in a position that
223 static int WaitTillCardIsFree(unsigned long base)
225 unsigned int count = 0;
226 unsigned int a = in_atomic(); /* do we run under spinlock? */
228 while (!(inw(base + 0xe) & 0x1) && count++ < 100)
234 return !(inw(base + 0xe) & 0x1);
237 static int lock_card(struct isi_board *card)
239 unsigned long base = card->base;
240 unsigned int retries, a;
242 for (retries = 0; retries < 10; retries++) {
243 spin_lock_irqsave(&card->card_lock, card->flags);
244 for (a = 0; a < 10; a++) {
245 if (inw(base + 0xe) & 0x1)
249 spin_unlock_irqrestore(&card->card_lock, card->flags);
252 pr_warn("Failed to lock Card (0x%lx)\n", card->base);
254 return 0; /* Failed to acquire the card! */
257 static void unlock_card(struct isi_board *card)
259 spin_unlock_irqrestore(&card->card_lock, card->flags);
263 * ISI Card specific ops ...
266 /* card->lock HAS to be held */
267 static void raise_dtr(struct isi_port *port)
269 struct isi_board *card = port->card;
270 unsigned long base = card->base;
271 u16 channel = port->channel;
273 if (WaitTillCardIsFree(base))
276 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
278 InterruptTheCard(base);
279 port->status |= ISI_DTR;
282 /* card->lock HAS to be held */
283 static void drop_dtr(struct isi_port *port)
285 struct isi_board *card = port->card;
286 unsigned long base = card->base;
287 u16 channel = port->channel;
289 if (WaitTillCardIsFree(base))
292 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
294 InterruptTheCard(base);
295 port->status &= ~ISI_DTR;
298 /* card->lock HAS to be held */
299 static inline void raise_rts(struct isi_port *port)
301 struct isi_board *card = port->card;
302 unsigned long base = card->base;
303 u16 channel = port->channel;
305 if (WaitTillCardIsFree(base))
308 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
310 InterruptTheCard(base);
311 port->status |= ISI_RTS;
314 /* card->lock HAS to be held */
315 static inline void drop_rts(struct isi_port *port)
317 struct isi_board *card = port->card;
318 unsigned long base = card->base;
319 u16 channel = port->channel;
321 if (WaitTillCardIsFree(base))
324 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
326 InterruptTheCard(base);
327 port->status &= ~ISI_RTS;
330 /* card->lock MUST NOT be held */
332 static void isicom_dtr_rts(struct tty_port *port, int on)
334 struct isi_port *ip = container_of(port, struct isi_port, port);
335 struct isi_board *card = ip->card;
336 unsigned long base = card->base;
337 u16 channel = ip->channel;
339 if (!lock_card(card))
343 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
345 InterruptTheCard(base);
346 ip->status |= (ISI_DTR | ISI_RTS);
348 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
350 InterruptTheCard(base);
351 ip->status &= ~(ISI_DTR | ISI_RTS);
356 /* card->lock HAS to be held */
357 static void drop_dtr_rts(struct isi_port *port)
359 struct isi_board *card = port->card;
360 unsigned long base = card->base;
361 u16 channel = port->channel;
363 if (WaitTillCardIsFree(base))
366 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
368 InterruptTheCard(base);
369 port->status &= ~(ISI_RTS | ISI_DTR);
373 * ISICOM Driver specific routines ...
377 static inline int __isicom_paranoia_check(struct isi_port const *port,
378 char *name, const char *routine)
381 pr_warn("Warning: bad isicom magic for dev %s in %s\n",
385 if (port->magic != ISICOM_MAGIC) {
386 pr_warn("Warning: NULL isicom port for dev %s in %s\n",
397 * We shovel data into the card buffers on a regular basis. The card
398 * will do the rest of the work for us.
401 static void isicom_tx(unsigned long _data)
403 unsigned long flags, base;
404 unsigned int retries;
405 short count = (BOARD_COUNT-1), card;
406 short txcount, wrd, residue, word_count, cnt;
407 struct isi_port *port;
408 struct tty_struct *tty;
410 /* find next active board */
411 card = (prev_card + 1) & 0x0003;
412 while (count-- > 0) {
413 if (isi_card[card].status & BOARD_ACTIVE)
415 card = (card + 1) & 0x0003;
417 if (!(isi_card[card].status & BOARD_ACTIVE))
422 count = isi_card[card].port_count;
423 port = isi_card[card].ports;
424 base = isi_card[card].base;
426 spin_lock_irqsave(&isi_card[card].card_lock, flags);
427 for (retries = 0; retries < 100; retries++) {
428 if (inw(base + 0xe) & 0x1)
435 tty = tty_port_tty_get(&port->port);
439 for (; count > 0; count--, port++) {
440 /* port not active or tx disabled to force flow control */
441 if (!(port->port.flags & ASYNC_INITIALIZED) ||
442 !(port->status & ISI_TXOK))
445 txcount = min_t(short, TX_SIZE, port->xmit_cnt);
446 if (txcount <= 0 || tty->stopped || tty->hw_stopped)
449 if (!(inw(base + 0x02) & (1 << port->channel)))
452 pr_debug("txing %d bytes, port%d.\n",
453 txcount, port->channel + 1);
454 outw((port->channel << isi_card[card].shift_count) | txcount,
459 cnt = min_t(int, txcount, (SERIAL_XMIT_SIZE
461 if (residue == YES) {
464 wrd |= (port->port.xmit_buf[port->xmit_tail]
466 port->xmit_tail = (port->xmit_tail + 1)
467 & (SERIAL_XMIT_SIZE - 1);
479 word_count = cnt >> 1;
480 outsw(base, port->port.xmit_buf+port->xmit_tail, word_count);
481 port->xmit_tail = (port->xmit_tail
482 + (word_count << 1)) & (SERIAL_XMIT_SIZE - 1);
483 txcount -= (word_count << 1);
484 port->xmit_cnt -= (word_count << 1);
487 wrd = port->port.xmit_buf[port->xmit_tail];
488 port->xmit_tail = (port->xmit_tail + 1)
489 & (SERIAL_XMIT_SIZE - 1);
495 InterruptTheCard(base);
496 if (port->xmit_cnt <= 0)
497 port->status &= ~ISI_TXOK;
498 if (port->xmit_cnt <= WAKEUP_CHARS)
505 spin_unlock_irqrestore(&isi_card[card].card_lock, flags);
506 /* schedule another tx for hopefully in about 10ms */
508 mod_timer(&tx, jiffies + msecs_to_jiffies(10));
512 * Main interrupt handler routine
515 static irqreturn_t isicom_interrupt(int irq, void *dev_id)
517 struct isi_board *card = dev_id;
518 struct isi_port *port;
519 struct tty_struct *tty;
521 u16 header, word_count, count, channel;
525 if (!card || !(card->status & FIRMWARE_LOADED))
530 /* did the card interrupt us? */
531 if (!(inw(base + 0x0e) & 0x02))
534 spin_lock(&card->card_lock);
537 * disable any interrupts from the PCI card and lower the
540 outw(0x8000, base+0x04);
541 ClearInterrupt(base);
543 inw(base); /* get the dummy word out */
545 channel = (header & 0x7800) >> card->shift_count;
546 byte_count = header & 0xff;
548 if (channel + 1 > card->port_count) {
549 pr_warn("%s(0x%lx): %d(channel) > port_count\n",
550 __func__, base, channel + 1);
551 outw(0x0000, base+0x04); /* enable interrupts */
552 spin_unlock(&card->card_lock);
555 port = card->ports + channel;
556 if (!(port->port.flags & ASYNC_INITIALIZED)) {
557 outw(0x0000, base+0x04); /* enable interrupts */
558 spin_unlock(&card->card_lock);
562 tty = tty_port_tty_get(&port->port);
564 word_count = byte_count >> 1;
565 while (byte_count > 1) {
569 if (byte_count & 0x01)
571 outw(0x0000, base+0x04); /* enable interrupts */
572 spin_unlock(&card->card_lock);
576 if (header & 0x8000) { /* Status Packet */
578 switch (header & 0xff) {
579 case 0: /* Change in EIA signals */
580 if (port->port.flags & ASYNC_CHECK_CD) {
581 if (port->status & ISI_DCD) {
582 if (!(header & ISI_DCD)) {
583 /* Carrier has been lost */
584 pr_debug("%s: DCD->low.\n",
586 port->status &= ~ISI_DCD;
589 } else if (header & ISI_DCD) {
590 /* Carrier has been detected */
591 pr_debug("%s: DCD->high.\n",
593 port->status |= ISI_DCD;
594 wake_up_interruptible(&port->port.open_wait);
597 if (header & ISI_DCD)
598 port->status |= ISI_DCD;
600 port->status &= ~ISI_DCD;
603 if (tty_port_cts_enabled(&port->port)) {
604 if (tty->hw_stopped) {
605 if (header & ISI_CTS) {
608 port->status |= (ISI_TXOK
612 } else if (!(header & ISI_CTS)) {
615 port->status &= ~(ISI_TXOK | ISI_CTS);
618 if (header & ISI_CTS)
619 port->status |= ISI_CTS;
621 port->status &= ~ISI_CTS;
624 if (header & ISI_DSR)
625 port->status |= ISI_DSR;
627 port->status &= ~ISI_DSR;
630 port->status |= ISI_RI;
632 port->status &= ~ISI_RI;
636 case 1: /* Received Break !!! */
637 tty_insert_flip_char(&port->port, 0, TTY_BREAK);
638 if (port->port.flags & ASYNC_SAK)
640 tty_flip_buffer_push(&port->port);
643 case 2: /* Statistics */
644 pr_debug("%s: stats!!!\n", __func__);
648 pr_debug("%s: Unknown code in status packet.\n",
652 } else { /* Data Packet */
653 count = tty_prepare_flip_string(&port->port, &rp,
655 pr_debug("%s: Can rx %d of %d bytes.\n",
656 __func__, count, byte_count);
657 word_count = count >> 1;
658 insw(base, rp, word_count);
659 byte_count -= (word_count << 1);
660 if (count & 0x0001) {
661 tty_insert_flip_char(&port->port, inw(base) & 0xff,
665 if (byte_count > 0) {
666 pr_debug("%s(0x%lx:%d): Flip buffer overflow! dropping bytes...\n",
667 __func__, base, channel + 1);
668 /* drain out unread xtra data */
669 while (byte_count > 0) {
674 tty_flip_buffer_push(&port->port);
676 outw(0x0000, base+0x04); /* enable interrupts */
677 spin_unlock(&card->card_lock);
683 static void isicom_config_port(struct tty_struct *tty)
685 struct isi_port *port = tty->driver_data;
686 struct isi_board *card = port->card;
688 unsigned long base = card->base;
689 u16 channel_setup, channel = port->channel,
690 shift_count = card->shift_count;
691 unsigned char flow_ctrl;
693 /* FIXME: Switch to new tty baud API */
695 if (baud & CBAUDEX) {
698 /* if CBAUDEX bit is on and the baud is set to either 50 or 75
699 * then the card is programmed for 57.6Kbps or 115Kbps
703 /* 1,2,3,4 => 57.6, 115.2, 230, 460 kbps resp. */
704 if (baud < 1 || baud > 4)
705 tty->termios.c_cflag &= ~CBAUDEX;
711 /* the ASYNC_SPD_HI and ASYNC_SPD_VHI options are set
712 * by the set_serial_info ioctl ... this is done by
713 * the 'setserial' utility.
716 if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
717 baud++; /* 57.6 Kbps */
718 if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
719 baud += 2; /* 115 Kbps */
720 if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
721 baud += 3; /* 230 kbps*/
722 if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
723 baud += 4; /* 460 kbps*/
725 if (linuxb_to_isib[baud] == -1) {
732 if (WaitTillCardIsFree(base) == 0) {
733 outw(0x8000 | (channel << shift_count) | 0x03, base);
734 outw(linuxb_to_isib[baud] << 8 | 0x03, base);
736 switch (C_CSIZE(tty)) {
738 channel_setup |= ISICOM_CS5;
741 channel_setup |= ISICOM_CS6;
744 channel_setup |= ISICOM_CS7;
747 channel_setup |= ISICOM_CS8;
752 channel_setup |= ISICOM_2SB;
754 channel_setup |= ISICOM_EVPAR;
756 channel_setup |= ISICOM_ODPAR;
758 outw(channel_setup, base);
759 InterruptTheCard(base);
762 port->port.flags &= ~ASYNC_CHECK_CD;
764 port->port.flags |= ASYNC_CHECK_CD;
766 /* flow control settings ...*/
768 port->port.flags &= ~ASYNC_CTS_FLOW;
769 if (C_CRTSCTS(tty)) {
770 port->port.flags |= ASYNC_CTS_FLOW;
771 flow_ctrl |= ISICOM_CTSRTS;
774 flow_ctrl |= ISICOM_RESPOND_XONXOFF;
776 flow_ctrl |= ISICOM_INITIATE_XONXOFF;
778 if (WaitTillCardIsFree(base) == 0) {
779 outw(0x8000 | (channel << shift_count) | 0x04, base);
780 outw(flow_ctrl << 8 | 0x05, base);
781 outw((STOP_CHAR(tty)) << 8 | (START_CHAR(tty)), base);
782 InterruptTheCard(base);
785 /* rx enabled -> enable port for rx on the card */
787 card->port_status |= (1 << channel);
788 outw(card->port_status, base + 0x02);
794 static inline void isicom_setup_board(struct isi_board *bp)
797 struct isi_port *port;
800 if (!(bp->status & BOARD_INIT)) {
802 for (channel = 0; channel < bp->port_count; channel++, port++)
805 bp->status |= BOARD_ACTIVE | BOARD_INIT;
808 /* Activate and thus setup board are protected from races against shutdown
809 by the tty_port mutex */
811 static int isicom_activate(struct tty_port *tport, struct tty_struct *tty)
813 struct isi_port *port = container_of(tport, struct isi_port, port);
814 struct isi_board *card = port->card;
817 if (tty_port_alloc_xmit_buf(tport) < 0)
820 spin_lock_irqsave(&card->card_lock, flags);
821 isicom_setup_board(card);
823 port->xmit_cnt = port->xmit_head = port->xmit_tail = 0;
825 /* discard any residual data */
826 if (WaitTillCardIsFree(card->base) == 0) {
827 outw(0x8000 | (port->channel << card->shift_count) | 0x02,
829 outw(((ISICOM_KILLTX | ISICOM_KILLRX) << 8) | 0x06, card->base);
830 InterruptTheCard(card->base);
832 isicom_config_port(tty);
833 spin_unlock_irqrestore(&card->card_lock, flags);
838 static int isicom_carrier_raised(struct tty_port *port)
840 struct isi_port *ip = container_of(port, struct isi_port, port);
841 return (ip->status & ISI_DCD)?1 : 0;
844 static struct tty_port *isicom_find_port(struct tty_struct *tty)
846 struct isi_port *port;
847 struct isi_board *card;
849 int line = tty->index;
852 card = &isi_card[board];
854 if (!(card->status & FIRMWARE_LOADED))
857 /* open on a port greater than the port count for the card !!! */
858 if (line > ((board * 16) + card->port_count - 1))
861 port = &isi_ports[line];
862 if (isicom_paranoia_check(port, tty->name, "isicom_open"))
868 static int isicom_open(struct tty_struct *tty, struct file *filp)
870 struct isi_port *port;
871 struct tty_port *tport;
873 tport = isicom_find_port(tty);
876 port = container_of(tport, struct isi_port, port);
878 tty->driver_data = port;
879 return tty_port_open(tport, tty, filp);
884 /* card->lock HAS to be held */
885 static void isicom_shutdown_port(struct isi_port *port)
887 struct isi_board *card = port->card;
889 if (--card->count < 0) {
890 pr_debug("%s: bad board(0x%lx) count %d.\n",
891 __func__, card->base, card->count);
894 /* last port was closed, shutdown that board too */
896 card->status &= BOARD_ACTIVE;
899 static void isicom_flush_buffer(struct tty_struct *tty)
901 struct isi_port *port = tty->driver_data;
902 struct isi_board *card = port->card;
905 if (isicom_paranoia_check(port, tty->name, "isicom_flush_buffer"))
908 spin_lock_irqsave(&card->card_lock, flags);
909 port->xmit_cnt = port->xmit_head = port->xmit_tail = 0;
910 spin_unlock_irqrestore(&card->card_lock, flags);
915 static void isicom_shutdown(struct tty_port *port)
917 struct isi_port *ip = container_of(port, struct isi_port, port);
918 struct isi_board *card = ip->card;
921 /* indicate to the card that no more data can be received
923 spin_lock_irqsave(&card->card_lock, flags);
924 card->port_status &= ~(1 << ip->channel);
925 outw(card->port_status, card->base + 0x02);
926 isicom_shutdown_port(ip);
927 spin_unlock_irqrestore(&card->card_lock, flags);
928 tty_port_free_xmit_buf(port);
931 static void isicom_close(struct tty_struct *tty, struct file *filp)
933 struct isi_port *ip = tty->driver_data;
934 struct tty_port *port;
940 if (isicom_paranoia_check(ip, tty->name, "isicom_close"))
942 tty_port_close(port, tty, filp);
946 static int isicom_write(struct tty_struct *tty, const unsigned char *buf,
949 struct isi_port *port = tty->driver_data;
950 struct isi_board *card = port->card;
954 if (isicom_paranoia_check(port, tty->name, "isicom_write"))
957 spin_lock_irqsave(&card->card_lock, flags);
960 cnt = min_t(int, count, min(SERIAL_XMIT_SIZE - port->xmit_cnt
961 - 1, SERIAL_XMIT_SIZE - port->xmit_head));
965 memcpy(port->port.xmit_buf + port->xmit_head, buf, cnt);
966 port->xmit_head = (port->xmit_head + cnt) & (SERIAL_XMIT_SIZE
968 port->xmit_cnt += cnt;
973 if (port->xmit_cnt && !tty->stopped && !tty->hw_stopped)
974 port->status |= ISI_TXOK;
975 spin_unlock_irqrestore(&card->card_lock, flags);
979 /* put_char et all */
980 static int isicom_put_char(struct tty_struct *tty, unsigned char ch)
982 struct isi_port *port = tty->driver_data;
983 struct isi_board *card = port->card;
986 if (isicom_paranoia_check(port, tty->name, "isicom_put_char"))
989 spin_lock_irqsave(&card->card_lock, flags);
990 if (port->xmit_cnt >= SERIAL_XMIT_SIZE - 1) {
991 spin_unlock_irqrestore(&card->card_lock, flags);
995 port->port.xmit_buf[port->xmit_head++] = ch;
996 port->xmit_head &= (SERIAL_XMIT_SIZE - 1);
998 spin_unlock_irqrestore(&card->card_lock, flags);
1002 /* flush_chars et all */
1003 static void isicom_flush_chars(struct tty_struct *tty)
1005 struct isi_port *port = tty->driver_data;
1007 if (isicom_paranoia_check(port, tty->name, "isicom_flush_chars"))
1010 if (port->xmit_cnt <= 0 || tty->stopped || tty->hw_stopped ||
1011 !port->port.xmit_buf)
1014 /* this tells the transmitter to consider this port for
1015 data output to the card ... that's the best we can do. */
1016 port->status |= ISI_TXOK;
1019 /* write_room et all */
1020 static int isicom_write_room(struct tty_struct *tty)
1022 struct isi_port *port = tty->driver_data;
1025 if (isicom_paranoia_check(port, tty->name, "isicom_write_room"))
1028 free = SERIAL_XMIT_SIZE - port->xmit_cnt - 1;
1034 /* chars_in_buffer et all */
1035 static int isicom_chars_in_buffer(struct tty_struct *tty)
1037 struct isi_port *port = tty->driver_data;
1038 if (isicom_paranoia_check(port, tty->name, "isicom_chars_in_buffer"))
1040 return port->xmit_cnt;
1044 static int isicom_send_break(struct tty_struct *tty, int length)
1046 struct isi_port *port = tty->driver_data;
1047 struct isi_board *card = port->card;
1048 unsigned long base = card->base;
1053 if (!lock_card(card))
1056 outw(0x8000 | ((port->channel) << (card->shift_count)) | 0x3, base);
1057 outw((length & 0xff) << 8 | 0x00, base);
1058 outw((length & 0xff00u), base);
1059 InterruptTheCard(base);
1065 static int isicom_tiocmget(struct tty_struct *tty)
1067 struct isi_port *port = tty->driver_data;
1068 /* just send the port status */
1069 u16 status = port->status;
1071 if (isicom_paranoia_check(port, tty->name, "isicom_ioctl"))
1074 return ((status & ISI_RTS) ? TIOCM_RTS : 0) |
1075 ((status & ISI_DTR) ? TIOCM_DTR : 0) |
1076 ((status & ISI_DCD) ? TIOCM_CAR : 0) |
1077 ((status & ISI_DSR) ? TIOCM_DSR : 0) |
1078 ((status & ISI_CTS) ? TIOCM_CTS : 0) |
1079 ((status & ISI_RI ) ? TIOCM_RI : 0);
1082 static int isicom_tiocmset(struct tty_struct *tty,
1083 unsigned int set, unsigned int clear)
1085 struct isi_port *port = tty->driver_data;
1086 unsigned long flags;
1088 if (isicom_paranoia_check(port, tty->name, "isicom_ioctl"))
1091 spin_lock_irqsave(&port->card->card_lock, flags);
1092 if (set & TIOCM_RTS)
1094 if (set & TIOCM_DTR)
1097 if (clear & TIOCM_RTS)
1099 if (clear & TIOCM_DTR)
1101 spin_unlock_irqrestore(&port->card->card_lock, flags);
1106 static int isicom_set_serial_info(struct tty_struct *tty,
1107 struct serial_struct __user *info)
1109 struct isi_port *port = tty->driver_data;
1110 struct serial_struct newinfo;
1113 if (copy_from_user(&newinfo, info, sizeof(newinfo)))
1116 mutex_lock(&port->port.mutex);
1117 reconfig_port = ((port->port.flags & ASYNC_SPD_MASK) !=
1118 (newinfo.flags & ASYNC_SPD_MASK));
1120 if (!capable(CAP_SYS_ADMIN)) {
1121 if ((newinfo.close_delay != port->port.close_delay) ||
1122 (newinfo.closing_wait != port->port.closing_wait) ||
1123 ((newinfo.flags & ~ASYNC_USR_MASK) !=
1124 (port->port.flags & ~ASYNC_USR_MASK))) {
1125 mutex_unlock(&port->port.mutex);
1128 port->port.flags = ((port->port.flags & ~ASYNC_USR_MASK) |
1129 (newinfo.flags & ASYNC_USR_MASK));
1131 port->port.close_delay = newinfo.close_delay;
1132 port->port.closing_wait = newinfo.closing_wait;
1133 port->port.flags = ((port->port.flags & ~ASYNC_FLAGS) |
1134 (newinfo.flags & ASYNC_FLAGS));
1136 if (reconfig_port) {
1137 unsigned long flags;
1138 spin_lock_irqsave(&port->card->card_lock, flags);
1139 isicom_config_port(tty);
1140 spin_unlock_irqrestore(&port->card->card_lock, flags);
1142 mutex_unlock(&port->port.mutex);
1146 static int isicom_get_serial_info(struct isi_port *port,
1147 struct serial_struct __user *info)
1149 struct serial_struct out_info;
1151 mutex_lock(&port->port.mutex);
1152 memset(&out_info, 0, sizeof(out_info));
1153 /* out_info.type = ? */
1154 out_info.line = port - isi_ports;
1155 out_info.port = port->card->base;
1156 out_info.irq = port->card->irq;
1157 out_info.flags = port->port.flags;
1158 /* out_info.baud_base = ? */
1159 out_info.close_delay = port->port.close_delay;
1160 out_info.closing_wait = port->port.closing_wait;
1161 mutex_unlock(&port->port.mutex);
1162 if (copy_to_user(info, &out_info, sizeof(out_info)))
1167 static int isicom_ioctl(struct tty_struct *tty,
1168 unsigned int cmd, unsigned long arg)
1170 struct isi_port *port = tty->driver_data;
1171 void __user *argp = (void __user *)arg;
1173 if (isicom_paranoia_check(port, tty->name, "isicom_ioctl"))
1178 return isicom_get_serial_info(port, argp);
1181 return isicom_set_serial_info(tty, argp);
1184 return -ENOIOCTLCMD;
1189 /* set_termios et all */
1190 static void isicom_set_termios(struct tty_struct *tty,
1191 struct ktermios *old_termios)
1193 struct isi_port *port = tty->driver_data;
1194 unsigned long flags;
1196 if (isicom_paranoia_check(port, tty->name, "isicom_set_termios"))
1199 if (tty->termios.c_cflag == old_termios->c_cflag &&
1200 tty->termios.c_iflag == old_termios->c_iflag)
1203 spin_lock_irqsave(&port->card->card_lock, flags);
1204 isicom_config_port(tty);
1205 spin_unlock_irqrestore(&port->card->card_lock, flags);
1207 if ((old_termios->c_cflag & CRTSCTS) && !C_CRTSCTS(tty)) {
1208 tty->hw_stopped = 0;
1213 /* throttle et all */
1214 static void isicom_throttle(struct tty_struct *tty)
1216 struct isi_port *port = tty->driver_data;
1217 struct isi_board *card = port->card;
1219 if (isicom_paranoia_check(port, tty->name, "isicom_throttle"))
1222 /* tell the card that this port cannot handle any more data for now */
1223 card->port_status &= ~(1 << port->channel);
1224 outw(card->port_status, card->base + 0x02);
1227 /* unthrottle et all */
1228 static void isicom_unthrottle(struct tty_struct *tty)
1230 struct isi_port *port = tty->driver_data;
1231 struct isi_board *card = port->card;
1233 if (isicom_paranoia_check(port, tty->name, "isicom_unthrottle"))
1236 /* tell the card that this port is ready to accept more data */
1237 card->port_status |= (1 << port->channel);
1238 outw(card->port_status, card->base + 0x02);
1242 static void isicom_stop(struct tty_struct *tty)
1244 struct isi_port *port = tty->driver_data;
1246 if (isicom_paranoia_check(port, tty->name, "isicom_stop"))
1249 /* this tells the transmitter not to consider this port for
1250 data output to the card. */
1251 port->status &= ~ISI_TXOK;
1255 static void isicom_start(struct tty_struct *tty)
1257 struct isi_port *port = tty->driver_data;
1259 if (isicom_paranoia_check(port, tty->name, "isicom_start"))
1262 /* this tells the transmitter to consider this port for
1263 data output to the card. */
1264 port->status |= ISI_TXOK;
1267 static void isicom_hangup(struct tty_struct *tty)
1269 struct isi_port *port = tty->driver_data;
1271 if (isicom_paranoia_check(port, tty->name, "isicom_hangup"))
1273 tty_port_hangup(&port->port);
1278 * Driver init and deinit functions
1281 static const struct tty_operations isicom_ops = {
1282 .open = isicom_open,
1283 .close = isicom_close,
1284 .write = isicom_write,
1285 .put_char = isicom_put_char,
1286 .flush_chars = isicom_flush_chars,
1287 .write_room = isicom_write_room,
1288 .chars_in_buffer = isicom_chars_in_buffer,
1289 .ioctl = isicom_ioctl,
1290 .set_termios = isicom_set_termios,
1291 .throttle = isicom_throttle,
1292 .unthrottle = isicom_unthrottle,
1293 .stop = isicom_stop,
1294 .start = isicom_start,
1295 .hangup = isicom_hangup,
1296 .flush_buffer = isicom_flush_buffer,
1297 .tiocmget = isicom_tiocmget,
1298 .tiocmset = isicom_tiocmset,
1299 .break_ctl = isicom_send_break,
1302 static const struct tty_port_operations isicom_port_ops = {
1303 .carrier_raised = isicom_carrier_raised,
1304 .dtr_rts = isicom_dtr_rts,
1305 .activate = isicom_activate,
1306 .shutdown = isicom_shutdown,
1309 static int reset_card(struct pci_dev *pdev,
1310 const unsigned int card, unsigned int *signature)
1312 struct isi_board *board = pci_get_drvdata(pdev);
1313 unsigned long base = board->base;
1314 unsigned int sig, portcount = 0;
1317 dev_dbg(&pdev->dev, "ISILoad:Resetting Card%d at 0x%lx\n", card + 1,
1324 outw(0, base + 0x8); /* Reset */
1328 sig = inw(base + 0x4) & 0xff;
1330 if (sig != 0xa5 && sig != 0xbb && sig != 0xcc && sig != 0xdd &&
1332 dev_warn(&pdev->dev, "ISILoad:Card%u reset failure (Possible "
1333 "bad I/O Port Address 0x%lx).\n", card + 1, base);
1334 dev_dbg(&pdev->dev, "Sig=0x%x\n", sig);
1341 portcount = inw(base + 0x2);
1342 if (!(inw(base + 0xe) & 0x1) || (portcount != 0 && portcount != 4 &&
1343 portcount != 8 && portcount != 16)) {
1344 dev_err(&pdev->dev, "ISILoad:PCI Card%d reset failure.\n",
1354 board->port_count = (portcount == 4) ? 4 : 8;
1355 board->shift_count = 12;
1359 board->port_count = 16;
1360 board->shift_count = 11;
1363 dev_info(&pdev->dev, "-Done\n");
1370 static int load_firmware(struct pci_dev *pdev,
1371 const unsigned int index, const unsigned int signature)
1373 struct isi_board *board = pci_get_drvdata(pdev);
1374 const struct firmware *fw;
1375 unsigned long base = board->base;
1377 u16 word_count, status;
1388 switch (signature) {
1390 name = "isi608.bin";
1393 name = "isi608em.bin";
1396 name = "isi616em.bin";
1399 name = "isi4608.bin";
1402 name = "isi4616.bin";
1405 dev_err(&pdev->dev, "Unknown signature.\n");
1409 retval = request_firmware(&fw, name, &pdev->dev);
1415 for (frame = (struct stframe *)fw->data;
1416 frame < (struct stframe *)(fw->data + fw->size);
1417 frame = (struct stframe *)((u8 *)(frame + 1) +
1419 if (WaitTillCardIsFree(base))
1422 outw(0xf0, base); /* start upload sequence */
1424 outw(frame->addr, base); /* lsb of address */
1426 word_count = frame->count / 2 + frame->count % 2;
1427 outw(word_count, base);
1428 InterruptTheCard(base);
1430 udelay(100); /* 0x2f */
1432 if (WaitTillCardIsFree(base))
1435 status = inw(base + 0x4);
1437 dev_warn(&pdev->dev, "Card%d rejected load header:\n"
1441 index + 1, frame->addr, frame->count, status);
1444 outsw(base, frame->data, word_count);
1446 InterruptTheCard(base);
1448 udelay(50); /* 0x0f */
1450 if (WaitTillCardIsFree(base))
1453 status = inw(base + 0x4);
1455 dev_err(&pdev->dev, "Card%d got out of sync.Card "
1456 "Status:0x%x\n", index + 1, status);
1461 /* XXX: should we test it by reading it back and comparing with original like
1462 * in load firmware package? */
1463 for (frame = (struct stframe *)fw->data;
1464 frame < (struct stframe *)(fw->data + fw->size);
1465 frame = (struct stframe *)((u8 *)(frame + 1) +
1467 if (WaitTillCardIsFree(base))
1470 outw(0xf1, base); /* start download sequence */
1472 outw(frame->addr, base); /* lsb of address */
1474 word_count = (frame->count >> 1) + frame->count % 2;
1475 outw(word_count + 1, base);
1476 InterruptTheCard(base);
1478 udelay(50); /* 0xf */
1480 if (WaitTillCardIsFree(base))
1483 status = inw(base + 0x4);
1485 dev_warn(&pdev->dev, "Card%d rejected verify header:\n"
1489 index + 1, frame->addr, frame->count, status);
1493 data = kmalloc(word_count * 2, GFP_KERNEL);
1495 dev_err(&pdev->dev, "Card%d, firmware upload "
1496 "failed, not enough memory\n", index + 1);
1500 insw(base, data, word_count);
1501 InterruptTheCard(base);
1503 for (a = 0; a < frame->count; a++)
1504 if (data[a] != frame->data[a]) {
1506 dev_err(&pdev->dev, "Card%d, firmware upload "
1507 "failed\n", index + 1);
1512 udelay(50); /* 0xf */
1514 if (WaitTillCardIsFree(base))
1517 status = inw(base + 0x4);
1519 dev_err(&pdev->dev, "Card%d verify got out of sync. "
1520 "Card Status:0x%x\n", index + 1, status);
1526 if (WaitTillCardIsFree(base))
1533 InterruptTheCard(base);
1534 outw(0x0, base + 0x4); /* for ISI4608 cards */
1536 board->status |= FIRMWARE_LOADED;
1540 release_firmware(fw);
1546 * Insmod can set static symbols so keep these static
1548 static unsigned int card_count;
1550 static int isicom_probe(struct pci_dev *pdev,
1551 const struct pci_device_id *ent)
1553 unsigned int uninitialized_var(signature), index;
1554 int retval = -EPERM;
1555 struct isi_board *board = NULL;
1557 if (card_count >= BOARD_COUNT)
1560 retval = pci_enable_device(pdev);
1562 dev_err(&pdev->dev, "failed to enable\n");
1566 dev_info(&pdev->dev, "ISI PCI Card(Device ID 0x%x)\n", ent->device);
1568 /* allot the first empty slot in the array */
1569 for (index = 0; index < BOARD_COUNT; index++) {
1570 if (isi_card[index].base == 0) {
1571 board = &isi_card[index];
1575 if (index == BOARD_COUNT) {
1580 board->index = index;
1581 board->base = pci_resource_start(pdev, 3);
1582 board->irq = pdev->irq;
1585 pci_set_drvdata(pdev, board);
1587 retval = pci_request_region(pdev, 3, ISICOM_NAME);
1589 dev_err(&pdev->dev, "I/O Region 0x%lx-0x%lx is busy. Card%d "
1590 "will be disabled.\n", board->base, board->base + 15,
1596 retval = request_irq(board->irq, isicom_interrupt,
1597 IRQF_SHARED, ISICOM_NAME, board);
1599 dev_err(&pdev->dev, "Could not install handler at Irq %d. "
1600 "Card%d will be disabled.\n", board->irq, index + 1);
1604 retval = reset_card(pdev, index, &signature);
1608 retval = load_firmware(pdev, index, signature);
1612 for (index = 0; index < board->port_count; index++) {
1613 struct tty_port *tport = &board->ports[index].port;
1614 tty_port_init(tport);
1615 tport->ops = &isicom_port_ops;
1616 tport->close_delay = 50 * HZ/100;
1617 tport->closing_wait = 3000 * HZ/100;
1618 tty_port_register_device(tport, isicom_normal,
1619 board->index * 16 + index, &pdev->dev);
1625 free_irq(board->irq, board);
1627 pci_release_region(pdev, 3);
1632 pci_disable_device(pdev);
1637 static void isicom_remove(struct pci_dev *pdev)
1639 struct isi_board *board = pci_get_drvdata(pdev);
1642 for (i = 0; i < board->port_count; i++) {
1643 tty_unregister_device(isicom_normal, board->index * 16 + i);
1644 tty_port_destroy(&board->ports[i].port);
1647 free_irq(board->irq, board);
1648 pci_release_region(pdev, 3);
1651 pci_disable_device(pdev);
1654 static int __init isicom_init(void)
1656 int retval, idx, channel;
1657 struct isi_port *port;
1659 for (idx = 0; idx < BOARD_COUNT; idx++) {
1660 port = &isi_ports[idx * 16];
1661 isi_card[idx].ports = port;
1662 spin_lock_init(&isi_card[idx].card_lock);
1663 for (channel = 0; channel < 16; channel++, port++) {
1664 port->magic = ISICOM_MAGIC;
1665 port->card = &isi_card[idx];
1666 port->channel = channel;
1670 isi_card[idx].base = 0;
1671 isi_card[idx].irq = 0;
1674 /* tty driver structure initialization */
1675 isicom_normal = alloc_tty_driver(PORT_COUNT);
1676 if (!isicom_normal) {
1681 isicom_normal->name = "ttyM";
1682 isicom_normal->major = ISICOM_NMAJOR;
1683 isicom_normal->minor_start = 0;
1684 isicom_normal->type = TTY_DRIVER_TYPE_SERIAL;
1685 isicom_normal->subtype = SERIAL_TYPE_NORMAL;
1686 isicom_normal->init_termios = tty_std_termios;
1687 isicom_normal->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
1689 isicom_normal->flags = TTY_DRIVER_REAL_RAW |
1690 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_HARDWARE_BREAK;
1691 tty_set_operations(isicom_normal, &isicom_ops);
1693 retval = tty_register_driver(isicom_normal);
1695 pr_debug("Couldn't register the dialin driver\n");
1699 retval = pci_register_driver(&isicom_driver);
1701 pr_err("Unable to register pci driver.\n");
1705 mod_timer(&tx, jiffies + 1);
1709 tty_unregister_driver(isicom_normal);
1711 put_tty_driver(isicom_normal);
1716 static void __exit isicom_exit(void)
1718 del_timer_sync(&tx);
1720 pci_unregister_driver(&isicom_driver);
1721 tty_unregister_driver(isicom_normal);
1722 put_tty_driver(isicom_normal);
1725 module_init(isicom_init);
1726 module_exit(isicom_exit);
1728 MODULE_AUTHOR("MultiTech");
1729 MODULE_DESCRIPTION("Driver for the ISI series of cards by MultiTech");
1730 MODULE_LICENSE("GPL");
1731 MODULE_FIRMWARE("isi608.bin");
1732 MODULE_FIRMWARE("isi608em.bin");
1733 MODULE_FIRMWARE("isi616em.bin");
1734 MODULE_FIRMWARE("isi4608.bin");
1735 MODULE_FIRMWARE("isi4616.bin");