Ryan S. Arnold | 45d607e | 2006-03-27 21:25:16 +0200 | [diff] [blame] | 1 | /* |
| 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 Rothwell | b8b572e | 2008-08-01 15:20:30 +1000 | [diff] [blame] | 9 | * moved here from arch/powerpc/include/asm/hvconsole.h |
Ryan S. Arnold | 45d607e | 2006-03-27 21:25:16 +0200 | [diff] [blame] | 10 | * 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 Borntraeger | 611e097 | 2008-06-20 15:24:08 +0200 | [diff] [blame] | 29 | #include <linux/kref.h> |
Ryan S. Arnold | 45d607e | 2006-03-27 21:25:16 +0200 | [diff] [blame] | 30 | |
| 31 | /* |
| 32 | * This is the max number of console adapters that can/will be found as |
| 33 | * console devices on first stage console init. Any number beyond this range |
| 34 | * can't be used as a console device but is still a valid tty device. |
| 35 | */ |
| 36 | #define MAX_NR_HVC_CONSOLES 16 |
| 37 | |
| 38 | /* |
| 39 | * The Linux TTY code does not support dynamic addition of tty derived devices |
| 40 | * so we need to know how many tty devices we might need when space is allocated |
| 41 | * for the tty device. Since this driver supports hotplug of vty adapters we |
| 42 | * need to make sure we have enough allocated. |
| 43 | */ |
| 44 | #define HVC_ALLOC_TTY_ADAPTERS 8 |
| 45 | |
Christian Borntraeger | 611e097 | 2008-06-20 15:24:08 +0200 | [diff] [blame] | 46 | struct hvc_struct { |
| 47 | spinlock_t lock; |
| 48 | int index; |
| 49 | struct tty_struct *tty; |
| 50 | unsigned int count; |
| 51 | int do_wakeup; |
| 52 | char *outbuf; |
| 53 | int outbuf_size; |
| 54 | int n_outbuf; |
| 55 | uint32_t vtermno; |
| 56 | struct hv_ops *ops; |
| 57 | int irq_requested; |
| 58 | int data; |
| 59 | struct list_head next; |
| 60 | struct kref kref; /* ref count & hvc_struct lifetime */ |
| 61 | }; |
Ryan S. Arnold | 45d607e | 2006-03-27 21:25:16 +0200 | [diff] [blame] | 62 | |
| 63 | /* implemented by a low level driver */ |
| 64 | struct hv_ops { |
| 65 | int (*get_chars)(uint32_t vtermno, char *buf, int count); |
| 66 | int (*put_chars)(uint32_t vtermno, const char *buf, int count); |
Ryan S. Arnold | 45d607e | 2006-03-27 21:25:16 +0200 | [diff] [blame] | 67 | |
Hendrik Brueckner | fc362e2 | 2008-10-13 23:12:48 +0000 | [diff] [blame^] | 68 | /* Callbacks for notification. Called in open, close and hangup */ |
Christian Borntraeger | 611e097 | 2008-06-20 15:24:08 +0200 | [diff] [blame] | 69 | int (*notifier_add)(struct hvc_struct *hp, int irq); |
| 70 | void (*notifier_del)(struct hvc_struct *hp, int irq); |
Hendrik Brueckner | fc362e2 | 2008-10-13 23:12:48 +0000 | [diff] [blame^] | 71 | void (*notifier_hangup)(struct hvc_struct *hp, int irq); |
Christian Borntraeger | 611e097 | 2008-06-20 15:24:08 +0200 | [diff] [blame] | 72 | }; |
Ryan S. Arnold | 45d607e | 2006-03-27 21:25:16 +0200 | [diff] [blame] | 73 | |
| 74 | /* Register a vterm and a slot index for use as a console (console_init) */ |
| 75 | extern int hvc_instantiate(uint32_t vtermno, int index, struct hv_ops *ops); |
| 76 | |
| 77 | /* register a vterm for hvc tty operation (module_init or hotplug add) */ |
Christian Borntraeger | 611e097 | 2008-06-20 15:24:08 +0200 | [diff] [blame] | 78 | extern struct hvc_struct * __devinit hvc_alloc(uint32_t vtermno, int data, |
Stephen Rothwell | 4e9e95a | 2006-07-13 18:53:32 +1000 | [diff] [blame] | 79 | struct hv_ops *ops, int outbuf_size); |
Christian Borntraeger | 611e097 | 2008-06-20 15:24:08 +0200 | [diff] [blame] | 80 | /* remove a vterm from hvc tty operation (module_exit or hotplug remove) */ |
Ryan S. Arnold | 45d607e | 2006-03-27 21:25:16 +0200 | [diff] [blame] | 81 | extern int __devexit hvc_remove(struct hvc_struct *hp); |
| 82 | |
Christian Borntraeger | 611e097 | 2008-06-20 15:24:08 +0200 | [diff] [blame] | 83 | /* data available */ |
| 84 | int hvc_poll(struct hvc_struct *hp); |
| 85 | void hvc_kick(void); |
| 86 | |
| 87 | /* default notifier for irq based notification */ |
| 88 | extern int notifier_add_irq(struct hvc_struct *hp, int data); |
| 89 | extern void notifier_del_irq(struct hvc_struct *hp, int data); |
Hendrik Brueckner | fc362e2 | 2008-10-13 23:12:48 +0000 | [diff] [blame^] | 90 | extern void notifier_hangup_irq(struct hvc_struct *hp, int data); |
Christian Borntraeger | 611e097 | 2008-06-20 15:24:08 +0200 | [diff] [blame] | 91 | |
Michael Ellerman | 1c8950f | 2008-05-08 14:27:17 +1000 | [diff] [blame] | 92 | |
| 93 | #if defined(CONFIG_XMON) && defined(CONFIG_SMP) |
| 94 | #include <asm/xmon.h> |
| 95 | #else |
| 96 | static inline int cpus_are_in_xmon(void) |
| 97 | { |
| 98 | return 0; |
| 99 | } |
| 100 | #endif |
| 101 | |
Ryan S. Arnold | 45d607e | 2006-03-27 21:25:16 +0200 | [diff] [blame] | 102 | #endif // HVC_CONSOLE_H |