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
);
190 * Function ircomm_tty_cleanup ()
192 * Remove IrCOMM TTY layer/driver
195 static void __exit
ircomm_tty_cleanup(void)
199 IRDA_DEBUG(4, "%s()\n", __func__
);
201 ret
= tty_unregister_driver(driver
);
203 IRDA_ERROR("%s(), failed to unregister driver\n",
208 hashbin_delete(ircomm_tty
, (FREE_FUNC
) __ircomm_tty_cleanup
);
209 put_tty_driver(driver
);
213 * Function ircomm_startup (self)
218 static int ircomm_tty_startup(struct ircomm_tty_cb
*self
)
223 IRDA_DEBUG(2, "%s()\n", __func__
);
225 IRDA_ASSERT(self
!= NULL
, return -1;);
226 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
228 /* Check if already open */
229 if (test_and_set_bit(ASYNCB_INITIALIZED
, &self
->port
.flags
)) {
230 IRDA_DEBUG(2, "%s(), already open so break out!\n", __func__
);
234 /* Register with IrCOMM */
235 irda_notify_init(¬ify
);
236 /* These callbacks we must handle ourselves */
237 notify
.data_indication
= ircomm_tty_data_indication
;
238 notify
.udata_indication
= ircomm_tty_control_indication
;
239 notify
.flow_indication
= ircomm_tty_flow_indication
;
241 /* Use the ircomm_tty interface for these ones */
242 notify
.disconnect_indication
= ircomm_tty_disconnect_indication
;
243 notify
.connect_confirm
= ircomm_tty_connect_confirm
;
244 notify
.connect_indication
= ircomm_tty_connect_indication
;
245 strlcpy(notify
.name
, "ircomm_tty", sizeof(notify
.name
));
246 notify
.instance
= self
;
249 self
->ircomm
= ircomm_open(¬ify
, self
->service_type
,
255 self
->slsap_sel
= self
->ircomm
->slsap_sel
;
257 /* Connect IrCOMM link with remote device */
258 ret
= ircomm_tty_attach_cable(self
);
260 IRDA_ERROR("%s(), error attaching cable!\n", __func__
);
266 clear_bit(ASYNCB_INITIALIZED
, &self
->port
.flags
);
271 * Function ircomm_block_til_ready (self, filp)
276 static int ircomm_tty_block_til_ready(struct ircomm_tty_cb
*self
,
277 struct tty_struct
*tty
, struct file
*filp
)
279 struct tty_port
*port
= &self
->port
;
280 DECLARE_WAITQUEUE(wait
, current
);
282 int do_clocal
= 0, extra_count
= 0;
285 IRDA_DEBUG(2, "%s()\n", __func__
);
288 * If non-blocking mode is set, or the port is not enabled,
289 * then make the check up front and then exit.
291 if (filp
->f_flags
& O_NONBLOCK
|| tty
->flags
& (1 << TTY_IO_ERROR
)){
292 /* nonblock mode is set or port is not enabled */
293 port
->flags
|= ASYNC_NORMAL_ACTIVE
;
294 IRDA_DEBUG(1, "%s(), O_NONBLOCK requested!\n", __func__
);
298 if (tty
->termios
.c_cflag
& CLOCAL
) {
299 IRDA_DEBUG(1, "%s(), doing CLOCAL!\n", __func__
);
303 /* Wait for carrier detect and the line to become
304 * free (i.e., not in use by the callout). While we are in
305 * this loop, port->count is dropped by one, so that
306 * mgsl_close() knows when to free things. We restore it upon
307 * exit, either normal or abnormal.
311 add_wait_queue(&port
->open_wait
, &wait
);
313 IRDA_DEBUG(2, "%s(%d):block_til_ready before block on %s open_count=%d\n",
314 __FILE__
, __LINE__
, tty
->driver
->name
, port
->count
);
316 spin_lock_irqsave(&port
->lock
, flags
);
317 if (!tty_hung_up_p(filp
)) {
321 spin_unlock_irqrestore(&port
->lock
, flags
);
322 port
->blocked_open
++;
325 if (tty
->termios
.c_cflag
& CBAUD
)
326 tty_port_raise_dtr_rts(port
);
328 current
->state
= TASK_INTERRUPTIBLE
;
330 if (tty_hung_up_p(filp
) ||
331 !test_bit(ASYNCB_INITIALIZED
, &port
->flags
)) {
332 retval
= (port
->flags
& ASYNC_HUP_NOTIFY
) ?
333 -EAGAIN
: -ERESTARTSYS
;
338 * Check if link is ready now. Even if CLOCAL is
339 * specified, we cannot return before the IrCOMM link is
342 if (!test_bit(ASYNCB_CLOSING
, &port
->flags
) &&
343 (do_clocal
|| tty_port_carrier_raised(port
)) &&
344 self
->state
== IRCOMM_TTY_READY
)
349 if (signal_pending(current
)) {
350 retval
= -ERESTARTSYS
;
354 IRDA_DEBUG(1, "%s(%d):block_til_ready blocking on %s open_count=%d\n",
355 __FILE__
, __LINE__
, tty
->driver
->name
, port
->count
);
360 __set_current_state(TASK_RUNNING
);
361 remove_wait_queue(&port
->open_wait
, &wait
);
364 /* ++ is not atomic, so this should be protected - Jean II */
365 spin_lock_irqsave(&port
->lock
, flags
);
367 spin_unlock_irqrestore(&port
->lock
, flags
);
369 port
->blocked_open
--;
371 IRDA_DEBUG(1, "%s(%d):block_til_ready after blocking on %s open_count=%d\n",
372 __FILE__
, __LINE__
, tty
->driver
->name
, port
->count
);
375 port
->flags
|= ASYNC_NORMAL_ACTIVE
;
381 static int ircomm_tty_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
383 struct ircomm_tty_cb
*self
;
384 unsigned int line
= tty
->index
;
386 /* Check if instance already exists */
387 self
= hashbin_lock_find(ircomm_tty
, line
, NULL
);
389 /* No, so make new instance */
390 self
= kzalloc(sizeof(struct ircomm_tty_cb
), GFP_KERNEL
);
392 IRDA_ERROR("%s(), kmalloc failed!\n", __func__
);
396 tty_port_init(&self
->port
);
397 self
->port
.ops
= &ircomm_port_ops
;
398 self
->magic
= IRCOMM_TTY_MAGIC
;
399 self
->flow
= FLOW_STOP
;
402 INIT_WORK(&self
->tqueue
, ircomm_tty_do_softint
);
403 self
->max_header_size
= IRCOMM_TTY_HDR_UNINITIALISED
;
404 self
->max_data_size
= IRCOMM_TTY_DATA_UNINITIALISED
;
406 /* Init some important stuff */
407 init_timer(&self
->watchdog_timer
);
408 spin_lock_init(&self
->spinlock
);
411 * Force TTY into raw mode by default which is usually what
412 * we want for IrCOMM and IrLPT. This way applications will
413 * not have to twiddle with printcap etc.
415 * Note this is completely usafe and doesn't work properly
417 tty
->termios
.c_iflag
= 0;
418 tty
->termios
.c_oflag
= 0;
420 /* Insert into hash */
421 hashbin_insert(ircomm_tty
, (irda_queue_t
*) self
, line
, NULL
);
424 return tty_port_install(&self
->port
, driver
, tty
);
428 * Function ircomm_tty_open (tty, filp)
430 * This routine is called when a particular tty device is opened. This
431 * routine is mandatory; if this routine is not filled in, the attempted
432 * open will fail with ENODEV.
434 static int ircomm_tty_open(struct tty_struct
*tty
, struct file
*filp
)
436 struct ircomm_tty_cb
*self
= tty
->driver_data
;
440 IRDA_DEBUG(2, "%s()\n", __func__
);
442 /* ++ is not atomic, so this should be protected - Jean II */
443 spin_lock_irqsave(&self
->port
.lock
, flags
);
445 spin_unlock_irqrestore(&self
->port
.lock
, flags
);
446 tty_port_tty_set(&self
->port
, tty
);
448 IRDA_DEBUG(1, "%s(), %s%d, count = %d\n", __func__
, tty
->driver
->name
,
449 self
->line
, self
->port
.count
);
451 /* Not really used by us, but lets do it anyway */
452 tty
->low_latency
= (self
->port
.flags
& ASYNC_LOW_LATENCY
) ? 1 : 0;
455 * If the port is the middle of closing, bail out now
457 if (tty_hung_up_p(filp
) ||
458 test_bit(ASYNCB_CLOSING
, &self
->port
.flags
)) {
460 /* Hm, why are we blocking on ASYNC_CLOSING if we
461 * do return -EAGAIN/-ERESTARTSYS below anyway?
462 * IMHO it's either not needed in the first place
463 * or for some reason we need to make sure the async
464 * closing has been finished - if so, wouldn't we
465 * probably better sleep uninterruptible?
468 if (wait_event_interruptible(self
->port
.close_wait
,
469 !test_bit(ASYNCB_CLOSING
, &self
->port
.flags
))) {
470 IRDA_WARNING("%s - got signal while blocking on ASYNC_CLOSING!\n",
475 #ifdef SERIAL_DO_RESTART
476 return (self
->port
.flags
& ASYNC_HUP_NOTIFY
) ?
477 -EAGAIN
: -ERESTARTSYS
;
483 /* Check if this is a "normal" ircomm device, or an irlpt device */
484 if (self
->line
< 0x10) {
485 self
->service_type
= IRCOMM_3_WIRE
| IRCOMM_9_WIRE
;
486 self
->settings
.service_type
= IRCOMM_9_WIRE
; /* 9 wire as default */
487 /* Jan Kiszka -> add DSR/RI -> Conform to IrCOMM spec */
488 self
->settings
.dce
= IRCOMM_CTS
| IRCOMM_CD
| IRCOMM_DSR
| IRCOMM_RI
; /* Default line settings */
489 IRDA_DEBUG(2, "%s(), IrCOMM device\n", __func__
);
491 IRDA_DEBUG(2, "%s(), IrLPT device\n", __func__
);
492 self
->service_type
= IRCOMM_3_WIRE_RAW
;
493 self
->settings
.service_type
= IRCOMM_3_WIRE_RAW
; /* Default */
496 ret
= ircomm_tty_startup(self
);
500 ret
= ircomm_tty_block_til_ready(self
, tty
, filp
);
503 "%s(), returning after block_til_ready with %d\n", __func__
,
512 * Function ircomm_tty_close (tty, filp)
514 * This routine is called when a particular tty device is closed.
517 static void ircomm_tty_close(struct tty_struct
*tty
, struct file
*filp
)
519 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
520 struct tty_port
*port
= &self
->port
;
522 IRDA_DEBUG(0, "%s()\n", __func__
);
524 IRDA_ASSERT(self
!= NULL
, return;);
525 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
527 if (tty_port_close_start(port
, tty
, filp
) == 0)
530 ircomm_tty_shutdown(self
);
532 tty_driver_flush_buffer(tty
);
534 tty_port_close_end(port
, tty
);
535 tty_port_tty_set(port
, NULL
);
539 * Function ircomm_tty_flush_buffer (tty)
544 static void ircomm_tty_flush_buffer(struct tty_struct
*tty
)
546 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
548 IRDA_ASSERT(self
!= NULL
, return;);
549 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
552 * Let do_softint() do this to avoid race condition with
555 schedule_work(&self
->tqueue
);
559 * Function ircomm_tty_do_softint (work)
561 * We use this routine to give the write wakeup to the user at at a
562 * safe time (as fast as possible after write have completed). This
563 * can be compared to the Tx interrupt.
565 static void ircomm_tty_do_softint(struct work_struct
*work
)
567 struct ircomm_tty_cb
*self
=
568 container_of(work
, struct ircomm_tty_cb
, tqueue
);
569 struct tty_struct
*tty
;
571 struct sk_buff
*skb
, *ctrl_skb
;
573 IRDA_DEBUG(2, "%s()\n", __func__
);
575 if (!self
|| self
->magic
!= IRCOMM_TTY_MAGIC
)
578 tty
= tty_port_tty_get(&self
->port
);
582 /* Unlink control buffer */
583 spin_lock_irqsave(&self
->spinlock
, flags
);
585 ctrl_skb
= self
->ctrl_skb
;
586 self
->ctrl_skb
= NULL
;
588 spin_unlock_irqrestore(&self
->spinlock
, flags
);
590 /* Flush control buffer if any */
592 if(self
->flow
== FLOW_START
)
593 ircomm_control_request(self
->ircomm
, ctrl_skb
);
594 /* Drop reference count - see ircomm_ttp_data_request(). */
595 dev_kfree_skb(ctrl_skb
);
601 /* Unlink transmit buffer */
602 spin_lock_irqsave(&self
->spinlock
, flags
);
607 spin_unlock_irqrestore(&self
->spinlock
, flags
);
609 /* Flush transmit buffer if any */
611 ircomm_tty_do_event(self
, IRCOMM_TTY_DATA_REQUEST
, skb
, NULL
);
612 /* Drop reference count - see ircomm_ttp_data_request(). */
616 /* Check if user (still) wants to be waken up */
623 * Function ircomm_tty_write (tty, buf, count)
625 * This routine is called by the kernel to write a series of characters
626 * to the tty device. The characters may come from user space or kernel
627 * space. This routine will return the number of characters actually
628 * accepted for writing. This routine is mandatory.
630 static int ircomm_tty_write(struct tty_struct
*tty
,
631 const unsigned char *buf
, int count
)
633 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
640 IRDA_DEBUG(2, "%s(), count=%d, hw_stopped=%d\n", __func__
, count
,
643 IRDA_ASSERT(self
!= NULL
, return -1;);
644 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
646 /* We may receive packets from the TTY even before we have finished
647 * our setup. Not cool.
648 * The problem is that we don't know the final header and data size
649 * to create the proper skb, so any skb we would create would have
650 * bogus header and data size, so need care.
651 * We use a bogus header size to safely detect this condition.
652 * Another problem is that hw_stopped was set to 0 way before it
653 * should be, so we would drop this skb. It should now be fixed.
654 * One option is to not accept data until we are properly setup.
655 * But, I suspect that when it happens, the ppp line discipline
656 * just "drops" the data, which might screw up connect scripts.
657 * The second option is to create a "safe skb", with large header
658 * and small size (see ircomm_tty_open() for values).
659 * We just need to make sure that when the real values get filled,
660 * we don't mess up the original "safe skb" (see tx_data_size).
662 if (self
->max_header_size
== IRCOMM_TTY_HDR_UNINITIALISED
) {
663 IRDA_DEBUG(1, "%s() : not initialised\n", __func__
);
664 #ifdef IRCOMM_NO_TX_BEFORE_INIT
665 /* We didn't consume anything, TTY will retry */
673 /* Protect our manipulation of self->tx_skb and related */
674 spin_lock_irqsave(&self
->spinlock
, flags
);
676 /* Fetch current transmit buffer */
680 * Send out all the data we get, possibly as multiple fragmented
681 * frames, but this will only happen if the data is larger than the
682 * max data size. The normal case however is just the opposite, and
683 * this function may be called multiple times, and will then actually
684 * defragment the data and send it out as one packet as soon as
685 * possible, but at a safer point in time
690 /* Adjust data size to the max data size */
691 if (size
> self
->max_data_size
)
692 size
= self
->max_data_size
;
695 * Do we already have a buffer ready for transmit, or do
696 * we need to allocate a new frame
700 * Any room for more data at the end of the current
701 * transmit buffer? Cannot use skb_tailroom, since
702 * dev_alloc_skb gives us a larger skb than we
704 * Note : use tx_data_size, because max_data_size
705 * may have changed and we don't want to overwrite
708 if ((tailroom
= (self
->tx_data_size
- skb
->len
)) > 0) {
709 /* Adjust data to tailroom */
714 * Current transmit frame is full, so break
715 * out, so we can send it as soon as possible
720 /* Prepare a full sized frame */
721 skb
= alloc_skb(self
->max_data_size
+
722 self
->max_header_size
,
725 spin_unlock_irqrestore(&self
->spinlock
, flags
);
728 skb_reserve(skb
, self
->max_header_size
);
730 /* Remember skb size because max_data_size may
731 * change later on - Jean II */
732 self
->tx_data_size
= self
->max_data_size
;
736 memcpy(skb_put(skb
,size
), buf
+ len
, size
);
742 spin_unlock_irqrestore(&self
->spinlock
, flags
);
745 * Schedule a new thread which will transmit the frame as soon
746 * as possible, but at a safe point in time. We do this so the
747 * "user" can give us data multiple times, as PPP does (because of
748 * its 256 byte tx buffer). We will then defragment and send out
749 * all this data as one single packet.
751 schedule_work(&self
->tqueue
);
757 * Function ircomm_tty_write_room (tty)
759 * This routine returns the numbers of characters the tty driver will
760 * accept for queuing to be written. This number is subject to change as
761 * output buffers get emptied, or if the output flow control is acted.
763 static int ircomm_tty_write_room(struct tty_struct
*tty
)
765 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
769 IRDA_ASSERT(self
!= NULL
, return -1;);
770 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
772 #ifdef IRCOMM_NO_TX_BEFORE_INIT
773 /* max_header_size tells us if the channel is initialised or not. */
774 if (self
->max_header_size
== IRCOMM_TTY_HDR_UNINITIALISED
)
775 /* Don't bother us yet */
779 /* Check if we are allowed to transmit any data.
780 * hw_stopped is the regular flow control.
785 spin_lock_irqsave(&self
->spinlock
, flags
);
787 ret
= self
->tx_data_size
- self
->tx_skb
->len
;
789 ret
= self
->max_data_size
;
790 spin_unlock_irqrestore(&self
->spinlock
, flags
);
792 IRDA_DEBUG(2, "%s(), ret=%d\n", __func__
, ret
);
798 * Function ircomm_tty_wait_until_sent (tty, timeout)
800 * This routine waits until the device has written out all of the
801 * characters in its transmitter FIFO.
803 static void ircomm_tty_wait_until_sent(struct tty_struct
*tty
, int timeout
)
805 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
806 unsigned long orig_jiffies
, poll_time
;
809 IRDA_DEBUG(2, "%s()\n", __func__
);
811 IRDA_ASSERT(self
!= NULL
, return;);
812 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
814 orig_jiffies
= jiffies
;
816 /* Set poll time to 200 ms */
817 poll_time
= IRDA_MIN(timeout
, msecs_to_jiffies(200));
819 spin_lock_irqsave(&self
->spinlock
, flags
);
820 while (self
->tx_skb
&& self
->tx_skb
->len
) {
821 spin_unlock_irqrestore(&self
->spinlock
, flags
);
822 schedule_timeout_interruptible(poll_time
);
823 spin_lock_irqsave(&self
->spinlock
, flags
);
824 if (signal_pending(current
))
826 if (timeout
&& time_after(jiffies
, orig_jiffies
+ timeout
))
829 spin_unlock_irqrestore(&self
->spinlock
, flags
);
830 current
->state
= TASK_RUNNING
;
834 * Function ircomm_tty_throttle (tty)
836 * This routine notifies the tty driver that input buffers for the line
837 * discipline are close to full, and it should somehow signal that no
838 * more characters should be sent to the tty.
840 static void ircomm_tty_throttle(struct tty_struct
*tty
)
842 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
844 IRDA_DEBUG(2, "%s()\n", __func__
);
846 IRDA_ASSERT(self
!= NULL
, return;);
847 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
849 /* Software flow control? */
851 ircomm_tty_send_xchar(tty
, STOP_CHAR(tty
));
853 /* Hardware flow control? */
854 if (tty
->termios
.c_cflag
& CRTSCTS
) {
855 self
->settings
.dte
&= ~IRCOMM_RTS
;
856 self
->settings
.dte
|= IRCOMM_DELTA_RTS
;
858 ircomm_param_request(self
, IRCOMM_DTE
, TRUE
);
861 ircomm_flow_request(self
->ircomm
, FLOW_STOP
);
865 * Function ircomm_tty_unthrottle (tty)
867 * This routine notifies the tty drivers that it should signals that
868 * characters can now be sent to the tty without fear of overrunning the
869 * input buffers of the line disciplines.
871 static void ircomm_tty_unthrottle(struct tty_struct
*tty
)
873 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
875 IRDA_DEBUG(2, "%s()\n", __func__
);
877 IRDA_ASSERT(self
!= NULL
, return;);
878 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
880 /* Using software flow control? */
882 ircomm_tty_send_xchar(tty
, START_CHAR(tty
));
885 /* Using hardware flow control? */
886 if (tty
->termios
.c_cflag
& CRTSCTS
) {
887 self
->settings
.dte
|= (IRCOMM_RTS
|IRCOMM_DELTA_RTS
);
889 ircomm_param_request(self
, IRCOMM_DTE
, TRUE
);
890 IRDA_DEBUG(1, "%s(), FLOW_START\n", __func__
);
892 ircomm_flow_request(self
->ircomm
, FLOW_START
);
896 * Function ircomm_tty_chars_in_buffer (tty)
898 * Indicates if there are any data in the buffer
901 static int ircomm_tty_chars_in_buffer(struct tty_struct
*tty
)
903 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
907 IRDA_ASSERT(self
!= NULL
, return -1;);
908 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
910 spin_lock_irqsave(&self
->spinlock
, flags
);
913 len
= self
->tx_skb
->len
;
915 spin_unlock_irqrestore(&self
->spinlock
, flags
);
920 static void ircomm_tty_shutdown(struct ircomm_tty_cb
*self
)
924 IRDA_ASSERT(self
!= NULL
, return;);
925 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
927 IRDA_DEBUG(0, "%s()\n", __func__
);
929 if (!test_and_clear_bit(ASYNCB_INITIALIZED
, &self
->port
.flags
))
932 ircomm_tty_detach_cable(self
);
934 spin_lock_irqsave(&self
->spinlock
, flags
);
936 del_timer(&self
->watchdog_timer
);
938 /* Free parameter buffer */
939 if (self
->ctrl_skb
) {
940 dev_kfree_skb(self
->ctrl_skb
);
941 self
->ctrl_skb
= NULL
;
944 /* Free transmit buffer */
946 dev_kfree_skb(self
->tx_skb
);
951 ircomm_close(self
->ircomm
);
955 spin_unlock_irqrestore(&self
->spinlock
, flags
);
959 * Function ircomm_tty_hangup (tty)
961 * This routine notifies the tty driver that it should hangup the tty
965 static void ircomm_tty_hangup(struct tty_struct
*tty
)
967 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
968 struct tty_port
*port
= &self
->port
;
971 IRDA_DEBUG(0, "%s()\n", __func__
);
973 IRDA_ASSERT(self
!= NULL
, return;);
974 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
976 /* ircomm_tty_flush_buffer(tty); */
977 ircomm_tty_shutdown(self
);
979 spin_lock_irqsave(&port
->lock
, flags
);
980 port
->flags
&= ~ASYNC_NORMAL_ACTIVE
;
982 set_bit(TTY_IO_ERROR
, &port
->tty
->flags
);
983 tty_kref_put(port
->tty
);
987 spin_unlock_irqrestore(&port
->lock
, flags
);
989 wake_up_interruptible(&port
->open_wait
);
993 * Function ircomm_tty_send_xchar (tty, ch)
995 * This routine is used to send a high-priority XON/XOFF character to
998 static void ircomm_tty_send_xchar(struct tty_struct
*tty
, char ch
)
1000 IRDA_DEBUG(0, "%s(), not impl\n", __func__
);
1004 * Function ircomm_tty_start (tty)
1006 * This routine notifies the tty driver that it resume sending
1007 * characters to the tty device.
1009 void ircomm_tty_start(struct tty_struct
*tty
)
1011 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
1013 ircomm_flow_request(self
->ircomm
, FLOW_START
);
1017 * Function ircomm_tty_stop (tty)
1019 * This routine notifies the tty driver that it should stop outputting
1020 * characters to the tty device.
1022 static void ircomm_tty_stop(struct tty_struct
*tty
)
1024 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
1026 IRDA_ASSERT(self
!= NULL
, return;);
1027 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
1029 ircomm_flow_request(self
->ircomm
, FLOW_STOP
);
1033 * Function ircomm_check_modem_status (self)
1035 * Check for any changes in the DCE's line settings. This function should
1036 * be called whenever the dce parameter settings changes, to update the
1037 * flow control settings and other things
1039 void ircomm_tty_check_modem_status(struct ircomm_tty_cb
*self
)
1041 struct tty_struct
*tty
;
1044 IRDA_DEBUG(0, "%s()\n", __func__
);
1046 IRDA_ASSERT(self
!= NULL
, return;);
1047 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
1049 tty
= tty_port_tty_get(&self
->port
);
1051 status
= self
->settings
.dce
;
1053 if (status
& IRCOMM_DCE_DELTA_ANY
) {
1054 /*wake_up_interruptible(&self->delta_msr_wait);*/
1056 if ((self
->port
.flags
& ASYNC_CHECK_CD
) && (status
& IRCOMM_DELTA_CD
)) {
1058 "%s(), ircomm%d CD now %s...\n", __func__
, self
->line
,
1059 (status
& IRCOMM_CD
) ? "on" : "off");
1061 if (status
& IRCOMM_CD
) {
1062 wake_up_interruptible(&self
->port
.open_wait
);
1065 "%s(), Doing serial hangup..\n", __func__
);
1069 /* Hangup will remote the tty, so better break out */
1073 if (tty
&& self
->port
.flags
& ASYNC_CTS_FLOW
) {
1074 if (tty
->hw_stopped
) {
1075 if (status
& IRCOMM_CTS
) {
1077 "%s(), CTS tx start...\n", __func__
);
1078 tty
->hw_stopped
= 0;
1080 /* Wake up processes blocked on open */
1081 wake_up_interruptible(&self
->port
.open_wait
);
1083 schedule_work(&self
->tqueue
);
1087 if (!(status
& IRCOMM_CTS
)) {
1089 "%s(), CTS tx stop...\n", __func__
);
1090 tty
->hw_stopped
= 1;
1099 * Function ircomm_tty_data_indication (instance, sap, skb)
1101 * Handle incoming data, and deliver it to the line discipline
1104 static int ircomm_tty_data_indication(void *instance
, void *sap
,
1105 struct sk_buff
*skb
)
1107 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) instance
;
1108 struct tty_struct
*tty
;
1110 IRDA_DEBUG(2, "%s()\n", __func__
);
1112 IRDA_ASSERT(self
!= NULL
, return -1;);
1113 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
1114 IRDA_ASSERT(skb
!= NULL
, return -1;);
1116 tty
= tty_port_tty_get(&self
->port
);
1118 IRDA_DEBUG(0, "%s(), no tty!\n", __func__
);
1123 * If we receive data when hardware is stopped then something is wrong.
1124 * We try to poll the peers line settings to check if we are up todate.
1125 * Devices like WinCE can do this, and since they don't send any
1126 * params, we can just as well declare the hardware for running.
1128 if (tty
->hw_stopped
&& (self
->flow
== FLOW_START
)) {
1129 IRDA_DEBUG(0, "%s(), polling for line settings!\n", __func__
);
1130 ircomm_param_request(self
, IRCOMM_POLL
, TRUE
);
1132 /* We can just as well declare the hardware for running */
1133 ircomm_tty_send_initial_parameters(self
);
1134 ircomm_tty_link_established(self
);
1138 * Use flip buffer functions since the code may be called from interrupt
1141 tty_insert_flip_string(tty
, skb
->data
, skb
->len
);
1142 tty_flip_buffer_push(tty
);
1145 /* No need to kfree_skb - see ircomm_ttp_data_indication() */
1151 * Function ircomm_tty_control_indication (instance, sap, skb)
1153 * Parse all incoming parameters (easy!)
1156 static int ircomm_tty_control_indication(void *instance
, void *sap
,
1157 struct sk_buff
*skb
)
1159 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) instance
;
1162 IRDA_DEBUG(4, "%s()\n", __func__
);
1164 IRDA_ASSERT(self
!= NULL
, return -1;);
1165 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
1166 IRDA_ASSERT(skb
!= NULL
, return -1;);
1168 clen
= skb
->data
[0];
1170 irda_param_extract_all(self
, skb
->data
+1, IRDA_MIN(skb
->len
-1, clen
),
1171 &ircomm_param_info
);
1173 /* No need to kfree_skb - see ircomm_control_indication() */
1179 * Function ircomm_tty_flow_indication (instance, sap, cmd)
1181 * This function is called by IrTTP when it wants us to slow down the
1182 * transmission of data. We just mark the hardware as stopped, and wait
1183 * for IrTTP to notify us that things are OK again.
1185 static void ircomm_tty_flow_indication(void *instance
, void *sap
,
1188 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) instance
;
1189 struct tty_struct
*tty
;
1191 IRDA_ASSERT(self
!= NULL
, return;);
1192 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
1194 tty
= tty_port_tty_get(&self
->port
);
1198 IRDA_DEBUG(2, "%s(), hw start!\n", __func__
);
1200 tty
->hw_stopped
= 0;
1202 /* ircomm_tty_do_softint will take care of the rest */
1203 schedule_work(&self
->tqueue
);
1205 default: /* If we get here, something is very wrong, better stop */
1207 IRDA_DEBUG(2, "%s(), hw stopped!\n", __func__
);
1209 tty
->hw_stopped
= 1;
1217 #ifdef CONFIG_PROC_FS
1218 static void ircomm_tty_line_info(struct ircomm_tty_cb
*self
, struct seq_file
*m
)
1220 struct tty_struct
*tty
;
1223 seq_printf(m
, "State: %s\n", ircomm_tty_state
[self
->state
]);
1225 seq_puts(m
, "Service type: ");
1226 if (self
->service_type
& IRCOMM_9_WIRE
)
1227 seq_puts(m
, "9_WIRE");
1228 else if (self
->service_type
& IRCOMM_3_WIRE
)
1229 seq_puts(m
, "3_WIRE");
1230 else if (self
->service_type
& IRCOMM_3_WIRE_RAW
)
1231 seq_puts(m
, "3_WIRE_RAW");
1233 seq_puts(m
, "No common service type!\n");
1236 seq_printf(m
, "Port name: %s\n", self
->settings
.port_name
);
1238 seq_printf(m
, "DTE status:");
1240 if (self
->settings
.dte
& IRCOMM_RTS
) {
1241 seq_printf(m
, "%cRTS", sep
);
1244 if (self
->settings
.dte
& IRCOMM_DTR
) {
1245 seq_printf(m
, "%cDTR", sep
);
1250 seq_puts(m
, "DCE status:");
1252 if (self
->settings
.dce
& IRCOMM_CTS
) {
1253 seq_printf(m
, "%cCTS", sep
);
1256 if (self
->settings
.dce
& IRCOMM_DSR
) {
1257 seq_printf(m
, "%cDSR", sep
);
1260 if (self
->settings
.dce
& IRCOMM_CD
) {
1261 seq_printf(m
, "%cCD", sep
);
1264 if (self
->settings
.dce
& IRCOMM_RI
) {
1265 seq_printf(m
, "%cRI", sep
);
1270 seq_puts(m
, "Configuration: ");
1271 if (!self
->settings
.null_modem
)
1272 seq_puts(m
, "DTE <-> DCE\n");
1274 seq_puts(m
, "DTE <-> DTE (null modem emulation)\n");
1276 seq_printf(m
, "Data rate: %d\n", self
->settings
.data_rate
);
1278 seq_puts(m
, "Flow control:");
1280 if (self
->settings
.flow_control
& IRCOMM_XON_XOFF_IN
) {
1281 seq_printf(m
, "%cXON_XOFF_IN", sep
);
1284 if (self
->settings
.flow_control
& IRCOMM_XON_XOFF_OUT
) {
1285 seq_printf(m
, "%cXON_XOFF_OUT", sep
);
1288 if (self
->settings
.flow_control
& IRCOMM_RTS_CTS_IN
) {
1289 seq_printf(m
, "%cRTS_CTS_IN", sep
);
1292 if (self
->settings
.flow_control
& IRCOMM_RTS_CTS_OUT
) {
1293 seq_printf(m
, "%cRTS_CTS_OUT", sep
);
1296 if (self
->settings
.flow_control
& IRCOMM_DSR_DTR_IN
) {
1297 seq_printf(m
, "%cDSR_DTR_IN", sep
);
1300 if (self
->settings
.flow_control
& IRCOMM_DSR_DTR_OUT
) {
1301 seq_printf(m
, "%cDSR_DTR_OUT", sep
);
1304 if (self
->settings
.flow_control
& IRCOMM_ENQ_ACK_IN
) {
1305 seq_printf(m
, "%cENQ_ACK_IN", sep
);
1308 if (self
->settings
.flow_control
& IRCOMM_ENQ_ACK_OUT
) {
1309 seq_printf(m
, "%cENQ_ACK_OUT", sep
);
1314 seq_puts(m
, "Flags:");
1316 if (self
->port
.flags
& ASYNC_CTS_FLOW
) {
1317 seq_printf(m
, "%cASYNC_CTS_FLOW", sep
);
1320 if (self
->port
.flags
& ASYNC_CHECK_CD
) {
1321 seq_printf(m
, "%cASYNC_CHECK_CD", sep
);
1324 if (self
->port
.flags
& ASYNC_INITIALIZED
) {
1325 seq_printf(m
, "%cASYNC_INITIALIZED", sep
);
1328 if (self
->port
.flags
& ASYNC_LOW_LATENCY
) {
1329 seq_printf(m
, "%cASYNC_LOW_LATENCY", sep
);
1332 if (self
->port
.flags
& ASYNC_CLOSING
) {
1333 seq_printf(m
, "%cASYNC_CLOSING", sep
);
1336 if (self
->port
.flags
& ASYNC_NORMAL_ACTIVE
) {
1337 seq_printf(m
, "%cASYNC_NORMAL_ACTIVE", sep
);
1342 seq_printf(m
, "Role: %s\n", self
->client
? "client" : "server");
1343 seq_printf(m
, "Open count: %d\n", self
->port
.count
);
1344 seq_printf(m
, "Max data size: %d\n", self
->max_data_size
);
1345 seq_printf(m
, "Max header size: %d\n", self
->max_header_size
);
1347 tty
= tty_port_tty_get(&self
->port
);
1349 seq_printf(m
, "Hardware: %s\n",
1350 tty
->hw_stopped
? "Stopped" : "Running");
1355 static int ircomm_tty_proc_show(struct seq_file
*m
, void *v
)
1357 struct ircomm_tty_cb
*self
;
1358 unsigned long flags
;
1360 spin_lock_irqsave(&ircomm_tty
->hb_spinlock
, flags
);
1362 self
= (struct ircomm_tty_cb
*) hashbin_get_first(ircomm_tty
);
1363 while (self
!= NULL
) {
1364 if (self
->magic
!= IRCOMM_TTY_MAGIC
)
1367 ircomm_tty_line_info(self
, m
);
1368 self
= (struct ircomm_tty_cb
*) hashbin_get_next(ircomm_tty
);
1370 spin_unlock_irqrestore(&ircomm_tty
->hb_spinlock
, flags
);
1374 static int ircomm_tty_proc_open(struct inode
*inode
, struct file
*file
)
1376 return single_open(file
, ircomm_tty_proc_show
, NULL
);
1379 static const struct file_operations ircomm_tty_proc_fops
= {
1380 .owner
= THIS_MODULE
,
1381 .open
= ircomm_tty_proc_open
,
1383 .llseek
= seq_lseek
,
1384 .release
= single_release
,
1386 #endif /* CONFIG_PROC_FS */
1388 MODULE_AUTHOR("Dag Brattli <dagb@cs.uit.no>");
1389 MODULE_DESCRIPTION("IrCOMM serial TTY driver");
1390 MODULE_LICENSE("GPL");
1391 MODULE_ALIAS_CHARDEV_MAJOR(IRCOMM_TTY_MAJOR
);
1393 module_init(ircomm_tty_init
);
1394 module_exit(ircomm_tty_cleanup
);