xref: /xnu-11215.81.4/bsd/kern/tty_dev.h (revision d4514f0bc1d3f944c22d92e68b646ac3fb40d452)
1*d4514f0bSApple OSS Distributions /*
2*d4514f0bSApple OSS Distributions  * Copyright (c) 2013 Apple Inc. All rights reserved.
3*d4514f0bSApple OSS Distributions  *
4*d4514f0bSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*d4514f0bSApple OSS Distributions  *
6*d4514f0bSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*d4514f0bSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*d4514f0bSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*d4514f0bSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*d4514f0bSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*d4514f0bSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*d4514f0bSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*d4514f0bSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*d4514f0bSApple OSS Distributions  *
15*d4514f0bSApple OSS Distributions  * Please obtain a copy of the License at
16*d4514f0bSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*d4514f0bSApple OSS Distributions  *
18*d4514f0bSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*d4514f0bSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*d4514f0bSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*d4514f0bSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*d4514f0bSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*d4514f0bSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*d4514f0bSApple OSS Distributions  * limitations under the License.
25*d4514f0bSApple OSS Distributions  *
26*d4514f0bSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*d4514f0bSApple OSS Distributions  */
28*d4514f0bSApple OSS Distributions 
29*d4514f0bSApple OSS Distributions #ifndef __TTY_DEV_H__
30*d4514f0bSApple OSS Distributions #define __TTY_DEV_H__
31*d4514f0bSApple OSS Distributions 
32*d4514f0bSApple OSS Distributions /*
33*d4514f0bSApple OSS Distributions  * ptmx_ioctl is a pointer to a list of pointers to tty structures which is
34*d4514f0bSApple OSS Distributions  * grown, as necessary, copied, and replaced, but never shrunk.  The ioctl
35*d4514f0bSApple OSS Distributions  * structures themselves pointed to from this list come and go as needed.
36*d4514f0bSApple OSS Distributions  */
37*d4514f0bSApple OSS Distributions struct ptmx_ioctl {
38*d4514f0bSApple OSS Distributions 	struct tty      *pt_tty;        /* pointer to ttymalloc()'ed data */
39*d4514f0bSApple OSS Distributions 	int             pt_flags;
40*d4514f0bSApple OSS Distributions 	struct selinfo  pt_selr;
41*d4514f0bSApple OSS Distributions 	struct selinfo  pt_selw;
42*d4514f0bSApple OSS Distributions 	u_char          pt_send;
43*d4514f0bSApple OSS Distributions 	u_char          pt_ucntl;
44*d4514f0bSApple OSS Distributions 	void            *pt_devhandle;  /* cloned replica device handle */
45*d4514f0bSApple OSS Distributions };
46*d4514f0bSApple OSS Distributions 
47*d4514f0bSApple OSS Distributions #define PF_PKT          0x0008          /* packet mode */
48*d4514f0bSApple OSS Distributions #define PF_STOPPED      0x0010          /* user told stopped */
49*d4514f0bSApple OSS Distributions #define PF_NOSTOP       0x0040
50*d4514f0bSApple OSS Distributions #define PF_UCNTL        0x0080          /* user control mode */
51*d4514f0bSApple OSS Distributions #define PF_UNLOCKED     0x0100          /* replica unlock (primary open resets) */
52*d4514f0bSApple OSS Distributions #define PF_OPEN_M       0x0200          /* primary is open */
53*d4514f0bSApple OSS Distributions #define PF_OPEN_S       0x0400          /* replica is open */
54*d4514f0bSApple OSS Distributions 
55*d4514f0bSApple OSS Distributions struct tty_dev_t {
56*d4514f0bSApple OSS Distributions 	int primary;     // primary major device number
57*d4514f0bSApple OSS Distributions 	int replica;     // replica major device number
58*d4514f0bSApple OSS Distributions 	unsigned int    fix_7828447:1,
59*d4514f0bSApple OSS Distributions 	    fix_7070978:1,
60*d4514f0bSApple OSS Distributions 	    mac_notify:1,
61*d4514f0bSApple OSS Distributions 	    open_reset:1,
62*d4514f0bSApple OSS Distributions 	    _reserved:28;
63*d4514f0bSApple OSS Distributions #if __LP64__
64*d4514f0bSApple OSS Distributions 	int _pad;
65*d4514f0bSApple OSS Distributions #endif
66*d4514f0bSApple OSS Distributions 
67*d4514f0bSApple OSS Distributions 	struct tty_dev_t *next;
68*d4514f0bSApple OSS Distributions 
69*d4514f0bSApple OSS Distributions 	struct ptmx_ioctl *(*open)(int minor, int flags);
70*d4514f0bSApple OSS Distributions 	int (*free)(int minor, int flags);
71*d4514f0bSApple OSS Distributions 	int (*name)(int minor, char *buffer, size_t size);
72*d4514f0bSApple OSS Distributions 	void (*revoke)(int minor, struct tty *tp);
73*d4514f0bSApple OSS Distributions };
74*d4514f0bSApple OSS Distributions 
75*d4514f0bSApple OSS Distributions extern void tty_dev_register(struct tty_dev_t *dev);
76*d4514f0bSApple OSS Distributions 
77*d4514f0bSApple OSS Distributions extern int ttnread(struct tty *tp);
78*d4514f0bSApple OSS Distributions 
79*d4514f0bSApple OSS Distributions extern void termios32to64(struct termios32 *in, struct user_termios *out);
80*d4514f0bSApple OSS Distributions extern void termios64to32(struct user_termios *in, struct termios32 *out);
81*d4514f0bSApple OSS Distributions 
82*d4514f0bSApple OSS Distributions #endif // __TTY_DEV_H__
83