]> git.saurik.com Git - apple/xnu.git/blame - osfmk/mach/machine.h
xnu-792.22.5.tar.gz
[apple/xnu.git] / osfmk / mach / machine.h
CommitLineData
1c79356b 1/*
91447636 2 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
1c79356b 3 *
8f6c56a5 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
8f6c56a5
A
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
8ad349bb 24 * limitations under the License.
8f6c56a5
A
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/*
29 * Mach Operating System
30 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
31 * All Rights Reserved.
32 *
33 * Permission to use, copy, modify and distribute this software and its
34 * documentation is hereby granted, provided that both the copyright
35 * notice and this permission notice appear in all copies of the
36 * software, derivative works or modified versions, and any portions
37 * thereof, and that both notices appear in supporting documentation.
38 *
39 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
40 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
41 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
42 *
43 * Carnegie Mellon requests users of this software to return to
44 *
45 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
46 * School of Computer Science
47 * Carnegie Mellon University
48 * Pittsburgh PA 15213-3890
49 *
50 * any improvements or extensions that they make and grant Carnegie Mellon
51 * the rights to redistribute these changes.
52 */
53/* File: machine.h
54 * Author: Avadis Tevanian, Jr.
55 * Date: 1986
56 *
57 * Machine independent machine abstraction.
58 */
59
60#ifndef _MACH_MACHINE_H_
61#define _MACH_MACHINE_H_
62
91447636 63#include <stdint.h>
1c79356b
A
64#include <mach/machine/vm_types.h>
65#include <mach/boolean.h>
66
1c79356b
A
67typedef integer_t cpu_type_t;
68typedef integer_t cpu_subtype_t;
91447636 69typedef integer_t cpu_threadtype_t;
1c79356b
A
70
71#define CPU_STATE_MAX 4
72
73#define CPU_STATE_USER 0
74#define CPU_STATE_SYSTEM 1
75#define CPU_STATE_IDLE 2
76#define CPU_STATE_NICE 3
77
9bccf70c 78#ifdef KERNEL_PRIVATE
91447636
A
79
80#include <sys/cdefs.h>
81
82__BEGIN_DECLS
83cpu_type_t cpu_type(void);
84
85cpu_subtype_t cpu_subtype(void);
86
87cpu_threadtype_t cpu_threadtype(void);
88__END_DECLS
89
90#ifdef MACH_KERNEL_PRIVATE
91
92struct machine_info {
93 integer_t major_version; /* kernel major version id */
94 integer_t minor_version; /* kernel minor version id */
95 integer_t max_cpus; /* max number of CPUs possible */
96 integer_t avail_cpus; /* number of CPUs now available */
97 uint32_t memory_size; /* size of memory in bytes, capped at 2 GB */
98 uint64_t max_mem; /* actual size of physical memory */
99 integer_t physical_cpu; /* number of physical CPUs now available */
100 integer_t physical_cpu_max; /* max number of physical CPUs possible */
101 integer_t logical_cpu; /* number of logical cpu now available */
102 integer_t logical_cpu_max; /* max number of physical CPUs possible */
1c79356b
A
103};
104
91447636
A
105typedef struct machine_info *machine_info_t;
106typedef struct machine_info machine_info_data_t;
1c79356b 107
1c79356b 108extern struct machine_info machine_info;
9bccf70c 109
91447636
A
110__BEGIN_DECLS
111cpu_type_t slot_type(
112 int slot_num);
113
114cpu_subtype_t slot_subtype(
115 int slot_num);
116
117cpu_threadtype_t slot_threadtype(
118 int slot_num);
119__END_DECLS
120
121#endif /* MACH_KERNEL_PRIVATE */
122#endif /* KERNEL_PRIVATE */
123
124
125/*
126 * Capability bits used in the definition of cpu_type.
127 */
128#define CPU_ARCH_MASK 0xff000000 /* mask for architecture bits */
129#define CPU_ARCH_ABI64 0x01000000 /* 64 bit ABI */
1c79356b
A
130
131/*
132 * Machine types known by all.
133 */
134
135#define CPU_TYPE_ANY ((cpu_type_t) -1)
136
137#define CPU_TYPE_VAX ((cpu_type_t) 1)
138/* skip ((cpu_type_t) 2) */
139/* skip ((cpu_type_t) 3) */
140/* skip ((cpu_type_t) 4) */
141/* skip ((cpu_type_t) 5) */
142#define CPU_TYPE_MC680x0 ((cpu_type_t) 6)
c0fea474
A
143#define CPU_TYPE_X86 ((cpu_type_t) 7)
144#define CPU_TYPE_I386 CPU_TYPE_X86 /* compatibility */
145#define CPU_TYPE_X86_64 (CPU_TYPE_X86 | CPU_ARCH_ABI64)
146
1c79356b
A
147/* skip CPU_TYPE_MIPS ((cpu_type_t) 8) */
148/* skip ((cpu_type_t) 9) */
149#define CPU_TYPE_MC98000 ((cpu_type_t) 10)
150#define CPU_TYPE_HPPA ((cpu_type_t) 11)
151/* skip CPU_TYPE_ARM ((cpu_type_t) 12) */
152#define CPU_TYPE_MC88000 ((cpu_type_t) 13)
153#define CPU_TYPE_SPARC ((cpu_type_t) 14)
154#define CPU_TYPE_I860 ((cpu_type_t) 15)
155/* skip CPU_TYPE_ALPHA ((cpu_type_t) 16) */
156/* skip ((cpu_type_t) 17) */
157#define CPU_TYPE_POWERPC ((cpu_type_t) 18)
91447636 158#define CPU_TYPE_POWERPC64 (CPU_TYPE_POWERPC | CPU_ARCH_ABI64)
1c79356b
A
159
160/*
161 * Machine subtypes (these are defined here, instead of in a machine
162 * dependent directory, so that any program can get all definitions
163 * regardless of where is it compiled).
164 */
165
166/*
167 * Object files that are hand-crafted to run on any
168 * implementation of an architecture are tagged with
169 * CPU_SUBTYPE_MULTIPLE. This functions essentially the same as
170 * the "ALL" subtype of an architecture except that it allows us
171 * to easily find object files that may need to be modified
172 * whenever a new implementation of an architecture comes out.
173 *
174 * It is the responsibility of the implementor to make sure the
175 * software handles unsupported implementations elegantly.
176 */
177#define CPU_SUBTYPE_MULTIPLE ((cpu_subtype_t) -1)
178#define CPU_SUBTYPE_LITTLE_ENDIAN ((cpu_subtype_t) 0)
179#define CPU_SUBTYPE_BIG_ENDIAN ((cpu_subtype_t) 1)
180
91447636
A
181/*
182 * Machine threadtypes.
183 * This is none - not defined - for most machine types/subtypes.
184 */
185#define CPU_THREADTYPE_NONE ((cpu_threadtype_t) 0)
186
1c79356b
A
187/*
188 * VAX subtypes (these do *not* necessary conform to the actual cpu
189 * ID assigned by DEC available via the SID register).
190 */
191
192#define CPU_SUBTYPE_VAX_ALL ((cpu_subtype_t) 0)
193#define CPU_SUBTYPE_VAX780 ((cpu_subtype_t) 1)
194#define CPU_SUBTYPE_VAX785 ((cpu_subtype_t) 2)
195#define CPU_SUBTYPE_VAX750 ((cpu_subtype_t) 3)
196#define CPU_SUBTYPE_VAX730 ((cpu_subtype_t) 4)
197#define CPU_SUBTYPE_UVAXI ((cpu_subtype_t) 5)
198#define CPU_SUBTYPE_UVAXII ((cpu_subtype_t) 6)
199#define CPU_SUBTYPE_VAX8200 ((cpu_subtype_t) 7)
200#define CPU_SUBTYPE_VAX8500 ((cpu_subtype_t) 8)
201#define CPU_SUBTYPE_VAX8600 ((cpu_subtype_t) 9)
202#define CPU_SUBTYPE_VAX8650 ((cpu_subtype_t) 10)
203#define CPU_SUBTYPE_VAX8800 ((cpu_subtype_t) 11)
204#define CPU_SUBTYPE_UVAXIII ((cpu_subtype_t) 12)
205
206/*
207 * 680x0 subtypes
208 *
209 * The subtype definitions here are unusual for historical reasons.
210 * NeXT used to consider 68030 code as generic 68000 code. For
211 * backwards compatability:
212 *
213 * CPU_SUBTYPE_MC68030 symbol has been preserved for source code
214 * compatability.
215 *
216 * CPU_SUBTYPE_MC680x0_ALL has been defined to be the same
217 * subtype as CPU_SUBTYPE_MC68030 for binary comatability.
218 *
219 * CPU_SUBTYPE_MC68030_ONLY has been added to allow new object
220 * files to be tagged as containing 68030-specific instructions.
221 */
222
223#define CPU_SUBTYPE_MC680x0_ALL ((cpu_subtype_t) 1)
224#define CPU_SUBTYPE_MC68030 ((cpu_subtype_t) 1) /* compat */
225#define CPU_SUBTYPE_MC68040 ((cpu_subtype_t) 2)
226#define CPU_SUBTYPE_MC68030_ONLY ((cpu_subtype_t) 3)
227
228/*
4452a7af 229 * I386 subtypes
1c79356b
A
230 */
231
1c79356b 232#define CPU_SUBTYPE_INTEL(f, m) ((cpu_subtype_t) (f) + ((m) << 4))
c0fea474
A
233
234#define CPU_SUBTYPE_I386_ALL CPU_SUBTYPE_INTEL(3, 0)
235#define CPU_SUBTYPE_386 CPU_SUBTYPE_INTEL(3, 0)
236#define CPU_SUBTYPE_486 CPU_SUBTYPE_INTEL(4, 0)
237#define CPU_SUBTYPE_486SX CPU_SUBTYPE_INTEL(4, 8) // 8 << 4 = 128
238#define CPU_SUBTYPE_586 CPU_SUBTYPE_INTEL(5, 0)
1c79356b
A
239#define CPU_SUBTYPE_PENT CPU_SUBTYPE_INTEL(5, 0)
240#define CPU_SUBTYPE_PENTPRO CPU_SUBTYPE_INTEL(6, 1)
241#define CPU_SUBTYPE_PENTII_M3 CPU_SUBTYPE_INTEL(6, 3)
242#define CPU_SUBTYPE_PENTII_M5 CPU_SUBTYPE_INTEL(6, 5)
c0fea474
A
243#define CPU_SUBTYPE_CELERON CPU_SUBTYPE_INTEL(7, 6)
244#define CPU_SUBTYPE_CELERON_MOBILE CPU_SUBTYPE_INTEL(7, 7)
245#define CPU_SUBTYPE_PENTIUM_3 CPU_SUBTYPE_INTEL(8, 0)
246#define CPU_SUBTYPE_PENTIUM_3_M CPU_SUBTYPE_INTEL(8, 1)
247#define CPU_SUBTYPE_PENTIUM_3_XEON CPU_SUBTYPE_INTEL(8, 2)
248#define CPU_SUBTYPE_PENTIUM_M CPU_SUBTYPE_INTEL(9, 0)
249#define CPU_SUBTYPE_PENTIUM_4 CPU_SUBTYPE_INTEL(10, 0)
250#define CPU_SUBTYPE_PENTIUM_4_M CPU_SUBTYPE_INTEL(10, 1)
251#define CPU_SUBTYPE_ITANIUM CPU_SUBTYPE_INTEL(11, 0)
252#define CPU_SUBTYPE_ITANIUM_2 CPU_SUBTYPE_INTEL(11, 1)
253#define CPU_SUBTYPE_XEON CPU_SUBTYPE_INTEL(12, 0)
254#define CPU_SUBTYPE_XEON_MP CPU_SUBTYPE_INTEL(12, 1)
1c79356b
A
255
256#define CPU_SUBTYPE_INTEL_FAMILY(x) ((x) & 15)
257#define CPU_SUBTYPE_INTEL_FAMILY_MAX 15
258
259#define CPU_SUBTYPE_INTEL_MODEL(x) ((x) >> 4)
260#define CPU_SUBTYPE_INTEL_MODEL_ALL 0
261
c0fea474
A
262/*
263 * X86 subtypes.
264 */
265
266#define CPU_SUBTYPE_X86_ALL ((cpu_subtype_t)3)
267#define CPU_SUBTYPE_X86_64_ALL ((cpu_subtype_t)3)
268#define CPU_SUBTYPE_X86_ARCH1 ((cpu_subtype_t)4)
269
91447636
A
270
271#define CPU_THREADTYPE_INTEL_HTT ((cpu_threadtype_t) 1)
272
1c79356b
A
273/*
274 * Mips subtypes.
275 */
276
277#define CPU_SUBTYPE_MIPS_ALL ((cpu_subtype_t) 0)
278#define CPU_SUBTYPE_MIPS_R2300 ((cpu_subtype_t) 1)
279#define CPU_SUBTYPE_MIPS_R2600 ((cpu_subtype_t) 2)
280#define CPU_SUBTYPE_MIPS_R2800 ((cpu_subtype_t) 3)
281#define CPU_SUBTYPE_MIPS_R2000a ((cpu_subtype_t) 4) /* pmax */
282#define CPU_SUBTYPE_MIPS_R2000 ((cpu_subtype_t) 5)
283#define CPU_SUBTYPE_MIPS_R3000a ((cpu_subtype_t) 6) /* 3max */
284#define CPU_SUBTYPE_MIPS_R3000 ((cpu_subtype_t) 7)
285
286/*
287 * MC98000 (PowerPC) subtypes
288 */
289#define CPU_SUBTYPE_MC98000_ALL ((cpu_subtype_t) 0)
290#define CPU_SUBTYPE_MC98601 ((cpu_subtype_t) 1)
291
292/*
293 * HPPA subtypes for Hewlett-Packard HP-PA family of
294 * risc processors. Port by NeXT to 700 series.
295 */
296
297#define CPU_SUBTYPE_HPPA_ALL ((cpu_subtype_t) 0)
298#define CPU_SUBTYPE_HPPA_7100 ((cpu_subtype_t) 0) /* compat */
299#define CPU_SUBTYPE_HPPA_7100LC ((cpu_subtype_t) 1)
300
301/*
302 * MC88000 subtypes.
303 */
304#define CPU_SUBTYPE_MC88000_ALL ((cpu_subtype_t) 0)
305#define CPU_SUBTYPE_MC88100 ((cpu_subtype_t) 1)
306#define CPU_SUBTYPE_MC88110 ((cpu_subtype_t) 2)
307
308/*
309 * SPARC subtypes
310 */
311#define CPU_SUBTYPE_SPARC_ALL ((cpu_subtype_t) 0)
312
313/*
314 * I860 subtypes
315 */
316#define CPU_SUBTYPE_I860_ALL ((cpu_subtype_t) 0)
317#define CPU_SUBTYPE_I860_860 ((cpu_subtype_t) 1)
318
319/*
320 * PowerPC subtypes
321 */
322#define CPU_SUBTYPE_POWERPC_ALL ((cpu_subtype_t) 0)
323#define CPU_SUBTYPE_POWERPC_601 ((cpu_subtype_t) 1)
324#define CPU_SUBTYPE_POWERPC_602 ((cpu_subtype_t) 2)
325#define CPU_SUBTYPE_POWERPC_603 ((cpu_subtype_t) 3)
326#define CPU_SUBTYPE_POWERPC_603e ((cpu_subtype_t) 4)
327#define CPU_SUBTYPE_POWERPC_603ev ((cpu_subtype_t) 5)
328#define CPU_SUBTYPE_POWERPC_604 ((cpu_subtype_t) 6)
329#define CPU_SUBTYPE_POWERPC_604e ((cpu_subtype_t) 7)
330#define CPU_SUBTYPE_POWERPC_620 ((cpu_subtype_t) 8)
331#define CPU_SUBTYPE_POWERPC_750 ((cpu_subtype_t) 9)
332#define CPU_SUBTYPE_POWERPC_7400 ((cpu_subtype_t) 10)
333#define CPU_SUBTYPE_POWERPC_7450 ((cpu_subtype_t) 11)
55e303ae 334#define CPU_SUBTYPE_POWERPC_970 ((cpu_subtype_t) 100)
1c79356b 335
4452a7af
A
336/*
337 * CPU families (sysctl hw.cpufamily)
338 *
339 * NB: the encodings of the CPU families are intentionally arbitrary.
340 * There is no ordering, and you should never try to deduce whether
341 * or not some feature is available based on the family.
342 * Use feature flags (eg, hw.optional.altivec) to test for optional
343 * functionality.
344 */
345#define CPUFAMILY_UNKNOWN 0
346#define CPUFAMILY_POWERPC_G3 0xcee41549
347#define CPUFAMILY_POWERPC_G4 0x77c184ae
348#define CPUFAMILY_POWERPC_G5 0xed76d8aa
349#define CPUFAMILY_INTEL_6_14 0x73d67300 /* Intel Core Solo and Intel Core Duo (32-bit Pentium-M with SSE3) */
350#define CPUFAMILY_INTEL_6_15 0x426f69ef /* Intel Core 2 */
351
1c79356b 352#endif /* _MACH_MACHINE_H_ */