]> git.saurik.com Git - apple/xnu.git/blame - osfmk/ppc/cpu_capabilities.h
xnu-792.17.14.tar.gz
[apple/xnu.git] / osfmk / ppc / cpu_capabilities.h
CommitLineData
43866e37 1/*
8f6c56a5 2 * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
43866e37 3 *
8f6c56a5 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
43866e37 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@
43866e37 27 */
91447636 28#ifdef PRIVATE
43866e37
A
29
30#ifndef _PPC_CPU_CAPABILITIES_H
31#define _PPC_CPU_CAPABILITIES_H
32
43866e37
A
33/* _cpu_capabilities
34 *
35 * This is the authoritative way to determine from user mode what
36 * implementation-specific processor features are available.
91447636 37 * This API is only supported for Apple internal use.
43866e37
A
38 */
39
40#ifndef __ASSEMBLER__
41
42extern int _cpu_capabilities;
43
44#endif /* __ASSEMBLER__ */
45
46/* Bit definitions for _cpu_capabilities: */
47
48#define kHasAltivec 0x00000001
49#define k64Bit 0x00000002 // 64-bit GPRs
50#define kCache32 0x00000004 // cache line size is 32 bytes
51#define kCache64 0x00000008
52#define kCache128 0x00000010
53#define kDcbaRecommended 0x00000020 // PPC: dcba is available and recommended
91447636 54#define kDcbaAvailable 0x00000040 // PPC: dcba is available (but may or may not be recommended)
43866e37 55#define kDataStreamsRecommended 0x00000080 // PPC: dst, dstt, dstst, dss, and dssall instructions available and recommended
91447636 56#define kDataStreamsAvailable 0x00000100 // PPC: dst, dstt, dstst, dss, and dssall instructions available (may or may not be rec'd)
43866e37 57#define kDcbtStreamsRecommended 0x00000200 // PPC: enhanced dcbt instruction available and recommended
91447636
A
58#define kDcbtStreamsAvailable 0x00000400 // PPC: enhanced dcbt instruction available (but may or may not be recommended)
59#define kFastThreadLocalStorage 0x00000800 // TLS ptr is kept in a user-mode-readable register
43866e37
A
60
61#define kUP 0x00008000 // set if (kNumCPUs == 1)
62#define kNumCPUs 0x00FF0000 // number of CPUs (see _NumCPUs() below)
63
64#define kNumCPUsShift 16 // see _NumCPUs() below
65
66#define kHasGraphicsOps 0x08000000 // PPC: has fres, frsqrte, and fsel instructions
67#define kHasStfiwx 0x10000000 // PPC: has stfiwx instruction
68#define kHasFsqrt 0x20000000 // PPC: has fsqrt and fsqrts instructions
69
70#ifndef __ASSEMBLER__
71
72static __inline__ int _NumCPUs( void ) { return (_cpu_capabilities & kNumCPUs) >> kNumCPUsShift; }
73
74#endif /* __ASSEMBLER__ */
55e303ae
A
75
76
77/*
78 * The shared kernel/user "comm page(s)":
79 *
80 * The last eight pages of every address space are reserved for the kernel/user
81 * "comm area". Because they can be addressed via a sign-extended 16-bit field,
82 * it is particularly efficient to access code or data in the comm area with
83 * absolute branches (ba, bla, bca) or absolute load/stores ("lwz r0,-4096(0)").
84 * Because the comm area can be reached from anywhere, dyld is not needed.
85 * Although eight pages are reserved, presently only two are populated and mapped.
86 *
87 * Routines on the comm page(s) can be thought of as the firmware for extended processor
88 * instructions, whose opcodes are special forms of "bla". Ie, they are cpu
89 * capabilities. During system initialization, the kernel populates the comm page with
90 * code customized for the particular processor and platform.
91 *
92 * Because Mach VM cannot map the last page of an address space, the max length of
93 * the comm area is seven pages.
94 */
95
96#define _COMM_PAGE_BASE_ADDRESS (-8*4096) // start at page -8, ie 0xFFFF8000
97#define _COMM_PAGE_AREA_LENGTH ( 7*4096) // reserved length of entire comm area
98#define _COMM_PAGE_AREA_USED ( 2*4096) // we use two pages so far
91447636
A
99
100/* The Objective-C runtime fixed address page to optimize message dispatch */
101#define _OBJC_PAGE_BASE_ADDRESS (-20*4096) // start at page -20, ie 0xFFFEC000
55e303ae
A
102
103/* data in the comm page */
104
105#define _COMM_PAGE_SIGNATURE (_COMM_PAGE_BASE_ADDRESS+0x000) // first few bytes are a signature
106#define _COMM_PAGE_VERSION (_COMM_PAGE_BASE_ADDRESS+0x01E) // 16-bit version#
91447636 107#define _COMM_PAGE_THIS_VERSION 2 // this is version 2 of the commarea format
55e303ae
A
108
109#define _COMM_PAGE_CPU_CAPABILITIES (_COMM_PAGE_BASE_ADDRESS+0x020) // mirror of extern int _cpu_capabilities
110#define _COMM_PAGE_NCPUS (_COMM_PAGE_BASE_ADDRESS+0x021) // number of configured CPUs
111#define _COMM_PAGE_ALTIVEC (_COMM_PAGE_BASE_ADDRESS+0x024) // nonzero if Altivec available
112#define _COMM_PAGE_64_BIT (_COMM_PAGE_BASE_ADDRESS+0x025) // nonzero if 64-bit processor
113#define _COMM_PAGE_CACHE_LINESIZE (_COMM_PAGE_BASE_ADDRESS+0x026) // cache line size (16-bit field)
114
91447636 115#define _COMM_PAGE_UNUSED1 (_COMM_PAGE_BASE_ADDRESS+0x028) // 24 unused bytes
55e303ae
A
116
117#define _COMM_PAGE_2_TO_52 (_COMM_PAGE_BASE_ADDRESS+0x040) // double float constant 2**52
118#define _COMM_PAGE_10_TO_6 (_COMM_PAGE_BASE_ADDRESS+0x048) // double float constant 10**6
91447636
A
119#define _COMM_PAGE_MAGIC_FE (_COMM_PAGE_BASE_ADDRESS+0x050) // magic constant 0xFEFEFEFEFEFEFEFF (to find 0s)
120#define _COMM_PAGE_MAGIC_80 (_COMM_PAGE_BASE_ADDRESS+0x058) // magic constant 0x8080808080808080 (to find 0s)
55e303ae
A
121
122#define _COMM_PAGE_TIMEBASE (_COMM_PAGE_BASE_ADDRESS+0x060) // used by gettimeofday()
123#define _COMM_PAGE_TIMESTAMP (_COMM_PAGE_BASE_ADDRESS+0x068) // used by gettimeofday()
124#define _COMM_PAGE_SEC_PER_TICK (_COMM_PAGE_BASE_ADDRESS+0x070) // used by gettimeofday()
125
55e303ae
A
126 /* jump table (bla to this address, which may be a branch to the actual code somewhere else) */
127 /* When new jump table entries are added, corresponding symbols should be added below */
128
91447636
A
129#define _COMM_PAGE_COMPARE_AND_SWAP32 (_COMM_PAGE_BASE_ADDRESS+0x080) // compare-and-swap word, no barrier
130#define _COMM_PAGE_COMPARE_AND_SWAP64 (_COMM_PAGE_BASE_ADDRESS+0x0c0) // compare-and-swap doubleword, no barrier
131#define _COMM_PAGE_ENQUEUE (_COMM_PAGE_BASE_ADDRESS+0x100) // enqueue
132#define _COMM_PAGE_DEQUEUE (_COMM_PAGE_BASE_ADDRESS+0x140) // dequeue
133#define _COMM_PAGE_MEMORY_BARRIER (_COMM_PAGE_BASE_ADDRESS+0x180) // memory barrier
134#define _COMM_PAGE_ATOMIC_ADD32 (_COMM_PAGE_BASE_ADDRESS+0x1a0) // add atomic word
135#define _COMM_PAGE_ATOMIC_ADD64 (_COMM_PAGE_BASE_ADDRESS+0x1c0) // add atomic doubleword
136
137#define _COMM_PAGE_UNUSED3 (_COMM_PAGE_BASE_ADDRESS+0x1e0) // 32 unused bytes
138
55e303ae
A
139#define _COMM_PAGE_ABSOLUTE_TIME (_COMM_PAGE_BASE_ADDRESS+0x200) // mach_absolute_time()
140#define _COMM_PAGE_SPINLOCK_TRY (_COMM_PAGE_BASE_ADDRESS+0x220) // spinlock_try()
141#define _COMM_PAGE_SPINLOCK_LOCK (_COMM_PAGE_BASE_ADDRESS+0x260) // spinlock_lock()
142#define _COMM_PAGE_SPINLOCK_UNLOCK (_COMM_PAGE_BASE_ADDRESS+0x2a0) // spinlock_unlock()
143#define _COMM_PAGE_PTHREAD_GETSPECIFIC (_COMM_PAGE_BASE_ADDRESS+0x2c0) // pthread_getspecific()
144#define _COMM_PAGE_GETTIMEOFDAY (_COMM_PAGE_BASE_ADDRESS+0x2e0) // used by gettimeofday()
145#define _COMM_PAGE_FLUSH_DCACHE (_COMM_PAGE_BASE_ADDRESS+0x4e0) // sys_dcache_flush()
146#define _COMM_PAGE_FLUSH_ICACHE (_COMM_PAGE_BASE_ADDRESS+0x520) // sys_icache_invalidate()
147#define _COMM_PAGE_PTHREAD_SELF (_COMM_PAGE_BASE_ADDRESS+0x580) // pthread_self()
91447636 148
55e303ae 149#define _COMM_PAGE_UNUSED4 (_COMM_PAGE_BASE_ADDRESS+0x5a0) // 32 unused bytes
91447636 150
55e303ae
A
151#define _COMM_PAGE_RELINQUISH (_COMM_PAGE_BASE_ADDRESS+0x5c0) // used by spinlocks
152
153#define _COMM_PAGE_UNUSED5 (_COMM_PAGE_BASE_ADDRESS+0x5e0) // 32 unused bytes
154
155#define _COMM_PAGE_BZERO (_COMM_PAGE_BASE_ADDRESS+0x600) // bzero()
156#define _COMM_PAGE_BCOPY (_COMM_PAGE_BASE_ADDRESS+0x780) // bcopy()
157#define _COMM_PAGE_MEMCPY (_COMM_PAGE_BASE_ADDRESS+0x7a0) // memcpy()
158#define _COMM_PAGE_MEMMOVE (_COMM_PAGE_BASE_ADDRESS+0x7a0) // memmove()
159
91447636
A
160#define _COMM_PAGE_COMPARE_AND_SWAP32B (_COMM_PAGE_BASE_ADDRESS+0xf80) // compare-and-swap word w barrier
161#define _COMM_PAGE_COMPARE_AND_SWAP64B (_COMM_PAGE_BASE_ADDRESS+0xfc0) // compare-and-swap doubleword w barrier
55e303ae 162
91447636
A
163#define _COMM_PAGE_MEMSET_PATTERN (_COMM_PAGE_BASE_ADDRESS+0x1000)// used by nonzero memset()
164#define _COMM_PAGE_BIGCOPY (_COMM_PAGE_BASE_ADDRESS+0x1140)// very-long-operand copies
55e303ae 165
91447636 166#define _COMM_PAGE_END (_COMM_PAGE_BASE_ADDRESS+0x1700)// end of commpage area
55e303ae
A
167
168#ifdef __ASSEMBLER__
169#ifdef __COMM_PAGE_SYMBOLS
170
171#define CREATE_COMM_PAGE_SYMBOL(symbol_name, symbol_address) \
172 .org (symbol_address - _COMM_PAGE_BASE_ADDRESS) @\
173symbol_name: nop
174
175 .text // Required to make a well behaved symbol file
176
91447636
A
177 CREATE_COMM_PAGE_SYMBOL(___compare_and_swap32, _COMM_PAGE_COMPARE_AND_SWAP32)
178 CREATE_COMM_PAGE_SYMBOL(___compare_and_swap64, _COMM_PAGE_COMPARE_AND_SWAP64)
179 CREATE_COMM_PAGE_SYMBOL(___atomic_enqueue, _COMM_PAGE_ENQUEUE)
180 CREATE_COMM_PAGE_SYMBOL(___atomic_dequeue, _COMM_PAGE_DEQUEUE)
181 CREATE_COMM_PAGE_SYMBOL(___memory_barrier, _COMM_PAGE_MEMORY_BARRIER)
182 CREATE_COMM_PAGE_SYMBOL(___atomic_add32, _COMM_PAGE_ATOMIC_ADD32)
183 CREATE_COMM_PAGE_SYMBOL(___atomic_add64, _COMM_PAGE_ATOMIC_ADD64)
55e303ae
A
184 CREATE_COMM_PAGE_SYMBOL(___mach_absolute_time, _COMM_PAGE_ABSOLUTE_TIME)
185 CREATE_COMM_PAGE_SYMBOL(___spin_lock_try, _COMM_PAGE_SPINLOCK_TRY)
186 CREATE_COMM_PAGE_SYMBOL(___spin_lock, _COMM_PAGE_SPINLOCK_LOCK)
187 CREATE_COMM_PAGE_SYMBOL(___spin_unlock, _COMM_PAGE_SPINLOCK_UNLOCK)
188 CREATE_COMM_PAGE_SYMBOL(___pthread_getspecific, _COMM_PAGE_PTHREAD_GETSPECIFIC)
189 CREATE_COMM_PAGE_SYMBOL(___gettimeofday, _COMM_PAGE_GETTIMEOFDAY)
190 CREATE_COMM_PAGE_SYMBOL(___sys_dcache_flush, _COMM_PAGE_FLUSH_DCACHE)
191 CREATE_COMM_PAGE_SYMBOL(___sys_icache_invalidate, _COMM_PAGE_FLUSH_ICACHE)
192 CREATE_COMM_PAGE_SYMBOL(___pthread_self, _COMM_PAGE_PTHREAD_SELF)
193 CREATE_COMM_PAGE_SYMBOL(___spin_lock_relinquish, _COMM_PAGE_RELINQUISH)
194 CREATE_COMM_PAGE_SYMBOL(___bzero, _COMM_PAGE_BZERO)
195 CREATE_COMM_PAGE_SYMBOL(___bcopy, _COMM_PAGE_BCOPY)
196 CREATE_COMM_PAGE_SYMBOL(___memcpy, _COMM_PAGE_MEMCPY)
197// CREATE_COMM_PAGE_SYMBOL(___memmove, _COMM_PAGE_MEMMOVE)
91447636
A
198 CREATE_COMM_PAGE_SYMBOL(___compare_and_swap32b, _COMM_PAGE_COMPARE_AND_SWAP32B)
199 CREATE_COMM_PAGE_SYMBOL(___compare_and_swap64b, _COMM_PAGE_COMPARE_AND_SWAP64B)
200 CREATE_COMM_PAGE_SYMBOL(___memset_pattern, _COMM_PAGE_MEMSET_PATTERN)
55e303ae 201 CREATE_COMM_PAGE_SYMBOL(___bigcopy, _COMM_PAGE_BIGCOPY)
91447636 202
55e303ae
A
203 CREATE_COMM_PAGE_SYMBOL(___end_comm_page, _COMM_PAGE_END)
204
205 .data // Required to make a well behaved symbol file
206 .long 0 // Required to make a well behaved symbol file
207
208#endif /* __COMM_PAGE_SYMBOLS */
209#endif /* __ASSEMBLER__ */
210
43866e37 211#endif /* _PPC_CPU_CAPABILITIES_H */
91447636 212#endif /* PRIVATE */