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.h>
17 #include <linux/tty_flip.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,
49 gig_dbg(DEBUG_CMD, "scheduling IF_LOCK");
50 gigaset_schedule_event(cs);
52 wait_event(cs->waitqueue, !cs->waiting);
54 if (cs->cmd_result >= 0) {
55 *arg = cs->cmd_result;
59 return cs->cmd_result;
62 static int if_version(struct cardstate *cs, unsigned arg[4])
64 static const unsigned version[4] = GIG_VERSION;
65 static const unsigned compat[4] = GIG_COMPAT;
66 unsigned cmd = arg[0];
68 gig_dbg(DEBUG_IF, "%u: if_version (%d)", cs->minor_index, cmd);
72 memcpy(arg, version, sizeof version);
75 memcpy(arg, compat, sizeof compat);
79 if (!gigaset_add_event(cs, &cs->at_state, EV_IF_VER,
85 gig_dbg(DEBUG_CMD, "scheduling IF_VER");
86 gigaset_schedule_event(cs);
88 wait_event(cs->waitqueue, !cs->waiting);
90 if (cs->cmd_result >= 0)
93 return cs->cmd_result;
99 static int if_config(struct cardstate *cs, int *arg)
101 gig_dbg(DEBUG_IF, "%u: if_config (%d)", cs->minor_index, *arg);
106 if (cs->mstate != MS_LOCKED)
109 if (!cs->connected) {
110 pr_err("%s: not connected\n", __func__);
115 return gigaset_enterconfigmode(cs);
118 /*** the terminal driver ***/
119 /* stolen from usbserial and some other tty drivers */
121 static int if_open(struct tty_struct *tty, struct file *filp);
122 static void if_close(struct tty_struct *tty, struct file *filp);
123 static int if_ioctl(struct tty_struct *tty, struct file *file,
124 unsigned int cmd, unsigned long arg);
125 static int if_write_room(struct tty_struct *tty);
126 static int if_chars_in_buffer(struct tty_struct *tty);
127 static void if_throttle(struct tty_struct *tty);
128 static void if_unthrottle(struct tty_struct *tty);
129 static void if_set_termios(struct tty_struct *tty, struct ktermios *old);
130 static int if_tiocmget(struct tty_struct *tty, struct file *file);
131 static int if_tiocmset(struct tty_struct *tty, struct file *file,
132 unsigned int set, unsigned int clear);
133 static int if_write(struct tty_struct *tty,
134 const unsigned char *buf, int count);
136 static const struct tty_operations if_ops = {
141 .write_room = if_write_room,
142 .chars_in_buffer = if_chars_in_buffer,
143 .set_termios = if_set_termios,
144 .throttle = if_throttle,
145 .unthrottle = if_unthrottle,
146 .tiocmget = if_tiocmget,
147 .tiocmset = if_tiocmset,
150 static int if_open(struct tty_struct *tty, struct file *filp)
152 struct cardstate *cs;
155 gig_dbg(DEBUG_IF, "%d+%d: %s()",
156 tty->driver->minor_start, tty->index, __func__);
158 tty->driver_data = NULL;
160 cs = gigaset_get_cs_by_tty(tty);
161 if (!cs || !try_module_get(cs->driver->owner))
164 if (mutex_lock_interruptible(&cs->mutex))
165 return -ERESTARTSYS; // FIXME -EINTR?
166 tty->driver_data = cs;
170 if (cs->open_count == 1) {
171 spin_lock_irqsave(&cs->lock, flags);
173 spin_unlock_irqrestore(&cs->lock, flags);
174 tty->low_latency = 1; //FIXME test
177 mutex_unlock(&cs->mutex);
181 static void if_close(struct tty_struct *tty, struct file *filp)
183 struct cardstate *cs;
186 cs = (struct cardstate *) tty->driver_data;
188 pr_err("%s: no cardstate\n", __func__);
192 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
194 mutex_lock(&cs->mutex);
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, struct file *file,
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))
229 return -ERESTARTSYS; // FIXME -EINTR?
232 dev_warn(cs->dev, "%s: device not opened\n", __func__);
237 retval = get_user(int_arg, (int __user *) arg);
239 retval = if_lock(cs, &int_arg);
241 retval = put_user(int_arg, (int __user *) arg);
244 retval = get_user(int_arg, (int __user *) arg);
246 retval = if_config(cs, &int_arg);
248 retval = put_user(int_arg, (int __user *) arg);
250 case GIGASET_BRKCHARS:
251 //FIXME test if MS_LOCKED
252 if (!cs->connected) {
254 "can't communicate with unplugged device");
258 retval = copy_from_user(&buf,
259 (const unsigned char __user *) arg, 6)
262 gigaset_dbg_buffer(DEBUG_IF, "GIGASET_BRKCHARS",
263 6, (const unsigned char *) arg);
264 retval = cs->ops->brkchars(cs, buf);
267 case GIGASET_VERSION:
268 retval = copy_from_user(version,
269 (unsigned __user *) arg, sizeof version)
272 retval = if_version(cs, version);
274 retval = copy_to_user((unsigned __user *) arg,
275 version, sizeof version)
279 gig_dbg(DEBUG_ANY, "%s: arg not supported - 0x%04x",
281 retval = -ENOIOCTLCMD;
285 mutex_unlock(&cs->mutex);
290 static int if_tiocmget(struct tty_struct *tty, struct file *file)
292 struct cardstate *cs;
295 cs = (struct cardstate *) tty->driver_data;
297 pr_err("%s: no cardstate\n", __func__);
301 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
303 if (mutex_lock_interruptible(&cs->mutex))
304 return -ERESTARTSYS; // FIXME -EINTR?
306 // FIXME read from device?
307 retval = cs->control_state & (TIOCM_RTS|TIOCM_DTR);
309 mutex_unlock(&cs->mutex);
314 static int if_tiocmset(struct tty_struct *tty, struct file *file,
315 unsigned int set, unsigned int clear)
317 struct cardstate *cs;
321 cs = (struct cardstate *) tty->driver_data;
323 pr_err("%s: no cardstate\n", __func__);
327 gig_dbg(DEBUG_IF, "%u: %s(0x%x, 0x%x)",
328 cs->minor_index, __func__, set, clear);
330 if (mutex_lock_interruptible(&cs->mutex))
331 return -ERESTARTSYS; // FIXME -EINTR?
333 if (!cs->connected) {
334 gig_dbg(DEBUG_ANY, "can't communicate with unplugged device");
337 mc = (cs->control_state | set) & ~clear & (TIOCM_RTS|TIOCM_DTR);
338 retval = cs->ops->set_modem_ctrl(cs, cs->control_state, mc);
339 cs->control_state = mc;
342 mutex_unlock(&cs->mutex);
347 static int if_write(struct tty_struct *tty, const unsigned char *buf, int count)
349 struct cardstate *cs;
350 int retval = -ENODEV;
352 cs = (struct cardstate *) tty->driver_data;
354 pr_err("%s: no cardstate\n", __func__);
358 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
360 if (mutex_lock_interruptible(&cs->mutex))
361 return -ERESTARTSYS; // FIXME -EINTR?
364 dev_warn(cs->dev, "%s: device not opened\n", __func__);
365 else if (cs->mstate != MS_LOCKED) {
366 dev_warn(cs->dev, "can't write to unlocked device\n");
368 } else if (!cs->connected) {
369 gig_dbg(DEBUG_ANY, "can't write to unplugged device");
370 retval = -EBUSY; //FIXME
372 retval = cs->ops->write_cmd(cs, buf, count,
373 &cs->if_wake_tasklet);
376 mutex_unlock(&cs->mutex);
381 static int if_write_room(struct tty_struct *tty)
383 struct cardstate *cs;
384 int retval = -ENODEV;
386 cs = (struct cardstate *) tty->driver_data;
388 pr_err("%s: no cardstate\n", __func__);
392 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
394 if (mutex_lock_interruptible(&cs->mutex))
395 return -ERESTARTSYS; // FIXME -EINTR?
398 dev_warn(cs->dev, "%s: device not opened\n", __func__);
399 else if (cs->mstate != MS_LOCKED) {
400 dev_warn(cs->dev, "can't write to unlocked device\n");
402 } else if (!cs->connected) {
403 gig_dbg(DEBUG_ANY, "can't write to unplugged device");
404 retval = -EBUSY; //FIXME
406 retval = cs->ops->write_room(cs);
408 mutex_unlock(&cs->mutex);
413 static int if_chars_in_buffer(struct tty_struct *tty)
415 struct cardstate *cs;
416 int retval = -ENODEV;
418 cs = (struct cardstate *) tty->driver_data;
420 pr_err("%s: no cardstate\n", __func__);
424 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
426 if (mutex_lock_interruptible(&cs->mutex))
427 return -ERESTARTSYS; // FIXME -EINTR?
430 dev_warn(cs->dev, "%s: device not opened\n", __func__);
431 else if (cs->mstate != MS_LOCKED) {
432 dev_warn(cs->dev, "can't write to unlocked device\n");
434 } else if (!cs->connected) {
435 gig_dbg(DEBUG_ANY, "can't write to unplugged device");
436 retval = -EBUSY; //FIXME
438 retval = cs->ops->chars_in_buffer(cs);
440 mutex_unlock(&cs->mutex);
445 static void if_throttle(struct tty_struct *tty)
447 struct cardstate *cs;
449 cs = (struct cardstate *) tty->driver_data;
451 pr_err("%s: no cardstate\n", __func__);
455 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
457 mutex_lock(&cs->mutex);
460 dev_warn(cs->dev, "%s: device not opened\n", __func__);
465 mutex_unlock(&cs->mutex);
468 static void if_unthrottle(struct tty_struct *tty)
470 struct cardstate *cs;
472 cs = (struct cardstate *) tty->driver_data;
474 pr_err("%s: no cardstate\n", __func__);
478 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
480 mutex_lock(&cs->mutex);
483 dev_warn(cs->dev, "%s: device not opened\n", __func__);
488 mutex_unlock(&cs->mutex);
491 static void if_set_termios(struct tty_struct *tty, struct ktermios *old)
493 struct cardstate *cs;
496 unsigned int old_cflag;
497 unsigned int control_state, new_state;
499 cs = (struct cardstate *) tty->driver_data;
501 pr_err("%s: no cardstate\n", __func__);
505 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
507 mutex_lock(&cs->mutex);
509 if (!cs->open_count) {
510 dev_warn(cs->dev, "%s: device not opened\n", __func__);
514 if (!cs->connected) {
515 gig_dbg(DEBUG_ANY, "can't communicate with unplugged device");
519 // stolen from mct_u232.c
520 iflag = tty->termios->c_iflag;
521 cflag = tty->termios->c_cflag;
522 old_cflag = old ? old->c_cflag : cflag; //FIXME?
523 gig_dbg(DEBUG_IF, "%u: iflag %x cflag %x old %x",
524 cs->minor_index, iflag, cflag, old_cflag);
526 /* get a local copy of the current port settings */
527 control_state = cs->control_state;
531 * Do not attempt to cache old rates and skip settings,
532 * disconnects screw such tricks up completely.
533 * Premature optimization is the root of all evil.
536 /* reassert DTR and (maybe) RTS on transition from B0 */
537 if ((old_cflag & CBAUD) == B0) {
538 new_state = control_state | TIOCM_DTR;
539 /* don't set RTS if using hardware flow control */
540 if (!(old_cflag & CRTSCTS))
541 new_state |= TIOCM_RTS;
542 gig_dbg(DEBUG_IF, "%u: from B0 - set DTR%s",
544 (new_state & TIOCM_RTS) ? " only" : "/RTS");
545 cs->ops->set_modem_ctrl(cs, control_state, new_state);
546 control_state = new_state;
549 cs->ops->baud_rate(cs, cflag & CBAUD);
551 if ((cflag & CBAUD) == B0) {
552 /* Drop RTS and DTR */
553 gig_dbg(DEBUG_IF, "%u: to B0 - drop DTR/RTS", cs->minor_index);
554 new_state = control_state & ~(TIOCM_DTR | TIOCM_RTS);
555 cs->ops->set_modem_ctrl(cs, control_state, new_state);
556 control_state = new_state;
560 * Update line control register (LCR)
563 cs->ops->set_line_ctrl(cs, cflag);
565 /* save off the modified port settings */
566 cs->control_state = control_state;
569 mutex_unlock(&cs->mutex);
573 /* wakeup tasklet for the write operation */
574 static void if_wake(unsigned long data)
576 struct cardstate *cs = (struct cardstate *) data;
582 /*** interface to common ***/
584 void gigaset_if_init(struct cardstate *cs)
586 struct gigaset_driver *drv;
592 tasklet_init(&cs->if_wake_tasklet, &if_wake, (unsigned long) cs);
594 mutex_lock(&cs->mutex);
595 cs->tty_dev = tty_register_device(drv->tty, cs->minor_index, NULL);
597 if (!IS_ERR(cs->tty_dev))
598 dev_set_drvdata(cs->tty_dev, cs);
601 "could not register device to the tty subsystem\n");
604 mutex_unlock(&cs->mutex);
607 void gigaset_if_free(struct cardstate *cs)
609 struct gigaset_driver *drv;
615 tasklet_disable(&cs->if_wake_tasklet);
616 tasklet_kill(&cs->if_wake_tasklet);
618 tty_unregister_device(drv->tty, cs->minor_index);
621 void gigaset_if_receive(struct cardstate *cs,
622 unsigned char *buffer, size_t len)
625 struct tty_struct *tty;
627 spin_lock_irqsave(&cs->lock, flags);
628 if ((tty = cs->tty) == NULL)
629 gig_dbg(DEBUG_ANY, "receive on closed device");
631 tty_buffer_request_room(tty, len);
632 tty_insert_flip_string(tty, buffer, len);
633 tty_flip_buffer_push(tty);
635 spin_unlock_irqrestore(&cs->lock, flags);
637 EXPORT_SYMBOL_GPL(gigaset_if_receive);
639 /* gigaset_if_initdriver
640 * Initialize tty interface.
643 * procname Name of the driver (e.g. for /proc/tty/drivers)
644 * devname Name of the device files (prefix without minor number)
646 void gigaset_if_initdriver(struct gigaset_driver *drv, const char *procname,
649 unsigned minors = drv->minors;
651 struct tty_driver *tty;
655 if ((drv->tty = alloc_tty_driver(minors)) == NULL)
659 tty->magic = TTY_DRIVER_MAGIC,
660 tty->major = GIG_MAJOR,
661 tty->type = TTY_DRIVER_TYPE_SERIAL,
662 tty->subtype = SERIAL_TYPE_NORMAL,
663 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
665 tty->driver_name = procname;
667 tty->minor_start = drv->minor;
668 tty->num = drv->minors;
670 tty->owner = THIS_MODULE;
672 tty->init_termios = tty_std_termios; //FIXME
673 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL; //FIXME
674 tty_set_operations(tty, &if_ops);
676 ret = tty_register_driver(tty);
678 pr_err("error %d registering tty driver\n", ret);
681 gig_dbg(DEBUG_IF, "tty driver initialized");
686 pr_err("out of memory\n");
689 put_tty_driver(drv->tty);
692 void gigaset_if_freedriver(struct gigaset_driver *drv)
698 tty_unregister_driver(drv->tty);
699 put_tty_driver(drv->tty);