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 gig_dbg(DEBUG_IF, "not connected"); /* nothing to do */
198 else if (!cs->open_count)
199 dev_warn(cs->dev, "%s: device not opened\n", __func__);
201 if (!--cs->open_count) {
202 spin_lock_irqsave(&cs->lock, flags);
204 spin_unlock_irqrestore(&cs->lock, flags);
208 mutex_unlock(&cs->mutex);
210 module_put(cs->driver->owner);
213 static int if_ioctl(struct tty_struct *tty, struct file *file,
214 unsigned int cmd, unsigned long arg)
216 struct cardstate *cs;
217 int retval = -ENODEV;
219 unsigned char buf[6];
222 cs = (struct cardstate *) tty->driver_data;
224 pr_err("%s: no cardstate\n", __func__);
228 gig_dbg(DEBUG_IF, "%u: %s(0x%x)", cs->minor_index, __func__, cmd);
230 if (mutex_lock_interruptible(&cs->mutex))
231 return -ERESTARTSYS; // FIXME -EINTR?
233 if (!cs->connected) {
234 gig_dbg(DEBUG_IF, "not connected");
236 } else if (!cs->open_count)
237 dev_warn(cs->dev, "%s: device not opened\n", __func__);
242 retval = get_user(int_arg, (int __user *) arg);
244 retval = if_lock(cs, &int_arg);
246 retval = put_user(int_arg, (int __user *) arg);
249 retval = get_user(int_arg, (int __user *) arg);
251 retval = if_config(cs, &int_arg);
253 retval = put_user(int_arg, (int __user *) arg);
255 case GIGASET_BRKCHARS:
256 retval = copy_from_user(&buf,
257 (const unsigned char __user *) arg, 6)
260 gigaset_dbg_buffer(DEBUG_IF, "GIGASET_BRKCHARS",
261 6, (const unsigned char *) arg);
262 retval = cs->ops->brkchars(cs, buf);
265 case GIGASET_VERSION:
266 retval = copy_from_user(version,
267 (unsigned __user *) arg, sizeof version)
270 retval = if_version(cs, version);
272 retval = copy_to_user((unsigned __user *) arg,
273 version, sizeof version)
277 gig_dbg(DEBUG_ANY, "%s: arg not supported - 0x%04x",
279 retval = -ENOIOCTLCMD;
283 mutex_unlock(&cs->mutex);
288 static int if_tiocmget(struct tty_struct *tty, struct file *file)
290 struct cardstate *cs;
293 cs = (struct cardstate *) tty->driver_data;
295 pr_err("%s: no cardstate\n", __func__);
299 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
301 if (mutex_lock_interruptible(&cs->mutex))
302 return -ERESTARTSYS; // FIXME -EINTR?
304 // FIXME read from device?
305 retval = cs->control_state & (TIOCM_RTS|TIOCM_DTR);
307 mutex_unlock(&cs->mutex);
312 static int if_tiocmset(struct tty_struct *tty, struct file *file,
313 unsigned int set, unsigned int clear)
315 struct cardstate *cs;
319 cs = (struct cardstate *) tty->driver_data;
321 pr_err("%s: no cardstate\n", __func__);
325 gig_dbg(DEBUG_IF, "%u: %s(0x%x, 0x%x)",
326 cs->minor_index, __func__, set, clear);
328 if (mutex_lock_interruptible(&cs->mutex))
329 return -ERESTARTSYS; // FIXME -EINTR?
331 if (!cs->connected) {
332 gig_dbg(DEBUG_IF, "not connected");
335 mc = (cs->control_state | set) & ~clear & (TIOCM_RTS|TIOCM_DTR);
336 retval = cs->ops->set_modem_ctrl(cs, cs->control_state, mc);
337 cs->control_state = mc;
340 mutex_unlock(&cs->mutex);
345 static int if_write(struct tty_struct *tty, const unsigned char *buf, int count)
347 struct cardstate *cs;
348 int retval = -ENODEV;
350 cs = (struct cardstate *) tty->driver_data;
352 pr_err("%s: no cardstate\n", __func__);
356 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
358 if (mutex_lock_interruptible(&cs->mutex))
359 return -ERESTARTSYS; // FIXME -EINTR?
361 if (!cs->connected) {
362 gig_dbg(DEBUG_IF, "not connected");
364 } else if (!cs->open_count)
365 dev_warn(cs->dev, "%s: device not opened\n", __func__);
366 else if (cs->mstate != MS_LOCKED) {
367 dev_warn(cs->dev, "can't write to unlocked device\n");
370 retval = cs->ops->write_cmd(cs, buf, count,
371 &cs->if_wake_tasklet);
374 mutex_unlock(&cs->mutex);
379 static int if_write_room(struct tty_struct *tty)
381 struct cardstate *cs;
382 int retval = -ENODEV;
384 cs = (struct cardstate *) tty->driver_data;
386 pr_err("%s: no cardstate\n", __func__);
390 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
392 if (mutex_lock_interruptible(&cs->mutex))
393 return -ERESTARTSYS; // FIXME -EINTR?
395 if (!cs->connected) {
396 gig_dbg(DEBUG_IF, "not connected");
398 } else if (!cs->open_count)
399 dev_warn(cs->dev, "%s: device not opened\n", __func__);
400 else if (cs->mstate != MS_LOCKED) {
401 dev_warn(cs->dev, "can't write to unlocked device\n");
404 retval = cs->ops->write_room(cs);
406 mutex_unlock(&cs->mutex);
411 static int if_chars_in_buffer(struct tty_struct *tty)
413 struct cardstate *cs;
414 int retval = -ENODEV;
416 cs = (struct cardstate *) tty->driver_data;
418 pr_err("%s: no cardstate\n", __func__);
422 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
424 if (mutex_lock_interruptible(&cs->mutex))
425 return -ERESTARTSYS; // FIXME -EINTR?
427 if (!cs->connected) {
428 gig_dbg(DEBUG_IF, "not connected");
430 } else if (!cs->open_count)
431 dev_warn(cs->dev, "%s: device not opened\n", __func__);
432 else if (cs->mstate != MS_LOCKED) {
433 dev_warn(cs->dev, "can't write to unlocked device\n");
436 retval = cs->ops->chars_in_buffer(cs);
438 mutex_unlock(&cs->mutex);
443 static void if_throttle(struct tty_struct *tty)
445 struct cardstate *cs;
447 cs = (struct cardstate *) tty->driver_data;
449 pr_err("%s: no cardstate\n", __func__);
453 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
455 mutex_lock(&cs->mutex);
458 gig_dbg(DEBUG_IF, "not connected"); /* nothing to do */
459 else if (!cs->open_count)
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 gig_dbg(DEBUG_IF, "not connected"); /* nothing to do */
484 else if (!cs->open_count)
485 dev_warn(cs->dev, "%s: device not opened\n", __func__);
490 mutex_unlock(&cs->mutex);
493 static void if_set_termios(struct tty_struct *tty, struct ktermios *old)
495 struct cardstate *cs;
498 unsigned int old_cflag;
499 unsigned int control_state, new_state;
501 cs = (struct cardstate *) tty->driver_data;
503 pr_err("%s: no cardstate\n", __func__);
507 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
509 mutex_lock(&cs->mutex);
511 if (!cs->connected) {
512 gig_dbg(DEBUG_IF, "not connected");
516 if (!cs->open_count) {
517 dev_warn(cs->dev, "%s: device not opened\n", __func__);
521 // stolen from mct_u232.c
522 iflag = tty->termios->c_iflag;
523 cflag = tty->termios->c_cflag;
524 old_cflag = old ? old->c_cflag : cflag; //FIXME?
525 gig_dbg(DEBUG_IF, "%u: iflag %x cflag %x old %x",
526 cs->minor_index, iflag, cflag, old_cflag);
528 /* get a local copy of the current port settings */
529 control_state = cs->control_state;
533 * Do not attempt to cache old rates and skip settings,
534 * disconnects screw such tricks up completely.
535 * Premature optimization is the root of all evil.
538 /* reassert DTR and (maybe) RTS on transition from B0 */
539 if ((old_cflag & CBAUD) == B0) {
540 new_state = control_state | TIOCM_DTR;
541 /* don't set RTS if using hardware flow control */
542 if (!(old_cflag & CRTSCTS))
543 new_state |= TIOCM_RTS;
544 gig_dbg(DEBUG_IF, "%u: from B0 - set DTR%s",
546 (new_state & TIOCM_RTS) ? " only" : "/RTS");
547 cs->ops->set_modem_ctrl(cs, control_state, new_state);
548 control_state = new_state;
551 cs->ops->baud_rate(cs, cflag & CBAUD);
553 if ((cflag & CBAUD) == B0) {
554 /* Drop RTS and DTR */
555 gig_dbg(DEBUG_IF, "%u: to B0 - drop DTR/RTS", cs->minor_index);
556 new_state = control_state & ~(TIOCM_DTR | TIOCM_RTS);
557 cs->ops->set_modem_ctrl(cs, control_state, new_state);
558 control_state = new_state;
562 * Update line control register (LCR)
565 cs->ops->set_line_ctrl(cs, cflag);
567 /* save off the modified port settings */
568 cs->control_state = control_state;
571 mutex_unlock(&cs->mutex);
575 /* wakeup tasklet for the write operation */
576 static void if_wake(unsigned long data)
578 struct cardstate *cs = (struct cardstate *) data;
584 /*** interface to common ***/
586 void gigaset_if_init(struct cardstate *cs)
588 struct gigaset_driver *drv;
594 tasklet_init(&cs->if_wake_tasklet, &if_wake, (unsigned long) cs);
596 mutex_lock(&cs->mutex);
597 cs->tty_dev = tty_register_device(drv->tty, cs->minor_index, NULL);
599 if (!IS_ERR(cs->tty_dev))
600 dev_set_drvdata(cs->tty_dev, cs);
603 "could not register device to the tty subsystem\n");
606 mutex_unlock(&cs->mutex);
609 void gigaset_if_free(struct cardstate *cs)
611 struct gigaset_driver *drv;
617 tasklet_disable(&cs->if_wake_tasklet);
618 tasklet_kill(&cs->if_wake_tasklet);
620 tty_unregister_device(drv->tty, cs->minor_index);
623 void gigaset_if_receive(struct cardstate *cs,
624 unsigned char *buffer, size_t len)
627 struct tty_struct *tty;
629 spin_lock_irqsave(&cs->lock, flags);
630 if ((tty = cs->tty) == NULL)
631 gig_dbg(DEBUG_ANY, "receive on closed device");
633 tty_buffer_request_room(tty, len);
634 tty_insert_flip_string(tty, buffer, len);
635 tty_flip_buffer_push(tty);
637 spin_unlock_irqrestore(&cs->lock, flags);
639 EXPORT_SYMBOL_GPL(gigaset_if_receive);
641 /* gigaset_if_initdriver
642 * Initialize tty interface.
645 * procname Name of the driver (e.g. for /proc/tty/drivers)
646 * devname Name of the device files (prefix without minor number)
648 void gigaset_if_initdriver(struct gigaset_driver *drv, const char *procname,
651 unsigned minors = drv->minors;
653 struct tty_driver *tty;
657 if ((drv->tty = alloc_tty_driver(minors)) == NULL)
661 tty->magic = TTY_DRIVER_MAGIC,
662 tty->major = GIG_MAJOR,
663 tty->type = TTY_DRIVER_TYPE_SERIAL,
664 tty->subtype = SERIAL_TYPE_NORMAL,
665 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
667 tty->driver_name = procname;
669 tty->minor_start = drv->minor;
670 tty->num = drv->minors;
672 tty->owner = THIS_MODULE;
674 tty->init_termios = tty_std_termios; //FIXME
675 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL; //FIXME
676 tty_set_operations(tty, &if_ops);
678 ret = tty_register_driver(tty);
680 pr_err("error %d registering tty driver\n", ret);
683 gig_dbg(DEBUG_IF, "tty driver initialized");
688 pr_err("out of memory\n");
691 put_tty_driver(drv->tty);
694 void gigaset_if_freedriver(struct gigaset_driver *drv)
700 tty_unregister_driver(drv->tty);
701 put_tty_driver(drv->tty);