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>
50 #include <asm/machdep.h>
52 #include "hvc_console.h"
54 static const char hvc_driver_name[] = "hvc_console";
56 static struct vio_device_id hvc_driver_table[] = {
57 {"serial", "hvterm1"},
59 {"serial", "hvterm-protocol"},
64 typedef enum hv_protocol {
70 u32 termno; /* HV term number */
71 hv_protocol_t proto; /* Raw data or HVSI packets */
72 struct hvsi_priv hvsi; /* HVSI specific data */
74 char buf[SIZE_VIO_GET_CHARS];
78 static struct hvterm_priv *hvterm_privs[MAX_NR_HVC_CONSOLES];
79 /* For early boot console */
80 static struct hvterm_priv hvterm_priv0;
82 static int hvterm_raw_get_chars(uint32_t vtermno, char *buf, int count)
84 struct hvterm_priv *pv = hvterm_privs[vtermno];
92 spin_lock_irqsave(&pv->buf_lock, flags);
96 pv->left = hvc_get_chars(pv->termno, pv->buf, count);
99 * Work around a HV bug where it gives us a null
100 * after every \r. -- paulus
102 for (i = 1; i < pv->left; ++i) {
103 if (pv->buf[i] == 0 && pv->buf[i-1] == '\r') {
106 memmove(&pv->buf[i], &pv->buf[i+1],
113 got = min(count, pv->left);
114 memcpy(buf, &pv->buf[pv->offset], got);
118 spin_unlock_irqrestore(&pv->buf_lock, flags);
124 * hvterm_raw_put_chars: send characters to firmware for given vterm adapter
125 * @vtermno: The virtual terminal number.
126 * @buf: The characters to send. Because of the underlying hypercall in
127 * hvc_put_chars(), this buffer must be at least 16 bytes long, even if
128 * you are sending fewer chars.
129 * @count: number of chars to send.
131 static int hvterm_raw_put_chars(uint32_t vtermno, const char *buf, int count)
133 struct hvterm_priv *pv = hvterm_privs[vtermno];
138 return hvc_put_chars(pv->termno, buf, count);
141 static const struct hv_ops hvterm_raw_ops = {
142 .get_chars = hvterm_raw_get_chars,
143 .put_chars = hvterm_raw_put_chars,
144 .notifier_add = notifier_add_irq,
145 .notifier_del = notifier_del_irq,
146 .notifier_hangup = notifier_hangup_irq,
149 static int hvterm_hvsi_get_chars(uint32_t vtermno, char *buf, int count)
151 struct hvterm_priv *pv = hvterm_privs[vtermno];
156 return hvsilib_get_chars(&pv->hvsi, buf, count);
159 static int hvterm_hvsi_put_chars(uint32_t vtermno, const char *buf, int count)
161 struct hvterm_priv *pv = hvterm_privs[vtermno];
166 return hvsilib_put_chars(&pv->hvsi, buf, count);
169 static int hvterm_hvsi_open(struct hvc_struct *hp, int data)
171 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
174 pr_devel("HVSI@%x: open !\n", pv->termno);
176 rc = notifier_add_irq(hp, data);
180 return hvsilib_open(&pv->hvsi, hp);
183 static void hvterm_hvsi_close(struct hvc_struct *hp, int data)
185 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
187 pr_devel("HVSI@%x: do close !\n", pv->termno);
189 hvsilib_close(&pv->hvsi, hp);
191 notifier_del_irq(hp, data);
194 void hvterm_hvsi_hangup(struct hvc_struct *hp, int data)
196 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
198 pr_devel("HVSI@%x: do hangup !\n", pv->termno);
200 hvsilib_close(&pv->hvsi, hp);
202 notifier_hangup_irq(hp, data);
205 static int hvterm_hvsi_tiocmget(struct hvc_struct *hp)
207 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
211 return pv->hvsi.mctrl;
214 static int hvterm_hvsi_tiocmset(struct hvc_struct *hp, unsigned int set,
217 struct hvterm_priv *pv = hvterm_privs[hp->vtermno];
219 pr_devel("HVSI@%x: Set modem control, set=%x,clr=%x\n",
220 pv->termno, set, clear);
223 hvsilib_write_mctrl(&pv->hvsi, 1);
224 else if (clear & TIOCM_DTR)
225 hvsilib_write_mctrl(&pv->hvsi, 0);
230 static const struct hv_ops hvterm_hvsi_ops = {
231 .get_chars = hvterm_hvsi_get_chars,
232 .put_chars = hvterm_hvsi_put_chars,
233 .notifier_add = hvterm_hvsi_open,
234 .notifier_del = hvterm_hvsi_close,
235 .notifier_hangup = hvterm_hvsi_hangup,
236 .tiocmget = hvterm_hvsi_tiocmget,
237 .tiocmset = hvterm_hvsi_tiocmset,
240 static void udbg_hvc_putc(char c)
243 unsigned char bounce_buffer[16];
245 if (!hvterm_privs[0])
252 switch(hvterm_privs[0]->proto) {
253 case HV_PROTOCOL_RAW:
255 * hvterm_raw_put_chars requires at least a 16-byte
256 * buffer, so go via the bounce buffer
258 bounce_buffer[0] = c;
259 count = hvterm_raw_put_chars(0, bounce_buffer, 1);
261 case HV_PROTOCOL_HVSI:
262 count = hvterm_hvsi_put_chars(0, &c, 1);
268 static int udbg_hvc_getc_poll(void)
273 if (!hvterm_privs[0])
276 switch(hvterm_privs[0]->proto) {
277 case HV_PROTOCOL_RAW:
278 rc = hvterm_raw_get_chars(0, &c, 1);
280 case HV_PROTOCOL_HVSI:
281 rc = hvterm_hvsi_get_chars(0, &c, 1);
289 static int udbg_hvc_getc(void)
293 if (!hvterm_privs[0])
297 ch = udbg_hvc_getc_poll();
299 /* This shouldn't be needed...but... */
300 volatile unsigned long delay;
301 for (delay=0; delay < 2000000; delay++)
309 static int hvc_vio_probe(struct vio_dev *vdev,
310 const struct vio_device_id *id)
312 const struct hv_ops *ops;
313 struct hvc_struct *hp;
314 struct hvterm_priv *pv;
318 /* probed with invalid parameters. */
322 if (of_device_is_compatible(vdev->dev.of_node, "hvterm1")) {
323 proto = HV_PROTOCOL_RAW;
324 ops = &hvterm_raw_ops;
325 } else if (of_device_is_compatible(vdev->dev.of_node, "hvterm-protocol")) {
326 proto = HV_PROTOCOL_HVSI;
327 ops = &hvterm_hvsi_ops;
329 pr_err("hvc_vio: Unknown protocol for %s\n", vdev->dev.of_node->full_name);
333 pr_devel("hvc_vio_probe() device %s, using %s protocol\n",
334 vdev->dev.of_node->full_name,
335 proto == HV_PROTOCOL_RAW ? "raw" : "hvsi");
337 /* Is it our boot one ? */
338 if (hvterm_privs[0] == &hvterm_priv0 &&
339 vdev->unit_address == hvterm_priv0.termno) {
340 pv = hvterm_privs[0];
342 pr_devel("->boot console, using termno 0\n");
344 /* nope, allocate a new one */
346 for (i = 0; i < MAX_NR_HVC_CONSOLES && termno < 0; i++)
347 if (!hvterm_privs[i])
349 pr_devel("->non-boot console, using termno %d\n", termno);
352 pv = kzalloc(sizeof(struct hvterm_priv), GFP_KERNEL);
355 pv->termno = vdev->unit_address;
357 spin_lock_init(&pv->buf_lock);
358 hvterm_privs[termno] = pv;
359 hvsilib_init(&pv->hvsi, hvc_get_chars, hvc_put_chars,
363 hp = hvc_alloc(termno, vdev->irq, ops, MAX_VIO_PUT_CHARS);
366 dev_set_drvdata(&vdev->dev, hp);
368 /* register udbg if it's not there already for console 0 */
369 if (hp->index == 0 && !udbg_putc) {
370 udbg_putc = udbg_hvc_putc;
371 udbg_getc = udbg_hvc_getc;
372 udbg_getc_poll = udbg_hvc_getc_poll;
378 static struct vio_driver hvc_vio_driver = {
379 .id_table = hvc_driver_table,
380 .probe = hvc_vio_probe,
381 .name = hvc_driver_name,
383 .suppress_bind_attrs = true,
387 static int __init hvc_vio_init(void)
391 /* Register as a vio device to receive callbacks */
392 rc = vio_register_driver(&hvc_vio_driver);
396 device_initcall(hvc_vio_init); /* after drivers/tty/hvc/hvc_console.c */
398 void __init hvc_vio_init_early(void)
400 const __be32 *termno;
402 const struct hv_ops *ops;
404 /* find the boot console from /chosen/stdout */
407 name = of_get_property(of_stdout, "name", NULL);
409 printk(KERN_WARNING "stdout node missing 'name' property!\n");
413 /* Check if it's a virtual terminal */
414 if (strncmp(name, "vty", 3) != 0)
416 termno = of_get_property(of_stdout, "reg", NULL);
419 hvterm_priv0.termno = of_read_number(termno, 1);
420 spin_lock_init(&hvterm_priv0.buf_lock);
421 hvterm_privs[0] = &hvterm_priv0;
423 /* Check the protocol */
424 if (of_device_is_compatible(of_stdout, "hvterm1")) {
425 hvterm_priv0.proto = HV_PROTOCOL_RAW;
426 ops = &hvterm_raw_ops;
428 else if (of_device_is_compatible(of_stdout, "hvterm-protocol")) {
429 hvterm_priv0.proto = HV_PROTOCOL_HVSI;
430 ops = &hvterm_hvsi_ops;
431 hvsilib_init(&hvterm_priv0.hvsi, hvc_get_chars, hvc_put_chars,
432 hvterm_priv0.termno, 1);
433 /* HVSI, perform the handshake now */
434 hvsilib_establish(&hvterm_priv0.hvsi);
437 udbg_putc = udbg_hvc_putc;
438 udbg_getc = udbg_hvc_getc;
439 udbg_getc_poll = udbg_hvc_getc_poll;
441 /* When using the old HVSI driver don't register the HVC
442 * backend for HVSI, only do udbg
444 if (hvterm_priv0.proto == HV_PROTOCOL_HVSI)
447 /* Check whether the user has requested a different console. */
448 if (!strstr(boot_command_line, "console="))
449 add_preferred_console("hvc", 0, NULL);
450 hvc_instantiate(0, 0, ops);
453 /* call this from early_init() for a working debug console on
454 * vterm capable LPAR machines
456 #ifdef CONFIG_PPC_EARLY_DEBUG_LPAR
457 void __init udbg_init_debug_lpar(void)
459 hvterm_privs[0] = &hvterm_priv0;
460 hvterm_priv0.termno = 0;
461 hvterm_priv0.proto = HV_PROTOCOL_RAW;
462 spin_lock_init(&hvterm_priv0.buf_lock);
463 udbg_putc = udbg_hvc_putc;
464 udbg_getc = udbg_hvc_getc;
465 udbg_getc_poll = udbg_hvc_getc_poll;
467 #endif /* CONFIG_PPC_EARLY_DEBUG_LPAR */
469 #ifdef CONFIG_PPC_EARLY_DEBUG_LPAR_HVSI
470 void __init udbg_init_debug_lpar_hvsi(void)
472 hvterm_privs[0] = &hvterm_priv0;
473 hvterm_priv0.termno = CONFIG_PPC_EARLY_DEBUG_HVSI_VTERMNO;
474 hvterm_priv0.proto = HV_PROTOCOL_HVSI;
475 spin_lock_init(&hvterm_priv0.buf_lock);
476 udbg_putc = udbg_hvc_putc;
477 udbg_getc = udbg_hvc_getc;
478 udbg_getc_poll = udbg_hvc_getc_poll;
479 hvsilib_init(&hvterm_priv0.hvsi, hvc_get_chars, hvc_put_chars,
480 hvterm_priv0.termno, 1);
481 hvsilib_establish(&hvterm_priv0.hvsi);
483 #endif /* CONFIG_PPC_EARLY_DEBUG_LPAR_HVSI */