xref: /titanic_52/usr/src/uts/common/sys/isa_defs.h (revision ba4e3c84e6b9390bbf7df80b5f1d11dec34cc525)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_SYS_ISA_DEFS_H
28 #define	_SYS_ISA_DEFS_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 /*
33  * This header file serves to group a set of well known defines and to
34  * set these for each instruction set architecture.  These defines may
35  * be divided into two groups;  characteristics of the processor and
36  * implementation choices for Solaris on a processor.
37  *
38  * Processor Characteristics:
39  *
40  * _LITTLE_ENDIAN / _BIG_ENDIAN:
41  *	The natural byte order of the processor.  A pointer to an int points
42  *	to the least/most significant byte of that int.
43  *
44  * _STACK_GROWS_UPWARD / _STACK_GROWS_DOWNWARD:
45  *	The processor specific direction of stack growth.  A push onto the
46  *	stack increases/decreases the stack pointer, so it stores data at
47  *	successively higher/lower addresses.  (Stackless machines ignored
48  *	without regrets).
49  *
50  * _LONG_LONG_HTOL / _LONG_LONG_LTOH:
51  *	A pointer to a long long points to the most/least significant long
52  *	within that long long.
53  *
54  * _BIT_FIELDS_HTOL / _BIT_FIELDS_LTOH:
55  *	The C compiler assigns bit fields from the high/low to the low/high end
56  *	of an int (most to least significant vs. least to most significant).
57  *
58  * _IEEE_754:
59  *	The processor (or supported implementations of the processor)
60  *	supports the ieee-754 floating point standard.  No other floating
61  *	point standards are supported (or significant).  Any other supported
62  *	floating point formats are expected to be cased on the ISA processor
63  *	symbol.
64  *
65  * _CHAR_IS_UNSIGNED / _CHAR_IS_SIGNED:
66  *	The C Compiler implements objects of type `char' as `unsigned' or
67  *	`signed' respectively.  This is really an implementation choice of
68  *	the compiler writer, but it is specified in the ABI and tends to
69  *	be uniform across compilers for an instruction set architecture.
70  *	Hence, it has the properties of a processor characteristic.
71  *
72  * _CHAR_ALIGNMENT / _SHORT_ALIGNMENT / _INT_ALIGNMENT / _LONG_ALIGNMENT /
73  * _LONG_LONG_ALIGNMENT / _DOUBLE_ALIGNMENT / _LONG_DOUBLE_ALIGNMENT /
74  * _POINTER_ALIGNMENT / _FLOAT_ALIGNMENT:
75  *	The ABI defines alignment requirements of each of the primitive
76  *	object types.  Some, if not all, may be hardware requirements as
77  * 	well.  The values are expressed in "byte-alignment" units.
78  *
79  * _MAX_ALIGNMENT:
80  *	The most stringent alignment requirement as specified by the ABI.
81  *	Equal to the maximum of all the above _XXX_ALIGNMENT values.
82  *
83  * _ALIGNMENT_REQUIRED:
84  *	True or false (1 or 0) whether or not the hardware requires the ABI
85  *	alignment.
86  *
87  * _LONG_LONG_ALIGNMENT_32
88  *	The 32-bit ABI supported by a 64-bit kernel may have different
89  *	alignment requirements for primitive object types.  The value of this
90  *	identifier is expressed in "byte-alignment" units.
91  *
92  * _HAVE_CPUID_INSN
93  *	This indicates that the architecture supports the 'cpuid'
94  *	instruction as defined by Intel.  (Intel allows other vendors
95  *	to extend the instruction for their own purposes.)
96  *
97  *
98  * Implementation Choices:
99  *
100  * _ILP32 / _LP64:
101  *	This specifies the compiler data type implementation as specified in
102  *	the relevant ABI.  The choice between these is strongly influenced
103  *	by the underlying hardware, but is not absolutely tied to it.
104  *	Currently only two data type models are supported:
105  *
106  *	_ILP32:
107  *		Int/Long/Pointer are 32 bits.  This is the historical UNIX
108  *		and Solaris implementation.  Due to its historical standing,
109  *		this is the default case.
110  *
111  *	_LP64:
112  *		Long/Pointer are 64 bits, Int is 32 bits.  This is the chosen
113  *		implementation for 64-bit ABIs such as SPARC V9.
114  *
115  *	_I32LPx:
116  *		A compilation environment where 'int' is 32-bit, and
117  *		longs and pointers are simply the same size.
118  *
119  *	In all cases, Char is 8 bits and Short is 16 bits.
120  *
121  * _SUNOS_VTOC_8 / _SUNOS_VTOC_16 / _SVR4_VTOC_16:
122  *	This specifies the form of the disk VTOC (or label):
123  *
124  *	_SUNOS_VTOC_8:
125  *		This is a VTOC form which is upwardly compatible with the
126  *		SunOS 4.x disk label and allows 8 partitions per disk.
127  *
128  *	_SUNOS_VTOC_16:
129  *		In this format the incore vtoc image matches the ondisk
130  *		version.  It allows 16 slices per disk, and is not
131  *		compatible with the SunOS 4.x disk label.
132  *
133  *	Note that these are not the only two VTOC forms possible and
134  *	additional forms may be added.  One possible form would be the
135  *	SVr4 VTOC form.  The symbol for that is reserved now, although
136  *	it is not implemented.
137  *
138  *	_SVR4_VTOC_16:
139  *		This VTOC form is compatible with the System V Release 4
140  *		VTOC (as implemented on the SVr4 Intel and 3b ports) with
141  *		16 partitions per disk.
142  *
143  *
144  * _DMA_USES_PHYSADDR / _DMA_USES_VIRTADDR
145  *	This describes the type of addresses used by system DMA:
146  *
147  *	_DMA_USES_PHYSADDR:
148  *		This type of DMA, used in the x86 implementation,
149  *		requires physical addresses for DMA buffers.  The 24-bit
150  *		addresses used by some legacy boards is the source of the
151  *		"low-memory" (<16MB) requirement for some devices using DMA.
152  *
153  *	_DMA_USES_VIRTADDR:
154  *		This method of DMA allows the use of virtual addresses for
155  *		DMA transfers.
156  *
157  * _FIRMWARE_NEEDS_FDISK / _NO_FDISK_PRESENT
158  *      This indicates the presence/absence of an fdisk table.
159  *
160  *      _FIRMWARE_NEEDS_FDISK
161  *              The fdisk table is required by system firmware.  If present,
162  *              it allows a disk to be subdivided into multiple fdisk
163  *              partitions, each of which is equivalent to a separate,
164  *              virtual disk.  This enables the co-existence of multiple
165  *              operating systems on a shared hard disk.
166  *
167  *      _NO_FDISK_PRESENT
168  *              If the fdisk table is absent, it is assumed that the entire
169  *              media is allocated for a single operating system.
170  *
171  * _HAVE_TEM_FIRMWARE
172  *	Defined if this architecture has the (fallback) option of
173  *	using prom_* calls for doing I/O if a suitable kernel driver
174  *	is not available to do it.
175  *
176  * _DONT_USE_1275_GENERIC_NAMES
177  *		Controls whether or not device tree node names should
178  *		comply with the IEEE 1275 "Generic Names" Recommended
179  *		Practice. With _DONT_USE_GENERIC_NAMES, device-specific
180  *		names identifying the particular device will be used.
181  *
182  * __i386_COMPAT
183  *	This indicates whether the i386 ABI is supported as a *non-native*
184  *	mode for the platform.  When this symbol is defined:
185  *	-	32-bit xstat-style system calls are enabled
186  *	-	32-bit xmknod-style system calls are enabled
187  *	-	32-bit system calls use i386 sizes -and- alignments
188  *
189  *	Note that this is NOT defined for the i386 native environment!
190  *
191  * __x86
192  *	This is ONLY a synonym for defined(__i386) || defined(__amd64)
193  *	which is useful only insofar as these two architectures share
194  *	common attributes.  Analogous to __sparc.
195  *
196  * _PSM_MODULES
197  *	This indicates whether or not the implementation uses PSM
198  *	modules for processor support, reading /etc/mach from inside
199  *	the kernel to extract a list.
200  *
201  * _RTC_CONFIG
202  *	This indicates whether or not the implementation uses /etc/rtc_config
203  *	to configure the real-time clock in the kernel.
204  */
205 
206 #ifdef	__cplusplus
207 extern "C" {
208 #endif
209 
210 /*
211  * The following set of definitions characterize Solaris on AMD's
212  * 64-bit systems.
213  */
214 #if defined(__x86_64) || defined(__amd64)
215 
216 #if !defined(__amd64)
217 #define	__amd64		/* preferred guard */
218 #endif
219 
220 #if !defined(__x86)
221 #define	__x86
222 #endif
223 
224 /*
225  * Define the appropriate "processor characteristics"
226  */
227 #define	_LITTLE_ENDIAN
228 #define	_STACK_GROWS_DOWNWARD
229 #define	_LONG_LONG_LTOH
230 #define	_BIT_FIELDS_LTOH
231 #define	_IEEE_754
232 #define	_CHAR_IS_SIGNED
233 #define	_BOOL_ALIGNMENT			1
234 #define	_CHAR_ALIGNMENT			1
235 #define	_SHORT_ALIGNMENT		2
236 #define	_INT_ALIGNMENT			4
237 #define	_FLOAT_ALIGNMENT		4
238 #define	_FLOAT_COMPLEX_ALIGNMENT	4
239 #define	_LONG_ALIGNMENT			8
240 #define	_LONG_LONG_ALIGNMENT		8
241 #define	_DOUBLE_ALIGNMENT		8
242 #define	_DOUBLE_COMPLEX_ALIGNMENT	8
243 #define	_LONG_DOUBLE_ALIGNMENT		16
244 #define	_LONG_DOUBLE_COMPLEX_ALIGNMENT	16
245 #define	_POINTER_ALIGNMENT		8
246 #define	_MAX_ALIGNMENT			16
247 #define	_ALIGNMENT_REQUIRED		1
248 
249 /*
250  * Different alignment constraints for the i386 ABI in compatibility mode
251  */
252 #define	_LONG_LONG_ALIGNMENT_32		4
253 
254 /*
255  * Define the appropriate "implementation choices".
256  */
257 #if !defined(_LP64)
258 #define	_LP64
259 #endif
260 #if !defined(_I32LPx) && defined(_KERNEL)
261 #define	_I32LPx
262 #endif
263 #define	_MULTI_DATAMODEL
264 #define	_SUNOS_VTOC_16
265 #define	_DMA_USES_PHYSADDR
266 #define	_FIRMWARE_NEEDS_FDISK
267 #define	__i386_COMPAT
268 #define	_PSM_MODULES
269 #define	_RTC_CONFIG
270 #define	_DONT_USE_1275_GENERIC_NAMES
271 #define	_HAVE_CPUID_INSN
272 
273 /*
274  * The feature test macro __i386 is generic for all processors implementing
275  * the Intel 386 instruction set or a superset of it.  Specifically, this
276  * includes all members of the 386, 486, and Pentium family of processors.
277  */
278 #elif defined(__i386) || defined(__i386__)
279 
280 #if !defined(__i386)
281 #define	__i386
282 #endif
283 
284 #if !defined(__x86)
285 #define	__x86
286 #endif
287 
288 /*
289  * Define the appropriate "processor characteristics"
290  */
291 #define	_LITTLE_ENDIAN
292 #define	_STACK_GROWS_DOWNWARD
293 #define	_LONG_LONG_LTOH
294 #define	_BIT_FIELDS_LTOH
295 #define	_IEEE_754
296 #define	_CHAR_IS_SIGNED
297 #define	_BOOL_ALIGNMENT			1
298 #define	_CHAR_ALIGNMENT			1
299 #define	_SHORT_ALIGNMENT		2
300 #define	_INT_ALIGNMENT			4
301 #define	_FLOAT_ALIGNMENT		4
302 #define	_FLOAT_COMPLEX_ALIGNMENT	4
303 #define	_LONG_ALIGNMENT			4
304 #define	_LONG_LONG_ALIGNMENT		4
305 #define	_DOUBLE_ALIGNMENT		4
306 #define	_DOUBLE_COMPLEX_ALIGNMENT	4
307 #define	_LONG_DOUBLE_ALIGNMENT		4
308 #define	_LONG_DOUBLE_COMPLEX_ALIGNMENT	4
309 #define	_POINTER_ALIGNMENT		4
310 #define	_MAX_ALIGNMENT			4
311 #define	_ALIGNMENT_REQUIRED		0
312 
313 #define	_LONG_LONG_ALIGNMENT_32		_LONG_LONG_ALIGNMENT
314 
315 /*
316  * Define the appropriate "implementation choices".
317  */
318 #define	_ILP32
319 #if !defined(_I32LPx) && defined(_KERNEL)
320 #define	_I32LPx
321 #endif
322 #define	_SUNOS_VTOC_16
323 #define	_DMA_USES_PHYSADDR
324 #define	_FIRMWARE_NEEDS_FDISK
325 #define	_PSM_MODULES
326 #define	_RTC_CONFIG
327 #define	_DONT_USE_1275_GENERIC_NAMES
328 #define	_HAVE_CPUID_INSN
329 
330 /*
331  * The following set of definitions characterize the Solaris on SPARC systems.
332  *
333  * The symbol __sparc indicates any of the SPARC family of processor
334  * architectures.  This includes SPARC V7, SPARC V8 and SPARC V9.
335  *
336  * The symbol __sparcv8 indicates the 32-bit SPARC V8 architecture as defined
337  * by Version 8 of the SPARC Architecture Manual.  (SPARC V7 is close enough
338  * to SPARC V8 for the former to be subsumed into the latter definition.)
339  *
340  * The symbol __sparcv9 indicates the 64-bit SPARC V9 architecture as defined
341  * by Version 9 of the SPARC Architecture Manual.
342  *
343  * The symbols __sparcv8 and __sparcv9 are mutually exclusive, and are only
344  * relevant when the symbol __sparc is defined.
345  */
346 /*
347  * XXX Due to the existence of 5110166, "defined(__sparcv9)" needs to be added
348  * to support backwards builds.  This workaround should be removed in s10_71.
349  */
350 #elif defined(__sparc) || defined(__sparcv9) || defined(__sparc__)
351 #if !defined(__sparc)
352 #define	__sparc
353 #endif
354 
355 /*
356  * You can be 32-bit or 64-bit, but not both at the same time.
357  */
358 #if defined(__sparcv8) && defined(__sparcv9)
359 #error	"SPARC Versions 8 and 9 are mutually exclusive choices"
360 #endif
361 
362 /*
363  * Existing compilers do not set __sparcv8.  Years will transpire before
364  * the compilers can be depended on to set the feature test macro. In
365  * the interim, we'll set it here on the basis of historical behaviour;
366  * if you haven't asked for SPARC V9, then you must've meant SPARC V8.
367  */
368 #if !defined(__sparcv9) && !defined(__sparcv8)
369 #define	__sparcv8
370 #endif
371 
372 /*
373  * Define the appropriate "processor characteristics" shared between
374  * all Solaris on SPARC systems.
375  */
376 #define	_BIG_ENDIAN
377 #define	_STACK_GROWS_DOWNWARD
378 #define	_LONG_LONG_HTOL
379 #define	_BIT_FIELDS_HTOL
380 #define	_IEEE_754
381 #define	_CHAR_IS_SIGNED
382 #define	_BOOL_ALIGNMENT			1
383 #define	_CHAR_ALIGNMENT			1
384 #define	_SHORT_ALIGNMENT		2
385 #define	_INT_ALIGNMENT			4
386 #define	_FLOAT_ALIGNMENT		4
387 #define	_FLOAT_COMPLEX_ALIGNMENT	4
388 #define	_LONG_LONG_ALIGNMENT		8
389 #define	_DOUBLE_ALIGNMENT		8
390 #define	_DOUBLE_COMPLEX_ALIGNMENT	8
391 #define	_ALIGNMENT_REQUIRED		1
392 
393 /*
394  * Define the appropriate "implementation choices" shared between versions.
395  */
396 #define	_SUNOS_VTOC_8
397 #define	_DMA_USES_VIRTADDR
398 #define	_NO_FDISK_PRESENT
399 #define	_HAVE_TEM_FIRMWARE
400 
401 /*
402  * The following set of definitions characterize the implementation of
403  * 32-bit Solaris on SPARC V8 systems.
404  */
405 #if defined(__sparcv8)
406 
407 /*
408  * Define the appropriate "processor characteristics"
409  */
410 #define	_LONG_ALIGNMENT			4
411 #define	_LONG_DOUBLE_ALIGNMENT		8
412 #define	_LONG_DOUBLE_COMPLEX_ALIGNMENT	8
413 #define	_POINTER_ALIGNMENT		4
414 #define	_MAX_ALIGNMENT			8
415 
416 #define	_LONG_LONG_ALIGNMENT_32		_LONG_LONG_ALIGNMENT
417 
418 /*
419  * Define the appropriate "implementation choices"
420  */
421 #define	_ILP32
422 #if !defined(_I32LPx) && defined(_KERNEL)
423 #define	_I32LPx
424 #endif
425 
426 /*
427  * The following set of definitions characterize the implementation of
428  * 64-bit Solaris on SPARC V9 systems.
429  */
430 #elif defined(__sparcv9)
431 
432 /*
433  * Define the appropriate "processor characteristics"
434  */
435 #define	_LONG_ALIGNMENT			8
436 #define	_LONG_DOUBLE_ALIGNMENT		16
437 #define	_LONG_DOUBLE_COMPLEX_ALIGNMENT	16
438 #define	_POINTER_ALIGNMENT		8
439 #define	_MAX_ALIGNMENT			16
440 
441 #define	_LONG_LONG_ALIGNMENT_32		_LONG_LONG_ALIGMENT
442 
443 /*
444  * Define the appropriate "implementation choices"
445  */
446 #if !defined(_LP64)
447 #define	_LP64
448 #endif
449 #if !defined(_I32LPx)
450 #define	_I32LPx
451 #endif
452 #define	_MULTI_DATAMODEL
453 
454 #else
455 #error	"unknown SPARC version"
456 #endif
457 
458 /*
459  * #error is strictly ansi-C, but works as well as anything for K&R systems.
460  */
461 #else
462 #error "ISA not supported"
463 #endif
464 
465 #if defined(_ILP32) && defined(_LP64)
466 #error "Both _ILP32 and _LP64 are defined"
467 #endif
468 
469 #ifdef	__cplusplus
470 }
471 #endif
472 
473 #endif	/* _SYS_ISA_DEFS_H */
474