osfmk/i386/machine_routines.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * @OSF_COPYRIGHT@
  32  */
  33
  34 #ifndef _I386_MACHINE_ROUTINES_H_
  35 #define _I386_MACHINE_ROUTINES_H_
  36
  37 #include <mach/mach_types.h>
  38 #include <mach/boolean.h>
  39 #include <kern/kern_types.h>
  40 #include <pexpert/pexpert.h>
  41
  42 #include <sys/cdefs.h>
  43 #include <sys/appleapiopts.h>
  44
  45 __BEGIN_DECLS
  46
  47 /* Interrupt handling */
  48
  49 /* Initialize Interrupts */
  50 void    ml_init_interrupt(void);
  51
  52 /* Get Interrupts Enabled */
  53 boolean_t ml_get_interrupts_enabled(void);
  54
  55 /* Set Interrupts Enabled */
  56 boolean_t ml_set_interrupts_enabled(boolean_t enable);
  57
  58 /* Check if running at interrupt context */
  59 boolean_t ml_at_interrupt_context(void);
  60
  61 /* Generate a fake interrupt */
  62 void ml_cause_interrupt(void);
  63
  64 void ml_get_timebase(unsigned long long *timestamp);
  65
  66 /* Type for the Time Base Enable function */
  67 typedef void (*time_base_enable_t)(cpu_id_t cpu_id, boolean_t enable);
  68
  69 /* Type for the IPI Hander */
  70 typedef void (*ipi_handler_t)(void);
  71
  72 /* Struct for ml_processor_register */
  73 struct ml_processor_info {
  74         cpu_id_t                        cpu_id;
  75         boolean_t                       boot_cpu;
  76         vm_offset_t                     start_paddr;
  77         boolean_t                       supports_nap;
  78         unsigned long           l2cr_value;
  79         time_base_enable_t      time_base_enable;
  80 };
  81
  82 typedef struct ml_processor_info ml_processor_info_t;
  83
  84
  85 /* Register a processor */
  86 kern_return_t ml_processor_register(
  87         cpu_id_t cpu_id,
  88         uint32_t lapic_id,
  89         processor_t *processor,
  90         ipi_handler_t *ipi_handler,
  91         boolean_t boot_cpu);
  92
  93 /* Initialize Interrupts */
  94 void ml_install_interrupt_handler(
  95     void *nub,
  96     int source,
  97     void *target,
  98     IOInterruptHandler handler,
  99     void *refCon);
 100
 101 #ifdef __APPLE_API_UNSTABLE
 102 vm_offset_t
 103 ml_static_ptovirt(
 104         vm_offset_t);
 105
 106 /* PCI config cycle probing */
 107 boolean_t ml_probe_read(
 108         vm_offset_t paddr,
 109         unsigned int *val);
 110 boolean_t ml_probe_read_64(
 111         addr64_t paddr,
 112         unsigned int *val);
 113
 114 /* Read physical address byte */
 115 unsigned int ml_phys_read_byte(
 116         vm_offset_t paddr);
 117 unsigned int ml_phys_read_byte_64(
 118         addr64_t paddr);
 119
 120 /* Read physical address half word */
 121 unsigned int ml_phys_read_half(
 122         vm_offset_t paddr);
 123 unsigned int ml_phys_read_half_64(
 124         addr64_t paddr);
 125
 126 /* Read physical address word*/
 127 unsigned int ml_phys_read(
 128         vm_offset_t paddr);
 129 unsigned int ml_phys_read_64(
 130         addr64_t paddr);
 131 unsigned int ml_phys_read_word(
 132         vm_offset_t paddr);
 133 unsigned int ml_phys_read_word_64(
 134         addr64_t paddr);
 135
 136 /* Read physical address double word */
 137 unsigned long long ml_phys_read_double(
 138         vm_offset_t paddr);
 139 unsigned long long ml_phys_read_double_64(
 140         addr64_t paddr);
 141
 142 /* Write physical address byte */
 143 void ml_phys_write_byte(
 144         vm_offset_t paddr, unsigned int data);
 145 void ml_phys_write_byte_64(
 146         addr64_t paddr, unsigned int data);
 147
 148 /* Write physical address half word */
 149 void ml_phys_write_half(
 150         vm_offset_t paddr, unsigned int data);
 151 void ml_phys_write_half_64(
 152         addr64_t paddr, unsigned int data);
 153
 154 /* Write physical address word */
 155 void ml_phys_write(
 156         vm_offset_t paddr, unsigned int data);
 157 void ml_phys_write_64(
 158         addr64_t paddr, unsigned int data);
 159 void ml_phys_write_word(
 160         vm_offset_t paddr, unsigned int data);
 161 void ml_phys_write_word_64(
 162         addr64_t paddr, unsigned int data);
 163
 164 /* Write physical address double word */
 165 void ml_phys_write_double(
 166         vm_offset_t paddr, unsigned long long data);
 167 void ml_phys_write_double_64(
 168         addr64_t paddr, unsigned long long data);
 169
 170 void ml_static_mfree(
 171         vm_offset_t,
 172         vm_size_t);
 173
 174 /* virtual to physical on wired pages */
 175 vm_offset_t ml_vtophys(
 176         vm_offset_t vaddr);
 177
 178 /* Struct for ml_cpu_get_info */
 179 struct ml_cpu_info {
 180         unsigned long           vector_unit;
 181         unsigned long           cache_line_size;
 182         unsigned long           l1_icache_size;
 183         unsigned long           l1_dcache_size;
 184         unsigned long           l2_settings;
 185         unsigned long           l2_cache_size;
 186         unsigned long           l3_settings;
 187         unsigned long           l3_cache_size;
 188 };
 189
 190 typedef struct ml_cpu_info ml_cpu_info_t;
 191
 192 /* Get processor info */
 193 void ml_cpu_get_info(ml_cpu_info_t *ml_cpu_info);
 194
 195 #endif /* __APPLE_API_UNSTABLE */
 196
 197 #ifdef __APPLE_API_PRIVATE
 198 #if     defined(PEXPERT_KERNEL_PRIVATE) || defined(MACH_KERNEL_PRIVATE)
 199 /* IO memory map services */
 200
 201 /* Map memory map IO space */
 202 vm_offset_t ml_io_map(
 203         vm_offset_t phys_addr,
 204         vm_size_t size);
 205
 206 /* boot memory allocation */
 207 vm_offset_t ml_static_malloc(
 208         vm_size_t size);
 209
 210 #endif /* PEXPERT_KERNEL_PRIVATE || MACH_KERNEL_PRIVATE  */
 211
 212 /* Zero bytes starting at a physical address */
 213 void bzero_phys(
 214         addr64_t phys_address,
 215         uint32_t length);
 216
 217 void ml_thread_policy(
 218         thread_t thread,
 219         unsigned policy_id,
 220         unsigned policy_info);
 221
 222 #define MACHINE_GROUP                                   0x00000001
 223 #define MACHINE_NETWORK_GROUP                   0x10000000
 224 #define MACHINE_NETWORK_WORKLOOP                0x00000001
 225 #define MACHINE_NETWORK_NETISR                  0x00000002
 226
 227 /* Initialize the maximum number of CPUs */
 228 void ml_init_max_cpus(
 229         unsigned long max_cpus);
 230
 231 /* Return the maximum number of CPUs set by ml_init_max_cpus() */
 232 int ml_get_max_cpus(
 233         void);
 234
 235 extern void     ml_cpu_up(void);
 236 extern void     ml_cpu_down(void);
 237
 238 extern int      set_be_bit(void);
 239 extern int      clr_be_bit(void);
 240 extern int      be_tracing(void);
 241
 242 #endif /* __APPLE_API_PRIVATE */
 243
 244 __END_DECLS
 245
 246 #endif /* _I386_MACHINE_ROUTINES_H_ */