]>
git.saurik.com Git - apple/xnu.git/blob - bsd/kern/tty_compat.c
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
28 /* Copyright (c) 1997 Apple Computer, Inc. All Rights Reserved */
30 * Copyright (c) 1982, 1986, 1991, 1993
31 * The Regents of the University of California. All rights reserved.
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
36 * 1. Redistributions of source code must retain the above copyright
37 * notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce the above copyright
39 * notice, this list of conditions and the following disclaimer in the
40 * documentation and/or other materials provided with the distribution.
41 * 3. All advertising materials mentioning features or use of this software
42 * must display the following acknowledgement:
43 * This product includes software developed by the University of
44 * California, Berkeley and its contributors.
45 * 4. Neither the name of the University nor the names of its contributors
46 * may be used to endorse or promote products derived from this software
47 * without specific prior written permission.
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
61 * @(#)tty_compat.c 8.1 (Berkeley) 6/10/93
65 * Compatibility routines for BSD 4.3 tty ioctl() commands
67 * The only function externalized from this file is ttcompat() and it is
68 * externalized as private extern to prevent exporting of the symbol when
69 * KEXTs link against the kernel.
71 * Locks: All functions in this file assume that the tty_lock()
72 * is held on the tty structure before these functions are
76 #include <sys/param.h>
77 #include <sys/systm.h>
78 #include <sys/ioctl.h>
79 #include <sys/proc_internal.h>
81 #include <sys/termios.h>
82 #include <sys/file_internal.h>
84 #include <sys/kernel.h>
85 #include <sys/sysctl.h>
86 #include <sys/syslog.h>
88 static int ttcompatgetflags(struct tty
*tp
);
89 static void ttcompatsetflags(struct tty
*tp
, struct termios
*t
);
90 static void ttcompatsetlflags(struct tty
*tp
, struct termios
*t
);
91 static int ttcompatspeedtab(int speed
, struct speedtab
*table
);
94 * These two tables encode baud rate to speed code and speed code to
95 * baud rate information. They are a mapping between the <sys/termios.h>
96 * baud rate constants and the <sys/ttydev.h> baud rate constants. We
97 * cannot use those constants directly here because they occupy the same
100 static struct speedtab compatspeeds
[] = {
122 static int compatspcodes
[] = {
123 0, 50, 75, 110, 134, 150, 200, 300, 600, 1200,
124 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200,
130 * Description: Given a baud rate value as an integer, and a speed table,
131 * convert the baud rate to a speed code, according to the
132 * contents of the table. This effectively changes termios.h
133 * baud rate values into ttydev.h baud rate codes.
135 * Parameters: int speed Baud rate, as an integer
136 * struct speedtab *table Baud rate table to speed code table
138 * Returns: 1 B50 speed code; returned if we can
139 * not find an answer in the table.
140 * 0 If a 0 was requested in order to
141 * trigger a hangup (250ms of line
142 * silence, per Bell 103C standard).
143 * * A speed code matching the requested
144 * baud rate (potentially rounded down,
145 * if there is no exact match).
147 * Notes: This function is used for TIOCGETP, TIOCSETP, and TIOCSETN.
150 ttcompatspeedtab(int speed
, struct speedtab
*table
)
153 return (0); /* hangup */
154 for ( ; table
->sp_speed
> 0; table
++)
155 if (table
->sp_speed
<= speed
) /* nearest one, rounded down */
156 return (table
->sp_code
);
157 return (1); /* 50, min and not hangup */
164 * Description: Convert backward compatability set command arguments as
167 * TIOCSETP -> TIOSETAF
168 * TIOCSETN -> TIOCSETA
169 * TIOCSETC -> TIOCSETA
170 * TIOCSLTC -> TIOCSETA
171 * TIOCLBIS -> TIOCSETA
172 * TIOCLBIC -> TIOCSETA
173 * TIOCLSET -> TIOCSETA
175 * The converted command argument and potentially modified 'term'
176 * argument are returned to ttcompat(), which will then call
177 * ttioctl_locked(), if this function returns successfully.
179 * Parameters struct tty *tp The tty on which the operation is
181 * u_long *com A pointer to the terminal input/output
182 * command being requested; its contents
183 * will be modified per the table above,
184 * on a non-error return.
185 * caddr_t data Command specific parameter data; this
186 * data is read but not modified.
187 * struct termios *term A local stack termios structure from
188 * ttcompat(), whose contents are to be
189 * modified based on *com and *data.
191 * Returns: EINVAL An input speed or output speed is
192 * outside the allowable range for a
193 * TIOCSETP or TIOCSETN command.
194 * 0 All other cases return 0.
196 * Notes: This function may modify the contents of the tp->t_flags
197 * field in a successful call to TIOCSETP, TIOCSETN, TIOCLBIS,
198 * TIOCLBIC, or TIOCLSET.
200 * All other tp fields will remain unmodifed, since the struct
201 * termios is a local stack copy from ttcompat(), and not the
202 * real thing. A subsequent call to ttioctl_locked() in
203 * ttcompat(), however, may result in subsequent changes.
205 * WARNING: This compatibility code is not 6/432 clean; it will only
206 * work for 32 bit processes on 32 bit kernels or 64 bit
207 * processes on 64 bit kernels. We are not addressing this
208 * due to <rdar://6904053>.
211 ttsetcompat(struct tty
*tp
, u_long
*com
, caddr_t data
, struct termios
*term
)
216 * Wait for all characters queued for output to drain, then
217 * Discard all characters queued for input, and then set
218 * the input and output speeds and device flags, per the
219 * contents of the struct sgttyb that 'data' points to.
223 * Same as TIOCSETP, but the output is not drained, and any
224 * pending input is not discarded.
227 struct sgttyb
*sg
= (struct sgttyb
*)data
;
230 if ((speed
= sg
->sg_ispeed
) > MAX_SPEED
|| speed
< 0)
232 else if (speed
!= ttcompatspeedtab(tp
->t_ispeed
, compatspeeds
))
233 term
->c_ispeed
= compatspcodes
[speed
];
235 term
->c_ispeed
= tp
->t_ispeed
;
236 if ((speed
= sg
->sg_ospeed
) > MAX_SPEED
|| speed
< 0)
238 else if (speed
!= ttcompatspeedtab(tp
->t_ospeed
, compatspeeds
))
239 term
->c_ospeed
= compatspcodes
[speed
];
241 term
->c_ospeed
= tp
->t_ospeed
;
242 term
->c_cc
[VERASE
] = sg
->sg_erase
;
243 term
->c_cc
[VKILL
] = sg
->sg_kill
;
244 tp
->t_flags
= (tp
->t_flags
&0xffff0000) | (sg
->sg_flags
&0xffff);
245 ttcompatsetflags(tp
, term
);
246 *com
= (*com
== TIOCSETP
) ? TIOCSETAF
: TIOCSETA
;
251 * Set the terminal control characters per the contents of
252 * the struct tchars that 'data' points to.
255 struct tchars
*tc
= (struct tchars
*)data
;
259 cc
[VINTR
] = tc
->t_intrc
;
260 cc
[VQUIT
] = tc
->t_quitc
;
261 cc
[VSTART
] = tc
->t_startc
;
262 cc
[VSTOP
] = tc
->t_stopc
;
263 cc
[VEOF
] = tc
->t_eofc
;
264 cc
[VEOL
] = tc
->t_brkc
;
265 if (tc
->t_brkc
== -1)
266 cc
[VEOL2
] = _POSIX_VDISABLE
;
272 * Set the terminal control characters per the contents of
273 * the struct ltchars that 'data' points to.
276 struct ltchars
*ltc
= (struct ltchars
*)data
;
280 cc
[VSUSP
] = ltc
->t_suspc
;
281 cc
[VDSUSP
] = ltc
->t_dsuspc
;
282 cc
[VREPRINT
] = ltc
->t_rprntc
;
283 cc
[VDISCARD
] = ltc
->t_flushc
;
284 cc
[VWERASE
] = ltc
->t_werasc
;
285 cc
[VLNEXT
] = ltc
->t_lnextc
;
291 * Set the bits in the terminal state local flags word
292 * (16 bits) for the terminal to the current bits OR
293 * those in the 16 bit value pointed to by 'data'.
297 * Clear the bits in the terminal state local flags word
298 * for the terminal to the current bits AND those bits NOT
299 * in the 16 bit value pointed to by 'data'.
303 * Set the terminal state local flags word to exactly those
304 * bits that correspond to the 16 bit value pointed to by
307 if (*com
== TIOCLSET
)
308 tp
->t_flags
= (tp
->t_flags
&0xffff) | *(int *)data
<<16;
311 (ttcompatgetflags(tp
)&0xffff0000)|(tp
->t_flags
&0xffff);
312 if (*com
== TIOCLBIS
)
313 tp
->t_flags
|= *(int *)data
<<16;
315 tp
->t_flags
&= ~(*(int *)data
<<16);
317 ttcompatsetlflags(tp
, term
);
327 * Description: For 'set' commands, convert the command and arguments as
328 * necessary, and call ttioctl_locked(), returning the result
329 * as our result; for 'get' commands, obtain the requested data
330 * from the appropriate source, and return it in the expected
331 * format. If the command is not recognized, return EINVAL.
333 * Parameters struct tty *tp The tty on which the operation is
335 * u_long com The terminal input/output command
337 * caddr_t data The pointer to the user data argument
338 * provided with the command.
339 * int flag The file open flags (e.g. FREAD).
340 * struct proc *p The current process pointer for the
343 * Returns: 0 Most 'get' operations can't fail, and
344 * therefore return this.
345 * ENOTTY TIOCGSID may return this when you
346 * attempt to get the session ID for a
347 * terminal with no associated session,
348 * or for which there is a session, but
350 * ENOTTY If the command cannot be handled at
351 * this layer, this will be returned.
352 * * Any value returned by ttioctl_locked(),
353 * if a set command is requested.
355 * Notes: The process pointer may be a proxy on whose behalf we are
356 * operating, so it is not safe to simply use current_process()
360 __private_extern__
int
361 ttcompat(struct tty
*tp
, u_long com
, caddr_t data
, int flag
, struct proc
*p
)
372 * See ttsetcompat() for a full description of these command
373 * values and their meanings.
379 term
= tp
->t_termios
;
380 if ((error
= ttsetcompat(tp
, &com
, data
, &term
)) != 0)
382 return ttioctl_locked(tp
, com
, (caddr_t
) &term
, flag
, p
);
386 * Get the current input and output speeds, and device
387 * flags, into the structure pointed to by 'data'.
390 struct sgttyb
*sg
= (struct sgttyb
*)data
;
393 sg
->sg_ospeed
= ttcompatspeedtab(tp
->t_ospeed
, compatspeeds
);
394 if (tp
->t_ispeed
== 0)
395 sg
->sg_ispeed
= sg
->sg_ospeed
;
397 sg
->sg_ispeed
= ttcompatspeedtab(tp
->t_ispeed
, compatspeeds
);
398 sg
->sg_erase
= cc
[VERASE
];
399 sg
->sg_kill
= cc
[VKILL
];
400 sg
->sg_flags
= tp
->t_flags
= ttcompatgetflags(tp
);
405 * Get the terminal control characters into the struct
406 * tchars that 'data' points to.
409 struct tchars
*tc
= (struct tchars
*)data
;
412 tc
->t_intrc
= cc
[VINTR
];
413 tc
->t_quitc
= cc
[VQUIT
];
414 tc
->t_startc
= cc
[VSTART
];
415 tc
->t_stopc
= cc
[VSTOP
];
416 tc
->t_eofc
= cc
[VEOF
];
417 tc
->t_brkc
= cc
[VEOL
];
422 * Get the terminal control characters into the struct
423 * ltchars that 'data' points to.
426 struct ltchars
*ltc
= (struct ltchars
*)data
;
429 ltc
->t_suspc
= cc
[VSUSP
];
430 ltc
->t_dsuspc
= cc
[VDSUSP
];
431 ltc
->t_rprntc
= cc
[VREPRINT
];
432 ltc
->t_flushc
= cc
[VDISCARD
];
433 ltc
->t_werasc
= cc
[VWERASE
];
434 ltc
->t_lnextc
= cc
[VLNEXT
];
439 * Get the terminal state local flags word into the 16 bit
440 * value pointed to by 'data'.
443 (ttcompatgetflags(tp
) & 0xffff0000UL
)
444 | (tp
->t_flags
& 0xffff);
445 *(int *)data
= tp
->t_flags
>>16;
450 * Get the current line discipline into the int pointed to
453 *(int *)data
= tp
->t_line
? tp
->t_line
: 2;
458 * Set the current line discipline based on the value of the
459 * int pointed to by 'data'.
464 return (ttioctl_locked(tp
, TIOCSETD
,
465 *(int *)data
== 2 ? (caddr_t
)&ldisczero
: data
, flag
, p
));
470 * Become the console device.
473 return (ttioctl_locked(tp
, TIOCCONS
, data
, flag
, p
));
477 * Get the current session ID (controlling process' PID).
479 if (tp
->t_session
== NULL
)
482 if (tp
->t_session
->s_leader
== NULL
)
485 *(int *) data
= tp
->t_session
->s_leader
->p_pid
;
490 * This ioctl is not handled at this layer.
496 * Successful 'get' operation.
504 * Description: Get the terminal state local flags, device flags, and current
505 * speed code for the device (all 32 bits are returned).
507 * Parameters struct tty *tp The tty on which the operation is
510 * Returns: * Integer value corresponding to the
511 * current terminal state local flags
514 * Notes: Caller is responsible for breaking these bits back out into
515 * separate 16 bit filelds, if that's what was actually desired.
518 ttcompatgetflags(struct tty
*tp
)
520 tcflag_t iflag
= tp
->t_iflag
;
521 tcflag_t lflag
= tp
->t_lflag
;
522 tcflag_t oflag
= tp
->t_oflag
;
523 tcflag_t cflag
= tp
->t_cflag
;
528 if (iflag
&ICRNL
|| oflag
&ONLCR
)
530 if ((cflag
&CSIZE
) == CS8
) {
535 else if (cflag
&PARENB
) {
542 flags
|= EVENP
| ODDP
;
545 if ((lflag
&ICANON
) == 0) {
547 if (iflag
&(INPCK
|ISTRIP
|IXON
) || lflag
&(IEXTEN
|ISIG
)
548 || (cflag
&(CSIZE
|PARENB
)) != CS8
)
553 if (!(flags
&RAW
) && !(oflag
&OPOST
) && (cflag
&(CSIZE
|PARENB
)) == CS8
)
557 if ((cflag
&HUPCL
) == 0)
562 flags
|= CRTERA
|CRTBS
;
564 flags
|= CRTKIL
|CRTBS
;
569 if ((iflag
&IXANY
) == 0)
571 flags
|= lflag
&(ECHO
|TOSTOP
|FLUSHO
|PENDIN
|NOFLSH
);
578 * Description: Given a set of compatability flags, convert the compatability
579 * flags in the terminal flags fields into canonical flags in the
580 * provided termios struct.
582 * Parameters: struct tty *tp The tty on which the operation is
584 * struct termios *t The termios structure into which to
585 * return the converted flags.
587 * Returns: void (implicit: *t, modified)
590 ttcompatsetflags(struct tty
*tp
, struct termios
*t
)
592 int flags
= tp
->t_flags
;
593 tcflag_t iflag
= t
->c_iflag
;
594 tcflag_t oflag
= t
->c_oflag
;
595 tcflag_t lflag
= t
->c_lflag
;
596 tcflag_t cflag
= t
->c_cflag
;
600 lflag
&= ~(ECHOCTL
|ISIG
|ICANON
|IEXTEN
);
602 iflag
&= ~(PARMRK
|IGNPAR
|IGNCR
|INLCR
);
603 iflag
|= BRKINT
|IXON
|IMAXBEL
;
604 lflag
|= ISIG
|IEXTEN
|ECHOCTL
; /* XXX was echoctl on ? */
626 cflag
&= ~(CSIZE
|PARENB
);
627 if (flags
&(RAW
|LITOUT
|PASS8
)) {
629 if (!(flags
&(RAW
|PASS8
))
630 || (flags
&(RAW
|PASS8
|ANYP
)) == (PASS8
|ANYP
))
634 if (flags
&(RAW
|LITOUT
))
643 /* XXX don't set INPCK if RAW or PASS8? */
644 if ((flags
&(EVENP
|ODDP
)) == EVENP
) {
647 } else if ((flags
&(EVENP
|ODDP
)) == ODDP
) {
656 if ((flags
&DECCTQ
) == 0)
669 * Description: Given a set of compatability terminal state local flags,
670 * convert the compatability flags in the terminal flags
671 * fields into canonical flags in the provided termios struct.
673 * Parameters: struct tty *tp The tty on which the operation is
675 * struct termios *t The termios structure into which to
676 * return the converted local flags.
678 * Returns: void (implicit: *t, modified)
681 ttcompatsetlflags(struct tty
*tp
, struct termios
*t
)
683 int flags
= tp
->t_flags
;
684 tcflag_t iflag
= t
->c_iflag
;
685 tcflag_t oflag
= t
->c_oflag
;
686 tcflag_t lflag
= t
->c_lflag
;
687 tcflag_t cflag
= t
->c_cflag
;
689 iflag
&= ~(PARMRK
|IGNPAR
|IGNCR
|INLCR
);
710 if ((flags
&DECCTQ
) == 0)
722 lflag
&= ~(TOSTOP
|FLUSHO
|PENDIN
|NOFLSH
);
723 lflag
|= flags
&(TOSTOP
|FLUSHO
|PENDIN
|NOFLSH
);
726 * The next if-else statement is copied from above so don't bother
727 * checking it separately. We could avoid fiddlling with the
728 * character size if the mode is already RAW or if neither the
729 * LITOUT bit or the PASS8 bit is being changed, but the delta of
730 * the change is not available here and skipping the RAW case would
731 * make the code different from above.
733 cflag
&= ~(CSIZE
|PARENB
);
734 if (flags
&(RAW
|LITOUT
|PASS8
)) {
736 if (!(flags
&(RAW
|PASS8
))
737 || (flags
&(RAW
|PASS8
|ANYP
)) == (PASS8
|ANYP
))
741 if (flags
&(RAW
|LITOUT
))