2 * vio driver interface to hvc_console.c
4 * This code was moved here to allow the remaining code to be reused as a
5 * generic polling mode with semi-reliable transport driver core to the
6 * console and tty subsystems.
9 * Copyright (C) 2001 Anton Blanchard <anton@au.ibm.com>, IBM
10 * Copyright (C) 2001 Paul Mackerras <paulus@au.ibm.com>, IBM
11 * Copyright (C) 2004 Benjamin Herrenschmidt <benh@kernel.crashing.org>, IBM Corp.
12 * Copyright (C) 2004 IBM Corporation
14 * Additional Author(s):
15 * Ryan S. Arnold <rsa@us.ibm.com>
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 * - handle error in sending hvsi protocol packets
34 * - retry nego on subsequent sends ?
39 #include <linux/types.h>
40 #include <linux/init.h>
41 #include <linux/delay.h>
42 #include <linux/slab.h>
43 #include <linux/console.h>
45 #include <asm/hvconsole.h>
48 #include <asm/firmware.h>
52 #include "hvc_console.h"
54 static const char hvc_driver_name[] = "hvc_console";
56 static struct vio_device_id hvc_driver_table[] __devinitdata = {
57 {"serial", "hvterm1"},
59 {"serial", "hvterm-protocol"},
63 MODULE_DEVICE_TABLE(vio, hvc_driver_table);
65 typedef enum hv_protocol {
71 u32 termno; /* HV term number */
72 hv_protocol_t proto; /* Raw data or HVSI packets */
73 struct hvsi_priv hvsi; /* HVSI specific data */
75 char buf[SIZE_VIO_GET_CHARS];
79 static struct hvterm_priv *hvterm_privs[MAX_NR_HVC_CONSOLES];
80 /* For early boot console */
81 static struct hvterm_priv hvterm_priv0;
83 static int hvterm_raw_get_chars(uint32_t vtermno, char *buf, int count)
85 struct hvterm_priv *pv = hvterm_privs[vtermno];
93 spin_lock_irqsave(&pv->buf_lock, flags);
97 pv->left = hvc_get_chars(pv->termno, pv->buf, count);
100 * Work around a HV bug where it gives us a null
101 * after every \r. -- paulus
103 for (i = 1; i < pv->left; ++i) {
104 if (pv->buf[i] == 0 && pv->buf[i-1] == '\r') {
107 memmove(&pv->buf[i], &pv->buf[i+1],
114 got = min(count, pv->left);
115 memcpy(buf, &pv->buf[pv->offset], got);
119 spin_unlock_irqrestore(&pv->buf_lock, flags);
124 static int hvterm_raw_put_chars(uint32_t vtermno, const char *buf, int count)
126 struct hvterm_priv *pv = hvterm_privs[vtermno];
131 return hvc_put_chars(pv->termno, buf, count);
134 static const struct hv_ops hvterm_raw_ops = {
135 .get_chars = hvterm_raw_get_chars,
136 .put_chars = hvterm_raw_put_chars,
137 .notifier_add = notifier_add_irq,
138 .notifier_del = notifier_del_irq,
139 .notifier_hangup = notifier_hangup_irq,
142 static int hvterm_hvsi_get_chars(uint32_t vtermno, char *buf, int count)
144 struct hvterm_priv *pv = hvterm_privs[vtermno];
149 return hvsilib_get_chars(&pv->hvsi, buf, count);
152 static int hvterm_hvsi_put_chars(uint32_t vtermno, const char *buf, int count)
154 struct hvterm_priv *pv = hvterm_privs[vtermno];
159 return hvsilib_put_chars(&pv->hvsi, buf, count);
162 static int hvterm_hvsi_open(struct hvc_struct *hp, int data)
164 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
167 pr_devel("HVSI@%x: open !\n", pv->termno);
169 rc = notifier_add_irq(hp, data);
173 return hvsilib_open(&pv->hvsi, hp);
176 static void hvterm_hvsi_close(struct hvc_struct *hp, int data)
178 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
180 pr_devel("HVSI@%x: do close !\n", pv->termno);
182 hvsilib_close(&pv->hvsi, hp);
184 notifier_del_irq(hp, data);
187 void hvterm_hvsi_hangup(struct hvc_struct *hp, int data)
189 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
191 pr_devel("HVSI@%x: do hangup !\n", pv->termno);
193 hvsilib_close(&pv->hvsi, hp);
195 notifier_hangup_irq(hp, data);
198 static int hvterm_hvsi_tiocmget(struct hvc_struct *hp)
200 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
204 return pv->hvsi.mctrl;
207 static int hvterm_hvsi_tiocmset(struct hvc_struct *hp, unsigned int set,
210 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
212 pr_devel("HVSI@%x: Set modem control, set=%x,clr=%x\n",
213 pv->termno, set, clear);
216 hvsilib_write_mctrl(&pv->hvsi, 1);
217 else if (clear & TIOCM_DTR)
218 hvsilib_write_mctrl(&pv->hvsi, 0);
223 static const struct hv_ops hvterm_hvsi_ops = {
224 .get_chars = hvterm_hvsi_get_chars,
225 .put_chars = hvterm_hvsi_put_chars,
226 .notifier_add = hvterm_hvsi_open,
227 .notifier_del = hvterm_hvsi_close,
228 .notifier_hangup = hvterm_hvsi_hangup,
229 .tiocmget = hvterm_hvsi_tiocmget,
230 .tiocmset = hvterm_hvsi_tiocmset,
233 static int __devinit hvc_vio_probe(struct vio_dev *vdev,
234 const struct vio_device_id *id)
236 const struct hv_ops *ops;
237 struct hvc_struct *hp;
238 struct hvterm_priv *pv;
242 /* probed with invalid parameters. */
246 if (of_device_is_compatible(vdev->dev.of_node, "hvterm1")) {
247 proto = HV_PROTOCOL_RAW;
248 ops = &hvterm_raw_ops;
249 } else if (of_device_is_compatible(vdev->dev.of_node, "hvterm-protocol")) {
250 proto = HV_PROTOCOL_HVSI;
251 ops = &hvterm_hvsi_ops;
253 pr_err("hvc_vio: Unkown protocol for %s\n", vdev->dev.of_node->full_name);
257 pr_devel("hvc_vio_probe() device %s, using %s protocol\n",
258 vdev->dev.of_node->full_name,
259 proto == HV_PROTOCOL_RAW ? "raw" : "hvsi");
261 /* Is it our boot one ? */
262 if (hvterm_privs[0] == &hvterm_priv0 &&
263 vdev->unit_address == hvterm_priv0.termno) {
264 pv = hvterm_privs[0];
266 pr_devel("->boot console, using termno 0\n");
268 /* nope, allocate a new one */
270 for (i = 0; i < MAX_NR_HVC_CONSOLES && termno < 0; i++)
271 if (!hvterm_privs[i])
273 pr_devel("->non-boot console, using termno %d\n", termno);
276 pv = kzalloc(sizeof(struct hvterm_priv), GFP_KERNEL);
279 pv->termno = vdev->unit_address;
281 spin_lock_init(&pv->buf_lock);
282 hvterm_privs[termno] = pv;
283 hvsilib_init(&pv->hvsi, hvc_get_chars, hvc_put_chars,
287 hp = hvc_alloc(termno, vdev->irq, ops, MAX_VIO_PUT_CHARS);
290 dev_set_drvdata(&vdev->dev, hp);
295 static int __devexit hvc_vio_remove(struct vio_dev *vdev)
297 struct hvc_struct *hp = dev_get_drvdata(&vdev->dev);
300 termno = hp->vtermno;
303 if (hvterm_privs[termno] != &hvterm_priv0)
304 kfree(hvterm_privs[termno]);
305 hvterm_privs[termno] = NULL;
310 static struct vio_driver hvc_vio_driver = {
311 .id_table = hvc_driver_table,
312 .probe = hvc_vio_probe,
313 .remove = __devexit_p(hvc_vio_remove),
315 .name = hvc_driver_name,
316 .owner = THIS_MODULE,
320 static int __init hvc_vio_init(void)
324 if (firmware_has_feature(FW_FEATURE_ISERIES))
327 /* Register as a vio device to receive callbacks */
328 rc = vio_register_driver(&hvc_vio_driver);
332 module_init(hvc_vio_init); /* after drivers/char/hvc_console.c */
334 static void __exit hvc_vio_exit(void)
336 vio_unregister_driver(&hvc_vio_driver);
338 module_exit(hvc_vio_exit);
340 static void udbg_hvc_putc(char c)
348 switch(hvterm_priv0.proto) {
349 case HV_PROTOCOL_RAW:
350 count = hvterm_raw_put_chars(0, &c, 1);
352 case HV_PROTOCOL_HVSI:
353 count = hvterm_hvsi_put_chars(0, &c, 1);
359 static int udbg_hvc_getc_poll(void)
364 switch(hvterm_priv0.proto) {
365 case HV_PROTOCOL_RAW:
366 rc = hvterm_raw_get_chars(0, &c, 1);
368 case HV_PROTOCOL_HVSI:
369 rc = hvterm_hvsi_get_chars(0, &c, 1);
377 static int udbg_hvc_getc(void)
381 ch = udbg_hvc_getc_poll();
383 /* This shouldn't be needed...but... */
384 volatile unsigned long delay;
385 for (delay=0; delay < 2000000; delay++)
393 void __init hvc_vio_init_early(void)
395 struct device_node *stdout_node;
398 const struct hv_ops *ops;
400 /* find the boot console from /chosen/stdout */
403 name = of_get_property(of_chosen, "linux,stdout-path", NULL);
406 stdout_node = of_find_node_by_path(name);
409 name = of_get_property(stdout_node, "name", NULL);
411 printk(KERN_WARNING "stdout node missing 'name' property!\n");
415 /* Check if it's a virtual terminal */
416 if (strncmp(name, "vty", 3) != 0)
418 termno = of_get_property(stdout_node, "reg", NULL);
421 hvterm_priv0.termno = *termno;
422 spin_lock_init(&hvterm_priv0.buf_lock);
423 hvterm_privs[0] = &hvterm_priv0;
425 /* Check the protocol */
426 if (of_device_is_compatible(stdout_node, "hvterm1")) {
427 hvterm_priv0.proto = HV_PROTOCOL_RAW;
428 ops = &hvterm_raw_ops;
430 else if (of_device_is_compatible(stdout_node, "hvterm-protocol")) {
431 hvterm_priv0.proto = HV_PROTOCOL_HVSI;
432 ops = &hvterm_hvsi_ops;
433 hvsilib_init(&hvterm_priv0.hvsi, hvc_get_chars, hvc_put_chars,
434 hvterm_priv0.termno, 1);
435 /* HVSI, perform the handshake now */
436 hvsilib_establish(&hvterm_priv0.hvsi);
439 udbg_putc = udbg_hvc_putc;
440 udbg_getc = udbg_hvc_getc;
441 udbg_getc_poll = udbg_hvc_getc_poll;
443 /* When using the old HVSI driver don't register the HVC
444 * backend for HVSI, only do udbg
446 if (hvterm_priv0.proto == HV_PROTOCOL_HVSI)
449 add_preferred_console("hvc", 0, NULL);
450 hvc_instantiate(0, 0, ops);
452 of_node_put(stdout_node);
455 /* call this from early_init() for a working debug console on
456 * vterm capable LPAR machines
458 #ifdef CONFIG_PPC_EARLY_DEBUG_LPAR
459 void __init udbg_init_debug_lpar(void)
461 hvterm_privs[0] = &hvterm_priv0;
462 hvterm_priv0.termno = 0;
463 hvterm_priv0.proto = HV_PROTOCOL_RAW;
464 spin_lock_init(&hvterm_priv0.buf_lock);
465 udbg_putc = udbg_hvc_putc;
466 udbg_getc = udbg_hvc_getc;
467 udbg_getc_poll = udbg_hvc_getc_poll;
469 #endif /* CONFIG_PPC_EARLY_DEBUG_LPAR */
471 #ifdef CONFIG_PPC_EARLY_DEBUG_LPAR_HVSI
472 void __init udbg_init_debug_lpar_hvsi(void)
474 hvterm_privs[0] = &hvterm_priv0;
475 hvterm_priv0.termno = CONFIG_PPC_EARLY_DEBUG_HVSI_VTERMNO;
476 hvterm_priv0.proto = HV_PROTOCOL_HVSI;
477 spin_lock_init(&hvterm_priv0.buf_lock);
478 udbg_putc = udbg_hvc_putc;
479 udbg_getc = udbg_hvc_getc;
480 udbg_getc_poll = udbg_hvc_getc_poll;
481 hvsilib_init(&hvterm_priv0.hvsi, hvc_get_chars, hvc_put_chars,
482 hvterm_priv0.termno, 1);
483 hvsilib_establish(&hvterm_priv0.hvsi);
485 #endif /* CONFIG_PPC_EARLY_DEBUG_LPAR_HVSI */