2
* opal driver interface to hvc_console.c
4
* Copyright 2011 Benjamin Herrenschmidt <benh@kernel.crashing.org>, IBM Corp.
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or
9
* (at your option) any later version.
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with this program; if not, write to the Free Software
18
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24
#include <linux/types.h>
25
#include <linux/init.h>
26
#include <linux/delay.h>
27
#include <linux/slab.h>
28
#include <linux/console.h>
30
#include <linux/of_platform.h>
31
#include <linux/export.h>
33
#include <asm/hvconsole.h>
35
#include <asm/firmware.h>
40
#include "hvc_console.h"
42
static const char hvc_opal_name[] = "hvc_opal";
44
static struct of_device_id hvc_opal_match[] __devinitdata = {
45
{ .name = "serial", .compatible = "ibm,opal-console-raw" },
46
{ .name = "serial", .compatible = "ibm,opal-console-hvsi" },
50
typedef enum hv_protocol {
55
struct hvc_opal_priv {
56
hv_protocol_t proto; /* Raw data or HVSI packets */
57
struct hvsi_priv hvsi; /* HVSI specific data */
59
static struct hvc_opal_priv *hvc_opal_privs[MAX_NR_HVC_CONSOLES];
61
/* For early boot console */
62
static struct hvc_opal_priv hvc_opal_boot_priv;
63
static u32 hvc_opal_boot_termno;
65
static const struct hv_ops hvc_opal_raw_ops = {
66
.get_chars = opal_get_chars,
67
.put_chars = opal_put_chars,
68
.notifier_add = notifier_add_irq,
69
.notifier_del = notifier_del_irq,
70
.notifier_hangup = notifier_hangup_irq,
73
static int hvc_opal_hvsi_get_chars(uint32_t vtermno, char *buf, int count)
75
struct hvc_opal_priv *pv = hvc_opal_privs[vtermno];
80
return hvsilib_get_chars(&pv->hvsi, buf, count);
83
static int hvc_opal_hvsi_put_chars(uint32_t vtermno, const char *buf, int count)
85
struct hvc_opal_priv *pv = hvc_opal_privs[vtermno];
90
return hvsilib_put_chars(&pv->hvsi, buf, count);
93
static int hvc_opal_hvsi_open(struct hvc_struct *hp, int data)
95
struct hvc_opal_priv *pv = hvc_opal_privs[hp->vtermno];
98
pr_devel("HVSI@%x: do open !\n", hp->vtermno);
100
rc = notifier_add_irq(hp, data);
104
return hvsilib_open(&pv->hvsi, hp);
107
static void hvc_opal_hvsi_close(struct hvc_struct *hp, int data)
109
struct hvc_opal_priv *pv = hvc_opal_privs[hp->vtermno];
111
pr_devel("HVSI@%x: do close !\n", hp->vtermno);
113
hvsilib_close(&pv->hvsi, hp);
115
notifier_del_irq(hp, data);
118
void hvc_opal_hvsi_hangup(struct hvc_struct *hp, int data)
120
struct hvc_opal_priv *pv = hvc_opal_privs[hp->vtermno];
122
pr_devel("HVSI@%x: do hangup !\n", hp->vtermno);
124
hvsilib_close(&pv->hvsi, hp);
126
notifier_hangup_irq(hp, data);
129
static int hvc_opal_hvsi_tiocmget(struct hvc_struct *hp)
131
struct hvc_opal_priv *pv = hvc_opal_privs[hp->vtermno];
135
return pv->hvsi.mctrl;
138
static int hvc_opal_hvsi_tiocmset(struct hvc_struct *hp, unsigned int set,
141
struct hvc_opal_priv *pv = hvc_opal_privs[hp->vtermno];
143
pr_devel("HVSI@%x: Set modem control, set=%x,clr=%x\n",
144
hp->vtermno, set, clear);
147
hvsilib_write_mctrl(&pv->hvsi, 1);
148
else if (clear & TIOCM_DTR)
149
hvsilib_write_mctrl(&pv->hvsi, 0);
154
static const struct hv_ops hvc_opal_hvsi_ops = {
155
.get_chars = hvc_opal_hvsi_get_chars,
156
.put_chars = hvc_opal_hvsi_put_chars,
157
.notifier_add = hvc_opal_hvsi_open,
158
.notifier_del = hvc_opal_hvsi_close,
159
.notifier_hangup = hvc_opal_hvsi_hangup,
160
.tiocmget = hvc_opal_hvsi_tiocmget,
161
.tiocmset = hvc_opal_hvsi_tiocmset,
164
static int __devinit hvc_opal_probe(struct platform_device *dev)
166
const struct hv_ops *ops;
167
struct hvc_struct *hp;
168
struct hvc_opal_priv *pv;
170
unsigned int termno, boot = 0;
173
if (of_device_is_compatible(dev->dev.of_node, "ibm,opal-console-raw")) {
174
proto = HV_PROTOCOL_RAW;
175
ops = &hvc_opal_raw_ops;
176
} else if (of_device_is_compatible(dev->dev.of_node,
177
"ibm,opal-console-hvsi")) {
178
proto = HV_PROTOCOL_HVSI;
179
ops = &hvc_opal_hvsi_ops;
181
pr_err("hvc_opal: Unkown protocol for %s\n",
182
dev->dev.of_node->full_name);
186
reg = of_get_property(dev->dev.of_node, "reg", NULL);
187
termno = reg ? be32_to_cpup(reg) : 0;
189
/* Is it our boot one ? */
190
if (hvc_opal_privs[termno] == &hvc_opal_boot_priv) {
191
pv = hvc_opal_privs[termno];
193
} else if (hvc_opal_privs[termno] == NULL) {
194
pv = kzalloc(sizeof(struct hvc_opal_priv), GFP_KERNEL);
198
hvc_opal_privs[termno] = pv;
199
if (proto == HV_PROTOCOL_HVSI)
200
hvsilib_init(&pv->hvsi, opal_get_chars, opal_put_chars,
203
/* Instanciate now to establish a mapping index==vtermno */
204
hvc_instantiate(termno, termno, ops);
206
pr_err("hvc_opal: Device %s has duplicate terminal number #%d\n",
207
dev->dev.of_node->full_name, termno);
211
pr_info("hvc%d: %s protocol on %s%s\n", termno,
212
proto == HV_PROTOCOL_RAW ? "raw" : "hvsi",
213
dev->dev.of_node->full_name,
214
boot ? " (boot console)" : "");
216
/* We don't do IRQ yet */
217
hp = hvc_alloc(termno, 0, ops, MAX_VIO_PUT_CHARS);
220
dev_set_drvdata(&dev->dev, hp);
225
static int __devexit hvc_opal_remove(struct platform_device *dev)
227
struct hvc_struct *hp = dev_get_drvdata(&dev->dev);
230
termno = hp->vtermno;
233
if (hvc_opal_privs[termno] != &hvc_opal_boot_priv)
234
kfree(hvc_opal_privs[termno]);
235
hvc_opal_privs[termno] = NULL;
240
static struct platform_driver hvc_opal_driver = {
241
.probe = hvc_opal_probe,
242
.remove = __devexit_p(hvc_opal_remove),
244
.name = hvc_opal_name,
245
.owner = THIS_MODULE,
246
.of_match_table = hvc_opal_match,
250
static int __init hvc_opal_init(void)
252
if (!firmware_has_feature(FW_FEATURE_OPAL))
255
/* Register as a vio device to receive callbacks */
256
return platform_driver_register(&hvc_opal_driver);
258
module_init(hvc_opal_init);
260
static void __exit hvc_opal_exit(void)
262
platform_driver_unregister(&hvc_opal_driver);
264
module_exit(hvc_opal_exit);
266
static void udbg_opal_putc(char c)
268
unsigned int termno = hvc_opal_boot_termno;
272
udbg_opal_putc('\r');
275
switch(hvc_opal_boot_priv.proto) {
276
case HV_PROTOCOL_RAW:
277
count = opal_put_chars(termno, &c, 1);
279
case HV_PROTOCOL_HVSI:
280
count = hvc_opal_hvsi_put_chars(termno, &c, 1);
283
} while(count == 0 || count == -EAGAIN);
286
static int udbg_opal_getc_poll(void)
288
unsigned int termno = hvc_opal_boot_termno;
292
switch(hvc_opal_boot_priv.proto) {
293
case HV_PROTOCOL_RAW:
294
rc = opal_get_chars(termno, &c, 1);
296
case HV_PROTOCOL_HVSI:
297
rc = hvc_opal_hvsi_get_chars(termno, &c, 1);
305
static int udbg_opal_getc(void)
309
ch = udbg_opal_getc_poll();
311
/* This shouldn't be needed...but... */
312
volatile unsigned long delay;
313
for (delay=0; delay < 2000000; delay++)
321
static void udbg_init_opal_common(void)
323
udbg_putc = udbg_opal_putc;
324
udbg_getc = udbg_opal_getc;
325
udbg_getc_poll = udbg_opal_getc_poll;
326
tb_ticks_per_usec = 0x200; /* Make udelay not suck */
329
void __init hvc_opal_init_early(void)
331
struct device_node *stdout_node = NULL;
333
const char *name = NULL;
334
const struct hv_ops *ops;
337
/* find the boot console from /chosen/stdout */
339
name = of_get_property(of_chosen, "linux,stdout-path", NULL);
341
stdout_node = of_find_node_by_path(name);
343
pr_err("hvc_opal: Failed to locate default console!\n");
347
struct device_node *opal, *np;
349
/* Current OPAL takeover doesn't provide the stdout
350
* path, so we hard wire it
352
opal = of_find_node_by_path("/ibm,opal/consoles");
354
pr_devel("hvc_opal: Found consoles in new location\n");
356
opal = of_find_node_by_path("/ibm,opal");
358
pr_devel("hvc_opal: "
359
"Found consoles in old location\n");
363
for_each_child_of_node(opal, np) {
364
if (!strcmp(np->name, "serial")) {
373
termno = of_get_property(stdout_node, "reg", NULL);
374
index = termno ? *termno : 0;
375
if (index >= MAX_NR_HVC_CONSOLES)
377
hvc_opal_privs[index] = &hvc_opal_boot_priv;
379
/* Check the protocol */
380
if (of_device_is_compatible(stdout_node, "ibm,opal-console-raw")) {
381
hvc_opal_boot_priv.proto = HV_PROTOCOL_RAW;
382
ops = &hvc_opal_raw_ops;
383
pr_devel("hvc_opal: Found RAW console\n");
385
else if (of_device_is_compatible(stdout_node,"ibm,opal-console-hvsi")) {
386
hvc_opal_boot_priv.proto = HV_PROTOCOL_HVSI;
387
ops = &hvc_opal_hvsi_ops;
388
hvsilib_init(&hvc_opal_boot_priv.hvsi, opal_get_chars,
389
opal_put_chars, index, 1);
390
/* HVSI, perform the handshake now */
391
hvsilib_establish(&hvc_opal_boot_priv.hvsi);
392
pr_devel("hvc_opal: Found HVSI console\n");
395
hvc_opal_boot_termno = index;
396
udbg_init_opal_common();
397
add_preferred_console("hvc", index, NULL);
398
hvc_instantiate(index, index, ops);
400
of_node_put(stdout_node);
403
#ifdef CONFIG_PPC_EARLY_DEBUG_OPAL_RAW
404
void __init udbg_init_debug_opal(void)
406
u32 index = CONFIG_PPC_EARLY_DEBUG_OPAL_VTERMNO;
407
hvc_opal_privs[index] = &hvc_opal_boot_priv;
408
hvc_opal_boot_priv.proto = HV_PROTOCOL_RAW;
409
hvc_opal_boot_termno = index;
410
udbg_init_opal_common();
412
#endif /* CONFIG_PPC_EARLY_DEBUG_OPAL_RAW */
414
#ifdef CONFIG_PPC_EARLY_DEBUG_OPAL_HVSI
415
void __init udbg_init_debug_opal_hvsi(void)
417
u32 index = CONFIG_PPC_EARLY_DEBUG_OPAL_VTERMNO;
418
hvc_opal_privs[index] = &hvc_opal_boot_priv;
419
hvc_opal_boot_termno = index;
420
udbg_init_opal_common();
421
hvsilib_init(&hvc_opal_boot_priv.hvsi, opal_get_chars, opal_put_chars,
423
hvsilib_establish(&hvc_opal_boot_priv.hvsi);
425
#endif /* CONFIG_PPC_EARLY_DEBUG_OPAL_HVSI */