blob: 798c48d0d32c1c14ddb8645ef8851ccb5b91508a [file] [log] [blame]
Ryan S. Arnold45d607e2006-03-27 21:25:16 +02001/*
2 * hvc_console.h
3 * Copyright (C) 2005 IBM Corporation
4 *
5 * Author(s):
6 * Ryan S. Arnold <rsa@us.ibm.com>
7 *
8 * hvc_console header information:
Stephen Rothwellb8b572e2008-08-01 15:20:30 +10009 * moved here from arch/powerpc/include/asm/hvconsole.h
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020010 * and drivers/char/hvc_console.c
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 */
26
27#ifndef HVC_CONSOLE_H
28#define HVC_CONSOLE_H
Christian Borntraeger611e0972008-06-20 15:24:08 +020029#include <linux/kref.h>
Hendrik Bruecknerfebde372008-10-14 05:02:09 +000030#include <linux/tty.h>
Hendrik Brueckner254be492009-08-27 01:45:39 +000031#include <linux/spinlock.h>
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020032
33/*
34 * This is the max number of console adapters that can/will be found as
35 * console devices on first stage console init. Any number beyond this range
36 * can't be used as a console device but is still a valid tty device.
37 */
38#define MAX_NR_HVC_CONSOLES 16
39
40/*
41 * The Linux TTY code does not support dynamic addition of tty derived devices
42 * so we need to know how many tty devices we might need when space is allocated
43 * for the tty device. Since this driver supports hotplug of vty adapters we
44 * need to make sure we have enough allocated.
45 */
46#define HVC_ALLOC_TTY_ADAPTERS 8
47
Christian Borntraeger611e0972008-06-20 15:24:08 +020048struct hvc_struct {
Jiri Slabyf3d9f252012-04-02 13:54:21 +020049 struct tty_port port;
Christian Borntraeger611e0972008-06-20 15:24:08 +020050 spinlock_t lock;
51 int index;
Christian Borntraeger611e0972008-06-20 15:24:08 +020052 int do_wakeup;
53 char *outbuf;
54 int outbuf_size;
55 int n_outbuf;
56 uint32_t vtermno;
Rusty Russellb5113062010-01-18 03:44:57 +000057 const struct hv_ops *ops;
Christian Borntraeger611e0972008-06-20 15:24:08 +020058 int irq_requested;
59 int data;
Hendrik Bruecknerfebde372008-10-14 05:02:09 +000060 struct winsize ws;
61 struct work_struct tty_resize;
Christian Borntraeger611e0972008-06-20 15:24:08 +020062 struct list_head next;
Sam Mendoza-Jonasbbc3dfe82016-07-11 13:38:57 +100063 unsigned long flags;
Christian Borntraeger611e0972008-06-20 15:24:08 +020064};
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020065
66/* implemented by a low level driver */
67struct hv_ops {
68 int (*get_chars)(uint32_t vtermno, char *buf, int count);
69 int (*put_chars)(uint32_t vtermno, const char *buf, int count);
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020070
Hendrik Bruecknerfc362e22008-10-13 23:12:48 +000071 /* Callbacks for notification. Called in open, close and hangup */
Christian Borntraeger611e0972008-06-20 15:24:08 +020072 int (*notifier_add)(struct hvc_struct *hp, int irq);
73 void (*notifier_del)(struct hvc_struct *hp, int irq);
Hendrik Bruecknerfc362e22008-10-13 23:12:48 +000074 void (*notifier_hangup)(struct hvc_struct *hp, int irq);
Benjamin Herrenschmidt4d2bb3f2011-05-12 13:46:38 +100075
76 /* tiocmget/set implementation */
77 int (*tiocmget)(struct hvc_struct *hp);
78 int (*tiocmset)(struct hvc_struct *hp, unsigned int set, unsigned int clear);
Hendrik Brueckner33e745a2013-07-02 17:07:14 +020079
80 /* Callbacks to handle tty ports */
81 void (*dtr_rts)(struct hvc_struct *hp, int raise);
Christian Borntraeger611e0972008-06-20 15:24:08 +020082};
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020083
84/* Register a vterm and a slot index for use as a console (console_init) */
Rusty Russellb5113062010-01-18 03:44:57 +000085extern int hvc_instantiate(uint32_t vtermno, int index,
86 const struct hv_ops *ops);
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020087
88/* register a vterm for hvc tty operation (module_init or hotplug add) */
Amit Shah119ea102010-01-18 03:44:58 +000089extern struct hvc_struct * hvc_alloc(uint32_t vtermno, int data,
90 const struct hv_ops *ops, int outbuf_size);
Christian Borntraeger611e0972008-06-20 15:24:08 +020091/* remove a vterm from hvc tty operation (module_exit or hotplug remove) */
Hendrik Brueckner934752d2008-10-13 23:12:52 +000092extern int hvc_remove(struct hvc_struct *hp);
Ryan S. Arnold45d607e2006-03-27 21:25:16 +020093
Christian Borntraeger611e0972008-06-20 15:24:08 +020094/* data available */
95int hvc_poll(struct hvc_struct *hp);
96void hvc_kick(void);
97
Hendrik Bruecknerfebde372008-10-14 05:02:09 +000098/* Resize hvc tty terminal window */
Hendrik Brueckner254be492009-08-27 01:45:39 +000099extern void __hvc_resize(struct hvc_struct *hp, struct winsize ws);
100
101static inline void hvc_resize(struct hvc_struct *hp, struct winsize ws)
102{
103 unsigned long flags;
104
105 spin_lock_irqsave(&hp->lock, flags);
106 __hvc_resize(hp, ws);
107 spin_unlock_irqrestore(&hp->lock, flags);
108}
Hendrik Bruecknerfebde372008-10-14 05:02:09 +0000109
Christian Borntraeger611e0972008-06-20 15:24:08 +0200110/* default notifier for irq based notification */
111extern int notifier_add_irq(struct hvc_struct *hp, int data);
112extern void notifier_del_irq(struct hvc_struct *hp, int data);
Hendrik Bruecknerfc362e22008-10-13 23:12:48 +0000113extern void notifier_hangup_irq(struct hvc_struct *hp, int data);
Christian Borntraeger611e0972008-06-20 15:24:08 +0200114
Michael Ellerman1c8950f2008-05-08 14:27:17 +1000115
116#if defined(CONFIG_XMON) && defined(CONFIG_SMP)
117#include <asm/xmon.h>
118#else
119static inline int cpus_are_in_xmon(void)
120{
121 return 0;
122}
123#endif
124
Ryan S. Arnold45d607e2006-03-27 21:25:16 +0200125#endif // HVC_CONSOLE_H