xref: /xnu-11215/osfmk/ipc/ipc_init.h (revision e6231be0)
1 /*
2  * Copyright (c) 2000 Apple Computer, 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  * @OSF_COPYRIGHT@
30  */
31 /*
32  * HISTORY
33  *
34  * Revision 1.1.1.1  1998/09/22 21:05:29  wsanchez
35  * Import of Mac OS X kernel (~semeria)
36  *
37  * Revision 1.1.1.1  1998/03/07 02:26:15  wsanchez
38  * Import of OSF Mach kernel (~mburg)
39  *
40  * Revision 1.1.6.1  1994/09/23  02:07:56  ezf
41  *      change marker to not FREE
42  *      [1994/09/22  21:29:04  ezf]
43  *
44  * Revision 1.1.2.4  1993/07/22  16:16:03  rod
45  *      Add ANSI prototypes.  CR #9523.
46  *      [1993/07/22  13:29:57  rod]
47  *
48  * Revision 1.1.2.3  1993/06/07  22:10:25  jeffc
49  *      CR9176 - ANSI C violations: trailing tokens on CPP
50  *      directives, extra semicolons after decl_ ..., asm keywords
51  *      [1993/06/07  19:01:24  jeffc]
52  *
53  * Revision 1.1.2.2  1993/06/02  23:31:04  jeffc
54  *      Added to OSF/1 R1.3 from NMK15.0.
55  *      [1993/06/02  21:09:31  jeffc]
56  *
57  * Revision 1.1  1992/09/30  02:28:50  robert
58  *      Initial revision
59  *
60  * $EndLog$
61  */
62 /* CMU_HIST */
63 /*
64  * Revision 2.4  91/05/14  16:32:45  mrt
65  *      Correcting copyright
66  *
67  * Revision 2.3  91/02/05  17:21:42  mrt
68  *      Changed to new Mach copyright
69  *      [91/02/01  15:45:16  mrt]
70  *
71  * Revision 2.2  90/06/02  14:49:59  rpd
72  *      Created for new IPC.
73  *      [90/03/26  20:55:26  rpd]
74  *
75  */
76 /* CMU_ENDHIST */
77 /*
78  * Mach Operating System
79  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
80  * All Rights Reserved.
81  *
82  * Permission to use, copy, modify and distribute this software and its
83  * documentation is hereby granted, provided that both the copyright
84  * notice and this permission notice appear in all copies of the
85  * software, derivative works or modified versions, and any portions
86  * thereof, and that both notices appear in supporting documentation.
87  *
88  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
89  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
90  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
91  *
92  * Carnegie Mellon requests users of this software to return to
93  *
94  *  Software Distribution Coordinator  or  [email protected]
95  *  School of Computer Science
96  *  Carnegie Mellon University
97  *  Pittsburgh PA 15213-3890
98  *
99  * any improvements or extensions that they make and grant Carnegie Mellon
100  * the rights to redistribute these changes.
101  */
102 /*
103  */
104 /*
105  *	File:	ipc/ipc_init.h
106  *	Author:	Rich Draves
107  *	Date:	1989
108  *
109  *	Declarations of functions to initialize the IPC system.
110  */
111 
112 #ifndef _IPC_IPC_INIT_H_
113 #define _IPC_IPC_INIT_H_
114 
115 /* These boot-args decide whether control port is immovable and/or pinned */
116 __options_decl(ipc_control_port_options_t, uint32_t, {
117 	ICP_OPTIONS_NONE         = 0x00,
118 
119 	/* Must be in the same order as task_control_port_options_t (mach/task_info.h) */
120 	ICP_OPTIONS_PINNED_1P_SOFT       = 0x01,
121 	ICP_OPTIONS_PINNED_1P_HARD       = 0x02,
122 	ICP_OPTIONS_IMMOVABLE_1P_SOFT    = 0x04,
123 	ICP_OPTIONS_IMMOVABLE_1P_HARD    = 0x08,
124 
125 	ICP_OPTIONS_PINNED_3P_SOFT       = 0x10,
126 	ICP_OPTIONS_PINNED_3P_HARD       = 0x20,
127 	ICP_OPTIONS_IMMOVABLE_3P_SOFT    = 0x40,
128 	ICP_OPTIONS_IMMOVABLE_3P_HARD    = 0x80,
129 
130 	ICP_OPTIONS_PINNED_ALL_HARD      = ICP_OPTIONS_PINNED_1P_HARD | ICP_OPTIONS_PINNED_3P_HARD,
131 	ICP_OPTIONS_PINNED_ALL_SOFT      = ICP_OPTIONS_PINNED_1P_SOFT | ICP_OPTIONS_PINNED_3P_SOFT,
132 
133 	ICP_OPTIONS_IMMOVABLE_ALL_HARD   = ICP_OPTIONS_IMMOVABLE_1P_HARD | ICP_OPTIONS_IMMOVABLE_3P_HARD,
134 	ICP_OPTIONS_IMMOVABLE_ALL_SOFT   = ICP_OPTIONS_IMMOVABLE_1P_SOFT | ICP_OPTIONS_IMMOVABLE_3P_SOFT,
135 });
136 
137 #define ICP_OPTIONS_1P_MASK (ICP_OPTIONS_PINNED_1P_HARD |     \
138 	ICP_OPTIONS_PINNED_1P_SOFT |     \
139 	ICP_OPTIONS_IMMOVABLE_1P_HARD |  \
140 	ICP_OPTIONS_IMMOVABLE_1P_SOFT)
141 
142 #define ICP_OPTIONS_1P_PINNED (ICP_OPTIONS_PINNED_1P_HARD | ICP_OPTIONS_PINNED_1P_SOFT)
143 #define ICP_OPTIONS_1P_IMMOVABLE (ICP_OPTIONS_IMMOVABLE_1P_HARD | ICP_OPTIONS_IMMOVABLE_1P_SOFT)
144 
145 #define ICP_OPTIONS_3P_MASK (ICP_OPTIONS_PINNED_3P_HARD |     \
146 	ICP_OPTIONS_PINNED_3P_SOFT |     \
147 	ICP_OPTIONS_IMMOVABLE_3P_HARD |  \
148 	ICP_OPTIONS_IMMOVABLE_3P_SOFT)
149 
150 #define ICP_OPTIONS_3P_PINNED (ICP_OPTIONS_PINNED_3P_HARD | ICP_OPTIONS_PINNED_3P_SOFT)
151 #define ICP_OPTIONS_3P_IMMOVABLE (ICP_OPTIONS_IMMOVABLE_3P_HARD | ICP_OPTIONS_IMMOVABLE_3P_SOFT)
152 
153 #define ICP_OPTIONS_3P_SHIFT 4
154 
155 #endif  /* _IPC_IPC_INIT_H_ */
156