1 // SPDX-License-Identifier: GPL-2.0+
3 * Original driver code supplied by Multi-Tech
7 * Merge to 2.0.x kernel tree
8 * Obtain and use official major/minors
9 * Loader switched to a misc device
10 * (fixed range check bug as a side effect)
15 * 10/6/99 sameer Merged the ISA and PCI drivers to
16 * a new unified driver.
18 * 3/9/99 sameer Added support for ISI4616 cards.
20 * 16/9/99 sameer We do not force RTS low anymore.
21 * This is to prevent the firmware
22 * from getting confused.
24 * 26/10/99 sameer Cosmetic changes:The driver now
25 * dumps the Port Count information
26 * along with I/O address and IRQ.
28 * 13/12/99 sameer Fixed the problem with IRQ sharing.
30 * 10/5/00 sameer Fixed isicom_shutdown_board()
31 * to not lower DTR on all the ports
32 * when the last port on the card is
35 * 10/5/00 sameer Signal mask setup command added
36 * to isicom_setup_port and
37 * isicom_shutdown_port.
39 * 24/5/00 sameer The driver is now SMP aware.
42 * 27/11/00 Vinayak P Risbud Fixed the Driver Crash Problem
45 * 03/01/01 anil .s Added support for resetting the
46 * internal modems on ISI cards.
48 * 08/02/01 anil .s Upgraded the driver for kernel
51 * 11/04/01 Kevin Fixed firmware load problem with
54 * 30/04/01 anil .s Fixed the remote login through
55 * ISI port problem. Now the link
56 * does not go down before password
59 * 03/05/01 anil .s Fixed the problem with IRQ sharing
60 * among ISI-PCI cards.
62 * 03/05/01 anil .s Added support to display the version
63 * info during insmod as well as module
66 * 10/05/01 anil .s Done the modifications to the source
67 * file and Install script so that the
68 * same installation can be used for
69 * 2.2.x and 2.4.x kernel.
71 * 06/06/01 anil .s Now we drop both dtr and rts during
72 * shutdown_port as well as raise them
73 * during isicom_config_port.
76 * restore_flags on failure in
77 * isicom_send_break, verify put_user
80 * 11/02/03 ranjeeth Added support for 230 Kbps and 460 Kbps
81 * Baud index extended to 21
83 * 20/03/03 ranjeeth Made to work for Linux Advanced server.
84 * Taken care of license warning.
86 * 10/12/03 Ravindra Made to work for Fedora Core 1 of
87 * Red Hat Distribution
89 * 06/01/05 Alan Cox Merged the ISI and base kernel strands
90 * into a single 2.6 driver
92 * ***********************************************************
94 * To use this driver you also need the support package. You
95 * can find this in RPM format on
96 * ftp://ftp.linux.org.uk/pub/linux/alan
98 * You can find the original tools for this direct from Multitech
99 * ftp://ftp.multitech.com/ISI-Cards/
101 * Having installed the cards the module options (/etc/modprobe.d/)
103 * options isicom io=card1,card2,card3,card4 irq=card1,card2,card3,card4
105 * Omit those entries for boards you don't have installed.
109 * 64-bit verification
112 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
114 #include <linux/module.h>
115 #include <linux/firmware.h>
116 #include <linux/kernel.h>
117 #include <linux/tty.h>
118 #include <linux/tty_flip.h>
119 #include <linux/termios.h>
120 #include <linux/fs.h>
121 #include <linux/sched.h>
122 #include <linux/serial.h>
123 #include <linux/mm.h>
124 #include <linux/interrupt.h>
125 #include <linux/timer.h>
126 #include <linux/delay.h>
127 #include <linux/ioport.h>
128 #include <linux/slab.h>
130 #include <linux/uaccess.h>
131 #include <linux/io.h>
133 #include <linux/pci.h>
135 #include <linux/isicom.h>
137 #define InterruptTheCard(base) outw(0, (base) + 0xc)
138 #define ClearInterrupt(base) inw((base) + 0x0a)
141 #define isicom_paranoia_check(a, b, c) __isicom_paranoia_check((a), (b), (c))
143 #define isicom_paranoia_check(a, b, c) 0
146 static int isicom_probe(struct pci_dev *, const struct pci_device_id *);
147 static void isicom_remove(struct pci_dev *);
149 static const struct pci_device_id isicom_pci_tbl[] = {
150 { PCI_DEVICE(VENDOR_ID, 0x2028) },
151 { PCI_DEVICE(VENDOR_ID, 0x2051) },
152 { PCI_DEVICE(VENDOR_ID, 0x2052) },
153 { PCI_DEVICE(VENDOR_ID, 0x2053) },
154 { PCI_DEVICE(VENDOR_ID, 0x2054) },
155 { PCI_DEVICE(VENDOR_ID, 0x2055) },
156 { PCI_DEVICE(VENDOR_ID, 0x2056) },
157 { PCI_DEVICE(VENDOR_ID, 0x2057) },
158 { PCI_DEVICE(VENDOR_ID, 0x2058) },
161 MODULE_DEVICE_TABLE(pci, isicom_pci_tbl);
163 static struct pci_driver isicom_driver = {
165 .id_table = isicom_pci_tbl,
166 .probe = isicom_probe,
167 .remove = isicom_remove
170 static int prev_card = 3; /* start servicing isi_card[0] */
171 static struct tty_driver *isicom_normal;
173 static void isicom_tx(struct timer_list *unused);
174 static void isicom_start(struct tty_struct *tty);
176 static DEFINE_TIMER(tx, isicom_tx);
178 /* baud index mappings from linux defns to isi */
180 static signed char linuxb_to_isib[] = {
181 -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13, 15, 16, 17, 18, 19, 20, 21
187 unsigned char port_count;
188 unsigned short status;
189 unsigned short port_status; /* each bit for each port */
190 unsigned short shift_count;
191 struct isi_port *ports;
193 spinlock_t card_lock; /* Card wide lock 11/5/00 -sameer */
199 unsigned short magic;
200 struct tty_port port;
203 struct isi_board *card;
204 unsigned char *xmit_buf;
210 static struct isi_board isi_card[BOARD_COUNT];
211 static struct isi_port isi_ports[PORT_COUNT];
214 * Locking functions for card level locking. We need to own both
215 * the kernel lock for the card and have the card in a position that
219 static int WaitTillCardIsFree(unsigned long base)
221 unsigned int count = 0;
223 while (!(inw(base + 0xe) & 0x1) && count++ < 100)
226 return !(inw(base + 0xe) & 0x1);
229 static int lock_card(struct isi_board *card)
231 unsigned long base = card->base;
232 unsigned int retries, a;
234 for (retries = 0; retries < 10; retries++) {
235 spin_lock_irqsave(&card->card_lock, card->flags);
236 for (a = 0; a < 10; a++) {
237 if (inw(base + 0xe) & 0x1)
241 spin_unlock_irqrestore(&card->card_lock, card->flags);
244 pr_warn("Failed to lock Card (0x%lx)\n", card->base);
246 return 0; /* Failed to acquire the card! */
249 static void unlock_card(struct isi_board *card)
251 spin_unlock_irqrestore(&card->card_lock, card->flags);
255 * ISI Card specific ops ...
258 /* card->lock HAS to be held */
259 static void raise_dtr(struct isi_port *port)
261 struct isi_board *card = port->card;
262 unsigned long base = card->base;
263 u16 channel = port->channel;
265 if (WaitTillCardIsFree(base))
268 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
270 InterruptTheCard(base);
271 port->status |= ISI_DTR;
274 /* card->lock HAS to be held */
275 static void drop_dtr(struct isi_port *port)
277 struct isi_board *card = port->card;
278 unsigned long base = card->base;
279 u16 channel = port->channel;
281 if (WaitTillCardIsFree(base))
284 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
286 InterruptTheCard(base);
287 port->status &= ~ISI_DTR;
290 /* card->lock HAS to be held */
291 static inline void raise_rts(struct isi_port *port)
293 struct isi_board *card = port->card;
294 unsigned long base = card->base;
295 u16 channel = port->channel;
297 if (WaitTillCardIsFree(base))
300 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
302 InterruptTheCard(base);
303 port->status |= ISI_RTS;
306 /* card->lock HAS to be held */
307 static inline void drop_rts(struct isi_port *port)
309 struct isi_board *card = port->card;
310 unsigned long base = card->base;
311 u16 channel = port->channel;
313 if (WaitTillCardIsFree(base))
316 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
318 InterruptTheCard(base);
319 port->status &= ~ISI_RTS;
322 /* card->lock MUST NOT be held */
324 static void isicom_dtr_rts(struct tty_port *port, int on)
326 struct isi_port *ip = container_of(port, struct isi_port, port);
327 struct isi_board *card = ip->card;
328 unsigned long base = card->base;
329 u16 channel = ip->channel;
331 if (!lock_card(card))
335 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
337 InterruptTheCard(base);
338 ip->status |= (ISI_DTR | ISI_RTS);
340 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
342 InterruptTheCard(base);
343 ip->status &= ~(ISI_DTR | ISI_RTS);
348 /* card->lock HAS to be held */
349 static void drop_dtr_rts(struct isi_port *port)
351 struct isi_board *card = port->card;
352 unsigned long base = card->base;
353 u16 channel = port->channel;
355 if (WaitTillCardIsFree(base))
358 outw(0x8000 | (channel << card->shift_count) | 0x02, base);
360 InterruptTheCard(base);
361 port->status &= ~(ISI_RTS | ISI_DTR);
365 * ISICOM Driver specific routines ...
369 static inline int __isicom_paranoia_check(struct isi_port const *port,
370 char *name, const char *routine)
373 pr_warn("Warning: bad isicom magic for dev %s in %s\n",
377 if (port->magic != ISICOM_MAGIC) {
378 pr_warn("Warning: NULL isicom port for dev %s in %s\n",
389 * We shovel data into the card buffers on a regular basis. The card
390 * will do the rest of the work for us.
393 static void isicom_tx(struct timer_list *unused)
395 unsigned long flags, base;
396 unsigned int retries;
397 short count = (BOARD_COUNT-1), card;
398 short txcount, wrd, residue, word_count, cnt;
399 struct isi_port *port;
400 struct tty_struct *tty;
402 /* find next active board */
403 card = (prev_card + 1) & 0x0003;
404 while (count-- > 0) {
405 if (isi_card[card].status & BOARD_ACTIVE)
407 card = (card + 1) & 0x0003;
409 if (!(isi_card[card].status & BOARD_ACTIVE))
414 count = isi_card[card].port_count;
415 port = isi_card[card].ports;
416 base = isi_card[card].base;
418 spin_lock_irqsave(&isi_card[card].card_lock, flags);
419 for (retries = 0; retries < 100; retries++) {
420 if (inw(base + 0xe) & 0x1)
427 tty = tty_port_tty_get(&port->port);
431 for (; count > 0; count--, port++) {
432 /* port not active or tx disabled to force flow control */
433 if (!tty_port_initialized(&port->port) ||
434 !(port->status & ISI_TXOK))
437 txcount = min_t(short, TX_SIZE, port->xmit_cnt);
438 if (txcount <= 0 || tty->stopped || tty->hw_stopped)
441 if (!(inw(base + 0x02) & (1 << port->channel)))
444 pr_debug("txing %d bytes, port%d.\n",
445 txcount, port->channel + 1);
446 outw((port->channel << isi_card[card].shift_count) | txcount,
451 cnt = min_t(int, txcount, (SERIAL_XMIT_SIZE
453 if (residue == YES) {
456 wrd |= (port->port.xmit_buf[port->xmit_tail]
458 port->xmit_tail = (port->xmit_tail + 1)
459 & (SERIAL_XMIT_SIZE - 1);
471 word_count = cnt >> 1;
472 outsw(base, port->port.xmit_buf+port->xmit_tail, word_count);
473 port->xmit_tail = (port->xmit_tail
474 + (word_count << 1)) & (SERIAL_XMIT_SIZE - 1);
475 txcount -= (word_count << 1);
476 port->xmit_cnt -= (word_count << 1);
479 wrd = port->port.xmit_buf[port->xmit_tail];
480 port->xmit_tail = (port->xmit_tail + 1)
481 & (SERIAL_XMIT_SIZE - 1);
487 InterruptTheCard(base);
488 if (port->xmit_cnt <= 0)
489 port->status &= ~ISI_TXOK;
490 if (port->xmit_cnt <= WAKEUP_CHARS)
497 spin_unlock_irqrestore(&isi_card[card].card_lock, flags);
498 /* schedule another tx for hopefully in about 10ms */
500 mod_timer(&tx, jiffies + msecs_to_jiffies(10));
504 * Main interrupt handler routine
507 static irqreturn_t isicom_interrupt(int irq, void *dev_id)
509 struct isi_board *card = dev_id;
510 struct isi_port *port;
511 struct tty_struct *tty;
513 u16 header, word_count, count, channel;
517 if (!card || !(card->status & FIRMWARE_LOADED))
522 /* did the card interrupt us? */
523 if (!(inw(base + 0x0e) & 0x02))
526 spin_lock(&card->card_lock);
529 * disable any interrupts from the PCI card and lower the
532 outw(0x8000, base+0x04);
533 ClearInterrupt(base);
535 inw(base); /* get the dummy word out */
537 channel = (header & 0x7800) >> card->shift_count;
538 byte_count = header & 0xff;
540 if (channel + 1 > card->port_count) {
541 pr_warn("%s(0x%lx): %d(channel) > port_count\n",
542 __func__, base, channel + 1);
543 outw(0x0000, base+0x04); /* enable interrupts */
544 spin_unlock(&card->card_lock);
547 port = card->ports + channel;
548 if (!tty_port_initialized(&port->port)) {
549 outw(0x0000, base+0x04); /* enable interrupts */
550 spin_unlock(&card->card_lock);
554 tty = tty_port_tty_get(&port->port);
556 word_count = byte_count >> 1;
557 while (byte_count > 1) {
561 if (byte_count & 0x01)
563 outw(0x0000, base+0x04); /* enable interrupts */
564 spin_unlock(&card->card_lock);
568 if (header & 0x8000) { /* Status Packet */
570 switch (header & 0xff) {
571 case 0: /* Change in EIA signals */
572 if (tty_port_check_carrier(&port->port)) {
573 if (port->status & ISI_DCD) {
574 if (!(header & ISI_DCD)) {
575 /* Carrier has been lost */
576 pr_debug("%s: DCD->low.\n",
578 port->status &= ~ISI_DCD;
581 } else if (header & ISI_DCD) {
582 /* Carrier has been detected */
583 pr_debug("%s: DCD->high.\n",
585 port->status |= ISI_DCD;
586 wake_up_interruptible(&port->port.open_wait);
589 if (header & ISI_DCD)
590 port->status |= ISI_DCD;
592 port->status &= ~ISI_DCD;
595 if (tty_port_cts_enabled(&port->port)) {
596 if (tty->hw_stopped) {
597 if (header & ISI_CTS) {
600 port->status |= (ISI_TXOK
604 } else if (!(header & ISI_CTS)) {
607 port->status &= ~(ISI_TXOK | ISI_CTS);
610 if (header & ISI_CTS)
611 port->status |= ISI_CTS;
613 port->status &= ~ISI_CTS;
616 if (header & ISI_DSR)
617 port->status |= ISI_DSR;
619 port->status &= ~ISI_DSR;
622 port->status |= ISI_RI;
624 port->status &= ~ISI_RI;
628 case 1: /* Received Break !!! */
629 tty_insert_flip_char(&port->port, 0, TTY_BREAK);
630 if (port->port.flags & ASYNC_SAK)
632 tty_flip_buffer_push(&port->port);
635 case 2: /* Statistics */
636 pr_debug("%s: stats!!!\n", __func__);
640 pr_debug("%s: Unknown code in status packet.\n",
644 } else { /* Data Packet */
645 count = tty_prepare_flip_string(&port->port, &rp,
647 pr_debug("%s: Can rx %d of %d bytes.\n",
648 __func__, count, byte_count);
649 word_count = count >> 1;
650 insw(base, rp, word_count);
651 byte_count -= (word_count << 1);
652 if (count & 0x0001) {
653 tty_insert_flip_char(&port->port, inw(base) & 0xff,
657 if (byte_count > 0) {
658 pr_debug("%s(0x%lx:%d): Flip buffer overflow! dropping bytes...\n",
659 __func__, base, channel + 1);
660 /* drain out unread xtra data */
661 while (byte_count > 0) {
666 tty_flip_buffer_push(&port->port);
668 outw(0x0000, base+0x04); /* enable interrupts */
669 spin_unlock(&card->card_lock);
675 static void isicom_config_port(struct tty_struct *tty)
677 struct isi_port *port = tty->driver_data;
678 struct isi_board *card = port->card;
680 unsigned long base = card->base;
681 u16 channel_setup, channel = port->channel,
682 shift_count = card->shift_count;
683 unsigned char flow_ctrl;
685 /* FIXME: Switch to new tty baud API */
687 if (baud & CBAUDEX) {
690 /* if CBAUDEX bit is on and the baud is set to either 50 or 75
691 * then the card is programmed for 57.6Kbps or 115Kbps
695 /* 1,2,3,4 => 57.6, 115.2, 230, 460 kbps resp. */
696 if (baud < 1 || baud > 4)
697 tty->termios.c_cflag &= ~CBAUDEX;
703 /* the ASYNC_SPD_HI and ASYNC_SPD_VHI options are set
704 * by the set_serial_info ioctl ... this is done by
705 * the 'setserial' utility.
708 if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
709 baud++; /* 57.6 Kbps */
710 if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
711 baud += 2; /* 115 Kbps */
712 if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
713 baud += 3; /* 230 kbps*/
714 if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
715 baud += 4; /* 460 kbps*/
717 if (linuxb_to_isib[baud] == -1) {
724 if (WaitTillCardIsFree(base) == 0) {
725 outw(0x8000 | (channel << shift_count) | 0x03, base);
726 outw(linuxb_to_isib[baud] << 8 | 0x03, base);
728 switch (C_CSIZE(tty)) {
730 channel_setup |= ISICOM_CS5;
733 channel_setup |= ISICOM_CS6;
736 channel_setup |= ISICOM_CS7;
739 channel_setup |= ISICOM_CS8;
744 channel_setup |= ISICOM_2SB;
746 channel_setup |= ISICOM_EVPAR;
748 channel_setup |= ISICOM_ODPAR;
750 outw(channel_setup, base);
751 InterruptTheCard(base);
753 tty_port_set_check_carrier(&port->port, !C_CLOCAL(tty));
755 /* flow control settings ...*/
757 tty_port_set_cts_flow(&port->port, C_CRTSCTS(tty));
759 flow_ctrl |= ISICOM_CTSRTS;
761 flow_ctrl |= ISICOM_RESPOND_XONXOFF;
763 flow_ctrl |= ISICOM_INITIATE_XONXOFF;
765 if (WaitTillCardIsFree(base) == 0) {
766 outw(0x8000 | (channel << shift_count) | 0x04, base);
767 outw(flow_ctrl << 8 | 0x05, base);
768 outw((STOP_CHAR(tty)) << 8 | (START_CHAR(tty)), base);
769 InterruptTheCard(base);
772 /* rx enabled -> enable port for rx on the card */
774 card->port_status |= (1 << channel);
775 outw(card->port_status, base + 0x02);
781 static inline void isicom_setup_board(struct isi_board *bp)
784 struct isi_port *port;
787 if (!(bp->status & BOARD_INIT)) {
789 for (channel = 0; channel < bp->port_count; channel++, port++)
792 bp->status |= BOARD_ACTIVE | BOARD_INIT;
795 /* Activate and thus setup board are protected from races against shutdown
796 by the tty_port mutex */
798 static int isicom_activate(struct tty_port *tport, struct tty_struct *tty)
800 struct isi_port *port = container_of(tport, struct isi_port, port);
801 struct isi_board *card = port->card;
804 if (tty_port_alloc_xmit_buf(tport) < 0)
807 spin_lock_irqsave(&card->card_lock, flags);
808 isicom_setup_board(card);
810 port->xmit_cnt = port->xmit_head = port->xmit_tail = 0;
812 /* discard any residual data */
813 if (WaitTillCardIsFree(card->base) == 0) {
814 outw(0x8000 | (port->channel << card->shift_count) | 0x02,
816 outw(((ISICOM_KILLTX | ISICOM_KILLRX) << 8) | 0x06, card->base);
817 InterruptTheCard(card->base);
819 isicom_config_port(tty);
820 spin_unlock_irqrestore(&card->card_lock, flags);
825 static int isicom_carrier_raised(struct tty_port *port)
827 struct isi_port *ip = container_of(port, struct isi_port, port);
828 return (ip->status & ISI_DCD)?1 : 0;
831 static struct tty_port *isicom_find_port(struct tty_struct *tty)
833 struct isi_port *port;
834 struct isi_board *card;
836 int line = tty->index;
839 card = &isi_card[board];
841 if (!(card->status & FIRMWARE_LOADED))
844 /* open on a port greater than the port count for the card !!! */
845 if (line > ((board * 16) + card->port_count - 1))
848 port = &isi_ports[line];
849 if (isicom_paranoia_check(port, tty->name, "isicom_open"))
855 static int isicom_open(struct tty_struct *tty, struct file *filp)
857 struct isi_port *port;
858 struct tty_port *tport;
860 tport = isicom_find_port(tty);
863 port = container_of(tport, struct isi_port, port);
865 tty->driver_data = port;
866 return tty_port_open(tport, tty, filp);
871 /* card->lock HAS to be held */
872 static void isicom_shutdown_port(struct isi_port *port)
874 struct isi_board *card = port->card;
876 if (--card->count < 0) {
877 pr_debug("%s: bad board(0x%lx) count %d.\n",
878 __func__, card->base, card->count);
881 /* last port was closed, shutdown that board too */
883 card->status &= BOARD_ACTIVE;
886 static void isicom_flush_buffer(struct tty_struct *tty)
888 struct isi_port *port = tty->driver_data;
889 struct isi_board *card = port->card;
892 if (isicom_paranoia_check(port, tty->name, "isicom_flush_buffer"))
895 spin_lock_irqsave(&card->card_lock, flags);
896 port->xmit_cnt = port->xmit_head = port->xmit_tail = 0;
897 spin_unlock_irqrestore(&card->card_lock, flags);
902 static void isicom_shutdown(struct tty_port *port)
904 struct isi_port *ip = container_of(port, struct isi_port, port);
905 struct isi_board *card = ip->card;
908 /* indicate to the card that no more data can be received
910 spin_lock_irqsave(&card->card_lock, flags);
911 card->port_status &= ~(1 << ip->channel);
912 outw(card->port_status, card->base + 0x02);
913 isicom_shutdown_port(ip);
914 spin_unlock_irqrestore(&card->card_lock, flags);
915 tty_port_free_xmit_buf(port);
918 static void isicom_close(struct tty_struct *tty, struct file *filp)
920 struct isi_port *ip = tty->driver_data;
921 struct tty_port *port;
927 if (isicom_paranoia_check(ip, tty->name, "isicom_close"))
929 tty_port_close(port, tty, filp);
933 static int isicom_write(struct tty_struct *tty, const unsigned char *buf,
936 struct isi_port *port = tty->driver_data;
937 struct isi_board *card = port->card;
941 if (isicom_paranoia_check(port, tty->name, "isicom_write"))
944 spin_lock_irqsave(&card->card_lock, flags);
947 cnt = min_t(int, count, min(SERIAL_XMIT_SIZE - port->xmit_cnt
948 - 1, SERIAL_XMIT_SIZE - port->xmit_head));
952 memcpy(port->port.xmit_buf + port->xmit_head, buf, cnt);
953 port->xmit_head = (port->xmit_head + cnt) & (SERIAL_XMIT_SIZE
955 port->xmit_cnt += cnt;
960 if (port->xmit_cnt && !tty->stopped && !tty->hw_stopped)
961 port->status |= ISI_TXOK;
962 spin_unlock_irqrestore(&card->card_lock, flags);
966 /* put_char et all */
967 static int isicom_put_char(struct tty_struct *tty, unsigned char ch)
969 struct isi_port *port = tty->driver_data;
970 struct isi_board *card = port->card;
973 if (isicom_paranoia_check(port, tty->name, "isicom_put_char"))
976 spin_lock_irqsave(&card->card_lock, flags);
977 if (port->xmit_cnt >= SERIAL_XMIT_SIZE - 1) {
978 spin_unlock_irqrestore(&card->card_lock, flags);
982 port->port.xmit_buf[port->xmit_head++] = ch;
983 port->xmit_head &= (SERIAL_XMIT_SIZE - 1);
985 spin_unlock_irqrestore(&card->card_lock, flags);
989 /* flush_chars et all */
990 static void isicom_flush_chars(struct tty_struct *tty)
992 struct isi_port *port = tty->driver_data;
994 if (isicom_paranoia_check(port, tty->name, "isicom_flush_chars"))
997 if (port->xmit_cnt <= 0 || tty->stopped || tty->hw_stopped ||
998 !port->port.xmit_buf)
1001 /* this tells the transmitter to consider this port for
1002 data output to the card ... that's the best we can do. */
1003 port->status |= ISI_TXOK;
1006 /* write_room et all */
1007 static int isicom_write_room(struct tty_struct *tty)
1009 struct isi_port *port = tty->driver_data;
1012 if (isicom_paranoia_check(port, tty->name, "isicom_write_room"))
1015 free = SERIAL_XMIT_SIZE - port->xmit_cnt - 1;
1021 /* chars_in_buffer et all */
1022 static int isicom_chars_in_buffer(struct tty_struct *tty)
1024 struct isi_port *port = tty->driver_data;
1025 if (isicom_paranoia_check(port, tty->name, "isicom_chars_in_buffer"))
1027 return port->xmit_cnt;
1031 static int isicom_send_break(struct tty_struct *tty, int length)
1033 struct isi_port *port = tty->driver_data;
1034 struct isi_board *card = port->card;
1035 unsigned long base = card->base;
1040 if (!lock_card(card))
1043 outw(0x8000 | ((port->channel) << (card->shift_count)) | 0x3, base);
1044 outw((length & 0xff) << 8 | 0x00, base);
1045 outw((length & 0xff00u), base);
1046 InterruptTheCard(base);
1052 static int isicom_tiocmget(struct tty_struct *tty)
1054 struct isi_port *port = tty->driver_data;
1055 /* just send the port status */
1056 u16 status = port->status;
1058 if (isicom_paranoia_check(port, tty->name, "isicom_ioctl"))
1061 return ((status & ISI_RTS) ? TIOCM_RTS : 0) |
1062 ((status & ISI_DTR) ? TIOCM_DTR : 0) |
1063 ((status & ISI_DCD) ? TIOCM_CAR : 0) |
1064 ((status & ISI_DSR) ? TIOCM_DSR : 0) |
1065 ((status & ISI_CTS) ? TIOCM_CTS : 0) |
1066 ((status & ISI_RI ) ? TIOCM_RI : 0);
1069 static int isicom_tiocmset(struct tty_struct *tty,
1070 unsigned int set, unsigned int clear)
1072 struct isi_port *port = tty->driver_data;
1073 unsigned long flags;
1075 if (isicom_paranoia_check(port, tty->name, "isicom_ioctl"))
1078 spin_lock_irqsave(&port->card->card_lock, flags);
1079 if (set & TIOCM_RTS)
1081 if (set & TIOCM_DTR)
1084 if (clear & TIOCM_RTS)
1086 if (clear & TIOCM_DTR)
1088 spin_unlock_irqrestore(&port->card->card_lock, flags);
1093 static int isicom_set_serial_info(struct tty_struct *tty,
1094 struct serial_struct *ss)
1096 struct isi_port *port = tty->driver_data;
1099 if (isicom_paranoia_check(port, tty->name, "isicom_ioctl"))
1102 mutex_lock(&port->port.mutex);
1103 reconfig_port = ((port->port.flags & ASYNC_SPD_MASK) !=
1104 (ss->flags & ASYNC_SPD_MASK));
1106 if (!capable(CAP_SYS_ADMIN)) {
1107 if ((ss->close_delay != port->port.close_delay) ||
1108 (ss->closing_wait != port->port.closing_wait) ||
1109 ((ss->flags & ~ASYNC_USR_MASK) !=
1110 (port->port.flags & ~ASYNC_USR_MASK))) {
1111 mutex_unlock(&port->port.mutex);
1114 port->port.flags = ((port->port.flags & ~ASYNC_USR_MASK) |
1115 (ss->flags & ASYNC_USR_MASK));
1117 port->port.close_delay = ss->close_delay;
1118 port->port.closing_wait = ss->closing_wait;
1119 port->port.flags = ((port->port.flags & ~ASYNC_FLAGS) |
1120 (ss->flags & ASYNC_FLAGS));
1122 if (reconfig_port) {
1123 unsigned long flags;
1124 spin_lock_irqsave(&port->card->card_lock, flags);
1125 isicom_config_port(tty);
1126 spin_unlock_irqrestore(&port->card->card_lock, flags);
1128 mutex_unlock(&port->port.mutex);
1132 static int isicom_get_serial_info(struct tty_struct *tty,
1133 struct serial_struct *ss)
1135 struct isi_port *port = tty->driver_data;
1137 if (isicom_paranoia_check(port, tty->name, "isicom_ioctl"))
1140 mutex_lock(&port->port.mutex);
1142 ss->line = port - isi_ports;
1143 ss->port = port->card->base;
1144 ss->irq = port->card->irq;
1145 ss->flags = port->port.flags;
1146 /* ss->baud_base = ? */
1147 ss->close_delay = port->port.close_delay;
1148 ss->closing_wait = port->port.closing_wait;
1149 mutex_unlock(&port->port.mutex);
1153 /* set_termios et all */
1154 static void isicom_set_termios(struct tty_struct *tty,
1155 struct ktermios *old_termios)
1157 struct isi_port *port = tty->driver_data;
1158 unsigned long flags;
1160 if (isicom_paranoia_check(port, tty->name, "isicom_set_termios"))
1163 if (tty->termios.c_cflag == old_termios->c_cflag &&
1164 tty->termios.c_iflag == old_termios->c_iflag)
1167 spin_lock_irqsave(&port->card->card_lock, flags);
1168 isicom_config_port(tty);
1169 spin_unlock_irqrestore(&port->card->card_lock, flags);
1171 if ((old_termios->c_cflag & CRTSCTS) && !C_CRTSCTS(tty)) {
1172 tty->hw_stopped = 0;
1177 /* throttle et all */
1178 static void isicom_throttle(struct tty_struct *tty)
1180 struct isi_port *port = tty->driver_data;
1181 struct isi_board *card = port->card;
1183 if (isicom_paranoia_check(port, tty->name, "isicom_throttle"))
1186 /* tell the card that this port cannot handle any more data for now */
1187 card->port_status &= ~(1 << port->channel);
1188 outw(card->port_status, card->base + 0x02);
1191 /* unthrottle et all */
1192 static void isicom_unthrottle(struct tty_struct *tty)
1194 struct isi_port *port = tty->driver_data;
1195 struct isi_board *card = port->card;
1197 if (isicom_paranoia_check(port, tty->name, "isicom_unthrottle"))
1200 /* tell the card that this port is ready to accept more data */
1201 card->port_status |= (1 << port->channel);
1202 outw(card->port_status, card->base + 0x02);
1206 static void isicom_stop(struct tty_struct *tty)
1208 struct isi_port *port = tty->driver_data;
1210 if (isicom_paranoia_check(port, tty->name, "isicom_stop"))
1213 /* this tells the transmitter not to consider this port for
1214 data output to the card. */
1215 port->status &= ~ISI_TXOK;
1219 static void isicom_start(struct tty_struct *tty)
1221 struct isi_port *port = tty->driver_data;
1223 if (isicom_paranoia_check(port, tty->name, "isicom_start"))
1226 /* this tells the transmitter to consider this port for
1227 data output to the card. */
1228 port->status |= ISI_TXOK;
1231 static void isicom_hangup(struct tty_struct *tty)
1233 struct isi_port *port = tty->driver_data;
1235 if (isicom_paranoia_check(port, tty->name, "isicom_hangup"))
1237 tty_port_hangup(&port->port);
1242 * Driver init and deinit functions
1245 static const struct tty_operations isicom_ops = {
1246 .open = isicom_open,
1247 .close = isicom_close,
1248 .write = isicom_write,
1249 .put_char = isicom_put_char,
1250 .flush_chars = isicom_flush_chars,
1251 .write_room = isicom_write_room,
1252 .chars_in_buffer = isicom_chars_in_buffer,
1253 .set_termios = isicom_set_termios,
1254 .throttle = isicom_throttle,
1255 .unthrottle = isicom_unthrottle,
1256 .stop = isicom_stop,
1257 .start = isicom_start,
1258 .hangup = isicom_hangup,
1259 .flush_buffer = isicom_flush_buffer,
1260 .tiocmget = isicom_tiocmget,
1261 .tiocmset = isicom_tiocmset,
1262 .break_ctl = isicom_send_break,
1263 .get_serial = isicom_get_serial_info,
1264 .set_serial = isicom_set_serial_info,
1267 static const struct tty_port_operations isicom_port_ops = {
1268 .carrier_raised = isicom_carrier_raised,
1269 .dtr_rts = isicom_dtr_rts,
1270 .activate = isicom_activate,
1271 .shutdown = isicom_shutdown,
1274 static int reset_card(struct pci_dev *pdev,
1275 const unsigned int card, unsigned int *signature)
1277 struct isi_board *board = pci_get_drvdata(pdev);
1278 unsigned long base = board->base;
1279 unsigned int sig, portcount = 0;
1282 dev_dbg(&pdev->dev, "ISILoad:Resetting Card%d at 0x%lx\n", card + 1,
1289 outw(0, base + 0x8); /* Reset */
1293 sig = inw(base + 0x4) & 0xff;
1295 if (sig != 0xa5 && sig != 0xbb && sig != 0xcc && sig != 0xdd &&
1297 dev_warn(&pdev->dev, "ISILoad:Card%u reset failure (Possible "
1298 "bad I/O Port Address 0x%lx).\n", card + 1, base);
1299 dev_dbg(&pdev->dev, "Sig=0x%x\n", sig);
1306 portcount = inw(base + 0x2);
1307 if (!(inw(base + 0xe) & 0x1) || (portcount != 0 && portcount != 4 &&
1308 portcount != 8 && portcount != 16)) {
1309 dev_err(&pdev->dev, "ISILoad:PCI Card%d reset failure.\n",
1319 board->port_count = (portcount == 4) ? 4 : 8;
1320 board->shift_count = 12;
1324 board->port_count = 16;
1325 board->shift_count = 11;
1328 dev_info(&pdev->dev, "-Done\n");
1335 static int load_firmware(struct pci_dev *pdev,
1336 const unsigned int index, const unsigned int signature)
1338 struct isi_board *board = pci_get_drvdata(pdev);
1339 const struct firmware *fw;
1340 unsigned long base = board->base;
1342 u16 word_count, status;
1353 switch (signature) {
1355 name = "isi608.bin";
1358 name = "isi608em.bin";
1361 name = "isi616em.bin";
1364 name = "isi4608.bin";
1367 name = "isi4616.bin";
1370 dev_err(&pdev->dev, "Unknown signature.\n");
1374 retval = request_firmware(&fw, name, &pdev->dev);
1380 for (frame = (struct stframe *)fw->data;
1381 frame < (struct stframe *)(fw->data + fw->size);
1382 frame = (struct stframe *)((u8 *)(frame + 1) +
1384 if (WaitTillCardIsFree(base))
1387 outw(0xf0, base); /* start upload sequence */
1389 outw(frame->addr, base); /* lsb of address */
1391 word_count = frame->count / 2 + frame->count % 2;
1392 outw(word_count, base);
1393 InterruptTheCard(base);
1395 udelay(100); /* 0x2f */
1397 if (WaitTillCardIsFree(base))
1400 status = inw(base + 0x4);
1402 dev_warn(&pdev->dev, "Card%d rejected load header:\n"
1406 index + 1, frame->addr, frame->count, status);
1409 outsw(base, frame->data, word_count);
1411 InterruptTheCard(base);
1413 udelay(50); /* 0x0f */
1415 if (WaitTillCardIsFree(base))
1418 status = inw(base + 0x4);
1420 dev_err(&pdev->dev, "Card%d got out of sync.Card "
1421 "Status:0x%x\n", index + 1, status);
1426 /* XXX: should we test it by reading it back and comparing with original like
1427 * in load firmware package? */
1428 for (frame = (struct stframe *)fw->data;
1429 frame < (struct stframe *)(fw->data + fw->size);
1430 frame = (struct stframe *)((u8 *)(frame + 1) +
1432 if (WaitTillCardIsFree(base))
1435 outw(0xf1, base); /* start download sequence */
1437 outw(frame->addr, base); /* lsb of address */
1439 word_count = (frame->count >> 1) + frame->count % 2;
1440 outw(word_count + 1, base);
1441 InterruptTheCard(base);
1443 udelay(50); /* 0xf */
1445 if (WaitTillCardIsFree(base))
1448 status = inw(base + 0x4);
1450 dev_warn(&pdev->dev, "Card%d rejected verify header:\n"
1454 index + 1, frame->addr, frame->count, status);
1458 data = kmalloc_array(word_count, 2, GFP_KERNEL);
1460 dev_err(&pdev->dev, "Card%d, firmware upload "
1461 "failed, not enough memory\n", index + 1);
1465 insw(base, data, word_count);
1466 InterruptTheCard(base);
1468 for (a = 0; a < frame->count; a++)
1469 if (data[a] != frame->data[a]) {
1471 dev_err(&pdev->dev, "Card%d, firmware upload "
1472 "failed\n", index + 1);
1477 udelay(50); /* 0xf */
1479 if (WaitTillCardIsFree(base))
1482 status = inw(base + 0x4);
1484 dev_err(&pdev->dev, "Card%d verify got out of sync. "
1485 "Card Status:0x%x\n", index + 1, status);
1491 if (WaitTillCardIsFree(base))
1498 InterruptTheCard(base);
1499 outw(0x0, base + 0x4); /* for ISI4608 cards */
1501 board->status |= FIRMWARE_LOADED;
1505 release_firmware(fw);
1511 * Insmod can set static symbols so keep these static
1513 static unsigned int card_count;
1515 static int isicom_probe(struct pci_dev *pdev,
1516 const struct pci_device_id *ent)
1518 unsigned int uninitialized_var(signature), index;
1519 int retval = -EPERM;
1520 struct isi_board *board = NULL;
1522 if (card_count >= BOARD_COUNT)
1525 retval = pci_enable_device(pdev);
1527 dev_err(&pdev->dev, "failed to enable\n");
1531 dev_info(&pdev->dev, "ISI PCI Card(Device ID 0x%x)\n", ent->device);
1533 /* allot the first empty slot in the array */
1534 for (index = 0; index < BOARD_COUNT; index++) {
1535 if (isi_card[index].base == 0) {
1536 board = &isi_card[index];
1540 if (index == BOARD_COUNT) {
1545 board->index = index;
1546 board->base = pci_resource_start(pdev, 3);
1547 board->irq = pdev->irq;
1550 pci_set_drvdata(pdev, board);
1552 retval = pci_request_region(pdev, 3, ISICOM_NAME);
1554 dev_err(&pdev->dev, "I/O Region 0x%lx-0x%lx is busy. Card%d "
1555 "will be disabled.\n", board->base, board->base + 15,
1561 retval = request_irq(board->irq, isicom_interrupt,
1562 IRQF_SHARED, ISICOM_NAME, board);
1564 dev_err(&pdev->dev, "Could not install handler at Irq %d. "
1565 "Card%d will be disabled.\n", board->irq, index + 1);
1569 retval = reset_card(pdev, index, &signature);
1573 retval = load_firmware(pdev, index, signature);
1577 for (index = 0; index < board->port_count; index++) {
1578 struct tty_port *tport = &board->ports[index].port;
1579 tty_port_init(tport);
1580 tport->ops = &isicom_port_ops;
1581 tport->close_delay = 50 * HZ/100;
1582 tport->closing_wait = 3000 * HZ/100;
1583 tty_port_register_device(tport, isicom_normal,
1584 board->index * 16 + index, &pdev->dev);
1590 free_irq(board->irq, board);
1592 pci_release_region(pdev, 3);
1597 pci_disable_device(pdev);
1602 static void isicom_remove(struct pci_dev *pdev)
1604 struct isi_board *board = pci_get_drvdata(pdev);
1607 for (i = 0; i < board->port_count; i++) {
1608 tty_unregister_device(isicom_normal, board->index * 16 + i);
1609 tty_port_destroy(&board->ports[i].port);
1612 free_irq(board->irq, board);
1613 pci_release_region(pdev, 3);
1616 pci_disable_device(pdev);
1619 static int __init isicom_init(void)
1621 int retval, idx, channel;
1622 struct isi_port *port;
1624 for (idx = 0; idx < BOARD_COUNT; idx++) {
1625 port = &isi_ports[idx * 16];
1626 isi_card[idx].ports = port;
1627 spin_lock_init(&isi_card[idx].card_lock);
1628 for (channel = 0; channel < 16; channel++, port++) {
1629 port->magic = ISICOM_MAGIC;
1630 port->card = &isi_card[idx];
1631 port->channel = channel;
1635 isi_card[idx].base = 0;
1636 isi_card[idx].irq = 0;
1639 /* tty driver structure initialization */
1640 isicom_normal = alloc_tty_driver(PORT_COUNT);
1641 if (!isicom_normal) {
1646 isicom_normal->name = "ttyM";
1647 isicom_normal->major = ISICOM_NMAJOR;
1648 isicom_normal->minor_start = 0;
1649 isicom_normal->type = TTY_DRIVER_TYPE_SERIAL;
1650 isicom_normal->subtype = SERIAL_TYPE_NORMAL;
1651 isicom_normal->init_termios = tty_std_termios;
1652 isicom_normal->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
1654 isicom_normal->flags = TTY_DRIVER_REAL_RAW |
1655 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_HARDWARE_BREAK;
1656 tty_set_operations(isicom_normal, &isicom_ops);
1658 retval = tty_register_driver(isicom_normal);
1660 pr_debug("Couldn't register the dialin driver\n");
1664 retval = pci_register_driver(&isicom_driver);
1666 pr_err("Unable to register pci driver.\n");
1670 mod_timer(&tx, jiffies + 1);
1674 tty_unregister_driver(isicom_normal);
1676 put_tty_driver(isicom_normal);
1681 static void __exit isicom_exit(void)
1683 del_timer_sync(&tx);
1685 pci_unregister_driver(&isicom_driver);
1686 tty_unregister_driver(isicom_normal);
1687 put_tty_driver(isicom_normal);
1690 module_init(isicom_init);
1691 module_exit(isicom_exit);
1693 MODULE_AUTHOR("MultiTech");
1694 MODULE_DESCRIPTION("Driver for the ISI series of cards by MultiTech");
1695 MODULE_LICENSE("GPL");
1696 MODULE_FIRMWARE("isi608.bin");
1697 MODULE_FIRMWARE("isi608em.bin");
1698 MODULE_FIRMWARE("isi616em.bin");
1699 MODULE_FIRMWARE("isi4608.bin");
1700 MODULE_FIRMWARE("isi4616.bin");