]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/ppc/machine_routines.h
xnu-1504.9.37.tar.gz
[apple/xnu.git] / osfmk / ppc / machine_routines.h
index ff4b5e34b031334bda60fd2b290ec55a49a84181..3fcaf77ef0e7c0e7791dc1c5d229ea3eb79432e1 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * @OSF_COPYRIGHT@
 #include <kern/kern_types.h>
 #include <pexpert/pexpert.h>
 
+#include <sys/cdefs.h>
 #include <sys/appleapiopts.h>
 
+__BEGIN_DECLS
+
 /* Get Interrupts Enabled */
-boolean_t ml_get_interrupts_enabled(void);
+extern boolean_t       ml_get_interrupts_enabled(
+                                               void);
 
 /* Set Interrupts Enabled */
-boolean_t ml_set_interrupts_enabled(boolean_t enable);
+extern boolean_t       ml_set_interrupts_enabled(
+                                               boolean_t                               enable);
 
 /* Check if running at interrupt context */
-boolean_t ml_at_interrupt_context(void);
+extern boolean_t       ml_at_interrupt_context(
+                                               void);
+
+#ifdef KERNEL_PRIVATE
 
 /* Generate a fake interrupt */
-void ml_cause_interrupt(void);
+extern void                    ml_cause_interrupt(
+                                               void);
 
 /* Type for the IPI Hander */
 typedef void (*ipi_handler_t)(void);
@@ -52,139 +67,227 @@ typedef void (*ipi_handler_t)(void);
 typedef void (*time_base_enable_t)(cpu_id_t cpu_id, boolean_t enable);
 
 /* enables (or disables) the processor nap mode the function returns the previous value*/
-boolean_t ml_enable_nap(
-        int target_cpu,
-        boolean_t nap_enabled);
+extern boolean_t       ml_enable_nap(
+                                               int                                             target_cpu,
+                                               boolean_t                               nap_enabled);
 
 /* Put the processor to sleep */
-void ml_ppc_sleep(void);
-void ml_get_timebase(unsigned long long *timstamp);
-void ml_sense__nmi(void);
+extern void                    ml_ppc_sleep(
+                                               void);
 
-int ml_enable_cache_level(int cache_level, int enable);
+extern void                    ml_get_timebase(
+                                               unsigned long long              *timstamp);
 
-void ml_static_mfree(
-       vm_offset_t,
-       vm_size_t);
+extern int                     ml_enable_cache_level(
+                                               int                                             cache_level,
+                                               int                                             enable);
+
+extern void                    ml_static_mfree(
+                                               vm_offset_t                             vaddr,
+                                               vm_size_t                               size);
         
 /* Init Interrupts */
-void ml_install_interrupt_handler(
-       void *nub,
-       int source,
-       void *target,
-       IOInterruptHandler handler,
-       void *refCon);
+extern void                    ml_install_interrupt_handler(
+                                               void                                    *nub,
+                                               int                                             source,
+                                               void                                    *target,
+                                               IOInterruptHandler              handler,
+                                               void                                    *refCon);
                
-#ifdef __APPLE_API_UNSTABLE
-
-vm_offset_t
-ml_static_ptovirt(
-       vm_offset_t);
+extern vm_offset_t             ml_static_ptovirt(
+                                                       vm_offset_t                     paddr);
 
 /* virtual to physical on wired pages */
-vm_offset_t ml_vtophys(
-       vm_offset_t vaddr);
+extern vm_offset_t             ml_vtophys(
+                                                       vm_offset_t                     vaddr);
+
+vm_size_t ml_nofault_copy(
+       vm_offset_t virtsrc, vm_offset_t virtdst, vm_size_t size);
 
 /* PCI config cycle probing */
-boolean_t ml_probe_read(
-       vm_offset_t paddr,
-       unsigned int *val);
+extern boolean_t               ml_probe_read(
+                                                       vm_offset_t                     paddr,
+                                                       unsigned int            *val);
+
+extern boolean_t               ml_probe_read_64(
+                                                       addr64_t                        paddr,
+                                                       unsigned int            *val);
 
 /* Read physical address byte */
-unsigned int ml_phys_read_byte(
-       vm_offset_t paddr);
+extern unsigned int            ml_phys_read_byte(
+                                                       vm_offset_t                     paddr);
+
+extern unsigned int            ml_phys_read_byte_64(
+                                                       addr64_t                        paddr);
+
+/* Read physical address half word */
+extern unsigned int            ml_phys_read_half(
+                                                       vm_offset_t                     paddr);
+
+extern unsigned int            ml_phys_read_half_64(
+                                                       addr64_t                        paddr);
+
+/* Read physical address word*/
+extern unsigned int            ml_phys_read(
+                                                       vm_offset_t                     paddr);
 
