blob: 19e24045b137a2964b450afbf94cc930de3cd427 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB Serial Console driver
3 *
4 * Copyright (C) 2001 - 2002 Greg Kroah-Hartman (greg@kroah.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version
8 * 2 as published by the Free Software Foundation.
Alan Cox4dbd5a02008-07-22 11:09:57 +01009 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 * Thanks to Randy Dunlap for the original version of this code.
11 *
12 */
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/kernel.h>
15#include <linux/init.h>
16#include <linux/slab.h>
17#include <linux/tty.h>
18#include <linux/console.h>
19#include <linux/usb.h>
Greg Kroah-Hartmana9698882006-07-11 21:22:58 -070020#include <linux/usb/serial.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22static int debug;
23
Linus Torvalds1da177e2005-04-16 15:20:36 -070024struct usbcons_info {
25 int magic;
26 int break_flag;
27 struct usb_serial_port *port;
28};
29
30static struct usbcons_info usbcons_info;
31static struct console usbcons;
32
33/*
34 * ------------------------------------------------------------
35 * USB Serial console driver
36 *
37 * Much of the code here is copied from drivers/char/serial.c
38 * and implements a phony serial console in the same way that
39 * serial.c does so that in case some software queries it,
40 * it will get the same results.
41 *
42 * Things that are different from the way the serial port code
43 * does things, is that we call the lower level usb-serial
44 * driver code to initialize the device, and we set the initial
45 * console speeds based on the command line arguments.
46 * ------------------------------------------------------------
47 */
48
49
50/*
51 * The parsing of the command line works exactly like the
52 * serial.c code, except that the specifier is "ttyUSB" instead
53 * of "ttyS".
54 */
Paul Fulghum69a4bf72006-04-12 23:41:59 +020055static int usb_console_setup(struct console *co, char *options)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056{
57 struct usbcons_info *info = &usbcons_info;
58 int baud = 9600;
59 int bits = 8;
60 int parity = 'n';
61 int doflow = 0;
62 int cflag = CREAD | HUPCL | CLOCAL;
63 char *s;
64 struct usb_serial *serial;
65 struct usb_serial_port *port;
66 int retval = 0;
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -050067 struct tty_struct *tty = NULL;
68 struct ktermios *termios = NULL, dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Alan Cox4dbd5a02008-07-22 11:09:57 +010070 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72 if (options) {
73 baud = simple_strtoul(options, NULL, 10);
74 s = options;
75 while (*s >= '0' && *s <= '9')
76 s++;
77 if (*s)
78 parity = *s++;
79 if (*s)
80 bits = *s++ - '0';
81 if (*s)
82 doflow = (*s++ == 'r');
83 }
Alan Coxc17ee882008-07-22 11:10:08 +010084
85 /* Sane default */
86 if (baud == 0)
87 baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 switch (bits) {
Alan Cox4dbd5a02008-07-22 11:09:57 +010090 case 7:
91 cflag |= CS7;
92 break;
93 default:
94 case 8:
95 cflag |= CS8;
96 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 }
98 switch (parity) {
Alan Cox4dbd5a02008-07-22 11:09:57 +010099 case 'o': case 'O':
100 cflag |= PARODD;
101 break;
102 case 'e': case 'E':
103 cflag |= PARENB;
104 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 }
106 co->cflag = cflag;
107
Aristeu Rozanski27680d22007-11-12 15:14:49 -0500108 /*
109 * no need to check the index here: if the index is wrong, console
110 * code won't call us
111 */
112 serial = usb_serial_get_by_index(co->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 if (serial == NULL) {
114 /* no device is connected yet, sorry :( */
Alan Cox4dbd5a02008-07-22 11:09:57 +0100115 err("No USB device connected to ttyUSB%i", co->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 return -ENODEV;
117 }
118
119 port = serial->port[0];
Alan Cox4a90f092008-10-13 10:39:46 +0100120 tty_port_tty_set(&port->port, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122 info->port = port;
Alan Cox4dbd5a02008-07-22 11:09:57 +0100123
Alan Cox95da3102008-07-22 11:09:07 +0100124 ++port->port.count;
125 if (port->port.count == 1) {
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500126 if (serial->type->set_termios) {
127 /*
128 * allocate a fake tty so the driver can initialize
129 * the termios structure, then later call set_termios to
130 * configure according to command line arguments
131 */
132 tty = kzalloc(sizeof(*tty), GFP_KERNEL);
133 if (!tty) {
134 retval = -ENOMEM;
135 err("no more memory");
136 goto reset_open_count;
137 }
Kevin Haoe5404582008-12-01 11:36:16 +0000138 kref_init(&tty->kref);
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500139 termios = kzalloc(sizeof(*termios), GFP_KERNEL);
140 if (!termios) {
141 retval = -ENOMEM;
142 err("no more memory");
143 goto free_tty;
144 }
145 memset(&dummy, 0, sizeof(struct ktermios));
146 tty->termios = termios;
Alan Cox4a90f092008-10-13 10:39:46 +0100147 tty_port_tty_set(&port->port, tty);
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500148 }
149
Alan Cox4dbd5a02008-07-22 11:09:57 +0100150 /* only call the device specific open if this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 * is the first time the port is opened */
152 if (serial->type->open)
Alan Cox95da3102008-07-22 11:09:07 +0100153 retval = serial->type->open(NULL, port, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 else
Alan Cox95da3102008-07-22 11:09:07 +0100155 retval = usb_serial_generic_open(NULL, port, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500157 if (retval) {
158 err("could not open USB console port");
159 goto free_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500162 if (serial->type->set_termios) {
163 termios->c_cflag = cflag;
Alan Coxc17ee882008-07-22 11:10:08 +0100164 tty_termios_encode_baud_rate(termios, baud, baud);
Jason Wessel06dd8812008-09-08 14:53:37 +0100165 serial->type->set_termios(tty, port, &dummy);
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500166
Alan Cox4a90f092008-10-13 10:39:46 +0100167 tty_port_tty_set(&port->port, NULL);
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500168 kfree(termios);
169 kfree(tty);
170 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 }
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500172
Aristeu Rozanski9a6b1ef2007-11-12 15:15:02 -0500173 port->console = 1;
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500174 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500176out:
177 return retval;
178free_termios:
179 kfree(termios);
Alan Cox4a90f092008-10-13 10:39:46 +0100180 tty_port_tty_set(&port->port, NULL);
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500181free_tty:
182 kfree(tty);
183reset_open_count:
Alan Cox95da3102008-07-22 11:09:07 +0100184 port->port.count = 0;
Aristeu Rozanskic87d6a42007-11-13 17:22:07 -0500185goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186}
187
Alan Cox4dbd5a02008-07-22 11:09:57 +0100188static void usb_console_write(struct console *co,
189 const char *buf, unsigned count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
191 static struct usbcons_info *info = &usbcons_info;
192 struct usb_serial_port *port = info->port;
193 struct usb_serial *serial;
194 int retval = -ENODEV;
195
Guennadi Liakhovetski73e487f2006-04-25 07:46:17 +0200196 if (!port || port->serial->dev->state == USB_STATE_NOTATTACHED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 return;
198 serial = port->serial;
199
200 if (count == 0)
201 return;
202
Harvey Harrison441b62c2008-03-03 16:08:34 -0800203 dbg("%s - port %d, %d byte(s)", __func__, port->number, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Alan Cox95da3102008-07-22 11:09:07 +0100205 if (!port->port.count) {
Alan Cox4dbd5a02008-07-22 11:09:57 +0100206 dbg("%s - port not opened", __func__);
Paul Fulghumc10746d2006-04-13 22:26:35 +0200207 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 }
209
Paul Fulghumc10746d2006-04-13 22:26:35 +0200210 while (count) {
211 unsigned int i;
212 unsigned int lf;
213 /* search for LF so we can insert CR if necessary */
Alan Cox4dbd5a02008-07-22 11:09:57 +0100214 for (i = 0, lf = 0 ; i < count ; i++) {
Paul Fulghumc10746d2006-04-13 22:26:35 +0200215 if (*(buf + i) == 10) {
216 lf = 1;
217 i++;
218 break;
219 }
220 }
Alan Cox4dbd5a02008-07-22 11:09:57 +0100221 /* pass on to the driver specific version of this function if
222 it is available */
Paul Fulghumc10746d2006-04-13 22:26:35 +0200223 if (serial->type->write)
Alan Cox95da3102008-07-22 11:09:07 +0100224 retval = serial->type->write(NULL, port, buf, i);
Paul Fulghumc10746d2006-04-13 22:26:35 +0200225 else
Alan Cox95da3102008-07-22 11:09:07 +0100226 retval = usb_serial_generic_write(NULL, port, buf, i);
Harvey Harrison441b62c2008-03-03 16:08:34 -0800227 dbg("%s - return value : %d", __func__, retval);
Paul Fulghumc10746d2006-04-13 22:26:35 +0200228 if (lf) {
229 /* append CR after LF */
230 unsigned char cr = 13;
231 if (serial->type->write)
Alan Cox4dbd5a02008-07-22 11:09:57 +0100232 retval = serial->type->write(NULL,
233 port, &cr, 1);
Paul Fulghumc10746d2006-04-13 22:26:35 +0200234 else
Alan Cox4dbd5a02008-07-22 11:09:57 +0100235 retval = usb_serial_generic_write(NULL,
236 port, &cr, 1);
Harvey Harrison441b62c2008-03-03 16:08:34 -0800237 dbg("%s - return value : %d", __func__, retval);
Paul Fulghumc10746d2006-04-13 22:26:35 +0200238 }
239 buf += i;
240 count -= i;
241 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242}
243
Kevin Hao39efd192009-01-02 13:44:34 +0000244static struct tty_driver *usb_console_device(struct console *co, int *index)
245{
246 struct tty_driver **p = (struct tty_driver **)co->data;
247
248 if (!*p)
249 return NULL;
250
251 *index = co->index;
252 return *p;
253}
254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255static struct console usbcons = {
256 .name = "ttyUSB",
257 .write = usb_console_write,
Kevin Hao39efd192009-01-02 13:44:34 +0000258 .device = usb_console_device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 .setup = usb_console_setup,
260 .flags = CON_PRINTBUFFER,
261 .index = -1,
Kevin Hao39efd192009-01-02 13:44:34 +0000262 .data = &usb_serial_tty_driver,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263};
264
Guennadi Liakhovetski73e487f2006-04-25 07:46:17 +0200265void usb_serial_console_disconnect(struct usb_serial *serial)
266{
Alan Cox4dbd5a02008-07-22 11:09:57 +0100267 if (serial && serial->port && serial->port[0]
268 && serial->port[0] == usbcons_info.port) {
Guennadi Liakhovetski73e487f2006-04-25 07:46:17 +0200269 usb_serial_console_exit();
270 usb_serial_put(serial);
271 }
272}
273
Alan Cox4dbd5a02008-07-22 11:09:57 +0100274void usb_serial_console_init(int serial_debug, int minor)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275{
276 debug = serial_debug;
277
278 if (minor == 0) {
Alan Cox4dbd5a02008-07-22 11:09:57 +0100279 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 * Call register_console() if this is the first device plugged
281 * in. If we call it earlier, then the callback to
282 * console_setup() will fail, as there is not a device seen by
283 * the USB subsystem yet.
284 */
285 /*
286 * Register console.
287 * NOTES:
Alan Cox4dbd5a02008-07-22 11:09:57 +0100288 * console_setup() is called (back) immediately (from
289 * register_console). console_write() is called immediately
290 * from register_console iff CON_PRINTBUFFER is set in flags.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 */
Alan Cox4dbd5a02008-07-22 11:09:57 +0100292 dbg("registering the USB serial console.");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 register_console(&usbcons);
294 }
295}
296
Alan Cox4dbd5a02008-07-22 11:09:57 +0100297void usb_serial_console_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298{
Guennadi Liakhovetski73e487f2006-04-25 07:46:17 +0200299 if (usbcons_info.port) {
300 unregister_console(&usbcons);
Alan Cox95da3102008-07-22 11:09:07 +0100301 if (usbcons_info.port->port.count)
302 usbcons_info.port->port.count--;
Guennadi Liakhovetski73e487f2006-04-25 07:46:17 +0200303 usbcons_info.port = NULL;
304 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305}
306