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