2 * interface to user space for the gigaset driver
4 * Copyright (c) 2004 by Hansjoerg Lipp <hjlipp@web.de>
6 * =====================================================================
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation; either version 2 of
10 * the License, or (at your option) any later version.
11 * =====================================================================
15 #include <linux/gigaset_dev.h>
16 #include <linux/tty_flip.h>
17 #include <linux/module.h>
21 static int if_lock(struct cardstate
*cs
, int *arg
)
25 gig_dbg(DEBUG_IF
, "%u: if_lock (%d)", cs
->minor_index
, cmd
);
31 *arg
= cs
->mstate
== MS_LOCKED
;
35 if (!cmd
&& cs
->mstate
== MS_LOCKED
&& cs
->connected
) {
36 cs
->ops
->set_modem_ctrl(cs
, 0, TIOCM_DTR
|TIOCM_RTS
);
37 cs
->ops
->baud_rate(cs
, B115200
);
38 cs
->ops
->set_line_ctrl(cs
, CS8
);
39 cs
->control_state
= TIOCM_DTR
|TIOCM_RTS
;
43 if (!gigaset_add_event(cs
, &cs
->at_state
, EV_IF_LOCK
,
48 gigaset_schedule_event(cs
);
50 wait_event(cs
->waitqueue
, !cs
->waiting
);
52 if (cs
->cmd_result
>= 0) {
53 *arg
= cs
->cmd_result
;
57 return cs
->cmd_result
;
60 static int if_version(struct cardstate
*cs
, unsigned arg
[4])
62 static const unsigned version
[4] = GIG_VERSION
;
63 static const unsigned compat
[4] = GIG_COMPAT
;
64 unsigned cmd
= arg
[0];
66 gig_dbg(DEBUG_IF
, "%u: if_version (%d)", cs
->minor_index
, cmd
);
70 memcpy(arg
, version
, sizeof version
);
73 memcpy(arg
, compat
, sizeof compat
);
77 if (!gigaset_add_event(cs
, &cs
->at_state
, EV_IF_VER
,
82 gigaset_schedule_event(cs
);
84 wait_event(cs
->waitqueue
, !cs
->waiting
);
86 if (cs
->cmd_result
>= 0)
89 return cs
->cmd_result
;
95 static int if_config(struct cardstate
*cs
, int *arg
)
97 gig_dbg(DEBUG_IF
, "%u: if_config (%d)", cs
->minor_index
, *arg
);
102 if (cs
->mstate
!= MS_LOCKED
)
105 if (!cs
->connected
) {
106 pr_err("%s: not connected\n", __func__
);
111 return gigaset_enterconfigmode(cs
);
114 /*** the terminal driver ***/
115 /* stolen from usbserial and some other tty drivers */
117 static int if_open(struct tty_struct
*tty
, struct file
*filp
);
118 static void if_close(struct tty_struct
*tty
, struct file
*filp
);
119 static int if_ioctl(struct tty_struct
*tty
,
120 unsigned int cmd
, unsigned long arg
);
121 static int if_write_room(struct tty_struct
*tty
);
122 static int if_chars_in_buffer(struct tty_struct
*tty
);
123 static void if_throttle(struct tty_struct
*tty
);
124 static void if_unthrottle(struct tty_struct
*tty
);
125 static void if_set_termios(struct tty_struct
*tty
, struct ktermios
*old
);
126 static int if_tiocmget(struct tty_struct
*tty
);
127 static int if_tiocmset(struct tty_struct
*tty
,
128 unsigned int set
, unsigned int clear
);
129 static int if_write(struct tty_struct
*tty
,
130 const unsigned char *buf
, int count
);
132 static const struct tty_operations if_ops
= {
137 .write_room
= if_write_room
,
138 .chars_in_buffer
= if_chars_in_buffer
,
139 .set_termios
= if_set_termios
,
140 .throttle
= if_throttle
,
141 .unthrottle
= if_unthrottle
,
142 .tiocmget
= if_tiocmget
,
143 .tiocmset
= if_tiocmset
,
146 static int if_open(struct tty_struct
*tty
, struct file
*filp
)
148 struct cardstate
*cs
;
151 gig_dbg(DEBUG_IF
, "%d+%d: %s()",
152 tty
->driver
->minor_start
, tty
->index
, __func__
);
154 tty
->driver_data
= NULL
;
156 cs
= gigaset_get_cs_by_tty(tty
);
157 if (!cs
|| !try_module_get(cs
->driver
->owner
))
160 if (mutex_lock_interruptible(&cs
->mutex
)) {
161 module_put(cs
->driver
->owner
);
164 tty
->driver_data
= cs
;
168 if (cs
->open_count
== 1) {
169 spin_lock_irqsave(&cs
->lock
, flags
);
171 spin_unlock_irqrestore(&cs
->lock
, flags
);
172 tty
->low_latency
= 1;
175 mutex_unlock(&cs
->mutex
);
179 static void if_close(struct tty_struct
*tty
, struct file
*filp
)
181 struct cardstate
*cs
;
184 cs
= (struct cardstate
*) tty
->driver_data
;
186 pr_err("%s: no cardstate\n", __func__
);
190 gig_dbg(DEBUG_IF
, "%u: %s()", cs
->minor_index
, __func__
);
192 mutex_lock(&cs
->mutex
);
195 gig_dbg(DEBUG_IF
, "not connected"); /* nothing to do */
196 else if (!cs
->open_count
)
197 dev_warn(cs
->dev
, "%s: device not opened\n", __func__
);
199 if (!--cs
->open_count
) {
200 spin_lock_irqsave(&cs
->lock
, flags
);
202 spin_unlock_irqrestore(&cs
->lock
, flags
);
206 mutex_unlock(&cs
->mutex
);
208 module_put(cs
->driver
->owner
);
211 static int if_ioctl(struct tty_struct
*tty
,
212 unsigned int cmd
, unsigned long arg
)
214 struct cardstate
*cs
;
215 int retval
= -ENODEV
;
217 unsigned char buf
[6];
220 cs
= (struct cardstate
*) tty
->driver_data
;
222 pr_err("%s: no cardstate\n", __func__
);
226 gig_dbg(DEBUG_IF
, "%u: %s(0x%x)", cs
->minor_index
, __func__
, cmd
);
228 if (mutex_lock_interruptible(&cs
->mutex
))
231 if (!cs
->connected
) {
232 gig_dbg(DEBUG_IF
, "not connected");
234 } else if (!cs
->open_count
)
235 dev_warn(cs
->dev
, "%s: device not opened\n", __func__
);
240 retval
= get_user(int_arg
, (int __user
*) arg
);
242 retval
= if_lock(cs
, &int_arg
);
244 retval
= put_user(int_arg
, (int __user
*) arg
);
247 retval
= get_user(int_arg
, (int __user
*) arg
);
249 retval
= if_config(cs
, &int_arg
);
251 retval
= put_user(int_arg
, (int __user
*) arg
);
253 case GIGASET_BRKCHARS
:
254 retval
= copy_from_user(&buf
,
255 (const unsigned char __user
*) arg
, 6)
258 gigaset_dbg_buffer(DEBUG_IF
, "GIGASET_BRKCHARS",
259 6, (const unsigned char *) arg
);
260 retval
= cs
->ops
->brkchars(cs
, buf
);
263 case GIGASET_VERSION
:
264 retval
= copy_from_user(version
,
265 (unsigned __user
*) arg
, sizeof version
)
268 retval
= if_version(cs
, version
);
270 retval
= copy_to_user((unsigned __user
*) arg
,
271 version
, sizeof version
)
275 gig_dbg(DEBUG_IF
, "%s: arg not supported - 0x%04x",
277 retval
= -ENOIOCTLCMD
;
281 mutex_unlock(&cs
->mutex
);
286 static int if_tiocmget(struct tty_struct
*tty
)
288 struct cardstate
*cs
;
291 cs
= (struct cardstate
*) tty
->driver_data
;
293 pr_err("%s: no cardstate\n", __func__
);
297 gig_dbg(DEBUG_IF
, "%u: %s()", cs
->minor_index
, __func__
);
299 if (mutex_lock_interruptible(&cs
->mutex
))
302 retval
= cs
->control_state
& (TIOCM_RTS
|TIOCM_DTR
);
304 mutex_unlock(&cs
->mutex
);
309 static int if_tiocmset(struct tty_struct
*tty
,
310 unsigned int set
, unsigned int clear
)
312 struct cardstate
*cs
;
316 cs
= (struct cardstate
*) tty
->driver_data
;
318 pr_err("%s: no cardstate\n", __func__
);
322 gig_dbg(DEBUG_IF
, "%u: %s(0x%x, 0x%x)",
323 cs
->minor_index
, __func__
, set
, clear
);
325 if (mutex_lock_interruptible(&cs
->mutex
))
328 if (!cs
->connected
) {
329 gig_dbg(DEBUG_IF
, "not connected");
332 mc
= (cs
->control_state
| set
) & ~clear
& (TIOCM_RTS
|TIOCM_DTR
);
333 retval
= cs
->ops
->set_modem_ctrl(cs
, cs
->control_state
, mc
);
334 cs
->control_state
= mc
;
337 mutex_unlock(&cs
->mutex
);
342 static int if_write(struct tty_struct
*tty
, const unsigned char *buf
, int count
)
344 struct cardstate
*cs
;
348 cs
= (struct cardstate
*) tty
->driver_data
;
350 pr_err("%s: no cardstate\n", __func__
);
354 gig_dbg(DEBUG_IF
, "%u: %s()", cs
->minor_index
, __func__
);
356 if (mutex_lock_interruptible(&cs
->mutex
))
359 if (!cs
->connected
) {
360 gig_dbg(DEBUG_IF
, "not connected");
364 if (!cs
->open_count
) {
365 dev_warn(cs
->dev
, "%s: device not opened\n", __func__
);
369 if (cs
->mstate
!= MS_LOCKED
) {
370 dev_warn(cs
->dev
, "can't write to unlocked device\n");
380 cb
= kmalloc(sizeof(struct cmdbuf_t
) + count
, GFP_KERNEL
);
382 dev_err(cs
->dev
, "%s: out of memory\n", __func__
);
387 memcpy(cb
->buf
, buf
, count
);
391 cb
->wake_tasklet
= &cs
->if_wake_tasklet
;
392 retval
= cs
->ops
->write_cmd(cs
, cb
);
394 mutex_unlock(&cs
->mutex
);
398 static int if_write_room(struct tty_struct
*tty
)
400 struct cardstate
*cs
;
401 int retval
= -ENODEV
;
403 cs
= (struct cardstate
*) tty
->driver_data
;
405 pr_err("%s: no cardstate\n", __func__
);
409 gig_dbg(DEBUG_IF
, "%u: %s()", cs
->minor_index
, __func__
);
411 if (mutex_lock_interruptible(&cs
->mutex
))
414 if (!cs
->connected
) {
415 gig_dbg(DEBUG_IF
, "not connected");
417 } else if (!cs
->open_count
)
418 dev_warn(cs
->dev
, "%s: device not opened\n", __func__
);
419 else if (cs
->mstate
!= MS_LOCKED
) {
420 dev_warn(cs
->dev
, "can't write to unlocked device\n");
423 retval
= cs
->ops
->write_room(cs
);
425 mutex_unlock(&cs
->mutex
);
430 static int if_chars_in_buffer(struct tty_struct
*tty
)
432 struct cardstate
*cs
;
435 cs
= (struct cardstate
*) tty
->driver_data
;
437 pr_err("%s: no cardstate\n", __func__
);
441 gig_dbg(DEBUG_IF
, "%u: %s()", cs
->minor_index
, __func__
);
443 mutex_lock(&cs
->mutex
);
446 gig_dbg(DEBUG_IF
, "not connected");
447 else if (!cs
->open_count
)
448 dev_warn(cs
->dev
, "%s: device not opened\n", __func__
);
449 else if (cs
->mstate
!= MS_LOCKED
)
450 dev_warn(cs
->dev
, "can't write to unlocked device\n");
452 retval
= cs
->ops
->chars_in_buffer(cs
);
454 mutex_unlock(&cs
->mutex
);
459 static void if_throttle(struct tty_struct
*tty
)
461 struct cardstate
*cs
;
463 cs
= (struct cardstate
*) tty
->driver_data
;
465 pr_err("%s: no cardstate\n", __func__
);
469 gig_dbg(DEBUG_IF
, "%u: %s()", cs
->minor_index
, __func__
);
471 mutex_lock(&cs
->mutex
);
474 gig_dbg(DEBUG_IF
, "not connected"); /* nothing to do */
475 else if (!cs
->open_count
)
476 dev_warn(cs
->dev
, "%s: device not opened\n", __func__
);
478 gig_dbg(DEBUG_IF
, "%s: not implemented\n", __func__
);
480 mutex_unlock(&cs
->mutex
);
483 static void if_unthrottle(struct tty_struct
*tty
)
485 struct cardstate
*cs
;
487 cs
= (struct cardstate
*) tty
->driver_data
;
489 pr_err("%s: no cardstate\n", __func__
);
493 gig_dbg(DEBUG_IF
, "%u: %s()", cs
->minor_index
, __func__
);
495 mutex_lock(&cs
->mutex
);
498 gig_dbg(DEBUG_IF
, "not connected"); /* nothing to do */
499 else if (!cs
->open_count
)
500 dev_warn(cs
->dev
, "%s: device not opened\n", __func__
);
502 gig_dbg(DEBUG_IF
, "%s: not implemented\n", __func__
);
504 mutex_unlock(&cs
->mutex
);
507 static void if_set_termios(struct tty_struct
*tty
, struct ktermios
*old
)
509 struct cardstate
*cs
;
512 unsigned int old_cflag
;
513 unsigned int control_state
, new_state
;
515 cs
= (struct cardstate
*) tty
->driver_data
;
517 pr_err("%s: no cardstate\n", __func__
);
521 gig_dbg(DEBUG_IF
, "%u: %s()", cs
->minor_index
, __func__
);
523 mutex_lock(&cs
->mutex
);
525 if (!cs
->connected
) {
526 gig_dbg(DEBUG_IF
, "not connected");
530 if (!cs
->open_count
) {
531 dev_warn(cs
->dev
, "%s: device not opened\n", __func__
);
535 iflag
= tty
->termios
->c_iflag
;
536 cflag
= tty
->termios
->c_cflag
;
537 old_cflag
= old
? old
->c_cflag
: cflag
;
538 gig_dbg(DEBUG_IF
, "%u: iflag %x cflag %x old %x",
539 cs
->minor_index
, iflag
, cflag
, old_cflag
);
541 /* get a local copy of the current port settings */
542 control_state
= cs
->control_state
;
546 * Do not attempt to cache old rates and skip settings,
547 * disconnects screw such tricks up completely.
548 * Premature optimization is the root of all evil.
551 /* reassert DTR and (maybe) RTS on transition from B0 */
552 if ((old_cflag
& CBAUD
) == B0
) {
553 new_state
= control_state
| TIOCM_DTR
;
554 /* don't set RTS if using hardware flow control */
555 if (!(old_cflag
& CRTSCTS
))
556 new_state
|= TIOCM_RTS
;
557 gig_dbg(DEBUG_IF
, "%u: from B0 - set DTR%s",
559 (new_state
& TIOCM_RTS
) ? " only" : "/RTS");
560 cs
->ops
->set_modem_ctrl(cs
, control_state
, new_state
);
561 control_state
= new_state
;
564 cs
->ops
->baud_rate(cs
, cflag
& CBAUD
);
566 if ((cflag
& CBAUD
) == B0
) {
567 /* Drop RTS and DTR */
568 gig_dbg(DEBUG_IF
, "%u: to B0 - drop DTR/RTS", cs
->minor_index
);
569 new_state
= control_state
& ~(TIOCM_DTR
| TIOCM_RTS
);
570 cs
->ops
->set_modem_ctrl(cs
, control_state
, new_state
);
571 control_state
= new_state
;
575 * Update line control register (LCR)
578 cs
->ops
->set_line_ctrl(cs
, cflag
);
580 /* save off the modified port settings */
581 cs
->control_state
= control_state
;
584 mutex_unlock(&cs
->mutex
);
588 /* wakeup tasklet for the write operation */
589 static void if_wake(unsigned long data
)
591 struct cardstate
*cs
= (struct cardstate
*) data
;
597 /*** interface to common ***/
599 void gigaset_if_init(struct cardstate
*cs
)
601 struct gigaset_driver
*drv
;
607 tasklet_init(&cs
->if_wake_tasklet
, if_wake
, (unsigned long) cs
);
609 mutex_lock(&cs
->mutex
);
610 cs
->tty_dev
= tty_register_device(drv
->tty
, cs
->minor_index
, NULL
);
612 if (!IS_ERR(cs
->tty_dev
))
613 dev_set_drvdata(cs
->tty_dev
, cs
);
615 pr_warning("could not register device to the tty subsystem\n");
618 mutex_unlock(&cs
->mutex
);
621 void gigaset_if_free(struct cardstate
*cs
)
623 struct gigaset_driver
*drv
;
629 tasklet_disable(&cs
->if_wake_tasklet
);
630 tasklet_kill(&cs
->if_wake_tasklet
);
632 tty_unregister_device(drv
->tty
, cs
->minor_index
);
636 * gigaset_if_receive() - pass a received block of data to the tty device
637 * @cs: device descriptor structure.
638 * @buffer: received data.
639 * @len: number of bytes received.
641 * Called by asyncdata/isocdata if a block of data received from the
642 * device must be sent to userspace through the ttyG* device.
644 void gigaset_if_receive(struct cardstate
*cs
,
645 unsigned char *buffer
, size_t len
)
648 struct tty_struct
*tty
;
650 spin_lock_irqsave(&cs
->lock
, flags
);
653 gig_dbg(DEBUG_IF
, "receive on closed device");
655 tty_insert_flip_string(tty
, buffer
, len
);
656 tty_flip_buffer_push(tty
);
658 spin_unlock_irqrestore(&cs
->lock
, flags
);
660 EXPORT_SYMBOL_GPL(gigaset_if_receive
);
662 /* gigaset_if_initdriver
663 * Initialize tty interface.
666 * procname Name of the driver (e.g. for /proc/tty/drivers)
667 * devname Name of the device files (prefix without minor number)
669 void gigaset_if_initdriver(struct gigaset_driver
*drv
, const char *procname
,
672 unsigned minors
= drv
->minors
;
674 struct tty_driver
*tty
;
678 drv
->tty
= tty
= alloc_tty_driver(minors
);
682 tty
->magic
= TTY_DRIVER_MAGIC
,
683 tty
->type
= TTY_DRIVER_TYPE_SERIAL
,
684 tty
->subtype
= SERIAL_TYPE_NORMAL
,
685 tty
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
687 tty
->driver_name
= procname
;
689 tty
->minor_start
= drv
->minor
;
690 tty
->num
= drv
->minors
;
692 tty
->owner
= THIS_MODULE
;
694 tty
->init_termios
= tty_std_termios
;
695 tty
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
| HUPCL
| CLOCAL
;
696 tty_set_operations(tty
, &if_ops
);
698 ret
= tty_register_driver(tty
);
700 pr_err("error %d registering tty driver\n", ret
);
703 gig_dbg(DEBUG_IF
, "tty driver initialized");
708 pr_err("out of memory\n");
711 put_tty_driver(drv
->tty
);
714 void gigaset_if_freedriver(struct gigaset_driver
*drv
)
720 tty_unregister_driver(drv
->tty
);
721 put_tty_driver(drv
->tty
);