]> git.saurik.com Git - apple/xnu.git/blame - osfmk/mach/machine.h
xnu-1228.3.13.tar.gz
[apple/xnu.git] / osfmk / mach / machine.h
CommitLineData
1c79356b 1/*
2d21ac55 2 * Copyright (c) 2000-2007 Apple Computer, Inc. All rights reserved.
1c79356b 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
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.
8f6c56a5 14 *
2d21ac55
A
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
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
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.
8f6c56a5 25 *
2d21ac55 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 */
91447636
A
96 uint32_t memory_size; /* size of memory in bytes, capped at 2 GB */
97 uint64_t max_mem; /* actual size of physical memory */
2d21ac55 98 uint32_t physical_cpu; /* number of physical CPUs now available */
91447636 99 integer_t physical_cpu_max; /* max number of physical CPUs possible */
2d21ac55 100 uint32_t logical_cpu; /* number of logical cpu now available */
91447636 101 integer_t logical_cpu_max; /* max number of physical CPUs possible */
1c79356b
A
102};
103
91447636
A
104typedef struct machine_info *machine_info_t;
105typedef struct machine_info machine_info_data_t;
1c79356b 106
1c79356b 107extern struct machine_info machine_info;
9bccf70c 108
91447636
A
109__BEGIN_DECLS
110cpu_type_t slot_type(
111 int slot_num);
112
113cpu_subtype_t slot_subtype(
114 int slot_num);
115
116cpu_threadtype_t slot_threadtype(
117 int slot_num);
118__END_DECLS
119
120#endif /* MACH_KERNEL_PRIVATE */
121#endif /* KERNEL_PRIVATE */
122
123
124/*
125 * Capability bits used in the definition of cpu_type.
126 */
127#define CPU_ARCH_MASK 0xff000000 /* mask for architecture bits */
128#define CPU_ARCH_ABI64 0x01000000 /* 64 bit ABI */
1c79356b
A
129
130/*
131 * Machine types known by all.
132 */
133
134#define CPU_TYPE_ANY ((cpu_type_t) -1)
135
136#define CPU_TYPE_VAX ((cpu_type_t) 1)
137/* skip ((cpu_type_t) 2) */
138/* skip ((cpu_type_t) 3) */
139/* skip ((cpu_type_t) 4) */
140/* skip ((cpu_type_t) 5) */
141#define CPU_TYPE_MC680x0 ((cpu_type_t) 6)
c0fea474
A
142#define CPU_TYPE_X86 ((cpu_type_t) 7)
143#define CPU_TYPE_I386 CPU_TYPE_X86 /* compatibility */
144#define CPU_TYPE_X86_64 (CPU_TYPE_X86 | CPU_ARCH_ABI64)
145
1c79356b
A
146/* skip CPU_TYPE_MIPS ((cpu_type_t) 8) */
147/* skip ((cpu_type_t) 9) */
148#define CPU_TYPE_MC98000 ((cpu_type_t) 10)
149#define CPU_TYPE_HPPA ((cpu_type_t) 11)
2d21ac55 150#define CPU_TYPE_ARM ((cpu_type_t) 12)
1c79356b
A
151#define CPU_TYPE_MC88000 ((cpu_type_t) 13)
152#define CPU_TYPE_SPARC ((cpu_type_t) 14)
153#define CPU_TYPE_I860 ((cpu_type_t) 15)
154/* skip CPU_TYPE_ALPHA ((cpu_type_t) 16) */
155/* skip ((cpu_type_t) 17) */
156#define CPU_TYPE_POWERPC ((cpu_type_t) 18)
91447636 157#define CPU_TYPE_POWERPC64 (CPU_TYPE_POWERPC | CPU_ARCH_ABI64)
1c79356b
A
158
159/*
160 * Machine subtypes (these are defined here, instead of in a machine
161 * dependent directory, so that any program can get all definitions
162 * regardless of where is it compiled).
163 */
164
2d21ac55
A
165/*
166 * Capability bits used in the definition of cpu_subtype.
167 */
168#define CPU_SUBTYPE_MASK 0xff000000 /* mask for feature flags */
169#define CPU_SUBTYPE_LIB64 0x80000000 /* 64 bit libraries */
170
171
1c79356b
A
172/*
173 * Object files that are hand-crafted to run on any
174 * implementation of an architecture are tagged with
175 * CPU_SUBTYPE_MULTIPLE. This functions essentially the same as
176 * the "ALL" subtype of an architecture except that it allows us
177 * to easily find object files that may need to be modified
178 * whenever a new implementation of an architecture comes out.
179 *
180 * It is the responsibility of the implementor to make sure the
181 * software handles unsupported implementations elegantly.
182 */
183#define CPU_SUBTYPE_MULTIPLE ((cpu_subtype_t) -1)
184#define CPU_SUBTYPE_LITTLE_ENDIAN ((cpu_subtype_t) 0)
185#define CPU_SUBTYPE_BIG_ENDIAN ((cpu_subtype_t) 1)
186
91447636
A
187/*
188 * Machine threadtypes.
189 * This is none - not defined - for most machine types/subtypes.
190 */
191#define CPU_THREADTYPE_NONE ((cpu_threadtype_t) 0)
192
1c79356b
A
193/*
194 * VAX subtypes (these do *not* necessary conform to the actual cpu
195 * ID assigned by DEC available via the SID register).
196 */
197
198#define CPU_SUBTYPE_VAX_ALL ((cpu_subtype_t) 0)
199#define CPU_SUBTYPE_VAX780 ((cpu_subtype_t) 1)
200#define CPU_SUBTYPE_VAX785 ((cpu_subtype_t) 2)
201#define CPU_SUBTYPE_VAX750 ((cpu_subtype_t) 3)
202#define CPU_SUBTYPE_VAX730 ((cpu_subtype_t) 4)
203#define CPU_SUBTYPE_UVAXI ((cpu_subtype_t) 5)
204#define CPU_SUBTYPE_UVAXII ((cpu_subtype_t) 6)
205#define CPU_SUBTYPE_VAX8200 ((cpu_subtype_t) 7)
206#define CPU_SUBTYPE_VAX8500 ((cpu_subtype_t) 8)
207#define CPU_SUBTYPE_VAX8600 ((cpu_subtype_t) 9)
208#define CPU_SUBTYPE_VAX8650 ((cpu_subtype_t) 10)
209#define CPU_SUBTYPE_VAX8800 ((cpu_subtype_t) 11)
210#define CPU_SUBTYPE_UVAXIII ((cpu_subtype_t) 12)
211
212/*
213 * 680x0 subtypes
214 *
215 * The subtype definitions here are unusual for historical reasons.
216 * NeXT used to consider 68030 code as generic 68000 code. For
217 * backwards compatability:
218 *
219 * CPU_SUBTYPE_MC68030 symbol has been preserved for source code
220 * compatability.
221 *
222 * CPU_SUBTYPE_MC680x0_ALL has been defined to be the same
223 * subtype as CPU_SUBTYPE_MC68030 for binary comatability.
224 *
225 * CPU_SUBTYPE_MC68030_ONLY has been added to allow new object
226 * files to be tagged as containing 68030-specific instructions.
227 */
228
229#define CPU_SUBTYPE_MC680x0_ALL ((cpu_subtype_t) 1)
230#define CPU_SUBTYPE_MC68030 ((cpu_subtype_t) 1) /* compat */
231#define CPU_SUBTYPE_MC68040 ((cpu_subtype_t) 2)
232#define CPU_SUBTYPE_MC68030_ONLY ((cpu_subtype_t) 3)
233
234/*
0c530ab8 235 * I386 subtypes
1c79356b
A
236 */
237
1c79356b 238#define CPU_SUBTYPE_INTEL(f, m) ((cpu_subtype_t) (f) + ((m) << 4))
c0fea474
A
239
240#define CPU_SUBTYPE_I386_ALL CPU_SUBTYPE_INTEL(3, 0)
241#define CPU_SUBTYPE_386 CPU_SUBTYPE_INTEL(3, 0)
242#define CPU_SUBTYPE_486 CPU_SUBTYPE_INTEL(4, 0)
243#define CPU_SUBTYPE_486SX CPU_SUBTYPE_INTEL(4, 8) // 8 << 4 = 128
244#define CPU_SUBTYPE_586 CPU_SUBTYPE_INTEL(5, 0)
1c79356b
A
245#define CPU_SUBTYPE_PENT CPU_SUBTYPE_INTEL(5, 0)
246#define CPU_SUBTYPE_PENTPRO CPU_SUBTYPE_INTEL(6, 1)
247#define CPU_SUBTYPE_PENTII_M3 CPU_SUBTYPE_INTEL(6, 3)
248#define CPU_SUBTYPE_PENTII_M5 CPU_SUBTYPE_INTEL(6, 5)
c0fea474
A
249#define CPU_SUBTYPE_CELERON CPU_SUBTYPE_INTEL(7, 6)
250#define CPU_SUBTYPE_CELERON_MOBILE CPU_SUBTYPE_INTEL(7, 7)
251#define CPU_SUBTYPE_PENTIUM_3 CPU_SUBTYPE_INTEL(8, 0)
252#define CPU_SUBTYPE_PENTIUM_3_M CPU_SUBTYPE_INTEL(8, 1)
253#define CPU_SUBTYPE_PENTIUM_3_XEON CPU_SUBTYPE_INTEL(8, 2)
254#define CPU_SUBTYPE_PENTIUM_M CPU_SUBTYPE_INTEL(9, 0)
255#define CPU_SUBTYPE_PENTIUM_4 CPU_SUBTYPE_INTEL(10, 0)
256#define CPU_SUBTYPE_PENTIUM_4_M CPU_SUBTYPE_INTEL(10, 1)
257#define CPU_SUBTYPE_ITANIUM CPU_SUBTYPE_INTEL(11, 0)
258#define CPU_SUBTYPE_ITANIUM_2 CPU_SUBTYPE_INTEL(11, 1)
259#define CPU_SUBTYPE_XEON CPU_SUBTYPE_INTEL(12, 0)
260#define CPU_SUBTYPE_XEON_MP CPU_SUBTYPE_INTEL(12, 1)
1c79356b
A
261
262#define CPU_SUBTYPE_INTEL_FAMILY(x) ((x) & 15)
263#define CPU_SUBTYPE_INTEL_FAMILY_MAX 15
264
265#define CPU_SUBTYPE_INTEL_MODEL(x) ((x) >> 4)
266#define CPU_SUBTYPE_INTEL_MODEL_ALL 0
267
c0fea474
A
268/*
269 * X86 subtypes.
270 */
271
272#define CPU_SUBTYPE_X86_ALL ((cpu_subtype_t)3)
273#define CPU_SUBTYPE_X86_64_ALL ((cpu_subtype_t)3)
274#define CPU_SUBTYPE_X86_ARCH1 ((cpu_subtype_t)4)
275
91447636
A
276
277#define CPU_THREADTYPE_INTEL_HTT ((cpu_threadtype_t) 1)
278
1c79356b
A
279/*
280 * Mips subtypes.
281 */
282
283#define CPU_SUBTYPE_MIPS_ALL ((cpu_subtype_t) 0)
284#define CPU_SUBTYPE_MIPS_R2300 ((cpu_subtype_t) 1)
285#define CPU_SUBTYPE_MIPS_R2600 ((cpu_subtype_t) 2)
286#define CPU_SUBTYPE_MIPS_R2800 ((cpu_subtype_t) 3)
287#define CPU_SUBTYPE_MIPS_R2000a ((cpu_subtype_t) 4) /* pmax */
288#define CPU_SUBTYPE_MIPS_R2000 ((cpu_subtype_t) 5)
289#define CPU_SUBTYPE_MIPS_R3000a ((cpu_subtype_t) 6) /* 3max */
290#define CPU_SUBTYPE_MIPS_R3000 ((cpu_subtype_t) 7)
291
292/*
293 * MC98000 (PowerPC) subtypes
294 */
295#define CPU_SUBTYPE_MC98000_ALL ((cpu_subtype_t) 0)
296#define CPU_SUBTYPE_MC98601 ((cpu_subtype_t) 1)
297
298/*
299 * HPPA subtypes for Hewlett-Packard HP-PA family of
300 * risc processors. Port by NeXT to 700 series.
301 */
302
303#define CPU_SUBTYPE_HPPA_ALL ((cpu_subtype_t) 0)
304#define CPU_SUBTYPE_HPPA_7100 ((cpu_subtype_t) 0) /* compat */
305#define CPU_SUBTYPE_HPPA_7100LC ((cpu_subtype_t) 1)
306
307/*
308 * MC88000 subtypes.
309 */
310#define CPU_SUBTYPE_MC88000_ALL ((cpu_subtype_t) 0)
311#define CPU_SUBTYPE_MC88100 ((cpu_subtype_t) 1)
312#define CPU_SUBTYPE_MC88110 ((cpu_subtype_t) 2)
313
314/*
315 * SPARC subtypes
316 */
317#define CPU_SUBTYPE_SPARC_ALL ((cpu_subtype_t) 0)
318
319/*
320 * I860 subtypes
321 */
322#define CPU_SUBTYPE_I860_ALL ((cpu_subtype_t) 0)
323#define CPU_SUBTYPE_I860_860 ((cpu_subtype_t) 1)
324
325/*
326 * PowerPC subtypes
327 */
328#define CPU_SUBTYPE_POWERPC_ALL ((cpu_subtype_t) 0)
329#define CPU_SUBTYPE_POWERPC_601 ((cpu_subtype_t) 1)
330#define CPU_SUBTYPE_POWERPC_602 ((cpu_subtype_t) 2)
331#define CPU_SUBTYPE_POWERPC_603 ((cpu_subtype_t) 3)
332#define CPU_SUBTYPE_POWERPC_603e ((cpu_subtype_t) 4)
333#define CPU_SUBTYPE_POWERPC_603ev ((cpu_subtype_t) 5)
334#define CPU_SUBTYPE_POWERPC_604 ((cpu_subtype_t) 6)
335#define CPU_SUBTYPE_POWERPC_604e ((cpu_subtype_t) 7)
336#define CPU_SUBTYPE_POWERPC_620 ((cpu_subtype_t) 8)
337#define CPU_SUBTYPE_POWERPC_750 ((cpu_subtype_t) 9)
338#define CPU_SUBTYPE_POWERPC_7400 ((cpu_subtype_t) 10)
339#define CPU_SUBTYPE_POWERPC_7450 ((cpu_subtype_t) 11)
55e303ae 340#define CPU_SUBTYPE_POWERPC_970 ((cpu_subtype_t) 100)
1c79356b 341
0c530ab8 342/*
2d21ac55
A
343 * ARM subtypes
344 */
345#define CPU_SUBTYPE_ARM_ALL ((cpu_subtype_t) 0)
346#define CPU_SUBTYPE_ARM_V4T ((cpu_subtype_t) 5)
347#define CPU_SUBTYPE_ARM_V6 ((cpu_subtype_t) 6)
4a3eedf9
A
348#define CPU_SUBTYPE_ARM_V5TEJ ((cpu_subtype_t) 7)
349#define CPU_SUBTYPE_ARM_XSCALE ((cpu_subtype_t) 8)
2d21ac55
A
350
351/*
352 * CPU families (sysctl hw.cpufamily)
0c530ab8 353 *
2d21ac55
A
354 * These are meant to identify the CPU's marketing name - an
355 * application can map these to (possibly) localized strings.
0c530ab8
A
356 * NB: the encodings of the CPU families are intentionally arbitrary.
357 * There is no ordering, and you should never try to deduce whether
358 * or not some feature is available based on the family.
359 * Use feature flags (eg, hw.optional.altivec) to test for optional
360 * functionality.
361 */
362#define CPUFAMILY_UNKNOWN 0
363#define CPUFAMILY_POWERPC_G3 0xcee41549
364#define CPUFAMILY_POWERPC_G4 0x77c184ae
365#define CPUFAMILY_POWERPC_G5 0xed76d8aa
2d21ac55
A
366#define CPUFAMILY_INTEL_6_13 0xaa33392b
367#define CPUFAMILY_INTEL_6_14 0x73d67300 /* "Intel Core Solo" and "Intel Core Duo" (32-bit Pentium-M with SSE3) */
368#define CPUFAMILY_INTEL_6_15 0x426f69ef /* "Intel Core 2 Duo" */
369#define CPUFAMILY_INTEL_6_23 0x78ea4fbc /* Penryn */
370#define CPUFAMILY_INTEL_6_26 0x6b5a4cd2 /* Nehalem */
371#define CPUFAMILY_ARM_9 0xe73283ae
372#define CPUFAMILY_ARM_11 0x8ff620d8
4a3eedf9 373#define CPUFAMILY_ARM_XSCALE 0x53b005f5
2d21ac55
A
374
375#define CPUFAMILY_INTEL_YONAH CPUFAMILY_INTEL_6_14
376#define CPUFAMILY_INTEL_MEROM CPUFAMILY_INTEL_6_15
377#define CPUFAMILY_INTEL_PENRYN CPUFAMILY_INTEL_6_23
378#define CPUFAMILY_INTEL_NEHALEM CPUFAMILY_INTEL_6_26
379
380#define CPUFAMILY_INTEL_CORE CPUFAMILY_INTEL_6_14
381#define CPUFAMILY_INTEL_CORE2 CPUFAMILY_INTEL_6_15
0c530ab8 382
1c79356b 383#endif /* _MACH_MACHINE_H_ */