acpi_tz.c revision 1.28 1 /* $NetBSD: acpi_tz.c,v 1.28 2007/12/01 05:12:09 jmcneill Exp $ */
2
3 /*
4 * Copyright (c) 2003 Jared D. McNeill <jmcneill (at) 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.28 2007/12/01 05:12:09 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
117 static void acpitz_get_status(void *);
118 static void acpitz_get_zone(void *, int);
119 static void acpitz_get_zone_quiet(void *);
120 static char* acpitz_celcius_string(int);
121 static void acpitz_print_status(struct acpitz_softc *);
122 static void acpitz_power_off(struct acpitz_softc *);
123 static void acpitz_power_zone(struct acpitz_softc *, int, int);
124 static void acpitz_sane_temp(UINT32 *tmp);
125 static ACPI_STATUS
126 acpitz_switch_cooler(ACPI_OBJECT *, void *);
127 static void acpitz_notify_handler(ACPI_HANDLE, UINT32, void *);
128 static int acpitz_get_integer(struct acpitz_softc *, const char *, UINT32 *);
129 static void acpitz_tick(void *);
130 static void acpitz_init_envsys(struct acpitz_softc *);
131
132 CFATTACH_DECL(acpitz, sizeof(struct acpitz_softc), acpitz_match,
133 acpitz_attach, NULL, NULL);
134
135 /*
136 * acpitz_match: autoconf(9) match routine
137 */
138 static int
139 acpitz_match(struct device *parent, struct cfdata *match, void *aux)
140 {
141 struct acpi_attach_args *aa = aux;
142
143 if (aa->aa_node->ad_type != ACPI_TYPE_THERMAL)
144 return 0;
145
146 return 1;
147 }
148
149 /*
150 * acpitz_attach: autoconf(9) attach routine
151 */
152 static void
153 acpitz_attach(struct device *parent, struct device *self, void *aux)
154 {
155 struct acpitz_softc *sc = (struct acpitz_softc *)self;
156 struct acpi_attach_args *aa = aux;
157 ACPI_STATUS rv;
158 ACPI_INTEGER v;
159
160 mutex_init(&sc->sc_mtx, MUTEX_DRIVER, IPL_NONE);
161
162 #if 0
163 sc->sc_flags = ATZ_F_VERBOSE;
164 #endif
165 sc->sc_devnode = aa->aa_node;
166
167 aprint_naive(": ACPI Thermal Zone\n");
168 aprint_normal(": ACPI Thermal Zone\n");
169
170 rv = acpi_eval_integer(sc->sc_devnode->ad_handle, "_TZP", &v);
171 if (ACPI_FAILURE(rv)) {
172 aprint_verbose("%s: unable to get polling interval; using default of",
173 sc->sc_dev.dv_xname);
174 sc->sc_zone.tzp = ATZ_TZP_RATE;
175 } else {
176 sc->sc_zone.tzp = v;
177 aprint_verbose("%s: polling interval is", sc->sc_dev.dv_xname);
178 }
179 aprint_verbose(" %d.%ds\n", sc->sc_zone.tzp / 10, sc->sc_zone.tzp % 10);
180
181 /* XXX a value of 0 means "polling is not necessary" */
182 if (sc->sc_zone.tzp == 0)
183 sc->sc_zone.tzp = ATZ_TZP_RATE;
184
185 sc->sc_zone_expire = ATZ_ZONE_EXPIRE / sc->sc_zone.tzp;
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("%s: unable to install SYSTEM NOTIFY handler: %s\n",
194 sc->sc_dev.dv_xname, 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 callout_schedule(&sc->sc_callout, sc->sc_zone.tzp * hz / 10);
204 }
205
206 static void
207 acpitz_get_zone_quiet(void *opaque)
208 {
209 acpitz_get_zone(opaque, 0);
210 }
211
212 static void
213 acpitz_get_status(void *opaque)
214 {
215 struct acpitz_softc *sc = opaque;
216 UINT32 tmp, active;
217 int i, flags;
218
219 sc->sc_zone_expire--;
220 if (sc->sc_zone_expire <= 0) {
221 sc->sc_zone_expire = ATZ_ZONE_EXPIRE / sc->sc_zone.tzp;
222 if (sc->sc_flags & ATZ_F_VERBOSE)
223 printf("%s: force refetch zone\n", sc->sc_dev.dv_xname);
224 acpitz_get_zone(sc, 0);
225 }
226
227 if (acpitz_get_integer(sc, "_TMP", &tmp)) {
228 aprint_error("%s: failed to evaluate _TMP\n",
229 sc->sc_dev.dv_xname);
230 return;
231 }
232 sc->sc_zone.tmp = tmp;
233 /* XXX sanity check for tmp here? */
234
235 /*
236 * The temperature unit for envsys(4) is microKelvin, so convert to
237 * that from ACPI's microKelvin. Also, the ACPI specification assumes
238 * that K = C + 273.2 rather than the nominal 273.15 used by envsys(4),
239 * so we correct for that too.
240 */
241 sc->sc_sensor.value_cur = sc->sc_zone.tmp * 100000 - 50000;
242 sc->sc_sensor.state = ENVSYS_SVALID;
243
244 if (sc->sc_flags & ATZ_F_VERBOSE)
245 acpitz_print_status(sc);
246
247 if (sc->sc_flags & ATZ_F_PASSIVEONLY) {
248 /* Passive Cooling: XXX not yet */
249
250 } else {
251 /* Active Cooling */
252
253 /* temperature threshold: _AC0 > ... > _AC9 */
254 active = ATZ_ACTIVE_NONE;
255 for (i = ATZ_NLEVELS - 1; i >= 0; i--) {
256 if (sc->sc_zone.ac[i] == ATZ_TMP_INVALID)
257 continue;
258
259 /* we want to keep highest cooling mode in 'active' */
260 if (sc->sc_zone.ac[i] <= tmp)
261 active = i;
262 }
263
264 flags = sc->sc_flags & ~(ATZ_F_CRITICAL|ATZ_F_HOT|ATZ_F_PASSIVE);
265 if (sc->sc_zone.psv != ATZ_TMP_INVALID &&
266 tmp >= sc->sc_zone.psv)
267 flags |= ATZ_F_PASSIVE;
268 if (sc->sc_zone.hot != ATZ_TMP_INVALID &&
269 tmp >= sc->sc_zone.hot)
270 flags |= ATZ_F_HOT;
271 if (sc->sc_zone.crt != ATZ_TMP_INVALID &&
272 tmp >= sc->sc_zone.crt)
273 flags |= ATZ_F_CRITICAL;
274
275 if (flags != sc->sc_flags) {
276 int changed = (sc->sc_flags ^ flags) & flags;
277 sc->sc_flags = flags;
278 if (changed & ATZ_F_CRITICAL) {
279 sc->sc_sensor.state = ENVSYS_SCRITICAL;
280 printf("%s: zone went critical at temp %sC\n",
281 sc->sc_dev.dv_xname,
282 acpitz_celcius_string(tmp));
283 } else if (changed & ATZ_F_HOT) {
284 sc->sc_sensor.state = ENVSYS_SWARNOVER;
285 printf("%s: zone went hot at temp %sC\n",
286 sc->sc_dev.dv_xname,
287 acpitz_celcius_string(tmp));
288 }
289 }
290
291 /* power on fans */
292 if (sc->sc_active != active) {
293 if (sc->sc_active != ATZ_ACTIVE_NONE)
294 acpitz_power_zone(sc, sc->sc_active, 0);
295
296 if (active != ATZ_ACTIVE_NONE) {
297 if (sc->sc_flags & ATZ_F_VERBOSE)
298 printf("%s: active cooling level %u\n",
299 sc->sc_dev.dv_xname, active);
300 acpitz_power_zone(sc, active, 1);
301 }
302
303 sc->sc_active = active;
304 }
305 }
306
307 return;
308 }
309
310 static char *
311 acpitz_celcius_string(int dk)
312 {
313 static char buf[10];
314
315 snprintf(buf, sizeof(buf), "%d.%d", (dk - ATZ_ZEROC) / 10,
316 (dk - ATZ_ZEROC) % 10);
317
318 return buf;
319 }
320
321 static void
322 acpitz_print_status(struct acpitz_softc *sc)
323 {
324
325 printf("%s: zone temperature is now %sC\n", sc->sc_dev.dv_xname,
326 acpitz_celcius_string(sc->sc_zone.tmp));
327
328 return;
329 }
330
331 static ACPI_STATUS
332 acpitz_switch_cooler(ACPI_OBJECT *obj, void *arg)
333 {
334 ACPI_HANDLE cooler;
335 ACPI_STATUS rv;
336 int pwr_state, flag;
337
338 flag = *(int *)arg;
339
340 if (flag)
341 pwr_state = ACPI_STATE_D0;
342 else
343 pwr_state = ACPI_STATE_D3;
344
345 switch(obj->Type) {
346 case ACPI_TYPE_ANY:
347 cooler = obj->Reference.Handle;
348 break;
349 case ACPI_TYPE_STRING:
350 rv = AcpiGetHandle(NULL, obj->String.Pointer, &cooler);
351 if (ACPI_FAILURE(rv)) {
352 printf("failed to get handler from %s\n",
353 obj->String.Pointer);
354 return rv;
355 }
356 break;
357 default:
358 printf("unknown power type: %d\n", obj->Type);
359 return AE_OK;
360 }
361
362 rv = acpi_pwr_switch_consumer(cooler, pwr_state);
363 if (rv != AE_BAD_PARAMETER && ACPI_FAILURE(rv)) {
364 printf("failed to change state for %s: %s\n",
365 acpi_name(obj->Reference.Handle),
366 AcpiFormatException(rv));
367 }
368
369 return AE_OK;
370 }
371
372 /*
373 * acpitz_power_zone:
374 * power on or off the i:th part of the zone zone
375 */
376 static void
377 acpitz_power_zone(struct acpitz_softc *sc, int i, int on)
378 {
379 KASSERT(i >= 0 && i < ATZ_NLEVELS);
380
381 acpi_foreach_package_object(sc->sc_zone.al[i].Pointer,
382 acpitz_switch_cooler, &on);
383 }
384
385
386 /*
387 * acpitz_power_off:
388 * power off parts of the zone
389 */
390 static void
391 acpitz_power_off(struct acpitz_softc *sc)
392 {
393 int i;
394
395 for (i = 0 ; i < ATZ_NLEVELS; i++) {
396 if (sc->sc_zone.al[i].Pointer == NULL)
397 continue;
398 acpitz_power_zone(sc, i, 0);
399 }
400 sc->sc_active = ATZ_ACTIVE_NONE;
401 sc->sc_flags &= ~(ATZ_F_CRITICAL|ATZ_F_HOT|ATZ_F_PASSIVE);
402 }
403
404 static void
405 acpitz_get_zone(void *opaque, int verbose)
406 {
407 struct acpitz_softc *sc = opaque;
408 ACPI_STATUS rv;
409 char buf[8];
410 int i, valid_levels;
411 static int first = 1;
412
413 if (!first) {
414 acpitz_power_off(sc);
415
416 for (i = 0; i < ATZ_NLEVELS; i++) {
417 if (sc->sc_zone.al[i].Pointer != NULL)
418 AcpiOsFree(sc->sc_zone.al[i].Pointer);
419 sc->sc_zone.al[i].Pointer = NULL;
420 }
421 }
422
423 valid_levels = 0;
424
425 for (i = 0; i < ATZ_NLEVELS; i++) {
426 ACPI_OBJECT *obj;
427
428 snprintf(buf, sizeof(buf), "_AC%d", i);
429 if (acpitz_get_integer(sc, buf, &sc->sc_zone.ac[i]))
430 continue;
431
432 snprintf(buf, sizeof(buf), "_AL%d", i);
433 rv = acpi_eval_struct(sc->sc_devnode->ad_handle, buf,
434 &sc->sc_zone.al[i]);
435 if (ACPI_FAILURE(rv)) {
436 sc->sc_zone.al[i].Pointer = NULL;
437 continue;
438 }
439
440 obj = sc->sc_zone.al[i].Pointer;
441 if (obj != NULL) {
442 if (obj->Type != ACPI_TYPE_PACKAGE) {
443 printf("%s: ac%d not package\n",
444 sc->sc_dev.dv_xname, i);
445 AcpiOsFree(obj);
446 sc->sc_zone.al[i].Pointer = NULL;
447 continue;
448 }
449 }
450
451 if (first)
452 aprint_normal("%s: active cooling level %d: %sC\n",
453 sc->sc_dev.dv_xname, i,
454 acpitz_celcius_string(sc->sc_zone.ac[i]));
455
456 valid_levels++;
457 }
458
459 if (valid_levels == 0) {
460 sc->sc_flags |= ATZ_F_PASSIVEONLY;
461 if (first)
462 aprint_normal("%s: passive cooling mode only\n",
463 sc->sc_dev.dv_xname);
464 }
465
466 acpitz_get_integer(sc, "_TMP", &sc->sc_zone.tmp);
467 acpitz_get_integer(sc, "_CRT", &sc->sc_zone.crt);
468 acpitz_get_integer(sc, "_HOT", &sc->sc_zone.hot);
469 sc->sc_zone.psl.Length = ACPI_ALLOCATE_BUFFER;
470 sc->sc_zone.psl.Pointer = NULL;
471 AcpiEvaluateObject(sc, "_PSL", NULL, &sc->sc_zone.psl);
472 acpitz_get_integer(sc, "_PSV", &sc->sc_zone.psv);
473 acpitz_get_integer(sc, "_TC1", &sc->sc_zone.tc1);
474 acpitz_get_integer(sc, "_TC2", &sc->sc_zone.tc2);
475
476 acpitz_sane_temp(&sc->sc_zone.tmp);
477 acpitz_sane_temp(&sc->sc_zone.crt);
478 acpitz_sane_temp(&sc->sc_zone.hot);
479 acpitz_sane_temp(&sc->sc_zone.psv);
480
481 if (verbose) {
482 aprint_normal("%s:", sc->sc_dev.dv_xname);
483 if (sc->sc_zone.crt != ATZ_TMP_INVALID)
484 aprint_normal(" critical %sC",
485 acpitz_celcius_string(sc->sc_zone.crt));
486 if (sc->sc_zone.hot != ATZ_TMP_INVALID)
487 aprint_normal(" hot %sC",
488 acpitz_celcius_string(sc->sc_zone.hot));
489 if (sc->sc_zone.psv != ATZ_TMP_INVALID)
490 aprint_normal(" passive %sC",
491 acpitz_celcius_string(sc->sc_zone.tmp));
492 aprint_normal("\n");
493 }
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 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 = AcpiOsQueueForExecution(OSD_PRIORITY_LO, 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 AcpiOsQueueForExecution(OSD_PRIORITY_LO, 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