osfmk/i386/pmCPU.h

   1 /*
   2  * Copyright (c) 2006-2008 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 pmDsipatch_t or pmCallBacks_t
  38  * changes.
  39  */
  40 #define PM_DISPATCH_VERSION     15
  41
  42 /*
  43  * Dispatch table for functions that get installed when the power
  44  * management KEXT loads.
  45  */
  46 typedef struct
  47 {
  48     int                 (*pmCPUStateInit)(void);
  49
  50     /*
  51      * The following are the 'C' State interfaces.
  52      */
  53     void                (*cstateInit)(void);
  54     uint64_t            (*cstateMachineIdle)(uint64_t maxIdleDuration);
  55     uint64_t            (*GetDeadline)(x86_lcpu_t *lcpu);
  56     uint64_t            (*SetDeadline)(x86_lcpu_t *lcpu, uint64_t);
  57     void                (*Deadline)(x86_lcpu_t *lcpu);
  58     boolean_t           (*exitIdle)(x86_lcpu_t *lcpu);
  59     void                (*markCPURunning)(x86_lcpu_t *lcpu);
  60     int                 (*pmCPUControl)(uint32_t cmd, void *datap);
  61     void                (*pmCPUHalt)(void);
  62     uint64_t            (*getMaxSnoop)(void);
  63     void                (*setMaxBusDelay)(uint64_t time);
  64     uint64_t            (*getMaxBusDelay)(void);
  65     void                (*setMaxIntDelay)(uint64_t time);
  66     uint64_t            (*getMaxIntDelay)(void);
  67     void                (*pmCPUSafeMode)(x86_lcpu_t *lcpu, uint32_t flags);
  68     void                (*pmTimerStateSave)(void);
  69     void                (*pmTimerStateRestore)(void);
  70     kern_return_t       (*exitHalt)(x86_lcpu_t *lcpu);
  71     void                (*markAllCPUsOff)(void);
  72     void                (*pmSetRunCount)(uint32_t count);
  73     boolean_t           (*pmIsCPUUnAvailable)(x86_lcpu_t *lcpu);
  74 } pmDispatch_t;
  75
  76 typedef struct {
  77     int                 (*setRTCPop)(uint64_t time);
  78     void                (*resyncDeadlines)(int cpu);
  79     void                (*initComplete)(void);
  80     x86_lcpu_t          *(*GetLCPU)(int cpu);
  81     x86_core_t          *(*GetCore)(int cpu);
  82     x86_die_t           *(*GetDie)(int cpu);
  83     x86_pkg_t           *(*GetPackage)(int cpu);
  84     x86_lcpu_t          *(*GetMyLCPU)(void);
  85     x86_core_t          *(*GetMyCore)(void);
  86     x86_die_t           *(*GetMyDie)(void);
  87     x86_pkg_t           *(*GetMyPackage)(void);
  88     x86_pkg_t           *(*GetPkgRoot)(void);
  89     void                (*LockCPUTopology)(int lock);
  90     boolean_t           (*GetHibernate)(int cpu);
  91     processor_t         (*LCPUtoProcessor)(int lcpu);
  92     processor_t         (*ThreadBind)(processor_t proc);
  93     uint32_t            (*GetSavedRunCount)(void);
  94     x86_topology_parameters_t   *topoParms;
  95 } pmCallBacks_t;
  96
  97 extern pmDispatch_t     *pmDispatch;
  98
  99 void power_management_init(void);
 100 void pmKextRegister(uint32_t version, pmDispatch_t *cpuFuncs,
 101                     pmCallBacks_t *callbacks);
 102 void pmUnRegister(pmDispatch_t *cpuFuncs);
 103 void pmCPUStateInit(void);
 104 uint64_t pmCPUGetDeadline(struct cpu_data *cpu);
 105 uint64_t pmCPUSetDeadline(struct cpu_data *cpu, uint64_t deadline);
 106 void pmCPUDeadline(struct cpu_data *cpu);
 107 boolean_t pmCPUExitIdle(struct cpu_data *cpu);
 108 void pmCPUMarkRunning(struct cpu_data *cpu);
 109 void pmMarkAllCPUsOff(void);
 110 int pmCPUControl(uint32_t cmd, void *datap);
 111 void pmCPUHalt(uint32_t reason);
 112 void pmTimerSave(void);
 113 void pmTimerRestore(void);
 114 kern_return_t pmCPUExitHalt(int cpu);
 115
 116 #define PM_HALT_NORMAL          0               /* normal halt path */
 117 #define PM_HALT_DEBUG           1               /* debug code wants to halt */
 118 #define PM_HALT_PANIC           2               /* panic code wants to halt */
 119 #define PM_HALT_SLEEP           3               /* sleep code wants to halt */
 120
 121 void pmSafeMode(x86_lcpu_t *lcpu, uint32_t flags);
 122
 123 #define PM_SAFE_FL_NORMAL       0x00000001      /* put CPU into "normal" power mode */
 124 #define PM_SAFE_FL_SAFE         0x00000002      /* put CPU into a "safe" power mode */
 125 #define PM_SAFE_FL_PAUSE        0x00000010      /* pause execution on the CPU */
 126 #define PM_SAFE_FL_RESUME       0x00000020      /* resume execution on the CPU */
 127
 128 extern int pmsafe_debug;
 129 extern int idlehalt;
 130
 131 /******************************************************************************
 132  *
 133  * All of the following are deprecated interfaces and no longer used.
 134  *
 135  ******************************************************************************/
 136
 137
 138 #endif /* ASSEMBLER */
 139
 140 #endif /* _I386_PMCPU_H_ */
 141 #endif /* KERNEL_PRIVATE */