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