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 ***/
116 static int if_open(struct tty_struct *tty, struct file *filp)
118 struct cardstate *cs;
120 gig_dbg(DEBUG_IF, "%d+%d: %s()",
121 tty->driver->minor_start, tty->index, __func__);
123 cs = gigaset_get_cs_by_tty(tty);
124 if (!cs || !try_module_get(cs->driver->owner))
127 if (mutex_lock_interruptible(&cs->mutex)) {
128 module_put(cs->driver->owner);
131 tty->driver_data = cs;
135 if (cs->port.count == 1) {
136 tty_port_tty_set(&cs->port, tty);
137 cs->port.low_latency = 1;
140 mutex_unlock(&cs->mutex);
144 static void if_close(struct tty_struct *tty, struct file *filp)
146 struct cardstate *cs = tty->driver_data;
148 if (!cs) { /* happens if we didn't find cs in open */
149 gig_dbg(DEBUG_IF, "%s: no cardstate", __func__);
153 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
155 mutex_lock(&cs->mutex);
158 gig_dbg(DEBUG_IF, "not connected"); /* nothing to do */
159 else if (!cs->port.count)
160 dev_warn(cs->dev, "%s: device not opened\n", __func__);
161 else if (!--cs->port.count)
162 tty_port_tty_set(&cs->port, NULL);
164 mutex_unlock(&cs->mutex);
166 module_put(cs->driver->owner);
169 static int if_ioctl(struct tty_struct *tty,
170 unsigned int cmd, unsigned long arg)
172 struct cardstate *cs = tty->driver_data;
173 int retval = -ENODEV;
175 unsigned char buf[6];
178 gig_dbg(DEBUG_IF, "%u: %s(0x%x)", cs->minor_index, __func__, cmd);
180 if (mutex_lock_interruptible(&cs->mutex))
183 if (!cs->connected) {
184 gig_dbg(DEBUG_IF, "not connected");
190 retval = get_user(int_arg, (int __user *) arg);
192 retval = if_lock(cs, &int_arg);
194 retval = put_user(int_arg, (int __user *) arg);
197 retval = get_user(int_arg, (int __user *) arg);
199 retval = if_config(cs, &int_arg);
201 retval = put_user(int_arg, (int __user *) arg);
203 case GIGASET_BRKCHARS:
204 retval = copy_from_user(&buf,
205 (const unsigned char __user *) arg, 6)
208 gigaset_dbg_buffer(DEBUG_IF, "GIGASET_BRKCHARS",
209 6, (const unsigned char *) arg);
210 retval = cs->ops->brkchars(cs, buf);
213 case GIGASET_VERSION:
214 retval = copy_from_user(version,
215 (unsigned __user *) arg, sizeof version)
218 retval = if_version(cs, version);
220 retval = copy_to_user((unsigned __user *) arg,
221 version, sizeof version)
225 gig_dbg(DEBUG_IF, "%s: arg not supported - 0x%04x",
227 retval = -ENOIOCTLCMD;
231 mutex_unlock(&cs->mutex);
236 static int if_tiocmget(struct tty_struct *tty)
238 struct cardstate *cs = tty->driver_data;
241 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
243 if (mutex_lock_interruptible(&cs->mutex))
246 retval = cs->control_state & (TIOCM_RTS | TIOCM_DTR);
248 mutex_unlock(&cs->mutex);
253 static int if_tiocmset(struct tty_struct *tty,
254 unsigned int set, unsigned int clear)
256 struct cardstate *cs = tty->driver_data;
260 gig_dbg(DEBUG_IF, "%u: %s(0x%x, 0x%x)",
261 cs->minor_index, __func__, set, clear);
263 if (mutex_lock_interruptible(&cs->mutex))
266 if (!cs->connected) {
267 gig_dbg(DEBUG_IF, "not connected");
270 mc = (cs->control_state | set) & ~clear & (TIOCM_RTS | TIOCM_DTR);
271 retval = cs->ops->set_modem_ctrl(cs, cs->control_state, mc);
272 cs->control_state = mc;
275 mutex_unlock(&cs->mutex);
280 static int if_write(struct tty_struct *tty, const unsigned char *buf, int count)
282 struct cardstate *cs = tty->driver_data;
286 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
288 if (mutex_lock_interruptible(&cs->mutex))
291 if (!cs->connected) {
292 gig_dbg(DEBUG_IF, "not connected");
296 if (cs->mstate != MS_LOCKED) {
297 dev_warn(cs->dev, "can't write to unlocked device\n");
307 cb = kmalloc(sizeof(struct cmdbuf_t) + count, GFP_KERNEL);
309 dev_err(cs->dev, "%s: out of memory\n", __func__);
314 memcpy(cb->buf, buf, count);
318 cb->wake_tasklet = &cs->if_wake_tasklet;
319 retval = cs->ops->write_cmd(cs, cb);
321 mutex_unlock(&cs->mutex);
325 static int if_write_room(struct tty_struct *tty)
327 struct cardstate *cs = tty->driver_data;
330 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
332 if (mutex_lock_interruptible(&cs->mutex))
335 if (!cs->connected) {
336 gig_dbg(DEBUG_IF, "not connected");
338 } else if (cs->mstate != MS_LOCKED) {
339 dev_warn(cs->dev, "can't write to unlocked device\n");
342 retval = cs->ops->write_room(cs);
344 mutex_unlock(&cs->mutex);
349 static int if_chars_in_buffer(struct tty_struct *tty)
351 struct cardstate *cs = tty->driver_data;
354 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
356 mutex_lock(&cs->mutex);
359 gig_dbg(DEBUG_IF, "not connected");
360 else if (cs->mstate != MS_LOCKED)
361 dev_warn(cs->dev, "can't write to unlocked device\n");
363 retval = cs->ops->chars_in_buffer(cs);
365 mutex_unlock(&cs->mutex);
370 static void if_throttle(struct tty_struct *tty)
372 struct cardstate *cs = tty->driver_data;
374 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
376 mutex_lock(&cs->mutex);
379 gig_dbg(DEBUG_IF, "not connected"); /* nothing to do */
381 gig_dbg(DEBUG_IF, "%s: not implemented\n", __func__);
383 mutex_unlock(&cs->mutex);
386 static void if_unthrottle(struct tty_struct *tty)
388 struct cardstate *cs = tty->driver_data;
390 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
392 mutex_lock(&cs->mutex);
395 gig_dbg(DEBUG_IF, "not connected"); /* nothing to do */
397 gig_dbg(DEBUG_IF, "%s: not implemented\n", __func__);
399 mutex_unlock(&cs->mutex);
402 static void if_set_termios(struct tty_struct *tty, struct ktermios *old)
404 struct cardstate *cs = tty->driver_data;
407 unsigned int old_cflag;
408 unsigned int control_state, new_state;
410 gig_dbg(DEBUG_IF, "%u: %s()", cs->minor_index, __func__);
412 mutex_lock(&cs->mutex);
414 if (!cs->connected) {
415 gig_dbg(DEBUG_IF, "not connected");
419 iflag = tty->termios.c_iflag;
420 cflag = tty->termios.c_cflag;
421 old_cflag = old ? old->c_cflag : cflag;
422 gig_dbg(DEBUG_IF, "%u: iflag %x cflag %x old %x",
423 cs->minor_index, iflag, cflag, old_cflag);
425 /* get a local copy of the current port settings */
426 control_state = cs->control_state;
430 * Do not attempt to cache old rates and skip settings,
431 * disconnects screw such tricks up completely.
432 * Premature optimization is the root of all evil.
435 /* reassert DTR and (maybe) RTS on transition from B0 */
436 if ((old_cflag & CBAUD) == B0) {
437 new_state = control_state | TIOCM_DTR;
438 /* don't set RTS if using hardware flow control */
439 if (!(old_cflag & CRTSCTS))
440 new_state |= TIOCM_RTS;
441 gig_dbg(DEBUG_IF, "%u: from B0 - set DTR%s",
443 (new_state & TIOCM_RTS) ? " only" : "/RTS");
444 cs->ops->set_modem_ctrl(cs, control_state, new_state);
445 control_state = new_state;
448 cs->ops->baud_rate(cs, cflag & CBAUD);
450 if ((cflag & CBAUD) == B0) {
451 /* Drop RTS and DTR */
452 gig_dbg(DEBUG_IF, "%u: to B0 - drop DTR/RTS", cs->minor_index);
453 new_state = control_state & ~(TIOCM_DTR | TIOCM_RTS);
454 cs->ops->set_modem_ctrl(cs, control_state, new_state);
455 control_state = new_state;
459 * Update line control register (LCR)
462 cs->ops->set_line_ctrl(cs, cflag);
464 /* save off the modified port settings */
465 cs->control_state = control_state;
468 mutex_unlock(&cs->mutex);
471 static const struct tty_operations if_ops = {
476 .write_room = if_write_room,
477 .chars_in_buffer = if_chars_in_buffer,
478 .set_termios = if_set_termios,
479 .throttle = if_throttle,
480 .unthrottle = if_unthrottle,
481 .tiocmget = if_tiocmget,
482 .tiocmset = if_tiocmset,
486 /* wakeup tasklet for the write operation */
487 static void if_wake(unsigned long data)
489 struct cardstate *cs = (struct cardstate *)data;
491 tty_port_tty_wakeup(&cs->port);
494 /*** interface to common ***/
496 void gigaset_if_init(struct cardstate *cs)
498 struct gigaset_driver *drv;
504 tasklet_init(&cs->if_wake_tasklet, if_wake, (unsigned long) cs);
506 mutex_lock(&cs->mutex);
507 cs->tty_dev = tty_port_register_device(&cs->port, drv->tty,
508 cs->minor_index, NULL);
510 if (!IS_ERR(cs->tty_dev))
511 dev_set_drvdata(cs->tty_dev, cs);
513 pr_warning("could not register device to the tty subsystem\n");
516 mutex_unlock(&cs->mutex);
519 void gigaset_if_free(struct cardstate *cs)
521 struct gigaset_driver *drv;
527 tasklet_disable(&cs->if_wake_tasklet);
528 tasklet_kill(&cs->if_wake_tasklet);
530 tty_unregister_device(drv->tty, cs->minor_index);
534 * gigaset_if_receive() - pass a received block of data to the tty device
535 * @cs: device descriptor structure.
536 * @buffer: received data.
537 * @len: number of bytes received.
539 * Called by asyncdata/isocdata if a block of data received from the
540 * device must be sent to userspace through the ttyG* device.
542 void gigaset_if_receive(struct cardstate *cs,
543 unsigned char *buffer, size_t len)
545 tty_insert_flip_string(&cs->port, buffer, len);
546 tty_flip_buffer_push(&cs->port);
548 EXPORT_SYMBOL_GPL(gigaset_if_receive);
550 /* gigaset_if_initdriver
551 * Initialize tty interface.
554 * procname Name of the driver (e.g. for /proc/tty/drivers)
555 * devname Name of the device files (prefix without minor number)
557 void gigaset_if_initdriver(struct gigaset_driver *drv, const char *procname,
561 struct tty_driver *tty;
565 drv->tty = tty = alloc_tty_driver(drv->minors);
569 tty->type = TTY_DRIVER_TYPE_SERIAL;
570 tty->subtype = SERIAL_TYPE_NORMAL;
571 tty->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
573 tty->driver_name = procname;
575 tty->minor_start = drv->minor;
577 tty->init_termios = tty_std_termios;
578 tty->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
579 tty_set_operations(tty, &if_ops);
581 ret = tty_register_driver(tty);
583 pr_err("error %d registering tty driver\n", ret);
586 gig_dbg(DEBUG_IF, "tty driver initialized");
591 pr_err("out of memory\n");
594 put_tty_driver(drv->tty);
597 void gigaset_if_freedriver(struct gigaset_driver *drv)
603 tty_unregister_driver(drv->tty);
604 put_tty_driver(drv->tty);