Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Copyright (C) 2001 Anton Blanchard <anton@au.ibm.com>, IBM | |
3 | * Copyright (C) 2001 Paul Mackerras <paulus@au.ibm.com>, IBM | |
4 | * Copyright (C) 2004 Benjamin Herrenschmidt <benh@kernel.crashing.org>, IBM Corp. | |
5 | * Copyright (C) 2004 IBM Corporation | |
6 | * | |
7 | * Additional Author(s): | |
8 | * Ryan S. Arnold <rsa@us.ibm.com> | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or modify | |
11 | * it under the terms of the GNU General Public License as published by | |
12 | * the Free Software Foundation; either version 2 of the License, or | |
13 | * (at your option) any later version. | |
14 | * | |
15 | * This program is distributed in the hope that it will be useful, | |
16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | * GNU General Public License for more details. | |
19 | * | |
20 | * You should have received a copy of the GNU General Public License | |
21 | * along with this program; if not, write to the Free Software | |
22 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
23 | */ | |
24 | ||
25 | #include <linux/console.h> | |
26 | #include <linux/cpumask.h> | |
27 | #include <linux/init.h> | |
28 | #include <linux/kbd_kern.h> | |
29 | #include <linux/kernel.h> | |
1da177e4 LT |
30 | #include <linux/kthread.h> |
31 | #include <linux/list.h> | |
32 | #include <linux/module.h> | |
33 | #include <linux/major.h> | |
34 | #include <linux/sysrq.h> | |
35 | #include <linux/tty.h> | |
36 | #include <linux/tty_flip.h> | |
37 | #include <linux/sched.h> | |
38 | #include <linux/spinlock.h> | |
39 | #include <linux/delay.h> | |
7dfb7103 | 40 | #include <linux/freezer.h> |
45d607ed | 41 | |
1da177e4 | 42 | #include <asm/uaccess.h> |
45d607ed RA |
43 | |
44 | #include "hvc_console.h" | |
1da177e4 LT |
45 | |
46 | #define HVC_MAJOR 229 | |
47 | #define HVC_MINOR 0 | |
48 | ||
1da177e4 LT |
49 | /* |
50 | * Wait this long per iteration while trying to push buffered data to the | |
51 | * hypervisor before allowing the tty to complete a close operation. | |
52 | */ | |
53 | #define HVC_CLOSE_WAIT (HZ/100) /* 1/10 of a second */ | |
54 | ||
55 | /* | |
45d607ed RA |
56 | * These sizes are most efficient for vio, because they are the |
57 | * native transfer size. We could make them selectable in the | |
58 | * future to better deal with backends that want other buffer sizes. | |
1da177e4 | 59 | */ |
1da177e4 LT |
60 | #define N_OUTBUF 16 |
61 | #define N_INBUF 16 | |
62 | ||
45d607ed | 63 | #define __ALIGNED__ __attribute__((__aligned__(sizeof(long)))) |
1da177e4 | 64 | |
837dcfaf MM |
65 | static struct tty_driver *hvc_driver; |
66 | static struct task_struct *hvc_task; | |
67 | ||
68 | /* Picks up late kicks after list walk but before schedule() */ | |
69 | static int hvc_kicked; | |
70 | ||
3e6c6f63 RR |
71 | static int hvc_init(void); |
72 | ||
837dcfaf MM |
73 | #ifdef CONFIG_MAGIC_SYSRQ |
74 | static int sysrq_pressed; | |
75 | #endif | |
76 | ||
1da177e4 | 77 | /* dynamic list of hvc_struct instances */ |
bed9759b | 78 | static LIST_HEAD(hvc_structs); |
1da177e4 LT |
79 | |
80 | /* | |
81 | * Protect the list of hvc_struct instances from inserts and removals during | |
82 | * list traversal. | |
83 | */ | |
84 | static DEFINE_SPINLOCK(hvc_structs_lock); | |
85 | ||
837dcfaf | 86 | /* |
6f24808e MM |
87 | * This value is used to assign a tty->index value to a hvc_struct based |
88 | * upon order of exposure via hvc_probe(), when we can not match it to | |
c3ea6921 | 89 | * a console candidate registered with hvc_instantiate(). |
837dcfaf | 90 | */ |
6f24808e | 91 | static int last_hvc = -1; |
837dcfaf MM |
92 | |
93 | /* | |
c3ea6921 | 94 | * Do not call this function with either the hvc_structs_lock or the hvc_struct |
12b20ded | 95 | * lock held. If successful, this function increments the kref reference |
837dcfaf MM |
96 | * count against the target hvc_struct so it should be released when finished. |
97 | */ | |
4fa156ea | 98 | static struct hvc_struct *hvc_get_by_index(int index) |
837dcfaf MM |
99 | { |
100 | struct hvc_struct *hp; | |
101 | unsigned long flags; | |
102 | ||
103 | spin_lock(&hvc_structs_lock); | |
104 | ||
105 | list_for_each_entry(hp, &hvc_structs, next) { | |
106 | spin_lock_irqsave(&hp->lock, flags); | |
107 | if (hp->index == index) { | |
12b20ded | 108 | kref_get(&hp->kref); |
837dcfaf MM |
109 | spin_unlock_irqrestore(&hp->lock, flags); |
110 | spin_unlock(&hvc_structs_lock); | |
111 | return hp; | |
112 | } | |
113 | spin_unlock_irqrestore(&hp->lock, flags); | |
114 | } | |
115 | hp = NULL; | |
116 | ||
117 | spin_unlock(&hvc_structs_lock); | |
118 | return hp; | |
119 | } | |
120 | ||
121 | ||
1da177e4 LT |
122 | /* |
123 | * Initial console vtermnos for console API usage prior to full console | |
124 | * initialization. Any vty adapter outside this range will not have usable | |
125 | * console interfaces but can still be used as a tty device. This has to be | |
126 | * static because kmalloc will not work during early console init. | |
127 | */ | |
030ffad2 | 128 | static struct hv_ops *cons_ops[MAX_NR_HVC_CONSOLES]; |
64e4da57 MM |
129 | static uint32_t vtermnos[MAX_NR_HVC_CONSOLES] = |
130 | {[0 ... MAX_NR_HVC_CONSOLES - 1] = -1}; | |
1da177e4 | 131 | |
837dcfaf MM |
132 | /* |
133 | * Console APIs, NOT TTY. These APIs are available immediately when | |
134 | * hvc_console_setup() finds adapters. | |
135 | */ | |
136 | ||
4fa156ea AB |
137 | static void hvc_console_print(struct console *co, const char *b, |
138 | unsigned count) | |
837dcfaf | 139 | { |
45d607ed | 140 | char c[N_OUTBUF] __ALIGNED__; |
837dcfaf | 141 | unsigned i = 0, n = 0; |
030ffad2 | 142 | int r, donecr = 0, index = co->index; |
837dcfaf MM |
143 | |
144 | /* Console access attempt outside of acceptable console range. */ | |
030ffad2 | 145 | if (index >= MAX_NR_HVC_CONSOLES) |
837dcfaf MM |
146 | return; |
147 | ||
c3ea6921 | 148 | /* This console adapter was removed so it is not usable. */ |
030ffad2 | 149 | if (vtermnos[index] < 0) |
837dcfaf MM |
150 | return; |
151 | ||
152 | while (count > 0 || i > 0) { | |
153 | if (count > 0 && i < sizeof(c)) { | |
154 | if (b[n] == '\n' && !donecr) { | |
155 | c[i++] = '\r'; | |
156 | donecr = 1; | |
157 | } else { | |
158 | c[i++] = b[n++]; | |
159 | donecr = 0; | |
160 | --count; | |
161 | } | |
162 | } else { | |
030ffad2 | 163 | r = cons_ops[index]->put_chars(vtermnos[index], c, i); |
3feebbb5 | 164 | if (r <= 0) { |
837dcfaf MM |
165 | /* throw away chars on error */ |
166 | i = 0; | |
167 | } else if (r > 0) { | |
168 | i -= r; | |
169 | if (i > 0) | |
170 | memmove(c, c+r, i); | |
171 | } | |
172 | } | |
173 | } | |
174 | } | |
175 | ||
176 | static struct tty_driver *hvc_console_device(struct console *c, int *index) | |
177 | { | |
7805b1b2 MM |
178 | if (vtermnos[c->index] == -1) |
179 | return NULL; | |
180 | ||
837dcfaf MM |
181 | *index = c->index; |
182 | return hvc_driver; | |
183 | } | |
184 | ||
185 | static int __init hvc_console_setup(struct console *co, char *options) | |
186 | { | |
7805b1b2 MM |
187 | if (co->index < 0 || co->index >= MAX_NR_HVC_CONSOLES) |
188 | return -ENODEV; | |
189 | ||
190 | if (vtermnos[co->index] == -1) | |
191 | return -ENODEV; | |
192 | ||
837dcfaf MM |
193 | return 0; |
194 | } | |
195 | ||
4fa156ea | 196 | static struct console hvc_con_driver = { |
837dcfaf MM |
197 | .name = "hvc", |
198 | .write = hvc_console_print, | |
199 | .device = hvc_console_device, | |
200 | .setup = hvc_console_setup, | |
201 | .flags = CON_PRINTBUFFER, | |
202 | .index = -1, | |
203 | }; | |
204 | ||
d5ee257c | 205 | /* |
c3ea6921 | 206 | * Early console initialization. Precedes driver initialization. |
d5ee257c MM |
207 | * |
208 | * (1) we are first, and the user specified another driver | |
209 | * -- index will remain -1 | |
210 | * (2) we are first and the user specified no driver | |
211 | * -- index will be set to 0, then we will fail setup. | |
212 | * (3) we are first and the user specified our driver | |
213 | * -- index will be set to user specified driver, and we will fail | |
214 | * (4) we are after driver, and this initcall will register us | |
215 | * -- if the user didn't specify a driver then the console will match | |
216 | * | |
217 | * Note that for cases 2 and 3, we will match later when the io driver | |
218 | * calls hvc_instantiate() and call register again. | |
219 | */ | |
837dcfaf MM |
220 | static int __init hvc_console_init(void) |
221 | { | |
837dcfaf MM |
222 | register_console(&hvc_con_driver); |
223 | return 0; | |
224 | } | |
225 | console_initcall(hvc_console_init); | |
1da177e4 | 226 | |
12b20ded GKH |
227 | /* callback when the kboject ref count reaches zero. */ |
228 | static void destroy_hvc_struct(struct kref *kref) | |
229 | { | |
230 | struct hvc_struct *hp = container_of(kref, struct hvc_struct, kref); | |
231 | unsigned long flags; | |
232 | ||
233 | spin_lock(&hvc_structs_lock); | |
234 | ||
235 | spin_lock_irqsave(&hp->lock, flags); | |
236 | list_del(&(hp->next)); | |
237 | spin_unlock_irqrestore(&hp->lock, flags); | |
238 | ||
239 | spin_unlock(&hvc_structs_lock); | |
240 | ||
241 | kfree(hp); | |
242 | } | |
243 | ||
1da177e4 | 244 | /* |
6f24808e MM |
245 | * hvc_instantiate() is an early console discovery method which locates |
246 | * consoles * prior to the vio subsystem discovering them. Hotplugged | |
247 | * vty adapters do NOT get an hvc_instantiate() callback since they | |
248 | * appear after early console init. | |
1da177e4 | 249 | */ |
030ffad2 | 250 | int hvc_instantiate(uint32_t vtermno, int index, struct hv_ops *ops) |
837dcfaf | 251 | { |
7805b1b2 MM |
252 | struct hvc_struct *hp; |
253 | ||
837dcfaf MM |
254 | if (index < 0 || index >= MAX_NR_HVC_CONSOLES) |
255 | return -1; | |
1da177e4 | 256 | |
837dcfaf MM |
257 | if (vtermnos[index] != -1) |
258 | return -1; | |
259 | ||
c3ea6921 | 260 | /* make sure no no tty has been registered in this index */ |
7805b1b2 MM |
261 | hp = hvc_get_by_index(index); |
262 | if (hp) { | |
12b20ded | 263 | kref_put(&hp->kref, destroy_hvc_struct); |
7805b1b2 MM |
264 | return -1; |
265 | } | |
266 | ||
837dcfaf | 267 | vtermnos[index] = vtermno; |
030ffad2 | 268 | cons_ops[index] = ops; |
6f24808e | 269 | |
c3ea6921 | 270 | /* reserve all indices up to and including this index */ |
6f24808e MM |
271 | if (last_hvc < index) |
272 | last_hvc = index; | |
273 | ||
d5ee257c MM |
274 | /* if this index is what the user requested, then register |
275 | * now (setup won't fail at this point). It's ok to just | |
276 | * call register again if previously .setup failed. | |
277 | */ | |
278 | if (index == hvc_con_driver.index) | |
279 | register_console(&hvc_con_driver); | |
280 | ||
837dcfaf MM |
281 | return 0; |
282 | } | |
7721c494 | 283 | EXPORT_SYMBOL_GPL(hvc_instantiate); |
1da177e4 LT |
284 | |
285 | /* Wake the sleeping khvcd */ | |
611e097d | 286 | void hvc_kick(void) |
1da177e4 LT |
287 | { |
288 | hvc_kicked = 1; | |
289 | wake_up_process(hvc_task); | |
290 | } | |
7721c494 | 291 | EXPORT_SYMBOL_GPL(hvc_kick); |
1da177e4 | 292 | |
1da177e4 LT |
293 | static void hvc_unthrottle(struct tty_struct *tty) |
294 | { | |
295 | hvc_kick(); | |
296 | } | |
297 | ||
1da177e4 LT |
298 | /* |
299 | * The TTY interface won't be used until after the vio layer has exposed the vty | |
300 | * adapter to the kernel. | |
301 | */ | |
302 | static int hvc_open(struct tty_struct *tty, struct file * filp) | |
303 | { | |
304 | struct hvc_struct *hp; | |
305 | unsigned long flags; | |
1da177e4 | 306 | int rc = 0; |
1da177e4 | 307 | |
12b20ded | 308 | /* Auto increments kref reference if found. */ |
87fd7724 | 309 | if (!(hp = hvc_get_by_index(tty->index))) |
1da177e4 | 310 | return -ENODEV; |
1da177e4 LT |
311 | |
312 | spin_lock_irqsave(&hp->lock, flags); | |
313 | /* Check and then increment for fast path open. */ | |
314 | if (hp->count++ > 0) { | |
315 | spin_unlock_irqrestore(&hp->lock, flags); | |
316 | hvc_kick(); | |
317 | return 0; | |
318 | } /* else count == 0 */ | |
319 | ||
320 | tty->driver_data = hp; | |
fb5c594c | 321 | |
1da177e4 | 322 | hp->tty = tty; |
611e097d | 323 | |
1da177e4 | 324 | spin_unlock_irqrestore(&hp->lock, flags); |
611e097d | 325 | |
b1b135c8 CB |
326 | if (hp->ops->notifier_add) |
327 | rc = hp->ops->notifier_add(hp, hp->data); | |
1da177e4 LT |
328 | |
329 | /* | |
611e097d | 330 | * If the notifier fails we return an error. The tty layer |
1da177e4 LT |
331 | * will call hvc_close() after a failed open but we don't want to clean |
332 | * up there so we'll clean up here and clear out the previously set | |
12b20ded | 333 | * tty fields and return the kref reference. |
1da177e4 LT |
334 | */ |
335 | if (rc) { | |
336 | spin_lock_irqsave(&hp->lock, flags); | |
337 | hp->tty = NULL; | |
1da177e4 LT |
338 | spin_unlock_irqrestore(&hp->lock, flags); |
339 | tty->driver_data = NULL; | |
12b20ded | 340 | kref_put(&hp->kref, destroy_hvc_struct); |
1da177e4 LT |
341 | printk(KERN_ERR "hvc_open: request_irq failed with rc %d.\n", rc); |
342 | } | |
343 | /* Force wakeup of the polling thread */ | |
344 | hvc_kick(); | |
345 | ||
346 | return rc; | |
347 | } | |
348 | ||
349 | static void hvc_close(struct tty_struct *tty, struct file * filp) | |
350 | { | |
351 | struct hvc_struct *hp; | |
1da177e4 LT |
352 | unsigned long flags; |
353 | ||
354 | if (tty_hung_up_p(filp)) | |
355 | return; | |
356 | ||
357 | /* | |
358 | * No driver_data means that this close was issued after a failed | |
359 | * hvc_open by the tty layer's release_dev() function and we can just | |
12b20ded | 360 | * exit cleanly because the kref reference wasn't made. |
1da177e4 LT |
361 | */ |
362 | if (!tty->driver_data) | |
363 | return; | |
364 | ||
365 | hp = tty->driver_data; | |
366 | spin_lock_irqsave(&hp->lock, flags); | |
367 | ||
1da177e4 | 368 | if (--hp->count == 0) { |
1da177e4 LT |
369 | /* We are done with the tty pointer now. */ |
370 | hp->tty = NULL; | |
371 | spin_unlock_irqrestore(&hp->lock, flags); | |
372 | ||
eef2622a CB |
373 | if (hp->ops->notifier_del) |
374 | hp->ops->notifier_del(hp, hp->data); | |
375 | ||
febde371 HB |
376 | /* cancel pending tty resize work */ |
377 | cancel_work_sync(&hp->tty_resize); | |
378 | ||
1da177e4 LT |
379 | /* |
380 | * Chain calls chars_in_buffer() and returns immediately if | |
381 | * there is no buffered data otherwise sleeps on a wait queue | |
382 | * waking periodically to check chars_in_buffer(). | |
383 | */ | |
384 | tty_wait_until_sent(tty, HVC_CLOSE_WAIT); | |
1da177e4 LT |
385 | } else { |
386 | if (hp->count < 0) | |
387 | printk(KERN_ERR "hvc_close %X: oops, count is %d\n", | |
388 | hp->vtermno, hp->count); | |
389 | spin_unlock_irqrestore(&hp->lock, flags); | |
390 | } | |
391 | ||
12b20ded | 392 | kref_put(&hp->kref, destroy_hvc_struct); |
1da177e4 LT |
393 | } |
394 | ||
395 | static void hvc_hangup(struct tty_struct *tty) | |
396 | { | |
397 | struct hvc_struct *hp = tty->driver_data; | |
398 | unsigned long flags; | |
1da177e4 | 399 | int temp_open_count; |
1da177e4 LT |
400 | |
401 | if (!hp) | |
402 | return; | |
403 | ||
febde371 HB |
404 | /* cancel pending tty resize work */ |
405 | cancel_work_sync(&hp->tty_resize); | |
406 | ||
1da177e4 LT |
407 | spin_lock_irqsave(&hp->lock, flags); |
408 | ||
409 | /* | |
410 | * The N_TTY line discipline has problems such that in a close vs | |
411 | * open->hangup case this can be called after the final close so prevent | |
412 | * that from happening for now. | |
413 | */ | |
414 | if (hp->count <= 0) { | |
415 | spin_unlock_irqrestore(&hp->lock, flags); | |
416 | return; | |
417 | } | |
418 | ||
1da177e4 LT |
419 | temp_open_count = hp->count; |
420 | hp->count = 0; | |
421 | hp->n_outbuf = 0; | |
422 | hp->tty = NULL; | |
611e097d | 423 | |
eef2622a CB |
424 | spin_unlock_irqrestore(&hp->lock, flags); |
425 | ||
fc362e2e HB |
426 | if (hp->ops->notifier_hangup) |
427 | hp->ops->notifier_hangup(hp, hp->data); | |
611e097d | 428 | |
1da177e4 LT |
429 | while(temp_open_count) { |
430 | --temp_open_count; | |
12b20ded | 431 | kref_put(&hp->kref, destroy_hvc_struct); |
1da177e4 LT |
432 | } |
433 | } | |
434 | ||
435 | /* | |
436 | * Push buffered characters whether they were just recently buffered or waiting | |
437 | * on a blocked hypervisor. Call this function with hp->lock held. | |
438 | */ | |
3feebbb5 | 439 | static int hvc_push(struct hvc_struct *hp) |
1da177e4 LT |
440 | { |
441 | int n; | |
442 | ||
030ffad2 | 443 | n = hp->ops->put_chars(hp->vtermno, hp->outbuf, hp->n_outbuf); |
1da177e4 | 444 | if (n <= 0) { |
45d607ed RA |
445 | if (n == 0) { |
446 | hp->do_wakeup = 1; | |
3feebbb5 | 447 | return 0; |
45d607ed | 448 | } |
1da177e4 LT |
449 | /* throw away output on error; this happens when |
450 | there is no session connected to the vterm. */ | |
451 | hp->n_outbuf = 0; | |
452 | } else | |
453 | hp->n_outbuf -= n; | |
454 | if (hp->n_outbuf > 0) | |
455 | memmove(hp->outbuf, hp->outbuf + n, hp->n_outbuf); | |
456 | else | |
457 | hp->do_wakeup = 1; | |
3feebbb5 HB |
458 | |
459 | return n; | |
1da177e4 LT |
460 | } |
461 | ||
45d607ed | 462 | static int hvc_write(struct tty_struct *tty, const unsigned char *buf, int count) |
1da177e4 | 463 | { |
45d607ed | 464 | struct hvc_struct *hp = tty->driver_data; |
1da177e4 LT |
465 | unsigned long flags; |
466 | int rsize, written = 0; | |
467 | ||
45d607ed RA |
468 | /* This write was probably executed during a tty close. */ |
469 | if (!hp) | |
470 | return -EPIPE; | |
471 | ||
472 | if (hp->count <= 0) | |
473 | return -EIO; | |
474 | ||
1da177e4 LT |
475 | spin_lock_irqsave(&hp->lock, flags); |
476 | ||
477 | /* Push pending writes */ | |
478 | if (hp->n_outbuf > 0) | |
479 | hvc_push(hp); | |
480 | ||
4e9e95a3 | 481 | while (count > 0 && (rsize = hp->outbuf_size - hp->n_outbuf) > 0) { |
1da177e4 LT |
482 | if (rsize > count) |
483 | rsize = count; | |
484 | memcpy(hp->outbuf + hp->n_outbuf, buf, rsize); | |
485 | count -= rsize; | |
486 | buf += rsize; | |
487 | hp->n_outbuf += rsize; | |
488 | written += rsize; | |
489 | hvc_push(hp); | |
490 | } | |
491 | spin_unlock_irqrestore(&hp->lock, flags); | |
492 | ||
1da177e4 LT |
493 | /* |
494 | * Racy, but harmless, kick thread if there is still pending data. | |
1da177e4 LT |
495 | */ |
496 | if (hp->n_outbuf) | |
497 | hvc_kick(); | |
498 | ||
499 | return written; | |
500 | } | |
501 | ||
febde371 HB |
502 | /** |
503 | * hvc_set_winsz() - Resize the hvc tty terminal window. | |
504 | * @work: work structure. | |
505 | * | |
506 | * The routine shall not be called within an atomic context because it | |
507 | * might sleep. | |
508 | * | |
509 | * Locking: hp->lock | |
510 | */ | |
511 | static void hvc_set_winsz(struct work_struct *work) | |
512 | { | |
513 | struct hvc_struct *hp; | |
514 | unsigned long hvc_flags; | |
515 | struct tty_struct *tty; | |
516 | struct winsize ws; | |
517 | ||
518 | hp = container_of(work, struct hvc_struct, tty_resize); | |
febde371 HB |
519 | |
520 | spin_lock_irqsave(&hp->lock, hvc_flags); | |
521 | if (!hp->tty) { | |
522 | spin_unlock_irqrestore(&hp->lock, hvc_flags); | |
523 | return; | |
524 | } | |
525 | ws = hp->ws; | |
526 | tty = tty_kref_get(hp->tty); | |
527 | spin_unlock_irqrestore(&hp->lock, hvc_flags); | |
528 | ||
fc6f6238 | 529 | tty_do_resize(tty, &ws); |
febde371 HB |
530 | tty_kref_put(tty); |
531 | } | |
532 | ||
1da177e4 LT |
533 | /* |
534 | * This is actually a contract between the driver and the tty layer outlining | |
c3ea6921 | 535 | * how much write room the driver can guarantee will be sent OR BUFFERED. This |
1da177e4 LT |
536 | * driver MUST honor the return value. |
537 | */ | |
538 | static int hvc_write_room(struct tty_struct *tty) | |
539 | { | |
540 | struct hvc_struct *hp = tty->driver_data; | |
541 | ||
542 | if (!hp) | |
543 | return -1; | |
544 | ||
4e9e95a3 | 545 | return hp->outbuf_size - hp->n_outbuf; |
1da177e4 LT |
546 | } |
547 | ||
548 | static int hvc_chars_in_buffer(struct tty_struct *tty) | |
549 | { | |
550 | struct hvc_struct *hp = tty->driver_data; | |
551 | ||
552 | if (!hp) | |
23198fda | 553 | return 0; |
1da177e4 LT |
554 | return hp->n_outbuf; |
555 | } | |
556 | ||
b791072b WS |
557 | /* |
558 | * timeout will vary between the MIN and MAX values defined here. By default | |
559 | * and during console activity we will use a default MIN_TIMEOUT of 10. When | |
560 | * the console is idle, we increase the timeout value on each pass through | |
561 | * msleep until we reach the max. This may be noticeable as a brief (average | |
562 | * one second) delay on the console before the console responds to input when | |
563 | * there has been no input for some time. | |
564 | */ | |
565 | #define MIN_TIMEOUT (10) | |
566 | #define MAX_TIMEOUT (2000) | |
567 | static u32 timeout = MIN_TIMEOUT; | |
568 | ||
1da177e4 LT |
569 | #define HVC_POLL_READ 0x00000001 |
570 | #define HVC_POLL_WRITE 0x00000002 | |
1da177e4 | 571 | |
611e097d | 572 | int hvc_poll(struct hvc_struct *hp) |
1da177e4 LT |
573 | { |
574 | struct tty_struct *tty; | |
575 | int i, n, poll_mask = 0; | |
576 | char buf[N_INBUF] __ALIGNED__; | |
577 | unsigned long flags; | |
578 | int read_total = 0; | |
3feebbb5 | 579 | int written_total = 0; |
1da177e4 LT |
580 | |
581 | spin_lock_irqsave(&hp->lock, flags); | |
582 | ||
583 | /* Push pending writes */ | |
584 | if (hp->n_outbuf > 0) | |
3feebbb5 | 585 | written_total = hvc_push(hp); |
b5374461 | 586 | |
1da177e4 | 587 | /* Reschedule us if still some write pending */ |
3feebbb5 | 588 | if (hp->n_outbuf > 0) { |
1da177e4 | 589 | poll_mask |= HVC_POLL_WRITE; |
3feebbb5 HB |
590 | /* If hvc_push() was not able to write, sleep a few msecs */ |
591 | timeout = (written_total) ? 0 : MIN_TIMEOUT; | |
592 | } | |
1da177e4 LT |
593 | |
594 | /* No tty attached, just skip */ | |
595 | tty = hp->tty; | |
596 | if (tty == NULL) | |
597 | goto bail; | |
598 | ||
599 | /* Now check if we can get data (are we throttled ?) */ | |
600 | if (test_bit(TTY_THROTTLED, &tty->flags)) | |
601 | goto throttled; | |
602 | ||
611e097d | 603 | /* If we aren't notifier driven and aren't throttled, we always |
1da177e4 LT |
604 | * request a reschedule |
605 | */ | |
611e097d | 606 | if (!hp->irq_requested) |
1da177e4 LT |
607 | poll_mask |= HVC_POLL_READ; |
608 | ||
609 | /* Read data if any */ | |
610 | for (;;) { | |
33f0f88f | 611 | int count = tty_buffer_request_room(tty, N_INBUF); |
1da177e4 LT |
612 | |
613 | /* If flip is full, just reschedule a later read */ | |
614 | if (count == 0) { | |
615 | poll_mask |= HVC_POLL_READ; | |
616 | break; | |
617 | } | |
618 | ||
030ffad2 | 619 | n = hp->ops->get_chars(hp->vtermno, buf, count); |
1da177e4 LT |
620 | if (n <= 0) { |
621 | /* Hangup the tty when disconnected from host */ | |
622 | if (n == -EPIPE) { | |
623 | spin_unlock_irqrestore(&hp->lock, flags); | |
624 | tty_hangup(tty); | |
625 | spin_lock_irqsave(&hp->lock, flags); | |
45d607ed RA |
626 | } else if ( n == -EAGAIN ) { |
627 | /* | |
628 | * Some back-ends can only ensure a certain min | |
629 | * num of bytes read, which may be > 'count'. | |
630 | * Let the tty clear the flip buff to make room. | |
631 | */ | |
632 | poll_mask |= HVC_POLL_READ; | |
1da177e4 LT |
633 | } |
634 | break; | |
635 | } | |
636 | for (i = 0; i < n; ++i) { | |
637 | #ifdef CONFIG_MAGIC_SYSRQ | |
2b9e0bac MM |
638 | if (hp->index == hvc_con_driver.index) { |
639 | /* Handle the SysRq Hack */ | |
640 | /* XXX should support a sequence */ | |
641 | if (buf[i] == '\x0f') { /* ^O */ | |
368c1e32 HB |
642 | /* if ^O is pressed again, reset |
643 | * sysrq_pressed and flip ^O char */ | |
644 | sysrq_pressed = !sysrq_pressed; | |
645 | if (sysrq_pressed) | |
646 | continue; | |
2b9e0bac | 647 | } else if (sysrq_pressed) { |
7d12e780 | 648 | handle_sysrq(buf[i], tty); |
2b9e0bac MM |
649 | sysrq_pressed = 0; |
650 | continue; | |
651 | } | |
1da177e4 LT |
652 | } |
653 | #endif /* CONFIG_MAGIC_SYSRQ */ | |
654 | tty_insert_flip_char(tty, buf[i], 0); | |
655 | } | |
656 | ||
1da177e4 | 657 | read_total += n; |
1da177e4 LT |
658 | } |
659 | throttled: | |
660 | /* Wakeup write queue if necessary */ | |
661 | if (hp->do_wakeup) { | |
662 | hp->do_wakeup = 0; | |
663 | tty_wakeup(tty); | |
664 | } | |
665 | bail: | |
666 | spin_unlock_irqrestore(&hp->lock, flags); | |
667 | ||
b791072b WS |
668 | if (read_total) { |
669 | /* Activity is occurring, so reset the polling backoff value to | |
670 | a minimum for performance. */ | |
671 | timeout = MIN_TIMEOUT; | |
672 | ||
fb5c594c | 673 | tty_flip_buffer_push(tty); |
b791072b WS |
674 | } |
675 | ||
1da177e4 LT |
676 | return poll_mask; |
677 | } | |
7721c494 | 678 | EXPORT_SYMBOL_GPL(hvc_poll); |
1da177e4 | 679 | |
febde371 | 680 | /** |
254be490 | 681 | * __hvc_resize() - Update terminal window size information. |
febde371 HB |
682 | * @hp: HVC console pointer |
683 | * @ws: Terminal window size structure | |
684 | * | |
685 | * Stores the specified window size information in the hvc structure of @hp. | |
686 | * The function schedule the tty resize update. | |
687 | * | |
688 | * Locking: Locking free; the function MUST be called holding hp->lock | |
689 | */ | |
254be490 | 690 | void __hvc_resize(struct hvc_struct *hp, struct winsize ws) |
febde371 | 691 | { |
7947cf0d HB |
692 | hp->ws = ws; |
693 | schedule_work(&hp->tty_resize); | |
febde371 | 694 | } |
254be490 | 695 | EXPORT_SYMBOL_GPL(__hvc_resize); |
febde371 | 696 | |
1da177e4 LT |
697 | /* |
698 | * This kthread is either polling or interrupt driven. This is determined by | |
699 | * calling hvc_poll() who determines whether a console adapter support | |
700 | * interrupts. | |
701 | */ | |
5605d4de | 702 | static int khvcd(void *unused) |
1da177e4 LT |
703 | { |
704 | int poll_mask; | |
705 | struct hvc_struct *hp; | |
706 | ||
83144186 | 707 | set_freezable(); |
1da177e4 LT |
708 | __set_current_state(TASK_RUNNING); |
709 | do { | |
710 | poll_mask = 0; | |
711 | hvc_kicked = 0; | |
b64074e4 | 712 | try_to_freeze(); |
1da177e4 | 713 | wmb(); |
1c8950ff | 714 | if (!cpus_are_in_xmon()) { |
1da177e4 LT |
715 | spin_lock(&hvc_structs_lock); |
716 | list_for_each_entry(hp, &hvc_structs, next) { | |
1da177e4 LT |
717 | poll_mask |= hvc_poll(hp); |
718 | } | |
719 | spin_unlock(&hvc_structs_lock); | |
720 | } else | |
721 | poll_mask |= HVC_POLL_READ; | |
722 | if (hvc_kicked) | |
723 | continue; | |
1da177e4 LT |
724 | set_current_state(TASK_INTERRUPTIBLE); |
725 | if (!hvc_kicked) { | |
726 | if (poll_mask == 0) | |
727 | schedule(); | |
b791072b WS |
728 | else { |
729 | if (timeout < MAX_TIMEOUT) | |
730 | timeout += (timeout >> 6) + 1; | |
731 | ||
732 | msleep_interruptible(timeout); | |
733 | } | |
1da177e4 LT |
734 | } |
735 | __set_current_state(TASK_RUNNING); | |
736 | } while (!kthread_should_stop()); | |
737 | ||
738 | return 0; | |
739 | } | |
740 | ||
b68e31d0 | 741 | static const struct tty_operations hvc_ops = { |
1da177e4 LT |
742 | .open = hvc_open, |
743 | .close = hvc_close, | |
744 | .write = hvc_write, | |
745 | .hangup = hvc_hangup, | |
746 | .unthrottle = hvc_unthrottle, | |
747 | .write_room = hvc_write_room, | |
748 | .chars_in_buffer = hvc_chars_in_buffer, | |
749 | }; | |
750 | ||
611e097d | 751 | struct hvc_struct __devinit *hvc_alloc(uint32_t vtermno, int data, |
4e9e95a3 | 752 | struct hv_ops *ops, int outbuf_size) |
1da177e4 LT |
753 | { |
754 | struct hvc_struct *hp; | |
6f24808e | 755 | int i; |
1da177e4 | 756 | |
3e6c6f63 RR |
757 | /* We wait until a driver actually comes along */ |
758 | if (!hvc_driver) { | |
759 | int err = hvc_init(); | |
760 | if (err) | |
761 | return ERR_PTR(err); | |
762 | } | |
763 | ||
2da7582f | 764 | hp = kzalloc(ALIGN(sizeof(*hp), sizeof(long)) + outbuf_size, |
4e9e95a3 | 765 | GFP_KERNEL); |
1da177e4 | 766 | if (!hp) |
acad9559 | 767 | return ERR_PTR(-ENOMEM); |
1da177e4 | 768 | |
acad9559 | 769 | hp->vtermno = vtermno; |
611e097d | 770 | hp->data = data; |
030ffad2 | 771 | hp->ops = ops; |
4e9e95a3 SR |
772 | hp->outbuf_size = outbuf_size; |
773 | hp->outbuf = &((char *)hp)[ALIGN(sizeof(*hp), sizeof(long))]; | |
1da177e4 | 774 | |
12b20ded | 775 | kref_init(&hp->kref); |
1da177e4 | 776 | |
febde371 | 777 | INIT_WORK(&hp->tty_resize, hvc_set_winsz); |
1da177e4 LT |
778 | spin_lock_init(&hp->lock); |
779 | spin_lock(&hvc_structs_lock); | |
6f24808e MM |
780 | |
781 | /* | |
782 | * find index to use: | |
783 | * see if this vterm id matches one registered for console. | |
784 | */ | |
785 | for (i=0; i < MAX_NR_HVC_CONSOLES; i++) | |
45d607ed RA |
786 | if (vtermnos[i] == hp->vtermno && |
787 | cons_ops[i] == hp->ops) | |
6f24808e MM |
788 | break; |
789 | ||
790 | /* no matching slot, just use a counter */ | |
791 | if (i >= MAX_NR_HVC_CONSOLES) | |
792 | i = ++last_hvc; | |
793 | ||
794 | hp->index = i; | |
795 | ||
1da177e4 LT |
796 | list_add_tail(&(hp->next), &hvc_structs); |
797 | spin_unlock(&hvc_structs_lock); | |
798 | ||
acad9559 | 799 | return hp; |
1da177e4 | 800 | } |
7721c494 | 801 | EXPORT_SYMBOL_GPL(hvc_alloc); |
1da177e4 | 802 | |
934752d8 | 803 | int hvc_remove(struct hvc_struct *hp) |
1da177e4 | 804 | { |
1da177e4 | 805 | unsigned long flags; |
1da177e4 LT |
806 | struct tty_struct *tty; |
807 | ||
808 | spin_lock_irqsave(&hp->lock, flags); | |
809 | tty = hp->tty; | |
1da177e4 LT |
810 | |
811 | if (hp->index < MAX_NR_HVC_CONSOLES) | |
812 | vtermnos[hp->index] = -1; | |
813 | ||
814 | /* Don't whack hp->irq because tty_hangup() will need to free the irq. */ | |
815 | ||
816 | spin_unlock_irqrestore(&hp->lock, flags); | |
817 | ||
818 | /* | |
12b20ded GKH |
819 | * We 'put' the instance that was grabbed when the kref instance |
820 | * was initialized using kref_init(). Let the last holder of this | |
821 | * kref cause it to be removed, which will probably be the tty_hangup | |
1da177e4 LT |
822 | * below. |
823 | */ | |
12b20ded | 824 | kref_put(&hp->kref, destroy_hvc_struct); |
1da177e4 LT |
825 | |
826 | /* | |
827 | * This function call will auto chain call hvc_hangup. The tty should | |
828 | * always be valid at this time unless a simultaneous tty close already | |
829 | * cleaned up the hvc_struct. | |
830 | */ | |
831 | if (tty) | |
832 | tty_hangup(tty); | |
833 | return 0; | |
834 | } | |
1da177e4 | 835 | |
3e6c6f63 RR |
836 | /* Driver initialization: called as soon as someone uses hvc_alloc(). */ |
837 | static int hvc_init(void) | |
1da177e4 | 838 | { |
55aab8cd | 839 | struct tty_driver *drv; |
3e6c6f63 | 840 | int err; |
55aab8cd | 841 | |
5f6d9c07 | 842 | /* We need more than hvc_count adapters due to hotplug additions. */ |
55aab8cd | 843 | drv = alloc_tty_driver(HVC_ALLOC_TTY_ADAPTERS); |
3e6c6f63 RR |
844 | if (!drv) { |
845 | err = -ENOMEM; | |
846 | goto out; | |
847 | } | |
1da177e4 | 848 | |
55aab8cd | 849 | drv->owner = THIS_MODULE; |
55aab8cd MN |
850 | drv->driver_name = "hvc"; |
851 | drv->name = "hvc"; | |
852 | drv->major = HVC_MAJOR; | |
853 | drv->minor_start = HVC_MINOR; | |
854 | drv->type = TTY_DRIVER_TYPE_SYSTEM; | |
855 | drv->init_termios = tty_std_termios; | |
56ce9e2b | 856 | drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_RESET_TERMIOS; |
55aab8cd | 857 | tty_set_operations(drv, &hvc_ops); |
1da177e4 | 858 | |
1da177e4 LT |
859 | /* Always start the kthread because there can be hotplug vty adapters |
860 | * added later. */ | |
861 | hvc_task = kthread_run(khvcd, NULL, "khvcd"); | |
862 | if (IS_ERR(hvc_task)) { | |
3e6c6f63 RR |
863 | printk(KERN_ERR "Couldn't create kthread for console.\n"); |
864 | err = PTR_ERR(hvc_task); | |
865 | goto put_tty; | |
1da177e4 LT |
866 | } |
867 | ||
3e6c6f63 RR |
868 | err = tty_register_driver(drv); |
869 | if (err) { | |
870 | printk(KERN_ERR "Couldn't register hvc console driver\n"); | |
871 | goto stop_thread; | |
872 | } | |
ef4cbee0 | 873 | |
9fef3d2d MM |
874 | /* |
875 | * Make sure tty is fully registered before allowing it to be | |
876 | * found by hvc_console_device. | |
877 | */ | |
878 | smp_mb(); | |
55aab8cd | 879 | hvc_driver = drv; |
acad9559 | 880 | return 0; |
3e6c6f63 | 881 | |
3e6c6f63 RR |
882 | stop_thread: |
883 | kthread_stop(hvc_task); | |
884 | hvc_task = NULL; | |
2571cd6a JL |
885 | put_tty: |
886 | put_tty_driver(drv); | |
3e6c6f63 RR |
887 | out: |
888 | return err; | |
1da177e4 LT |
889 | } |
890 | ||
c3ea6921 | 891 | /* This isn't particularly necessary due to this being a console driver |
320da0d2 MM |
892 | * but it is nice to be thorough. |
893 | */ | |
1da177e4 LT |
894 | static void __exit hvc_exit(void) |
895 | { | |
3e6c6f63 RR |
896 | if (hvc_driver) { |
897 | kthread_stop(hvc_task); | |
1da177e4 | 898 | |
3e6c6f63 RR |
899 | tty_unregister_driver(hvc_driver); |
900 | /* return tty_struct instances allocated in hvc_init(). */ | |
901 | put_tty_driver(hvc_driver); | |
902 | unregister_console(&hvc_con_driver); | |
903 | } | |
1da177e4 | 904 | } |
1da177e4 | 905 | module_exit(hvc_exit); |