1 /*********************************************************************
3 * Filename: ircomm_tty.c
5 * Description: IrCOMM serial TTY driver
6 * Status: Experimental.
7 * Author: Dag Brattli <dagb@cs.uit.no>
8 * Created at: Sun Jun 6 21:00:56 1999
9 * Modified at: Wed Feb 23 00:09:02 2000
10 * Modified by: Dag Brattli <dagb@cs.uit.no>
11 * Sources: serial.c and previous IrCOMM work by Takahide Higuchi
13 * Copyright (c) 1999-2000 Dag Brattli, All Rights Reserved.
14 * Copyright (c) 2000-2003 Jean Tourrilhes <jt@hpl.hp.com>
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License as
18 * published by the Free Software Foundation; either version 2 of
19 * the License, or (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
31 ********************************************************************/
33 #include <linux/init.h>
34 #include <linux/module.h>
36 #include <linux/slab.h>
37 #include <linux/sched.h>
38 #include <linux/seq_file.h>
39 #include <linux/termios.h>
40 #include <linux/tty.h>
41 #include <linux/tty_flip.h>
42 #include <linux/interrupt.h>
43 #include <linux/device.h> /* for MODULE_ALIAS_CHARDEV_MAJOR */
45 #include <asm/uaccess.h>
47 #include <net/irda/irda.h>
48 #include <net/irda/irmod.h>
50 #include <net/irda/ircomm_core.h>
51 #include <net/irda/ircomm_param.h>
52 #include <net/irda/ircomm_tty_attach.h>
53 #include <net/irda/ircomm_tty.h>
55 static int ircomm_tty_install(struct tty_driver *driver,
56 struct tty_struct *tty);
57 static int ircomm_tty_open(struct tty_struct *tty, struct file *filp);
58 static void ircomm_tty_close(struct tty_struct * tty, struct file *filp);
59 static int ircomm_tty_write(struct tty_struct * tty,
60 const unsigned char *buf, int count);
61 static int ircomm_tty_write_room(struct tty_struct *tty);
62 static void ircomm_tty_throttle(struct tty_struct *tty);
63 static void ircomm_tty_unthrottle(struct tty_struct *tty);
64 static int ircomm_tty_chars_in_buffer(struct tty_struct *tty);
65 static void ircomm_tty_flush_buffer(struct tty_struct *tty);
66 static void ircomm_tty_send_xchar(struct tty_struct *tty, char ch);
67 static void ircomm_tty_wait_until_sent(struct tty_struct *tty, int timeout);
68 static void ircomm_tty_hangup(struct tty_struct *tty);
69 static void ircomm_tty_do_softint(struct work_struct *work);
70 static void ircomm_tty_shutdown(struct ircomm_tty_cb *self);
71 static void ircomm_tty_stop(struct tty_struct *tty);
73 static int ircomm_tty_data_indication(void *instance, void *sap,
75 static int ircomm_tty_control_indication(void *instance, void *sap,
77 static void ircomm_tty_flow_indication(void *instance, void *sap,
80 static const struct file_operations ircomm_tty_proc_fops;
81 #endif /* CONFIG_PROC_FS */
82 static struct tty_driver *driver;
84 static hashbin_t *ircomm_tty = NULL;
86 static const struct tty_operations ops = {
87 .install = ircomm_tty_install,
88 .open = ircomm_tty_open,
89 .close = ircomm_tty_close,
90 .write = ircomm_tty_write,
91 .write_room = ircomm_tty_write_room,
92 .chars_in_buffer = ircomm_tty_chars_in_buffer,
93 .flush_buffer = ircomm_tty_flush_buffer,
94 .ioctl = ircomm_tty_ioctl, /* ircomm_tty_ioctl.c */
95 .tiocmget = ircomm_tty_tiocmget, /* ircomm_tty_ioctl.c */
96 .tiocmset = ircomm_tty_tiocmset, /* ircomm_tty_ioctl.c */
97 .throttle = ircomm_tty_throttle,
98 .unthrottle = ircomm_tty_unthrottle,
99 .send_xchar = ircomm_tty_send_xchar,
100 .set_termios = ircomm_tty_set_termios,
101 .stop = ircomm_tty_stop,
102 .start = ircomm_tty_start,
103 .hangup = ircomm_tty_hangup,
104 .wait_until_sent = ircomm_tty_wait_until_sent,
105 #ifdef CONFIG_PROC_FS
106 .proc_fops = &ircomm_tty_proc_fops,
107 #endif /* CONFIG_PROC_FS */
110 static void ircomm_port_raise_dtr_rts(struct tty_port *port, int raise)
112 struct ircomm_tty_cb *self = container_of(port, struct ircomm_tty_cb,
115 * Here, we use to lock those two guys, but as ircomm_param_request()
116 * does it itself, I don't see the point (and I see the deadlock).
120 self->settings.dte |= IRCOMM_RTS | IRCOMM_DTR;
122 self->settings.dte &= ~(IRCOMM_RTS | IRCOMM_DTR);
124 ircomm_param_request(self, IRCOMM_DTE, TRUE);
127 static int ircomm_port_carrier_raised(struct tty_port *port)
129 struct ircomm_tty_cb *self = container_of(port, struct ircomm_tty_cb,
131 return self->settings.dce & IRCOMM_CD;
134 static const struct tty_port_operations ircomm_port_ops = {
135 .dtr_rts = ircomm_port_raise_dtr_rts,
136 .carrier_raised = ircomm_port_carrier_raised,
140 * Function ircomm_tty_init()
142 * Init IrCOMM TTY layer/driver
145 static int __init ircomm_tty_init(void)
147 driver = alloc_tty_driver(IRCOMM_TTY_PORTS);
150 ircomm_tty = hashbin_new(HB_LOCK);
151 if (ircomm_tty == NULL) {
152 IRDA_ERROR("%s(), can't allocate hashbin!\n", __func__);
153 put_tty_driver(driver);
157 driver->driver_name = "ircomm";
158 driver->name = "ircomm";
159 driver->major = IRCOMM_TTY_MAJOR;
160 driver->minor_start = IRCOMM_TTY_MINOR;
161 driver->type = TTY_DRIVER_TYPE_SERIAL;
162 driver->subtype = SERIAL_TYPE_NORMAL;
163 driver->init_termios = tty_std_termios;
164 driver->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
165 driver->flags = TTY_DRIVER_REAL_RAW;
166 tty_set_operations(driver, &ops);
167 if (tty_register_driver(driver)) {
168 IRDA_ERROR("%s(): Couldn't register serial driver\n",
170 put_tty_driver(driver);
176 static void __exit __ircomm_tty_cleanup(struct ircomm_tty_cb *self)
178 IRDA_DEBUG(0, "%s()\n", __func__ );
180 IRDA_ASSERT(self != NULL, return;);
181 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
183 ircomm_tty_shutdown(self);
186 tty_port_destroy(&self->port);
191 * Function ircomm_tty_cleanup ()
193 * Remove IrCOMM TTY layer/driver
196 static void __exit ircomm_tty_cleanup(void)
200 IRDA_DEBUG(4, "%s()\n", __func__ );
202 ret = tty_unregister_driver(driver);
204 IRDA_ERROR("%s(), failed to unregister driver\n",
209 hashbin_delete(ircomm_tty, (FREE_FUNC) __ircomm_tty_cleanup);
210 put_tty_driver(driver);
214 * Function ircomm_startup (self)
219 static int ircomm_tty_startup(struct ircomm_tty_cb *self)
224 IRDA_DEBUG(2, "%s()\n", __func__ );
226 IRDA_ASSERT(self != NULL, return -1;);
227 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
229 /* Check if already open */
230 if (test_and_set_bit(ASYNCB_INITIALIZED, &self->port.flags)) {
231 IRDA_DEBUG(2, "%s(), already open so break out!\n", __func__ );
235 /* Register with IrCOMM */
236 irda_notify_init(¬ify);
237 /* These callbacks we must handle ourselves */
238 notify.data_indication = ircomm_tty_data_indication;
239 notify.udata_indication = ircomm_tty_control_indication;
240 notify.flow_indication = ircomm_tty_flow_indication;
242 /* Use the ircomm_tty interface for these ones */
243 notify.disconnect_indication = ircomm_tty_disconnect_indication;
244 notify.connect_confirm = ircomm_tty_connect_confirm;
245 notify.connect_indication = ircomm_tty_connect_indication;
246 strlcpy(notify.name, "ircomm_tty", sizeof(notify.name));
247 notify.instance = self;
250 self->ircomm = ircomm_open(¬ify, self->service_type,
256 self->slsap_sel = self->ircomm->slsap_sel;
258 /* Connect IrCOMM link with remote device */
259 ret = ircomm_tty_attach_cable(self);
261 IRDA_ERROR("%s(), error attaching cable!\n", __func__);
267 clear_bit(ASYNCB_INITIALIZED, &self->port.flags);
272 * Function ircomm_block_til_ready (self, filp)
277 static int ircomm_tty_block_til_ready(struct ircomm_tty_cb *self,
278 struct tty_struct *tty, struct file *filp)
280 struct tty_port *port = &self->port;
281 DECLARE_WAITQUEUE(wait, current);
286 IRDA_DEBUG(2, "%s()\n", __func__ );
289 * If non-blocking mode is set, or the port is not enabled,
290 * then make the check up front and then exit.
292 if (test_bit(TTY_IO_ERROR, &tty->flags)) {
293 port->flags |= ASYNC_NORMAL_ACTIVE;
297 if (filp->f_flags & O_NONBLOCK) {
298 /* nonblock mode is set */
299 if (tty->termios.c_cflag & CBAUD)
300 tty_port_raise_dtr_rts(port);
301 port->flags |= ASYNC_NORMAL_ACTIVE;
302 IRDA_DEBUG(1, "%s(), O_NONBLOCK requested!\n", __func__ );
306 if (tty->termios.c_cflag & CLOCAL) {
307 IRDA_DEBUG(1, "%s(), doing CLOCAL!\n", __func__ );
311 /* Wait for carrier detect and the line to become
312 * free (i.e., not in use by the callout). While we are in
313 * this loop, port->count is dropped by one, so that
314 * mgsl_close() knows when to free things. We restore it upon
315 * exit, either normal or abnormal.
319 add_wait_queue(&port->open_wait, &wait);
321 IRDA_DEBUG(2, "%s(%d):block_til_ready before block on %s open_count=%d\n",
322 __FILE__, __LINE__, tty->driver->name, port->count);
324 spin_lock_irqsave(&port->lock, flags);
325 if (!tty_hung_up_p(filp))
327 port->blocked_open++;
328 spin_unlock_irqrestore(&port->lock, flags);
331 if (tty->termios.c_cflag & CBAUD)
332 tty_port_raise_dtr_rts(port);
334 set_current_state(TASK_INTERRUPTIBLE);
336 if (tty_hung_up_p(filp) ||
337 !test_bit(ASYNCB_INITIALIZED, &port->flags)) {
338 retval = (port->flags & ASYNC_HUP_NOTIFY) ?
339 -EAGAIN : -ERESTARTSYS;
344 * Check if link is ready now. Even if CLOCAL is
345 * specified, we cannot return before the IrCOMM link is
348 if (!test_bit(ASYNCB_CLOSING, &port->flags) &&
349 (do_clocal || tty_port_carrier_raised(port)) &&
350 self->state == IRCOMM_TTY_READY)
355 if (signal_pending(current)) {
356 retval = -ERESTARTSYS;
360 IRDA_DEBUG(1, "%s(%d):block_til_ready blocking on %s open_count=%d\n",
361 __FILE__, __LINE__, tty->driver->name, port->count);
366 __set_current_state(TASK_RUNNING);
367 remove_wait_queue(&port->open_wait, &wait);
369 spin_lock_irqsave(&port->lock, flags);
370 if (!tty_hung_up_p(filp))
372 port->blocked_open--;
373 spin_unlock_irqrestore(&port->lock, flags);
375 IRDA_DEBUG(1, "%s(%d):block_til_ready after blocking on %s open_count=%d\n",
376 __FILE__, __LINE__, tty->driver->name, port->count);
379 port->flags |= ASYNC_NORMAL_ACTIVE;
385 static int ircomm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
387 struct ircomm_tty_cb *self;
388 unsigned int line = tty->index;
390 /* Check if instance already exists */
391 self = hashbin_lock_find(ircomm_tty, line, NULL);
393 /* No, so make new instance */
394 self = kzalloc(sizeof(struct ircomm_tty_cb), GFP_KERNEL);
396 IRDA_ERROR("%s(), kmalloc failed!\n", __func__);
400 tty_port_init(&self->port);
401 self->port.ops = &ircomm_port_ops;
402 self->magic = IRCOMM_TTY_MAGIC;
403 self->flow = FLOW_STOP;
406 INIT_WORK(&self->tqueue, ircomm_tty_do_softint);
407 self->max_header_size = IRCOMM_TTY_HDR_UNINITIALISED;
408 self->max_data_size = IRCOMM_TTY_DATA_UNINITIALISED;
410 /* Init some important stuff */
411 init_timer(&self->watchdog_timer);
412 spin_lock_init(&self->spinlock);
415 * Force TTY into raw mode by default which is usually what
416 * we want for IrCOMM and IrLPT. This way applications will
417 * not have to twiddle with printcap etc.
419 * Note this is completely usafe and doesn't work properly
421 tty->termios.c_iflag = 0;
422 tty->termios.c_oflag = 0;
424 /* Insert into hash */
425 hashbin_insert(ircomm_tty, (irda_queue_t *) self, line, NULL);
428 tty->driver_data = self;
430 return tty_port_install(&self->port, driver, tty);
434 * Function ircomm_tty_open (tty, filp)
436 * This routine is called when a particular tty device is opened. This
437 * routine is mandatory; if this routine is not filled in, the attempted
438 * open will fail with ENODEV.
440 static int ircomm_tty_open(struct tty_struct *tty, struct file *filp)
442 struct ircomm_tty_cb *self = tty->driver_data;
446 IRDA_DEBUG(2, "%s()\n", __func__ );
448 /* ++ is not atomic, so this should be protected - Jean II */
449 spin_lock_irqsave(&self->port.lock, flags);
451 spin_unlock_irqrestore(&self->port.lock, flags);
452 tty_port_tty_set(&self->port, tty);
454 IRDA_DEBUG(1, "%s(), %s%d, count = %d\n", __func__ , tty->driver->name,
455 self->line, self->port.count);
457 /* Not really used by us, but lets do it anyway */
458 self->port.low_latency = (self->port.flags & ASYNC_LOW_LATENCY) ? 1 : 0;
461 * If the port is the middle of closing, bail out now
463 if (tty_hung_up_p(filp) ||
464 test_bit(ASYNCB_CLOSING, &self->port.flags)) {
466 /* Hm, why are we blocking on ASYNC_CLOSING if we
467 * do return -EAGAIN/-ERESTARTSYS below anyway?
468 * IMHO it's either not needed in the first place
469 * or for some reason we need to make sure the async
470 * closing has been finished - if so, wouldn't we
471 * probably better sleep uninterruptible?
474 if (wait_event_interruptible(self->port.close_wait,
475 !test_bit(ASYNCB_CLOSING, &self->port.flags))) {
476 IRDA_WARNING("%s - got signal while blocking on ASYNC_CLOSING!\n",
481 #ifdef SERIAL_DO_RESTART
482 return (self->port.flags & ASYNC_HUP_NOTIFY) ?
483 -EAGAIN : -ERESTARTSYS;
489 /* Check if this is a "normal" ircomm device, or an irlpt device */
490 if (self->line < 0x10) {
491 self->service_type = IRCOMM_3_WIRE | IRCOMM_9_WIRE;
492 self->settings.service_type = IRCOMM_9_WIRE; /* 9 wire as default */
493 /* Jan Kiszka -> add DSR/RI -> Conform to IrCOMM spec */
494 self->settings.dce = IRCOMM_CTS | IRCOMM_CD | IRCOMM_DSR | IRCOMM_RI; /* Default line settings */
495 IRDA_DEBUG(2, "%s(), IrCOMM device\n", __func__ );
497 IRDA_DEBUG(2, "%s(), IrLPT device\n", __func__ );
498 self->service_type = IRCOMM_3_WIRE_RAW;
499 self->settings.service_type = IRCOMM_3_WIRE_RAW; /* Default */
502 ret = ircomm_tty_startup(self);
506 ret = ircomm_tty_block_til_ready(self, tty, filp);
509 "%s(), returning after block_til_ready with %d\n", __func__ ,
518 * Function ircomm_tty_close (tty, filp)
520 * This routine is called when a particular tty device is closed.
523 static void ircomm_tty_close(struct tty_struct *tty, struct file *filp)
525 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
526 struct tty_port *port = &self->port;
528 IRDA_DEBUG(0, "%s()\n", __func__ );
530 IRDA_ASSERT(self != NULL, return;);
531 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
533 if (tty_port_close_start(port, tty, filp) == 0)
536 ircomm_tty_shutdown(self);
538 tty_driver_flush_buffer(tty);
540 tty_port_close_end(port, tty);
541 tty_port_tty_set(port, NULL);
545 * Function ircomm_tty_flush_buffer (tty)
550 static void ircomm_tty_flush_buffer(struct tty_struct *tty)
552 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
554 IRDA_ASSERT(self != NULL, return;);
555 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
558 * Let do_softint() do this to avoid race condition with
561 schedule_work(&self->tqueue);
565 * Function ircomm_tty_do_softint (work)
567 * We use this routine to give the write wakeup to the user at at a
568 * safe time (as fast as possible after write have completed). This
569 * can be compared to the Tx interrupt.
571 static void ircomm_tty_do_softint(struct work_struct *work)
573 struct ircomm_tty_cb *self =
574 container_of(work, struct ircomm_tty_cb, tqueue);
575 struct tty_struct *tty;
577 struct sk_buff *skb, *ctrl_skb;
579 IRDA_DEBUG(2, "%s()\n", __func__ );
581 if (!self || self->magic != IRCOMM_TTY_MAGIC)
584 tty = tty_port_tty_get(&self->port);
588 /* Unlink control buffer */
589 spin_lock_irqsave(&self->spinlock, flags);
591 ctrl_skb = self->ctrl_skb;
592 self->ctrl_skb = NULL;
594 spin_unlock_irqrestore(&self->spinlock, flags);
596 /* Flush control buffer if any */
598 if(self->flow == FLOW_START)
599 ircomm_control_request(self->ircomm, ctrl_skb);
600 /* Drop reference count - see ircomm_ttp_data_request(). */
601 dev_kfree_skb(ctrl_skb);
607 /* Unlink transmit buffer */
608 spin_lock_irqsave(&self->spinlock, flags);
613 spin_unlock_irqrestore(&self->spinlock, flags);
615 /* Flush transmit buffer if any */
617 ircomm_tty_do_event(self, IRCOMM_TTY_DATA_REQUEST, skb, NULL);
618 /* Drop reference count - see ircomm_ttp_data_request(). */
622 /* Check if user (still) wants to be waken up */
629 * Function ircomm_tty_write (tty, buf, count)
631 * This routine is called by the kernel to write a series of characters
632 * to the tty device. The characters may come from user space or kernel
633 * space. This routine will return the number of characters actually
634 * accepted for writing. This routine is mandatory.
636 static int ircomm_tty_write(struct tty_struct *tty,
637 const unsigned char *buf, int count)
639 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
646 IRDA_DEBUG(2, "%s(), count=%d, hw_stopped=%d\n", __func__ , count,
649 IRDA_ASSERT(self != NULL, return -1;);
650 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
652 /* We may receive packets from the TTY even before we have finished
653 * our setup. Not cool.
654 * The problem is that we don't know the final header and data size
655 * to create the proper skb, so any skb we would create would have
656 * bogus header and data size, so need care.
657 * We use a bogus header size to safely detect this condition.
658 * Another problem is that hw_stopped was set to 0 way before it
659 * should be, so we would drop this skb. It should now be fixed.
660 * One option is to not accept data until we are properly setup.
661 * But, I suspect that when it happens, the ppp line discipline
662 * just "drops" the data, which might screw up connect scripts.
663 * The second option is to create a "safe skb", with large header
664 * and small size (see ircomm_tty_open() for values).
665 * We just need to make sure that when the real values get filled,
666 * we don't mess up the original "safe skb" (see tx_data_size).
668 if (self->max_header_size == IRCOMM_TTY_HDR_UNINITIALISED) {
669 IRDA_DEBUG(1, "%s() : not initialised\n", __func__);
670 #ifdef IRCOMM_NO_TX_BEFORE_INIT
671 /* We didn't consume anything, TTY will retry */
679 /* Protect our manipulation of self->tx_skb and related */
680 spin_lock_irqsave(&self->spinlock, flags);
682 /* Fetch current transmit buffer */
686 * Send out all the data we get, possibly as multiple fragmented
687 * frames, but this will only happen if the data is larger than the
688 * max data size. The normal case however is just the opposite, and
689 * this function may be called multiple times, and will then actually
690 * defragment the data and send it out as one packet as soon as
691 * possible, but at a safer point in time
696 /* Adjust data size to the max data size */
697 if (size > self->max_data_size)
698 size = self->max_data_size;
701 * Do we already have a buffer ready for transmit, or do
702 * we need to allocate a new frame
706 * Any room for more data at the end of the current
707 * transmit buffer? Cannot use skb_tailroom, since
708 * dev_alloc_skb gives us a larger skb than we
710 * Note : use tx_data_size, because max_data_size
711 * may have changed and we don't want to overwrite
714 if ((tailroom = (self->tx_data_size - skb->len)) > 0) {
715 /* Adjust data to tailroom */
720 * Current transmit frame is full, so break
721 * out, so we can send it as soon as possible
726 /* Prepare a full sized frame */
727 skb = alloc_skb(self->max_data_size+
728 self->max_header_size,
731 spin_unlock_irqrestore(&self->spinlock, flags);
734 skb_reserve(skb, self->max_header_size);
736 /* Remember skb size because max_data_size may
737 * change later on - Jean II */
738 self->tx_data_size = self->max_data_size;
742 memcpy(skb_put(skb,size), buf + len, size);
748 spin_unlock_irqrestore(&self->spinlock, flags);
751 * Schedule a new thread which will transmit the frame as soon
752 * as possible, but at a safe point in time. We do this so the
753 * "user" can give us data multiple times, as PPP does (because of
754 * its 256 byte tx buffer). We will then defragment and send out
755 * all this data as one single packet.
757 schedule_work(&self->tqueue);
763 * Function ircomm_tty_write_room (tty)
765 * This routine returns the numbers of characters the tty driver will
766 * accept for queuing to be written. This number is subject to change as
767 * output buffers get emptied, or if the output flow control is acted.
769 static int ircomm_tty_write_room(struct tty_struct *tty)
771 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
775 IRDA_ASSERT(self != NULL, return -1;);
776 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
778 #ifdef IRCOMM_NO_TX_BEFORE_INIT
779 /* max_header_size tells us if the channel is initialised or not. */
780 if (self->max_header_size == IRCOMM_TTY_HDR_UNINITIALISED)
781 /* Don't bother us yet */
785 /* Check if we are allowed to transmit any data.
786 * hw_stopped is the regular flow control.
791 spin_lock_irqsave(&self->spinlock, flags);
793 ret = self->tx_data_size - self->tx_skb->len;
795 ret = self->max_data_size;
796 spin_unlock_irqrestore(&self->spinlock, flags);
798 IRDA_DEBUG(2, "%s(), ret=%d\n", __func__ , ret);
804 * Function ircomm_tty_wait_until_sent (tty, timeout)
806 * This routine waits until the device has written out all of the
807 * characters in its transmitter FIFO.
809 static void ircomm_tty_wait_until_sent(struct tty_struct *tty, int timeout)
811 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
812 unsigned long orig_jiffies, poll_time;
815 IRDA_DEBUG(2, "%s()\n", __func__ );
817 IRDA_ASSERT(self != NULL, return;);
818 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
820 orig_jiffies = jiffies;
822 /* Set poll time to 200 ms */
823 poll_time = IRDA_MIN(timeout, msecs_to_jiffies(200));
825 spin_lock_irqsave(&self->spinlock, flags);
826 while (self->tx_skb && self->tx_skb->len) {
827 spin_unlock_irqrestore(&self->spinlock, flags);
828 schedule_timeout_interruptible(poll_time);
829 spin_lock_irqsave(&self->spinlock, flags);
830 if (signal_pending(current))
832 if (timeout && time_after(jiffies, orig_jiffies + timeout))
835 spin_unlock_irqrestore(&self->spinlock, flags);
836 current->state = TASK_RUNNING;
840 * Function ircomm_tty_throttle (tty)
842 * This routine notifies the tty driver that input buffers for the line
843 * discipline are close to full, and it should somehow signal that no
844 * more characters should be sent to the tty.
846 static void ircomm_tty_throttle(struct tty_struct *tty)
848 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
850 IRDA_DEBUG(2, "%s()\n", __func__ );
852 IRDA_ASSERT(self != NULL, return;);
853 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
855 /* Software flow control? */
857 ircomm_tty_send_xchar(tty, STOP_CHAR(tty));
859 /* Hardware flow control? */
860 if (tty->termios.c_cflag & CRTSCTS) {
861 self->settings.dte &= ~IRCOMM_RTS;
862 self->settings.dte |= IRCOMM_DELTA_RTS;
864 ircomm_param_request(self, IRCOMM_DTE, TRUE);
867 ircomm_flow_request(self->ircomm, FLOW_STOP);
871 * Function ircomm_tty_unthrottle (tty)
873 * This routine notifies the tty drivers that it should signals that
874 * characters can now be sent to the tty without fear of overrunning the
875 * input buffers of the line disciplines.
877 static void ircomm_tty_unthrottle(struct tty_struct *tty)
879 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
881 IRDA_DEBUG(2, "%s()\n", __func__ );
883 IRDA_ASSERT(self != NULL, return;);
884 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
886 /* Using software flow control? */
888 ircomm_tty_send_xchar(tty, START_CHAR(tty));
891 /* Using hardware flow control? */
892 if (tty->termios.c_cflag & CRTSCTS) {
893 self->settings.dte |= (IRCOMM_RTS|IRCOMM_DELTA_RTS);
895 ircomm_param_request(self, IRCOMM_DTE, TRUE);
896 IRDA_DEBUG(1, "%s(), FLOW_START\n", __func__ );
898 ircomm_flow_request(self->ircomm, FLOW_START);
902 * Function ircomm_tty_chars_in_buffer (tty)
904 * Indicates if there are any data in the buffer
907 static int ircomm_tty_chars_in_buffer(struct tty_struct *tty)
909 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
913 IRDA_ASSERT(self != NULL, return -1;);
914 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
916 spin_lock_irqsave(&self->spinlock, flags);
919 len = self->tx_skb->len;
921 spin_unlock_irqrestore(&self->spinlock, flags);
926 static void ircomm_tty_shutdown(struct ircomm_tty_cb *self)
930 IRDA_ASSERT(self != NULL, return;);
931 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
933 IRDA_DEBUG(0, "%s()\n", __func__ );
935 if (!test_and_clear_bit(ASYNCB_INITIALIZED, &self->port.flags))
938 ircomm_tty_detach_cable(self);
940 spin_lock_irqsave(&self->spinlock, flags);
942 del_timer(&self->watchdog_timer);
944 /* Free parameter buffer */
945 if (self->ctrl_skb) {
946 dev_kfree_skb(self->ctrl_skb);
947 self->ctrl_skb = NULL;
950 /* Free transmit buffer */
952 dev_kfree_skb(self->tx_skb);
957 ircomm_close(self->ircomm);
961 spin_unlock_irqrestore(&self->spinlock, flags);
965 * Function ircomm_tty_hangup (tty)
967 * This routine notifies the tty driver that it should hangup the tty
971 static void ircomm_tty_hangup(struct tty_struct *tty)
973 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
974 struct tty_port *port = &self->port;
977 IRDA_DEBUG(0, "%s()\n", __func__ );
979 IRDA_ASSERT(self != NULL, return;);
980 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
982 /* ircomm_tty_flush_buffer(tty); */
983 ircomm_tty_shutdown(self);
985 spin_lock_irqsave(&port->lock, flags);
986 port->flags &= ~ASYNC_NORMAL_ACTIVE;
988 set_bit(TTY_IO_ERROR, &port->tty->flags);
989 tty_kref_put(port->tty);
993 spin_unlock_irqrestore(&port->lock, flags);
995 wake_up_interruptible(&port->open_wait);
999 * Function ircomm_tty_send_xchar (tty, ch)
1001 * This routine is used to send a high-priority XON/XOFF character to
1004 static void ircomm_tty_send_xchar(struct tty_struct *tty, char ch)
1006 IRDA_DEBUG(0, "%s(), not impl\n", __func__ );
1010 * Function ircomm_tty_start (tty)
1012 * This routine notifies the tty driver that it resume sending
1013 * characters to the tty device.
1015 void ircomm_tty_start(struct tty_struct *tty)
1017 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
1019 ircomm_flow_request(self->ircomm, FLOW_START);
1023 * Function ircomm_tty_stop (tty)
1025 * This routine notifies the tty driver that it should stop outputting
1026 * characters to the tty device.
1028 static void ircomm_tty_stop(struct tty_struct *tty)
1030 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
1032 IRDA_ASSERT(self != NULL, return;);
1033 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1035 ircomm_flow_request(self->ircomm, FLOW_STOP);
1039 * Function ircomm_check_modem_status (self)
1041 * Check for any changes in the DCE's line settings. This function should
1042 * be called whenever the dce parameter settings changes, to update the
1043 * flow control settings and other things
1045 void ircomm_tty_check_modem_status(struct ircomm_tty_cb *self)
1047 struct tty_struct *tty;
1050 IRDA_DEBUG(0, "%s()\n", __func__ );
1052 IRDA_ASSERT(self != NULL, return;);
1053 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1055 tty = tty_port_tty_get(&self->port);
1057 status = self->settings.dce;
1059 if (status & IRCOMM_DCE_DELTA_ANY) {
1060 /*wake_up_interruptible(&self->delta_msr_wait);*/
1062 if ((self->port.flags & ASYNC_CHECK_CD) && (status & IRCOMM_DELTA_CD)) {
1064 "%s(), ircomm%d CD now %s...\n", __func__ , self->line,
1065 (status & IRCOMM_CD) ? "on" : "off");
1067 if (status & IRCOMM_CD) {
1068 wake_up_interruptible(&self->port.open_wait);
1071 "%s(), Doing serial hangup..\n", __func__ );
1075 /* Hangup will remote the tty, so better break out */
1079 if (tty && tty_port_cts_enabled(&self->port)) {
1080 if (tty->hw_stopped) {
1081 if (status & IRCOMM_CTS) {
1083 "%s(), CTS tx start...\n", __func__ );
1084 tty->hw_stopped = 0;
1086 /* Wake up processes blocked on open */
1087 wake_up_interruptible(&self->port.open_wait);
1089 schedule_work(&self->tqueue);
1093 if (!(status & IRCOMM_CTS)) {
1095 "%s(), CTS tx stop...\n", __func__ );
1096 tty->hw_stopped = 1;
1105 * Function ircomm_tty_data_indication (instance, sap, skb)
1107 * Handle incoming data, and deliver it to the line discipline
1110 static int ircomm_tty_data_indication(void *instance, void *sap,
1111 struct sk_buff *skb)
1113 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1114 struct tty_struct *tty;
1116 IRDA_DEBUG(2, "%s()\n", __func__ );
1118 IRDA_ASSERT(self != NULL, return -1;);
1119 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
1120 IRDA_ASSERT(skb != NULL, return -1;);
1122 tty = tty_port_tty_get(&self->port);
1124 IRDA_DEBUG(0, "%s(), no tty!\n", __func__ );
1129 * If we receive data when hardware is stopped then something is wrong.
1130 * We try to poll the peers line settings to check if we are up todate.
1131 * Devices like WinCE can do this, and since they don't send any
1132 * params, we can just as well declare the hardware for running.
1134 if (tty->hw_stopped && (self->flow == FLOW_START)) {
1135 IRDA_DEBUG(0, "%s(), polling for line settings!\n", __func__ );
1136 ircomm_param_request(self, IRCOMM_POLL, TRUE);
1138 /* We can just as well declare the hardware for running */
1139 ircomm_tty_send_initial_parameters(self);
1140 ircomm_tty_link_established(self);
1145 * Use flip buffer functions since the code may be called from interrupt
1148 tty_insert_flip_string(&self->port, skb->data, skb->len);
1149 tty_flip_buffer_push(&self->port);
1151 /* No need to kfree_skb - see ircomm_ttp_data_indication() */
1157 * Function ircomm_tty_control_indication (instance, sap, skb)
1159 * Parse all incoming parameters (easy!)
1162 static int ircomm_tty_control_indication(void *instance, void *sap,
1163 struct sk_buff *skb)
1165 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1168 IRDA_DEBUG(4, "%s()\n", __func__ );
1170 IRDA_ASSERT(self != NULL, return -1;);
1171 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
1172 IRDA_ASSERT(skb != NULL, return -1;);
1174 clen = skb->data[0];
1176 irda_param_extract_all(self, skb->data+1, IRDA_MIN(skb->len-1, clen),
1177 &ircomm_param_info);
1179 /* No need to kfree_skb - see ircomm_control_indication() */
1185 * Function ircomm_tty_flow_indication (instance, sap, cmd)
1187 * This function is called by IrTTP when it wants us to slow down the
1188 * transmission of data. We just mark the hardware as stopped, and wait
1189 * for IrTTP to notify us that things are OK again.
1191 static void ircomm_tty_flow_indication(void *instance, void *sap,
1194 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1195 struct tty_struct *tty;
1197 IRDA_ASSERT(self != NULL, return;);
1198 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1200 tty = tty_port_tty_get(&self->port);
1204 IRDA_DEBUG(2, "%s(), hw start!\n", __func__ );
1206 tty->hw_stopped = 0;
1208 /* ircomm_tty_do_softint will take care of the rest */
1209 schedule_work(&self->tqueue);
1211 default: /* If we get here, something is very wrong, better stop */
1213 IRDA_DEBUG(2, "%s(), hw stopped!\n", __func__ );
1215 tty->hw_stopped = 1;
1223 #ifdef CONFIG_PROC_FS
1224 static void ircomm_tty_line_info(struct ircomm_tty_cb *self, struct seq_file *m)
1226 struct tty_struct *tty;
1229 seq_printf(m, "State: %s\n", ircomm_tty_state[self->state]);
1231 seq_puts(m, "Service type: ");
1232 if (self->service_type & IRCOMM_9_WIRE)
1233 seq_puts(m, "9_WIRE");
1234 else if (self->service_type & IRCOMM_3_WIRE)
1235 seq_puts(m, "3_WIRE");
1236 else if (self->service_type & IRCOMM_3_WIRE_RAW)
1237 seq_puts(m, "3_WIRE_RAW");
1239 seq_puts(m, "No common service type!\n");
1242 seq_printf(m, "Port name: %s\n", self->settings.port_name);
1244 seq_printf(m, "DTE status:");
1246 if (self->settings.dte & IRCOMM_RTS) {
1247 seq_printf(m, "%cRTS", sep);
1250 if (self->settings.dte & IRCOMM_DTR) {
1251 seq_printf(m, "%cDTR", sep);
1256 seq_puts(m, "DCE status:");
1258 if (self->settings.dce & IRCOMM_CTS) {
1259 seq_printf(m, "%cCTS", sep);
1262 if (self->settings.dce & IRCOMM_DSR) {
1263 seq_printf(m, "%cDSR", sep);
1266 if (self->settings.dce & IRCOMM_CD) {
1267 seq_printf(m, "%cCD", sep);
1270 if (self->settings.dce & IRCOMM_RI) {
1271 seq_printf(m, "%cRI", sep);
1276 seq_puts(m, "Configuration: ");
1277 if (!self->settings.null_modem)
1278 seq_puts(m, "DTE <-> DCE\n");
1280 seq_puts(m, "DTE <-> DTE (null modem emulation)\n");
1282 seq_printf(m, "Data rate: %d\n", self->settings.data_rate);
1284 seq_puts(m, "Flow control:");
1286 if (self->settings.flow_control & IRCOMM_XON_XOFF_IN) {
1287 seq_printf(m, "%cXON_XOFF_IN", sep);
1290 if (self->settings.flow_control & IRCOMM_XON_XOFF_OUT) {
1291 seq_printf(m, "%cXON_XOFF_OUT", sep);
1294 if (self->settings.flow_control & IRCOMM_RTS_CTS_IN) {
1295 seq_printf(m, "%cRTS_CTS_IN", sep);
1298 if (self->settings.flow_control & IRCOMM_RTS_CTS_OUT) {
1299 seq_printf(m, "%cRTS_CTS_OUT", sep);
1302 if (self->settings.flow_control & IRCOMM_DSR_DTR_IN) {
1303 seq_printf(m, "%cDSR_DTR_IN", sep);
1306 if (self->settings.flow_control & IRCOMM_DSR_DTR_OUT) {
1307 seq_printf(m, "%cDSR_DTR_OUT", sep);
1310 if (self->settings.flow_control & IRCOMM_ENQ_ACK_IN) {
1311 seq_printf(m, "%cENQ_ACK_IN", sep);
1314 if (self->settings.flow_control & IRCOMM_ENQ_ACK_OUT) {
1315 seq_printf(m, "%cENQ_ACK_OUT", sep);
1320 seq_puts(m, "Flags:");
1322 if (tty_port_cts_enabled(&self->port)) {
1323 seq_printf(m, "%cASYNC_CTS_FLOW", sep);
1326 if (self->port.flags & ASYNC_CHECK_CD) {
1327 seq_printf(m, "%cASYNC_CHECK_CD", sep);
1330 if (self->port.flags & ASYNC_INITIALIZED) {
1331 seq_printf(m, "%cASYNC_INITIALIZED", sep);
1334 if (self->port.flags & ASYNC_LOW_LATENCY) {
1335 seq_printf(m, "%cASYNC_LOW_LATENCY", sep);
1338 if (self->port.flags & ASYNC_CLOSING) {
1339 seq_printf(m, "%cASYNC_CLOSING", sep);
1342 if (self->port.flags & ASYNC_NORMAL_ACTIVE) {
1343 seq_printf(m, "%cASYNC_NORMAL_ACTIVE", sep);
1348 seq_printf(m, "Role: %s\n", self->client ? "client" : "server");
1349 seq_printf(m, "Open count: %d\n", self->port.count);
1350 seq_printf(m, "Max data size: %d\n", self->max_data_size);
1351 seq_printf(m, "Max header size: %d\n", self->max_header_size);
1353 tty = tty_port_tty_get(&self->port);
1355 seq_printf(m, "Hardware: %s\n",
1356 tty->hw_stopped ? "Stopped" : "Running");
1361 static int ircomm_tty_proc_show(struct seq_file *m, void *v)
1363 struct ircomm_tty_cb *self;
1364 unsigned long flags;
1366 spin_lock_irqsave(&ircomm_tty->hb_spinlock, flags);
1368 self = (struct ircomm_tty_cb *) hashbin_get_first(ircomm_tty);
1369 while (self != NULL) {
1370 if (self->magic != IRCOMM_TTY_MAGIC)
1373 ircomm_tty_line_info(self, m);
1374 self = (struct ircomm_tty_cb *) hashbin_get_next(ircomm_tty);
1376 spin_unlock_irqrestore(&ircomm_tty->hb_spinlock, flags);
1380 static int ircomm_tty_proc_open(struct inode *inode, struct file *file)
1382 return single_open(file, ircomm_tty_proc_show, NULL);
1385 static const struct file_operations ircomm_tty_proc_fops = {
1386 .owner = THIS_MODULE,
1387 .open = ircomm_tty_proc_open,
1389 .llseek = seq_lseek,
1390 .release = single_release,
1392 #endif /* CONFIG_PROC_FS */
1394 MODULE_AUTHOR("Dag Brattli <dagb@cs.uit.no>");
1395 MODULE_DESCRIPTION("IrCOMM serial TTY driver");
1396 MODULE_LICENSE("GPL");
1397 MODULE_ALIAS_CHARDEV_MAJOR(IRCOMM_TTY_MAJOR);
1399 module_init(ircomm_tty_init);
1400 module_exit(ircomm_tty_cleanup);