osfmk/i386/machine_routines.h

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