tty_conf.c revision 1.42.2.7
1 /* $NetBSD: tty_conf.c,v 1.42.2.7 2005/12/11 10:29:12 christos Exp $ */ 2 3 /*- 4 * Copyright (c) 2005 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 /*- 40 * Copyright (c) 1982, 1986, 1991, 1993 41 * The Regents of the University of California. All rights reserved. 42 * (c) UNIX System Laboratories, Inc. 43 * All or some portions of this file are derived from material licensed 44 * to the University of California by American Telephone and Telegraph 45 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 46 * the permission of UNIX System Laboratories, Inc. 47 * 48 * Redistribution and use in source and binary forms, with or without 49 * modification, are permitted provided that the following conditions 50 * are met: 51 * 1. Redistributions of source code must retain the above copyright 52 * notice, this list of conditions and the following disclaimer. 53 * 2. Redistributions in binary form must reproduce the above copyright 54 * notice, this list of conditions and the following disclaimer in the 55 * documentation and/or other materials provided with the distribution. 56 * 3. Neither the name of the University nor the names of its contributors 57 * may be used to endorse or promote products derived from this software 58 * without specific prior written permission. 59 * 60 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 61 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 62 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 63 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 64 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 65 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 66 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 67 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 68 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 69 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 70 * SUCH DAMAGE. 71 * 72 * @(#)tty_conf.c 8.5 (Berkeley) 1/9/95 73 */ 74 75 #include <sys/cdefs.h> 76 __KERNEL_RCSID(0, "$NetBSD: tty_conf.c,v 1.42.2.7 2005/12/11 10:29:12 christos Exp $"); 77 78 #include <sys/param.h> 79 #include <sys/systm.h> 80 #include <sys/poll.h> 81 #include <sys/proc.h> 82 #include <sys/tty.h> 83 #include <sys/ttycom.h> 84 #include <sys/conf.h> 85 #include <sys/once.h> 86 #include <sys/lock.h> 87 #include <sys/queue.h> 88 89 static struct linesw termios_disc = { 90 .l_name = "termios", 91 .l_open = ttylopen, 92 .l_close = ttylclose, 93 .l_read = ttread, 94 .l_write = ttwrite, 95 .l_ioctl = ttynullioctl, 96 .l_rint = ttyinput, 97 .l_start = ttstart, 98 .l_modem = ttymodem, 99 .l_poll = ttpoll 100 }; 101 102 /* 103 * This is for the benefit of old BSD TTY compatbility, but since it is 104 * identical to termios (except for the name), don't bother conditionalizing 105 * it. 106 */ 107 static struct linesw ntty_disc = { /* old NTTYDISC */ 108 .l_name = "ntty", 109 .l_open = ttylopen, 110 .l_close = ttylclose, 111 .l_read = ttread, 112 .l_write = ttwrite, 113 .l_ioctl = ttynullioctl, 114 .l_rint = ttyinput, 115 .l_start = ttstart, 116 .l_modem = ttymodem, 117 .l_poll = ttpoll 118 }; 119 120 static LIST_HEAD(, linesw) ttyldisc_list = LIST_HEAD_INITIALIZER(ttyldisc_head); 121 static struct simplelock ttyldisc_list_slock = SIMPLELOCK_INITIALIZER; 122 123 /* 124 * Note: We don't bother refcounting termios_disc and ntty_disc; they can't 125 * be removed from the list, and termios_disc is likely to have very many 126 * references (could we overflow the count?). 127 */ 128 #define TTYLDISC_ISSTATIC(disc) \ 129 ((disc) == &termios_disc || (disc) == &ntty_disc) 130 131 #define TTYLDISC_HOLD(disc) \ 132 do { \ 133 if (! TTYLDISC_ISSTATIC(disc)) { \ 134 KASSERT((disc)->l_refcnt != UINT_MAX); \ 135 (disc)->l_refcnt++; \ 136 } \ 137 } while (/*CONSTCOND*/0) 138 139 #define TTYLDISC_RELE(disc) \ 140 do { \ 141 if (! TTYLDISC_ISSTATIC(disc)) { \ 142 KASSERT((disc)->l_refcnt != 0); \ 143 (disc)->l_refcnt--; \ 144 } \ 145 } while (/*CONSTCOND*/0) 146 147 #define TTYLDISC_ISINUSE(disc) \ 148 (TTYLDISC_ISSTATIC(disc) || (disc)->l_refcnt != 0) 149 150 /* 151 * Do nothing specific version of line 152 * discipline specific ioctl command. 153 */ 154 /*ARGSUSED*/ 155 int 156 ttynullioctl(struct tty *tp, u_long cmd, char *data, int flags, struct lwp *l) 157 { 158 159 #ifdef lint 160 tp = tp; data = data; flags = flags; l = l; 161 #endif 162 return (EPASSTHROUGH); 163 } 164 165 /* 166 * Return error to line discipline 167 * specific poll call. 168 */ 169 /*ARGSUSED*/ 170 int 171 ttyerrpoll(struct tty *tp, int events, struct lwp *l) 172 { 173 174 #ifdef lint 175 tp = tp; events = events; l = l; 176 #endif 177 return (POLLERR); 178 } 179 180 static ONCE_DECL(ttyldisc_init_once); 181 182 static void 183 ttyldisc_init(void) 184 { 185 186 if (ttyldisc_attach(&termios_disc) != 0) 187 panic("ttyldisc_init: termios_disc"); 188 if (ttyldisc_attach(&ntty_disc) != 0) 189 panic("ttyldisc_init: ntty_disc"); 190 } 191 192 static struct linesw * 193 ttyldisc_lookup_locked(const char *name) 194 { 195 struct linesw *disc; 196 197 LIST_FOREACH(disc, &ttyldisc_list, l_list) { 198 if (strcmp(name, disc->l_name) == 0) 199 return (disc); 200 } 201 202 return (NULL); 203 } 204 205 /* 206 * Look up a line discipline by its name. Caller holds a reference on 207 * the returned line discipline. 208 */ 209 struct linesw * 210 ttyldisc_lookup(const char *name) 211 { 212 struct linesw *disc; 213 214 RUN_ONCE(&ttyldisc_init_once, ttyldisc_init); 215 216 simple_lock(&ttyldisc_list_slock); 217 disc = ttyldisc_lookup_locked(name); 218 if (disc != NULL) 219 TTYLDISC_HOLD(disc); 220 simple_unlock(&ttyldisc_list_slock); 221 222 return (disc); 223 } 224 225 /* 226 * Look up a line discipline by its legacy number. Caller holds a 227 * reference on the returned line discipline. 228 */ 229 struct linesw * 230 ttyldisc_lookup_bynum(int num) 231 { 232 struct linesw *disc; 233 234 RUN_ONCE(&ttyldisc_init_once, ttyldisc_init); 235 236 simple_lock(&ttyldisc_list_slock); 237 238 LIST_FOREACH(disc, &ttyldisc_list, l_list) { 239 if (disc->l_no == num) { 240 TTYLDISC_HOLD(disc); 241 simple_unlock(&ttyldisc_list_slock); 242 return (disc); 243 } 244 } 245 246 simple_unlock(&ttyldisc_list_slock); 247 return (NULL); 248 } 249 250 /* 251 * Release a reference on a line discipline previously added by 252 * ttyldisc_lookup() or ttyldisc_lookup_bynum(). 253 */ 254 void 255 ttyldisc_release(struct linesw *disc) 256 { 257 258 if (disc == NULL) 259 return; 260 261 simple_lock(&ttyldisc_list_slock); 262 TTYLDISC_RELE(disc); 263 simple_unlock(&ttyldisc_list_slock); 264 } 265 266 #define TTYLDISC_LEGACY_NUMBER_MIN 10 267 #define TTYLDISC_LEGACY_NUMBER_MAX INT_MAX 268 269 static void 270 ttyldisc_assign_legacy_number(struct linesw *disc) 271 { 272 static const struct { 273 const char *name; 274 int num; 275 } table[] = { 276 { "termios", TTYDISC }, 277 { "ntty", 2 /* XXX old NTTYDISC */ }, 278 { "tablet", TABLDISC }, 279 { "slip", SLIPDISC }, 280 { "ppp", PPPDISC }, 281 { "strip", STRIPDISC }, 282 { "hdlc", HDLCDISC }, 283 { NULL, 0 } 284 }; 285 struct linesw *ldisc; 286 int i; 287 288 for (i = 0; table[i].name != NULL; i++) { 289 if (strcmp(disc->l_name, table[i].name) == 0) { 290 disc->l_no = table[i].num; 291 return; 292 } 293 } 294 295 disc->l_no = TTYLDISC_LEGACY_NUMBER_MIN; 296 297 LIST_FOREACH(ldisc, &ttyldisc_list, l_list) { 298 if (disc->l_no == ldisc->l_no) { 299 KASSERT(disc->l_no < TTYLDISC_LEGACY_NUMBER_MAX); 300 disc->l_no++; 301 } 302 } 303 } 304 305 /* 306 * Register a line discipline. 307 */ 308 int 309 ttyldisc_attach(struct linesw *disc) 310 { 311 312 KASSERT(disc->l_name != NULL); 313 KASSERT(disc->l_open != NULL); 314 KASSERT(disc->l_close != NULL); 315 KASSERT(disc->l_read != NULL); 316 KASSERT(disc->l_write != NULL); 317 KASSERT(disc->l_ioctl != NULL); 318 KASSERT(disc->l_rint != NULL); 319 KASSERT(disc->l_start != NULL); 320 KASSERT(disc->l_modem != NULL); 321 KASSERT(disc->l_poll != NULL); 322 323 /* You are not allowed to exceed TTLINEDNAMELEN */ 324 if (strlen(disc->l_name) >= TTLINEDNAMELEN) 325 return (ENAMETOOLONG); 326 327 simple_lock(&ttyldisc_list_slock); 328 329 if (ttyldisc_lookup_locked(disc->l_name) != NULL) { 330 simple_unlock(&ttyldisc_list_slock); 331 return (EEXIST); 332 } 333 334 ttyldisc_assign_legacy_number(disc); 335 LIST_INSERT_HEAD(&ttyldisc_list, disc, l_list); 336 337 simple_unlock(&ttyldisc_list_slock); 338 339 return (0); 340 } 341 342 /* 343 * Remove a line discipline. 344 */ 345 int 346 ttyldisc_detach(struct linesw *disc) 347 { 348 #ifdef DIAGNOSTIC 349 struct linesw *ldisc = ttyldisc_lookup(disc->l_name); 350 351 KASSERT(ldisc != NULL); 352 KASSERT(ldisc == disc); 353 ttyldisc_release(ldisc); 354 #endif 355 356 simple_lock(&ttyldisc_list_slock); 357 358 if (TTYLDISC_ISINUSE(disc)) { 359 simple_unlock(&ttyldisc_list_slock); 360 return (EBUSY); 361 } 362 363 LIST_REMOVE(disc, l_list); 364 365 simple_unlock(&ttyldisc_list_slock); 366 367 return (0); 368 } 369 370 /* 371 * Return the default line discipline. 372 */ 373 struct linesw * 374 ttyldisc_default(void) 375 { 376 377 return (&termios_disc); 378 } 379
Indexes created Sun Sep 21 16:09:51 GMT 2025