xref: /xnu-8019.80.24/osfmk/kern/ipc_host.h (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1 /*
2  * Copyright (c) 2000-2007 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  * Mach Operating System
33  * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
34  * All Rights Reserved.
35  *
36  * Permission to use, copy, modify and distribute this software and its
37  * documentation is hereby granted, provided that both the copyright
38  * notice and this permission notice appear in all copies of the
39  * software, derivative works or modified versions, and any portions
40  * thereof, and that both notices appear in supporting documentation.
41  *
42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45  *
46  * Carnegie Mellon requests users of this software to return to
47  *
48  *  Software Distribution Coordinator  or  [email protected]
49  *  School of Computer Science
50  *  Carnegie Mellon University
51  *  Pittsburgh PA 15213-3890
52  *
53  * any improvements or extensions that they make and grant Carnegie Mellon
54  * the rights to redistribute these changes.
55  */
56 /*
57  */
58 
59 #ifndef _KERN_IPC_HOST_H_
60 #define _KERN_IPC_HOST_H_
61 
62 #include <mach/port.h>
63 #include <kern/kern_types.h>
64 
65 /* Initialize IPC host services */
66 extern void ipc_host_init(void);
67 
68 /* Initialize ipc access to processor by allocating a port */
69 extern void ipc_processor_init(
70 	processor_t     processor);
71 
72 /* Initialize ipc control of a processor set */
73 extern void ipc_pset_init(
74 	processor_set_t         pset);
75 
76 /* Initialize ipc control of a clock */
77 extern void ipc_clock_init(
78 	clock_t         clock);
79 
80 /* Convert from a port to a clock */
81 extern clock_t convert_port_to_clock(
82 	ipc_port_t      port);
83 
84 /* Convert from a port to a clock control */
85 extern clock_t convert_port_to_clock_ctrl(
86 	ipc_port_t      port);
87 
88 /* Convert from a clock to a port */
89 extern ipc_port_t convert_clock_to_port(
90 	clock_t         clock);
91 
92 /* Convert from a clock control to a port */
93 extern ipc_port_t convert_clock_ctrl_to_port(
94 	clock_t         clock);
95 
96 /* Convert from a clock name to a clock pointer */
97 extern clock_t port_name_to_clock(
98 	mach_port_name_t clock_name);
99 
100 /* Convert from a port to a host */
101 extern host_t convert_port_to_host(
102 	ipc_port_t      port);
103 
104 /* Convert from a port to a host privilege port */
105 extern host_t convert_port_to_host_priv(
106 	ipc_port_t      port);
107 
108 /*  Convert from a port to a host paging port */
109 extern host_t convert_port_to_host_paging(
110 	ipc_port_t      port);
111 
112 /* Convert from a host to a port */
113 extern ipc_port_t convert_host_to_port(
114 	host_t          host);
115 
116 /* Convert from a port to a processor */
117 extern processor_t convert_port_to_processor(
118 	ipc_port_t      port);
119 
120 /* Convert from a processor to a port */
121 extern ipc_port_t convert_processor_to_port(
122 	processor_t     processor);
123 
124 /* Convert from a port to a processor set */
125 extern processor_set_t convert_port_to_pset(
126 	ipc_port_t      port);
127 
128 /* Convert from a port to a processor set name */
129 extern processor_set_t convert_port_to_pset_name(
130 	ipc_port_t      port);
131 
132 /* Convert from a processor set to a port */
133 extern ipc_port_t convert_pset_to_port(
134 	processor_set_t         processor);
135 
136 /* Convert from a processor set name to a port */
137 extern ipc_port_t convert_pset_name_to_port(
138 	processor_set_t         processor);
139 
140 #endif  /* _KERN_IPC_HOST_H_ */
141