-/* Read physical address */
-unsigned int ml_phys_read(
-       vm_offset_t paddr);
+extern unsigned int            ml_phys_read_64(
+                                                       addr64_t                        paddr);
+
+extern unsigned int            ml_phys_read_word(
+                                                       vm_offset_t                     paddr);
+
+extern unsigned int            ml_phys_read_word_64(
+                                                       addr64_t                        paddr);
+
+/* Read physical address double word */
+extern unsigned long long ml_phys_read_double(
+                                                       vm_offset_t                     paddr);
+
+extern unsigned long long ml_phys_read_double_64(
+                                                       addr64_t                        paddr);
 
 /* Write physical address byte */
-void ml_phys_write_byte(
-       vm_offset_t paddr, unsigned int data);
+extern void                            ml_phys_write_byte(
+                                                       vm_offset_t                     paddr,
+                                                       unsigned        int             data);
+
+extern void                            ml_phys_write_byte_64(
+                                                               addr64_t                paddr,
+                                                               unsigned int    data);
+
+/* Write physical address half word */
+extern void                            ml_phys_write_half(
+                                                       vm_offset_t                     paddr,
+                                                       unsigned int            data);
+
+extern void                            ml_phys_write_half_64(
+                                                       addr64_t                        paddr,
+                                                       unsigned int            data);
+
+/* Write physical address word */
+extern void                            ml_phys_write(
+                                                       vm_offset_t                     paddr,
+                                                       unsigned int            data);
+
+extern void                            ml_phys_write_64(
+                                                       addr64_t                        paddr,
+                                                       unsigned int            data);
+
+extern void                            ml_phys_write_word(
+                                                       vm_offset_t                     paddr,
+                                                       unsigned int            data);
 
-/* Write physical address */
-void ml_phys_write(
-       vm_offset_t paddr, unsigned int data);
+extern void                            ml_phys_write_word_64(
+                                                       addr64_t                        paddr,
+                                                       unsigned int            data);
+
+/* Write physical address double word */
+extern void                             ml_phys_write_double(
+                                                       vm_offset_t                     paddr,
+                                                       unsigned long long      data);
+
+extern void                            ml_phys_write_double_64(
+                                                       addr64_t paddr,
+                                                       unsigned long long       data);
 
 /* Struct for ml_processor_register */
