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 (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))
320 spin_unlock_irqrestore(&port->lock, flags);
321 port->blocked_open++;
324 if (tty->termios.c_cflag & CBAUD)
325 tty_port_raise_dtr_rts(port);
327 current->state = TASK_INTERRUPTIBLE;
329 if (tty_hung_up_p(filp) ||
330 !test_bit(ASYNCB_INITIALIZED, &port->flags)) {
331 retval = (port->flags & ASYNC_HUP_NOTIFY) ?
332 -EAGAIN : -ERESTARTSYS;
337 * Check if link is ready now. Even if CLOCAL is
338 * specified, we cannot return before the IrCOMM link is
341 if (!test_bit(ASYNCB_CLOSING, &port->flags) &&
342 (do_clocal || tty_port_carrier_raised(port)) &&
343 self->state == IRCOMM_TTY_READY)
348 if (signal_pending(current)) {
349 retval = -ERESTARTSYS;
353 IRDA_DEBUG(1, "%s(%d):block_til_ready blocking on %s open_count=%d\n",
354 __FILE__, __LINE__, tty->driver->name, port->count);
359 __set_current_state(TASK_RUNNING);
360 remove_wait_queue(&port->open_wait, &wait);
362 spin_lock_irqsave(&port->lock, flags);
363 if (!tty_hung_up_p(filp))
365 spin_unlock_irqrestore(&port->lock, flags);
366 port->blocked_open--;
368 IRDA_DEBUG(1, "%s(%d):block_til_ready after blocking on %s open_count=%d\n",
369 __FILE__, __LINE__, tty->driver->name, port->count);
372 port->flags |= ASYNC_NORMAL_ACTIVE;
378 static int ircomm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
380 struct ircomm_tty_cb *self;
381 unsigned int line = tty->index;
383 /* Check if instance already exists */
384 self = hashbin_lock_find(ircomm_tty, line, NULL);
386 /* No, so make new instance */
387 self = kzalloc(sizeof(struct ircomm_tty_cb), GFP_KERNEL);
389 IRDA_ERROR("%s(), kmalloc failed!\n", __func__);
393 tty_port_init(&self->port);
394 self->port.ops = &ircomm_port_ops;
395 self->magic = IRCOMM_TTY_MAGIC;
396 self->flow = FLOW_STOP;
399 INIT_WORK(&self->tqueue, ircomm_tty_do_softint);
400 self->max_header_size = IRCOMM_TTY_HDR_UNINITIALISED;
401 self->max_data_size = IRCOMM_TTY_DATA_UNINITIALISED;
403 /* Init some important stuff */
404 init_timer(&self->watchdog_timer);
405 spin_lock_init(&self->spinlock);
408 * Force TTY into raw mode by default which is usually what
409 * we want for IrCOMM and IrLPT. This way applications will
410 * not have to twiddle with printcap etc.
412 * Note this is completely usafe and doesn't work properly
414 tty->termios.c_iflag = 0;
415 tty->termios.c_oflag = 0;
417 /* Insert into hash */
418 hashbin_insert(ircomm_tty, (irda_queue_t *) self, line, NULL);
421 tty->driver_data = self;
423 return tty_port_install(&self->port, driver, tty);
427 * Function ircomm_tty_open (tty, filp)
429 * This routine is called when a particular tty device is opened. This
430 * routine is mandatory; if this routine is not filled in, the attempted
431 * open will fail with ENODEV.
433 static int ircomm_tty_open(struct tty_struct *tty, struct file *filp)
435 struct ircomm_tty_cb *self = tty->driver_data;
439 IRDA_DEBUG(2, "%s()\n", __func__ );
441 /* ++ is not atomic, so this should be protected - Jean II */
442 spin_lock_irqsave(&self->port.lock, flags);
444 spin_unlock_irqrestore(&self->port.lock, flags);
445 tty_port_tty_set(&self->port, tty);
447 IRDA_DEBUG(1, "%s(), %s%d, count = %d\n", __func__ , tty->driver->name,
448 self->line, self->port.count);
450 /* Not really used by us, but lets do it anyway */
451 self->port.low_latency = (self->port.flags & ASYNC_LOW_LATENCY) ? 1 : 0;
454 * If the port is the middle of closing, bail out now
456 if (tty_hung_up_p(filp) ||
457 test_bit(ASYNCB_CLOSING, &self->port.flags)) {
459 /* Hm, why are we blocking on ASYNC_CLOSING if we
460 * do return -EAGAIN/-ERESTARTSYS below anyway?
461 * IMHO it's either not needed in the first place
462 * or for some reason we need to make sure the async
463 * closing has been finished - if so, wouldn't we
464 * probably better sleep uninterruptible?
467 if (wait_event_interruptible(self->port.close_wait,
468 !test_bit(ASYNCB_CLOSING, &self->port.flags))) {
469 IRDA_WARNING("%s - got signal while blocking on ASYNC_CLOSING!\n",
474 #ifdef SERIAL_DO_RESTART
475 return (self->port.flags & ASYNC_HUP_NOTIFY) ?
476 -EAGAIN : -ERESTARTSYS;
482 /* Check if this is a "normal" ircomm device, or an irlpt device */
483 if (self->line < 0x10) {
484 self->service_type = IRCOMM_3_WIRE | IRCOMM_9_WIRE;
485 self->settings.service_type = IRCOMM_9_WIRE; /* 9 wire as default */
486 /* Jan Kiszka -> add DSR/RI -> Conform to IrCOMM spec */
487 self->settings.dce = IRCOMM_CTS | IRCOMM_CD | IRCOMM_DSR | IRCOMM_RI; /* Default line settings */
488 IRDA_DEBUG(2, "%s(), IrCOMM device\n", __func__ );
490 IRDA_DEBUG(2, "%s(), IrLPT device\n", __func__ );
491 self->service_type = IRCOMM_3_WIRE_RAW;
492 self->settings.service_type = IRCOMM_3_WIRE_RAW; /* Default */
495 ret = ircomm_tty_startup(self);
499 ret = ircomm_tty_block_til_ready(self, tty, filp);
502 "%s(), returning after block_til_ready with %d\n", __func__ ,
511 * Function ircomm_tty_close (tty, filp)
513 * This routine is called when a particular tty device is closed.
516 static void ircomm_tty_close(struct tty_struct *tty, struct file *filp)
518 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
519 struct tty_port *port = &self->port;
521 IRDA_DEBUG(0, "%s()\n", __func__ );
523 IRDA_ASSERT(self != NULL, return;);
524 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
526 if (tty_port_close_start(port, tty, filp) == 0)
529 ircomm_tty_shutdown(self);
531 tty_driver_flush_buffer(tty);
533 tty_port_close_end(port, tty);
534 tty_port_tty_set(port, NULL);
538 * Function ircomm_tty_flush_buffer (tty)
543 static void ircomm_tty_flush_buffer(struct tty_struct *tty)
545 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
547 IRDA_ASSERT(self != NULL, return;);
548 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
551 * Let do_softint() do this to avoid race condition with
554 schedule_work(&self->tqueue);
558 * Function ircomm_tty_do_softint (work)
560 * We use this routine to give the write wakeup to the user at at a
561 * safe time (as fast as possible after write have completed). This
562 * can be compared to the Tx interrupt.
564 static void ircomm_tty_do_softint(struct work_struct *work)
566 struct ircomm_tty_cb *self =
567 container_of(work, struct ircomm_tty_cb, tqueue);
568 struct tty_struct *tty;
570 struct sk_buff *skb, *ctrl_skb;
572 IRDA_DEBUG(2, "%s()\n", __func__ );
574 if (!self || self->magic != IRCOMM_TTY_MAGIC)
577 tty = tty_port_tty_get(&self->port);
581 /* Unlink control buffer */
582 spin_lock_irqsave(&self->spinlock, flags);
584 ctrl_skb = self->ctrl_skb;
585 self->ctrl_skb = NULL;
587 spin_unlock_irqrestore(&self->spinlock, flags);
589 /* Flush control buffer if any */
591 if(self->flow == FLOW_START)
592 ircomm_control_request(self->ircomm, ctrl_skb);
593 /* Drop reference count - see ircomm_ttp_data_request(). */
594 dev_kfree_skb(ctrl_skb);
600 /* Unlink transmit buffer */
601 spin_lock_irqsave(&self->spinlock, flags);
606 spin_unlock_irqrestore(&self->spinlock, flags);
608 /* Flush transmit buffer if any */
610 ircomm_tty_do_event(self, IRCOMM_TTY_DATA_REQUEST, skb, NULL);
611 /* Drop reference count - see ircomm_ttp_data_request(). */
615 /* Check if user (still) wants to be waken up */
622 * Function ircomm_tty_write (tty, buf, count)
624 * This routine is called by the kernel to write a series of characters
625 * to the tty device. The characters may come from user space or kernel
626 * space. This routine will return the number of characters actually
627 * accepted for writing. This routine is mandatory.
629 static int ircomm_tty_write(struct tty_struct *tty,
630 const unsigned char *buf, int count)
632 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
639 IRDA_DEBUG(2, "%s(), count=%d, hw_stopped=%d\n", __func__ , count,
642 IRDA_ASSERT(self != NULL, return -1;);
643 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
645 /* We may receive packets from the TTY even before we have finished
646 * our setup. Not cool.
647 * The problem is that we don't know the final header and data size
648 * to create the proper skb, so any skb we would create would have
649 * bogus header and data size, so need care.
650 * We use a bogus header size to safely detect this condition.
651 * Another problem is that hw_stopped was set to 0 way before it
652 * should be, so we would drop this skb. It should now be fixed.
653 * One option is to not accept data until we are properly setup.
654 * But, I suspect that when it happens, the ppp line discipline
655 * just "drops" the data, which might screw up connect scripts.
656 * The second option is to create a "safe skb", with large header
657 * and small size (see ircomm_tty_open() for values).
658 * We just need to make sure that when the real values get filled,
659 * we don't mess up the original "safe skb" (see tx_data_size).
661 if (self->max_header_size == IRCOMM_TTY_HDR_UNINITIALISED) {
662 IRDA_DEBUG(1, "%s() : not initialised\n", __func__);
663 #ifdef IRCOMM_NO_TX_BEFORE_INIT
664 /* We didn't consume anything, TTY will retry */
672 /* Protect our manipulation of self->tx_skb and related */
673 spin_lock_irqsave(&self->spinlock, flags);
675 /* Fetch current transmit buffer */
679 * Send out all the data we get, possibly as multiple fragmented
680 * frames, but this will only happen if the data is larger than the
681 * max data size. The normal case however is just the opposite, and
682 * this function may be called multiple times, and will then actually
683 * defragment the data and send it out as one packet as soon as
684 * possible, but at a safer point in time
689 /* Adjust data size to the max data size */
690 if (size > self->max_data_size)
691 size = self->max_data_size;
694 * Do we already have a buffer ready for transmit, or do
695 * we need to allocate a new frame
699 * Any room for more data at the end of the current
700 * transmit buffer? Cannot use skb_tailroom, since
701 * dev_alloc_skb gives us a larger skb than we
703 * Note : use tx_data_size, because max_data_size
704 * may have changed and we don't want to overwrite
707 if ((tailroom = (self->tx_data_size - skb->len)) > 0) {
708 /* Adjust data to tailroom */
713 * Current transmit frame is full, so break
714 * out, so we can send it as soon as possible
719 /* Prepare a full sized frame */
720 skb = alloc_skb(self->max_data_size+
721 self->max_header_size,
724 spin_unlock_irqrestore(&self->spinlock, flags);
727 skb_reserve(skb, self->max_header_size);
729 /* Remember skb size because max_data_size may
730 * change later on - Jean II */
731 self->tx_data_size = self->max_data_size;
735 memcpy(skb_put(skb,size), buf + len, size);
741 spin_unlock_irqrestore(&self->spinlock, flags);
744 * Schedule a new thread which will transmit the frame as soon
745 * as possible, but at a safe point in time. We do this so the
746 * "user" can give us data multiple times, as PPP does (because of
747 * its 256 byte tx buffer). We will then defragment and send out
748 * all this data as one single packet.
750 schedule_work(&self->tqueue);
756 * Function ircomm_tty_write_room (tty)
758 * This routine returns the numbers of characters the tty driver will
759 * accept for queuing to be written. This number is subject to change as
760 * output buffers get emptied, or if the output flow control is acted.
762 static int ircomm_tty_write_room(struct tty_struct *tty)
764 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
768 IRDA_ASSERT(self != NULL, return -1;);
769 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
771 #ifdef IRCOMM_NO_TX_BEFORE_INIT
772 /* max_header_size tells us if the channel is initialised or not. */
773 if (self->max_header_size == IRCOMM_TTY_HDR_UNINITIALISED)
774 /* Don't bother us yet */
778 /* Check if we are allowed to transmit any data.
779 * hw_stopped is the regular flow control.
784 spin_lock_irqsave(&self->spinlock, flags);
786 ret = self->tx_data_size - self->tx_skb->len;
788 ret = self->max_data_size;
789 spin_unlock_irqrestore(&self->spinlock, flags);
791 IRDA_DEBUG(2, "%s(), ret=%d\n", __func__ , ret);
797 * Function ircomm_tty_wait_until_sent (tty, timeout)
799 * This routine waits until the device has written out all of the
800 * characters in its transmitter FIFO.
802 static void ircomm_tty_wait_until_sent(struct tty_struct *tty, int timeout)
804 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
805 unsigned long orig_jiffies, poll_time;
808 IRDA_DEBUG(2, "%s()\n", __func__ );
810 IRDA_ASSERT(self != NULL, return;);
811 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
813 orig_jiffies = jiffies;
815 /* Set poll time to 200 ms */
816 poll_time = IRDA_MIN(timeout, msecs_to_jiffies(200));
818 spin_lock_irqsave(&self->spinlock, flags);
819 while (self->tx_skb && self->tx_skb->len) {
820 spin_unlock_irqrestore(&self->spinlock, flags);
821 schedule_timeout_interruptible(poll_time);
822 spin_lock_irqsave(&self->spinlock, flags);
823 if (signal_pending(current))
825 if (timeout && time_after(jiffies, orig_jiffies + timeout))
828 spin_unlock_irqrestore(&self->spinlock, flags);
829 current->state = TASK_RUNNING;
833 * Function ircomm_tty_throttle (tty)
835 * This routine notifies the tty driver that input buffers for the line
836 * discipline are close to full, and it should somehow signal that no
837 * more characters should be sent to the tty.
839 static void ircomm_tty_throttle(struct tty_struct *tty)
841 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
843 IRDA_DEBUG(2, "%s()\n", __func__ );
845 IRDA_ASSERT(self != NULL, return;);
846 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
848 /* Software flow control? */
850 ircomm_tty_send_xchar(tty, STOP_CHAR(tty));
852 /* Hardware flow control? */
853 if (tty->termios.c_cflag & CRTSCTS) {
854 self->settings.dte &= ~IRCOMM_RTS;
855 self->settings.dte |= IRCOMM_DELTA_RTS;
857 ircomm_param_request(self, IRCOMM_DTE, TRUE);
860 ircomm_flow_request(self->ircomm, FLOW_STOP);
864 * Function ircomm_tty_unthrottle (tty)
866 * This routine notifies the tty drivers that it should signals that
867 * characters can now be sent to the tty without fear of overrunning the
868 * input buffers of the line disciplines.
870 static void ircomm_tty_unthrottle(struct tty_struct *tty)
872 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
874 IRDA_DEBUG(2, "%s()\n", __func__ );
876 IRDA_ASSERT(self != NULL, return;);
877 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
879 /* Using software flow control? */
881 ircomm_tty_send_xchar(tty, START_CHAR(tty));
884 /* Using hardware flow control? */
885 if (tty->termios.c_cflag & CRTSCTS) {
886 self->settings.dte |= (IRCOMM_RTS|IRCOMM_DELTA_RTS);
888 ircomm_param_request(self, IRCOMM_DTE, TRUE);
889 IRDA_DEBUG(1, "%s(), FLOW_START\n", __func__ );
891 ircomm_flow_request(self->ircomm, FLOW_START);
895 * Function ircomm_tty_chars_in_buffer (tty)
897 * Indicates if there are any data in the buffer
900 static int ircomm_tty_chars_in_buffer(struct tty_struct *tty)
902 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
906 IRDA_ASSERT(self != NULL, return -1;);
907 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
909 spin_lock_irqsave(&self->spinlock, flags);
912 len = self->tx_skb->len;
914 spin_unlock_irqrestore(&self->spinlock, flags);
919 static void ircomm_tty_shutdown(struct ircomm_tty_cb *self)
923 IRDA_ASSERT(self != NULL, return;);
924 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
926 IRDA_DEBUG(0, "%s()\n", __func__ );
928 if (!test_and_clear_bit(ASYNCB_INITIALIZED, &self->port.flags))
931 ircomm_tty_detach_cable(self);
933 spin_lock_irqsave(&self->spinlock, flags);
935 del_timer(&self->watchdog_timer);
937 /* Free parameter buffer */
938 if (self->ctrl_skb) {
939 dev_kfree_skb(self->ctrl_skb);
940 self->ctrl_skb = NULL;
943 /* Free transmit buffer */
945 dev_kfree_skb(self->tx_skb);
950 ircomm_close(self->ircomm);
954 spin_unlock_irqrestore(&self->spinlock, flags);
958 * Function ircomm_tty_hangup (tty)
960 * This routine notifies the tty driver that it should hangup the tty
964 static void ircomm_tty_hangup(struct tty_struct *tty)
966 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
967 struct tty_port *port = &self->port;
970 IRDA_DEBUG(0, "%s()\n", __func__ );
972 IRDA_ASSERT(self != NULL, return;);
973 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
975 /* ircomm_tty_flush_buffer(tty); */
976 ircomm_tty_shutdown(self);
978 spin_lock_irqsave(&port->lock, flags);
979 port->flags &= ~ASYNC_NORMAL_ACTIVE;
981 set_bit(TTY_IO_ERROR, &port->tty->flags);
982 tty_kref_put(port->tty);
986 spin_unlock_irqrestore(&port->lock, flags);
988 wake_up_interruptible(&port->open_wait);
992 * Function ircomm_tty_send_xchar (tty, ch)
994 * This routine is used to send a high-priority XON/XOFF character to
997 static void ircomm_tty_send_xchar(struct tty_struct *tty, char ch)
999 IRDA_DEBUG(0, "%s(), not impl\n", __func__ );
1003 * Function ircomm_tty_start (tty)
1005 * This routine notifies the tty driver that it resume sending
1006 * characters to the tty device.
1008 void ircomm_tty_start(struct tty_struct *tty)
1010 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
1012 ircomm_flow_request(self->ircomm, FLOW_START);
1016 * Function ircomm_tty_stop (tty)
1018 * This routine notifies the tty driver that it should stop outputting
1019 * characters to the tty device.
1021 static void ircomm_tty_stop(struct tty_struct *tty)
1023 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
1025 IRDA_ASSERT(self != NULL, return;);
1026 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1028 ircomm_flow_request(self->ircomm, FLOW_STOP);
1032 * Function ircomm_check_modem_status (self)
1034 * Check for any changes in the DCE's line settings. This function should
1035 * be called whenever the dce parameter settings changes, to update the
1036 * flow control settings and other things
1038 void ircomm_tty_check_modem_status(struct ircomm_tty_cb *self)
1040 struct tty_struct *tty;
1043 IRDA_DEBUG(0, "%s()\n", __func__ );
1045 IRDA_ASSERT(self != NULL, return;);
1046 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1048 tty = tty_port_tty_get(&self->port);
1050 status = self->settings.dce;
1052 if (status & IRCOMM_DCE_DELTA_ANY) {
1053 /*wake_up_interruptible(&self->delta_msr_wait);*/
1055 if ((self->port.flags & ASYNC_CHECK_CD) && (status & IRCOMM_DELTA_CD)) {
1057 "%s(), ircomm%d CD now %s...\n", __func__ , self->line,
1058 (status & IRCOMM_CD) ? "on" : "off");
1060 if (status & IRCOMM_CD) {
1061 wake_up_interruptible(&self->port.open_wait);
1064 "%s(), Doing serial hangup..\n", __func__ );
1068 /* Hangup will remote the tty, so better break out */
1072 if (tty && tty_port_cts_enabled(&self->port)) {
1073 if (tty->hw_stopped) {
1074 if (status & IRCOMM_CTS) {
1076 "%s(), CTS tx start...\n", __func__ );
1077 tty->hw_stopped = 0;
1079 /* Wake up processes blocked on open */
1080 wake_up_interruptible(&self->port.open_wait);
1082 schedule_work(&self->tqueue);
1086 if (!(status & IRCOMM_CTS)) {
1088 "%s(), CTS tx stop...\n", __func__ );
1089 tty->hw_stopped = 1;
1098 * Function ircomm_tty_data_indication (instance, sap, skb)
1100 * Handle incoming data, and deliver it to the line discipline
1103 static int ircomm_tty_data_indication(void *instance, void *sap,
1104 struct sk_buff *skb)
1106 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1107 struct tty_struct *tty;
1109 IRDA_DEBUG(2, "%s()\n", __func__ );
1111 IRDA_ASSERT(self != NULL, return -1;);
1112 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
1113 IRDA_ASSERT(skb != NULL, return -1;);
1115 tty = tty_port_tty_get(&self->port);
1117 IRDA_DEBUG(0, "%s(), no tty!\n", __func__ );
1122 * If we receive data when hardware is stopped then something is wrong.
1123 * We try to poll the peers line settings to check if we are up todate.
1124 * Devices like WinCE can do this, and since they don't send any
1125 * params, we can just as well declare the hardware for running.
1127 if (tty->hw_stopped && (self->flow == FLOW_START)) {
1128 IRDA_DEBUG(0, "%s(), polling for line settings!\n", __func__ );
1129 ircomm_param_request(self, IRCOMM_POLL, TRUE);
1131 /* We can just as well declare the hardware for running */
1132 ircomm_tty_send_initial_parameters(self);
1133 ircomm_tty_link_established(self);
1138 * Use flip buffer functions since the code may be called from interrupt
1141 tty_insert_flip_string(&self->port, skb->data, skb->len);
1142 tty_flip_buffer_push(&self->port);
1144 /* No need to kfree_skb - see ircomm_ttp_data_indication() */
1150 * Function ircomm_tty_control_indication (instance, sap, skb)
1152 * Parse all incoming parameters (easy!)
1155 static int ircomm_tty_control_indication(void *instance, void *sap,
1156 struct sk_buff *skb)
1158 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1161 IRDA_DEBUG(4, "%s()\n", __func__ );
1163 IRDA_ASSERT(self != NULL, return -1;);
1164 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
1165 IRDA_ASSERT(skb != NULL, return -1;);
1167 clen = skb->data[0];
1169 irda_param_extract_all(self, skb->data+1, IRDA_MIN(skb->len-1, clen),
1170 &ircomm_param_info);
1172 /* No need to kfree_skb - see ircomm_control_indication() */
1178 * Function ircomm_tty_flow_indication (instance, sap, cmd)
1180 * This function is called by IrTTP when it wants us to slow down the
1181 * transmission of data. We just mark the hardware as stopped, and wait
1182 * for IrTTP to notify us that things are OK again.
1184 static void ircomm_tty_flow_indication(void *instance, void *sap,
1187 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1188 struct tty_struct *tty;
1190 IRDA_ASSERT(self != NULL, return;);
1191 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1193 tty = tty_port_tty_get(&self->port);
1197 IRDA_DEBUG(2, "%s(), hw start!\n", __func__ );
1199 tty->hw_stopped = 0;
1201 /* ircomm_tty_do_softint will take care of the rest */
1202 schedule_work(&self->tqueue);
1204 default: /* If we get here, something is very wrong, better stop */
1206 IRDA_DEBUG(2, "%s(), hw stopped!\n", __func__ );
1208 tty->hw_stopped = 1;
1216 #ifdef CONFIG_PROC_FS
1217 static void ircomm_tty_line_info(struct ircomm_tty_cb *self, struct seq_file *m)
1219 struct tty_struct *tty;
1222 seq_printf(m, "State: %s\n", ircomm_tty_state[self->state]);
1224 seq_puts(m, "Service type: ");
1225 if (self->service_type & IRCOMM_9_WIRE)
1226 seq_puts(m, "9_WIRE");
1227 else if (self->service_type & IRCOMM_3_WIRE)
1228 seq_puts(m, "3_WIRE");
1229 else if (self->service_type & IRCOMM_3_WIRE_RAW)
1230 seq_puts(m, "3_WIRE_RAW");
1232 seq_puts(m, "No common service type!\n");
1235 seq_printf(m, "Port name: %s\n", self->settings.port_name);
1237 seq_printf(m, "DTE status:");
1239 if (self->settings.dte & IRCOMM_RTS) {
1240 seq_printf(m, "%cRTS", sep);
1243 if (self->settings.dte & IRCOMM_DTR) {
1244 seq_printf(m, "%cDTR", sep);
1249 seq_puts(m, "DCE status:");
1251 if (self->settings.dce & IRCOMM_CTS) {
1252 seq_printf(m, "%cCTS", sep);
1255 if (self->settings.dce & IRCOMM_DSR) {
1256 seq_printf(m, "%cDSR", sep);
1259 if (self->settings.dce & IRCOMM_CD) {
1260 seq_printf(m, "%cCD", sep);
1263 if (self->settings.dce & IRCOMM_RI) {
1264 seq_printf(m, "%cRI", sep);
1269 seq_puts(m, "Configuration: ");
1270 if (!self->settings.null_modem)
1271 seq_puts(m, "DTE <-> DCE\n");
1273 seq_puts(m, "DTE <-> DTE (null modem emulation)\n");
1275 seq_printf(m, "Data rate: %d\n", self->settings.data_rate);
1277 seq_puts(m, "Flow control:");
1279 if (self->settings.flow_control & IRCOMM_XON_XOFF_IN) {
1280 seq_printf(m, "%cXON_XOFF_IN", sep);
1283 if (self->settings.flow_control & IRCOMM_XON_XOFF_OUT) {
1284 seq_printf(m, "%cXON_XOFF_OUT", sep);
1287 if (self->settings.flow_control & IRCOMM_RTS_CTS_IN) {
1288 seq_printf(m, "%cRTS_CTS_IN", sep);
1291 if (self->settings.flow_control & IRCOMM_RTS_CTS_OUT) {
1292 seq_printf(m, "%cRTS_CTS_OUT", sep);
1295 if (self->settings.flow_control & IRCOMM_DSR_DTR_IN) {
1296 seq_printf(m, "%cDSR_DTR_IN", sep);
1299 if (self->settings.flow_control & IRCOMM_DSR_DTR_OUT) {
1300 seq_printf(m, "%cDSR_DTR_OUT", sep);
1303 if (self->settings.flow_control & IRCOMM_ENQ_ACK_IN) {
1304 seq_printf(m, "%cENQ_ACK_IN", sep);
1307 if (self->settings.flow_control & IRCOMM_ENQ_ACK_OUT) {
1308 seq_printf(m, "%cENQ_ACK_OUT", sep);
1313 seq_puts(m, "Flags:");
1315 if (tty_port_cts_enabled(&self->port)) {
1316 seq_printf(m, "%cASYNC_CTS_FLOW", sep);
1319 if (self->port.flags & ASYNC_CHECK_CD) {
1320 seq_printf(m, "%cASYNC_CHECK_CD", sep);
1323 if (self->port.flags & ASYNC_INITIALIZED) {
1324 seq_printf(m, "%cASYNC_INITIALIZED", sep);
1327 if (self->port.flags & ASYNC_LOW_LATENCY) {
1328 seq_printf(m, "%cASYNC_LOW_LATENCY", sep);
1331 if (self->port.flags & ASYNC_CLOSING) {
1332 seq_printf(m, "%cASYNC_CLOSING", sep);
1335 if (self->port.flags & ASYNC_NORMAL_ACTIVE) {
1336 seq_printf(m, "%cASYNC_NORMAL_ACTIVE", sep);
1341 seq_printf(m, "Role: %s\n", self->client ? "client" : "server");
1342 seq_printf(m, "Open count: %d\n", self->port.count);
1343 seq_printf(m, "Max data size: %d\n", self->max_data_size);
1344 seq_printf(m, "Max header size: %d\n", self->max_header_size);
1346 tty = tty_port_tty_get(&self->port);
1348 seq_printf(m, "Hardware: %s\n",
1349 tty->hw_stopped ? "Stopped" : "Running");
1354 static int ircomm_tty_proc_show(struct seq_file *m, void *v)
1356 struct ircomm_tty_cb *self;
1357 unsigned long flags;
1359 spin_lock_irqsave(&ircomm_tty->hb_spinlock, flags);
1361 self = (struct ircomm_tty_cb *) hashbin_get_first(ircomm_tty);
1362 while (self != NULL) {
1363 if (self->magic != IRCOMM_TTY_MAGIC)
1366 ircomm_tty_line_info(self, m);
1367 self = (struct ircomm_tty_cb *) hashbin_get_next(ircomm_tty);
1369 spin_unlock_irqrestore(&ircomm_tty->hb_spinlock, flags);
1373 static int ircomm_tty_proc_open(struct inode *inode, struct file *file)
1375 return single_open(file, ircomm_tty_proc_show, NULL);
1378 static const struct file_operations ircomm_tty_proc_fops = {
1379 .owner = THIS_MODULE,
1380 .open = ircomm_tty_proc_open,
1382 .llseek = seq_lseek,
1383 .release = single_release,
1385 #endif /* CONFIG_PROC_FS */
1387 MODULE_AUTHOR("Dag Brattli <dagb@cs.uit.no>");
1388 MODULE_DESCRIPTION("IrCOMM serial TTY driver");
1389 MODULE_LICENSE("GPL");
1390 MODULE_ALIAS_CHARDEV_MAJOR(IRCOMM_TTY_MAJOR);
1392 module_init(ircomm_tty_init);
1393 module_exit(ircomm_tty_cleanup);