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/sched.h>
37 #include <linux/seq_file.h>
38 #include <linux/termios.h>
39 #include <linux/tty.h>
40 #include <linux/interrupt.h>
41 #include <linux/device.h> /* for MODULE_ALIAS_CHARDEV_MAJOR */
43 #include <asm/uaccess.h>
45 #include <net/irda/irda.h>
46 #include <net/irda/irmod.h>
48 #include <net/irda/ircomm_core.h>
49 #include <net/irda/ircomm_param.h>
50 #include <net/irda/ircomm_tty_attach.h>
51 #include <net/irda/ircomm_tty.h>
53 static int ircomm_tty_open(struct tty_struct *tty, struct file *filp);
54 static void ircomm_tty_close(struct tty_struct * tty, struct file *filp);
55 static int ircomm_tty_write(struct tty_struct * tty,
56 const unsigned char *buf, int count);
57 static int ircomm_tty_write_room(struct tty_struct *tty);
58 static void ircomm_tty_throttle(struct tty_struct *tty);
59 static void ircomm_tty_unthrottle(struct tty_struct *tty);
60 static int ircomm_tty_chars_in_buffer(struct tty_struct *tty);
61 static void ircomm_tty_flush_buffer(struct tty_struct *tty);
62 static void ircomm_tty_send_xchar(struct tty_struct *tty, char ch);
63 static void ircomm_tty_wait_until_sent(struct tty_struct *tty, int timeout);
64 static void ircomm_tty_hangup(struct tty_struct *tty);
65 static void ircomm_tty_do_softint(struct work_struct *work);
66 static void ircomm_tty_shutdown(struct ircomm_tty_cb *self);
67 static void ircomm_tty_stop(struct tty_struct *tty);
69 static int ircomm_tty_data_indication(void *instance, void *sap,
71 static int ircomm_tty_control_indication(void *instance, void *sap,
73 static void ircomm_tty_flow_indication(void *instance, void *sap,
76 static const struct file_operations ircomm_tty_proc_fops;
77 #endif /* CONFIG_PROC_FS */
78 static struct tty_driver *driver;
80 static hashbin_t *ircomm_tty = NULL;
82 static const struct tty_operations ops = {
83 .open = ircomm_tty_open,
84 .close = ircomm_tty_close,
85 .write = ircomm_tty_write,
86 .write_room = ircomm_tty_write_room,
87 .chars_in_buffer = ircomm_tty_chars_in_buffer,
88 .flush_buffer = ircomm_tty_flush_buffer,
89 .ioctl = ircomm_tty_ioctl, /* ircomm_tty_ioctl.c */
90 .tiocmget = ircomm_tty_tiocmget, /* ircomm_tty_ioctl.c */
91 .tiocmset = ircomm_tty_tiocmset, /* ircomm_tty_ioctl.c */
92 .throttle = ircomm_tty_throttle,
93 .unthrottle = ircomm_tty_unthrottle,
94 .send_xchar = ircomm_tty_send_xchar,
95 .set_termios = ircomm_tty_set_termios,
96 .stop = ircomm_tty_stop,
97 .start = ircomm_tty_start,
98 .hangup = ircomm_tty_hangup,
99 .wait_until_sent = ircomm_tty_wait_until_sent,
100 #ifdef CONFIG_PROC_FS
101 .proc_fops = &ircomm_tty_proc_fops,
102 #endif /* CONFIG_PROC_FS */
106 * Function ircomm_tty_init()
108 * Init IrCOMM TTY layer/driver
111 static int __init ircomm_tty_init(void)
113 driver = alloc_tty_driver(IRCOMM_TTY_PORTS);
116 ircomm_tty = hashbin_new(HB_LOCK);
117 if (ircomm_tty == NULL) {
118 IRDA_ERROR("%s(), can't allocate hashbin!\n", __func__);
119 put_tty_driver(driver);
123 driver->owner = THIS_MODULE;
124 driver->driver_name = "ircomm";
125 driver->name = "ircomm";
126 driver->major = IRCOMM_TTY_MAJOR;
127 driver->minor_start = IRCOMM_TTY_MINOR;
128 driver->type = TTY_DRIVER_TYPE_SERIAL;
129 driver->subtype = SERIAL_TYPE_NORMAL;
130 driver->init_termios = tty_std_termios;
131 driver->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
132 driver->flags = TTY_DRIVER_REAL_RAW;
133 tty_set_operations(driver, &ops);
134 if (tty_register_driver(driver)) {
135 IRDA_ERROR("%s(): Couldn't register serial driver\n",
137 put_tty_driver(driver);
143 static void __exit __ircomm_tty_cleanup(struct ircomm_tty_cb *self)
145 IRDA_DEBUG(0, "%s()\n", __func__ );
147 IRDA_ASSERT(self != NULL, return;);
148 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
150 ircomm_tty_shutdown(self);
157 * Function ircomm_tty_cleanup ()
159 * Remove IrCOMM TTY layer/driver
162 static void __exit ircomm_tty_cleanup(void)
166 IRDA_DEBUG(4, "%s()\n", __func__ );
168 ret = tty_unregister_driver(driver);
170 IRDA_ERROR("%s(), failed to unregister driver\n",
175 hashbin_delete(ircomm_tty, (FREE_FUNC) __ircomm_tty_cleanup);
176 put_tty_driver(driver);
180 * Function ircomm_startup (self)
185 static int ircomm_tty_startup(struct ircomm_tty_cb *self)
190 IRDA_DEBUG(2, "%s()\n", __func__ );
192 IRDA_ASSERT(self != NULL, return -1;);
193 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
195 /* Check if already open */
196 if (test_and_set_bit(ASYNC_B_INITIALIZED, &self->flags)) {
197 IRDA_DEBUG(2, "%s(), already open so break out!\n", __func__ );
201 /* Register with IrCOMM */
202 irda_notify_init(¬ify);
203 /* These callbacks we must handle ourselves */
204 notify.data_indication = ircomm_tty_data_indication;
205 notify.udata_indication = ircomm_tty_control_indication;
206 notify.flow_indication = ircomm_tty_flow_indication;
208 /* Use the ircomm_tty interface for these ones */
209 notify.disconnect_indication = ircomm_tty_disconnect_indication;
210 notify.connect_confirm = ircomm_tty_connect_confirm;
211 notify.connect_indication = ircomm_tty_connect_indication;
212 strlcpy(notify.name, "ircomm_tty", sizeof(notify.name));
213 notify.instance = self;
216 self->ircomm = ircomm_open(¬ify, self->service_type,
222 self->slsap_sel = self->ircomm->slsap_sel;
224 /* Connect IrCOMM link with remote device */
225 ret = ircomm_tty_attach_cable(self);
227 IRDA_ERROR("%s(), error attaching cable!\n", __func__);
233 clear_bit(ASYNC_B_INITIALIZED, &self->flags);
238 * Function ircomm_block_til_ready (self, filp)
243 static int ircomm_tty_block_til_ready(struct ircomm_tty_cb *self,
246 DECLARE_WAITQUEUE(wait, current);
248 int do_clocal = 0, extra_count = 0;
250 struct tty_struct *tty;
252 IRDA_DEBUG(2, "%s()\n", __func__ );
257 * If non-blocking mode is set, or the port is not enabled,
258 * then make the check up front and then exit.
260 if (filp->f_flags & O_NONBLOCK || tty->flags & (1 << TTY_IO_ERROR)){
261 /* nonblock mode is set or port is not enabled */
262 self->flags |= ASYNC_NORMAL_ACTIVE;
263 IRDA_DEBUG(1, "%s(), O_NONBLOCK requested!\n", __func__ );
267 if (tty->termios->c_cflag & CLOCAL) {
268 IRDA_DEBUG(1, "%s(), doing CLOCAL!\n", __func__ );
272 /* Wait for carrier detect and the line to become
273 * free (i.e., not in use by the callout). While we are in
274 * this loop, self->open_count is dropped by one, so that
275 * mgsl_close() knows when to free things. We restore it upon
276 * exit, either normal or abnormal.
280 add_wait_queue(&self->open_wait, &wait);
282 IRDA_DEBUG(2, "%s(%d):block_til_ready before block on %s open_count=%d\n",
283 __FILE__,__LINE__, tty->driver->name, self->open_count );
285 /* As far as I can see, we protect open_count - Jean II */
286 spin_lock_irqsave(&self->spinlock, flags);
287 if (!tty_hung_up_p(filp)) {
291 spin_unlock_irqrestore(&self->spinlock, flags);
292 self->blocked_open++;
295 if (tty->termios->c_cflag & CBAUD) {
296 /* Here, we use to lock those two guys, but
297 * as ircomm_param_request() does it itself,
298 * I don't see the point (and I see the deadlock).
300 self->settings.dte |= IRCOMM_RTS + IRCOMM_DTR;
302 ircomm_param_request(self, IRCOMM_DTE, TRUE);
305 current->state = TASK_INTERRUPTIBLE;
307 if (tty_hung_up_p(filp) ||
308 !test_bit(ASYNC_B_INITIALIZED, &self->flags)) {
309 retval = (self->flags & ASYNC_HUP_NOTIFY) ?
310 -EAGAIN : -ERESTARTSYS;
315 * Check if link is ready now. Even if CLOCAL is
316 * specified, we cannot return before the IrCOMM link is
319 if (!test_bit(ASYNC_B_CLOSING, &self->flags) &&
320 (do_clocal || (self->settings.dce & IRCOMM_CD)) &&
321 self->state == IRCOMM_TTY_READY)
326 if (signal_pending(current)) {
327 retval = -ERESTARTSYS;
331 IRDA_DEBUG(1, "%s(%d):block_til_ready blocking on %s open_count=%d\n",
332 __FILE__,__LINE__, tty->driver->name, self->open_count );
337 __set_current_state(TASK_RUNNING);
338 remove_wait_queue(&self->open_wait, &wait);
341 /* ++ is not atomic, so this should be protected - Jean II */
342 spin_lock_irqsave(&self->spinlock, flags);
344 spin_unlock_irqrestore(&self->spinlock, flags);
346 self->blocked_open--;
348 IRDA_DEBUG(1, "%s(%d):block_til_ready after blocking on %s open_count=%d\n",
349 __FILE__,__LINE__, tty->driver->name, self->open_count);
352 self->flags |= ASYNC_NORMAL_ACTIVE;
358 * Function ircomm_tty_open (tty, filp)
360 * This routine is called when a particular tty device is opened. This
361 * routine is mandatory; if this routine is not filled in, the attempted
362 * open will fail with ENODEV.
364 static int ircomm_tty_open(struct tty_struct *tty, struct file *filp)
366 struct ircomm_tty_cb *self;
371 IRDA_DEBUG(2, "%s()\n", __func__ );
374 if (line >= IRCOMM_TTY_PORTS)
377 /* Check if instance already exists */
378 self = hashbin_lock_find(ircomm_tty, line, NULL);
380 /* No, so make new instance */
381 self = kzalloc(sizeof(struct ircomm_tty_cb), GFP_KERNEL);
383 IRDA_ERROR("%s(), kmalloc failed!\n", __func__);
387 self->magic = IRCOMM_TTY_MAGIC;
388 self->flow = FLOW_STOP;
391 INIT_WORK(&self->tqueue, ircomm_tty_do_softint);
392 self->max_header_size = IRCOMM_TTY_HDR_UNINITIALISED;
393 self->max_data_size = IRCOMM_TTY_DATA_UNINITIALISED;
394 self->close_delay = 5*HZ/10;
395 self->closing_wait = 30*HZ;
397 /* Init some important stuff */
398 init_timer(&self->watchdog_timer);
399 init_waitqueue_head(&self->open_wait);
400 init_waitqueue_head(&self->close_wait);
401 spin_lock_init(&self->spinlock);
404 * Force TTY into raw mode by default which is usually what
405 * we want for IrCOMM and IrLPT. This way applications will
406 * not have to twiddle with printcap etc.
408 * Note this is completely usafe and doesn't work properly
410 tty->termios->c_iflag = 0;
411 tty->termios->c_oflag = 0;
413 /* Insert into hash */
414 hashbin_insert(ircomm_tty, (irda_queue_t *) self, line, NULL);
416 /* ++ is not atomic, so this should be protected - Jean II */
417 spin_lock_irqsave(&self->spinlock, flags);
420 tty->driver_data = self;
422 spin_unlock_irqrestore(&self->spinlock, flags);
424 IRDA_DEBUG(1, "%s(), %s%d, count = %d\n", __func__ , tty->driver->name,
425 self->line, self->open_count);
427 /* Not really used by us, but lets do it anyway */
428 self->tty->low_latency = (self->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
431 * If the port is the middle of closing, bail out now
433 if (tty_hung_up_p(filp) ||
434 test_bit(ASYNC_B_CLOSING, &self->flags)) {
436 /* Hm, why are we blocking on ASYNC_CLOSING if we
437 * do return -EAGAIN/-ERESTARTSYS below anyway?
438 * IMHO it's either not needed in the first place
439 * or for some reason we need to make sure the async
440 * closing has been finished - if so, wouldn't we
441 * probably better sleep uninterruptible?
444 if (wait_event_interruptible(self->close_wait, !test_bit(ASYNC_B_CLOSING, &self->flags))) {
445 IRDA_WARNING("%s - got signal while blocking on ASYNC_CLOSING!\n",
450 #ifdef SERIAL_DO_RESTART
451 return ((self->flags & ASYNC_HUP_NOTIFY) ?
452 -EAGAIN : -ERESTARTSYS);
458 /* Check if this is a "normal" ircomm device, or an irlpt device */
460 self->service_type = IRCOMM_3_WIRE | IRCOMM_9_WIRE;
461 self->settings.service_type = IRCOMM_9_WIRE; /* 9 wire as default */
462 /* Jan Kiszka -> add DSR/RI -> Conform to IrCOMM spec */
463 self->settings.dce = IRCOMM_CTS | IRCOMM_CD | IRCOMM_DSR | IRCOMM_RI; /* Default line settings */
464 IRDA_DEBUG(2, "%s(), IrCOMM device\n", __func__ );
466 IRDA_DEBUG(2, "%s(), IrLPT device\n", __func__ );
467 self->service_type = IRCOMM_3_WIRE_RAW;
468 self->settings.service_type = IRCOMM_3_WIRE_RAW; /* Default */
471 ret = ircomm_tty_startup(self);
475 ret = ircomm_tty_block_til_ready(self, filp);
478 "%s(), returning after block_til_ready with %d\n", __func__ ,
487 * Function ircomm_tty_close (tty, filp)
489 * This routine is called when a particular tty device is closed.
492 static void ircomm_tty_close(struct tty_struct *tty, struct file *filp)
494 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
497 IRDA_DEBUG(0, "%s()\n", __func__ );
502 IRDA_ASSERT(self != NULL, return;);
503 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
505 spin_lock_irqsave(&self->spinlock, flags);
507 if (tty_hung_up_p(filp)) {
508 spin_unlock_irqrestore(&self->spinlock, flags);
510 IRDA_DEBUG(0, "%s(), returning 1\n", __func__ );
514 if ((tty->count == 1) && (self->open_count != 1)) {
516 * Uh, oh. tty->count is 1, which means that the tty
517 * structure will be freed. state->count should always
518 * be one in these conditions. If it's greater than
519 * one, we've got real problems, since it means the
520 * serial port won't be shutdown.
522 IRDA_DEBUG(0, "%s(), bad serial port count; "
523 "tty->count is 1, state->count is %d\n", __func__ ,
525 self->open_count = 1;
528 if (--self->open_count < 0) {
529 IRDA_ERROR("%s(), bad serial port count for ttys%d: %d\n",
530 __func__, self->line, self->open_count);
531 self->open_count = 0;
533 if (self->open_count) {
534 spin_unlock_irqrestore(&self->spinlock, flags);
536 IRDA_DEBUG(0, "%s(), open count > 0\n", __func__ );
540 /* Hum... Should be test_and_set_bit ??? - Jean II */
541 set_bit(ASYNC_B_CLOSING, &self->flags);
543 /* We need to unlock here (we were unlocking at the end of this
544 * function), because tty_wait_until_sent() may schedule.
545 * I don't know if the rest should be protected somehow,
546 * so someone should check. - Jean II */
547 spin_unlock_irqrestore(&self->spinlock, flags);
550 * Now we wait for the transmit buffer to clear; and we notify
551 * the line discipline to only process XON/XOFF characters.
554 if (self->closing_wait != ASYNC_CLOSING_WAIT_NONE)
555 tty_wait_until_sent(tty, self->closing_wait);
557 ircomm_tty_shutdown(self);
559 tty_driver_flush_buffer(tty);
560 tty_ldisc_flush(tty);
565 if (self->blocked_open) {
566 if (self->close_delay)
567 schedule_timeout_interruptible(self->close_delay);
568 wake_up_interruptible(&self->open_wait);
571 self->flags &= ~(ASYNC_NORMAL_ACTIVE|ASYNC_CLOSING);
572 wake_up_interruptible(&self->close_wait);
576 * Function ircomm_tty_flush_buffer (tty)
581 static void ircomm_tty_flush_buffer(struct tty_struct *tty)
583 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
585 IRDA_ASSERT(self != NULL, return;);
586 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
589 * Let do_softint() do this to avoid race condition with
592 schedule_work(&self->tqueue);
596 * Function ircomm_tty_do_softint (work)
598 * We use this routine to give the write wakeup to the user at at a
599 * safe time (as fast as possible after write have completed). This
600 * can be compared to the Tx interrupt.
602 static void ircomm_tty_do_softint(struct work_struct *work)
604 struct ircomm_tty_cb *self =
605 container_of(work, struct ircomm_tty_cb, tqueue);
606 struct tty_struct *tty;
608 struct sk_buff *skb, *ctrl_skb;
610 IRDA_DEBUG(2, "%s()\n", __func__ );
612 if (!self || self->magic != IRCOMM_TTY_MAGIC)
619 /* Unlink control buffer */
620 spin_lock_irqsave(&self->spinlock, flags);
622 ctrl_skb = self->ctrl_skb;
623 self->ctrl_skb = NULL;
625 spin_unlock_irqrestore(&self->spinlock, flags);
627 /* Flush control buffer if any */
629 if(self->flow == FLOW_START)
630 ircomm_control_request(self->ircomm, ctrl_skb);
631 /* Drop reference count - see ircomm_ttp_data_request(). */
632 dev_kfree_skb(ctrl_skb);
638 /* Unlink transmit buffer */
639 spin_lock_irqsave(&self->spinlock, flags);
644 spin_unlock_irqrestore(&self->spinlock, flags);
646 /* Flush transmit buffer if any */
648 ircomm_tty_do_event(self, IRCOMM_TTY_DATA_REQUEST, skb, NULL);
649 /* Drop reference count - see ircomm_ttp_data_request(). */
653 /* Check if user (still) wants to be waken up */
658 * Function ircomm_tty_write (tty, buf, count)
660 * This routine is called by the kernel to write a series of characters
661 * to the tty device. The characters may come from user space or kernel
662 * space. This routine will return the number of characters actually
663 * accepted for writing. This routine is mandatory.
665 static int ircomm_tty_write(struct tty_struct *tty,
666 const unsigned char *buf, int count)
668 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
675 IRDA_DEBUG(2, "%s(), count=%d, hw_stopped=%d\n", __func__ , count,
678 IRDA_ASSERT(self != NULL, return -1;);
679 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
681 /* We may receive packets from the TTY even before we have finished
682 * our setup. Not cool.
683 * The problem is that we don't know the final header and data size
684 * to create the proper skb, so any skb we would create would have
685 * bogus header and data size, so need care.
686 * We use a bogus header size to safely detect this condition.
687 * Another problem is that hw_stopped was set to 0 way before it
688 * should be, so we would drop this skb. It should now be fixed.
689 * One option is to not accept data until we are properly setup.
690 * But, I suspect that when it happens, the ppp line discipline
691 * just "drops" the data, which might screw up connect scripts.
692 * The second option is to create a "safe skb", with large header
693 * and small size (see ircomm_tty_open() for values).
694 * We just need to make sure that when the real values get filled,
695 * we don't mess up the original "safe skb" (see tx_data_size).
697 if (self->max_header_size == IRCOMM_TTY_HDR_UNINITIALISED) {
698 IRDA_DEBUG(1, "%s() : not initialised\n", __func__);
699 #ifdef IRCOMM_NO_TX_BEFORE_INIT
700 /* We didn't consume anything, TTY will retry */
708 /* Protect our manipulation of self->tx_skb and related */
709 spin_lock_irqsave(&self->spinlock, flags);
711 /* Fetch current transmit buffer */
715 * Send out all the data we get, possibly as multiple fragmented
716 * frames, but this will only happen if the data is larger than the
717 * max data size. The normal case however is just the opposite, and
718 * this function may be called multiple times, and will then actually
719 * defragment the data and send it out as one packet as soon as
720 * possible, but at a safer point in time
725 /* Adjust data size to the max data size */
726 if (size > self->max_data_size)
727 size = self->max_data_size;
730 * Do we already have a buffer ready for transmit, or do
731 * we need to allocate a new frame
735 * Any room for more data at the end of the current
736 * transmit buffer? Cannot use skb_tailroom, since
737 * dev_alloc_skb gives us a larger skb than we
739 * Note : use tx_data_size, because max_data_size
740 * may have changed and we don't want to overwrite
743 if ((tailroom = (self->tx_data_size - skb->len)) > 0) {
744 /* Adjust data to tailroom */
749 * Current transmit frame is full, so break
750 * out, so we can send it as soon as possible
755 /* Prepare a full sized frame */
756 skb = alloc_skb(self->max_data_size+
757 self->max_header_size,
760 spin_unlock_irqrestore(&self->spinlock, flags);
763 skb_reserve(skb, self->max_header_size);
765 /* Remember skb size because max_data_size may
766 * change later on - Jean II */
767 self->tx_data_size = self->max_data_size;
771 memcpy(skb_put(skb,size), buf + len, size);
777 spin_unlock_irqrestore(&self->spinlock, flags);
780 * Schedule a new thread which will transmit the frame as soon
781 * as possible, but at a safe point in time. We do this so the
782 * "user" can give us data multiple times, as PPP does (because of
783 * its 256 byte tx buffer). We will then defragment and send out
784 * all this data as one single packet.
786 schedule_work(&self->tqueue);
792 * Function ircomm_tty_write_room (tty)
794 * This routine returns the numbers of characters the tty driver will
795 * accept for queuing to be written. This number is subject to change as
796 * output buffers get emptied, or if the output flow control is acted.
798 static int ircomm_tty_write_room(struct tty_struct *tty)
800 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
804 IRDA_ASSERT(self != NULL, return -1;);
805 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
807 #ifdef IRCOMM_NO_TX_BEFORE_INIT
808 /* max_header_size tells us if the channel is initialised or not. */
809 if (self->max_header_size == IRCOMM_TTY_HDR_UNINITIALISED)
810 /* Don't bother us yet */
814 /* Check if we are allowed to transmit any data.
815 * hw_stopped is the regular flow control.
820 spin_lock_irqsave(&self->spinlock, flags);
822 ret = self->tx_data_size - self->tx_skb->len;
824 ret = self->max_data_size;
825 spin_unlock_irqrestore(&self->spinlock, flags);
827 IRDA_DEBUG(2, "%s(), ret=%d\n", __func__ , ret);
833 * Function ircomm_tty_wait_until_sent (tty, timeout)
835 * This routine waits until the device has written out all of the
836 * characters in its transmitter FIFO.
838 static void ircomm_tty_wait_until_sent(struct tty_struct *tty, int timeout)
840 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
841 unsigned long orig_jiffies, poll_time;
844 IRDA_DEBUG(2, "%s()\n", __func__ );
846 IRDA_ASSERT(self != NULL, return;);
847 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
849 orig_jiffies = jiffies;
851 /* Set poll time to 200 ms */
852 poll_time = IRDA_MIN(timeout, msecs_to_jiffies(200));
854 spin_lock_irqsave(&self->spinlock, flags);
855 while (self->tx_skb && self->tx_skb->len) {
856 spin_unlock_irqrestore(&self->spinlock, flags);
857 schedule_timeout_interruptible(poll_time);
858 spin_lock_irqsave(&self->spinlock, flags);
859 if (signal_pending(current))
861 if (timeout && time_after(jiffies, orig_jiffies + timeout))
864 spin_unlock_irqrestore(&self->spinlock, flags);
865 current->state = TASK_RUNNING;
869 * Function ircomm_tty_throttle (tty)
871 * This routine notifies the tty driver that input buffers for the line
872 * discipline are close to full, and it should somehow signal that no
873 * more characters should be sent to the tty.
875 static void ircomm_tty_throttle(struct tty_struct *tty)
877 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
879 IRDA_DEBUG(2, "%s()\n", __func__ );
881 IRDA_ASSERT(self != NULL, return;);
882 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
884 /* Software flow control? */
886 ircomm_tty_send_xchar(tty, STOP_CHAR(tty));
888 /* Hardware flow control? */
889 if (tty->termios->c_cflag & CRTSCTS) {
890 self->settings.dte &= ~IRCOMM_RTS;
891 self->settings.dte |= IRCOMM_DELTA_RTS;
893 ircomm_param_request(self, IRCOMM_DTE, TRUE);
896 ircomm_flow_request(self->ircomm, FLOW_STOP);
900 * Function ircomm_tty_unthrottle (tty)
902 * This routine notifies the tty drivers that it should signals that
903 * characters can now be sent to the tty without fear of overrunning the
904 * input buffers of the line disciplines.
906 static void ircomm_tty_unthrottle(struct tty_struct *tty)
908 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
910 IRDA_DEBUG(2, "%s()\n", __func__ );
912 IRDA_ASSERT(self != NULL, return;);
913 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
915 /* Using software flow control? */
917 ircomm_tty_send_xchar(tty, START_CHAR(tty));
920 /* Using hardware flow control? */
921 if (tty->termios->c_cflag & CRTSCTS) {
922 self->settings.dte |= (IRCOMM_RTS|IRCOMM_DELTA_RTS);
924 ircomm_param_request(self, IRCOMM_DTE, TRUE);
925 IRDA_DEBUG(1, "%s(), FLOW_START\n", __func__ );
927 ircomm_flow_request(self->ircomm, FLOW_START);
931 * Function ircomm_tty_chars_in_buffer (tty)
933 * Indicates if there are any data in the buffer
936 static int ircomm_tty_chars_in_buffer(struct tty_struct *tty)
938 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
942 IRDA_ASSERT(self != NULL, return -1;);
943 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
945 spin_lock_irqsave(&self->spinlock, flags);
948 len = self->tx_skb->len;
950 spin_unlock_irqrestore(&self->spinlock, flags);
955 static void ircomm_tty_shutdown(struct ircomm_tty_cb *self)
959 IRDA_ASSERT(self != NULL, return;);
960 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
962 IRDA_DEBUG(0, "%s()\n", __func__ );
964 if (!test_and_clear_bit(ASYNC_B_INITIALIZED, &self->flags))
967 ircomm_tty_detach_cable(self);
969 spin_lock_irqsave(&self->spinlock, flags);
971 del_timer(&self->watchdog_timer);
973 /* Free parameter buffer */
974 if (self->ctrl_skb) {
975 dev_kfree_skb(self->ctrl_skb);
976 self->ctrl_skb = NULL;
979 /* Free transmit buffer */
981 dev_kfree_skb(self->tx_skb);
986 ircomm_close(self->ircomm);
990 spin_unlock_irqrestore(&self->spinlock, flags);
994 * Function ircomm_tty_hangup (tty)
996 * This routine notifies the tty driver that it should hangup the tty
1000 static void ircomm_tty_hangup(struct tty_struct *tty)
1002 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
1003 unsigned long flags;
1005 IRDA_DEBUG(0, "%s()\n", __func__ );
1007 IRDA_ASSERT(self != NULL, return;);
1008 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1013 /* ircomm_tty_flush_buffer(tty); */
1014 ircomm_tty_shutdown(self);
1016 /* I guess we need to lock here - Jean II */
1017 spin_lock_irqsave(&self->spinlock, flags);
1018 self->flags &= ~ASYNC_NORMAL_ACTIVE;
1020 self->open_count = 0;
1021 spin_unlock_irqrestore(&self->spinlock, flags);
1023 wake_up_interruptible(&self->open_wait);
1027 * Function ircomm_tty_send_xchar (tty, ch)
1029 * This routine is used to send a high-priority XON/XOFF character to
1032 static void ircomm_tty_send_xchar(struct tty_struct *tty, char ch)
1034 IRDA_DEBUG(0, "%s(), not impl\n", __func__ );
1038 * Function ircomm_tty_start (tty)
1040 * This routine notifies the tty driver that it resume sending
1041 * characters to the tty device.
1043 void ircomm_tty_start(struct tty_struct *tty)
1045 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
1047 ircomm_flow_request(self->ircomm, FLOW_START);
1051 * Function ircomm_tty_stop (tty)
1053 * This routine notifies the tty driver that it should stop outputting
1054 * characters to the tty device.
1056 static void ircomm_tty_stop(struct tty_struct *tty)
1058 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) tty->driver_data;
1060 IRDA_ASSERT(self != NULL, return;);
1061 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1063 ircomm_flow_request(self->ircomm, FLOW_STOP);
1067 * Function ircomm_check_modem_status (self)
1069 * Check for any changes in the DCE's line settings. This function should
1070 * be called whenever the dce parameter settings changes, to update the
1071 * flow control settings and other things
1073 void ircomm_tty_check_modem_status(struct ircomm_tty_cb *self)
1075 struct tty_struct *tty;
1078 IRDA_DEBUG(0, "%s()\n", __func__ );
1080 IRDA_ASSERT(self != NULL, return;);
1081 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1085 status = self->settings.dce;
1087 if (status & IRCOMM_DCE_DELTA_ANY) {
1088 /*wake_up_interruptible(&self->delta_msr_wait);*/
1090 if ((self->flags & ASYNC_CHECK_CD) && (status & IRCOMM_DELTA_CD)) {
1092 "%s(), ircomm%d CD now %s...\n", __func__ , self->line,
1093 (status & IRCOMM_CD) ? "on" : "off");
1095 if (status & IRCOMM_CD) {
1096 wake_up_interruptible(&self->open_wait);
1099 "%s(), Doing serial hangup..\n", __func__ );
1103 /* Hangup will remote the tty, so better break out */
1107 if (self->flags & ASYNC_CTS_FLOW) {
1108 if (tty->hw_stopped) {
1109 if (status & IRCOMM_CTS) {
1111 "%s(), CTS tx start...\n", __func__ );
1112 tty->hw_stopped = 0;
1114 /* Wake up processes blocked on open */
1115 wake_up_interruptible(&self->open_wait);
1117 schedule_work(&self->tqueue);
1121 if (!(status & IRCOMM_CTS)) {
1123 "%s(), CTS tx stop...\n", __func__ );
1124 tty->hw_stopped = 1;
1131 * Function ircomm_tty_data_indication (instance, sap, skb)
1133 * Handle incoming data, and deliver it to the line discipline
1136 static int ircomm_tty_data_indication(void *instance, void *sap,
1137 struct sk_buff *skb)
1139 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1140 struct tty_ldisc *ld;
1142 IRDA_DEBUG(2, "%s()\n", __func__ );
1144 IRDA_ASSERT(self != NULL, return -1;);
1145 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
1146 IRDA_ASSERT(skb != NULL, return -1;);
1149 IRDA_DEBUG(0, "%s(), no tty!\n", __func__ );
1154 * If we receive data when hardware is stopped then something is wrong.
1155 * We try to poll the peers line settings to check if we are up todate.
1156 * Devices like WinCE can do this, and since they don't send any
1157 * params, we can just as well declare the hardware for running.
1159 if (self->tty->hw_stopped && (self->flow == FLOW_START)) {
1160 IRDA_DEBUG(0, "%s(), polling for line settings!\n", __func__ );
1161 ircomm_param_request(self, IRCOMM_POLL, TRUE);
1163 /* We can just as well declare the hardware for running */
1164 ircomm_tty_send_initial_parameters(self);
1165 ircomm_tty_link_established(self);
1169 * Just give it over to the line discipline. There is no need to
1170 * involve the flip buffers, since we are not running in an interrupt
1174 ld = tty_ldisc_ref(self->tty);
1176 ld->ops->receive_buf(self->tty, skb->data, NULL, skb->len);
1177 tty_ldisc_deref(ld);
1179 /* No need to kfree_skb - see ircomm_ttp_data_indication() */
1185 * Function ircomm_tty_control_indication (instance, sap, skb)
1187 * Parse all incoming parameters (easy!)
1190 static int ircomm_tty_control_indication(void *instance, void *sap,
1191 struct sk_buff *skb)
1193 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1196 IRDA_DEBUG(4, "%s()\n", __func__ );
1198 IRDA_ASSERT(self != NULL, return -1;);
1199 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return -1;);
1200 IRDA_ASSERT(skb != NULL, return -1;);
1202 clen = skb->data[0];
1204 irda_param_extract_all(self, skb->data+1, IRDA_MIN(skb->len-1, clen),
1205 &ircomm_param_info);
1207 /* No need to kfree_skb - see ircomm_control_indication() */
1213 * Function ircomm_tty_flow_indication (instance, sap, cmd)
1215 * This function is called by IrTTP when it wants us to slow down the
1216 * transmission of data. We just mark the hardware as stopped, and wait
1217 * for IrTTP to notify us that things are OK again.
1219 static void ircomm_tty_flow_indication(void *instance, void *sap,
1222 struct ircomm_tty_cb *self = (struct ircomm_tty_cb *) instance;
1223 struct tty_struct *tty;
1225 IRDA_ASSERT(self != NULL, return;);
1226 IRDA_ASSERT(self->magic == IRCOMM_TTY_MAGIC, return;);
1232 IRDA_DEBUG(2, "%s(), hw start!\n", __func__ );
1233 tty->hw_stopped = 0;
1235 /* ircomm_tty_do_softint will take care of the rest */
1236 schedule_work(&self->tqueue);
1238 default: /* If we get here, something is very wrong, better stop */
1240 IRDA_DEBUG(2, "%s(), hw stopped!\n", __func__ );
1241 tty->hw_stopped = 1;
1247 #ifdef CONFIG_PROC_FS
1248 static void ircomm_tty_line_info(struct ircomm_tty_cb *self, struct seq_file *m)
1252 seq_printf(m, "State: %s\n", ircomm_tty_state[self->state]);
1254 seq_puts(m, "Service type: ");
1255 if (self->service_type & IRCOMM_9_WIRE)
1256 seq_puts(m, "9_WIRE");
1257 else if (self->service_type & IRCOMM_3_WIRE)
1258 seq_puts(m, "3_WIRE");
1259 else if (self->service_type & IRCOMM_3_WIRE_RAW)
1260 seq_puts(m, "3_WIRE_RAW");
1262 seq_puts(m, "No common service type!\n");
1265 seq_printf(m, "Port name: %s\n", self->settings.port_name);
1267 seq_printf(m, "DTE status:");
1269 if (self->settings.dte & IRCOMM_RTS) {
1270 seq_printf(m, "%cRTS", sep);
1273 if (self->settings.dte & IRCOMM_DTR) {
1274 seq_printf(m, "%cDTR", sep);
1279 seq_puts(m, "DCE status:");
1281 if (self->settings.dce & IRCOMM_CTS) {
1282 seq_printf(m, "%cCTS", sep);
1285 if (self->settings.dce & IRCOMM_DSR) {
1286 seq_printf(m, "%cDSR", sep);
1289 if (self->settings.dce & IRCOMM_CD) {
1290 seq_printf(m, "%cCD", sep);
1293 if (self->settings.dce & IRCOMM_RI) {
1294 seq_printf(m, "%cRI", sep);
1299 seq_puts(m, "Configuration: ");
1300 if (!self->settings.null_modem)
1301 seq_puts(m, "DTE <-> DCE\n");
1303 seq_puts(m, "DTE <-> DTE (null modem emulation)\n");
1305 seq_printf(m, "Data rate: %d\n", self->settings.data_rate);
1307 seq_puts(m, "Flow control:");
1309 if (self->settings.flow_control & IRCOMM_XON_XOFF_IN) {
1310 seq_printf(m, "%cXON_XOFF_IN", sep);
1313 if (self->settings.flow_control & IRCOMM_XON_XOFF_OUT) {
1314 seq_printf(m, "%cXON_XOFF_OUT", sep);
1317 if (self->settings.flow_control & IRCOMM_RTS_CTS_IN) {
1318 seq_printf(m, "%cRTS_CTS_IN", sep);
1321 if (self->settings.flow_control & IRCOMM_RTS_CTS_OUT) {
1322 seq_printf(m, "%cRTS_CTS_OUT", sep);
1325 if (self->settings.flow_control & IRCOMM_DSR_DTR_IN) {
1326 seq_printf(m, "%cDSR_DTR_IN", sep);
1329 if (self->settings.flow_control & IRCOMM_DSR_DTR_OUT) {
1330 seq_printf(m, "%cDSR_DTR_OUT", sep);
1333 if (self->settings.flow_control & IRCOMM_ENQ_ACK_IN) {
1334 seq_printf(m, "%cENQ_ACK_IN", sep);
1337 if (self->settings.flow_control & IRCOMM_ENQ_ACK_OUT) {
1338 seq_printf(m, "%cENQ_ACK_OUT", sep);
1343 seq_puts(m, "Flags:");
1345 if (self->flags & ASYNC_CTS_FLOW) {
1346 seq_printf(m, "%cASYNC_CTS_FLOW", sep);
1349 if (self->flags & ASYNC_CHECK_CD) {
1350 seq_printf(m, "%cASYNC_CHECK_CD", sep);
1353 if (self->flags & ASYNC_INITIALIZED) {
1354 seq_printf(m, "%cASYNC_INITIALIZED", sep);
1357 if (self->flags & ASYNC_LOW_LATENCY) {
1358 seq_printf(m, "%cASYNC_LOW_LATENCY", sep);
1361 if (self->flags & ASYNC_CLOSING) {
1362 seq_printf(m, "%cASYNC_CLOSING", sep);
1365 if (self->flags & ASYNC_NORMAL_ACTIVE) {
1366 seq_printf(m, "%cASYNC_NORMAL_ACTIVE", sep);
1371 seq_printf(m, "Role: %s\n", self->client ? "client" : "server");
1372 seq_printf(m, "Open count: %d\n", self->open_count);
1373 seq_printf(m, "Max data size: %d\n", self->max_data_size);
1374 seq_printf(m, "Max header size: %d\n", self->max_header_size);
1377 seq_printf(m, "Hardware: %s\n",
1378 self->tty->hw_stopped ? "Stopped" : "Running");
1381 static int ircomm_tty_proc_show(struct seq_file *m, void *v)
1383 struct ircomm_tty_cb *self;
1384 unsigned long flags;
1386 spin_lock_irqsave(&ircomm_tty->hb_spinlock, flags);
1388 self = (struct ircomm_tty_cb *) hashbin_get_first(ircomm_tty);
1389 while (self != NULL) {
1390 if (self->magic != IRCOMM_TTY_MAGIC)
1393 ircomm_tty_line_info(self, m);
1394 self = (struct ircomm_tty_cb *) hashbin_get_next(ircomm_tty);
1396 spin_unlock_irqrestore(&ircomm_tty->hb_spinlock, flags);
1400 static int ircomm_tty_proc_open(struct inode *inode, struct file *file)
1402 return single_open(file, ircomm_tty_proc_show, NULL);
1405 static const struct file_operations ircomm_tty_proc_fops = {
1406 .owner = THIS_MODULE,
1407 .open = ircomm_tty_proc_open,
1409 .llseek = seq_lseek,
1410 .release = single_release,
1412 #endif /* CONFIG_PROC_FS */
1414 MODULE_AUTHOR("Dag Brattli <dagb@cs.uit.no>");
1415 MODULE_DESCRIPTION("IrCOMM serial TTY driver");
1416 MODULE_LICENSE("GPL");
1417 MODULE_ALIAS_CHARDEV_MAJOR(IRCOMM_TTY_MAJOR);
1419 module_init(ircomm_tty_init);
1420 module_exit(ircomm_tty_cleanup);