-struct ml_processor_info_t {
+struct ml_processor_info {
        cpu_id_t                        cpu_id;
        boolean_t                       boot_cpu;
        vm_offset_t                     start_paddr;
        boolean_t                       supports_nap;
-       unsigned long           l2cr_value;
-       time_base_enable_t      time_base_enable;
+       unsigned long                   l2cr_value;
+       time_base_enable_t              time_base_enable;
+       uint32_t                        power_mode_0;
+       uint32_t                        power_mode_1;
 };
 
-typedef struct ml_processor_info_t ml_processor_info_t;
+typedef struct ml_processor_info ml_processor_info_t;
 
 /* Register a processor */
-kern_return_t ml_processor_register(
-       ml_processor_info_t *processor_info,
-       processor_t *processor,
-       ipi_handler_t *ipi_handler);
+extern kern_return_t   ml_processor_register(
+                                                       ml_processor_info_t *ml_processor_info,
+                                                       processor_t                     *processor,
+                                                       ipi_handler_t           *ipi_handler);
 
-#endif /* __APPLE_API_UNSTABLE */
+/* Zero bytes starting at a physical address */
+extern void                            bzero_phys(
+                                                       addr64_t                        phys_address,
+                                                       uint32_t                        length);
 
-#ifdef  __APPLE_API_PRIVATE
-#if    defined(PEXPERT_KERNEL_PRIVATE) || defined(MACH_KERNEL_PRIVATE)
-/* IO memory map services */
+/* Zero bytes starting at a physical address that's uncacheable */
+extern void                            bzero_phys_nc(
+                                                       addr64_t                        phys_address,
+                                                       uint32_t                        length);
 
-/* Map memory map IO space */
-vm_offset_t ml_io_map(
-       vm_offset_t phys_addr, 
-       vm_size_t size);
+/* Bytes available on current stack */
+vm_offset_t ml_stack_remaining(void);
 
-/* boot memory allocation */
-vm_offset_t ml_static_malloc(
-       vm_size_t size);
+#endif /* KERNEL_PRIVATE */
 
-#endif /* PEXPERT_KERNEL_PRIVATE || MACH_KERNEL_PRIVATE */
+#ifdef XNU_KERNEL_PRIVATE
+#if    defined(PEXPERT_KERNEL_PRIVATE) || defined(MACH_KERNEL_PRIVATE)
 
-#ifdef MACH_KERNEL_PRIVATE
-void   ml_init_interrupt(void);
+/* Map memory map IO space */
+extern vm_offset_t             ml_io_map(
+                                                       vm_offset_t                     phys_addr, 
+                                                       vm_size_t                       size);
 
-boolean_t fake_get_interrupts_enabled(void);
+void   ml_get_bouncepool_info(
+        vm_offset_t *phys_addr,
+       vm_size_t   *size);
 
-boolean_t fake_set_interrupts_enabled(
-       boolean_t enable);
 
-/* check pending timers */
-void machine_clock_assist(void);
+/* boot memory allocation */
+extern vm_offset_t             ml_static_malloc(
+                                                       vm_size_t                       size);
 
-void machine_idle(void);
+#endif /* PEXPERT_KERNEL_PRIVATE || MACH_KERNEL_PRIVATE */
 
-void machine_signal_idle(
-       processor_t processor);
 
-void cacheInit(void);
+#ifdef MACH_KERNEL_PRIVATE
+extern void                            ml_init_interrupt(
+                                                       void);
 
-void cacheDisable(void);
+extern void                            cacheInit(
+                                                       void);
 
-void ml_thrm_init(void);
-unsigned int ml_read_temp(void);
+extern void                            cacheDisable(
+                                                       void);
 
-void ml_thrm_set(      
-       unsigned int low, 
-       unsigned int high);
+extern void                            ml_init_lock_timeout(
+                                                       void);
 
-unsigned int ml_throttle(
-       unsigned int);
+void ml_ppc_do_sleep(void);
 
 #endif /* MACH_KERNEL_PRIVATE */
+#endif /* XNU_KERNEL_PRIVATE */
 
-void ml_thread_policy(
-       thread_t thread,
-       unsigned policy_id,
-       unsigned policy_info);
+#ifdef  KERNEL_PRIVATE
+extern void            ml_thread_policy(
+                               thread_t        thread,
+                               unsigned        policy_id,
+                               unsigned        policy_info);
 
 #define MACHINE_GROUP                          0x00000001
 #define MACHINE_NETWORK_GROUP          0x10000000 
 #define MACHINE_NETWORK_WORKLOOP       0x00000001
 #define MACHINE_NETWORK_NETISR         0x00000002
 
-/* Struct for ml_ppc_get_cpu_info */
-struct ml_ppc_cpu_info_t {
+/* Initialize the maximum number of CPUs */
+extern void                            ml_init_max_cpus(
+                                                       unsigned int            max_cpus);
+
+/* Return the maximum number of CPUs set by ml_init_max_cpus() */
+extern unsigned int            ml_get_max_cpus(
+                                                       void);
+
+extern void                    ml_cpu_up(void);
+extern void                    ml_cpu_down(void);
+
+/* Struct for ml_cpu_get_info */
+struct ml_cpu_info {
        unsigned long           vector_unit;
        unsigned long           cache_line_size;
        unsigned long           l1_icache_size;
@@ -195,14 +298,40 @@ struct ml_ppc_cpu_info_t {
        unsigned long           l3_cache_size;
 };
 
-typedef struct ml_ppc_cpu_info_t ml_ppc_cpu_info_t;
+typedef struct ml_cpu_info ml_cpu_info_t;
 
 /* Get processor info */
-void ml_ppc_get_info(ml_ppc_cpu_info_t *cpu_info);
+extern void                            ml_cpu_get_info(
+                                                       ml_cpu_info_t           *ml_cpu_info);
+
+extern void                            ml_set_processor_speed(
+                                                       unsigned long           speed);
+extern void                            ml_set_processor_speed_slave(
+                                                       unsigned long           speed);
+extern void                            ml_set_processor_speed_dpll(
+                                                       unsigned long           speed);
+extern void                            ml_set_processor_speed_dfs(
+                                                       unsigned long           speed);
+extern void                            ml_set_processor_speed_powertune(
+                                                       unsigned long           speed);
+
+extern void                            ml_set_processor_voltage(
+                                                       unsigned long           voltage);
+
+extern unsigned int            ml_scom_write(
+                                                       uint32_t                        reg,
+                                                       uint64_t                        data);
+
+extern unsigned int            ml_scom_read(
+                                                       uint32_t                        reg,
+                                                       uint64_t                        *data);
+
+extern uint32_t                ml_hdec_ratio(void);
+
+extern int boffSettingsInit;
 
-void ml_set_processor_speed(unsigned long speed);
-void ml_set_processor_voltage(unsigned long voltage);
+#endif /* KERNEL_PRIVATE */
 
-#endif /* __APPLE_API_PRIVATE */
+__END_DECLS
 
 #endif /* _PPC_MACHINE_ROUTINES_H_ */