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);
283 int do_clocal = 0, extra_count = 0;
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 (filp->f_flags & O_NONBLOCK || tty->flags & (1 << TTY_IO_ERROR)){
293 /* nonblock mode is set or port is not enabled */
294 port->flags |= ASYNC_NORMAL_ACTIVE;
295 IRDA_DEBUG(1, "%s(), O_NONBLOCK requested!\n", __func__ );
299 if (tty->termios.c_cflag & CLOCAL) {
300 IRDA_DEBUG(1, "%s(), doing CLOCAL!\n", __func__ );
304 /* Wait for carrier detect and the line to become
305 * free (i.e., not in use by the callout). While we are in
306 * this loop, port->count is dropped by one, so that
307 * mgsl_close() knows when to free things. We restore it upon
308 * exit, either normal or abnormal.
312 add_wait_queue(&port->open_wait, &wait);
314 IRDA_DEBUG(2, "%s(%d):block_til_ready before block on %s open_count=%d\n",
315 __FILE__, __LINE__, tty->driver->name, port->count);
317 spin_lock_irqsave(&port->lock, flags);
318 if (!tty_hung_up_p(filp)) {
322 spin_unlock_irqrestore(&port->lock, flags);
323 port->blocked_open++;
326 if (tty->termios.c_cflag & CBAUD)
327 tty_port_raise_dtr_rts(port);
329 current->state = TASK_INTERRUPTIBLE;
331 if (tty_hung_up_p(filp) ||
332 !test_bit(ASYNCB_INITIALIZED, &port->flags)) {
333 retval = (port->flags & ASYNC_HUP_NOTIFY) ?
334 -EAGAIN : -ERESTARTSYS;
339 * Check if link is ready now. Even if CLOCAL is
340 * specified, we cannot return before the IrCOMM link is
343 if (!test_bit(ASYNCB_CLOSING, &port->flags) &&
344 (do_clocal || tty_port_carrier_raised(port)) &&
345 self->state == IRCOMM_TTY_READY)
350 if (signal_pending(current)) {
351 retval = -ERESTARTSYS;
355 IRDA_DEBUG(1, "%s(%d):block_til_ready blocking on %s open_count=%d\n",
356 __FILE__, __LINE__, tty->driver->name, port->count);
361 __set_current_state(TASK_RUNNING);
362 remove_wait_queue(&port->open_wait, &wait);
365 /* ++ is not atomic, so this should be protected - Jean II */
366 spin_lock_irqsave(&port->lock, flags);
368 spin_unlock_irqrestore(&port->lock, flags);
370 port->blocked_open--;
372 IRDA_DEBUG(1, "%s(%d):block_til_ready after blocking on %s open_count=%d\n",
373 __FILE__, __LINE__, tty->driver->name, port->count);
376 port->flags |= ASYNC_NORMAL_ACTIVE;
382 static int ircomm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
384 struct ircomm_tty_cb *self;
385 unsigned int line = tty->index;
387 /* Check if instance already exists */
388 self = hashbin_lock_find(ircomm_tty, line, NULL);
390 /* No, so make new instance */
391 self = kzalloc(sizeof(struct ircomm_tty_cb), GFP_KERNEL);
393 IRDA_ERROR("%s(), kmalloc failed!\n", __func__);
397 tty_port_init(&self->port);
398 self->port.ops = &ircomm_port_ops;
399 self->magic = IRCOMM_TTY_MAGIC;
400 self->flow = FLOW_STOP;
403 INIT_WORK(&self->tqueue, ircomm_tty_do_softint);
404 self->max_header_size = IRCOMM_TTY_HDR_UNINITIALISED;
405 self->max_data_size = IRCOMM_TTY_DATA_UNINITIALISED;
407 /* Init some important stuff */
408 init_timer(&self->watchdog_timer);
409 spin_lock_init(&self->spinlock);
412 * Force TTY into raw mode by default which is usually what
413 * we want for IrCOMM and IrLPT. This way applications will
414 * not have to twiddle with printcap etc.
416 * Note this is completely usafe and doesn't work properly
418 tty->termios.c_iflag = 0;
419 tty->termios.c_oflag = 0;
421 /* Insert into hash */
422 hashbin_insert(ircomm_tty, (irda_queue_t *) self, line, NULL);
425 tty->driver_data = self;
427 return tty_port_install(&self->port, driver, tty);
431 * Function ircomm_tty_open (tty, filp)
433 * This routine is called when a particular tty device is opened. This
434 * routine is mandatory; if this routine is not filled in, the attempted
435 * open will fail with ENODEV.
437 static int ircomm_tty_open(struct tty_struct *tty, struct file *filp)
439 struct ircomm_tty_cb *self = tty->driver_data;
443 IRDA_DEBUG(2, "%s()\n", __func__ );
445 /* ++ is not atomic, so this should be protected - Jean II */
446 spin_lock_irqsave(&self->port.lock, flags);
448 spin_unlock_irqrestore(&self->port.lock, flags);
449 tty_port_tty_set(&self->port, tty);
451 IRDA_DEBUG(1, "%s(), %s%d, count = %d\n", __func__ , tty->driver->name,
452 self->line, self->port.count);
454 /* Not really used by us, but lets do it anyway */
455 self->port.low_latency = (self->port.flags & ASYNC_LOW_LATENCY) ? 1 : 0;
458 * If the port is the middle of closing, bail out now
460 if (tty_hung_up_p(filp) ||
461 test_bit(ASYNCB_CLOSING, &self->port.flags)) {
463 /* Hm, why are we blocking on ASYNC_CLOSING if we
464 * do return -EAGAIN/-ERESTARTSYS below anyway?
465 * IMHO it's either not needed in the first place
466 * or for some reason we need to make sure the async
467 * closing has been finished - if so, wouldn't we
468 * probably better sleep uninterruptible?
471 if (wait_event_interruptible(self->port.close_wait,
472 !test_bit(ASYNCB_CLOSING, &self->port.flags))) {
473 IRDA_WARNING("%s - got signal while blocking on ASYNC_CLOSING!\n",
478 #ifdef SERIAL_DO_RESTART
479 return (self->port.flags & ASYNC_HUP_NOTIFY) ?
480 -EAGAIN : -ERESTARTSYS;
486 /* Check if this is a "normal" ircomm device, or an irlpt device */
487 if (self->line < 0x10) {
488 self->service_type = IRCOMM_3_WIRE | IRCOMM_9_WIRE;
489 self->settings.service_type = IRCOMM_9_WIRE; /* 9 wire as default */
490 /* Jan Kiszka -> add DSR/RI -> Conform to IrCOMM spec */
491 self->settings.dce = IRCOMM_CTS | IRCOMM_CD | IRCOMM_DSR | IRCOMM_RI; /* Default line settings */
492 IRDA_DEBUG(2, "%s(), IrCOMM device\n", __func__ );
494 IRDA_DEBUG(2, "%s(), IrLPT device\n", __func__ );
495 self->service_type = IRCOMM_3_WIRE_RAW;
496 self->settings.service_type = IRCOMM_3_WIRE_RAW; /* Default */
499 ret = ircomm_tty_startup(self);
503 ret = ircomm_tty_block_til_ready(self, tty, filp);
506 "%s(), returning after block_til_ready with %d\n", __func__ ,
515 * Function ircomm_tty_close (tty, filp)
517 * This routine is called when a particular tty device is closed.
520 static void ircomm_tty_close(struct tty_struct *tty, struct file *filp)
522 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
523 struct tty_port *port = &self->port;
525 IRDA_DEBUG(0, "%s()\n", __func__ );
527 IRDA_ASSERT(self != NULL, return;);
528 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
530 if (tty_port_close_start(port, tty, filp) == 0)
533 ircomm_tty_shutdown(self);
535 tty_driver_flush_buffer(tty);
537 tty_port_close_end(port, tty);
538 tty_port_tty_set(port, NULL);
542 * Function ircomm_tty_flush_buffer (tty)
547 static void ircomm_tty_flush_buffer(struct tty_struct *tty)
549 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
551 IRDA_ASSERT(self != NULL, return;);
552 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
555 * Let do_softint() do this to avoid race condition with
558 schedule_work(&self->tqueue);
562 * Function ircomm_tty_do_softint (work)
564 * We use this routine to give the write wakeup to the user at at a
565 * safe time (as fast as possible after write have completed). This
566 * can be compared to the Tx interrupt.
568 static void ircomm_tty_do_softint(struct work_struct *work)
570 struct ircomm_tty_cb *self =
571 container_of(work, struct ircomm_tty_cb, tqueue);
572 struct tty_struct *tty;
574 struct sk_buff *skb, *ctrl_skb;
576 IRDA_DEBUG(2, "%s()\n", __func__ );
578 if (!self || self->magic != IRCOMM_TTY_MAGIC)
581 tty = tty_port_tty_get(&self->port);
585 /* Unlink control buffer */
586 spin_lock_irqsave(&self->spinlock, flags);
588 ctrl_skb = self->ctrl_skb;
589 self->ctrl_skb = NULL;
591 spin_unlock_irqrestore(&self->spinlock, flags);
593 /* Flush control buffer if any */
595 if(self->flow == FLOW_START)
596 ircomm_control_request(self->ircomm, ctrl_skb);
597 /* Drop reference count - see ircomm_ttp_data_request(). */
598 dev_kfree_skb(ctrl_skb);
604 /* Unlink transmit buffer */
605 spin_lock_irqsave(&self->spinlock, flags);
610 spin_unlock_irqrestore(&self->spinlock, flags);
612 /* Flush transmit buffer if any */
614 ircomm_tty_do_event(self, IRCOMM_TTY_DATA_REQUEST, skb, NULL);
615 /* Drop reference count - see ircomm_ttp_data_request(). */
619 /* Check if user (still) wants to be waken up */
626 * Function ircomm_tty_write (tty, buf, count)
628 * This routine is called by the kernel to write a series of characters
629 * to the tty device. The characters may come from user space or kernel
630 * space. This routine will return the number of characters actually
631 * accepted for writing. This routine is mandatory.
633 static int ircomm_tty_write(struct tty_struct *tty,
634 const unsigned char *buf, int count)
636 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
643 IRDA_DEBUG(2, "%s(), count=%d, hw_stopped=%d\n", __func__ , count,
646 IRDA_ASSERT(self != NULL, return -1;);
647 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
649 /* We may receive packets from the TTY even before we have finished
650 * our setup. Not cool.
651 * The problem is that we don't know the final header and data size
652 * to create the proper skb, so any skb we would create would have
653 * bogus header and data size, so need care.
654 * We use a bogus header size to safely detect this condition.
655 * Another problem is that hw_stopped was set to 0 way before it
656 * should be, so we would drop this skb. It should now be fixed.
657 * One option is to not accept data until we are properly setup.
658 * But, I suspect that when it happens, the ppp line discipline
659 * just "drops" the data, which might screw up connect scripts.
660 * The second option is to create a "safe skb", with large header
661 * and small size (see ircomm_tty_open() for values).
662 * We just need to make sure that when the real values get filled,
663 * we don't mess up the original "safe skb" (see tx_data_size).
665 if (self->max_header_size == IRCOMM_TTY_HDR_UNINITIALISED) {
666 IRDA_DEBUG(1, "%s() : not initialised\n", __func__);
667 #ifdef IRCOMM_NO_TX_BEFORE_INIT
668 /* We didn't consume anything, TTY will retry */
676 /* Protect our manipulation of self->tx_skb and related */
677 spin_lock_irqsave(&self->spinlock, flags);
679 /* Fetch current transmit buffer */
683 * Send out all the data we get, possibly as multiple fragmented
684 * frames, but this will only happen if the data is larger than the
685 * max data size. The normal case however is just the opposite, and
686 * this function may be called multiple times, and will then actually
687 * defragment the data and send it out as one packet as soon as
688 * possible, but at a safer point in time
693 /* Adjust data size to the max data size */
694 if (size > self->max_data_size)
695 size = self->max_data_size;
698 * Do we already have a buffer ready for transmit, or do
699 * we need to allocate a new frame
703 * Any room for more data at the end of the current
704 * transmit buffer? Cannot use skb_tailroom, since
705 * dev_alloc_skb gives us a larger skb than we
707 * Note : use tx_data_size, because max_data_size
708 * may have changed and we don't want to overwrite
711 if ((tailroom = (self->tx_data_size - skb->len)) > 0) {
712 /* Adjust data to tailroom */
717 * Current transmit frame is full, so break
718 * out, so we can send it as soon as possible
723 /* Prepare a full sized frame */
724 skb = alloc_skb(self->max_data_size+
725 self->max_header_size,
728 spin_unlock_irqrestore(&self->spinlock, flags);
731 skb_reserve(skb, self->max_header_size);
733 /* Remember skb size because max_data_size may
734 * change later on - Jean II */
735 self->tx_data_size = self->max_data_size;
739 memcpy(skb_put(skb,size), buf + len, size);
745 spin_unlock_irqrestore(&self->spinlock, flags);
748 * Schedule a new thread which will transmit the frame as soon
749 * as possible, but at a safe point in time. We do this so the
750 * "user" can give us data multiple times, as PPP does (because of
751 * its 256 byte tx buffer). We will then defragment and send out
752 * all this data as one single packet.
754 schedule_work(&self->tqueue);
760 * Function ircomm_tty_write_room (tty)
762 * This routine returns the numbers of characters the tty driver will
763 * accept for queuing to be written. This number is subject to change as
764 * output buffers get emptied, or if the output flow control is acted.
766 static int ircomm_tty_write_room(struct tty_struct *tty)
768 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
772 IRDA_ASSERT(self != NULL, return -1;);
773 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
775 #ifdef IRCOMM_NO_TX_BEFORE_INIT
776 /* max_header_size tells us if the channel is initialised or not. */
777 if (self->max_header_size == IRCOMM_TTY_HDR_UNINITIALISED)
778 /* Don't bother us yet */
782 /* Check if we are allowed to transmit any data.
783 * hw_stopped is the regular flow control.
788 spin_lock_irqsave(&self->spinlock, flags);
790 ret = self->tx_data_size - self->tx_skb->len;
792 ret = self->max_data_size;
793 spin_unlock_irqrestore(&self->spinlock, flags);
795 IRDA_DEBUG(2, "%s(), ret=%d\n", __func__ , ret);
801 * Function ircomm_tty_wait_until_sent (tty, timeout)
803 * This routine waits until the device has written out all of the
804 * characters in its transmitter FIFO.
806 static void ircomm_tty_wait_until_sent(struct tty_struct *tty, int timeout)
808 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
809 unsigned long orig_jiffies, poll_time;
812 IRDA_DEBUG(2, "%s()\n", __func__ );
814 IRDA_ASSERT(self != NULL, return;);
815 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
817 orig_jiffies = jiffies;
819 /* Set poll time to 200 ms */
820 poll_time = IRDA_MIN(timeout, msecs_to_jiffies(200));
822 spin_lock_irqsave(&self->spinlock, flags);
823 while (self->tx_skb && self->tx_skb->len) {
824 spin_unlock_irqrestore(&self->spinlock, flags);
825 schedule_timeout_interruptible(poll_time);
826 spin_lock_irqsave(&self->spinlock, flags);
827 if (signal_pending(current))
829 if (timeout && time_after(jiffies, orig_jiffies + timeout))
832 spin_unlock_irqrestore(&self->spinlock, flags);
833 current->state = TASK_RUNNING;
837 * Function ircomm_tty_throttle (tty)
839 * This routine notifies the tty driver that input buffers for the line
840 * discipline are close to full, and it should somehow signal that no
841 * more characters should be sent to the tty.
843 static void ircomm_tty_throttle(struct tty_struct *tty)
845 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
847 IRDA_DEBUG(2, "%s()\n", __func__ );
849 IRDA_ASSERT(self != NULL, return;);
850 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
852 /* Software flow control? */
854 ircomm_tty_send_xchar(tty, STOP_CHAR(tty));
856 /* Hardware flow control? */
857 if (tty->termios.c_cflag & CRTSCTS) {
858 self->settings.dte &= ~IRCOMM_RTS;
859 self->settings.dte |= IRCOMM_DELTA_RTS;
861 ircomm_param_request(self, IRCOMM_DTE, TRUE);
864 ircomm_flow_request(self->ircomm, FLOW_STOP);
868 * Function ircomm_tty_unthrottle (tty)
870 * This routine notifies the tty drivers that it should signals that
871 * characters can now be sent to the tty without fear of overrunning the
872 * input buffers of the line disciplines.
874 static void ircomm_tty_unthrottle(struct tty_struct *tty)
876 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
878 IRDA_DEBUG(2, "%s()\n", __func__ );
880 IRDA_ASSERT(self != NULL, return;);
881 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
883 /* Using software flow control? */
885 ircomm_tty_send_xchar(tty, START_CHAR(tty));
888 /* Using hardware flow control? */
889 if (tty->termios.c_cflag & CRTSCTS) {
890 self->settings.dte |= (IRCOMM_RTS|IRCOMM_DELTA_RTS);
892 ircomm_param_request(self, IRCOMM_DTE, TRUE);
893 IRDA_DEBUG(1, "%s(), FLOW_START\n", __func__ );
895 ircomm_flow_request(self->ircomm, FLOW_START);
899 * Function ircomm_tty_chars_in_buffer (tty)
901 * Indicates if there are any data in the buffer
904 static int ircomm_tty_chars_in_buffer(struct tty_struct *tty)
906 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
910 IRDA_ASSERT(self != NULL, return -1;);
911 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
913 spin_lock_irqsave(&self->spinlock, flags);
916 len = self->tx_skb->len;
918 spin_unlock_irqrestore(&self->spinlock, flags);
923 static void ircomm_tty_shutdown(struct ircomm_tty_cb *self)
927 IRDA_ASSERT(self != NULL, return;);
928 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
930 IRDA_DEBUG(0, "%s()\n", __func__ );
932 if (!test_and_clear_bit(ASYNCB_INITIALIZED, &self->port.flags))
935 ircomm_tty_detach_cable(self);
937 spin_lock_irqsave(&self->spinlock, flags);
939 del_timer(&self->watchdog_timer);
941 /* Free parameter buffer */
942 if (self->ctrl_skb) {
943 dev_kfree_skb(self->ctrl_skb);
944 self->ctrl_skb = NULL;
947 /* Free transmit buffer */
949 dev_kfree_skb(self->tx_skb);
954 ircomm_close(self->ircomm);
958 spin_unlock_irqrestore(&self->spinlock, flags);
962 * Function ircomm_tty_hangup (tty)
964 * This routine notifies the tty driver that it should hangup the tty
968 static void ircomm_tty_hangup(struct tty_struct *tty)
970 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
971 struct tty_port *port = &self->port;
974 IRDA_DEBUG(0, "%s()\n", __func__ );
976 IRDA_ASSERT(self != NULL, return;);
977 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
979 /* ircomm_tty_flush_buffer(tty); */
980 ircomm_tty_shutdown(self);
982 spin_lock_irqsave(&port->lock, flags);
983 port->flags &= ~ASYNC_NORMAL_ACTIVE;
985 set_bit(TTY_IO_ERROR, &port->tty->flags);
986 tty_kref_put(port->tty);
990 spin_unlock_irqrestore(&port->lock, flags);
992 wake_up_interruptible(&port->open_wait);
996 * Function ircomm_tty_send_xchar (tty, ch)
998 * This routine is used to send a high-priority XON/XOFF character to
1001 static void ircomm_tty_send_xchar(struct tty_struct *tty, char ch)
1003 IRDA_DEBUG(0, "%s(), not impl\n", __func__ );
1007 * Function ircomm_tty_start (tty)
1009 * This routine notifies the tty driver that it resume sending
1010 * characters to the tty device.
1012 void ircomm_tty_start(struct tty_struct *tty)
1014 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
1016 ircomm_flow_request(self->ircomm, FLOW_START);
1020 * Function ircomm_tty_stop (tty)
1022 * This routine notifies the tty driver that it should stop outputting
1023 * characters to the tty device.
1025 static void ircomm_tty_stop(struct tty_struct *tty)
1027 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
1029 IRDA_ASSERT(self != NULL, return;);
1030 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1032 ircomm_flow_request(self->ircomm, FLOW_STOP);
1036 * Function ircomm_check_modem_status (self)
1038 * Check for any changes in the DCE's line settings. This function should
1039 * be called whenever the dce parameter settings changes, to update the
1040 * flow control settings and other things
1042 void ircomm_tty_check_modem_status(struct ircomm_tty_cb *self)
1044 struct tty_struct *tty;
1047 IRDA_DEBUG(0, "%s()\n", __func__ );
1049 IRDA_ASSERT(self != NULL, return;);
1050 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1052 tty = tty_port_tty_get(&self->port);
1054 status = self->settings.dce;
1056 if (status & IRCOMM_DCE_DELTA_ANY) {
1057 /*wake_up_interruptible(&self->delta_msr_wait);*/
1059 if ((self->port.flags & ASYNC_CHECK_CD) && (status & IRCOMM_DELTA_CD)) {
1061 "%s(), ircomm%d CD now %s...\n", __func__ , self->line,
1062 (status & IRCOMM_CD) ? "on" : "off");
1064 if (status & IRCOMM_CD) {
1065 wake_up_interruptible(&self->port.open_wait);
1068 "%s(), Doing serial hangup..\n", __func__ );
1072 /* Hangup will remote the tty, so better break out */
1076 if (tty && tty_port_cts_enabled(&self->port)) {
1077 if (tty->hw_stopped) {
1078 if (status & IRCOMM_CTS) {
1080 "%s(), CTS tx start...\n", __func__ );
1081 tty->hw_stopped = 0;
1083 /* Wake up processes blocked on open */
1084 wake_up_interruptible(&self->port.open_wait);
1086 schedule_work(&self->tqueue);
1090 if (!(status & IRCOMM_CTS)) {
1092 "%s(), CTS tx stop...\n", __func__ );
1093 tty->hw_stopped = 1;
1102 * Function ircomm_tty_data_indication (instance, sap, skb)
1104 * Handle incoming data, and deliver it to the line discipline
1107 static int ircomm_tty_data_indication(void *instance, void *sap,
1108 struct sk_buff *skb)
1110 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1111 struct tty_struct *tty;
1113 IRDA_DEBUG(2, "%s()\n", __func__ );
1115 IRDA_ASSERT(self != NULL, return -1;);
1116 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
1117 IRDA_ASSERT(skb != NULL, return -1;);
1119 tty = tty_port_tty_get(&self->port);
1121 IRDA_DEBUG(0, "%s(), no tty!\n", __func__ );
1126 * If we receive data when hardware is stopped then something is wrong.
1127 * We try to poll the peers line settings to check if we are up todate.
1128 * Devices like WinCE can do this, and since they don't send any
1129 * params, we can just as well declare the hardware for running.
1131 if (tty->hw_stopped && (self->flow == FLOW_START)) {
1132 IRDA_DEBUG(0, "%s(), polling for line settings!\n", __func__ );
1133 ircomm_param_request(self, IRCOMM_POLL, TRUE);
1135 /* We can just as well declare the hardware for running */
1136 ircomm_tty_send_initial_parameters(self);
1137 ircomm_tty_link_established(self);
1142 * Use flip buffer functions since the code may be called from interrupt
1145 tty_insert_flip_string(&self->port, skb->data, skb->len);
1146 tty_flip_buffer_push(&self->port);
1148 /* No need to kfree_skb - see ircomm_ttp_data_indication() */
1154 * Function ircomm_tty_control_indication (instance, sap, skb)
1156 * Parse all incoming parameters (easy!)
1159 static int ircomm_tty_control_indication(void *instance, void *sap,
1160 struct sk_buff *skb)
1162 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1165 IRDA_DEBUG(4, "%s()\n", __func__ );
1167 IRDA_ASSERT(self != NULL, return -1;);
1168 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
1169 IRDA_ASSERT(skb != NULL, return -1;);
1171 clen = skb->data[0];
1173 irda_param_extract_all(self, skb->data+1, IRDA_MIN(skb->len-1, clen),
1174 &ircomm_param_info);
1176 /* No need to kfree_skb - see ircomm_control_indication() */
1182 * Function ircomm_tty_flow_indication (instance, sap, cmd)
1184 * This function is called by IrTTP when it wants us to slow down the
1185 * transmission of data. We just mark the hardware as stopped, and wait
1186 * for IrTTP to notify us that things are OK again.
1188 static void ircomm_tty_flow_indication(void *instance, void *sap,
1191 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1192 struct tty_struct *tty;
1194 IRDA_ASSERT(self != NULL, return;);
1195 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1197 tty = tty_port_tty_get(&self->port);
1201 IRDA_DEBUG(2, "%s(), hw start!\n", __func__ );
1203 tty->hw_stopped = 0;
1205 /* ircomm_tty_do_softint will take care of the rest */
1206 schedule_work(&self->tqueue);
1208 default: /* If we get here, something is very wrong, better stop */
1210 IRDA_DEBUG(2, "%s(), hw stopped!\n", __func__ );
1212 tty->hw_stopped = 1;
1220 #ifdef CONFIG_PROC_FS
1221 static void ircomm_tty_line_info(struct ircomm_tty_cb *self, struct seq_file *m)
1223 struct tty_struct *tty;
1226 seq_printf(m, "State: %s\n", ircomm_tty_state[self->state]);
1228 seq_puts(m, "Service type: ");
1229 if (self->service_type & IRCOMM_9_WIRE)
1230 seq_puts(m, "9_WIRE");
1231 else if (self->service_type & IRCOMM_3_WIRE)
1232 seq_puts(m, "3_WIRE");
1233 else if (self->service_type & IRCOMM_3_WIRE_RAW)
1234 seq_puts(m, "3_WIRE_RAW");
1236 seq_puts(m, "No common service type!\n");
1239 seq_printf(m, "Port name: %s\n", self->settings.port_name);
1241 seq_printf(m, "DTE status:");
1243 if (self->settings.dte & IRCOMM_RTS) {
1244 seq_printf(m, "%cRTS", sep);
1247 if (self->settings.dte & IRCOMM_DTR) {
1248 seq_printf(m, "%cDTR", sep);
1253 seq_puts(m, "DCE status:");
1255 if (self->settings.dce & IRCOMM_CTS) {
1256 seq_printf(m, "%cCTS", sep);
1259 if (self->settings.dce & IRCOMM_DSR) {
1260 seq_printf(m, "%cDSR", sep);
1263 if (self->settings.dce & IRCOMM_CD) {
1264 seq_printf(m, "%cCD", sep);
1267 if (self->settings.dce & IRCOMM_RI) {
1268 seq_printf(m, "%cRI", sep);
1273 seq_puts(m, "Configuration: ");
1274 if (!self->settings.null_modem)
1275 seq_puts(m, "DTE <-> DCE\n");
1277 seq_puts(m, "DTE <-> DTE (null modem emulation)\n");
1279 seq_printf(m, "Data rate: %d\n", self->settings.data_rate);
1281 seq_puts(m, "Flow control:");
1283 if (self->settings.flow_control & IRCOMM_XON_XOFF_IN) {
1284 seq_printf(m, "%cXON_XOFF_IN", sep);
1287 if (self->settings.flow_control & IRCOMM_XON_XOFF_OUT) {
1288 seq_printf(m, "%cXON_XOFF_OUT", sep);
1291 if (self->settings.flow_control & IRCOMM_RTS_CTS_IN) {
1292 seq_printf(m, "%cRTS_CTS_IN", sep);
1295 if (self->settings.flow_control & IRCOMM_RTS_CTS_OUT) {
1296 seq_printf(m, "%cRTS_CTS_OUT", sep);
1299 if (self->settings.flow_control & IRCOMM_DSR_DTR_IN) {
1300 seq_printf(m, "%cDSR_DTR_IN", sep);
1303 if (self->settings.flow_control & IRCOMM_DSR_DTR_OUT) {
1304 seq_printf(m, "%cDSR_DTR_OUT", sep);
1307 if (self->settings.flow_control & IRCOMM_ENQ_ACK_IN) {
1308 seq_printf(m, "%cENQ_ACK_IN", sep);
1311 if (self->settings.flow_control & IRCOMM_ENQ_ACK_OUT) {
1312 seq_printf(m, "%cENQ_ACK_OUT", sep);
1317 seq_puts(m, "Flags:");
1319 if (tty_port_cts_enabled(&self->port)) {
1320 seq_printf(m, "%cASYNC_CTS_FLOW", sep);
1323 if (self->port.flags & ASYNC_CHECK_CD) {
1324 seq_printf(m, "%cASYNC_CHECK_CD", sep);
1327 if (self->port.flags & ASYNC_INITIALIZED) {
1328 seq_printf(m, "%cASYNC_INITIALIZED", sep);
1331 if (self->port.flags & ASYNC_LOW_LATENCY) {
1332 seq_printf(m, "%cASYNC_LOW_LATENCY", sep);
1335 if (self->port.flags & ASYNC_CLOSING) {
1336 seq_printf(m, "%cASYNC_CLOSING", sep);
1339 if (self->port.flags & ASYNC_NORMAL_ACTIVE) {
1340 seq_printf(m, "%cASYNC_NORMAL_ACTIVE", sep);
1345 seq_printf(m, "Role: %s\n", self->client ? "client" : "server");
1346 seq_printf(m, "Open count: %d\n", self->port.count);
1347 seq_printf(m, "Max data size: %d\n", self->max_data_size);
1348 seq_printf(m, "Max header size: %d\n", self->max_header_size);
1350 tty = tty_port_tty_get(&self->port);
1352 seq_printf(m, "Hardware: %s\n",
1353 tty->hw_stopped ? "Stopped" : "Running");
1358 static int ircomm_tty_proc_show(struct seq_file *m, void *v)
1360 struct ircomm_tty_cb *self;
1361 unsigned long flags;
1363 spin_lock_irqsave(&ircomm_tty->hb_spinlock, flags);
1365 self = (struct ircomm_tty_cb *) hashbin_get_first(ircomm_tty);
1366 while (self != NULL) {
1367 if (self->magic != IRCOMM_TTY_MAGIC)
1370 ircomm_tty_line_info(self, m);
1371 self = (struct ircomm_tty_cb *) hashbin_get_next(ircomm_tty);
1373 spin_unlock_irqrestore(&ircomm_tty->hb_spinlock, flags);
1377 static int ircomm_tty_proc_open(struct inode *inode, struct file *file)
1379 return single_open(file, ircomm_tty_proc_show, NULL);
1382 static const struct file_operations ircomm_tty_proc_fops = {
1383 .owner = THIS_MODULE,
1384 .open = ircomm_tty_proc_open,
1386 .llseek = seq_lseek,
1387 .release = single_release,
1389 #endif /* CONFIG_PROC_FS */
1391 MODULE_AUTHOR("Dag Brattli <dagb@cs.uit.no>");
1392 MODULE_DESCRIPTION("IrCOMM serial TTY driver");
1393 MODULE_LICENSE("GPL");
1394 MODULE_ALIAS_CHARDEV_MAJOR(IRCOMM_TTY_MAJOR);
1396 module_init(ircomm_tty_init);
1397 module_exit(ircomm_tty_cleanup);