]> git.saurik.com Git - apple/xnu.git/blame - osfmk/i386/machine_routines.h
xnu-4903.231.4.tar.gz
[apple/xnu.git] / osfmk / i386 / machine_routines.h
CommitLineData
1c79356b 1/*
b0d623f7 2 * Copyright (c) 2000-2009 Apple 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 * @OSF_COPYRIGHT@
30 */
31
32#ifndef _I386_MACHINE_ROUTINES_H_
33#define _I386_MACHINE_ROUTINES_H_
34
35#include <mach/mach_types.h>
36#include <mach/boolean.h>
37#include <kern/kern_types.h>
38#include <pexpert/pexpert.h>
39
91447636 40#include <sys/cdefs.h>
9bccf70c 41#include <sys/appleapiopts.h>
1c79356b 42
5ba3f43e
A
43#include <stdarg.h>
44
91447636
A
45__BEGIN_DECLS
46
b0d623f7
A
47#ifdef XNU_KERNEL_PRIVATE
48
0c530ab8
A
49/* are we a 64 bit platform ? */
50
51boolean_t ml_is64bit(void);
52
53/* is this a 64bit thread? */
54
55boolean_t ml_thread_is64bit(thread_t);
56
57/* is this a 64bit thread? */
58
59boolean_t ml_state_is64bit(void *);
60
61/* set state of fpu save area for signal handling */
62
63void ml_fp_setvalid(boolean_t);
64
65void ml_cpu_set_ldt(int);
66
1c79356b
A
67/* Interrupt handling */
68
55e303ae
A
69/* Initialize Interrupts */
70void ml_init_interrupt(void);
71
1c79356b
A
72/* Generate a fake interrupt */
73void ml_cause_interrupt(void);
74
b0d623f7
A
75/* Initialize Interrupts */
76void ml_install_interrupt_handler(
77 void *nub,
78 int source,
79 void *target,
80 IOInterruptHandler handler,
81 void *refCon);
82
fe8ab488
A
83void ml_entropy_collect(void);
84
5ba3f43e 85uint64_t ml_get_timebase(void);
0c530ab8 86void ml_init_lock_timeout(void);
bd504ef0 87void ml_init_delay_spin_threshold(int);
316670eb
A
88
89boolean_t ml_delay_should_spin(uint64_t interval);
d52fe63f 90
e8c3f781
A
91extern void ml_delay_on_yield(void);
92
b0d623f7
A
93vm_offset_t
94ml_static_ptovirt(
95 vm_offset_t);
96
97void ml_static_mfree(
98 vm_offset_t,
99 vm_size_t);
100
101/* boot memory allocation */
102vm_offset_t ml_static_malloc(
103 vm_size_t size);
104
d9a64523
A
105vm_offset_t ml_static_slide(
106 vm_offset_t vaddr);
107
108vm_offset_t ml_static_unslide(
109 vm_offset_t vaddr);
110
b0d623f7
A
111/* virtual to physical on wired pages */
112vm_offset_t ml_vtophys(
113 vm_offset_t vaddr);
114
115vm_size_t ml_nofault_copy(
116 vm_offset_t virtsrc, vm_offset_t virtdst, vm_size_t size);
117
39236c6e
A
118boolean_t ml_validate_nofault(
119 vm_offset_t virtsrc, vm_size_t size);
120
b0d623f7
A
121/* Machine topology info */
122uint64_t ml_cpu_cache_size(unsigned int level);
123uint64_t ml_cpu_cache_sharing(unsigned int level);
124
125/* Initialize the maximum number of CPUs */
126void ml_init_max_cpus(
127 unsigned long max_cpus);
128
129extern void ml_cpu_up(void);
130extern void ml_cpu_down(void);
131
132void bzero_phys_nc(
133 addr64_t phys_address,
134 uint32_t length);
39236c6e
A
135extern uint32_t interrupt_timer_coalescing_enabled;
136extern uint32_t idle_entry_timer_processing_hdeadline_threshold;
137
138#if TCOAL_INSTRUMENT
139#define TCOAL_DEBUG KERNEL_DEBUG_CONSTANT
140#else
141#define TCOAL_DEBUG(x, a, b, c, d, e) do { } while(0)
142#endif /* TCOAL_INSTRUMENT */
b0d623f7
A
143
144#if defined(PEXPERT_KERNEL_PRIVATE) || defined(MACH_KERNEL_PRIVATE)
145/* IO memory map services */
146
147/* Map memory map IO space */
148vm_offset_t ml_io_map(
149 vm_offset_t phys_addr,
150 vm_size_t size);
151
b0d623f7
A
152
153void ml_get_bouncepool_info(
154 vm_offset_t *phys_addr,
155 vm_size_t *size);
060df5ea
A
156/* Indicates if spinlock, IPI and other timeouts should be suspended */
157boolean_t machine_timeout_suspended(void);
39037602 158void plctrace_disable(void);
b0d623f7
A
159#endif /* PEXPERT_KERNEL_PRIVATE || MACH_KERNEL_PRIVATE */
160
6d2010ae
A
161/* Warm up a CPU to receive an interrupt */
162kern_return_t ml_interrupt_prewarm(uint64_t deadline);
060df5ea 163
5ba3f43e
A
164/* Check if the machine layer wants to intercept a panic call */
165boolean_t ml_wants_panic_trap_to_debugger(void);
166
167/* Machine layer routine for intercepting panics */
168void ml_panic_trap_to_debugger(const char *panic_format_str,
169 va_list *panic_args,
170 unsigned int reason,
171 void *ctx,
172 uint64_t panic_options_mask,
173 unsigned long panic_caller);
b0d623f7
A
174#endif /* XNU_KERNEL_PRIVATE */
175
176#ifdef KERNEL_PRIVATE
177
55e303ae
A
178/* Type for the Time Base Enable function */
179typedef void (*time_base_enable_t)(cpu_id_t cpu_id, boolean_t enable);
180
9bccf70c
A
181/* Type for the IPI Hander */
182typedef void (*ipi_handler_t)(void);
183
55e303ae
A
184/* Struct for ml_processor_register */
185struct ml_processor_info {
186 cpu_id_t cpu_id;
187 boolean_t boot_cpu;
188 vm_offset_t start_paddr;
189 boolean_t supports_nap;
190 unsigned long l2cr_value;
191 time_base_enable_t time_base_enable;
192};
193
194typedef struct ml_processor_info ml_processor_info_t;
195
91447636 196
9bccf70c 197/* Register a processor */
b0d623f7
A
198kern_return_t
199ml_processor_register(
200 cpu_id_t cpu_id,
201 uint32_t lapic_id,
202 processor_t *processor_out,
203 boolean_t boot_cpu,
204 boolean_t start );
0c530ab8 205
43866e37
A
206/* PCI config cycle probing */
207boolean_t ml_probe_read(
208 vm_offset_t paddr,
209 unsigned int *val);
55e303ae
A
210boolean_t ml_probe_read_64(
211 addr64_t paddr,
212 unsigned int *val);
43866e37
A
213
214/* Read physical address byte */
215unsigned int ml_phys_read_byte(
216 vm_offset_t paddr);
55e303ae
A
217unsigned int ml_phys_read_byte_64(
218 addr64_t paddr);
43866e37
A
219
220/* Read physical address half word */
221unsigned int ml_phys_read_half(
222 vm_offset_t paddr);
55e303ae
A
223unsigned int ml_phys_read_half_64(
224 addr64_t paddr);
43866e37
A
225
226/* Read physical address word*/
227unsigned int ml_phys_read(
228 vm_offset_t paddr);
55e303ae
A
229unsigned int ml_phys_read_64(
230 addr64_t paddr);
43866e37
A
231unsigned int ml_phys_read_word(
232 vm_offset_t paddr);
55e303ae
A
233unsigned int ml_phys_read_word_64(
234 addr64_t paddr);
43866e37
A
235
236/* Read physical address double word */
237unsigned long long ml_phys_read_double(
238 vm_offset_t paddr);
55e303ae
A
239unsigned long long ml_phys_read_double_64(
240 addr64_t paddr);
43866e37 241
813fb2f6
A
242unsigned long long ml_io_read(uintptr_t iovaddr, int iovsz);
243unsigned int ml_io_read8(uintptr_t iovaddr);
244unsigned int ml_io_read16(uintptr_t iovaddr);
245unsigned int ml_io_read32(uintptr_t iovaddr);
246unsigned long long ml_io_read64(uintptr_t iovaddr);
247
43866e37
A
248/* Write physical address byte */
249void ml_phys_write_byte(
250 vm_offset_t paddr, unsigned int data);
55e303ae
A
251void ml_phys_write_byte_64(
252 addr64_t paddr, unsigned int data);
43866e37
A
253
254/* Write physical address half word */
255void ml_phys_write_half(
256 vm_offset_t paddr, unsigned int data);
55e303ae
A
257void ml_phys_write_half_64(
258 addr64_t paddr, unsigned int data);
43866e37
A
259
260/* Write physical address word */
261void ml_phys_write(
262 vm_offset_t paddr, unsigned int data);
55e303ae
A
263void ml_phys_write_64(
264 addr64_t paddr, unsigned int data);
43866e37
A
265void ml_phys_write_word(
266 vm_offset_t paddr, unsigned int data);
55e303ae
A
267void ml_phys_write_word_64(
268 addr64_t paddr, unsigned int data);
43866e37
A
269
270/* Write physical address double word */
271void ml_phys_write_double(
272 vm_offset_t paddr, unsigned long long data);
55e303ae
A
273void ml_phys_write_double_64(
274 addr64_t paddr, unsigned long long data);
43866e37 275
43866e37
A
276/* Struct for ml_cpu_get_info */
277struct ml_cpu_info {
6d2010ae
A
278 uint32_t vector_unit;
279 uint32_t cache_line_size;
280 uint32_t l1_icache_size;
281 uint32_t l1_dcache_size;
282 uint32_t l2_settings;
283 uint32_t l2_cache_size;
284 uint32_t l3_settings;
285 uint32_t l3_cache_size;
43866e37
A
286};
287
288typedef struct ml_cpu_info ml_cpu_info_t;
289
290/* Get processor info */
91447636 291void ml_cpu_get_info(ml_cpu_info_t *ml_cpu_info);
43866e37 292
9bccf70c
A
293void ml_thread_policy(
294 thread_t thread,
295 unsigned policy_id,
296 unsigned policy_info);
1c79356b 297
9bccf70c
A
298#define MACHINE_GROUP 0x00000001
299#define MACHINE_NETWORK_GROUP 0x10000000
300#define MACHINE_NETWORK_WORKLOOP 0x00000001
301#define MACHINE_NETWORK_NETISR 0x00000002
1c79356b 302
43866e37
A
303/* Return the maximum number of CPUs set by ml_init_max_cpus() */
304int ml_get_max_cpus(
305 void);
306
2d21ac55
A
307/*
308 * The following are in pmCPU.c not machine_routines.c.
309 */
0c530ab8
A
310extern void ml_set_maxsnoop(uint32_t maxdelay);
311extern unsigned ml_get_maxsnoop(void);
312extern void ml_set_maxbusdelay(uint32_t mdelay);
313extern uint32_t ml_get_maxbusdelay(void);
593a1d5f
A
314extern void ml_set_maxintdelay(uint64_t mdelay);
315extern uint64_t ml_get_maxintdelay(void);
6d2010ae 316extern boolean_t ml_get_interrupt_prewake_applicable(void);
2d21ac55
A
317
318
0c530ab8
A
319extern uint64_t tmrCvt(uint64_t time, uint64_t conversion);
320
2d21ac55
A
321extern uint64_t ml_cpu_int_event_time(void);
322
b0d623f7
A
323#endif /* KERNEL_PRIVATE */
324
325/* Get Interrupts Enabled */
326boolean_t ml_get_interrupts_enabled(void);
327
328/* Set Interrupts Enabled */
329boolean_t ml_set_interrupts_enabled(boolean_t enable);
330
331/* Check if running at interrupt context */
332boolean_t ml_at_interrupt_context(void);
333
5ba3f43e
A
334#ifdef XNU_KERNEL_PRIVATE
335extern boolean_t ml_is_quiescing(void);
336extern void ml_set_is_quiescing(boolean_t);
337extern uint64_t ml_get_booter_memory_size(void);
338#endif
339
b0d623f7
A
340/* Zero bytes starting at a physical address */
341void bzero_phys(
342 addr64_t phys_address,
343 uint32_t length);
344
345/* Bytes available on current stack */
346vm_offset_t ml_stack_remaining(void);
347
91447636 348__END_DECLS
813fb2f6
A
349#if defined(MACH_KERNEL_PRIVATE)
350__private_extern__ uint64_t
351ml_phys_read_data(uint64_t paddr, int psz);
352__private_extern__ void
353pmap_verify_noncacheable(uintptr_t vaddr);
354#endif /* MACH_KERNEL_PRIVATE */
6d2010ae 355#ifdef XNU_KERNEL_PRIVATE
316670eb 356
6d2010ae 357boolean_t ml_fpu_avx_enabled(void);
5ba3f43e
A
358#if !defined(RC_HIDE_XNU_J137)
359boolean_t ml_fpu_avx512_enabled(void);
360#endif
316670eb 361
6d2010ae
A
362void interrupt_latency_tracker_setup(void);
363void interrupt_reset_latency_stats(void);
364void interrupt_populate_latency_stats(char *, unsigned);
4b17d6b6 365void ml_get_power_state(boolean_t *, boolean_t *);
060df5ea 366
39236c6e
A
367void timer_queue_expire_local(void*);
368void timer_queue_expire_rescan(void*);
369void ml_timer_evaluate(void);
370boolean_t ml_timer_forced_evaluation(void);
39236c6e 371
39037602 372uint64_t ml_energy_stat(thread_t);
fe8ab488
A
373void ml_gpu_stat_update(uint64_t);
374uint64_t ml_gpu_stat(thread_t);
143464d5 375boolean_t ml_recent_wake(void);
3e170ce0
A
376
377extern uint64_t reportphyreaddelayabs;
378extern uint32_t reportphyreadosbt;
813fb2f6 379extern uint32_t phyreadpanic;
3e170ce0 380
6d2010ae 381#endif /* XNU_KERNEL_PRIVATE */
1c79356b 382#endif /* _I386_MACHINE_ROUTINES_H_ */