xref: /xnu-8020.140.41/bsd/kern/tty_dev.h (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1 /*
2  * Copyright (c) 2013 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
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.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
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.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #ifndef __TTY_DEV_H__
30 #define __TTY_DEV_H__
31 
32 /*
33  * ptmx_ioctl is a pointer to a list of pointers to tty structures which is
34  * grown, as necessary, copied, and replaced, but never shrunk.  The ioctl
35  * structures themselves pointed to from this list come and go as needed.
36  */
37 struct ptmx_ioctl {
38 	struct tty      *pt_tty;        /* pointer to ttymalloc()'ed data */
39 	int             pt_flags;
40 	struct selinfo  pt_selr;
41 	struct selinfo  pt_selw;
42 	u_char          pt_send;
43 	u_char          pt_ucntl;
44 	void            *pt_devhandle;  /* cloned replica device handle */
45 };
46 
47 #define PF_PKT          0x0008          /* packet mode */
48 #define PF_STOPPED      0x0010          /* user told stopped */
49 #define PF_NOSTOP       0x0040
50 #define PF_UCNTL        0x0080          /* user control mode */
51 #define PF_UNLOCKED     0x0100          /* replica unlock (primary open resets) */
52 #define PF_OPEN_M       0x0200          /* primary is open */
53 #define PF_OPEN_S       0x0400          /* replica is open */
54 
55 struct tty_dev_t {
56 	int primary;     // primary major device number
57 	int replica;     // replica major device number
58 	unsigned int    fix_7828447:1,
59 	    fix_7070978:1,
60 	    mac_notify:1,
61 	    open_reset:1,
62 	    _reserved:28;
63 #if __LP64__
64 	int _pad;
65 #endif
66 
67 	struct tty_dev_t *next;
68 
69 	struct ptmx_ioctl *(*open)(int minor, int flags);
70 	int (*free)(int minor, int flags);
71 	int (*name)(int minor, char *buffer, size_t size);
72 	void (*revoke)(int minor, struct tty *tp);
73 };
74 
75 extern void tty_dev_register(struct tty_dev_t *dev);
76 
77 extern int ttnread(struct tty *tp);
78 
79 extern void termios32to64(struct termios32 *in, struct user_termios *out);
80 extern void termios64to32(struct user_termios *in, struct termios32 *out);
81 
82 #endif // __TTY_DEV_H__
83