blob: 4c3b59be286add18bcf32b500ff84d8a4f88c36a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#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>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080040#include <linux/freezer.h>
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include <asm/uaccess.h>
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020043
44#include "hvc_console.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46#define HVC_MAJOR 229
47#define HVC_MINOR 0
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*
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/*
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020056 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070060#define N_OUTBUF 16
61#define N_INBUF 16
62
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020063#define __ALIGNED__ __attribute__((__aligned__(sizeof(long))))
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Milton Miller837dcfa2005-07-07 17:56:16 -070065static struct tty_driver *hvc_driver;
66static struct task_struct *hvc_task;
67
68/* Picks up late kicks after list walk but before schedule() */
69static int hvc_kicked;
70
Rusty Russell3e6c6f62007-10-16 23:30:13 -070071static int hvc_init(void);
72
Milton Miller837dcfa2005-07-07 17:56:16 -070073#ifdef CONFIG_MAGIC_SYSRQ
74static int sysrq_pressed;
75#endif
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077/* dynamic list of hvc_struct instances */
Denis Chengbed97592008-02-06 01:37:35 -080078static LIST_HEAD(hvc_structs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80/*
81 * Protect the list of hvc_struct instances from inserts and removals during
82 * list traversal.
83 */
84static DEFINE_SPINLOCK(hvc_structs_lock);
85
86/*
Milton Miller6f248082005-07-07 17:56:17 -070087 * 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
will schmidtc3ea6922007-04-18 00:54:51 +100089 * a console candidate registered with hvc_instantiate().
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 */
Milton Miller6f248082005-07-07 17:56:17 -070091static int last_hvc = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093/*
will schmidtc3ea6922007-04-18 00:54:51 +100094 * Do not call this function with either the hvc_structs_lock or the hvc_struct
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -080095 * lock held. If successful, this function increments the kref reference
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 * count against the target hvc_struct so it should be released when finished.
97 */
Adrian Bunk4fa156e2007-05-08 00:24:24 -070098static struct hvc_struct *hvc_get_by_index(int index)
Linus Torvalds1da177e2005-04-16 15:20:36 -070099{
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) {
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800108 kref_get(&hp->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 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
Milton Miller837dcfa2005-07-07 17:56:16 -0700121
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 */
Rusty Russellb5113062010-01-18 03:44:57 +0000128static const struct hv_ops *cons_ops[MAX_NR_HVC_CONSOLES];
Milton Miller64e4da52005-07-07 17:56:22 -0700129static uint32_t vtermnos[MAX_NR_HVC_CONSOLES] =
130 {[0 ... MAX_NR_HVC_CONSOLES - 1] = -1};
Milton Miller837dcfa2005-07-07 17:56:16 -0700131
132/*
133 * Console APIs, NOT TTY. These APIs are available immediately when
134 * hvc_console_setup() finds adapters.
135 */
136
Adrian Bunk4fa156e2007-05-08 00:24:24 -0700137static void hvc_console_print(struct console *co, const char *b,
138 unsigned count)
Milton Miller837dcfa2005-07-07 17:56:16 -0700139{
Ryan S. Arnold45d607e2006-03-27 21:25:16 +0200140 char c[N_OUTBUF] __ALIGNED__;
Milton Miller837dcfa2005-07-07 17:56:16 -0700141 unsigned i = 0, n = 0;
Milton Miller030ffad2005-07-07 17:56:25 -0700142 int r, donecr = 0, index = co->index;
Milton Miller837dcfa2005-07-07 17:56:16 -0700143
144 /* Console access attempt outside of acceptable console range. */
Milton Miller030ffad2005-07-07 17:56:25 -0700145 if (index >= MAX_NR_HVC_CONSOLES)
Milton Miller837dcfa2005-07-07 17:56:16 -0700146 return;
147
will schmidtc3ea6922007-04-18 00:54:51 +1000148 /* This console adapter was removed so it is not usable. */
Milton Miller030ffad2005-07-07 17:56:25 -0700149 if (vtermnos[index] < 0)
Milton Miller837dcfa2005-07-07 17:56:16 -0700150 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 {
Milton Miller030ffad2005-07-07 17:56:25 -0700163 r = cons_ops[index]->put_chars(vtermnos[index], c, i);
Hendrik Brueckner3feebbb2008-10-13 23:12:50 +0000164 if (r <= 0) {
Milton Miller837dcfa2005-07-07 17:56:16 -0700165 /* 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
176static struct tty_driver *hvc_console_device(struct console *c, int *index)
177{
Milton Miller7805b1b2005-07-07 17:56:23 -0700178 if (vtermnos[c->index] == -1)
179 return NULL;
180
Milton Miller837dcfa2005-07-07 17:56:16 -0700181 *index = c->index;
182 return hvc_driver;
183}
184
185static int __init hvc_console_setup(struct console *co, char *options)
186{
Milton Miller7805b1b2005-07-07 17:56:23 -0700187 if (co->index < 0 || co->index >= MAX_NR_HVC_CONSOLES)
188 return -ENODEV;
189
190 if (vtermnos[co->index] == -1)
191 return -ENODEV;
192
Milton Miller837dcfa2005-07-07 17:56:16 -0700193 return 0;
194}
195
Adrian Bunk4fa156e2007-05-08 00:24:24 -0700196static struct console hvc_con_driver = {
Milton Miller837dcfa2005-07-07 17:56:16 -0700197 .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
Milton Millerd5ee2572005-07-07 17:56:24 -0700205/*
will schmidtc3ea6922007-04-18 00:54:51 +1000206 * Early console initialization. Precedes driver initialization.
Milton Millerd5ee2572005-07-07 17:56:24 -0700207 *
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 */
Milton Miller837dcfa2005-07-07 17:56:16 -0700220static int __init hvc_console_init(void)
221{
Milton Miller837dcfa2005-07-07 17:56:16 -0700222 register_console(&hvc_con_driver);
223 return 0;
224}
225console_initcall(hvc_console_init);
226
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800227/* callback when the kboject ref count reaches zero. */
228static 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
Milton Miller837dcfa2005-07-07 17:56:16 -0700244/*
Milton Miller6f248082005-07-07 17:56:17 -0700245 * 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.
Milton Miller837dcfa2005-07-07 17:56:16 -0700249 */
Rusty Russellb5113062010-01-18 03:44:57 +0000250int hvc_instantiate(uint32_t vtermno, int index, const struct hv_ops *ops)
Milton Miller837dcfa2005-07-07 17:56:16 -0700251{
Milton Miller7805b1b2005-07-07 17:56:23 -0700252 struct hvc_struct *hp;
253
Milton Miller837dcfa2005-07-07 17:56:16 -0700254 if (index < 0 || index >= MAX_NR_HVC_CONSOLES)
255 return -1;
256
257 if (vtermnos[index] != -1)
258 return -1;
259
will schmidtc3ea6922007-04-18 00:54:51 +1000260 /* make sure no no tty has been registered in this index */
Milton Miller7805b1b2005-07-07 17:56:23 -0700261 hp = hvc_get_by_index(index);
262 if (hp) {
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800263 kref_put(&hp->kref, destroy_hvc_struct);
Milton Miller7805b1b2005-07-07 17:56:23 -0700264 return -1;
265 }
266
Milton Miller837dcfa2005-07-07 17:56:16 -0700267 vtermnos[index] = vtermno;
Milton Miller030ffad2005-07-07 17:56:25 -0700268 cons_ops[index] = ops;
Milton Miller6f248082005-07-07 17:56:17 -0700269
will schmidtc3ea6922007-04-18 00:54:51 +1000270 /* reserve all indices up to and including this index */
Milton Miller6f248082005-07-07 17:56:17 -0700271 if (last_hvc < index)
272 last_hvc = index;
273
Milton Millerd5ee2572005-07-07 17:56:24 -0700274 /* 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
Milton Miller837dcfa2005-07-07 17:56:16 -0700281 return 0;
282}
Christian Borntraeger7721c492008-07-25 12:06:06 -0500283EXPORT_SYMBOL_GPL(hvc_instantiate);
Milton Miller837dcfa2005-07-07 17:56:16 -0700284
285/* Wake the sleeping khvcd */
Christian Borntraeger611e0972008-06-20 15:24:08 +0200286void hvc_kick(void)
Milton Miller837dcfa2005-07-07 17:56:16 -0700287{
288 hvc_kicked = 1;
289 wake_up_process(hvc_task);
290}
Christian Borntraeger7721c492008-07-25 12:06:06 -0500291EXPORT_SYMBOL_GPL(hvc_kick);
Milton Miller837dcfa2005-07-07 17:56:16 -0700292
Milton Miller837dcfa2005-07-07 17:56:16 -0700293static void hvc_unthrottle(struct tty_struct *tty)
294{
295 hvc_kick();
296}
297
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298/*
299 * The TTY interface won't be used until after the vio layer has exposed the vty
300 * adapter to the kernel.
301 */
302static int hvc_open(struct tty_struct *tty, struct file * filp)
303{
304 struct hvc_struct *hp;
305 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 int rc = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800308 /* Auto increments kref reference if found. */
Olof Johansson87fd7722006-09-07 15:18:08 -0500309 if (!(hp = hvc_get_by_index(tty->index)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
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;
Michal Ostrowskifb5c5942006-02-18 09:29:59 -0500321
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 hp->tty = tty;
Christian Borntraeger611e0972008-06-20 15:24:08 +0200323
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 spin_unlock_irqrestore(&hp->lock, flags);
Christian Borntraeger611e0972008-06-20 15:24:08 +0200325
Christian Borntraegerb1b135c2008-08-07 09:18:34 +0200326 if (hp->ops->notifier_add)
327 rc = hp->ops->notifier_add(hp, hp->data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
329 /*
Christian Borntraeger611e0972008-06-20 15:24:08 +0200330 * If the notifier fails we return an error. The tty layer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 * 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
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800333 * tty fields and return the kref reference.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 */
335 if (rc) {
336 spin_lock_irqsave(&hp->lock, flags);
337 hp->tty = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 spin_unlock_irqrestore(&hp->lock, flags);
339 tty->driver_data = NULL;
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800340 kref_put(&hp->kref, destroy_hvc_struct);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 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
349static void hvc_close(struct tty_struct *tty, struct file * filp)
350{
351 struct hvc_struct *hp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 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
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800360 * exit cleanly because the kref reference wasn't made.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 */
362 if (!tty->driver_data)
363 return;
364
365 hp = tty->driver_data;
366 spin_lock_irqsave(&hp->lock, flags);
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 if (--hp->count == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 /* We are done with the tty pointer now. */
370 hp->tty = NULL;
371 spin_unlock_irqrestore(&hp->lock, flags);
372
Christian Borntraegereef26222008-10-12 21:51:31 +0000373 if (hp->ops->notifier_del)
374 hp->ops->notifier_del(hp, hp->data);
375
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000376 /* cancel pending tty resize work */
377 cancel_work_sync(&hp->tty_resize);
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 /*
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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 } 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
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800392 kref_put(&hp->kref, destroy_hvc_struct);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393}
394
395static void hvc_hangup(struct tty_struct *tty)
396{
397 struct hvc_struct *hp = tty->driver_data;
398 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 int temp_open_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401 if (!hp)
402 return;
403
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000404 /* cancel pending tty resize work */
405 cancel_work_sync(&hp->tty_resize);
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 temp_open_count = hp->count;
420 hp->count = 0;
421 hp->n_outbuf = 0;
422 hp->tty = NULL;
Christian Borntraeger611e0972008-06-20 15:24:08 +0200423
Christian Borntraegereef26222008-10-12 21:51:31 +0000424 spin_unlock_irqrestore(&hp->lock, flags);
425
Hendrik Bruecknerfc362e22008-10-13 23:12:48 +0000426 if (hp->ops->notifier_hangup)
427 hp->ops->notifier_hangup(hp, hp->data);
Christian Borntraeger611e0972008-06-20 15:24:08 +0200428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 while(temp_open_count) {
430 --temp_open_count;
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800431 kref_put(&hp->kref, destroy_hvc_struct);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 }
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 */
Hendrik Brueckner3feebbb2008-10-13 23:12:50 +0000439static int hvc_push(struct hvc_struct *hp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
441 int n;
442
Milton Miller030ffad2005-07-07 17:56:25 -0700443 n = hp->ops->put_chars(hp->vtermno, hp->outbuf, hp->n_outbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 if (n <= 0) {
Ryan S. Arnold45d607e2006-03-27 21:25:16 +0200445 if (n == 0) {
446 hp->do_wakeup = 1;
Hendrik Brueckner3feebbb2008-10-13 23:12:50 +0000447 return 0;
Ryan S. Arnold45d607e2006-03-27 21:25:16 +0200448 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 /* 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;
Hendrik Brueckner3feebbb2008-10-13 23:12:50 +0000458
459 return n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460}
461
Ryan S. Arnold45d607e2006-03-27 21:25:16 +0200462static int hvc_write(struct tty_struct *tty, const unsigned char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463{
Ryan S. Arnold45d607e2006-03-27 21:25:16 +0200464 struct hvc_struct *hp = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 unsigned long flags;
466 int rsize, written = 0;
467
Ryan S. Arnold45d607e2006-03-27 21:25:16 +0200468 /* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 spin_lock_irqsave(&hp->lock, flags);
476
477 /* Push pending writes */
478 if (hp->n_outbuf > 0)
479 hvc_push(hp);
480
Stephen Rothwell4e9e95a2006-07-13 18:53:32 +1000481 while (count > 0 && (rsize = hp->outbuf_size - hp->n_outbuf) > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 /*
494 * Racy, but harmless, kick thread if there is still pending data.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 */
496 if (hp->n_outbuf)
497 hvc_kick();
498
499 return written;
500}
501
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000502/**
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 */
511static 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);
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000519
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
Alan Coxfc6f6232009-01-02 13:43:17 +0000529 tty_do_resize(tty, &ws);
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000530 tty_kref_put(tty);
531}
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533/*
534 * This is actually a contract between the driver and the tty layer outlining
will schmidtc3ea6922007-04-18 00:54:51 +1000535 * how much write room the driver can guarantee will be sent OR BUFFERED. This
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 * driver MUST honor the return value.
537 */
538static 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
Stephen Rothwell4e9e95a2006-07-13 18:53:32 +1000545 return hp->outbuf_size - hp->n_outbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546}
547
548static int hvc_chars_in_buffer(struct tty_struct *tty)
549{
550 struct hvc_struct *hp = tty->driver_data;
551
552 if (!hp)
Alan Cox23198fd2009-07-20 16:05:27 +0100553 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 return hp->n_outbuf;
555}
556
Will Schmidtb7910722007-04-18 00:44:46 +1000557/*
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)
567static u32 timeout = MIN_TIMEOUT;
568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569#define HVC_POLL_READ 0x00000001
570#define HVC_POLL_WRITE 0x00000002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Christian Borntraeger611e0972008-06-20 15:24:08 +0200572int hvc_poll(struct hvc_struct *hp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
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;
Hendrik Brueckner3feebbb2008-10-13 23:12:50 +0000579 int written_total = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
581 spin_lock_irqsave(&hp->lock, flags);
582
583 /* Push pending writes */
584 if (hp->n_outbuf > 0)
Hendrik Brueckner3feebbb2008-10-13 23:12:50 +0000585 written_total = hvc_push(hp);
Michael Ellermanb5374462006-06-07 17:10:03 +1000586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 /* Reschedule us if still some write pending */
Hendrik Brueckner3feebbb2008-10-13 23:12:50 +0000588 if (hp->n_outbuf > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 poll_mask |= HVC_POLL_WRITE;
Hendrik Brueckner3feebbb2008-10-13 23:12:50 +0000590 /* If hvc_push() was not able to write, sleep a few msecs */
591 timeout = (written_total) ? 0 : MIN_TIMEOUT;
592 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
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
Christian Borntraeger611e0972008-06-20 15:24:08 +0200603 /* If we aren't notifier driven and aren't throttled, we always
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 * request a reschedule
605 */
Christian Borntraeger611e0972008-06-20 15:24:08 +0200606 if (!hp->irq_requested)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 poll_mask |= HVC_POLL_READ;
608
609 /* Read data if any */
610 for (;;) {
Alan Cox33f0f882006-01-09 20:54:13 -0800611 int count = tty_buffer_request_room(tty, N_INBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
613 /* If flip is full, just reschedule a later read */
614 if (count == 0) {
615 poll_mask |= HVC_POLL_READ;
616 break;
617 }
618
Milton Miller030ffad2005-07-07 17:56:25 -0700619 n = hp->ops->get_chars(hp->vtermno, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 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);
Ryan S. Arnold45d607e2006-03-27 21:25:16 +0200626 } 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 }
634 break;
635 }
636 for (i = 0; i < n; ++i) {
637#ifdef CONFIG_MAGIC_SYSRQ
Milton Miller2b9e0ba2005-07-07 17:56:19 -0700638 if (hp->index == hvc_con_driver.index) {
639 /* Handle the SysRq Hack */
640 /* XXX should support a sequence */
641 if (buf[i] == '\x0f') { /* ^O */
Hendrik Brueckner368c1e32008-12-16 00:09:38 +0000642 /* if ^O is pressed again, reset
643 * sysrq_pressed and flip ^O char */
644 sysrq_pressed = !sysrq_pressed;
645 if (sysrq_pressed)
646 continue;
Milton Miller2b9e0ba2005-07-07 17:56:19 -0700647 } else if (sysrq_pressed) {
David Howells7d12e782006-10-05 14:55:46 +0100648 handle_sysrq(buf[i], tty);
Milton Miller2b9e0ba2005-07-07 17:56:19 -0700649 sysrq_pressed = 0;
650 continue;
651 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 }
653#endif /* CONFIG_MAGIC_SYSRQ */
654 tty_insert_flip_char(tty, buf[i], 0);
655 }
656
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 read_total += n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
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
Will Schmidtb7910722007-04-18 00:44:46 +1000668 if (read_total) {
669 /* Activity is occurring, so reset the polling backoff value to
670 a minimum for performance. */
671 timeout = MIN_TIMEOUT;
672
Michal Ostrowskifb5c5942006-02-18 09:29:59 -0500673 tty_flip_buffer_push(tty);
Will Schmidtb7910722007-04-18 00:44:46 +1000674 }
675
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 return poll_mask;
677}
Christian Borntraeger7721c492008-07-25 12:06:06 -0500678EXPORT_SYMBOL_GPL(hvc_poll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000680/**
Hendrik Brueckner254be492009-08-27 01:45:39 +0000681 * __hvc_resize() - Update terminal window size information.
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000682 * @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 */
Hendrik Brueckner254be492009-08-27 01:45:39 +0000690void __hvc_resize(struct hvc_struct *hp, struct winsize ws)
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000691{
Hendrik Brueckner7947cf02008-11-18 01:28:28 +0000692 hp->ws = ws;
693 schedule_work(&hp->tty_resize);
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000694}
Hendrik Brueckner254be492009-08-27 01:45:39 +0000695EXPORT_SYMBOL_GPL(__hvc_resize);
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697/*
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 */
Adrian Bunk5605d4d2007-07-09 11:37:38 -0700702static int khvcd(void *unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703{
704 int poll_mask;
705 struct hvc_struct *hp;
706
Rafael J. Wysocki83144182007-07-17 04:03:35 -0700707 set_freezable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 __set_current_state(TASK_RUNNING);
709 do {
710 poll_mask = 0;
711 hvc_kicked = 0;
Andrew Mortonb64074e2006-09-16 12:15:38 -0700712 try_to_freeze();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 wmb();
Michael Ellerman1c8950f2008-05-08 14:27:17 +1000714 if (!cpus_are_in_xmon()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 spin_lock(&hvc_structs_lock);
716 list_for_each_entry(hp, &hvc_structs, next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 set_current_state(TASK_INTERRUPTIBLE);
725 if (!hvc_kicked) {
726 if (poll_mask == 0)
727 schedule();
Will Schmidtb7910722007-04-18 00:44:46 +1000728 else {
729 if (timeout < MAX_TIMEOUT)
730 timeout += (timeout >> 6) + 1;
731
732 msleep_interruptible(timeout);
733 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 }
735 __set_current_state(TASK_RUNNING);
736 } while (!kthread_should_stop());
737
738 return 0;
739}
740
Jeff Dikeb68e31d2006-10-02 02:17:18 -0700741static const struct tty_operations hvc_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 .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
Amit Shah119ea102010-01-18 03:44:58 +0000751struct hvc_struct *hvc_alloc(uint32_t vtermno, int data,
752 const struct hv_ops *ops,
753 int outbuf_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754{
755 struct hvc_struct *hp;
Milton Miller6f248082005-07-07 17:56:17 -0700756 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700758 /* We wait until a driver actually comes along */
759 if (!hvc_driver) {
760 int err = hvc_init();
761 if (err)
762 return ERR_PTR(err);
763 }
764
Milton Miller2da75822009-01-08 02:14:28 +0000765 hp = kzalloc(ALIGN(sizeof(*hp), sizeof(long)) + outbuf_size,
Stephen Rothwell4e9e95a2006-07-13 18:53:32 +1000766 GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 if (!hp)
Milton Milleracad9552005-07-07 17:56:24 -0700768 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Milton Milleracad9552005-07-07 17:56:24 -0700770 hp->vtermno = vtermno;
Christian Borntraeger611e0972008-06-20 15:24:08 +0200771 hp->data = data;
Milton Miller030ffad2005-07-07 17:56:25 -0700772 hp->ops = ops;
Stephen Rothwell4e9e95a2006-07-13 18:53:32 +1000773 hp->outbuf_size = outbuf_size;
774 hp->outbuf = &((char *)hp)[ALIGN(sizeof(*hp), sizeof(long))];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800776 kref_init(&hp->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000778 INIT_WORK(&hp->tty_resize, hvc_set_winsz);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 spin_lock_init(&hp->lock);
780 spin_lock(&hvc_structs_lock);
Milton Miller6f248082005-07-07 17:56:17 -0700781
782 /*
783 * find index to use:
784 * see if this vterm id matches one registered for console.
785 */
786 for (i=0; i < MAX_NR_HVC_CONSOLES; i++)
Ryan S. Arnold45d607e2006-03-27 21:25:16 +0200787 if (vtermnos[i] == hp->vtermno &&
788 cons_ops[i] == hp->ops)
Milton Miller6f248082005-07-07 17:56:17 -0700789 break;
790
791 /* no matching slot, just use a counter */
792 if (i >= MAX_NR_HVC_CONSOLES)
793 i = ++last_hvc;
794
795 hp->index = i;
796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 list_add_tail(&(hp->next), &hvc_structs);
798 spin_unlock(&hvc_structs_lock);
799
Milton Milleracad9552005-07-07 17:56:24 -0700800 return hp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801}
Christian Borntraeger7721c492008-07-25 12:06:06 -0500802EXPORT_SYMBOL_GPL(hvc_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Hendrik Brueckner934752d2008-10-13 23:12:52 +0000804int hvc_remove(struct hvc_struct *hp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 struct tty_struct *tty;
808
809 spin_lock_irqsave(&hp->lock, flags);
810 tty = hp->tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
812 if (hp->index < MAX_NR_HVC_CONSOLES)
813 vtermnos[hp->index] = -1;
814
815 /* Don't whack hp->irq because tty_hangup() will need to free the irq. */
816
817 spin_unlock_irqrestore(&hp->lock, flags);
818
819 /*
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800820 * We 'put' the instance that was grabbed when the kref instance
821 * was initialized using kref_init(). Let the last holder of this
822 * kref cause it to be removed, which will probably be the tty_hangup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 * below.
824 */
Greg Kroah-Hartman12b20de2007-11-28 10:46:22 -0800825 kref_put(&hp->kref, destroy_hvc_struct);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
827 /*
828 * This function call will auto chain call hvc_hangup. The tty should
829 * always be valid at this time unless a simultaneous tty close already
830 * cleaned up the hvc_struct.
831 */
832 if (tty)
833 tty_hangup(tty);
834 return 0;
835}
Amit Shahc0cefeb2009-11-27 20:50:49 +0000836EXPORT_SYMBOL_GPL(hvc_remove);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700838/* Driver initialization: called as soon as someone uses hvc_alloc(). */
839static int hvc_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840{
Michael Neuling55aab8c2006-03-25 17:30:00 +1100841 struct tty_driver *drv;
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700842 int err;
Michael Neuling55aab8c2006-03-25 17:30:00 +1100843
Milton Miller5f6d9c02005-07-07 17:56:21 -0700844 /* We need more than hvc_count adapters due to hotplug additions. */
Michael Neuling55aab8c2006-03-25 17:30:00 +1100845 drv = alloc_tty_driver(HVC_ALLOC_TTY_ADAPTERS);
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700846 if (!drv) {
847 err = -ENOMEM;
848 goto out;
849 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Michael Neuling55aab8c2006-03-25 17:30:00 +1100851 drv->owner = THIS_MODULE;
Michael Neuling55aab8c2006-03-25 17:30:00 +1100852 drv->driver_name = "hvc";
853 drv->name = "hvc";
854 drv->major = HVC_MAJOR;
855 drv->minor_start = HVC_MINOR;
856 drv->type = TTY_DRIVER_TYPE_SYSTEM;
857 drv->init_termios = tty_std_termios;
Hendrik Brueckner56ce9e22008-10-13 23:12:49 +0000858 drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_RESET_TERMIOS;
Michael Neuling55aab8c2006-03-25 17:30:00 +1100859 tty_set_operations(drv, &hvc_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 /* Always start the kthread because there can be hotplug vty adapters
862 * added later. */
863 hvc_task = kthread_run(khvcd, NULL, "khvcd");
864 if (IS_ERR(hvc_task)) {
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700865 printk(KERN_ERR "Couldn't create kthread for console.\n");
866 err = PTR_ERR(hvc_task);
867 goto put_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 }
869
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700870 err = tty_register_driver(drv);
871 if (err) {
872 printk(KERN_ERR "Couldn't register hvc console driver\n");
873 goto stop_thread;
874 }
Anton Blanchardef4cbee2005-09-14 14:19:18 -0700875
Milton Miller9fef3d22009-01-08 02:14:18 +0000876 /*
877 * Make sure tty is fully registered before allowing it to be
878 * found by hvc_console_device.
879 */
880 smp_mb();
Michael Neuling55aab8c2006-03-25 17:30:00 +1100881 hvc_driver = drv;
Milton Milleracad9552005-07-07 17:56:24 -0700882 return 0;
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700883
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700884stop_thread:
885 kthread_stop(hvc_task);
886 hvc_task = NULL;
Julia Lawall2571cd62008-10-13 10:31:49 +0100887put_tty:
888 put_tty_driver(drv);
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700889out:
890 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891}
892
will schmidtc3ea6922007-04-18 00:54:51 +1000893/* This isn't particularly necessary due to this being a console driver
Milton Miller320da0d2005-07-07 17:56:20 -0700894 * but it is nice to be thorough.
895 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896static void __exit hvc_exit(void)
897{
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700898 if (hvc_driver) {
899 kthread_stop(hvc_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Rusty Russell3e6c6f62007-10-16 23:30:13 -0700901 tty_unregister_driver(hvc_driver);
902 /* return tty_struct instances allocated in hvc_init(). */
903 put_tty_driver(hvc_driver);
904 unregister_console(&hvc_con_driver);
905 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907module_exit(hvc_exit);