p4tcc.c revision 241856
1/*- 2 * Copyright (c) 2005 Nate Lawson 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 19 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 21 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 22 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27/* 28 * Throttle clock frequency by using the thermal control circuit. This 29 * operates independently of SpeedStep and ACPI throttling and is supported 30 * on Pentium 4 and later models (feature TM). 31 * 32 * Reference: Intel Developer's manual v.3 #245472-012 33 * 34 * The original version of this driver was written by Ted Unangst for 35 * OpenBSD and imported by Maxim Sobolev. It was rewritten by Nate Lawson 36 * for use with the cpufreq framework. 37 */ 38 39#include <sys/cdefs.h> 40__FBSDID("$FreeBSD: head/sys/x86/cpufreq/p4tcc.c 241856 2012-10-22 03:41:14Z eadler $"); 41 42#include <sys/param.h> 43#include <sys/systm.h> 44#include <sys/bus.h> 45#include <sys/cpu.h> 46#include <sys/kernel.h> 47#include <sys/module.h> 48 49#include <machine/md_var.h> 50#include <machine/specialreg.h> 51 52#include "cpufreq_if.h" 53 54#include <contrib/dev/acpica/include/acpi.h> 55 56#include <dev/acpica/acpivar.h> 57#include "acpi_if.h" 58 59struct p4tcc_softc { 60 device_t dev; 61 int set_count; 62 int lowest_val; 63 int auto_mode; 64}; 65 66#define TCC_NUM_SETTINGS 8 67 68#define TCC_ENABLE_ONDEMAND (1<<4) 69#define TCC_REG_OFFSET 1 70#define TCC_SPEED_PERCENT(x) ((10000 * (x)) / TCC_NUM_SETTINGS) 71 72static int p4tcc_features(driver_t *driver, u_int *features); 73static void p4tcc_identify(driver_t *driver, device_t parent); 74static int p4tcc_probe(device_t dev); 75static int p4tcc_attach(device_t dev); 76static int p4tcc_settings(device_t dev, struct cf_setting *sets, 77 int *count); 78static int p4tcc_set(device_t dev, const struct cf_setting *set); 79static int p4tcc_get(device_t dev, struct cf_setting *set); 80static int p4tcc_type(device_t dev, int *type); 81 82static device_method_t p4tcc_methods[] = { 83 /* Device interface */ 84 DEVMETHOD(device_identify, p4tcc_identify), 85 DEVMETHOD(device_probe, p4tcc_probe), 86 DEVMETHOD(device_attach, p4tcc_attach), 87 88 /* cpufreq interface */ 89 DEVMETHOD(cpufreq_drv_set, p4tcc_set), 90 DEVMETHOD(cpufreq_drv_get, p4tcc_get), 91 DEVMETHOD(cpufreq_drv_type, p4tcc_type), 92 DEVMETHOD(cpufreq_drv_settings, p4tcc_settings), 93 94 /* ACPI interface */ 95 DEVMETHOD(acpi_get_features, p4tcc_features), 96 97 {0, 0} 98}; 99 100static driver_t p4tcc_driver = { 101 "p4tcc", 102 p4tcc_methods, 103 sizeof(struct p4tcc_softc), 104}; 105 106static devclass_t p4tcc_devclass; 107DRIVER_MODULE(p4tcc, cpu, p4tcc_driver, p4tcc_devclass, 0, 0); 108 109static int 110p4tcc_features(driver_t *driver, u_int *features) 111{ 112 113 /* Notify the ACPI CPU that we support direct access to MSRs */ 114 *features = ACPI_CAP_THR_MSRS; 115 return (0); 116} 117 118static void 119p4tcc_identify(driver_t *driver, device_t parent) 120{ 121 122 if ((cpu_feature & (CPUID_ACPI | CPUID_TM)) != (CPUID_ACPI | CPUID_TM)) 123 return; 124 125 /* Make sure we're not being doubly invoked. */ 126 if (device_find_child(parent, "p4tcc", -1) != NULL) 127 return; 128 129 /* 130 * We attach a p4tcc child for every CPU since settings need to 131 * be performed on every CPU in the SMP case. See section 13.15.3 132 * of the IA32 Intel Architecture Software Developer's Manual, 133 * Volume 3, for more info. 134 */ 135 if (BUS_ADD_CHILD(parent, 10, "p4tcc", -1) == NULL) 136 device_printf(parent, "add p4tcc child failed\n"); 137} 138 139static int 140p4tcc_probe(device_t dev) 141{ 142 device_set_desc(dev, "CPU Frequency Thermal Control"); 143 return (0); 144} 145 146static int 147p4tcc_attach(device_t dev) 148{ 149 struct p4tcc_softc *sc; 150 struct cf_setting set; 151 152 sc = device_get_softc(dev); 153 sc->dev = dev; 154 sc->set_count = TCC_NUM_SETTINGS; 155 156 /* 157 * On boot, the TCC is usually in Automatic mode where reading the 158 * current performance level is likely to produce bogus results. 159 * We record that state here and don't trust the contents of the 160 * status MSR until we've set it ourselves. 161 */ 162 sc->auto_mode = TRUE; 163 164 /* 165 * XXX: After a cursory glance at various Intel specification 166 * XXX: updates it seems like these tests for errata is bogus. 167 * XXX: As far as I can tell, the failure mode is benign, in 168 * XXX: that cpus with no errata will have their bottom two 169 * XXX: STPCLK# rates disabled, so rather than waste more time 170 * XXX: hunting down intel docs, just document it and punt. /phk 171 */ 172 switch (cpu_id & 0xff) { 173 case 0x22: 174 case 0x24: 175 case 0x25: 176 case 0x27: 177 case 0x29: 178 /* 179 * These CPU models hang when set to 12.5%. 180 * See Errata O50, P44, and Z21. 181 */ 182 sc->set_count -= 1; 183 break; 184 case 0x07: /* errata N44 and P18 */ 185 case 0x0a: 186 case 0x12: 187 case 0x13: 188 case 0x62: /* Pentium D B1: errata AA21 */ 189 case 0x64: /* Pentium D C1: errata AA21 */ 190 case 0x65: /* Pentium D D0: errata AA21 */ 191 /* 192 * These CPU models hang when set to 12.5% or 25%. 193 * See Errata N44, P18l and AA21. 194 */ 195 sc->set_count -= 2; 196 break; 197 } 198 sc->lowest_val = TCC_NUM_SETTINGS - sc->set_count + 1; 199 200 /* 201 * Before we finish attach, switch to 100%. It's possible the BIOS 202 * set us to a lower rate. The user can override this after boot. 203 */ 204 set.freq = 10000; 205 p4tcc_set(dev, &set); 206 207 cpufreq_register(dev); 208 return (0); 209} 210 211static int 212p4tcc_settings(device_t dev, struct cf_setting *sets, int *count) 213{ 214 struct p4tcc_softc *sc; 215 int i, val; 216 217 sc = device_get_softc(dev); 218 if (sets == NULL || count == NULL) 219 return (EINVAL); 220 if (*count < sc->set_count) 221 return (E2BIG); 222 223 /* Return a list of valid settings for this driver. */ 224 memset(sets, CPUFREQ_VAL_UNKNOWN, sizeof(*sets) * sc->set_count); 225 val = TCC_NUM_SETTINGS; 226 for (i = 0; i < sc->set_count; i++, val--) { 227 sets[i].freq = TCC_SPEED_PERCENT(val); 228 sets[i].dev = dev; 229 } 230 *count = sc->set_count; 231 232 return (0); 233} 234 235static int 236p4tcc_set(device_t dev, const struct cf_setting *set) 237{ 238 struct p4tcc_softc *sc; 239 uint64_t mask, msr; 240 int val; 241 242 if (set == NULL) 243 return (EINVAL); 244 sc = device_get_softc(dev); 245 246 /* 247 * Validate requested state converts to a setting that is an integer 248 * from [sc->lowest_val .. TCC_NUM_SETTINGS]. 249 */ 250 val = set->freq * TCC_NUM_SETTINGS / 10000; 251 if (val * 10000 != set->freq * TCC_NUM_SETTINGS || 252 val < sc->lowest_val || val > TCC_NUM_SETTINGS) 253 return (EINVAL); 254 255 /* 256 * Read the current register and mask off the old setting and 257 * On-Demand bit. If the new val is < 100%, set it and the On-Demand 258 * bit, otherwise just return to Automatic mode. 259 */ 260 msr = rdmsr(MSR_THERM_CONTROL); 261 mask = (TCC_NUM_SETTINGS - 1) << TCC_REG_OFFSET; 262 msr &= ~(mask | TCC_ENABLE_ONDEMAND); 263 if (val < TCC_NUM_SETTINGS) 264 msr |= (val << TCC_REG_OFFSET) | TCC_ENABLE_ONDEMAND; 265 wrmsr(MSR_THERM_CONTROL, msr); 266 267 /* 268 * Record whether we're now in Automatic or On-Demand mode. We have 269 * to cache this since there is no reliable way to check if TCC is in 270 * Automatic mode (i.e., at 100% or possibly 50%). Reading bit 4 of 271 * the ACPI Thermal Monitor Control Register produces 0 no matter 272 * what the current mode. 273 */ 274 if (msr & TCC_ENABLE_ONDEMAND) 275 sc->auto_mode = FALSE; 276 else 277 sc->auto_mode = TRUE; 278 279 return (0); 280} 281 282static int 283p4tcc_get(device_t dev, struct cf_setting *set) 284{ 285 struct p4tcc_softc *sc; 286 uint64_t msr; 287 int val; 288 289 if (set == NULL) 290 return (EINVAL); 291 sc = device_get_softc(dev); 292 293 /* 294 * Read the current register and extract the current setting. If 295 * in automatic mode, assume we're at TCC_NUM_SETTINGS (100%). 296 * 297 * XXX This is not completely reliable since at high temperatures 298 * the CPU may be automatically throttling to 50% but it's the best 299 * we can do. 300 */ 301 if (!sc->auto_mode) { 302 msr = rdmsr(MSR_THERM_CONTROL); 303 val = (msr >> TCC_REG_OFFSET) & (TCC_NUM_SETTINGS - 1); 304 } else 305 val = TCC_NUM_SETTINGS; 306 307 memset(set, CPUFREQ_VAL_UNKNOWN, sizeof(*set)); 308 set->freq = TCC_SPEED_PERCENT(val); 309 set->dev = dev; 310 311 return (0); 312} 313 314static int 315p4tcc_type(device_t dev, int *type) 316{ 317 318 if (type == NULL) 319 return (EINVAL); 320 321 *type = CPUFREQ_TYPE_RELATIVE; 322 return (0); 323} 324