1 // SPDX-License-Identifier: GPL-2.0+
4 * Copyright (C) 2005 IBM Corporation
7 * Ryan S. Arnold <rsa@us.ibm.com>
9 * hvc_console header information:
10 * moved here from arch/powerpc/include/asm/hvconsole.h
11 * and drivers/char/hvc_console.c
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include <linux/kref.h>
31 #include <linux/tty.h>
32 #include <linux/spinlock.h>
35 * This is the max number of console adapters that can/will be found as
36 * console devices on first stage console init. Any number beyond this range
37 * can't be used as a console device but is still a valid tty device.
39 #define MAX_NR_HVC_CONSOLES 16
42 * The Linux TTY code does not support dynamic addition of tty derived devices
43 * so we need to know how many tty devices we might need when space is allocated
44 * for the tty device. Since this driver supports hotplug of vty adapters we
45 * need to make sure we have enough allocated.
47 #define HVC_ALLOC_TTY_ADAPTERS 8
58 const struct hv_ops *ops;
62 struct work_struct tty_resize;
63 struct list_head next;
67 /* implemented by a low level driver */
69 int (*get_chars)(uint32_t vtermno, char *buf, int count);
70 int (*put_chars)(uint32_t vtermno, const char *buf, int count);
72 /* Callbacks for notification. Called in open, close and hangup */
73 int (*notifier_add)(struct hvc_struct *hp, int irq);
74 void (*notifier_del)(struct hvc_struct *hp, int irq);
75 void (*notifier_hangup)(struct hvc_struct *hp, int irq);
77 /* tiocmget/set implementation */
78 int (*tiocmget)(struct hvc_struct *hp);
79 int (*tiocmset)(struct hvc_struct *hp, unsigned int set, unsigned int clear);
81 /* Callbacks to handle tty ports */
82 void (*dtr_rts)(struct hvc_struct *hp, int raise);
85 /* Register a vterm and a slot index for use as a console (console_init) */
86 extern int hvc_instantiate(uint32_t vtermno, int index,
87 const struct hv_ops *ops);
89 /* register a vterm for hvc tty operation (module_init or hotplug add) */
90 extern struct hvc_struct * hvc_alloc(uint32_t vtermno, int data,
91 const struct hv_ops *ops, int outbuf_size);
92 /* remove a vterm from hvc tty operation (module_exit or hotplug remove) */
93 extern int hvc_remove(struct hvc_struct *hp);
96 int hvc_poll(struct hvc_struct *hp);
99 /* Resize hvc tty terminal window */
100 extern void __hvc_resize(struct hvc_struct *hp, struct winsize ws);
102 static inline void hvc_resize(struct hvc_struct *hp, struct winsize ws)
106 spin_lock_irqsave(&hp->lock, flags);
107 __hvc_resize(hp, ws);
108 spin_unlock_irqrestore(&hp->lock, flags);
111 /* default notifier for irq based notification */
112 extern int notifier_add_irq(struct hvc_struct *hp, int data);
113 extern void notifier_del_irq(struct hvc_struct *hp, int data);
114 extern void notifier_hangup_irq(struct hvc_struct *hp, int data);
117 #if defined(CONFIG_XMON) && defined(CONFIG_SMP)
118 #include <asm/xmon.h>
120 static inline int cpus_are_in_xmon(void)
126 #endif // HVC_CONSOLE_H