p4tcc.c revision 185331
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/i386/cpufreq/p4tcc.c 185331 2008-11-26 09:46:35Z sobomax $"); 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/acpi.h> 55#include <dev/acpica/acpivar.h> 56#include "acpi_if.h" 57 58struct p4tcc_softc { 59 device_t dev; 60 int set_count; 61 int lowest_val; 62 int auto_mode; 63}; 64 65#define TCC_NUM_SETTINGS 8 66 67#define TCC_ENABLE_ONDEMAND (1<<4) 68#define TCC_REG_OFFSET 1 69#define TCC_SPEED_PERCENT(x) ((10000 * (x)) / TCC_NUM_SETTINGS) 70 71static int p4tcc_features(driver_t *driver, u_int *features); 72static void p4tcc_identify(driver_t *driver, device_t parent); 73static int p4tcc_probe(device_t dev); 74static int p4tcc_attach(device_t dev); 75static int p4tcc_settings(device_t dev, struct cf_setting *sets, 76 int *count); 77static int p4tcc_set(device_t dev, const struct cf_setting *set); 78static int p4tcc_get(device_t dev, struct cf_setting *set); 79static int p4tcc_type(device_t dev, int *type); 80 81static device_method_t p4tcc_methods[] = { 82 /* Device interface */ 83 DEVMETHOD(device_identify, p4tcc_identify), 84 DEVMETHOD(device_probe, p4tcc_probe), 85 DEVMETHOD(device_attach, p4tcc_attach), 86 87 /* cpufreq interface */ 88 DEVMETHOD(cpufreq_drv_set, p4tcc_set), 89 DEVMETHOD(cpufreq_drv_get, p4tcc_get), 90 DEVMETHOD(cpufreq_drv_type, p4tcc_type), 91 DEVMETHOD(cpufreq_drv_settings, p4tcc_settings), 92 93 /* ACPI interface */ 94 DEVMETHOD(acpi_get_features, p4tcc_features), 95 96 {0, 0} 97}; 98 99static driver_t p4tcc_driver = { 100 "p4tcc", 101 p4tcc_methods, 102 sizeof(struct p4tcc_softc), 103}; 104 105static devclass_t p4tcc_devclass; 106DRIVER_MODULE(p4tcc, cpu, p4tcc_driver, p4tcc_devclass, 0, 0); 107 108static int 109p4tcc_features(driver_t *driver, u_int *features) 110{ 111 112 /* Notify the ACPI CPU that we support direct access to MSRs */ 113 *features = ACPI_CAP_THR_MSRS; 114 return (0); 115} 116 117static void 118p4tcc_identify(driver_t *driver, device_t parent) 119{ 120 121 if ((cpu_feature & (CPUID_ACPI | CPUID_TM)) != (CPUID_ACPI | CPUID_TM)) 122 return; 123 124 /* Make sure we're not being doubly invoked. */ 125 if (device_find_child(parent, "p4tcc", -1) != NULL) 126 return; 127 128 /* 129 * We attach a p4tcc child for every CPU since settings need to 130 * be performed on every CPU in the SMP case. See section 13.15.3 131 * of the IA32 Intel Architecture Software Developer's Manual, 132 * Volume 3, for more info. 133 */ 134 if (BUS_ADD_CHILD(parent, 10, "p4tcc", -1) == NULL) 135 device_printf(parent, "add p4tcc child failed\n"); 136} 137 138static int 139p4tcc_probe(device_t dev) 140{ 141 142 if (resource_disabled("p4tcc", 0)) 143 return (ENXIO); 144 145 device_set_desc(dev, "CPU Frequency Thermal Control"); 146 return (0); 147} 148 149static int 150p4tcc_attach(device_t dev) 151{ 152 struct p4tcc_softc *sc; 153 struct cf_setting set; 154 155 sc = device_get_softc(dev); 156 sc->dev = dev; 157 sc->set_count = TCC_NUM_SETTINGS; 158 159 /* 160 * On boot, the TCC is usually in Automatic mode where reading the 161 * current performance level is likely to produce bogus results. 162 * We record that state here and don't trust the contents of the 163 * status MSR until we've set it ourselves. 164 */ 165 sc->auto_mode = TRUE; 166 167 /* 168 * XXX: After a cursory glance at various Intel specification 169 * XXX: updates it seems like these tests for errata is bogus. 170 * XXX: As far as I can tell, the failure mode is benign, in 171 * XXX: that cpus with no errata will have their bottom two 172 * XXX: STPCLK# rates disabled, so rather than waste more time 173 * XXX: hunting down intel docs, just document it and punt. /phk 174 */ 175 switch (cpu_id & 0xff) { 176 case 0x22: 177 case 0x24: 178 case 0x25: 179 case 0x27: 180 case 0x29: 181 /* 182 * These CPU models hang when set to 12.5%. 183 * See Errata O50, P44, and Z21. 184 */ 185 sc->set_count -= 1; 186 break; 187 case 0x07: /* errata N44 and P18 */ 188 case 0x0a: 189 case 0x12: 190 case 0x13: 191 case 0x62: /* Pentium D B1: errata AA21 */ 192 case 0x64: /* Pentium D C1: errata AA21 */ 193 case 0x65: /* Pentium D D0: errata AA21 */ 194 /* 195 * These CPU models hang when set to 12.5% or 25%. 196 * See Errata N44, P18l and AA21. 197 */ 198 sc->set_count -= 2; 199 break; 200 } 201 sc->lowest_val = TCC_NUM_SETTINGS - sc->set_count + 1; 202 203 /* 204 * Before we finish attach, switch to 100%. It's possible the BIOS 205 * set us to a lower rate. The user can override this after boot. 206 */ 207 set.freq = 10000; 208 p4tcc_set(dev, &set); 209 210 cpufreq_register(dev); 211 return (0); 212} 213 214static int 215p4tcc_settings(device_t dev, struct cf_setting *sets, int *count) 216{ 217 struct p4tcc_softc *sc; 218 int i, val; 219 220 sc = device_get_softc(dev); 221 if (sets == NULL || count == NULL) 222 return (EINVAL); 223 if (*count < sc->set_count) 224 return (E2BIG); 225 226 /* Return a list of valid settings for this driver. */ 227 memset(sets, CPUFREQ_VAL_UNKNOWN, sizeof(*sets) * sc->set_count); 228 val = TCC_NUM_SETTINGS; 229 for (i = 0; i < sc->set_count; i++, val--) { 230 sets[i].freq = TCC_SPEED_PERCENT(val); 231 sets[i].dev = dev; 232 } 233 *count = sc->set_count; 234 235 return (0); 236} 237 238static int 239p4tcc_set(device_t dev, const struct cf_setting *set) 240{ 241 struct p4tcc_softc *sc; 242 uint64_t mask, msr; 243 int val; 244 245 if (set == NULL) 246 return (EINVAL); 247 sc = device_get_softc(dev); 248 249 /* 250 * Validate requested state converts to a setting that is an integer 251 * from [sc->lowest_val .. TCC_NUM_SETTINGS]. 252 */ 253 val = set->freq * TCC_NUM_SETTINGS / 10000; 254 if (val * 10000 != set->freq * TCC_NUM_SETTINGS || 255 val < sc->lowest_val || val > TCC_NUM_SETTINGS) 256 return (EINVAL); 257 258 /* 259 * Read the current register and mask off the old setting and 260 * On-Demand bit. If the new val is < 100%, set it and the On-Demand 261 * bit, otherwise just return to Automatic mode. 262 */ 263 msr = rdmsr(MSR_THERM_CONTROL); 264 mask = (TCC_NUM_SETTINGS - 1) << TCC_REG_OFFSET; 265 msr &= ~(mask | TCC_ENABLE_ONDEMAND); 266 if (val < TCC_NUM_SETTINGS) 267 msr |= (val << TCC_REG_OFFSET) | TCC_ENABLE_ONDEMAND; 268 wrmsr(MSR_THERM_CONTROL, msr); 269 270 /* 271 * Record whether we're now in Automatic or On-Demand mode. We have 272 * to cache this since there is no reliable way to check if TCC is in 273 * Automatic mode (i.e., at 100% or possibly 50%). Reading bit 4 of 274 * the ACPI Thermal Monitor Control Register produces 0 no matter 275 * what the current mode. 276 */ 277 if (msr & TCC_ENABLE_ONDEMAND) 278 sc->auto_mode = TRUE; 279 else 280 sc->auto_mode = FALSE; 281 282 return (0); 283} 284 285static int 286p4tcc_get(device_t dev, struct cf_setting *set) 287{ 288 struct p4tcc_softc *sc; 289 uint64_t msr; 290 int val; 291 292 if (set == NULL) 293 return (EINVAL); 294 sc = device_get_softc(dev); 295 296 /* 297 * Read the current register and extract the current setting. If 298 * in automatic mode, assume we're at TCC_NUM_SETTINGS (100%). 299 * 300 * XXX This is not completely reliable since at high temperatures 301 * the CPU may be automatically throttling to 50% but it's the best 302 * we can do. 303 */ 304 if (!sc->auto_mode) { 305 msr = rdmsr(MSR_THERM_CONTROL); 306 val = (msr >> TCC_REG_OFFSET) & (TCC_NUM_SETTINGS - 1); 307 } else 308 val = TCC_NUM_SETTINGS; 309 310 memset(set, CPUFREQ_VAL_UNKNOWN, sizeof(*set)); 311 set->freq = TCC_SPEED_PERCENT(val); 312 set->dev = dev; 313 314 return (0); 315} 316 317static int 318p4tcc_type(device_t dev, int *type) 319{ 320 321 if (type == NULL) 322 return (EINVAL); 323 324 *type = CPUFREQ_TYPE_RELATIVE; 325 return (0); 326} 327