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