1 /* $NetBSD: acpi_tz.c,v 1.32 2007/12/09 20:27:53 jmcneill Exp $ */ 2 3 /* 4 * Copyright (c) 2003 Jared D. McNeill <jmcneill@invisible.ca> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. The name of the author may not be used to endorse or promote products 13 * derived from this software without specific prior written permission. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 20 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 22 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 /* 29 * ACPI Thermal Zone driver 30 */ 31 32 #include <sys/cdefs.h> 33 __KERNEL_RCSID(0, "$NetBSD: acpi_tz.c,v 1.32 2007/12/09 20:27:53 jmcneill Exp $"); 34 35 #include <sys/param.h> 36 #include <sys/systm.h> 37 #include <sys/kernel.h> 38 #include <sys/errno.h> 39 #include <sys/ioctl.h> 40 #include <sys/syslog.h> 41 #include <sys/device.h> 42 #include <sys/callout.h> 43 #include <sys/proc.h> 44 #include <sys/mutex.h> 45 #include <dev/sysmon/sysmonvar.h> 46 47 #include <dev/acpi/acpica.h> 48 #include <dev/acpi/acpireg.h> 49 #include <dev/acpi/acpivar.h> 50 51 /* flags */ 52 #define ATZ_F_VERBOSE 0x01 /* show events to console */ 53 #define ATZ_F_CRITICAL 0x02 /* zone critical */ 54 #define ATZ_F_HOT 0x04 /* zone hot */ 55 #define ATZ_F_PASSIVE 0x08 /* zone passive cooling */ 56 #define ATZ_F_PASSIVEONLY 0x10 /* zone is passive cooling only */ 57 58 /* no active cooling level */ 59 #define ATZ_ACTIVE_NONE -1 60 61 /* constants */ 62 #define ATZ_TZP_RATE 300 /* default if no _TZP CM present (30 secs) */ 63 #define ATZ_NLEVELS 10 /* number of cooling levels, from ACPI spec */ 64 #define ATZ_ZEROC 2732 /* 0C in tenths degrees Kelvin */ 65 #define ATZ_TMP_INVALID 0xffffffff /* invalid temperature */ 66 #define ATZ_ZONE_EXPIRE 9000 /* zone info refetch interval (15min) */ 67 68 /* sensor indexes */ 69 #define ATZ_SENSOR_TEMP 0 /* thermal zone temperature */ 70 71 static int acpitz_match(struct device *, struct cfdata *, void *); 72 static void acpitz_attach(struct device *, struct device *, void *); 73 74 /* 75 * ACPI Temperature Zone information. Note all temperatures are reported 76 * in tenths of degrees Kelvin 77 */ 78 struct acpitz_zone { 79 /* Active cooling temperature threshold */ 80 UINT32 ac[ATZ_NLEVELS]; 81 /* Package of references to all active cooling devices for a level */ 82 ACPI_BUFFER al[ATZ_NLEVELS]; 83 /* Critical temperature threshold for system shutdown */ 84 UINT32 crt; 85 /* Critical temperature threshold for S4 sleep */ 86 UINT32 hot; 87 /* Package of references to processor objects for passive cooling */ 88 ACPI_BUFFER psl; 89 /* Passive cooling temperature threshold */ 90 UINT32 psv; 91 /* Thermal constants for use in passive cooling formulas */ 92 UINT32 tc1, tc2; 93 /* Current temperature of the thermal zone */ 94 UINT32 tmp; 95 /* Thermal sampling period for passive cooling, in tenths of seconds */ 96 UINT32 tsp; 97 /* Package of references to devices in this TZ (optional) */ 98 ACPI_BUFFER tzd; 99 /* Recommended TZ polling frequency, in tenths of seconds */ 100 UINT32 tzp; 101 }; 102 103 struct acpitz_softc { 104 struct device sc_dev; 105 struct acpi_devnode *sc_devnode; 106 struct acpitz_zone sc_zone; 107 struct callout sc_callout; 108 struct sysmon_envsys *sc_sme; 109 envsys_data_t sc_sensor; 110 kmutex_t sc_mtx; 111 int sc_active; /* active cooling level */ 112 int sc_flags; 113 int sc_rate; /* tz poll rate */ 114 int sc_zone_expire; 115 116 int sc_first; 117 }; 118 119 static void acpitz_get_status(void *); 120 static void acpitz_get_zone(void *, int); 121 static void acpitz_get_zone_quiet(void *); 122 static char* acpitz_celcius_string(int); 123 static void acpitz_print_status(struct acpitz_softc *); 124 static void acpitz_power_off(struct acpitz_softc *); 125 static void acpitz_power_zone(struct acpitz_softc *, int, int); 126 static void acpitz_sane_temp(UINT32 *tmp); 127 static ACPI_STATUS 128 acpitz_switch_cooler(ACPI_OBJECT *, void *); 129 static void acpitz_notify_handler(ACPI_HANDLE, UINT32, void *); 130 static int acpitz_get_integer(struct acpitz_softc *, const char *, UINT32 *); 131 static void acpitz_tick(void *); 132 static void acpitz_init_envsys(struct acpitz_softc *); 133 134 CFATTACH_DECL(acpitz, sizeof(struct acpitz_softc), acpitz_match, 135 acpitz_attach, NULL, NULL); 136 137 /* 138 * acpitz_match: autoconf(9) match routine 139 */ 140 static int 141 acpitz_match(struct device *parent, struct cfdata *match, void *aux) 142 { 143 struct acpi_attach_args *aa = aux; 144 145 if (aa->aa_node->ad_type != ACPI_TYPE_THERMAL) 146 return 0; 147 148 return 1; 149 } 150 151 /* 152 * acpitz_attach: autoconf(9) attach routine 153 */ 154 static void 155 acpitz_attach(struct device *parent, struct device *self, void *aux) 156 { 157 struct acpitz_softc *sc = (struct acpitz_softc *)self; 158 struct acpi_attach_args *aa = aux; 159 ACPI_STATUS rv; 160 ACPI_INTEGER v; 161 162 mutex_init(&sc->sc_mtx, MUTEX_DEFAULT, IPL_NONE); 163 164 #if 0 165 sc->sc_flags = ATZ_F_VERBOSE; 166 #endif 167 sc->sc_devnode = aa->aa_node; 168 169 aprint_naive("\n"); 170 171 rv = acpi_eval_integer(sc->sc_devnode->ad_handle, "_TZP", &v); 172 if (ACPI_FAILURE(rv)) 173 sc->sc_zone.tzp = ATZ_TZP_RATE; 174 else 175 sc->sc_zone.tzp = v; 176 177 aprint_debug(" sample rate %d.%ds\n", 178 sc->sc_zone.tzp / 10, sc->sc_zone.tzp % 10); 179 180 /* XXX a value of 0 means "polling is not necessary" */ 181 if (sc->sc_zone.tzp == 0) 182 sc->sc_zone.tzp = ATZ_TZP_RATE; 183 184 sc->sc_zone_expire = ATZ_ZONE_EXPIRE / sc->sc_zone.tzp; 185 sc->sc_first = 1; 186 187 acpitz_get_zone(sc, 1); 188 acpitz_get_status(sc); 189 190 rv = AcpiInstallNotifyHandler(sc->sc_devnode->ad_handle, 191 ACPI_SYSTEM_NOTIFY, acpitz_notify_handler, sc); 192 if (ACPI_FAILURE(rv)) { 193 aprint_error(": unable to install SYSTEM NOTIFY handler: %s\n", 194 AcpiFormatException(rv)); 195 return; 196 } 197 198 callout_init(&sc->sc_callout, 0); 199 callout_setfunc(&sc->sc_callout, acpitz_tick, sc); 200 201 acpitz_init_envsys(sc); 202 203 if (!pmf_device_register(self, NULL, NULL)) 204 aprint_error(": couldn't establish power handler\n"); 205 206 callout_schedule(&sc->sc_callout, sc->sc_zone.tzp * hz / 10); 207 } 208 209 static void 210 acpitz_get_zone_quiet(void *opaque) 211 { 212 acpitz_get_zone(opaque, 0); 213 } 214 215 static void 216 acpitz_get_status(void *opaque) 217 { 218 struct acpitz_softc *sc = opaque; 219 UINT32 tmp, active; 220 int i, flags; 221 222 sc->sc_zone_expire--; 223 if (sc->sc_zone_expire <= 0) { 224 sc->sc_zone_expire = ATZ_ZONE_EXPIRE / sc->sc_zone.tzp; 225 if (sc->sc_flags & ATZ_F_VERBOSE) 226 printf("%s: force refetch zone\n", sc->sc_dev.dv_xname); 227 acpitz_get_zone(sc, 0); 228 } 229 230 if (acpitz_get_integer(sc, "_TMP", &tmp)) { 231 aprint_error("%s: failed to evaluate _TMP\n", 232 sc->sc_dev.dv_xname); 233 return; 234 } 235 sc->sc_zone.tmp = tmp; 236 /* XXX sanity check for tmp here? */ 237 238 /* 239 * The temperature unit for envsys(4) is microKelvin, so convert to 240 * that from ACPI's microKelvin. Also, the ACPI specification assumes 241 * that K = C + 273.2 rather than the nominal 273.15 used by envsys(4), 242 * so we correct for that too. 243 */ 244 sc->sc_sensor.value_cur = sc->sc_zone.tmp * 100000 - 50000; 245 sc->sc_sensor.state = ENVSYS_SVALID; 246 247 if (sc->sc_flags & ATZ_F_VERBOSE) 248 acpitz_print_status(sc); 249 250 if (sc->sc_flags & ATZ_F_PASSIVEONLY) { 251 /* Passive Cooling: XXX not yet */ 252 253 } else { 254 /* Active Cooling */ 255 256 /* temperature threshold: _AC0 > ... > _AC9 */ 257 active = ATZ_ACTIVE_NONE; 258 for (i = ATZ_NLEVELS - 1; i >= 0; i--) { 259 if (sc->sc_zone.ac[i] == ATZ_TMP_INVALID) 260 continue; 261 262 /* we want to keep highest cooling mode in 'active' */ 263 if (sc->sc_zone.ac[i] <= tmp) 264 active = i; 265 } 266 267 flags = sc->sc_flags & ~(ATZ_F_CRITICAL|ATZ_F_HOT|ATZ_F_PASSIVE); 268 if (sc->sc_zone.psv != ATZ_TMP_INVALID && 269 tmp >= sc->sc_zone.psv) 270 flags |= ATZ_F_PASSIVE; 271 if (sc->sc_zone.hot != ATZ_TMP_INVALID && 272 tmp >= sc->sc_zone.hot) 273 flags |= ATZ_F_HOT; 274 if (sc->sc_zone.crt != ATZ_TMP_INVALID && 275 tmp >= sc->sc_zone.crt) 276 flags |= ATZ_F_CRITICAL; 277 278 if (flags != sc->sc_flags) { 279 int changed = (sc->sc_flags ^ flags) & flags; 280 sc->sc_flags = flags; 281 if (changed & ATZ_F_CRITICAL) { 282 sc->sc_sensor.state = ENVSYS_SCRITICAL; 283 printf("%s: zone went critical at temp %sC\n", 284 sc->sc_dev.dv_xname, 285 acpitz_celcius_string(tmp)); 286 } else if (changed & ATZ_F_HOT) { 287 sc->sc_sensor.state = ENVSYS_SWARNOVER; 288 printf("%s: zone went hot at temp %sC\n", 289 sc->sc_dev.dv_xname, 290 acpitz_celcius_string(tmp)); 291 } 292 } 293 294 /* power on fans */ 295 if (sc->sc_active != active) { 296 if (sc->sc_active != ATZ_ACTIVE_NONE) 297 acpitz_power_zone(sc, sc->sc_active, 0); 298 299 if (active != ATZ_ACTIVE_NONE) { 300 if (sc->sc_flags & ATZ_F_VERBOSE) 301 printf("%s: active cooling level %u\n", 302 sc->sc_dev.dv_xname, active); 303 acpitz_power_zone(sc, active, 1); 304 } 305 306 sc->sc_active = active; 307 } 308 } 309 310 return; 311 } 312 313 static char * 314 acpitz_celcius_string(int dk) 315 { 316 static char buf[10]; 317 318 snprintf(buf, sizeof(buf), "%d.%d", (dk - ATZ_ZEROC) / 10, 319 (dk - ATZ_ZEROC) % 10); 320 321 return buf; 322 } 323 324 static void 325 acpitz_print_status(struct acpitz_softc *sc) 326 { 327 328 printf("%s: zone temperature is now %sC\n", sc->sc_dev.dv_xname, 329 acpitz_celcius_string(sc->sc_zone.tmp)); 330 331 return; 332 } 333 334 static ACPI_STATUS 335 acpitz_switch_cooler(ACPI_OBJECT *obj, void *arg) 336 { 337 ACPI_HANDLE cooler; 338 ACPI_STATUS rv; 339 int pwr_state, flag; 340 341 flag = *(int *)arg; 342 343 if (flag) 344 pwr_state = ACPI_STATE_D0; 345 else 346 pwr_state = ACPI_STATE_D3; 347 348 switch(obj->Type) { 349 case ACPI_TYPE_ANY: 350 cooler = obj->Reference.Handle; 351 break; 352 case ACPI_TYPE_STRING: 353 rv = AcpiGetHandle(NULL, obj->String.Pointer, &cooler); 354 if (ACPI_FAILURE(rv)) { 355 printf("failed to get handler from %s\n", 356 obj->String.Pointer); 357 return rv; 358 } 359 break; 360 default: 361 printf("unknown power type: %d\n", obj->Type); 362 return AE_OK; 363 } 364 365 rv = acpi_pwr_switch_consumer(cooler, pwr_state); 366 if (rv != AE_BAD_PARAMETER && ACPI_FAILURE(rv)) { 367 printf("failed to change state for %s: %s\n", 368 acpi_name(obj->Reference.Handle), 369 AcpiFormatException(rv)); 370 } 371 372 return AE_OK; 373 } 374 375 /* 376 * acpitz_power_zone: 377 * power on or off the i:th part of the zone zone 378 */ 379 static void 380 acpitz_power_zone(struct acpitz_softc *sc, int i, int on) 381 { 382 KASSERT(i >= 0 && i < ATZ_NLEVELS); 383 384 acpi_foreach_package_object(sc->sc_zone.al[i].Pointer, 385 acpitz_switch_cooler, &on); 386 } 387 388 389 /* 390 * acpitz_power_off: 391 * power off parts of the zone 392 */ 393 static void 394 acpitz_power_off(struct acpitz_softc *sc) 395 { 396 int i; 397 398 for (i = 0 ; i < ATZ_NLEVELS; i++) { 399 if (sc->sc_zone.al[i].Pointer == NULL) 400 continue; 401 acpitz_power_zone(sc, i, 0); 402 } 403 sc->sc_active = ATZ_ACTIVE_NONE; 404 sc->sc_flags &= ~(ATZ_F_CRITICAL|ATZ_F_HOT|ATZ_F_PASSIVE); 405 } 406 407 static void 408 acpitz_get_zone(void *opaque, int verbose) 409 { 410 struct acpitz_softc *sc = opaque; 411 ACPI_STATUS rv; 412 char buf[8]; 413 int i, valid_levels; 414 415 if (!sc->sc_first) { 416 acpitz_power_off(sc); 417 418 for (i = 0; i < ATZ_NLEVELS; i++) { 419 if (sc->sc_zone.al[i].Pointer != NULL) 420 AcpiOsFree(sc->sc_zone.al[i].Pointer); 421 sc->sc_zone.al[i].Pointer = NULL; 422 } 423 } else 424 aprint_normal(":"); 425 426 valid_levels = 0; 427 428 for (i = 0; i < ATZ_NLEVELS; i++) { 429 ACPI_OBJECT *obj; 430 431 snprintf(buf, sizeof(buf), "_AC%d", i); 432 if (acpitz_get_integer(sc, buf, &sc->sc_zone.ac[i])) 433 continue; 434 435 snprintf(buf, sizeof(buf), "_AL%d", i); 436 rv = acpi_eval_struct(sc->sc_devnode->ad_handle, buf, 437 &sc->sc_zone.al[i]); 438 if (ACPI_FAILURE(rv)) { 439 sc->sc_zone.al[i].Pointer = NULL; 440 continue; 441 } 442 443 obj = sc->sc_zone.al[i].Pointer; 444 if (obj != NULL) { 445 if (obj->Type != ACPI_TYPE_PACKAGE) { 446 aprint_error("%d not package\n", i); 447 AcpiOsFree(obj); 448 sc->sc_zone.al[i].Pointer = NULL; 449 continue; 450 } 451 } 452 453 if (sc->sc_first) 454 aprint_normal(" active cooling level %d: %sC", i, 455 acpitz_celcius_string(sc->sc_zone.ac[i])); 456 457 valid_levels++; 458 } 459 460 acpitz_get_integer(sc, "_TMP", &sc->sc_zone.tmp); 461 acpitz_get_integer(sc, "_CRT", &sc->sc_zone.crt); 462 acpitz_get_integer(sc, "_HOT", &sc->sc_zone.hot); 463 sc->sc_zone.psl.Length = ACPI_ALLOCATE_BUFFER; 464 sc->sc_zone.psl.Pointer = NULL; 465 AcpiEvaluateObject(sc, "_PSL", NULL, &sc->sc_zone.psl); 466 acpitz_get_integer(sc, "_PSV", &sc->sc_zone.psv); 467 acpitz_get_integer(sc, "_TC1", &sc->sc_zone.tc1); 468 acpitz_get_integer(sc, "_TC2", &sc->sc_zone.tc2); 469 470 acpitz_sane_temp(&sc->sc_zone.tmp); 471 acpitz_sane_temp(&sc->sc_zone.crt); 472 acpitz_sane_temp(&sc->sc_zone.hot); 473 acpitz_sane_temp(&sc->sc_zone.psv); 474 475 if (verbose) { 476 if (sc->sc_zone.crt != ATZ_TMP_INVALID) 477 aprint_normal(" critical %sC", 478 acpitz_celcius_string(sc->sc_zone.crt)); 479 if (sc->sc_zone.hot != ATZ_TMP_INVALID) 480 aprint_normal(" hot %sC", 481 acpitz_celcius_string(sc->sc_zone.hot)); 482 if (sc->sc_zone.psv != ATZ_TMP_INVALID) 483 aprint_normal(" passive %sC", 484 acpitz_celcius_string(sc->sc_zone.tmp)); 485 } 486 487 if (valid_levels == 0) { 488 sc->sc_flags |= ATZ_F_PASSIVEONLY; 489 if (sc->sc_first) 490 aprint_normal(", passive cooling"); 491 } 492 if (verbose) 493 aprint_normal("\n"); 494 495 for (i = 0; i < ATZ_NLEVELS; i++) 496 acpitz_sane_temp(&sc->sc_zone.ac[i]); 497 498 acpitz_power_off(sc); 499 sc->sc_first = 0; 500 } 501 502 503 static void 504 acpitz_notify_handler(ACPI_HANDLE hdl, UINT32 notify, void *opaque) 505 { 506 struct acpitz_softc *sc = opaque; 507 ACPI_OSD_EXEC_CALLBACK func = NULL; 508 const char *name; 509 int rv; 510 511 switch (notify) { 512 case ACPI_NOTIFY_ThermalZoneStatusChanged: 513 func = acpitz_get_status; 514 name = "status check"; 515 break; 516 case ACPI_NOTIFY_ThermalZoneTripPointsChanged: 517 case ACPI_NOTIFY_DeviceListsChanged: 518 func = acpitz_get_zone_quiet; 519 name = "get zone"; 520 break; 521 default: 522 printf("%s: received unhandled notify message 0x%x\n", 523 sc->sc_dev.dv_xname, notify); 524 return; 525 } 526 527 KASSERT(func != NULL); 528 529 rv = AcpiOsExecute(OSL_NOTIFY_HANDLER, func, sc); 530 if (rv != AE_OK) 531 printf("%s: unable to queue %s\n", sc->sc_dev.dv_xname, name); 532 533 return; 534 } 535 536 static void 537 acpitz_sane_temp(UINT32 *tmp) 538 { 539 /* Sane temperatures are beteen 0 and 150 C */ 540 if (*tmp < ATZ_ZEROC || *tmp > ATZ_ZEROC + 1500) 541 *tmp = ATZ_TMP_INVALID; 542 } 543 544 static int 545 acpitz_get_integer(struct acpitz_softc *sc, const char *cm, UINT32 *val) 546 { 547 ACPI_STATUS rv; 548 ACPI_INTEGER tmp; 549 550 rv = acpi_eval_integer(sc->sc_devnode->ad_handle, cm, &tmp); 551 if (ACPI_FAILURE(rv)) { 552 #ifdef ACPI_DEBUG 553 printf("%s: failed to evaluate %s: %s\n", sc->sc_dev.dv_xname, 554 cm, AcpiFormatException(rv)); 555 #endif 556 *val = ATZ_TMP_INVALID; 557 return 1; 558 } 559 560 *val = tmp; 561 562 return 0; 563 } 564 565 static void 566 acpitz_tick(void *opaque) 567 { 568 struct acpitz_softc *sc = opaque; 569 570 AcpiOsExecute(OSL_NOTIFY_HANDLER, acpitz_get_status, sc); 571 572 callout_schedule(&sc->sc_callout, sc->sc_zone.tzp * hz / 10); 573 } 574 575 static void 576 acpitz_init_envsys(struct acpitz_softc *sc) 577 { 578 sc->sc_sme = sysmon_envsys_create(); 579 sc->sc_sensor.monitor = true; 580 sc->sc_sensor.flags = (ENVSYS_FMONCRITICAL|ENVSYS_FMONWARNOVER); 581 strlcpy(sc->sc_sensor.desc, "temperature", sizeof(sc->sc_sensor.desc)); 582 if (sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensor)) { 583 sysmon_envsys_destroy(sc->sc_sme); 584 return; 585 } 586 587 /* hook into sysmon */ 588 sc->sc_sme->sme_name = sc->sc_dev.dv_xname; 589 sc->sc_sme->sme_cookie = sc; 590 sc->sc_sme->sme_flags = SME_DISABLE_REFRESH; 591 592 if (sysmon_envsys_register(sc->sc_sme)) { 593 printf("%s: unable to register with sysmon\n", 594 sc->sc_dev.dv_xname); 595 sysmon_envsys_destroy(sc->sc_sme); 596 } 597 } 598