1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _SYS_CONSDEV_H 28 #define _SYS_CONSDEV_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 #include <sys/isa_defs.h> 33 #include <sys/dditypes.h> 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 40 #if defined(_KERNEL) || defined(_KMDB) 41 42 /* 43 * Paths to console devices 44 */ 45 #define CONSKBD_PATH "/pseudo/conskbd@0:conskbd" 46 #define CONSMS_PATH "/pseudo/consms@0:mouse" 47 #define WC_PATH "/pseudo/wc@0:wscons" 48 #define IWSCN_PATH "/pseudo/iwscn@0:iwscn" 49 #define CVC_PATH "/pseudo/cvc@0:cvc" 50 51 /* 52 * Console redirection. 53 */ 54 extern dev_t rconsdev; /* real (underlying) console */ 55 extern struct vnode *rconsvp; /* pointer to vnode for that device */ 56 57 /* 58 * Mouse, keyboard, and frame buffer configuration information. 59 * 60 * XXX: Assumes a single mouse/keyboard/frame buffer triple. 61 */ 62 extern dev_t mousedev; /* default mouse device */ 63 extern dev_t kbddev; /* default (actual) keyboard device */ 64 extern dev_t stdindev; /* default standard input device */ 65 extern dev_t fbdev; /* default framebuffer device */ 66 extern struct vnode *fbvp; /* pointer to vnode for that device */ 67 extern dev_info_t *fbdip; /* pointer to dev_info for fbdev (optional) */ 68 69 extern int consmode; /* CONS_FW or CONS_KFB */ 70 extern int cons_tem_disable; 71 #define CONS_FW 0 72 #define CONS_KFB 1 73 74 /* 75 * Workstation console redirection. 76 * 77 * The workstation console device is the multiplexor that hooks keyboard and 78 * frame buffer together into a single tty-like device. Access to it is 79 * through the redirecting driver, so that frame buffer output can be 80 * redirected to other devices. wsconsvp names the redirecting access point, 81 * and rwsconsvp names the workstation console itself. 82 * 83 * XXX: Assumes a single workstation console. 84 */ 85 extern struct vnode *wsconsvp; /* vnode for redirecting ws cons access */ 86 extern struct vnode *rwsconsvp; /* vnode for underlying workstation console */ 87 88 /* 89 * Generic console ioctls. 90 * 91 * On systems without OBP, all potential console devices should implement these. 92 * 93 * On systems with OBP, all potential console devices should implement 94 * the ABORTENABLE ioctls. All potential console devices that cannot share 95 * their hardware with OBP should implement the POLLEDIO ioctls. 96 */ 97 #define _CONSIOC (('C'<<24)|('O'<<16)|('N'<<8)) 98 99 /* 100 * Get the structure of function pointers to be used for polled I/O 101 * 102 * struct cons_polledio *polledio; 103 * struct strioctl str; 104 * 105 * str.ic_cmd = CONS_OPENPOLLEDIO; 106 * str.ic_timout = INFTIM; 107 * str.ic_len = sizeof (polledio); 108 * str.ic_dp = (char *)&polledio; 109 * ioctl(fd, I_STR, &str); 110 */ 111 #define CONSOPENPOLLEDIO (_CONSIOC|0) 112 113 /* 114 * Get the current state of abort enable 115 * enable = ioctl(fd, CONSGETABORTENABLE, 0) 116 */ 117 #define CONSGETABORTENABLE (_CONSIOC|1) 118 119 /* 120 * Set the current state of abort enable 121 * ioctl(fd, CONSSETABORTENABLE, boolean_t) 122 */ 123 #define CONSSETABORTENABLE (_CONSIOC|2) 124 125 /* 126 * Undo anything that was done with CONSOPENPOLLEDIO 127 * ioctl(fd, CONSCLOSEPOLLEDIO, 0) 128 */ 129 #define CONSCLOSEPOLLEDIO (_CONSIOC|3) 130 131 /* 132 * Set the type simulated by hardwares 133 * ioctl(fd, CONSSETKBDTYPE, kbdtype) 134 * kbdtype: 135 * KB_PC or KB_USB 136 */ 137 #define CONSSETKBDTYPE (_CONSIOC|4) 138 139 #define CONSPOLLEDIO_V0 0 140 #define CONSPOLLEDIO_V1 1 141 142 typedef int kbtrans_key_t; 143 144 enum keystate { KEY_PRESSED = 0, KEY_RELEASED = 1 }; 145 146 147 /* 148 * Opaque state structure for driver state. Each driver has its own 149 * implementation (with different names!), and casts to/from this. 150 * This allows better type-checking than "void *", helping to ensure 151 * that the structure passed in is the structure used in the callback. 152 */ 153 typedef struct __cons_polledio_arg *cons_polledio_arg_t; 154 155 /* 156 * This is the structure that is used to handle polled I/O. It is filled 157 * in by a lower driver, passed up, and eventually registered with the 158 * debugger that needs to do polled I/O. 159 */ 160 typedef struct cons_polledio { 161 162 /* 163 * version of this structure 164 */ 165 unsigned cons_polledio_version; 166 167 /* 168 * Argument that is passed to the following routines. 169 */ 170 cons_polledio_arg_t cons_polledio_argument; 171 172 /* 173 * Pointer to the routine and its argument that handles putting 174 * characters out to the polled device. 175 */ 176 void (*cons_polledio_putchar)(cons_polledio_arg_t, 177 uchar_t); 178 179 /* 180 * Pointer to the routine and its argument that handles getting 181 * characters from the polled device. This routine is blocking. 182 */ 183 int (*cons_polledio_getchar)(cons_polledio_arg_t); 184 185 /* 186 * Pointer to the routine and its argument that checks to see 187 * if a character is pending input. This routine is non-blocking. 188 */ 189 boolean_t (*cons_polledio_ischar)(cons_polledio_arg_t); 190 191 /* 192 * Initialize the polled subsystem. This routine is called once 193 * per mode change from non-polled to polled mode. 194 */ 195 void (*cons_polledio_enter)(cons_polledio_arg_t); 196 197 /* 198 * Restore the non-polled subsystem. This routine is called once 199 * per mode change from non-polled to polled mode. 200 */ 201 void (*cons_polledio_exit)(cons_polledio_arg_t); 202 203 204 /* Routine to set the LED's in polled mode */ 205 void (*cons_polledio_setled)(cons_polledio_arg_t, int); 206 207 /* Routine to indicate that a scande is available in polled mode */ 208 boolean_t (*cons_polledio_keycheck)( 209 cons_polledio_arg_t, 210 kbtrans_key_t *, enum keystate *); 211 } cons_polledio_t; 212 213 extern cons_polledio_t *cons_polledio; 214 215 /* 216 * Workstation Console 217 */ 218 #define _WCIOC (('W'<<24)|('C'<<16)) 219 #define WC_OPEN_FB (_WCIOC | 0) 220 #define WC_CLOSE_FB (_WCIOC | 1) 221 222 #endif /* _KERNEL || _KMDB */ 223 224 #ifdef __cplusplus 225 } 226 #endif 227 228 #endif /* _SYS_CONSDEV_H */ 229