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>
20 static int if_lock(struct cardstate *cs, int *arg)
24 gig_dbg(DEBUG_IF, "%u: if_lock (%d)", cs->minor_index, cmd);
30 *arg = cs->mstate == MS_LOCKED;
34 if (!cmd && cs->mstate == MS_LOCKED && cs->connected) {
35 cs->ops->set_modem_ctrl(cs, 0, TIOCM_DTR|TIOCM_RTS);
36 cs->ops->baud_rate(cs, B115200);
37 cs->ops->set_line_ctrl(cs, CS8);
38 cs->control_state = TIOCM_DTR|TIOCM_RTS;
42 if (!gigaset_add_event(cs, &cs->at_state, EV_IF_LOCK,
47 gigaset_schedule_event(cs);
49 wait_event(cs->waitqueue, !cs->waiting);
51 if (cs->cmd_result >= 0) {
52 *arg = cs->cmd_result;
56 return cs->cmd_result;
59 static int if_version(struct cardstate *cs, unsigned arg[4])
61 static const unsigned version[4] = GIG_VERSION;
62 static const unsigned compat[4] = GIG_COMPAT;
63 unsigned cmd = arg[0];
65 gig_dbg(DEBUG_IF, "%u: if_version (%d)", cs->minor_index, cmd);
69 memcpy(arg, version, sizeof version);
72 memcpy(arg, compat, sizeof compat);
76 if (!gigaset_add_event(cs, &cs->at_state, EV_IF_VER,
81 gigaset_schedule_event(cs);
83 wait_event(cs->waitqueue, !cs->waiting);
85 if (cs->cmd_result >= 0)
88 return cs->cmd_result;
94 static int if_config(struct cardstate *cs, int *arg)
96 gig_dbg(DEBUG_IF, "%u: if_config (%d)", cs->minor_index, *arg);
101 if (cs->mstate != MS_LOCKED)
104 if (!cs->connected) {
105 pr_err("%s: not connected\n", __func__);
110 return gigaset_enterconfigmode(cs);
113 /*** the terminal driver ***/
114 /* stolen from usbserial and some other tty drivers */
116 static int if_open(struct tty_struct *tty, struct file *filp);
117 static void if_close(struct tty_struct *tty, struct file *filp);
118 static int if_ioctl(struct tty_struct *tty, struct file *file,
119 unsigned int cmd, unsigned long arg);
120 static int if_write_room(struct tty_struct *tty);
121 static int if_chars_in_buffer(struct tty_struct *tty);
122 static void if_throttle(struct tty_struct *tty);
123 static void if_unthrottle(struct tty_struct *tty);
124 static void if_set_termios(struct tty_struct *tty, struct ktermios *old);
125 static int if_tiocmget(struct tty_struct *tty, struct file *file);
126 static int if_tiocmset(struct tty_struct *tty, struct file *file,
127 unsigned int set, unsigned int clear);
128 static int if_write(struct tty_struct *tty,
129 const unsigned char *buf, int count);
131 static const struct tty_operations if_ops = {
136 .write_room = if_write_room,
137 .chars_in_buffer = if_chars_in_buffer,
138 .set_termios = if_set_termios,
139 .throttle = if_throttle,
140 .unthrottle = if_unthrottle,
141 .tiocmget = if_tiocmget,
142 .tiocmset = if_tiocmset,
145 static int if_open(struct tty_struct *tty, struct file *filp)
147 struct cardstate *cs;
150 gig_dbg(DEBUG_IF, "%d+%d: %s()",
151 tty->driver->minor_start, tty->index, __func__);
153 tty->driver_data = NULL;
155 cs = gigaset_get_cs_by_tty(tty);
156 if (!cs || !try_module_get(cs->driver->owner))
159 if (mutex_lock_interruptible(&cs->mutex))
161 tty->driver_data = cs;
165 if (cs->open_count == 1) {
166 spin_lock_irqsave(&cs->lock, flags);
168 spin_unlock_irqrestore(&cs->lock, flags);
169 tty->low_latency = 1;
172 mutex_unlock(&cs->mutex);
176 static void if_close(struct tty_struct *tty, struct file *filp)
178 struct cardstate *cs;
181 cs = (struct cardstate *) tty->driver_data;
183 pr_err("%s: no cardstate\n", __func__);
187 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
189 mutex_lock(&cs->mutex);
192 gig_dbg(DEBUG_IF, "not connected"); /* nothing to do */
193 else if (!cs->open_count)
194 dev_warn(cs->dev, "%s: device not opened\n", __func__);
196 if (!--cs->open_count) {
197 spin_lock_irqsave(&cs->lock, flags);
199 spin_unlock_irqrestore(&cs->lock, flags);
203 mutex_unlock(&cs->mutex);
205 module_put(cs->driver->owner);
208 static int if_ioctl(struct tty_struct *tty, struct file *file,
209 unsigned int cmd, unsigned long arg)
211 struct cardstate *cs;
212 int retval = -ENODEV;
214 unsigned char buf[6];
217 cs = (struct cardstate *) tty->driver_data;
219 pr_err("%s: no cardstate\n", __func__);
223 gig_dbg(DEBUG_IF, "%u: %s(0x%x)", cs->minor_index, __func__, cmd);
225 if (mutex_lock_interruptible(&cs->mutex))
228 if (!cs->connected) {
229 gig_dbg(DEBUG_IF, "not connected");
231 } else if (!cs->open_count)
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 retval = copy_from_user(&buf,
252 (const unsigned char __user *) arg, 6)
255 gigaset_dbg_buffer(DEBUG_IF, "GIGASET_BRKCHARS",
256 6, (const unsigned char *) arg);
257 retval = cs->ops->brkchars(cs, buf);
260 case GIGASET_VERSION:
261 retval = copy_from_user(version,
262 (unsigned __user *) arg, sizeof version)
265 retval = if_version(cs, version);
267 retval = copy_to_user((unsigned __user *) arg,
268 version, sizeof version)
272 gig_dbg(DEBUG_IF, "%s: arg not supported - 0x%04x",
274 retval = -ENOIOCTLCMD;
278 mutex_unlock(&cs->mutex);
283 static int if_tiocmget(struct tty_struct *tty, struct file *file)
285 struct cardstate *cs;
288 cs = (struct cardstate *) tty->driver_data;
290 pr_err("%s: no cardstate\n", __func__);
294 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
296 if (mutex_lock_interruptible(&cs->mutex))
299 retval = cs->control_state & (TIOCM_RTS|TIOCM_DTR);
301 mutex_unlock(&cs->mutex);
306 static int if_tiocmset(struct tty_struct *tty, struct file *file,
307 unsigned int set, unsigned int clear)
309 struct cardstate *cs;
313 cs = (struct cardstate *) tty->driver_data;
315 pr_err("%s: no cardstate\n", __func__);
319 gig_dbg(DEBUG_IF, "%u: %s(0x%x, 0x%x)",
320 cs->minor_index, __func__, set, clear);
322 if (mutex_lock_interruptible(&cs->mutex))
325 if (!cs->connected) {
326 gig_dbg(DEBUG_IF, "not connected");
329 mc = (cs->control_state | set) & ~clear & (TIOCM_RTS|TIOCM_DTR);
330 retval = cs->ops->set_modem_ctrl(cs, cs->control_state, mc);
331 cs->control_state = mc;
334 mutex_unlock(&cs->mutex);
339 static int if_write(struct tty_struct *tty, const unsigned char *buf, int count)
341 struct cardstate *cs;
342 int retval = -ENODEV;
344 cs = (struct cardstate *) tty->driver_data;
346 pr_err("%s: no cardstate\n", __func__);
350 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
352 if (mutex_lock_interruptible(&cs->mutex))
355 if (!cs->connected) {
356 gig_dbg(DEBUG_IF, "not connected");
358 } else if (!cs->open_count)
359 dev_warn(cs->dev, "%s: device not opened\n", __func__);
360 else if (cs->mstate != MS_LOCKED) {
361 dev_warn(cs->dev, "can't write to unlocked device\n");
364 retval = cs->ops->write_cmd(cs, buf, count,
365 &cs->if_wake_tasklet);
368 mutex_unlock(&cs->mutex);
373 static int if_write_room(struct tty_struct *tty)
375 struct cardstate *cs;
376 int retval = -ENODEV;
378 cs = (struct cardstate *) tty->driver_data;
380 pr_err("%s: no cardstate\n", __func__);
384 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
386 if (mutex_lock_interruptible(&cs->mutex))
389 if (!cs->connected) {
390 gig_dbg(DEBUG_IF, "not connected");
392 } else if (!cs->open_count)
393 dev_warn(cs->dev, "%s: device not opened\n", __func__);
394 else if (cs->mstate != MS_LOCKED) {
395 dev_warn(cs->dev, "can't write to unlocked device\n");
398 retval = cs->ops->write_room(cs);
400 mutex_unlock(&cs->mutex);
405 static int if_chars_in_buffer(struct tty_struct *tty)
407 struct cardstate *cs;
410 cs = (struct cardstate *) tty->driver_data;
412 pr_err("%s: no cardstate\n", __func__);
416 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
418 mutex_lock(&cs->mutex);
421 gig_dbg(DEBUG_IF, "not connected");
422 else if (!cs->open_count)
423 dev_warn(cs->dev, "%s: device not opened\n", __func__);
424 else if (cs->mstate != MS_LOCKED)
425 dev_warn(cs->dev, "can't write to unlocked device\n");
427 retval = cs->ops->chars_in_buffer(cs);
429 mutex_unlock(&cs->mutex);
434 static void if_throttle(struct tty_struct *tty)
436 struct cardstate *cs;
438 cs = (struct cardstate *) tty->driver_data;
440 pr_err("%s: no cardstate\n", __func__);
444 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
446 mutex_lock(&cs->mutex);
449 gig_dbg(DEBUG_IF, "not connected"); /* nothing to do */
450 else if (!cs->open_count)
451 dev_warn(cs->dev, "%s: device not opened\n", __func__);
453 gig_dbg(DEBUG_IF, "%s: not implemented\n", __func__);
455 mutex_unlock(&cs->mutex);
458 static void if_unthrottle(struct tty_struct *tty)
460 struct cardstate *cs;
462 cs = (struct cardstate *) tty->driver_data;
464 pr_err("%s: no cardstate\n", __func__);
468 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
470 mutex_lock(&cs->mutex);
473 gig_dbg(DEBUG_IF, "not connected"); /* nothing to do */
474 else if (!cs->open_count)
475 dev_warn(cs->dev, "%s: device not opened\n", __func__);
477 gig_dbg(DEBUG_IF, "%s: not implemented\n", __func__);
479 mutex_unlock(&cs->mutex);
482 static void if_set_termios(struct tty_struct *tty, struct ktermios *old)
484 struct cardstate *cs;
487 unsigned int old_cflag;
488 unsigned int control_state, new_state;
490 cs = (struct cardstate *) tty->driver_data;
492 pr_err("%s: no cardstate\n", __func__);
496 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
498 mutex_lock(&cs->mutex);
500 if (!cs->connected) {
501 gig_dbg(DEBUG_IF, "not connected");
505 if (!cs->open_count) {
506 dev_warn(cs->dev, "%s: device not opened\n", __func__);
510 iflag = tty->termios->c_iflag;
511 cflag = tty->termios->c_cflag;
512 old_cflag = old ? old->c_cflag : cflag;
513 gig_dbg(DEBUG_IF, "%u: iflag %x cflag %x old %x",
514 cs->minor_index, iflag, cflag, old_cflag);
516 /* get a local copy of the current port settings */
517 control_state = cs->control_state;
521 * Do not attempt to cache old rates and skip settings,
522 * disconnects screw such tricks up completely.
523 * Premature optimization is the root of all evil.
526 /* reassert DTR and (maybe) RTS on transition from B0 */
527 if ((old_cflag & CBAUD) == B0) {
528 new_state = control_state | TIOCM_DTR;
529 /* don't set RTS if using hardware flow control */
530 if (!(old_cflag & CRTSCTS))
531 new_state |= TIOCM_RTS;
532 gig_dbg(DEBUG_IF, "%u: from B0 - set DTR%s",
534 (new_state & TIOCM_RTS) ? " only" : "/RTS");
535 cs->ops->set_modem_ctrl(cs, control_state, new_state);
536 control_state = new_state;
539 cs->ops->baud_rate(cs, cflag & CBAUD);
541 if ((cflag & CBAUD) == B0) {
542 /* Drop RTS and DTR */
543 gig_dbg(DEBUG_IF, "%u: to B0 - drop DTR/RTS", cs->minor_index);
544 new_state = control_state & ~(TIOCM_DTR | TIOCM_RTS);
545 cs->ops->set_modem_ctrl(cs, control_state, new_state);
546 control_state = new_state;
550 * Update line control register (LCR)
553 cs->ops->set_line_ctrl(cs, cflag);
555 /* save off the modified port settings */
556 cs->control_state = control_state;
559 mutex_unlock(&cs->mutex);
563 /* wakeup tasklet for the write operation */
564 static void if_wake(unsigned long data)
566 struct cardstate *cs = (struct cardstate *) data;
572 /*** interface to common ***/
574 void gigaset_if_init(struct cardstate *cs)
576 struct gigaset_driver *drv;
582 tasklet_init(&cs->if_wake_tasklet, if_wake, (unsigned long) cs);
584 mutex_lock(&cs->mutex);
585 cs->tty_dev = tty_register_device(drv->tty, cs->minor_index, NULL);
587 if (!IS_ERR(cs->tty_dev))
588 dev_set_drvdata(cs->tty_dev, cs);
590 pr_warning("could not register device to the tty subsystem\n");
593 mutex_unlock(&cs->mutex);
596 void gigaset_if_free(struct cardstate *cs)
598 struct gigaset_driver *drv;
604 tasklet_disable(&cs->if_wake_tasklet);
605 tasklet_kill(&cs->if_wake_tasklet);
607 tty_unregister_device(drv->tty, cs->minor_index);
611 * gigaset_if_receive() - pass a received block of data to the tty device
612 * @cs: device descriptor structure.
613 * @buffer: received data.
614 * @len: number of bytes received.
616 * Called by asyncdata/isocdata if a block of data received from the
617 * device must be sent to userspace through the ttyG* device.
619 void gigaset_if_receive(struct cardstate *cs,
620 unsigned char *buffer, size_t len)
623 struct tty_struct *tty;
625 spin_lock_irqsave(&cs->lock, flags);
628 gig_dbg(DEBUG_IF, "receive on closed device");
630 tty_insert_flip_string(tty, buffer, len);
631 tty_flip_buffer_push(tty);
633 spin_unlock_irqrestore(&cs->lock, flags);
635 EXPORT_SYMBOL_GPL(gigaset_if_receive);
637 /* gigaset_if_initdriver
638 * Initialize tty interface.
641 * procname Name of the driver (e.g. for /proc/tty/drivers)
642 * devname Name of the device files (prefix without minor number)
644 void gigaset_if_initdriver(struct gigaset_driver *drv, const char *procname,
647 unsigned minors = drv->minors;
649 struct tty_driver *tty;
653 drv->tty = tty = alloc_tty_driver(minors);
657 tty->magic = TTY_DRIVER_MAGIC,
658 tty->major = GIG_MAJOR,
659 tty->type = TTY_DRIVER_TYPE_SERIAL,
660 tty->subtype = SERIAL_TYPE_NORMAL,
661 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
663 tty->driver_name = procname;
665 tty->minor_start = drv->minor;
666 tty->num = drv->minors;
668 tty->owner = THIS_MODULE;
670 tty->init_termios = tty_std_termios;
671 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
672 tty_set_operations(tty, &if_ops);
674 ret = tty_register_driver(tty);
676 pr_err("error %d registering tty driver\n", ret);
679 gig_dbg(DEBUG_IF, "tty driver initialized");
684 pr_err("out of memory\n");
687 put_tty_driver(drv->tty);
690 void gigaset_if_freedriver(struct gigaset_driver *drv)
696 tty_unregister_driver(drv->tty);
697 put_tty_driver(drv->tty);