1 /* 2 * Copyright (c) 2006-2010 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 #ifdef KERNEL_PRIVATE 29 #ifndef _I386_PMCPU_H_ 30 #define _I386_PMCPU_H_ 31 32 #include <i386/cpu_topology.h> 33 34 #ifndef ASSEMBLER 35 36 /* 37 * This value should be changed each time that pmDispatch_t or pmCallBacks_t 38 * changes. 39 */ 40 #define PM_DISPATCH_VERSION 102 41 42 /* 43 * Dispatch table for functions that get installed when the power 44 * management KEXT loads. 45 * 46 * pmDispatch_t is the set of functions that the kernel can use to call 47 * into the power management KEXT. 48 * 49 * pmCallBacks_t is the set of functions that the power management kext 50 * can call to get at specific kernel functions. 51 */ 52 typedef struct{ 53 kern_return_t (*pmCPUStateInit)(void); 54 void (*cstateInit)(void); 55 uint64_t (*MachineIdle)(uint64_t maxIdleDuration); 56 uint64_t (*GetDeadline)(x86_lcpu_t *lcpu); 57 uint64_t (*SetDeadline)(x86_lcpu_t *lcpu, uint64_t); 58 void (*Deadline)(x86_lcpu_t *lcpu); 59 boolean_t (*exitIdle)(x86_lcpu_t *lcpu); 60 void (*markCPURunning)(x86_lcpu_t *lcpu); 61 int (*pmCPUControl)(uint32_t cmd, void *datap); 62 void (*pmCPUHalt)(void); 63 uint64_t (*getMaxSnoop)(void); 64 void (*setMaxBusDelay)(uint64_t time); 65 uint64_t (*getMaxBusDelay)(void); 66 void (*setMaxIntDelay)(uint64_t time); 67 uint64_t (*getMaxIntDelay)(void); 68 void (*pmCPUSafeMode)(x86_lcpu_t *lcpu, uint32_t flags); 69 void (*pmTimerStateSave)(void); 70 void (*pmTimerStateRestore)(void); 71 kern_return_t (*exitHalt)(x86_lcpu_t *lcpu); 72 kern_return_t (*exitHaltToOff)(x86_lcpu_t *lcpu); 73 void (*markAllCPUsOff)(void); 74 void (*pmSetRunCount)(uint32_t count); 75 boolean_t (*pmIsCPUUnAvailable)(x86_lcpu_t *lcpu); 76 int (*pmChooseCPU)(int startCPU, int endCPU, int preferredCPU); 77 int (*pmIPIHandler)(void *state); 78 void (*pmThreadTellUrgency)(int urgency, uint64_t rt_period, uint64_t rt_deadline); 79 void (*pmActiveRTThreads)(boolean_t active); 80 boolean_t (*pmInterruptPrewakeApplicable)(void); 81 void (*pmThreadGoingOffCore)(thread_t old_thread, boolean_t transfer_load, 82 uint64_t last_dispatch, boolean_t thread_runnable); 83 } pmDispatch_t; 84 85 /* common time fields exported to PM code. This structure may be 86 * allocated on the stack, so avoid making it unnecessarily large. 87 */ 88 typedef struct pm_rtc_nanotime { 89 uint64_t tsc_base; /* timestamp */ 90 uint64_t ns_base; /* nanoseconds */ 91 uint32_t scale; /* tsc -> nanosec multiplier */ 92 uint32_t shift; /* tsc -> nanosec shift/div */ 93 uint32_t generation; /* 0 == being updated */ 94 } pm_rtc_nanotime_t; 95 96 typedef struct { 97 uint64_t (*setRTCPop)(uint64_t time); 98 void (*resyncDeadlines)(int cpu); 99 void (*initComplete)(void); 100 x86_lcpu_t *(*GetLCPU)(int cpu); 101 x86_core_t *(*GetCore)(int cpu); 102 x86_die_t *(*GetDie)(int cpu); 103 x86_pkg_t *(*GetPackage)(int cpu); 104 x86_lcpu_t *(*GetMyLCPU)(void); 105 x86_core_t *(*GetMyCore)(void); 106 x86_die_t *(*GetMyDie)(void); 107 x86_pkg_t *(*GetMyPackage)(void); 108 x86_pkg_t *(*GetPkgRoot)(void); 109 void (*LockCPUTopology)(int lock); 110 boolean_t (*GetHibernate)(int cpu); 111 processor_t (*LCPUtoProcessor)(int lcpu); 112 processor_t (*ThreadBind)(processor_t proc); 113 uint32_t (*GetSavedRunCount)(void); 114 void (*pmSendIPI)(int cpu); 115 void (*GetNanotimeInfo)(pm_rtc_nanotime_t *); 116 int (*ThreadGetUrgency)(uint64_t *rt_period, uint64_t *rt_deadline); 117 uint32_t (*timerQueueMigrate)(int cpu); 118 void (*RTCClockAdjust)(uint64_t adjustment); 119 x86_topology_parameters_t *topoParms; 120 boolean_t (*InterruptPending)(void); 121 boolean_t (*IsInterrupting)(uint8_t vector); 122 void (*InterruptStats)(uint64_t intrs[256]); 123 void (*DisableApicTimer)(void); 124 } pmCallBacks_t; 125 126 extern pmDispatch_t *pmDispatch; 127 128 void power_management_init(void); 129 void pmKextRegister(uint32_t version, pmDispatch_t *cpuFuncs, 130 pmCallBacks_t *callbacks); 131 void pmUnRegister(pmDispatch_t *cpuFuncs); 132 void pmCPUStateInit(void); 133 uint64_t pmCPUGetDeadline(struct cpu_data *cpu); 134 uint64_t pmCPUSetDeadline(struct cpu_data *cpu, uint64_t deadline); 135 void pmCPUDeadline(struct cpu_data *cpu); 136 boolean_t pmCPUExitIdle(struct cpu_data *cpu); 137 void pmCPUMarkRunning(struct cpu_data *cpu); 138 void pmMarkAllCPUsOff(void); 139 int pmCPUControl(uint32_t cmd, void *datap); 140 void pmCPUHalt(uint32_t reason); 141 void pmTimerSave(void); 142 void pmTimerRestore(void); 143 kern_return_t pmCPUExitHalt(int cpu); 144 kern_return_t pmCPUExitHaltToOff(int cpu); 145 uint32_t pmTimerQueueMigrate(int); 146 147 #define PM_HALT_NORMAL 0 /* normal halt path */ 148 #define PM_HALT_DEBUG 1 /* debug code wants to halt */ 149 #define PM_HALT_PANIC 2 /* panic code wants to halt */ 150 #define PM_HALT_SLEEP 3 /* sleep code wants to halt */ 151 152 void pmSafeMode(x86_lcpu_t *lcpu, uint32_t flags); 153 154 #define PM_SAFE_FL_NORMAL 0x00000001 /* put CPU into "normal" power mode */ 155 #define PM_SAFE_FL_SAFE 0x00000002 /* put CPU into a "safe" power mode */ 156 #define PM_SAFE_FL_PAUSE 0x00000010 /* pause execution on the CPU */ 157 #define PM_SAFE_FL_RESUME 0x00000020 /* resume execution on the CPU */ 158 159 extern int pmsafe_debug; 160 /* Default urgency timing threshold for the DEBUG build */ 161 #define URGENCY_NOTIFICATION_ASSERT_NS (5 * 1000 * 1000) 162 extern uint64_t urgency_notification_assert_abstime_threshold; 163 164 x86_lcpu_t * 165 pmGetLogicalCPU(int cpu); 166 x86_lcpu_t * 167 pmGetMyLogicalCPU(void); 168 processor_t 169 pmLCPUtoProcessor(int lcpu); 170 x86_pkg_t * 171 pmGetPkgRoot(void); 172 173 174 /****************************************************************************** 175 * 176 * All of the following are deprecated interfaces and no longer used. 177 * 178 ******************************************************************************/ 179 180 181 #endif /* ASSEMBLER */ 182 183 #endif /* _I386_PMCPU_H_ */ 184 #endif /* KERNEL_PRIVATE */ 185