Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
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. | |
4dbd5a09 | 9 | * |
1da177e4 LT |
10 | * Thanks to Randy Dunlap for the original version of this code. |
11 | * | |
12 | */ | |
13 | ||
1da177e4 LT |
14 | #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> | |
a969888c | 20 | #include <linux/usb/serial.h> |
1da177e4 LT |
21 | |
22 | static int debug; | |
23 | ||
1da177e4 LT |
24 | struct usbcons_info { |
25 | int magic; | |
26 | int break_flag; | |
27 | struct usb_serial_port *port; | |
28 | }; | |
29 | ||
30 | static struct usbcons_info usbcons_info; | |
31 | static 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 | */ | |
69a4bf7c | 55 | static int usb_console_setup(struct console *co, char *options) |
1da177e4 LT |
56 | { |
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; | |
c87d6a4f AR |
67 | struct tty_struct *tty = NULL; |
68 | struct ktermios *termios = NULL, dummy; | |
1da177e4 | 69 | |
4dbd5a09 | 70 | dbg("%s", __func__); |
1da177e4 LT |
71 | |
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 | } | |
c17ee886 AC |
84 | |
85 | /* Sane default */ | |
86 | if (baud == 0) | |
87 | baud = 9600; | |
1da177e4 | 88 | |
1da177e4 | 89 | switch (bits) { |
4dbd5a09 AC |
90 | case 7: |
91 | cflag |= CS7; | |
92 | break; | |
93 | default: | |
94 | case 8: | |
95 | cflag |= CS8; | |
96 | break; | |
1da177e4 LT |
97 | } |
98 | switch (parity) { | |
4dbd5a09 AC |
99 | case 'o': case 'O': |
100 | cflag |= PARODD; | |
101 | break; | |
102 | case 'e': case 'E': | |
103 | cflag |= PARENB; | |
104 | break; | |
1da177e4 LT |
105 | } |
106 | co->cflag = cflag; | |
107 | ||
27680d23 AR |
108 | /* |
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); | |
1da177e4 LT |
113 | if (serial == NULL) { |
114 | /* no device is connected yet, sorry :( */ | |
4dbd5a09 | 115 | err("No USB device connected to ttyUSB%i", co->index); |
1da177e4 LT |
116 | return -ENODEV; |
117 | } | |
118 | ||
119 | port = serial->port[0]; | |
4a90f09b | 120 | tty_port_tty_set(&port->port, NULL); |
1da177e4 LT |
121 | |
122 | info->port = port; | |
4dbd5a09 | 123 | |
95da310e AC |
124 | ++port->port.count; |
125 | if (port->port.count == 1) { | |
c87d6a4f AR |
126 | 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 | } | |
e5404586 | 138 | kref_init(&tty->kref); |
c87d6a4f AR |
139 | 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; | |
4a90f09b | 147 | tty_port_tty_set(&port->port, tty); |
c87d6a4f AR |
148 | } |
149 | ||
4dbd5a09 | 150 | /* only call the device specific open if this |
1da177e4 LT |
151 | * is the first time the port is opened */ |
152 | if (serial->type->open) | |
95da310e | 153 | retval = serial->type->open(NULL, port, NULL); |
1da177e4 | 154 | else |
95da310e | 155 | retval = usb_serial_generic_open(NULL, port, NULL); |
1da177e4 | 156 | |
c87d6a4f AR |
157 | if (retval) { |
158 | err("could not open USB console port"); | |
159 | goto free_termios; | |
1da177e4 | 160 | } |
c87d6a4f AR |
161 | |
162 | if (serial->type->set_termios) { | |
163 | termios->c_cflag = cflag; | |
c17ee886 | 164 | tty_termios_encode_baud_rate(termios, baud, baud); |
06dd881f | 165 | serial->type->set_termios(tty, port, &dummy); |
c87d6a4f | 166 | |
4a90f09b | 167 | tty_port_tty_set(&port->port, NULL); |
c87d6a4f AR |
168 | kfree(termios); |
169 | kfree(tty); | |
1da177e4 | 170 | } |
1da177e4 | 171 | } |
335f8514 AC |
172 | /* So we know not to kill the hardware on a hangup on this |
173 | port. We have also bumped the use count by one so it won't go | |
174 | idle */ | |
9a6b1efa | 175 | port->console = 1; |
c87d6a4f | 176 | retval = 0; |
1da177e4 | 177 | |
c87d6a4f AR |
178 | out: |
179 | return retval; | |
180 | free_termios: | |
181 | kfree(termios); | |
4a90f09b | 182 | tty_port_tty_set(&port->port, NULL); |
c87d6a4f AR |
183 | free_tty: |
184 | kfree(tty); | |
185 | reset_open_count: | |
95da310e | 186 | port->port.count = 0; |
335f8514 | 187 | goto out; |
1da177e4 LT |
188 | } |
189 | ||
4dbd5a09 AC |
190 | static void usb_console_write(struct console *co, |
191 | const char *buf, unsigned count) | |
1da177e4 LT |
192 | { |
193 | static struct usbcons_info *info = &usbcons_info; | |
194 | struct usb_serial_port *port = info->port; | |
195 | struct usb_serial *serial; | |
196 | int retval = -ENODEV; | |
197 | ||
73e487fd | 198 | if (!port || port->serial->dev->state == USB_STATE_NOTATTACHED) |
1da177e4 LT |
199 | return; |
200 | serial = port->serial; | |
201 | ||
202 | if (count == 0) | |
203 | return; | |
204 | ||
441b62c1 | 205 | dbg("%s - port %d, %d byte(s)", __func__, port->number, count); |
1da177e4 | 206 | |
95da310e | 207 | if (!port->port.count) { |
4dbd5a09 | 208 | dbg("%s - port not opened", __func__); |
c10746db | 209 | return; |
1da177e4 LT |
210 | } |
211 | ||
c10746db PF |
212 | while (count) { |
213 | unsigned int i; | |
214 | unsigned int lf; | |
215 | /* search for LF so we can insert CR if necessary */ | |
4dbd5a09 | 216 | for (i = 0, lf = 0 ; i < count ; i++) { |
c10746db PF |
217 | if (*(buf + i) == 10) { |
218 | lf = 1; | |
219 | i++; | |
220 | break; | |
221 | } | |
222 | } | |
4dbd5a09 AC |
223 | /* pass on to the driver specific version of this function if |
224 | it is available */ | |
c10746db | 225 | if (serial->type->write) |
95da310e | 226 | retval = serial->type->write(NULL, port, buf, i); |
c10746db | 227 | else |
95da310e | 228 | retval = usb_serial_generic_write(NULL, port, buf, i); |
441b62c1 | 229 | dbg("%s - return value : %d", __func__, retval); |
c10746db PF |
230 | if (lf) { |
231 | /* append CR after LF */ | |
232 | unsigned char cr = 13; | |
233 | if (serial->type->write) | |
4dbd5a09 AC |
234 | retval = serial->type->write(NULL, |
235 | port, &cr, 1); | |
c10746db | 236 | else |
4dbd5a09 AC |
237 | retval = usb_serial_generic_write(NULL, |
238 | port, &cr, 1); | |
441b62c1 | 239 | dbg("%s - return value : %d", __func__, retval); |
c10746db PF |
240 | } |
241 | buf += i; | |
242 | count -= i; | |
243 | } | |
1da177e4 LT |
244 | } |
245 | ||
39efd191 KH |
246 | static struct tty_driver *usb_console_device(struct console *co, int *index) |
247 | { | |
248 | struct tty_driver **p = (struct tty_driver **)co->data; | |
249 | ||
250 | if (!*p) | |
251 | return NULL; | |
252 | ||
253 | *index = co->index; | |
254 | return *p; | |
255 | } | |
256 | ||
1da177e4 LT |
257 | static struct console usbcons = { |
258 | .name = "ttyUSB", | |
259 | .write = usb_console_write, | |
39efd191 | 260 | .device = usb_console_device, |
1da177e4 LT |
261 | .setup = usb_console_setup, |
262 | .flags = CON_PRINTBUFFER, | |
263 | .index = -1, | |
39efd191 | 264 | .data = &usb_serial_tty_driver, |
1da177e4 LT |
265 | }; |
266 | ||
73e487fd GL |
267 | void usb_serial_console_disconnect(struct usb_serial *serial) |
268 | { | |
4dbd5a09 AC |
269 | if (serial && serial->port && serial->port[0] |
270 | && serial->port[0] == usbcons_info.port) { | |
73e487fd GL |
271 | usb_serial_console_exit(); |
272 | usb_serial_put(serial); | |
273 | } | |
274 | } | |
275 | ||
4dbd5a09 | 276 | void usb_serial_console_init(int serial_debug, int minor) |
1da177e4 LT |
277 | { |
278 | debug = serial_debug; | |
279 | ||
280 | if (minor == 0) { | |
4dbd5a09 | 281 | /* |
1da177e4 LT |
282 | * Call register_console() if this is the first device plugged |
283 | * in. If we call it earlier, then the callback to | |
284 | * console_setup() will fail, as there is not a device seen by | |
285 | * the USB subsystem yet. | |
286 | */ | |
287 | /* | |
288 | * Register console. | |
289 | * NOTES: | |
4dbd5a09 AC |
290 | * console_setup() is called (back) immediately (from |
291 | * register_console). console_write() is called immediately | |
292 | * from register_console iff CON_PRINTBUFFER is set in flags. | |
1da177e4 | 293 | */ |
4dbd5a09 | 294 | dbg("registering the USB serial console."); |
1da177e4 LT |
295 | register_console(&usbcons); |
296 | } | |
297 | } | |
298 | ||
4dbd5a09 | 299 | void usb_serial_console_exit(void) |
1da177e4 | 300 | { |
73e487fd GL |
301 | if (usbcons_info.port) { |
302 | unregister_console(&usbcons); | |
95da310e AC |
303 | if (usbcons_info.port->port.count) |
304 | usbcons_info.port->port.count--; | |
73e487fd GL |
305 | usbcons_info.port = NULL; |
306 | } | |
1da177e4 LT |
307 | } |
308 |