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