1 /************************************************************************
2 * Copyright 2003 Digi International (www.digi.com)
4 * Copyright (C) 2004 IBM Corporation. All rights reserved.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED; without even the
13 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 * Temple Place - Suite 330, Boston,
21 * Contact Information:
22 * Scott H Kilau <Scott_Kilau@digi.com>
23 * Ananda Venkatarman <mansarov@us.ibm.com>
25 * 01/19/06: changed jsm_input routine to use the dynamically allocated
26 * tty_buffer changes. Contributors: Scott Kilau and Ananda V.
27 ***********************************************************************/
28 #include <linux/tty.h>
29 #include <linux/tty_flip.h>
30 #include <linux/serial_reg.h>
31 #include <linux/delay.h> /* For udelay */
32 #include <linux/pci.h>
33 #include <linux/slab.h>
37 static DECLARE_BITMAP(linemap, MAXLINES);
39 static void jsm_carrier(struct jsm_channel *ch);
41 static inline int jsm_get_mstat(struct jsm_channel *ch)
46 jsm_dbg(IOCTL, &ch->ch_bd->pci_dev, "start\n");
48 mstat = (ch->ch_mostat | ch->ch_mistat);
52 if (mstat & UART_MCR_DTR)
54 if (mstat & UART_MCR_RTS)
56 if (mstat & UART_MSR_CTS)
58 if (mstat & UART_MSR_DSR)
60 if (mstat & UART_MSR_RI)
62 if (mstat & UART_MSR_DCD)
65 jsm_dbg(IOCTL, &ch->ch_bd->pci_dev, "finish\n");
69 static unsigned int jsm_tty_tx_empty(struct uart_port *port)
75 * Return modem signals to ld.
77 static unsigned int jsm_tty_get_mctrl(struct uart_port *port)
80 struct jsm_channel *channel = (struct jsm_channel *)port;
82 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "start\n");
84 result = jsm_get_mstat(channel);
89 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "finish\n");
95 * jsm_set_modem_info()
97 * Set modem signals, called by ld.
99 static void jsm_tty_set_mctrl(struct uart_port *port, unsigned int mctrl)
101 struct jsm_channel *channel = (struct jsm_channel *)port;
103 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "start\n");
105 if (mctrl & TIOCM_RTS)
106 channel->ch_mostat |= UART_MCR_RTS;
108 channel->ch_mostat &= ~UART_MCR_RTS;
110 if (mctrl & TIOCM_DTR)
111 channel->ch_mostat |= UART_MCR_DTR;
113 channel->ch_mostat &= ~UART_MCR_DTR;
115 channel->ch_bd->bd_ops->assert_modem_signals(channel);
117 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "finish\n");
124 * Take data from the user or kernel and send it out to the FEP.
125 * In here exists all the Transparent Print magic as well.
127 static void jsm_tty_write(struct uart_port *port)
129 struct jsm_channel *channel;
130 channel = container_of(port, struct jsm_channel, uart_port);
131 channel->ch_bd->bd_ops->copy_data_from_queue_to_uart(channel);
134 static void jsm_tty_start_tx(struct uart_port *port)
136 struct jsm_channel *channel = (struct jsm_channel *)port;
138 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "start\n");
140 channel->ch_flags &= ~(CH_STOP);
143 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "finish\n");
146 static void jsm_tty_stop_tx(struct uart_port *port)
148 struct jsm_channel *channel = (struct jsm_channel *)port;
150 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "start\n");
152 channel->ch_flags |= (CH_STOP);
154 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "finish\n");
157 static void jsm_tty_send_xchar(struct uart_port *port, char ch)
159 unsigned long lock_flags;
160 struct jsm_channel *channel = (struct jsm_channel *)port;
161 struct ktermios *termios;
163 spin_lock_irqsave(&port->lock, lock_flags);
164 termios = &port->state->port.tty->termios;
165 if (ch == termios->c_cc[VSTART])
166 channel->ch_bd->bd_ops->send_start_character(channel);
168 if (ch == termios->c_cc[VSTOP])
169 channel->ch_bd->bd_ops->send_stop_character(channel);
170 spin_unlock_irqrestore(&port->lock, lock_flags);
173 static void jsm_tty_stop_rx(struct uart_port *port)
175 struct jsm_channel *channel = (struct jsm_channel *)port;
177 channel->ch_bd->bd_ops->disable_receiver(channel);
180 static void jsm_tty_enable_ms(struct uart_port *port)
185 static void jsm_tty_break(struct uart_port *port, int break_state)
187 unsigned long lock_flags;
188 struct jsm_channel *channel = (struct jsm_channel *)port;
190 spin_lock_irqsave(&port->lock, lock_flags);
191 if (break_state == -1)
192 channel->ch_bd->bd_ops->send_break(channel);
194 channel->ch_bd->bd_ops->clear_break(channel, 0);
196 spin_unlock_irqrestore(&port->lock, lock_flags);
199 static int jsm_tty_open(struct uart_port *port)
201 struct jsm_board *brd;
202 struct jsm_channel *channel = (struct jsm_channel *)port;
203 struct ktermios *termios;
205 /* Get board pointer from our array of majors we have allocated */
206 brd = channel->ch_bd;
209 * Allocate channel buffers for read/write/error.
210 * Set flag, so we don't get trounced on.
212 channel->ch_flags |= (CH_OPENING);
214 /* Drop locks, as malloc with GFP_KERNEL can sleep */
216 if (!channel->ch_rqueue) {
217 channel->ch_rqueue = kzalloc(RQUEUESIZE, GFP_KERNEL);
218 if (!channel->ch_rqueue) {
219 jsm_dbg(INIT, &channel->ch_bd->pci_dev,
220 "unable to allocate read queue buf\n");
224 if (!channel->ch_equeue) {
225 channel->ch_equeue = kzalloc(EQUEUESIZE, GFP_KERNEL);
226 if (!channel->ch_equeue) {
227 jsm_dbg(INIT, &channel->ch_bd->pci_dev,
228 "unable to allocate error queue buf\n");
233 channel->ch_flags &= ~(CH_OPENING);
235 * Initialize if neither terminal is open.
237 jsm_dbg(OPEN, &channel->ch_bd->pci_dev,
238 "jsm_open: initializing channel in open...\n");
241 * Flush input queues.
243 channel->ch_r_head = channel->ch_r_tail = 0;
244 channel->ch_e_head = channel->ch_e_tail = 0;
246 brd->bd_ops->flush_uart_write(channel);
247 brd->bd_ops->flush_uart_read(channel);
249 channel->ch_flags = 0;
250 channel->ch_cached_lsr = 0;
251 channel->ch_stops_sent = 0;
253 termios = &port->state->port.tty->termios;
254 channel->ch_c_cflag = termios->c_cflag;
255 channel->ch_c_iflag = termios->c_iflag;
256 channel->ch_c_oflag = termios->c_oflag;
257 channel->ch_c_lflag = termios->c_lflag;
258 channel->ch_startc = termios->c_cc[VSTART];
259 channel->ch_stopc = termios->c_cc[VSTOP];
261 /* Tell UART to init itself */
262 brd->bd_ops->uart_init(channel);
265 * Run param in case we changed anything
267 brd->bd_ops->param(channel);
269 jsm_carrier(channel);
271 channel->ch_open_count++;
273 jsm_dbg(OPEN, &channel->ch_bd->pci_dev, "finish\n");
277 static void jsm_tty_close(struct uart_port *port)
279 struct jsm_board *bd;
281 struct jsm_channel *channel = (struct jsm_channel *)port;
283 jsm_dbg(CLOSE, &channel->ch_bd->pci_dev, "start\n");
286 ts = &port->state->port.tty->termios;
288 channel->ch_flags &= ~(CH_STOPI);
290 channel->ch_open_count--;
293 * If we have HUPCL set, lower DTR and RTS
295 if (channel->ch_c_cflag & HUPCL) {
296 jsm_dbg(CLOSE, &channel->ch_bd->pci_dev,
297 "Close. HUPCL set, dropping DTR/RTS\n");
300 channel->ch_mostat &= ~(UART_MCR_DTR | UART_MCR_RTS);
301 bd->bd_ops->assert_modem_signals(channel);
304 /* Turn off UART interrupts for this port */
305 channel->ch_bd->bd_ops->uart_off(channel);
307 jsm_dbg(CLOSE, &channel->ch_bd->pci_dev, "finish\n");
310 static void jsm_tty_set_termios(struct uart_port *port,
311 struct ktermios *termios,
312 struct ktermios *old_termios)
314 unsigned long lock_flags;
315 struct jsm_channel *channel = (struct jsm_channel *)port;
317 spin_lock_irqsave(&port->lock, lock_flags);
318 channel->ch_c_cflag = termios->c_cflag;
319 channel->ch_c_iflag = termios->c_iflag;
320 channel->ch_c_oflag = termios->c_oflag;
321 channel->ch_c_lflag = termios->c_lflag;
322 channel->ch_startc = termios->c_cc[VSTART];
323 channel->ch_stopc = termios->c_cc[VSTOP];
325 channel->ch_bd->bd_ops->param(channel);
326 jsm_carrier(channel);
327 spin_unlock_irqrestore(&port->lock, lock_flags);
330 static const char *jsm_tty_type(struct uart_port *port)
335 static void jsm_tty_release_port(struct uart_port *port)
339 static int jsm_tty_request_port(struct uart_port *port)
344 static void jsm_config_port(struct uart_port *port, int flags)
346 port->type = PORT_JSM;
349 static struct uart_ops jsm_ops = {
350 .tx_empty = jsm_tty_tx_empty,
351 .set_mctrl = jsm_tty_set_mctrl,
352 .get_mctrl = jsm_tty_get_mctrl,
353 .stop_tx = jsm_tty_stop_tx,
354 .start_tx = jsm_tty_start_tx,
355 .send_xchar = jsm_tty_send_xchar,
356 .stop_rx = jsm_tty_stop_rx,
357 .enable_ms = jsm_tty_enable_ms,
358 .break_ctl = jsm_tty_break,
359 .startup = jsm_tty_open,
360 .shutdown = jsm_tty_close,
361 .set_termios = jsm_tty_set_termios,
362 .type = jsm_tty_type,
363 .release_port = jsm_tty_release_port,
364 .request_port = jsm_tty_request_port,
365 .config_port = jsm_config_port,
371 * Init the tty subsystem. Called once per board after board has been
372 * downloaded and init'ed.
374 int jsm_tty_init(struct jsm_board *brd)
378 struct jsm_channel *ch;
383 jsm_dbg(INIT, &brd->pci_dev, "start\n");
386 * Initialize board structure elements.
389 brd->nasync = brd->maxports;
392 * Allocate channel memory that might not have been allocated
393 * when the driver was first loaded.
395 for (i = 0; i < brd->nasync; i++) {
396 if (!brd->channels[i]) {
399 * Okay to malloc with GFP_KERNEL, we are not at
400 * interrupt context, and there are no locks held.
402 brd->channels[i] = kzalloc(sizeof(struct jsm_channel), GFP_KERNEL);
403 if (!brd->channels[i]) {
404 jsm_dbg(CORE, &brd->pci_dev,
405 "%s:%d Unable to allocate memory for channel struct\n",
411 ch = brd->channels[0];
412 vaddr = brd->re_map_membase;
414 /* Set up channel variables */
415 for (i = 0; i < brd->nasync; i++, ch = brd->channels[i]) {
417 if (!brd->channels[i])
420 spin_lock_init(&ch->ch_lock);
422 if (brd->bd_uart_offset == 0x200)
423 ch->ch_neo_uart = vaddr + (brd->bd_uart_offset * i);
428 /* .25 second delay */
429 ch->ch_close_delay = 250;
431 init_waitqueue_head(&ch->ch_flags_wait);
434 jsm_dbg(INIT, &brd->pci_dev, "finish\n");
438 int jsm_uart_port_init(struct jsm_board *brd)
442 struct jsm_channel *ch;
447 jsm_dbg(INIT, &brd->pci_dev, "start\n");
450 * Initialize board structure elements.
453 brd->nasync = brd->maxports;
455 /* Set up channel variables */
456 for (i = 0; i < brd->nasync; i++, ch = brd->channels[i]) {
458 if (!brd->channels[i])
461 brd->channels[i]->uart_port.irq = brd->irq;
462 brd->channels[i]->uart_port.uartclk = 14745600;
463 brd->channels[i]->uart_port.type = PORT_JSM;
464 brd->channels[i]->uart_port.iotype = UPIO_MEM;
465 brd->channels[i]->uart_port.membase = brd->re_map_membase;
466 brd->channels[i]->uart_port.fifosize = 16;
467 brd->channels[i]->uart_port.ops = &jsm_ops;
468 line = find_first_zero_bit(linemap, MAXLINES);
469 if (line >= MAXLINES) {
470 printk(KERN_INFO "jsm: linemap is full, added device failed\n");
473 set_bit(line, linemap);
474 brd->channels[i]->uart_port.line = line;
475 rc = uart_add_one_port (&jsm_uart_driver, &brd->channels[i]->uart_port);
477 printk(KERN_INFO "jsm: Port %d failed. Aborting...\n", i);
481 printk(KERN_INFO "jsm: Port %d added\n", i);
484 jsm_dbg(INIT, &brd->pci_dev, "finish\n");
488 int jsm_remove_uart_port(struct jsm_board *brd)
491 struct jsm_channel *ch;
496 jsm_dbg(INIT, &brd->pci_dev, "start\n");
499 * Initialize board structure elements.
502 brd->nasync = brd->maxports;
504 /* Set up channel variables */
505 for (i = 0; i < brd->nasync; i++) {
507 if (!brd->channels[i])
510 ch = brd->channels[i];
512 clear_bit(ch->uart_port.line, linemap);
513 uart_remove_one_port(&jsm_uart_driver, &brd->channels[i]->uart_port);
516 jsm_dbg(INIT, &brd->pci_dev, "finish\n");
520 void jsm_input(struct jsm_channel *ch)
522 struct jsm_board *bd;
523 struct tty_struct *tp;
524 struct tty_port *port;
529 unsigned long lock_flags;
535 jsm_dbg(READ, &ch->ch_bd->pci_dev, "start\n");
540 port = &ch->uart_port.state->port;
547 spin_lock_irqsave(&ch->ch_lock, lock_flags);
550 *Figure the number of characters in the buffer.
551 *Exit immediately if none.
556 head = ch->ch_r_head & rmask;
557 tail = ch->ch_r_tail & rmask;
559 data_len = (head - tail) & rmask;
561 spin_unlock_irqrestore(&ch->ch_lock, lock_flags);
565 jsm_dbg(READ, &ch->ch_bd->pci_dev, "start\n");
568 *If the device is not open, or CREAD is off, flush
569 *input data and return immediately.
572 !(tp->termios.c_cflag & CREAD) ) {
574 jsm_dbg(READ, &ch->ch_bd->pci_dev,
575 "input. dropping %d bytes on port %d...\n",
576 data_len, ch->ch_portnum);
577 ch->ch_r_head = tail;
579 /* Force queue flow control to be released, if needed */
580 jsm_check_queue_flow_control(ch);
582 spin_unlock_irqrestore(&ch->ch_lock, lock_flags);
587 * If we are throttled, simply don't read any data.
589 if (ch->ch_flags & CH_STOPI) {
590 spin_unlock_irqrestore(&ch->ch_lock, lock_flags);
591 jsm_dbg(READ, &ch->ch_bd->pci_dev,
592 "Port %d throttled, not reading any data. head: %x tail: %x\n",
593 ch->ch_portnum, head, tail);
597 jsm_dbg(READ, &ch->ch_bd->pci_dev, "start 2\n");
600 spin_unlock_irqrestore(&ch->ch_lock, lock_flags);
601 jsm_dbg(READ, &ch->ch_bd->pci_dev, "jsm_input 1\n");
605 len = tty_buffer_request_room(port, data_len);
609 * n now contains the most amount of data we can copy,
610 * bounded either by the flip buffer size or the amount
611 * of data the card actually has pending...
614 s = ((head >= tail) ? head : RQUEUESIZE) - tail;
621 * If conditions are such that ld needs to see all
622 * UART errors, we will have to walk each character
623 * and error byte and send them to the buffer one at
627 if (I_PARMRK(tp) || I_BRKINT(tp) || I_INPCK(tp)) {
628 for (i = 0; i < s; i++) {
630 * Give the Linux ld the flags in the
633 if (*(ch->ch_equeue +tail +i) & UART_LSR_BI)
634 tty_insert_flip_char(port, *(ch->ch_rqueue +tail +i), TTY_BREAK);
635 else if (*(ch->ch_equeue +tail +i) & UART_LSR_PE)
636 tty_insert_flip_char(port, *(ch->ch_rqueue +tail +i), TTY_PARITY);
637 else if (*(ch->ch_equeue +tail +i) & UART_LSR_FE)
638 tty_insert_flip_char(port, *(ch->ch_rqueue +tail +i), TTY_FRAME);
640 tty_insert_flip_char(port, *(ch->ch_rqueue +tail +i), TTY_NORMAL);
643 tty_insert_flip_string(port, ch->ch_rqueue + tail, s);
647 /* Flip queue if needed */
651 ch->ch_r_tail = tail & rmask;
652 ch->ch_e_tail = tail & rmask;
653 jsm_check_queue_flow_control(ch);
654 spin_unlock_irqrestore(&ch->ch_lock, lock_flags);
656 /* Tell the tty layer its okay to "eat" the data now */
657 tty_flip_buffer_push(port);
659 jsm_dbg(IOCTL, &ch->ch_bd->pci_dev, "finish\n");
662 static void jsm_carrier(struct jsm_channel *ch)
664 struct jsm_board *bd;
666 int virt_carrier = 0;
667 int phys_carrier = 0;
669 jsm_dbg(CARR, &ch->ch_bd->pci_dev, "start\n");
678 if (ch->ch_mistat & UART_MSR_DCD) {
679 jsm_dbg(CARR, &ch->ch_bd->pci_dev, "mistat: %x D_CD: %x\n",
680 ch->ch_mistat, ch->ch_mistat & UART_MSR_DCD);
684 if (ch->ch_c_cflag & CLOCAL)
687 jsm_dbg(CARR, &ch->ch_bd->pci_dev, "DCD: physical: %d virt: %d\n",
688 phys_carrier, virt_carrier);
691 * Test for a VIRTUAL carrier transition to HIGH.
693 if (((ch->ch_flags & CH_FCAR) == 0) && (virt_carrier == 1)) {
696 * When carrier rises, wake any threads waiting
697 * for carrier in the open routine.
700 jsm_dbg(CARR, &ch->ch_bd->pci_dev, "carrier: virt DCD rose\n");
702 if (waitqueue_active(&(ch->ch_flags_wait)))
703 wake_up_interruptible(&ch->ch_flags_wait);
707 * Test for a PHYSICAL carrier transition to HIGH.
709 if (((ch->ch_flags & CH_CD) == 0) && (phys_carrier == 1)) {
712 * When carrier rises, wake any threads waiting
713 * for carrier in the open routine.
716 jsm_dbg(CARR, &ch->ch_bd->pci_dev,
717 "carrier: physical DCD rose\n");
719 if (waitqueue_active(&(ch->ch_flags_wait)))
720 wake_up_interruptible(&ch->ch_flags_wait);
724 * Test for a PHYSICAL transition to low, so long as we aren't
725 * currently ignoring physical transitions (which is what "virtual
726 * carrier" indicates).
728 * The transition of the virtual carrier to low really doesn't
729 * matter... it really only means "ignore carrier state", not
730 * "make pretend that carrier is there".
732 if ((virt_carrier == 0) && ((ch->ch_flags & CH_CD) != 0)
733 && (phys_carrier == 0)) {
735 * When carrier drops:
737 * Drop carrier on all open units.
739 * Flush queues, waking up any task waiting in the
742 * Send a hangup to the control terminal.
744 * Enable all select calls.
746 if (waitqueue_active(&(ch->ch_flags_wait)))
747 wake_up_interruptible(&ch->ch_flags_wait);
751 * Make sure that our cached values reflect the current reality.
753 if (virt_carrier == 1)
754 ch->ch_flags |= CH_FCAR;
756 ch->ch_flags &= ~CH_FCAR;
758 if (phys_carrier == 1)
759 ch->ch_flags |= CH_CD;
761 ch->ch_flags &= ~CH_CD;
765 void jsm_check_queue_flow_control(struct jsm_channel *ch)
767 struct board_ops *bd_ops = ch->ch_bd->bd_ops;
770 /* Store how much space we have left in the queue */
771 if ((qleft = ch->ch_r_tail - ch->ch_r_head - 1) < 0)
772 qleft += RQUEUEMASK + 1;
775 * Check to see if we should enforce flow control on our queue because
776 * the ld (or user) isn't reading data out of our queue fast enuf.
778 * NOTE: This is done based on what the current flow control of the
781 * 1) HWFLOW (RTS) - Turn off the UART's Receive interrupt.
782 * This will cause the UART's FIFO to back up, and force
783 * the RTS signal to be dropped.
784 * 2) SWFLOW (IXOFF) - Keep trying to send a stop character to
785 * the other side, in hopes it will stop sending data to us.
786 * 3) NONE - Nothing we can do. We will simply drop any extra data
787 * that gets sent into us when the queue fills up.
791 if (ch->ch_c_cflag & CRTSCTS) {
792 if(!(ch->ch_flags & CH_RECEIVER_OFF)) {
793 bd_ops->disable_receiver(ch);
794 ch->ch_flags |= (CH_RECEIVER_OFF);
795 jsm_dbg(READ, &ch->ch_bd->pci_dev,
796 "Internal queue hit hilevel mark (%d)! Turning off interrupts\n",
801 else if (ch->ch_c_iflag & IXOFF) {
802 if (ch->ch_stops_sent <= MAX_STOPS_SENT) {
803 bd_ops->send_stop_character(ch);
805 jsm_dbg(READ, &ch->ch_bd->pci_dev,
806 "Sending stop char! Times sent: %x\n",
813 * Check to see if we should unenforce flow control because
814 * ld (or user) finally read enuf data out of our queue.
816 * NOTE: This is done based on what the current flow control of the
819 * 1) HWFLOW (RTS) - Turn back on the UART's Receive interrupt.
820 * This will cause the UART's FIFO to raise RTS back up,
821 * which will allow the other side to start sending data again.
822 * 2) SWFLOW (IXOFF) - Send a start character to
823 * the other side, so it will start sending data to us again.
824 * 3) NONE - Do nothing. Since we didn't do anything to turn off the
825 * other side, we don't need to do anything now.
827 if (qleft > (RQUEUESIZE / 2)) {
829 if (ch->ch_c_cflag & CRTSCTS) {
830 if (ch->ch_flags & CH_RECEIVER_OFF) {
831 bd_ops->enable_receiver(ch);
832 ch->ch_flags &= ~(CH_RECEIVER_OFF);
833 jsm_dbg(READ, &ch->ch_bd->pci_dev,
834 "Internal queue hit lowlevel mark (%d)! Turning on interrupts\n",
839 else if (ch->ch_c_iflag & IXOFF && ch->ch_stops_sent) {
840 ch->ch_stops_sent = 0;
841 bd_ops->send_start_character(ch);
842 jsm_dbg(READ, &ch->ch_bd->pci_dev,
843 "Sending start char!\n");