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 * Contact Information:
17 * Scott H Kilau <Scott_Kilau@digi.com>
18 * Ananda Venkatarman <mansarov@us.ibm.com>
20 * 01/19/06: changed jsm_input routine to use the dynamically allocated
21 * tty_buffer changes. Contributors: Scott Kilau and Ananda V.
22 ***********************************************************************/
23 #include <linux/tty.h>
24 #include <linux/tty_flip.h>
25 #include <linux/serial_reg.h>
26 #include <linux/delay.h> /* For udelay */
27 #include <linux/pci.h>
28 #include <linux/slab.h>
32 static DECLARE_BITMAP(linemap, MAXLINES);
34 static void jsm_carrier(struct jsm_channel *ch);
36 static inline int jsm_get_mstat(struct jsm_channel *ch)
41 jsm_dbg(IOCTL, &ch->ch_bd->pci_dev, "start\n");
43 mstat = (ch->ch_mostat | ch->ch_mistat);
47 if (mstat & UART_MCR_DTR)
49 if (mstat & UART_MCR_RTS)
51 if (mstat & UART_MSR_CTS)
53 if (mstat & UART_MSR_DSR)
55 if (mstat & UART_MSR_RI)
57 if (mstat & UART_MSR_DCD)
60 jsm_dbg(IOCTL, &ch->ch_bd->pci_dev, "finish\n");
64 static unsigned int jsm_tty_tx_empty(struct uart_port *port)
70 * Return modem signals to ld.
72 static unsigned int jsm_tty_get_mctrl(struct uart_port *port)
75 struct jsm_channel *channel =
76 container_of(port, struct jsm_channel, uart_port);
78 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "start\n");
80 result = jsm_get_mstat(channel);
85 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "finish\n");
91 * jsm_set_modem_info()
93 * Set modem signals, called by ld.
95 static void jsm_tty_set_mctrl(struct uart_port *port, unsigned int mctrl)
97 struct jsm_channel *channel =
98 container_of(port, struct jsm_channel, uart_port);
100 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "start\n");
102 if (mctrl & TIOCM_RTS)
103 channel->ch_mostat |= UART_MCR_RTS;
105 channel->ch_mostat &= ~UART_MCR_RTS;
107 if (mctrl & TIOCM_DTR)
108 channel->ch_mostat |= UART_MCR_DTR;
110 channel->ch_mostat &= ~UART_MCR_DTR;
112 channel->ch_bd->bd_ops->assert_modem_signals(channel);
114 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "finish\n");
121 * Take data from the user or kernel and send it out to the FEP.
122 * In here exists all the Transparent Print magic as well.
124 static void jsm_tty_write(struct uart_port *port)
126 struct jsm_channel *channel;
127 channel = container_of(port, struct jsm_channel, uart_port);
128 channel->ch_bd->bd_ops->copy_data_from_queue_to_uart(channel);
131 static void jsm_tty_start_tx(struct uart_port *port)
133 struct jsm_channel *channel =
134 container_of(port, struct jsm_channel, uart_port);
136 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "start\n");
138 channel->ch_flags &= ~(CH_STOP);
141 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "finish\n");
144 static void jsm_tty_stop_tx(struct uart_port *port)
146 struct jsm_channel *channel =
147 container_of(port, struct jsm_channel, uart_port);
149 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "start\n");
151 channel->ch_flags |= (CH_STOP);
153 jsm_dbg(IOCTL, &channel->ch_bd->pci_dev, "finish\n");
156 static void jsm_tty_send_xchar(struct uart_port *port, char ch)
158 unsigned long lock_flags;
159 struct jsm_channel *channel =
160 container_of(port, struct jsm_channel, uart_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 =
176 container_of(port, struct jsm_channel, uart_port);
178 channel->ch_bd->bd_ops->disable_receiver(channel);
181 static void jsm_tty_break(struct uart_port *port, int break_state)
183 unsigned long lock_flags;
184 struct jsm_channel *channel =
185 container_of(port, struct jsm_channel, uart_port);
187 spin_lock_irqsave(&port->lock, lock_flags);
188 if (break_state == -1)
189 channel->ch_bd->bd_ops->send_break(channel);
191 channel->ch_bd->bd_ops->clear_break(channel);
193 spin_unlock_irqrestore(&port->lock, lock_flags);
196 static int jsm_tty_open(struct uart_port *port)
198 unsigned long lock_flags;
199 struct jsm_board *brd;
200 struct jsm_channel *channel =
201 container_of(port, struct jsm_channel, uart_port);
202 struct ktermios *termios;
204 /* Get board pointer from our array of majors we have allocated */
205 brd = channel->ch_bd;
208 * Allocate channel buffers for read/write/error.
209 * Set flag, so we don't get trounced on.
211 channel->ch_flags |= (CH_OPENING);
213 /* Drop locks, as malloc with GFP_KERNEL can sleep */
215 if (!channel->ch_rqueue) {
216 channel->ch_rqueue = kzalloc(RQUEUESIZE, GFP_KERNEL);
217 if (!channel->ch_rqueue) {
218 jsm_dbg(INIT, &channel->ch_bd->pci_dev,
219 "unable to allocate read queue buf\n");
223 if (!channel->ch_equeue) {
224 channel->ch_equeue = kzalloc(EQUEUESIZE, GFP_KERNEL);
225 if (!channel->ch_equeue) {
226 jsm_dbg(INIT, &channel->ch_bd->pci_dev,
227 "unable to allocate error queue buf\n");
232 channel->ch_flags &= ~(CH_OPENING);
234 * Initialize if neither terminal is open.
236 jsm_dbg(OPEN, &channel->ch_bd->pci_dev,
237 "jsm_open: initializing channel in open...\n");
240 * Flush input queues.
242 channel->ch_r_head = channel->ch_r_tail = 0;
243 channel->ch_e_head = channel->ch_e_tail = 0;
245 brd->bd_ops->flush_uart_write(channel);
246 brd->bd_ops->flush_uart_read(channel);
248 channel->ch_flags = 0;
249 channel->ch_cached_lsr = 0;
250 channel->ch_stops_sent = 0;
252 spin_lock_irqsave(&port->lock, lock_flags);
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++;
272 spin_unlock_irqrestore(&port->lock, lock_flags);
274 jsm_dbg(OPEN, &channel->ch_bd->pci_dev, "finish\n");
278 static void jsm_tty_close(struct uart_port *port)
280 struct jsm_board *bd;
282 struct jsm_channel *channel =
283 container_of(port, struct jsm_channel, uart_port);
285 jsm_dbg(CLOSE, &channel->ch_bd->pci_dev, "start\n");
288 ts = &port->state->port.tty->termios;
290 channel->ch_flags &= ~(CH_STOPI);
292 channel->ch_open_count--;
295 * If we have HUPCL set, lower DTR and RTS
297 if (channel->ch_c_cflag & HUPCL) {
298 jsm_dbg(CLOSE, &channel->ch_bd->pci_dev,
299 "Close. HUPCL set, dropping DTR/RTS\n");
302 channel->ch_mostat &= ~(UART_MCR_DTR | UART_MCR_RTS);
303 bd->bd_ops->assert_modem_signals(channel);
306 /* Turn off UART interrupts for this port */
307 channel->ch_bd->bd_ops->uart_off(channel);
309 jsm_dbg(CLOSE, &channel->ch_bd->pci_dev, "finish\n");
312 static void jsm_tty_set_termios(struct uart_port *port,
313 struct ktermios *termios,
314 struct ktermios *old_termios)
316 unsigned long lock_flags;
317 struct jsm_channel *channel =
318 container_of(port, struct jsm_channel, uart_port);
320 spin_lock_irqsave(&port->lock, lock_flags);
321 channel->ch_c_cflag = termios->c_cflag;
322 channel->ch_c_iflag = termios->c_iflag;
323 channel->ch_c_oflag = termios->c_oflag;
324 channel->ch_c_lflag = termios->c_lflag;
325 channel->ch_startc = termios->c_cc[VSTART];
326 channel->ch_stopc = termios->c_cc[VSTOP];
328 channel->ch_bd->bd_ops->param(channel);
329 jsm_carrier(channel);
330 spin_unlock_irqrestore(&port->lock, lock_flags);
333 static const char *jsm_tty_type(struct uart_port *port)
338 static void jsm_tty_release_port(struct uart_port *port)
342 static int jsm_tty_request_port(struct uart_port *port)
347 static void jsm_config_port(struct uart_port *port, int flags)
349 port->type = PORT_JSM;
352 static const struct uart_ops jsm_ops = {
353 .tx_empty = jsm_tty_tx_empty,
354 .set_mctrl = jsm_tty_set_mctrl,
355 .get_mctrl = jsm_tty_get_mctrl,
356 .stop_tx = jsm_tty_stop_tx,
357 .start_tx = jsm_tty_start_tx,
358 .send_xchar = jsm_tty_send_xchar,
359 .stop_rx = jsm_tty_stop_rx,
360 .break_ctl = jsm_tty_break,
361 .startup = jsm_tty_open,
362 .shutdown = jsm_tty_close,
363 .set_termios = jsm_tty_set_termios,
364 .type = jsm_tty_type,
365 .release_port = jsm_tty_release_port,
366 .request_port = jsm_tty_request_port,
367 .config_port = jsm_config_port,
373 * Init the tty subsystem. Called once per board after board has been
374 * downloaded and init'ed.
376 int jsm_tty_init(struct jsm_board *brd)
380 struct jsm_channel *ch;
385 jsm_dbg(INIT, &brd->pci_dev, "start\n");
388 * Initialize board structure elements.
391 brd->nasync = brd->maxports;
394 * Allocate channel memory that might not have been allocated
395 * when the driver was first loaded.
397 for (i = 0; i < brd->nasync; i++) {
398 if (!brd->channels[i]) {
401 * Okay to malloc with GFP_KERNEL, we are not at
402 * interrupt context, and there are no locks held.
404 brd->channels[i] = kzalloc(sizeof(struct jsm_channel), GFP_KERNEL);
405 if (!brd->channels[i]) {
406 jsm_dbg(CORE, &brd->pci_dev,
407 "%s:%d Unable to allocate memory for channel struct\n",
413 ch = brd->channels[0];
414 vaddr = brd->re_map_membase;
416 /* Set up channel variables */
417 for (i = 0; i < brd->nasync; i++, ch = brd->channels[i]) {
419 if (!brd->channels[i])
422 spin_lock_init(&ch->ch_lock);
424 if (brd->bd_uart_offset == 0x200)
425 ch->ch_neo_uart = vaddr + (brd->bd_uart_offset * i);
427 ch->ch_cls_uart = vaddr + (brd->bd_uart_offset * i);
432 /* .25 second delay */
433 ch->ch_close_delay = 250;
435 init_waitqueue_head(&ch->ch_flags_wait);
438 jsm_dbg(INIT, &brd->pci_dev, "finish\n");
442 int jsm_uart_port_init(struct jsm_board *brd)
446 struct jsm_channel *ch;
451 jsm_dbg(INIT, &brd->pci_dev, "start\n");
454 * Initialize board structure elements.
457 brd->nasync = brd->maxports;
459 /* Set up channel variables */
460 for (i = 0; i < brd->nasync; i++, ch = brd->channels[i]) {
462 if (!brd->channels[i])
465 brd->channels[i]->uart_port.irq = brd->irq;
466 brd->channels[i]->uart_port.uartclk = 14745600;
467 brd->channels[i]->uart_port.type = PORT_JSM;
468 brd->channels[i]->uart_port.iotype = UPIO_MEM;
469 brd->channels[i]->uart_port.membase = brd->re_map_membase;
470 brd->channels[i]->uart_port.fifosize = 16;
471 brd->channels[i]->uart_port.ops = &jsm_ops;
472 line = find_first_zero_bit(linemap, MAXLINES);
473 if (line >= MAXLINES) {
474 printk(KERN_INFO "jsm: linemap is full, added device failed\n");
477 set_bit(line, linemap);
478 brd->channels[i]->uart_port.line = line;
479 rc = uart_add_one_port (&jsm_uart_driver, &brd->channels[i]->uart_port);
481 printk(KERN_INFO "jsm: Port %d failed. Aborting...\n", i);
485 printk(KERN_INFO "jsm: Port %d added\n", i);
488 jsm_dbg(INIT, &brd->pci_dev, "finish\n");
492 int jsm_remove_uart_port(struct jsm_board *brd)
495 struct jsm_channel *ch;
500 jsm_dbg(INIT, &brd->pci_dev, "start\n");
503 * Initialize board structure elements.
506 brd->nasync = brd->maxports;
508 /* Set up channel variables */
509 for (i = 0; i < brd->nasync; i++) {
511 if (!brd->channels[i])
514 ch = brd->channels[i];
516 clear_bit(ch->uart_port.line, linemap);
517 uart_remove_one_port(&jsm_uart_driver, &brd->channels[i]->uart_port);
520 jsm_dbg(INIT, &brd->pci_dev, "finish\n");
524 void jsm_input(struct jsm_channel *ch)
526 struct jsm_board *bd;
527 struct tty_struct *tp;
528 struct tty_port *port;
533 unsigned long lock_flags;
538 jsm_dbg(READ, &ch->ch_bd->pci_dev, "start\n");
543 port = &ch->uart_port.state->port;
550 spin_lock_irqsave(&ch->ch_lock, lock_flags);
553 *Figure the number of characters in the buffer.
554 *Exit immediately if none.
559 head = ch->ch_r_head & rmask;
560 tail = ch->ch_r_tail & rmask;
562 data_len = (head - tail) & rmask;
564 spin_unlock_irqrestore(&ch->ch_lock, lock_flags);
568 jsm_dbg(READ, &ch->ch_bd->pci_dev, "start\n");
571 *If the device is not open, or CREAD is off, flush
572 *input data and return immediately.
574 if (!tp || !C_CREAD(tp)) {
576 jsm_dbg(READ, &ch->ch_bd->pci_dev,
577 "input. dropping %d bytes on port %d...\n",
578 data_len, ch->ch_portnum);
579 ch->ch_r_head = tail;
581 /* Force queue flow control to be released, if needed */
582 jsm_check_queue_flow_control(ch);
584 spin_unlock_irqrestore(&ch->ch_lock, lock_flags);
589 * If we are throttled, simply don't read any data.
591 if (ch->ch_flags & CH_STOPI) {
592 spin_unlock_irqrestore(&ch->ch_lock, lock_flags);
593 jsm_dbg(READ, &ch->ch_bd->pci_dev,
594 "Port %d throttled, not reading any data. head: %x tail: %x\n",
595 ch->ch_portnum, head, tail);
599 jsm_dbg(READ, &ch->ch_bd->pci_dev, "start 2\n");
601 len = tty_buffer_request_room(port, data_len);
604 * len now contains the most amount of data we can copy,
605 * bounded either by the flip buffer size or the amount
606 * of data the card actually has pending...
609 s = ((head >= tail) ? head : RQUEUESIZE) - tail;
616 * If conditions are such that ld needs to see all
617 * UART errors, we will have to walk each character
618 * and error byte and send them to the buffer one at
622 if (I_PARMRK(tp) || I_BRKINT(tp) || I_INPCK(tp)) {
623 for (i = 0; i < s; i++) {
625 * Give the Linux ld the flags in the
628 if (*(ch->ch_equeue +tail +i) & UART_LSR_BI)
629 tty_insert_flip_char(port, *(ch->ch_rqueue +tail +i), TTY_BREAK);
630 else if (*(ch->ch_equeue +tail +i) & UART_LSR_PE)
631 tty_insert_flip_char(port, *(ch->ch_rqueue +tail +i), TTY_PARITY);
632 else if (*(ch->ch_equeue +tail +i) & UART_LSR_FE)
633 tty_insert_flip_char(port, *(ch->ch_rqueue +tail +i), TTY_FRAME);
635 tty_insert_flip_char(port, *(ch->ch_rqueue +tail +i), TTY_NORMAL);
638 tty_insert_flip_string(port, ch->ch_rqueue + tail, s);
642 /* Flip queue if needed */
646 ch->ch_r_tail = tail & rmask;
647 ch->ch_e_tail = tail & rmask;
648 jsm_check_queue_flow_control(ch);
649 spin_unlock_irqrestore(&ch->ch_lock, lock_flags);
651 /* Tell the tty layer its okay to "eat" the data now */
652 tty_flip_buffer_push(port);
654 jsm_dbg(IOCTL, &ch->ch_bd->pci_dev, "finish\n");
657 static void jsm_carrier(struct jsm_channel *ch)
659 struct jsm_board *bd;
661 int virt_carrier = 0;
662 int phys_carrier = 0;
664 jsm_dbg(CARR, &ch->ch_bd->pci_dev, "start\n");
673 if (ch->ch_mistat & UART_MSR_DCD) {
674 jsm_dbg(CARR, &ch->ch_bd->pci_dev, "mistat: %x D_CD: %x\n",
675 ch->ch_mistat, ch->ch_mistat & UART_MSR_DCD);
679 if (ch->ch_c_cflag & CLOCAL)
682 jsm_dbg(CARR, &ch->ch_bd->pci_dev, "DCD: physical: %d virt: %d\n",
683 phys_carrier, virt_carrier);
686 * Test for a VIRTUAL carrier transition to HIGH.
688 if (((ch->ch_flags & CH_FCAR) == 0) && (virt_carrier == 1)) {
691 * When carrier rises, wake any threads waiting
692 * for carrier in the open routine.
695 jsm_dbg(CARR, &ch->ch_bd->pci_dev, "carrier: virt DCD rose\n");
697 if (waitqueue_active(&(ch->ch_flags_wait)))
698 wake_up_interruptible(&ch->ch_flags_wait);
702 * Test for a PHYSICAL carrier transition to HIGH.
704 if (((ch->ch_flags & CH_CD) == 0) && (phys_carrier == 1)) {
707 * When carrier rises, wake any threads waiting
708 * for carrier in the open routine.
711 jsm_dbg(CARR, &ch->ch_bd->pci_dev,
712 "carrier: physical DCD rose\n");
714 if (waitqueue_active(&(ch->ch_flags_wait)))
715 wake_up_interruptible(&ch->ch_flags_wait);
719 * Test for a PHYSICAL transition to low, so long as we aren't
720 * currently ignoring physical transitions (which is what "virtual
721 * carrier" indicates).
723 * The transition of the virtual carrier to low really doesn't
724 * matter... it really only means "ignore carrier state", not
725 * "make pretend that carrier is there".
727 if ((virt_carrier == 0) && ((ch->ch_flags & CH_CD) != 0)
728 && (phys_carrier == 0)) {
730 * When carrier drops:
732 * Drop carrier on all open units.
734 * Flush queues, waking up any task waiting in the
737 * Send a hangup to the control terminal.
739 * Enable all select calls.
741 if (waitqueue_active(&(ch->ch_flags_wait)))
742 wake_up_interruptible(&ch->ch_flags_wait);
746 * Make sure that our cached values reflect the current reality.
748 if (virt_carrier == 1)
749 ch->ch_flags |= CH_FCAR;
751 ch->ch_flags &= ~CH_FCAR;
753 if (phys_carrier == 1)
754 ch->ch_flags |= CH_CD;
756 ch->ch_flags &= ~CH_CD;
760 void jsm_check_queue_flow_control(struct jsm_channel *ch)
762 struct board_ops *bd_ops = ch->ch_bd->bd_ops;
765 /* Store how much space we have left in the queue */
766 if ((qleft = ch->ch_r_tail - ch->ch_r_head - 1) < 0)
767 qleft += RQUEUEMASK + 1;
770 * Check to see if we should enforce flow control on our queue because
771 * the ld (or user) isn't reading data out of our queue fast enuf.
773 * NOTE: This is done based on what the current flow control of the
776 * 1) HWFLOW (RTS) - Turn off the UART's Receive interrupt.
777 * This will cause the UART's FIFO to back up, and force
778 * the RTS signal to be dropped.
779 * 2) SWFLOW (IXOFF) - Keep trying to send a stop character to
780 * the other side, in hopes it will stop sending data to us.
781 * 3) NONE - Nothing we can do. We will simply drop any extra data
782 * that gets sent into us when the queue fills up.
786 if (ch->ch_c_cflag & CRTSCTS) {
787 if(!(ch->ch_flags & CH_RECEIVER_OFF)) {
788 bd_ops->disable_receiver(ch);
789 ch->ch_flags |= (CH_RECEIVER_OFF);
790 jsm_dbg(READ, &ch->ch_bd->pci_dev,
791 "Internal queue hit hilevel mark (%d)! Turning off interrupts\n",
796 else if (ch->ch_c_iflag & IXOFF) {
797 if (ch->ch_stops_sent <= MAX_STOPS_SENT) {
798 bd_ops->send_stop_character(ch);
800 jsm_dbg(READ, &ch->ch_bd->pci_dev,
801 "Sending stop char! Times sent: %x\n",
808 * Check to see if we should unenforce flow control because
809 * ld (or user) finally read enuf data out of our queue.
811 * NOTE: This is done based on what the current flow control of the
814 * 1) HWFLOW (RTS) - Turn back on the UART's Receive interrupt.
815 * This will cause the UART's FIFO to raise RTS back up,
816 * which will allow the other side to start sending data again.
817 * 2) SWFLOW (IXOFF) - Send a start character to
818 * the other side, so it will start sending data to us again.
819 * 3) NONE - Do nothing. Since we didn't do anything to turn off the
820 * other side, we don't need to do anything now.
822 if (qleft > (RQUEUESIZE / 2)) {
824 if (ch->ch_c_cflag & CRTSCTS) {
825 if (ch->ch_flags & CH_RECEIVER_OFF) {
826 bd_ops->enable_receiver(ch);
827 ch->ch_flags &= ~(CH_RECEIVER_OFF);
828 jsm_dbg(READ, &ch->ch_bd->pci_dev,
829 "Internal queue hit lowlevel mark (%d)! Turning on interrupts\n",
834 else if (ch->ch_c_iflag & IXOFF && ch->ch_stops_sent) {
835 ch->ch_stops_sent = 0;
836 bd_ops->send_start_character(ch);
837 jsm_dbg(READ, &ch->ch_bd->pci_dev,
838 "Sending start char!\n");