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, see <http://www.gnu.org/licenses/>.
29 ********************************************************************/
31 #include <linux/init.h>
32 #include <linux/module.h>
34 #include <linux/slab.h>
35 #include <linux/sched.h>
36 #include <linux/seq_file.h>
37 #include <linux/termios.h>
38 #include <linux/tty.h>
39 #include <linux/tty_flip.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_install(struct tty_driver
*driver
,
54 struct tty_struct
*tty
);
55 static int ircomm_tty_open(struct tty_struct
*tty
, struct file
*filp
);
56 static void ircomm_tty_close(struct tty_struct
* tty
, struct file
*filp
);
57 static int ircomm_tty_write(struct tty_struct
* tty
,
58 const unsigned char *buf
, int count
);
59 static int ircomm_tty_write_room(struct tty_struct
*tty
);
60 static void ircomm_tty_throttle(struct tty_struct
*tty
);
61 static void ircomm_tty_unthrottle(struct tty_struct
*tty
);
62 static int ircomm_tty_chars_in_buffer(struct tty_struct
*tty
);
63 static void ircomm_tty_flush_buffer(struct tty_struct
*tty
);
64 static void ircomm_tty_send_xchar(struct tty_struct
*tty
, char ch
);
65 static void ircomm_tty_wait_until_sent(struct tty_struct
*tty
, int timeout
);
66 static void ircomm_tty_hangup(struct tty_struct
*tty
);
67 static void ircomm_tty_do_softint(struct work_struct
*work
);
68 static void ircomm_tty_shutdown(struct ircomm_tty_cb
*self
);
69 static void ircomm_tty_stop(struct tty_struct
*tty
);
71 static int ircomm_tty_data_indication(void *instance
, void *sap
,
73 static int ircomm_tty_control_indication(void *instance
, void *sap
,
75 static void ircomm_tty_flow_indication(void *instance
, void *sap
,
78 static const struct file_operations ircomm_tty_proc_fops
;
79 #endif /* CONFIG_PROC_FS */
80 static struct tty_driver
*driver
;
82 static hashbin_t
*ircomm_tty
= NULL
;
84 static const struct tty_operations ops
= {
85 .install
= ircomm_tty_install
,
86 .open
= ircomm_tty_open
,
87 .close
= ircomm_tty_close
,
88 .write
= ircomm_tty_write
,
89 .write_room
= ircomm_tty_write_room
,
90 .chars_in_buffer
= ircomm_tty_chars_in_buffer
,
91 .flush_buffer
= ircomm_tty_flush_buffer
,
92 .ioctl
= ircomm_tty_ioctl
, /* ircomm_tty_ioctl.c */
93 .tiocmget
= ircomm_tty_tiocmget
, /* ircomm_tty_ioctl.c */
94 .tiocmset
= ircomm_tty_tiocmset
, /* ircomm_tty_ioctl.c */
95 .throttle
= ircomm_tty_throttle
,
96 .unthrottle
= ircomm_tty_unthrottle
,
97 .send_xchar
= ircomm_tty_send_xchar
,
98 .set_termios
= ircomm_tty_set_termios
,
99 .stop
= ircomm_tty_stop
,
100 .start
= ircomm_tty_start
,
101 .hangup
= ircomm_tty_hangup
,
102 .wait_until_sent
= ircomm_tty_wait_until_sent
,
103 #ifdef CONFIG_PROC_FS
104 .proc_fops
= &ircomm_tty_proc_fops
,
105 #endif /* CONFIG_PROC_FS */
108 static void ircomm_port_raise_dtr_rts(struct tty_port
*port
, int raise
)
110 struct ircomm_tty_cb
*self
= container_of(port
, struct ircomm_tty_cb
,
113 * Here, we use to lock those two guys, but as ircomm_param_request()
114 * does it itself, I don't see the point (and I see the deadlock).
118 self
->settings
.dte
|= IRCOMM_RTS
| IRCOMM_DTR
;
120 self
->settings
.dte
&= ~(IRCOMM_RTS
| IRCOMM_DTR
);
122 ircomm_param_request(self
, IRCOMM_DTE
, TRUE
);
125 static int ircomm_port_carrier_raised(struct tty_port
*port
)
127 struct ircomm_tty_cb
*self
= container_of(port
, struct ircomm_tty_cb
,
129 return self
->settings
.dce
& IRCOMM_CD
;
132 static const struct tty_port_operations ircomm_port_ops
= {
133 .dtr_rts
= ircomm_port_raise_dtr_rts
,
134 .carrier_raised
= ircomm_port_carrier_raised
,
138 * Function ircomm_tty_init()
140 * Init IrCOMM TTY layer/driver
143 static int __init
ircomm_tty_init(void)
145 driver
= alloc_tty_driver(IRCOMM_TTY_PORTS
);
148 ircomm_tty
= hashbin_new(HB_LOCK
);
149 if (ircomm_tty
== NULL
) {
150 IRDA_ERROR("%s(), can't allocate hashbin!\n", __func__
);
151 put_tty_driver(driver
);
155 driver
->driver_name
= "ircomm";
156 driver
->name
= "ircomm";
157 driver
->major
= IRCOMM_TTY_MAJOR
;
158 driver
->minor_start
= IRCOMM_TTY_MINOR
;
159 driver
->type
= TTY_DRIVER_TYPE_SERIAL
;
160 driver
->subtype
= SERIAL_TYPE_NORMAL
;
161 driver
->init_termios
= tty_std_termios
;
162 driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
| HUPCL
| CLOCAL
;
163 driver
->flags
= TTY_DRIVER_REAL_RAW
;
164 tty_set_operations(driver
, &ops
);
165 if (tty_register_driver(driver
)) {
166 IRDA_ERROR("%s(): Couldn't register serial driver\n",
168 put_tty_driver(driver
);
174 static void __exit
__ircomm_tty_cleanup(struct ircomm_tty_cb
*self
)
176 IRDA_DEBUG(0, "%s()\n", __func__
);
178 IRDA_ASSERT(self
!= NULL
, return;);
179 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
181 ircomm_tty_shutdown(self
);
184 tty_port_destroy(&self
->port
);
189 * Function ircomm_tty_cleanup ()
191 * Remove IrCOMM TTY layer/driver
194 static void __exit
ircomm_tty_cleanup(void)
198 IRDA_DEBUG(4, "%s()\n", __func__
);
200 ret
= tty_unregister_driver(driver
);
202 IRDA_ERROR("%s(), failed to unregister driver\n",
207 hashbin_delete(ircomm_tty
, (FREE_FUNC
) __ircomm_tty_cleanup
);
208 put_tty_driver(driver
);
212 * Function ircomm_startup (self)
217 static int ircomm_tty_startup(struct ircomm_tty_cb
*self
)
222 IRDA_DEBUG(2, "%s()\n", __func__
);
224 IRDA_ASSERT(self
!= NULL
, return -1;);
225 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
227 /* Check if already open */
228 if (test_and_set_bit(ASYNCB_INITIALIZED
, &self
->port
.flags
)) {
229 IRDA_DEBUG(2, "%s(), already open so break out!\n", __func__
);
233 /* Register with IrCOMM */
234 irda_notify_init(¬ify
);
235 /* These callbacks we must handle ourselves */
236 notify
.data_indication
= ircomm_tty_data_indication
;
237 notify
.udata_indication
= ircomm_tty_control_indication
;
238 notify
.flow_indication
= ircomm_tty_flow_indication
;
240 /* Use the ircomm_tty interface for these ones */
241 notify
.disconnect_indication
= ircomm_tty_disconnect_indication
;
242 notify
.connect_confirm
= ircomm_tty_connect_confirm
;
243 notify
.connect_indication
= ircomm_tty_connect_indication
;
244 strlcpy(notify
.name
, "ircomm_tty", sizeof(notify
.name
));
245 notify
.instance
= self
;
248 self
->ircomm
= ircomm_open(¬ify
, self
->service_type
,
254 self
->slsap_sel
= self
->ircomm
->slsap_sel
;
256 /* Connect IrCOMM link with remote device */
257 ret
= ircomm_tty_attach_cable(self
);
259 IRDA_ERROR("%s(), error attaching cable!\n", __func__
);
265 clear_bit(ASYNCB_INITIALIZED
, &self
->port
.flags
);
270 * Function ircomm_block_til_ready (self, filp)
275 static int ircomm_tty_block_til_ready(struct ircomm_tty_cb
*self
,
276 struct tty_struct
*tty
, struct file
*filp
)
278 struct tty_port
*port
= &self
->port
;
279 DECLARE_WAITQUEUE(wait
, current
);
284 IRDA_DEBUG(2, "%s()\n", __func__
);
287 * If non-blocking mode is set, or the port is not enabled,
288 * then make the check up front and then exit.
290 if (test_bit(TTY_IO_ERROR
, &tty
->flags
)) {
291 port
->flags
|= ASYNC_NORMAL_ACTIVE
;
295 if (filp
->f_flags
& O_NONBLOCK
) {
296 /* nonblock mode is set */
297 if (tty
->termios
.c_cflag
& CBAUD
)
298 tty_port_raise_dtr_rts(port
);
299 port
->flags
|= ASYNC_NORMAL_ACTIVE
;
300 IRDA_DEBUG(1, "%s(), O_NONBLOCK requested!\n", __func__
);
304 if (tty
->termios
.c_cflag
& CLOCAL
) {
305 IRDA_DEBUG(1, "%s(), doing CLOCAL!\n", __func__
);
309 /* Wait for carrier detect and the line to become
310 * free (i.e., not in use by the callout). While we are in
311 * this loop, port->count is dropped by one, so that
312 * mgsl_close() knows when to free things. We restore it upon
313 * exit, either normal or abnormal.
317 add_wait_queue(&port
->open_wait
, &wait
);
319 IRDA_DEBUG(2, "%s(%d):block_til_ready before block on %s open_count=%d\n",
320 __FILE__
, __LINE__
, tty
->driver
->name
, port
->count
);
322 spin_lock_irqsave(&port
->lock
, flags
);
324 port
->blocked_open
++;
325 spin_unlock_irqrestore(&port
->lock
, flags
);
328 if (C_BAUD(tty
) && test_bit(ASYNCB_INITIALIZED
, &port
->flags
))
329 tty_port_raise_dtr_rts(port
);
331 set_current_state(TASK_INTERRUPTIBLE
);
333 if (tty_hung_up_p(filp
) ||
334 !test_bit(ASYNCB_INITIALIZED
, &port
->flags
)) {
335 retval
= (port
->flags
& ASYNC_HUP_NOTIFY
) ?
336 -EAGAIN
: -ERESTARTSYS
;
341 * Check if link is ready now. Even if CLOCAL is
342 * specified, we cannot return before the IrCOMM link is
345 if (!test_bit(ASYNCB_CLOSING
, &port
->flags
) &&
346 (do_clocal
|| tty_port_carrier_raised(port
)) &&
347 self
->state
== IRCOMM_TTY_READY
)
352 if (signal_pending(current
)) {
353 retval
= -ERESTARTSYS
;
357 IRDA_DEBUG(1, "%s(%d):block_til_ready blocking on %s open_count=%d\n",
358 __FILE__
, __LINE__
, tty
->driver
->name
, port
->count
);
363 __set_current_state(TASK_RUNNING
);
364 remove_wait_queue(&port
->open_wait
, &wait
);
366 spin_lock_irqsave(&port
->lock
, flags
);
367 if (!tty_hung_up_p(filp
))
369 port
->blocked_open
--;
370 spin_unlock_irqrestore(&port
->lock
, flags
);
372 IRDA_DEBUG(1, "%s(%d):block_til_ready after blocking on %s open_count=%d\n",
373 __FILE__
, __LINE__
, tty
->driver
->name
, port
->count
);
376 port
->flags
|= ASYNC_NORMAL_ACTIVE
;
382 static int ircomm_tty_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
384 struct ircomm_tty_cb
*self
;
385 unsigned int line
= tty
->index
;
387 /* Check if instance already exists */
388 self
= hashbin_lock_find(ircomm_tty
, line
, NULL
);
390 /* No, so make new instance */
391 self
= kzalloc(sizeof(struct ircomm_tty_cb
), GFP_KERNEL
);
393 IRDA_ERROR("%s(), kmalloc failed!\n", __func__
);
397 tty_port_init(&self
->port
);
398 self
->port
.ops
= &ircomm_port_ops
;
399 self
->magic
= IRCOMM_TTY_MAGIC
;
400 self
->flow
= FLOW_STOP
;
403 INIT_WORK(&self
->tqueue
, ircomm_tty_do_softint
);
404 self
->max_header_size
= IRCOMM_TTY_HDR_UNINITIALISED
;
405 self
->max_data_size
= IRCOMM_TTY_DATA_UNINITIALISED
;
407 /* Init some important stuff */
408 init_timer(&self
->watchdog_timer
);
409 spin_lock_init(&self
->spinlock
);
412 * Force TTY into raw mode by default which is usually what
413 * we want for IrCOMM and IrLPT. This way applications will
414 * not have to twiddle with printcap etc.
416 * Note this is completely usafe and doesn't work properly
418 tty
->termios
.c_iflag
= 0;
419 tty
->termios
.c_oflag
= 0;
421 /* Insert into hash */
422 hashbin_insert(ircomm_tty
, (irda_queue_t
*) self
, line
, NULL
);
425 tty
->driver_data
= self
;
427 return tty_port_install(&self
->port
, driver
, tty
);
431 * Function ircomm_tty_open (tty, filp)
433 * This routine is called when a particular tty device is opened. This
434 * routine is mandatory; if this routine is not filled in, the attempted
435 * open will fail with ENODEV.
437 static int ircomm_tty_open(struct tty_struct
*tty
, struct file
*filp
)
439 struct ircomm_tty_cb
*self
= tty
->driver_data
;
443 IRDA_DEBUG(2, "%s()\n", __func__
);
445 /* ++ is not atomic, so this should be protected - Jean II */
446 spin_lock_irqsave(&self
->port
.lock
, flags
);
448 spin_unlock_irqrestore(&self
->port
.lock
, flags
);
449 tty_port_tty_set(&self
->port
, tty
);
451 IRDA_DEBUG(1, "%s(), %s%d, count = %d\n", __func__
, tty
->driver
->name
,
452 self
->line
, self
->port
.count
);
454 /* Not really used by us, but lets do it anyway */
455 self
->port
.low_latency
= (self
->port
.flags
& ASYNC_LOW_LATENCY
) ? 1 : 0;
458 * If the port is the middle of closing, bail out now
460 if (test_bit(ASYNCB_CLOSING
, &self
->port
.flags
)) {
462 /* Hm, why are we blocking on ASYNC_CLOSING if we
463 * do return -EAGAIN/-ERESTARTSYS below anyway?
464 * IMHO it's either not needed in the first place
465 * or for some reason we need to make sure the async
466 * closing has been finished - if so, wouldn't we
467 * probably better sleep uninterruptible?
470 if (wait_event_interruptible(self
->port
.close_wait
,
471 !test_bit(ASYNCB_CLOSING
, &self
->port
.flags
))) {
472 IRDA_WARNING("%s - got signal while blocking on ASYNC_CLOSING!\n",
477 #ifdef SERIAL_DO_RESTART
478 return (self
->port
.flags
& ASYNC_HUP_NOTIFY
) ?
479 -EAGAIN
: -ERESTARTSYS
;
485 /* Check if this is a "normal" ircomm device, or an irlpt device */
486 if (self
->line
< 0x10) {
487 self
->service_type
= IRCOMM_3_WIRE
| IRCOMM_9_WIRE
;
488 self
->settings
.service_type
= IRCOMM_9_WIRE
; /* 9 wire as default */
489 /* Jan Kiszka -> add DSR/RI -> Conform to IrCOMM spec */
490 self
->settings
.dce
= IRCOMM_CTS
| IRCOMM_CD
| IRCOMM_DSR
| IRCOMM_RI
; /* Default line settings */
491 IRDA_DEBUG(2, "%s(), IrCOMM device\n", __func__
);
493 IRDA_DEBUG(2, "%s(), IrLPT device\n", __func__
);
494 self
->service_type
= IRCOMM_3_WIRE_RAW
;
495 self
->settings
.service_type
= IRCOMM_3_WIRE_RAW
; /* Default */
498 ret
= ircomm_tty_startup(self
);
502 ret
= ircomm_tty_block_til_ready(self
, tty
, filp
);
505 "%s(), returning after block_til_ready with %d\n", __func__
,
514 * Function ircomm_tty_close (tty, filp)
516 * This routine is called when a particular tty device is closed.
519 static void ircomm_tty_close(struct tty_struct
*tty
, struct file
*filp
)
521 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
522 struct tty_port
*port
= &self
->port
;
524 IRDA_DEBUG(0, "%s()\n", __func__
);
526 IRDA_ASSERT(self
!= NULL
, return;);
527 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
529 if (tty_port_close_start(port
, tty
, filp
) == 0)
532 ircomm_tty_shutdown(self
);
534 tty_driver_flush_buffer(tty
);
536 tty_port_close_end(port
, tty
);
537 tty_port_tty_set(port
, NULL
);
541 * Function ircomm_tty_flush_buffer (tty)
546 static void ircomm_tty_flush_buffer(struct tty_struct
*tty
)
548 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
550 IRDA_ASSERT(self
!= NULL
, return;);
551 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
554 * Let do_softint() do this to avoid race condition with
557 schedule_work(&self
->tqueue
);
561 * Function ircomm_tty_do_softint (work)
563 * We use this routine to give the write wakeup to the user at at a
564 * safe time (as fast as possible after write have completed). This
565 * can be compared to the Tx interrupt.
567 static void ircomm_tty_do_softint(struct work_struct
*work
)
569 struct ircomm_tty_cb
*self
=
570 container_of(work
, struct ircomm_tty_cb
, tqueue
);
571 struct tty_struct
*tty
;
573 struct sk_buff
*skb
, *ctrl_skb
;
575 IRDA_DEBUG(2, "%s()\n", __func__
);
577 if (!self
|| self
->magic
!= IRCOMM_TTY_MAGIC
)
580 tty
= tty_port_tty_get(&self
->port
);
584 /* Unlink control buffer */
585 spin_lock_irqsave(&self
->spinlock
, flags
);
587 ctrl_skb
= self
->ctrl_skb
;
588 self
->ctrl_skb
= NULL
;
590 spin_unlock_irqrestore(&self
->spinlock
, flags
);
592 /* Flush control buffer if any */
594 if(self
->flow
== FLOW_START
)
595 ircomm_control_request(self
->ircomm
, ctrl_skb
);
596 /* Drop reference count - see ircomm_ttp_data_request(). */
597 dev_kfree_skb(ctrl_skb
);
603 /* Unlink transmit buffer */
604 spin_lock_irqsave(&self
->spinlock
, flags
);
609 spin_unlock_irqrestore(&self
->spinlock
, flags
);
611 /* Flush transmit buffer if any */
613 ircomm_tty_do_event(self
, IRCOMM_TTY_DATA_REQUEST
, skb
, NULL
);
614 /* Drop reference count - see ircomm_ttp_data_request(). */
618 /* Check if user (still) wants to be waken up */
625 * Function ircomm_tty_write (tty, buf, count)
627 * This routine is called by the kernel to write a series of characters
628 * to the tty device. The characters may come from user space or kernel
629 * space. This routine will return the number of characters actually
630 * accepted for writing. This routine is mandatory.
632 static int ircomm_tty_write(struct tty_struct
*tty
,
633 const unsigned char *buf
, int count
)
635 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
642 IRDA_DEBUG(2, "%s(), count=%d, hw_stopped=%d\n", __func__
, count
,
645 IRDA_ASSERT(self
!= NULL
, return -1;);
646 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
648 /* We may receive packets from the TTY even before we have finished
649 * our setup. Not cool.
650 * The problem is that we don't know the final header and data size
651 * to create the proper skb, so any skb we would create would have
652 * bogus header and data size, so need care.
653 * We use a bogus header size to safely detect this condition.
654 * Another problem is that hw_stopped was set to 0 way before it
655 * should be, so we would drop this skb. It should now be fixed.
656 * One option is to not accept data until we are properly setup.
657 * But, I suspect that when it happens, the ppp line discipline
658 * just "drops" the data, which might screw up connect scripts.
659 * The second option is to create a "safe skb", with large header
660 * and small size (see ircomm_tty_open() for values).
661 * We just need to make sure that when the real values get filled,
662 * we don't mess up the original "safe skb" (see tx_data_size).
664 if (self
->max_header_size
== IRCOMM_TTY_HDR_UNINITIALISED
) {
665 IRDA_DEBUG(1, "%s() : not initialised\n", __func__
);
666 #ifdef IRCOMM_NO_TX_BEFORE_INIT
667 /* We didn't consume anything, TTY will retry */
675 /* Protect our manipulation of self->tx_skb and related */
676 spin_lock_irqsave(&self
->spinlock
, flags
);
678 /* Fetch current transmit buffer */
682 * Send out all the data we get, possibly as multiple fragmented
683 * frames, but this will only happen if the data is larger than the
684 * max data size. The normal case however is just the opposite, and
685 * this function may be called multiple times, and will then actually
686 * defragment the data and send it out as one packet as soon as
687 * possible, but at a safer point in time
692 /* Adjust data size to the max data size */
693 if (size
> self
->max_data_size
)
694 size
= self
->max_data_size
;
697 * Do we already have a buffer ready for transmit, or do
698 * we need to allocate a new frame
702 * Any room for more data at the end of the current
703 * transmit buffer? Cannot use skb_tailroom, since
704 * dev_alloc_skb gives us a larger skb than we
706 * Note : use tx_data_size, because max_data_size
707 * may have changed and we don't want to overwrite
710 if ((tailroom
= (self
->tx_data_size
- skb
->len
)) > 0) {
711 /* Adjust data to tailroom */
716 * Current transmit frame is full, so break
717 * out, so we can send it as soon as possible
722 /* Prepare a full sized frame */
723 skb
= alloc_skb(self
->max_data_size
+
724 self
->max_header_size
,
727 spin_unlock_irqrestore(&self
->spinlock
, flags
);
730 skb_reserve(skb
, self
->max_header_size
);
732 /* Remember skb size because max_data_size may
733 * change later on - Jean II */
734 self
->tx_data_size
= self
->max_data_size
;
738 memcpy(skb_put(skb
,size
), buf
+ len
, size
);
744 spin_unlock_irqrestore(&self
->spinlock
, flags
);
747 * Schedule a new thread which will transmit the frame as soon
748 * as possible, but at a safe point in time. We do this so the
749 * "user" can give us data multiple times, as PPP does (because of
750 * its 256 byte tx buffer). We will then defragment and send out
751 * all this data as one single packet.
753 schedule_work(&self
->tqueue
);
759 * Function ircomm_tty_write_room (tty)
761 * This routine returns the numbers of characters the tty driver will
762 * accept for queuing to be written. This number is subject to change as
763 * output buffers get emptied, or if the output flow control is acted.
765 static int ircomm_tty_write_room(struct tty_struct
*tty
)
767 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
771 IRDA_ASSERT(self
!= NULL
, return -1;);
772 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
774 #ifdef IRCOMM_NO_TX_BEFORE_INIT
775 /* max_header_size tells us if the channel is initialised or not. */
776 if (self
->max_header_size
== IRCOMM_TTY_HDR_UNINITIALISED
)
777 /* Don't bother us yet */
781 /* Check if we are allowed to transmit any data.
782 * hw_stopped is the regular flow control.
787 spin_lock_irqsave(&self
->spinlock
, flags
);
789 ret
= self
->tx_data_size
- self
->tx_skb
->len
;
791 ret
= self
->max_data_size
;
792 spin_unlock_irqrestore(&self
->spinlock
, flags
);
794 IRDA_DEBUG(2, "%s(), ret=%d\n", __func__
, ret
);
800 * Function ircomm_tty_wait_until_sent (tty, timeout)
802 * This routine waits until the device has written out all of the
803 * characters in its transmitter FIFO.
805 static void ircomm_tty_wait_until_sent(struct tty_struct
*tty
, int timeout
)
807 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
808 unsigned long orig_jiffies
, poll_time
;
811 IRDA_DEBUG(2, "%s()\n", __func__
);
813 IRDA_ASSERT(self
!= NULL
, return;);
814 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
816 orig_jiffies
= jiffies
;
818 /* Set poll time to 200 ms */
819 poll_time
= IRDA_MIN(timeout
, msecs_to_jiffies(200));
821 spin_lock_irqsave(&self
->spinlock
, flags
);
822 while (self
->tx_skb
&& self
->tx_skb
->len
) {
823 spin_unlock_irqrestore(&self
->spinlock
, flags
);
824 schedule_timeout_interruptible(poll_time
);
825 spin_lock_irqsave(&self
->spinlock
, flags
);
826 if (signal_pending(current
))
828 if (timeout
&& time_after(jiffies
, orig_jiffies
+ timeout
))
831 spin_unlock_irqrestore(&self
->spinlock
, flags
);
832 current
->state
= TASK_RUNNING
;
836 * Function ircomm_tty_throttle (tty)
838 * This routine notifies the tty driver that input buffers for the line
839 * discipline are close to full, and it should somehow signal that no
840 * more characters should be sent to the tty.
842 static void ircomm_tty_throttle(struct tty_struct
*tty
)
844 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
846 IRDA_DEBUG(2, "%s()\n", __func__
);
848 IRDA_ASSERT(self
!= NULL
, return;);
849 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
851 /* Software flow control? */
853 ircomm_tty_send_xchar(tty
, STOP_CHAR(tty
));
855 /* Hardware flow control? */
856 if (tty
->termios
.c_cflag
& CRTSCTS
) {
857 self
->settings
.dte
&= ~IRCOMM_RTS
;
858 self
->settings
.dte
|= IRCOMM_DELTA_RTS
;
860 ircomm_param_request(self
, IRCOMM_DTE
, TRUE
);
863 ircomm_flow_request(self
->ircomm
, FLOW_STOP
);
867 * Function ircomm_tty_unthrottle (tty)
869 * This routine notifies the tty drivers that it should signals that
870 * characters can now be sent to the tty without fear of overrunning the
871 * input buffers of the line disciplines.
873 static void ircomm_tty_unthrottle(struct tty_struct
*tty
)
875 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
877 IRDA_DEBUG(2, "%s()\n", __func__
);
879 IRDA_ASSERT(self
!= NULL
, return;);
880 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
882 /* Using software flow control? */
884 ircomm_tty_send_xchar(tty
, START_CHAR(tty
));
887 /* Using hardware flow control? */
888 if (tty
->termios
.c_cflag
& CRTSCTS
) {
889 self
->settings
.dte
|= (IRCOMM_RTS
|IRCOMM_DELTA_RTS
);
891 ircomm_param_request(self
, IRCOMM_DTE
, TRUE
);
892 IRDA_DEBUG(1, "%s(), FLOW_START\n", __func__
);
894 ircomm_flow_request(self
->ircomm
, FLOW_START
);
898 * Function ircomm_tty_chars_in_buffer (tty)
900 * Indicates if there are any data in the buffer
903 static int ircomm_tty_chars_in_buffer(struct tty_struct
*tty
)
905 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
909 IRDA_ASSERT(self
!= NULL
, return -1;);
910 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
912 spin_lock_irqsave(&self
->spinlock
, flags
);
915 len
= self
->tx_skb
->len
;
917 spin_unlock_irqrestore(&self
->spinlock
, flags
);
922 static void ircomm_tty_shutdown(struct ircomm_tty_cb
*self
)
926 IRDA_ASSERT(self
!= NULL
, return;);
927 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
929 IRDA_DEBUG(0, "%s()\n", __func__
);
931 if (!test_and_clear_bit(ASYNCB_INITIALIZED
, &self
->port
.flags
))
934 ircomm_tty_detach_cable(self
);
936 spin_lock_irqsave(&self
->spinlock
, flags
);
938 del_timer(&self
->watchdog_timer
);
940 /* Free parameter buffer */
941 if (self
->ctrl_skb
) {
942 dev_kfree_skb(self
->ctrl_skb
);
943 self
->ctrl_skb
= NULL
;
946 /* Free transmit buffer */
948 dev_kfree_skb(self
->tx_skb
);
953 ircomm_close(self
->ircomm
);
957 spin_unlock_irqrestore(&self
->spinlock
, flags
);
961 * Function ircomm_tty_hangup (tty)
963 * This routine notifies the tty driver that it should hangup the tty
967 static void ircomm_tty_hangup(struct tty_struct
*tty
)
969 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
970 struct tty_port
*port
= &self
->port
;
973 IRDA_DEBUG(0, "%s()\n", __func__
);
975 IRDA_ASSERT(self
!= NULL
, return;);
976 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
978 /* ircomm_tty_flush_buffer(tty); */
979 ircomm_tty_shutdown(self
);
981 spin_lock_irqsave(&port
->lock
, flags
);
982 port
->flags
&= ~ASYNC_NORMAL_ACTIVE
;
984 set_bit(TTY_IO_ERROR
, &port
->tty
->flags
);
985 tty_kref_put(port
->tty
);
989 spin_unlock_irqrestore(&port
->lock
, flags
);
991 wake_up_interruptible(&port
->open_wait
);
995 * Function ircomm_tty_send_xchar (tty, ch)
997 * This routine is used to send a high-priority XON/XOFF character to
1000 static void ircomm_tty_send_xchar(struct tty_struct
*tty
, char ch
)
1002 IRDA_DEBUG(0, "%s(), not impl\n", __func__
);
1006 * Function ircomm_tty_start (tty)
1008 * This routine notifies the tty driver that it resume sending
1009 * characters to the tty device.
1011 void ircomm_tty_start(struct tty_struct
*tty
)
1013 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
1015 ircomm_flow_request(self
->ircomm
, FLOW_START
);
1019 * Function ircomm_tty_stop (tty)
1021 * This routine notifies the tty driver that it should stop outputting
1022 * characters to the tty device.
1024 static void ircomm_tty_stop(struct tty_struct
*tty
)
1026 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) tty
->driver_data
;
1028 IRDA_ASSERT(self
!= NULL
, return;);
1029 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
1031 ircomm_flow_request(self
->ircomm
, FLOW_STOP
);
1035 * Function ircomm_check_modem_status (self)
1037 * Check for any changes in the DCE's line settings. This function should
1038 * be called whenever the dce parameter settings changes, to update the
1039 * flow control settings and other things
1041 void ircomm_tty_check_modem_status(struct ircomm_tty_cb
*self
)
1043 struct tty_struct
*tty
;
1046 IRDA_DEBUG(0, "%s()\n", __func__
);
1048 IRDA_ASSERT(self
!= NULL
, return;);
1049 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
1051 tty
= tty_port_tty_get(&self
->port
);
1053 status
= self
->settings
.dce
;
1055 if (status
& IRCOMM_DCE_DELTA_ANY
) {
1056 /*wake_up_interruptible(&self->delta_msr_wait);*/
1058 if ((self
->port
.flags
& ASYNC_CHECK_CD
) && (status
& IRCOMM_DELTA_CD
)) {
1060 "%s(), ircomm%d CD now %s...\n", __func__
, self
->line
,
1061 (status
& IRCOMM_CD
) ? "on" : "off");
1063 if (status
& IRCOMM_CD
) {
1064 wake_up_interruptible(&self
->port
.open_wait
);
1067 "%s(), Doing serial hangup..\n", __func__
);
1071 /* Hangup will remote the tty, so better break out */
1075 if (tty
&& tty_port_cts_enabled(&self
->port
)) {
1076 if (tty
->hw_stopped
) {
1077 if (status
& IRCOMM_CTS
) {
1079 "%s(), CTS tx start...\n", __func__
);
1080 tty
->hw_stopped
= 0;
1082 /* Wake up processes blocked on open */
1083 wake_up_interruptible(&self
->port
.open_wait
);
1085 schedule_work(&self
->tqueue
);
1089 if (!(status
& IRCOMM_CTS
)) {
1091 "%s(), CTS tx stop...\n", __func__
);
1092 tty
->hw_stopped
= 1;
1101 * Function ircomm_tty_data_indication (instance, sap, skb)
1103 * Handle incoming data, and deliver it to the line discipline
1106 static int ircomm_tty_data_indication(void *instance
, void *sap
,
1107 struct sk_buff
*skb
)
1109 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) instance
;
1110 struct tty_struct
*tty
;
1112 IRDA_DEBUG(2, "%s()\n", __func__
);
1114 IRDA_ASSERT(self
!= NULL
, return -1;);
1115 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
1116 IRDA_ASSERT(skb
!= NULL
, return -1;);
1118 tty
= tty_port_tty_get(&self
->port
);
1120 IRDA_DEBUG(0, "%s(), no tty!\n", __func__
);
1125 * If we receive data when hardware is stopped then something is wrong.
1126 * We try to poll the peers line settings to check if we are up todate.
1127 * Devices like WinCE can do this, and since they don't send any
1128 * params, we can just as well declare the hardware for running.
1130 if (tty
->hw_stopped
&& (self
->flow
== FLOW_START
)) {
1131 IRDA_DEBUG(0, "%s(), polling for line settings!\n", __func__
);
1132 ircomm_param_request(self
, IRCOMM_POLL
, TRUE
);
1134 /* We can just as well declare the hardware for running */
1135 ircomm_tty_send_initial_parameters(self
);
1136 ircomm_tty_link_established(self
);
1141 * Use flip buffer functions since the code may be called from interrupt
1144 tty_insert_flip_string(&self
->port
, skb
->data
, skb
->len
);
1145 tty_flip_buffer_push(&self
->port
);
1147 /* No need to kfree_skb - see ircomm_ttp_data_indication() */
1153 * Function ircomm_tty_control_indication (instance, sap, skb)
1155 * Parse all incoming parameters (easy!)
1158 static int ircomm_tty_control_indication(void *instance
, void *sap
,
1159 struct sk_buff
*skb
)
1161 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) instance
;
1164 IRDA_DEBUG(4, "%s()\n", __func__
);
1166 IRDA_ASSERT(self
!= NULL
, return -1;);
1167 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return -1;);
1168 IRDA_ASSERT(skb
!= NULL
, return -1;);
1170 clen
= skb
->data
[0];
1172 irda_param_extract_all(self
, skb
->data
+1, IRDA_MIN(skb
->len
-1, clen
),
1173 &ircomm_param_info
);
1175 /* No need to kfree_skb - see ircomm_control_indication() */
1181 * Function ircomm_tty_flow_indication (instance, sap, cmd)
1183 * This function is called by IrTTP when it wants us to slow down the
1184 * transmission of data. We just mark the hardware as stopped, and wait
1185 * for IrTTP to notify us that things are OK again.
1187 static void ircomm_tty_flow_indication(void *instance
, void *sap
,
1190 struct ircomm_tty_cb
*self
= (struct ircomm_tty_cb
*) instance
;
1191 struct tty_struct
*tty
;
1193 IRDA_ASSERT(self
!= NULL
, return;);
1194 IRDA_ASSERT(self
->magic
== IRCOMM_TTY_MAGIC
, return;);
1196 tty
= tty_port_tty_get(&self
->port
);
1200 IRDA_DEBUG(2, "%s(), hw start!\n", __func__
);
1202 tty
->hw_stopped
= 0;
1204 /* ircomm_tty_do_softint will take care of the rest */
1205 schedule_work(&self
->tqueue
);
1207 default: /* If we get here, something is very wrong, better stop */
1209 IRDA_DEBUG(2, "%s(), hw stopped!\n", __func__
);
1211 tty
->hw_stopped
= 1;
1219 #ifdef CONFIG_PROC_FS
1220 static void ircomm_tty_line_info(struct ircomm_tty_cb
*self
, struct seq_file
*m
)
1222 struct tty_struct
*tty
;
1225 seq_printf(m
, "State: %s\n", ircomm_tty_state
[self
->state
]);
1227 seq_puts(m
, "Service type: ");
1228 if (self
->service_type
& IRCOMM_9_WIRE
)
1229 seq_puts(m
, "9_WIRE");
1230 else if (self
->service_type
& IRCOMM_3_WIRE
)
1231 seq_puts(m
, "3_WIRE");
1232 else if (self
->service_type
& IRCOMM_3_WIRE_RAW
)
1233 seq_puts(m
, "3_WIRE_RAW");
1235 seq_puts(m
, "No common service type!\n");
1238 seq_printf(m
, "Port name: %s\n", self
->settings
.port_name
);
1240 seq_printf(m
, "DTE status:");
1242 if (self
->settings
.dte
& IRCOMM_RTS
) {
1243 seq_printf(m
, "%cRTS", sep
);
1246 if (self
->settings
.dte
& IRCOMM_DTR
) {
1247 seq_printf(m
, "%cDTR", sep
);
1252 seq_puts(m
, "DCE status:");
1254 if (self
->settings
.dce
& IRCOMM_CTS
) {
1255 seq_printf(m
, "%cCTS", sep
);
1258 if (self
->settings
.dce
& IRCOMM_DSR
) {
1259 seq_printf(m
, "%cDSR", sep
);
1262 if (self
->settings
.dce
& IRCOMM_CD
) {
1263 seq_printf(m
, "%cCD", sep
);
1266 if (self
->settings
.dce
& IRCOMM_RI
) {
1267 seq_printf(m
, "%cRI", sep
);
1272 seq_puts(m
, "Configuration: ");
1273 if (!self
->settings
.null_modem
)
1274 seq_puts(m
, "DTE <-> DCE\n");
1276 seq_puts(m
, "DTE <-> DTE (null modem emulation)\n");
1278 seq_printf(m
, "Data rate: %d\n", self
->settings
.data_rate
);
1280 seq_puts(m
, "Flow control:");
1282 if (self
->settings
.flow_control
& IRCOMM_XON_XOFF_IN
) {
1283 seq_printf(m
, "%cXON_XOFF_IN", sep
);
1286 if (self
->settings
.flow_control
& IRCOMM_XON_XOFF_OUT
) {
1287 seq_printf(m
, "%cXON_XOFF_OUT", sep
);
1290 if (self
->settings
.flow_control
& IRCOMM_RTS_CTS_IN
) {
1291 seq_printf(m
, "%cRTS_CTS_IN", sep
);
1294 if (self
->settings
.flow_control
& IRCOMM_RTS_CTS_OUT
) {
1295 seq_printf(m
, "%cRTS_CTS_OUT", sep
);
1298 if (self
->settings
.flow_control
& IRCOMM_DSR_DTR_IN
) {
1299 seq_printf(m
, "%cDSR_DTR_IN", sep
);
1302 if (self
->settings
.flow_control
& IRCOMM_DSR_DTR_OUT
) {
1303 seq_printf(m
, "%cDSR_DTR_OUT", sep
);
1306 if (self
->settings
.flow_control
& IRCOMM_ENQ_ACK_IN
) {
1307 seq_printf(m
, "%cENQ_ACK_IN", sep
);
1310 if (self
->settings
.flow_control
& IRCOMM_ENQ_ACK_OUT
) {
1311 seq_printf(m
, "%cENQ_ACK_OUT", sep
);
1316 seq_puts(m
, "Flags:");
1318 if (tty_port_cts_enabled(&self
->port
)) {
1319 seq_printf(m
, "%cASYNC_CTS_FLOW", sep
);
1322 if (self
->port
.flags
& ASYNC_CHECK_CD
) {
1323 seq_printf(m
, "%cASYNC_CHECK_CD", sep
);
1326 if (self
->port
.flags
& ASYNC_INITIALIZED
) {
1327 seq_printf(m
, "%cASYNC_INITIALIZED", sep
);
1330 if (self
->port
.flags
& ASYNC_LOW_LATENCY
) {
1331 seq_printf(m
, "%cASYNC_LOW_LATENCY", sep
);
1334 if (self
->port
.flags
& ASYNC_CLOSING
) {
1335 seq_printf(m
, "%cASYNC_CLOSING", sep
);
1338 if (self
->port
.flags
& ASYNC_NORMAL_ACTIVE
) {
1339 seq_printf(m
, "%cASYNC_NORMAL_ACTIVE", sep
);
1344 seq_printf(m
, "Role: %s\n", self
->client
? "client" : "server");
1345 seq_printf(m
, "Open count: %d\n", self
->port
.count
);
1346 seq_printf(m
, "Max data size: %d\n", self
->max_data_size
);
1347 seq_printf(m
, "Max header size: %d\n", self
->max_header_size
);
1349 tty
= tty_port_tty_get(&self
->port
);
1351 seq_printf(m
, "Hardware: %s\n",
1352 tty
->hw_stopped
? "Stopped" : "Running");
1357 static int ircomm_tty_proc_show(struct seq_file
*m
, void *v
)
1359 struct ircomm_tty_cb
*self
;
1360 unsigned long flags
;
1362 spin_lock_irqsave(&ircomm_tty
->hb_spinlock
, flags
);
1364 self
= (struct ircomm_tty_cb
*) hashbin_get_first(ircomm_tty
);
1365 while (self
!= NULL
) {
1366 if (self
->magic
!= IRCOMM_TTY_MAGIC
)
1369 ircomm_tty_line_info(self
, m
);
1370 self
= (struct ircomm_tty_cb
*) hashbin_get_next(ircomm_tty
);
1372 spin_unlock_irqrestore(&ircomm_tty
->hb_spinlock
, flags
);
1376 static int ircomm_tty_proc_open(struct inode
*inode
, struct file
*file
)
1378 return single_open(file
, ircomm_tty_proc_show
, NULL
);
1381 static const struct file_operations ircomm_tty_proc_fops
= {
1382 .owner
= THIS_MODULE
,
1383 .open
= ircomm_tty_proc_open
,
1385 .llseek
= seq_lseek
,
1386 .release
= single_release
,
1388 #endif /* CONFIG_PROC_FS */
1390 MODULE_AUTHOR("Dag Brattli <dagb@cs.uit.no>");
1391 MODULE_DESCRIPTION("IrCOMM serial TTY driver");
1392 MODULE_LICENSE("GPL");
1393 MODULE_ALIAS_CHARDEV_MAJOR(IRCOMM_TTY_MAJOR
);
1395 module_init(ircomm_tty_init
);
1396 module_exit(ircomm_tty_cleanup
);