2 * IPWireless 3G PCMCIA Network Driver
5 * by Stephen Blackheath <stephen@blacksapphire.com>,
6 * Ben Martel <benm@symmetric.co.nz>
8 * Copyrighted as follows:
9 * Copyright (C) 2004 by Symmetric Systems Ltd (NZ)
11 * Various driver changes and rewrites, port to new kernels
12 * Copyright (C) 2006-2007 Jiri Kosina
14 * Misc code cleanups and updates
15 * Copyright (C) 2007 David Sterba
18 #include <linux/init.h>
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/mutex.h>
22 #include <linux/ppp_defs.h>
24 #include <linux/if_ppp.h>
25 #include <linux/sched.h>
26 #include <linux/serial.h>
27 #include <linux/slab.h>
28 #include <linux/tty.h>
29 #include <linux/tty_driver.h>
30 #include <linux/tty_flip.h>
31 #include <linux/uaccess.h>
38 #define IPWIRELESS_PCMCIA_START (0)
39 #define IPWIRELESS_PCMCIA_MINORS (24)
40 #define IPWIRELESS_PCMCIA_MINOR_RANGE (8)
42 #define TTYTYPE_MODEM (0)
43 #define TTYTYPE_MONITOR (1)
44 #define TTYTYPE_RAS_RAW (2)
48 struct ipw_hardware *hardware;
49 unsigned int channel_idx;
50 unsigned int secondary_channel_idx;
52 struct ipw_network *network;
53 struct tty_struct *linux_tty;
55 unsigned int control_lines;
56 struct mutex ipw_tty_mutex;
61 static struct ipw_tty *ttys[IPWIRELESS_PCMCIA_MINORS];
63 static struct tty_driver *ipw_tty_driver;
65 static char *tty_type_name(int tty_type)
67 static char *channel_names[] = {
73 return channel_names[tty_type];
76 static void report_registering(struct ipw_tty *tty)
78 char *iftype = tty_type_name(tty->tty_type);
80 printk(KERN_INFO IPWIRELESS_PCCARD_NAME
81 ": registering %s device ttyIPWp%d\n", iftype, tty->index);
84 static void report_deregistering(struct ipw_tty *tty)
86 char *iftype = tty_type_name(tty->tty_type);
88 printk(KERN_INFO IPWIRELESS_PCCARD_NAME
89 ": deregistering %s device ttyIPWp%d\n", iftype,
93 static struct ipw_tty *get_tty(int minor)
95 if (minor < ipw_tty_driver->minor_start
96 || minor >= ipw_tty_driver->minor_start +
97 IPWIRELESS_PCMCIA_MINORS)
100 int minor_offset = minor - ipw_tty_driver->minor_start;
103 * The 'ras_raw' channel is only available when 'loopback' mode
105 * Number of minor starts with 16 (_RANGE * _RAS_RAW).
107 if (!ipwireless_loopback &&
109 IPWIRELESS_PCMCIA_MINOR_RANGE * TTYTYPE_RAS_RAW)
112 return ttys[minor_offset];
116 static int ipw_open(struct tty_struct *linux_tty, struct file *filp)
118 int minor = linux_tty->index;
119 struct ipw_tty *tty = get_tty(minor);
124 mutex_lock(&tty->ipw_tty_mutex);
127 mutex_unlock(&tty->ipw_tty_mutex);
130 if (tty->open_count == 0)
131 tty->tx_bytes_queued = 0;
135 tty->linux_tty = linux_tty;
136 linux_tty->driver_data = tty;
137 linux_tty->low_latency = 1;
139 if (tty->tty_type == TTYTYPE_MODEM)
140 ipwireless_ppp_open(tty->network);
142 mutex_unlock(&tty->ipw_tty_mutex);
147 static void do_ipw_close(struct ipw_tty *tty)
151 if (tty->open_count == 0) {
152 struct tty_struct *linux_tty = tty->linux_tty;
154 if (linux_tty != NULL) {
155 tty->linux_tty = NULL;
156 linux_tty->driver_data = NULL;
158 if (tty->tty_type == TTYTYPE_MODEM)
159 ipwireless_ppp_close(tty->network);
164 static void ipw_hangup(struct tty_struct *linux_tty)
166 struct ipw_tty *tty = linux_tty->driver_data;
171 mutex_lock(&tty->ipw_tty_mutex);
172 if (tty->open_count == 0) {
173 mutex_unlock(&tty->ipw_tty_mutex);
179 mutex_unlock(&tty->ipw_tty_mutex);
182 static void ipw_close(struct tty_struct *linux_tty, struct file *filp)
184 ipw_hangup(linux_tty);
187 /* Take data received from hardware, and send it out the tty */
188 void ipwireless_tty_received(struct ipw_tty *tty, unsigned char *data,
191 struct tty_struct *linux_tty;
194 mutex_lock(&tty->ipw_tty_mutex);
195 linux_tty = tty->linux_tty;
196 if (linux_tty == NULL) {
197 mutex_unlock(&tty->ipw_tty_mutex);
201 if (!tty->open_count) {
202 mutex_unlock(&tty->ipw_tty_mutex);
205 mutex_unlock(&tty->ipw_tty_mutex);
207 work = tty_insert_flip_string(linux_tty, data, length);
210 printk(KERN_DEBUG IPWIRELESS_PCCARD_NAME
211 ": %d chars not inserted to flip buffer!\n",
215 * This may sleep if ->low_latency is set
218 tty_flip_buffer_push(linux_tty);
221 static void ipw_write_packet_sent_callback(void *callback_data,
222 unsigned int packet_length)
224 struct ipw_tty *tty = callback_data;
227 * Packet has been sent, so we subtract the number of bytes from our
228 * tally of outstanding TX bytes.
230 tty->tx_bytes_queued -= packet_length;
233 static int ipw_write(struct tty_struct *linux_tty,
234 const unsigned char *buf, int count)
236 struct ipw_tty *tty = linux_tty->driver_data;
242 mutex_lock(&tty->ipw_tty_mutex);
243 if (!tty->open_count) {
244 mutex_unlock(&tty->ipw_tty_mutex);
248 room = IPWIRELESS_TX_QUEUE_SIZE - tty->tx_bytes_queued;
251 /* Don't allow caller to write any more than we have room for */
256 mutex_unlock(&tty->ipw_tty_mutex);
260 ret = ipwireless_send_packet(tty->hardware, IPW_CHANNEL_RAS,
262 ipw_write_packet_sent_callback, tty);
264 mutex_unlock(&tty->ipw_tty_mutex);
268 tty->tx_bytes_queued += count;
269 mutex_unlock(&tty->ipw_tty_mutex);
274 static int ipw_write_room(struct tty_struct *linux_tty)
276 struct ipw_tty *tty = linux_tty->driver_data;
279 /* FIXME: Exactly how is the tty object locked here .. */
283 if (!tty->open_count)
286 room = IPWIRELESS_TX_QUEUE_SIZE - tty->tx_bytes_queued;
293 static int ipwireless_get_serial_info(struct ipw_tty *tty,
294 struct serial_struct __user *retinfo)
296 struct serial_struct tmp;
301 memset(&tmp, 0, sizeof(tmp));
302 tmp.type = PORT_UNKNOWN;
303 tmp.line = tty->index;
307 tmp.baud_base = 115200;
309 tmp.closing_wait = 0;
310 tmp.custom_divisor = 0;
312 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
318 static int ipw_chars_in_buffer(struct tty_struct *linux_tty)
320 struct ipw_tty *tty = linux_tty->driver_data;
325 if (!tty->open_count)
328 return tty->tx_bytes_queued;
331 static int get_control_lines(struct ipw_tty *tty)
333 unsigned int my = tty->control_lines;
334 unsigned int out = 0;
336 if (my & IPW_CONTROL_LINE_RTS)
338 if (my & IPW_CONTROL_LINE_DTR)
340 if (my & IPW_CONTROL_LINE_CTS)
342 if (my & IPW_CONTROL_LINE_DSR)
344 if (my & IPW_CONTROL_LINE_DCD)
350 static int set_control_lines(struct ipw_tty *tty, unsigned int set,
355 if (set & TIOCM_RTS) {
356 ret = ipwireless_set_RTS(tty->hardware, tty->channel_idx, 1);
359 if (tty->secondary_channel_idx != -1) {
360 ret = ipwireless_set_RTS(tty->hardware,
361 tty->secondary_channel_idx, 1);
366 if (set & TIOCM_DTR) {
367 ret = ipwireless_set_DTR(tty->hardware, tty->channel_idx, 1);
370 if (tty->secondary_channel_idx != -1) {
371 ret = ipwireless_set_DTR(tty->hardware,
372 tty->secondary_channel_idx, 1);
377 if (clear & TIOCM_RTS) {
378 ret = ipwireless_set_RTS(tty->hardware, tty->channel_idx, 0);
379 if (tty->secondary_channel_idx != -1) {
380 ret = ipwireless_set_RTS(tty->hardware,
381 tty->secondary_channel_idx, 0);
386 if (clear & TIOCM_DTR) {
387 ret = ipwireless_set_DTR(tty->hardware, tty->channel_idx, 0);
388 if (tty->secondary_channel_idx != -1) {
389 ret = ipwireless_set_DTR(tty->hardware,
390 tty->secondary_channel_idx, 0);
398 static int ipw_tiocmget(struct tty_struct *linux_tty, struct file *file)
400 struct ipw_tty *tty = linux_tty->driver_data;
401 /* FIXME: Exactly how is the tty object locked here .. */
406 if (!tty->open_count)
409 return get_control_lines(tty);
413 ipw_tiocmset(struct tty_struct *linux_tty, struct file *file,
414 unsigned int set, unsigned int clear)
416 struct ipw_tty *tty = linux_tty->driver_data;
417 /* FIXME: Exactly how is the tty object locked here .. */
422 if (!tty->open_count)
425 return set_control_lines(tty, set, clear);
428 static int ipw_ioctl(struct tty_struct *linux_tty, struct file *file,
429 unsigned int cmd, unsigned long arg)
431 struct ipw_tty *tty = linux_tty->driver_data;
436 if (!tty->open_count)
439 /* FIXME: Exactly how is the tty object locked here .. */
443 return ipwireless_get_serial_info(tty, (void __user *) arg);
446 return 0; /* Keeps the PCMCIA scripts happy. */
449 if (tty->tty_type == TTYTYPE_MODEM) {
453 int chan = ipwireless_ppp_channel_index(
458 if (put_user(chan, (int __user *) arg))
465 int unit = ipwireless_ppp_unit_number(
470 if (put_user(unit, (int __user *) arg))
479 if (put_user(val, (int __user *) arg))
484 return tty_perform_flush(linux_tty, arg);
487 return tty_mode_ioctl(linux_tty, file, cmd , arg);
490 static int add_tty(dev_node_t *nodesp, int j,
491 struct ipw_hardware *hardware,
492 struct ipw_network *network, int channel_idx,
493 int secondary_channel_idx, int tty_type)
495 ttys[j] = kzalloc(sizeof(struct ipw_tty), GFP_KERNEL);
499 ttys[j]->hardware = hardware;
500 ttys[j]->channel_idx = channel_idx;
501 ttys[j]->secondary_channel_idx = secondary_channel_idx;
502 ttys[j]->network = network;
503 ttys[j]->tty_type = tty_type;
504 mutex_init(&ttys[j]->ipw_tty_mutex);
506 tty_register_device(ipw_tty_driver, j, NULL);
507 ipwireless_associate_network_tty(network, channel_idx, ttys[j]);
509 if (secondary_channel_idx != -1)
510 ipwireless_associate_network_tty(network,
511 secondary_channel_idx,
513 if (nodesp != NULL) {
514 sprintf(nodesp->dev_name, "ttyIPWp%d", j);
515 nodesp->major = ipw_tty_driver->major;
516 nodesp->minor = j + ipw_tty_driver->minor_start;
518 if (get_tty(j + ipw_tty_driver->minor_start) == ttys[j])
519 report_registering(ttys[j]);
523 struct ipw_tty *ipwireless_tty_create(struct ipw_hardware *hardware,
524 struct ipw_network *network,
529 for (i = 0; i < IPWIRELESS_PCMCIA_MINOR_RANGE; i++) {
532 for (j = i; j < IPWIRELESS_PCMCIA_MINORS;
533 j += IPWIRELESS_PCMCIA_MINOR_RANGE)
534 if (ttys[j] != NULL) {
542 if (add_tty(&nodes[0], j, hardware, network,
543 IPW_CHANNEL_DIALLER, IPW_CHANNEL_RAS,
547 j += IPWIRELESS_PCMCIA_MINOR_RANGE;
548 if (add_tty(&nodes[1], j, hardware, network,
549 IPW_CHANNEL_DIALLER, -1,
553 j += IPWIRELESS_PCMCIA_MINOR_RANGE;
554 if (add_tty(NULL, j, hardware, network,
559 nodes[0].next = &nodes[1];
560 nodes[1].next = NULL;
569 * Must be called before ipwireless_network_free().
571 void ipwireless_tty_free(struct ipw_tty *tty)
574 struct ipw_network *network = ttys[tty->index]->network;
576 for (j = tty->index; j < IPWIRELESS_PCMCIA_MINORS;
577 j += IPWIRELESS_PCMCIA_MINOR_RANGE) {
578 struct ipw_tty *ttyj = ttys[j];
581 mutex_lock(&ttyj->ipw_tty_mutex);
582 if (get_tty(j + ipw_tty_driver->minor_start) == ttyj)
583 report_deregistering(ttyj);
585 if (ttyj->linux_tty != NULL) {
586 mutex_unlock(&ttyj->ipw_tty_mutex);
587 tty_hangup(ttyj->linux_tty);
588 /* Wait till the tty_hangup has completed */
589 flush_scheduled_work();
590 /* FIXME: Exactly how is the tty object locked here
591 against a parallel ioctl etc */
592 mutex_lock(&ttyj->ipw_tty_mutex);
594 while (ttyj->open_count)
596 ipwireless_disassociate_network_ttys(network,
598 tty_unregister_device(ipw_tty_driver, j);
600 mutex_unlock(&ttyj->ipw_tty_mutex);
606 static struct tty_operations tty_ops = {
609 .hangup = ipw_hangup,
611 .write_room = ipw_write_room,
613 .chars_in_buffer = ipw_chars_in_buffer,
614 .tiocmget = ipw_tiocmget,
615 .tiocmset = ipw_tiocmset,
618 int ipwireless_tty_init(void)
622 ipw_tty_driver = alloc_tty_driver(IPWIRELESS_PCMCIA_MINORS);
626 ipw_tty_driver->owner = THIS_MODULE;
627 ipw_tty_driver->driver_name = IPWIRELESS_PCCARD_NAME;
628 ipw_tty_driver->name = "ttyIPWp";
629 ipw_tty_driver->major = 0;
630 ipw_tty_driver->minor_start = IPWIRELESS_PCMCIA_START;
631 ipw_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
632 ipw_tty_driver->subtype = SERIAL_TYPE_NORMAL;
633 ipw_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
634 ipw_tty_driver->init_termios = tty_std_termios;
635 ipw_tty_driver->init_termios.c_cflag =
636 B9600 | CS8 | CREAD | HUPCL | CLOCAL;
637 ipw_tty_driver->init_termios.c_ispeed = 9600;
638 ipw_tty_driver->init_termios.c_ospeed = 9600;
639 tty_set_operations(ipw_tty_driver, &tty_ops);
640 result = tty_register_driver(ipw_tty_driver);
642 printk(KERN_ERR IPWIRELESS_PCCARD_NAME
643 ": failed to register tty driver\n");
644 put_tty_driver(ipw_tty_driver);
651 void ipwireless_tty_release(void)
655 ret = tty_unregister_driver(ipw_tty_driver);
656 put_tty_driver(ipw_tty_driver);
658 printk(KERN_ERR IPWIRELESS_PCCARD_NAME
659 ": tty_unregister_driver failed with code %d\n", ret);
662 int ipwireless_tty_is_modem(struct ipw_tty *tty)
664 return tty->tty_type == TTYTYPE_MODEM;
668 ipwireless_tty_notify_control_line_change(struct ipw_tty *tty,
669 unsigned int channel_idx,
670 unsigned int control_lines,
671 unsigned int changed_mask)
673 unsigned int old_control_lines = tty->control_lines;
675 tty->control_lines = (tty->control_lines & ~changed_mask)
676 | (control_lines & changed_mask);
679 * If DCD is de-asserted, we close the tty so pppd can tell that we
682 if ((old_control_lines & IPW_CONTROL_LINE_DCD)
683 && !(tty->control_lines & IPW_CONTROL_LINE_DCD)
685 tty_hangup(tty->linux_tty);