2 * Copyright (c) 2000, 2001 Michael Smith
3 * Copyright (c) 2000 BSDi
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, 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
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/kernel.h>
36 #include <sys/kthread.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
41 #include <sys/reboot.h>
42 #include <sys/sysctl.h>
43 #include <sys/unistd.h>
44 #include <sys/power.h>
46 #include "cpufreq_if.h"
48 #include <contrib/dev/acpica/include/acpi.h>
49 #include <contrib/dev/acpica/include/accommon.h>
51 #include <dev/acpica/acpivar.h>
53 /* Hooks for the ACPI CA debugging infrastructure */
54 #define _COMPONENT ACPI_THERMAL
55 ACPI_MODULE_NAME("THERMAL")
58 #define TZ_KELVTOC(x) (((x) - TZ_ZEROC) / 10), abs(((x) - TZ_ZEROC) % 10)
60 #define TZ_NOTIFY_TEMPERATURE 0x80 /* Temperature changed. */
61 #define TZ_NOTIFY_LEVELS 0x81 /* Cooling levels changed. */
62 #define TZ_NOTIFY_DEVICES 0x82 /* Device lists changed. */
63 #define TZ_NOTIFY_CRITICAL 0xcc /* Fake notify that _CRT/_HOT reached. */
65 /* Check for temperature changes every 10 seconds by default */
66 #define TZ_POLLRATE 10
68 /* Make sure the reported temperature is valid for this number of polls. */
69 #define TZ_VALIDCHECKS 3
71 /* Notify the user we will be shutting down in one more poll cycle. */
72 #define TZ_NOTIFYCOUNT (TZ_VALIDCHECKS - 1)
74 /* ACPI spec defines this */
75 #define TZ_NUMLEVELS 10
78 ACPI_BUFFER al[TZ_NUMLEVELS];
89 struct acpi_tz_softc {
91 ACPI_HANDLE tz_handle; /*Thermal zone handle*/
92 int tz_temperature; /*Current temperature*/
93 int tz_active; /*Current active cooling*/
94 #define TZ_ACTIVE_NONE -1
95 #define TZ_ACTIVE_UNKNOWN -2
96 int tz_requested; /*Minimum active cooling*/
97 int tz_thflags; /*Current temp-related flags*/
98 #define TZ_THFLAG_NONE 0
99 #define TZ_THFLAG_PSV (1<<0)
100 #define TZ_THFLAG_HOT (1<<2)
101 #define TZ_THFLAG_CRT (1<<3)
103 #define TZ_FLAG_NO_SCP (1<<0) /*No _SCP method*/
104 #define TZ_FLAG_GETPROFILE (1<<1) /*Get power_profile in timeout*/
105 #define TZ_FLAG_GETSETTINGS (1<<2) /*Get devs/setpoints*/
106 struct timespec tz_cooling_started;
107 /*Current cooling starting time*/
109 struct sysctl_ctx_list tz_sysctl_ctx;
110 struct sysctl_oid *tz_sysctl_tree;
111 eventhandler_tag tz_event;
113 struct acpi_tz_zone tz_zone; /*Thermal zone parameters*/
116 /* passive cooling */
117 struct proc *tz_cooling_proc;
118 int tz_cooling_proc_running;
119 int tz_cooling_enabled;
120 int tz_cooling_active;
121 int tz_cooling_updated;
122 int tz_cooling_saved_freq;
125 #define CPUFREQ_MAX_LEVELS 64 /* XXX cpufreq should export this */
127 static int acpi_tz_probe(device_t dev);
128 static int acpi_tz_attach(device_t dev);
129 static int acpi_tz_establish(struct acpi_tz_softc *sc);
130 static void acpi_tz_monitor(void *Context);
131 static void acpi_tz_switch_cooler_off(ACPI_OBJECT *obj, void *arg);
132 static void acpi_tz_switch_cooler_on(ACPI_OBJECT *obj, void *arg);
133 static void acpi_tz_getparam(struct acpi_tz_softc *sc, char *node,
135 static void acpi_tz_sanity(struct acpi_tz_softc *sc, int *val, char *what);
136 static int acpi_tz_active_sysctl(SYSCTL_HANDLER_ARGS);
137 static int acpi_tz_cooling_sysctl(SYSCTL_HANDLER_ARGS);
138 static int acpi_tz_temp_sysctl(SYSCTL_HANDLER_ARGS);
139 static int acpi_tz_passive_sysctl(SYSCTL_HANDLER_ARGS);
140 static void acpi_tz_notify_handler(ACPI_HANDLE h, UINT32 notify,
142 static void acpi_tz_signal(struct acpi_tz_softc *sc, int flags);
143 static void acpi_tz_timeout(struct acpi_tz_softc *sc, int flags);
144 static void acpi_tz_power_profile(void *arg);
145 static void acpi_tz_thread(void *arg);
146 static int acpi_tz_cooling_is_available(struct acpi_tz_softc *sc);
147 static int acpi_tz_cooling_thread_start(struct acpi_tz_softc *sc);
149 static device_method_t acpi_tz_methods[] = {
150 /* Device interface */
151 DEVMETHOD(device_probe, acpi_tz_probe),
152 DEVMETHOD(device_attach, acpi_tz_attach),
157 static driver_t acpi_tz_driver = {
160 sizeof(struct acpi_tz_softc),
163 static devclass_t acpi_tz_devclass;
164 DRIVER_MODULE(acpi_tz, acpi, acpi_tz_driver, acpi_tz_devclass, 0, 0);
165 MODULE_DEPEND(acpi_tz, acpi, 1, 1, 1);
167 static struct sysctl_ctx_list acpi_tz_sysctl_ctx;
168 static struct sysctl_oid *acpi_tz_sysctl_tree;
170 /* Minimum cooling run time */
171 static int acpi_tz_min_runtime;
172 static int acpi_tz_polling_rate = TZ_POLLRATE;
173 static int acpi_tz_override;
175 /* Timezone polling thread */
176 static struct proc *acpi_tz_proc;
177 ACPI_LOCK_DECL(thermal, "ACPI thermal zone");
179 static int acpi_tz_cooling_unit = -1;
182 acpi_tz_probe(device_t dev)
186 if (acpi_get_type(dev) == ACPI_TYPE_THERMAL && !acpi_disabled("thermal")) {
187 device_set_desc(dev, "Thermal Zone");
195 acpi_tz_attach(device_t dev)
197 struct acpi_tz_softc *sc;
198 struct acpi_softc *acpi_sc;
202 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
204 sc = device_get_softc(dev);
206 sc->tz_handle = acpi_get_handle(dev);
207 sc->tz_requested = TZ_ACTIVE_NONE;
208 sc->tz_active = TZ_ACTIVE_UNKNOWN;
209 sc->tz_thflags = TZ_THFLAG_NONE;
210 sc->tz_cooling_proc = NULL;
211 sc->tz_cooling_proc_running = FALSE;
212 sc->tz_cooling_active = FALSE;
213 sc->tz_cooling_updated = FALSE;
214 sc->tz_cooling_enabled = FALSE;
217 * Parse the current state of the thermal zone and build control
218 * structures. We don't need to worry about interference with the
219 * control thread since we haven't fully attached this device yet.
221 if ((error = acpi_tz_establish(sc)) != 0)
225 * Register for any Notify events sent to this zone.
227 AcpiInstallNotifyHandler(sc->tz_handle, ACPI_DEVICE_NOTIFY,
228 acpi_tz_notify_handler, sc);
231 * Create our sysctl nodes.
233 * XXX we need a mechanism for adding nodes under ACPI.
235 if (device_get_unit(dev) == 0) {
236 acpi_sc = acpi_device_get_parent_softc(dev);
237 sysctl_ctx_init(&acpi_tz_sysctl_ctx);
238 acpi_tz_sysctl_tree = SYSCTL_ADD_NODE(&acpi_tz_sysctl_ctx,
239 SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree),
240 OID_AUTO, "thermal", CTLFLAG_RD, 0, "");
241 SYSCTL_ADD_INT(&acpi_tz_sysctl_ctx,
242 SYSCTL_CHILDREN(acpi_tz_sysctl_tree),
243 OID_AUTO, "min_runtime", CTLFLAG_RW,
244 &acpi_tz_min_runtime, 0,
245 "minimum cooling run time in sec");
246 SYSCTL_ADD_INT(&acpi_tz_sysctl_ctx,
247 SYSCTL_CHILDREN(acpi_tz_sysctl_tree),
248 OID_AUTO, "polling_rate", CTLFLAG_RW,
249 &acpi_tz_polling_rate, 0, "monitor polling rate");
250 SYSCTL_ADD_INT(&acpi_tz_sysctl_ctx,
251 SYSCTL_CHILDREN(acpi_tz_sysctl_tree), OID_AUTO,
252 "user_override", CTLFLAG_RW, &acpi_tz_override, 0,
253 "allow override of thermal settings");
255 sysctl_ctx_init(&sc->tz_sysctl_ctx);
256 sprintf(oidname, "tz%d", device_get_unit(dev));
257 sc->tz_sysctl_tree = SYSCTL_ADD_NODE(&sc->tz_sysctl_ctx,
258 SYSCTL_CHILDREN(acpi_tz_sysctl_tree),
259 OID_AUTO, oidname, CTLFLAG_RD, 0, "");
260 SYSCTL_ADD_OPAQUE(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
261 OID_AUTO, "temperature", CTLFLAG_RD, &sc->tz_temperature,
262 sizeof(sc->tz_temperature), "IK",
263 "current thermal zone temperature");
264 SYSCTL_ADD_PROC(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
265 OID_AUTO, "active", CTLTYPE_INT | CTLFLAG_RW,
266 sc, 0, acpi_tz_active_sysctl, "I", "cooling is active");
267 SYSCTL_ADD_PROC(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
268 OID_AUTO, "passive_cooling", CTLTYPE_INT | CTLFLAG_RW,
269 sc, 0, acpi_tz_cooling_sysctl, "I",
270 "enable passive (speed reduction) cooling");
272 SYSCTL_ADD_INT(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
273 OID_AUTO, "thermal_flags", CTLFLAG_RD,
274 &sc->tz_thflags, 0, "thermal zone flags");
275 SYSCTL_ADD_PROC(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
276 OID_AUTO, "_PSV", CTLTYPE_INT | CTLFLAG_RW,
277 sc, offsetof(struct acpi_tz_softc, tz_zone.psv),
278 acpi_tz_temp_sysctl, "IK", "passive cooling temp setpoint");
279 SYSCTL_ADD_PROC(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
280 OID_AUTO, "_HOT", CTLTYPE_INT | CTLFLAG_RW,
281 sc, offsetof(struct acpi_tz_softc, tz_zone.hot),
282 acpi_tz_temp_sysctl, "IK",
283 "too hot temp setpoint (suspend now)");
284 SYSCTL_ADD_PROC(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
285 OID_AUTO, "_CRT", CTLTYPE_INT | CTLFLAG_RW,
286 sc, offsetof(struct acpi_tz_softc, tz_zone.crt),
287 acpi_tz_temp_sysctl, "IK",
288 "critical temp setpoint (shutdown now)");
289 SYSCTL_ADD_OPAQUE(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
290 OID_AUTO, "_ACx", CTLFLAG_RD, &sc->tz_zone.ac,
291 sizeof(sc->tz_zone.ac), "IK", "");
292 SYSCTL_ADD_PROC(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
293 OID_AUTO, "_TC1", CTLTYPE_INT | CTLFLAG_RW,
294 sc, offsetof(struct acpi_tz_softc, tz_zone.tc1),
295 acpi_tz_passive_sysctl, "I",
296 "thermal constant 1 for passive cooling");
297 SYSCTL_ADD_PROC(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
298 OID_AUTO, "_TC2", CTLTYPE_INT | CTLFLAG_RW,
299 sc, offsetof(struct acpi_tz_softc, tz_zone.tc2),
300 acpi_tz_passive_sysctl, "I",
301 "thermal constant 2 for passive cooling");
302 SYSCTL_ADD_PROC(&sc->tz_sysctl_ctx, SYSCTL_CHILDREN(sc->tz_sysctl_tree),
303 OID_AUTO, "_TSP", CTLTYPE_INT | CTLFLAG_RW,
304 sc, offsetof(struct acpi_tz_softc, tz_zone.tsp),
305 acpi_tz_passive_sysctl, "I",
306 "thermal sampling period for passive cooling");
309 * Create thread to service all of the thermal zones. Register
310 * our power profile event handler.
312 sc->tz_event = EVENTHANDLER_REGISTER(power_profile_change,
313 acpi_tz_power_profile, sc, 0);
314 if (acpi_tz_proc == NULL) {
315 error = kproc_create(acpi_tz_thread, NULL, &acpi_tz_proc,
316 RFHIGHPID, 0, "acpi_thermal");
318 device_printf(sc->tz_dev, "could not create thread - %d", error);
324 * Create a thread to handle passive cooling for 1st zone which
325 * has _PSV, _TSP, _TC1 and _TC2. Users can enable it for other
326 * zones manually for now.
328 * XXX We enable only one zone to avoid multiple zones conflict
329 * with each other since cpufreq currently sets all CPUs to the
330 * given frequency whereas it's possible for different thermal
331 * zones to specify independent settings for multiple CPUs.
333 if (acpi_tz_cooling_unit < 0 && acpi_tz_cooling_is_available(sc))
334 sc->tz_cooling_enabled = TRUE;
335 if (sc->tz_cooling_enabled) {
336 error = acpi_tz_cooling_thread_start(sc);
338 sc->tz_cooling_enabled = FALSE;
341 acpi_tz_cooling_unit = device_get_unit(dev);
345 * Flag the event handler for a manual invocation by our timeout.
346 * We defer it like this so that the rest of the subsystem has time
347 * to come up. Don't bother evaluating/printing the temperature at
348 * this point; on many systems it'll be bogus until the EC is running.
350 sc->tz_flags |= TZ_FLAG_GETPROFILE;
354 EVENTHANDLER_DEREGISTER(power_profile_change, sc->tz_event);
355 AcpiRemoveNotifyHandler(sc->tz_handle, ACPI_DEVICE_NOTIFY,
356 acpi_tz_notify_handler);
357 sysctl_ctx_free(&sc->tz_sysctl_ctx);
359 return_VALUE (error);
363 * Parse the current state of this thermal zone and set up to use it.
365 * Note that we may have previous state, which will have to be discarded.
368 acpi_tz_establish(struct acpi_tz_softc *sc)
374 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
376 /* Erase any existing state. */
377 for (i = 0; i < TZ_NUMLEVELS; i++)
378 if (sc->tz_zone.al[i].Pointer != NULL)
379 AcpiOsFree(sc->tz_zone.al[i].Pointer);
380 if (sc->tz_zone.psl.Pointer != NULL)
381 AcpiOsFree(sc->tz_zone.psl.Pointer);
384 * XXX: We initialize only ACPI_BUFFER to avoid race condition
385 * with passive cooling thread which refers psv, tc1, tc2 and tsp.
387 bzero(sc->tz_zone.ac, sizeof(sc->tz_zone.ac));
388 bzero(sc->tz_zone.al, sizeof(sc->tz_zone.al));
389 bzero(&sc->tz_zone.psl, sizeof(sc->tz_zone.psl));
391 /* Evaluate thermal zone parameters. */
392 for (i = 0; i < TZ_NUMLEVELS; i++) {
393 sprintf(nbuf, "_AC%d", i);
394 acpi_tz_getparam(sc, nbuf, &sc->tz_zone.ac[i]);
395 sprintf(nbuf, "_AL%d", i);
396 sc->tz_zone.al[i].Length = ACPI_ALLOCATE_BUFFER;
397 sc->tz_zone.al[i].Pointer = NULL;
398 AcpiEvaluateObject(sc->tz_handle, nbuf, NULL, &sc->tz_zone.al[i]);
399 obj = (ACPI_OBJECT *)sc->tz_zone.al[i].Pointer;
401 /* Should be a package containing a list of power objects */
402 if (obj->Type != ACPI_TYPE_PACKAGE) {
403 device_printf(sc->tz_dev, "%s has unknown type %d, rejecting\n",
405 return_VALUE (ENXIO);
409 acpi_tz_getparam(sc, "_CRT", &sc->tz_zone.crt);
410 acpi_tz_getparam(sc, "_HOT", &sc->tz_zone.hot);
411 sc->tz_zone.psl.Length = ACPI_ALLOCATE_BUFFER;
412 sc->tz_zone.psl.Pointer = NULL;
413 AcpiEvaluateObject(sc->tz_handle, "_PSL", NULL, &sc->tz_zone.psl);
414 acpi_tz_getparam(sc, "_PSV", &sc->tz_zone.psv);
415 acpi_tz_getparam(sc, "_TC1", &sc->tz_zone.tc1);
416 acpi_tz_getparam(sc, "_TC2", &sc->tz_zone.tc2);
417 acpi_tz_getparam(sc, "_TSP", &sc->tz_zone.tsp);
418 acpi_tz_getparam(sc, "_TZP", &sc->tz_zone.tzp);
421 * Sanity-check the values we've been given.
423 * XXX what do we do about systems that give us the same value for
424 * more than one of these setpoints?
426 acpi_tz_sanity(sc, &sc->tz_zone.crt, "_CRT");
427 acpi_tz_sanity(sc, &sc->tz_zone.hot, "_HOT");
428 acpi_tz_sanity(sc, &sc->tz_zone.psv, "_PSV");
429 for (i = 0; i < TZ_NUMLEVELS; i++)
430 acpi_tz_sanity(sc, &sc->tz_zone.ac[i], "_ACx");
435 static char *aclevel_string[] = {
436 "NONE", "_AC0", "_AC1", "_AC2", "_AC3", "_AC4",
437 "_AC5", "_AC6", "_AC7", "_AC8", "_AC9"
440 static __inline const char *
441 acpi_tz_aclevel_string(int active)
443 if (active < -1 || active >= TZ_NUMLEVELS)
444 return (aclevel_string[0]);
446 return (aclevel_string[active + 1]);
450 * Get the current temperature.
453 acpi_tz_get_temperature(struct acpi_tz_softc *sc)
457 static char *tmp_name = "_TMP";
459 ACPI_FUNCTION_NAME ("acpi_tz_get_temperature");
461 /* Evaluate the thermal zone's _TMP method. */
462 status = acpi_GetInteger(sc->tz_handle, tmp_name, &temp);
463 if (ACPI_FAILURE(status)) {
464 ACPI_VPRINT(sc->tz_dev, acpi_device_get_parent_softc(sc->tz_dev),
465 "error fetching current temperature -- %s\n",
466 AcpiFormatException(status));
470 /* Check it for validity. */
471 acpi_tz_sanity(sc, &temp, tmp_name);
475 ACPI_DEBUG_PRINT((ACPI_DB_VALUES, "got %d.%dC\n", TZ_KELVTOC(temp)));
476 sc->tz_temperature = temp;
481 * Evaluate the condition of a thermal zone, take appropriate actions.
484 acpi_tz_monitor(void *Context)
486 struct acpi_tz_softc *sc;
487 struct timespec curtime;
490 int newactive, newflags;
492 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
494 sc = (struct acpi_tz_softc *)Context;
496 /* Get the current temperature. */
497 if (!acpi_tz_get_temperature(sc)) {
498 /* XXX disable zone? go to max cooling? */
501 temp = sc->tz_temperature;
504 * Work out what we ought to be doing right now.
506 * Note that the _ACx levels sort from hot to cold.
508 newactive = TZ_ACTIVE_NONE;
509 for (i = TZ_NUMLEVELS - 1; i >= 0; i--) {
510 if (sc->tz_zone.ac[i] != -1 && temp >= sc->tz_zone.ac[i]) {
512 if (sc->tz_active != newactive) {
513 ACPI_VPRINT(sc->tz_dev,
514 acpi_device_get_parent_softc(sc->tz_dev),
515 "_AC%d: temperature %d.%d >= setpoint %d.%d\n", i,
516 TZ_KELVTOC(temp), TZ_KELVTOC(sc->tz_zone.ac[i]));
522 * We are going to get _ACx level down (colder side), but give a guaranteed
523 * minimum cooling run time if requested.
525 if (acpi_tz_min_runtime > 0 && sc->tz_active != TZ_ACTIVE_NONE &&
526 sc->tz_active != TZ_ACTIVE_UNKNOWN &&
527 (newactive == TZ_ACTIVE_NONE || newactive > sc->tz_active)) {
529 getnanotime(&curtime);
530 timespecsub(&curtime, &sc->tz_cooling_started);
531 if (curtime.tv_sec < acpi_tz_min_runtime)
532 newactive = sc->tz_active;
535 /* Handle user override of active mode */
536 if (sc->tz_requested != TZ_ACTIVE_NONE && (newactive == TZ_ACTIVE_NONE
537 || sc->tz_requested < newactive))
538 newactive = sc->tz_requested;
540 /* update temperature-related flags */
541 newflags = TZ_THFLAG_NONE;
542 if (sc->tz_zone.psv != -1 && temp >= sc->tz_zone.psv)
543 newflags |= TZ_THFLAG_PSV;
544 if (sc->tz_zone.hot != -1 && temp >= sc->tz_zone.hot)
545 newflags |= TZ_THFLAG_HOT;
546 if (sc->tz_zone.crt != -1 && temp >= sc->tz_zone.crt)
547 newflags |= TZ_THFLAG_CRT;
549 /* If the active cooling state has changed, we have to switch things. */
550 if (sc->tz_active == TZ_ACTIVE_UNKNOWN) {
552 * We don't know which cooling device is on or off,
553 * so stop them all, because we now know which
554 * should be on (if any).
556 for (i = 0; i < TZ_NUMLEVELS; i++) {
557 if (sc->tz_zone.al[i].Pointer != NULL) {
558 acpi_ForeachPackageObject(
559 (ACPI_OBJECT *)sc->tz_zone.al[i].Pointer,
560 acpi_tz_switch_cooler_off, sc);
563 /* now we know that all devices are off */
564 sc->tz_active = TZ_ACTIVE_NONE;
567 if (newactive != sc->tz_active) {
568 /* Turn off the cooling devices that are on, if any are */
569 if (sc->tz_active != TZ_ACTIVE_NONE)
570 acpi_ForeachPackageObject(
571 (ACPI_OBJECT *)sc->tz_zone.al[sc->tz_active].Pointer,
572 acpi_tz_switch_cooler_off, sc);
574 /* Turn on cooling devices that are required, if any are */
575 if (newactive != TZ_ACTIVE_NONE) {
576 acpi_ForeachPackageObject(
577 (ACPI_OBJECT *)sc->tz_zone.al[newactive].Pointer,
578 acpi_tz_switch_cooler_on, sc);
580 ACPI_VPRINT(sc->tz_dev, acpi_device_get_parent_softc(sc->tz_dev),
581 "switched from %s to %s: %d.%dC\n",
582 acpi_tz_aclevel_string(sc->tz_active),
583 acpi_tz_aclevel_string(newactive), TZ_KELVTOC(temp));
584 sc->tz_active = newactive;
585 getnanotime(&sc->tz_cooling_started);
588 /* XXX (de)activate any passive cooling that may be required. */
591 * If the temperature is at _HOT or _CRT, increment our event count.
592 * If it has occurred enough times, shutdown the system. This is
593 * needed because some systems will report an invalid high temperature
594 * for one poll cycle. It is suspected this is due to the embedded
595 * controller timing out. A typical value is 138C for one cycle on
596 * a system that is otherwise 65C.
598 * If we're almost at that threshold, notify the user through devd(8).
600 if ((newflags & (TZ_THFLAG_HOT | TZ_THFLAG_CRT)) != 0) {
601 sc->tz_validchecks++;
602 if (sc->tz_validchecks == TZ_VALIDCHECKS) {
603 device_printf(sc->tz_dev,
604 "WARNING - current temperature (%d.%dC) exceeds safe limits\n",
605 TZ_KELVTOC(sc->tz_temperature));
606 shutdown_nice(RB_POWEROFF);
607 } else if (sc->tz_validchecks == TZ_NOTIFYCOUNT)
608 acpi_UserNotify("Thermal", sc->tz_handle, TZ_NOTIFY_CRITICAL);
610 sc->tz_validchecks = 0;
612 sc->tz_thflags = newflags;
618 * Given an object, verify that it's a reference to a device of some sort,
619 * and try to switch it off.
622 acpi_tz_switch_cooler_off(ACPI_OBJECT *obj, void *arg)
626 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
628 cooler = acpi_GetReference(NULL, obj);
629 if (cooler == NULL) {
630 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "can't get handle\n"));
634 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "called to turn %s off\n",
636 acpi_pwr_switch_consumer(cooler, ACPI_STATE_D3);
642 * Given an object, verify that it's a reference to a device of some sort,
643 * and try to switch it on.
645 * XXX replication of off/on function code is bad.
648 acpi_tz_switch_cooler_on(ACPI_OBJECT *obj, void *arg)
650 struct acpi_tz_softc *sc = (struct acpi_tz_softc *)arg;
654 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
656 cooler = acpi_GetReference(NULL, obj);
657 if (cooler == NULL) {
658 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "can't get handle\n"));
662 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "called to turn %s on\n",
664 status = acpi_pwr_switch_consumer(cooler, ACPI_STATE_D0);
665 if (ACPI_FAILURE(status)) {
666 ACPI_VPRINT(sc->tz_dev, acpi_device_get_parent_softc(sc->tz_dev),
667 "failed to activate %s - %s\n", acpi_name(cooler),
668 AcpiFormatException(status));
675 * Read/debug-print a parameter, default it to -1.
678 acpi_tz_getparam(struct acpi_tz_softc *sc, char *node, int *data)
681 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
683 if (ACPI_FAILURE(acpi_GetInteger(sc->tz_handle, node, data))) {
686 ACPI_DEBUG_PRINT((ACPI_DB_VALUES, "%s.%s = %d\n",
687 acpi_name(sc->tz_handle), node, *data));
694 * Sanity-check a temperature value. Assume that setpoints
695 * should be between 0C and 200C.
698 acpi_tz_sanity(struct acpi_tz_softc *sc, int *val, char *what)
700 if (*val != -1 && (*val < TZ_ZEROC || *val > TZ_ZEROC + 2000)) {
701 device_printf(sc->tz_dev, "%s value is absurd, ignored (%d.%dC)\n",
702 what, TZ_KELVTOC(*val));
708 * Respond to a sysctl on the active state node.
711 acpi_tz_active_sysctl(SYSCTL_HANDLER_ARGS)
713 struct acpi_tz_softc *sc;
717 sc = (struct acpi_tz_softc *)oidp->oid_arg1;
718 active = sc->tz_active;
719 error = sysctl_handle_int(oidp, &active, 0, req);
721 /* Error or no new value */
722 if (error != 0 || req->newptr == NULL)
724 if (active < -1 || active >= TZ_NUMLEVELS)
727 /* Set new preferred level and re-switch */
728 sc->tz_requested = active;
729 acpi_tz_signal(sc, 0);
734 acpi_tz_cooling_sysctl(SYSCTL_HANDLER_ARGS)
736 struct acpi_tz_softc *sc;
739 sc = (struct acpi_tz_softc *)oidp->oid_arg1;
740 enabled = sc->tz_cooling_enabled;
741 error = sysctl_handle_int(oidp, &enabled, 0, req);
743 /* Error or no new value */
744 if (error != 0 || req->newptr == NULL)
746 if (enabled != TRUE && enabled != FALSE)
750 if (acpi_tz_cooling_is_available(sc))
751 error = acpi_tz_cooling_thread_start(sc);
757 sc->tz_cooling_enabled = enabled;
762 acpi_tz_temp_sysctl(SYSCTL_HANDLER_ARGS)
764 struct acpi_tz_softc *sc;
769 temp_ptr = (int *)((uintptr_t)sc + oidp->oid_arg2);
771 error = sysctl_handle_int(oidp, &temp, 0, req);
773 /* Error or no new value */
774 if (error != 0 || req->newptr == NULL)
777 /* Only allow changing settings if override is set. */
778 if (!acpi_tz_override)
781 /* Check user-supplied value for sanity. */
782 acpi_tz_sanity(sc, &temp, "user-supplied temp");
791 acpi_tz_passive_sysctl(SYSCTL_HANDLER_ARGS)
793 struct acpi_tz_softc *sc;
798 val_ptr = (int *)((uintptr_t)sc + oidp->oid_arg2);
800 error = sysctl_handle_int(oidp, &val, 0, req);
802 /* Error or no new value */
803 if (error != 0 || req->newptr == NULL)
806 /* Only allow changing settings if override is set. */
807 if (!acpi_tz_override)
815 acpi_tz_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
817 struct acpi_tz_softc *sc = (struct acpi_tz_softc *)context;
819 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
822 case TZ_NOTIFY_TEMPERATURE:
823 /* Temperature change occurred */
824 acpi_tz_signal(sc, 0);
826 case TZ_NOTIFY_DEVICES:
827 case TZ_NOTIFY_LEVELS:
828 /* Zone devices/setpoints changed */
829 acpi_tz_signal(sc, TZ_FLAG_GETSETTINGS);
832 ACPI_VPRINT(sc->tz_dev, acpi_device_get_parent_softc(sc->tz_dev),
833 "unknown Notify event 0x%x\n", notify);
837 acpi_UserNotify("Thermal", h, notify);
843 acpi_tz_signal(struct acpi_tz_softc *sc, int flags)
846 sc->tz_flags |= flags;
847 ACPI_UNLOCK(thermal);
848 wakeup(&acpi_tz_proc);
852 * Notifies can be generated asynchronously but have also been seen to be
853 * triggered by other thermal methods. One system generates a notify of
854 * 0x81 when the fan is turned on or off. Another generates it when _SCP
855 * is called. To handle these situations, we check the zone via
856 * acpi_tz_monitor() before evaluating changes to setpoints or the cooling
860 acpi_tz_timeout(struct acpi_tz_softc *sc, int flags)
863 /* Check the current temperature and take action based on it */
866 /* If requested, get the power profile settings. */
867 if (flags & TZ_FLAG_GETPROFILE)
868 acpi_tz_power_profile(sc);
871 * If requested, check for new devices/setpoints. After finding them,
872 * check if we need to switch fans based on the new values.
874 if (flags & TZ_FLAG_GETSETTINGS) {
875 acpi_tz_establish(sc);
879 /* XXX passive cooling actions? */
883 * System power profile may have changed; fetch and notify the
884 * thermal zone accordingly.
886 * Since this can be called from an arbitrary eventhandler, it needs
887 * to get the ACPI lock itself.
890 acpi_tz_power_profile(void *arg)
893 struct acpi_tz_softc *sc = (struct acpi_tz_softc *)arg;
896 state = power_profile_get_state();
897 if (state != POWER_PROFILE_PERFORMANCE && state != POWER_PROFILE_ECONOMY)
900 /* check that we haven't decided there's no _SCP method */
901 if ((sc->tz_flags & TZ_FLAG_NO_SCP) == 0) {
903 /* Call _SCP to set the new profile */
904 status = acpi_SetInteger(sc->tz_handle, "_SCP",
905 (state == POWER_PROFILE_PERFORMANCE) ? 0 : 1);
906 if (ACPI_FAILURE(status)) {
907 if (status != AE_NOT_FOUND)
908 ACPI_VPRINT(sc->tz_dev,
909 acpi_device_get_parent_softc(sc->tz_dev),
910 "can't evaluate %s._SCP - %s\n",
911 acpi_name(sc->tz_handle),
912 AcpiFormatException(status));
913 sc->tz_flags |= TZ_FLAG_NO_SCP;
915 /* We have to re-evaluate the entire zone now */
916 acpi_tz_signal(sc, TZ_FLAG_GETSETTINGS);
922 * Thermal zone monitor thread.
925 acpi_tz_thread(void *arg)
930 struct acpi_tz_softc **sc;
932 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
939 /* If the number of devices has changed, re-evaluate. */
940 if (devclass_get_count(acpi_tz_devclass) != devcount) {
945 devclass_get_devices(acpi_tz_devclass, &devs, &devcount);
946 sc = malloc(sizeof(struct acpi_tz_softc *) * devcount, M_TEMP,
948 for (i = 0; i < devcount; i++)
949 sc[i] = device_get_softc(devs[i]);
952 /* Check for temperature events and act on them. */
953 for (i = 0; i < devcount; i++) {
955 flags = sc[i]->tz_flags;
956 sc[i]->tz_flags &= TZ_FLAG_NO_SCP;
957 ACPI_UNLOCK(thermal);
958 acpi_tz_timeout(sc[i], flags);
961 /* If more work to do, don't go to sleep yet. */
963 for (i = 0; i < devcount; i++) {
964 if (sc[i]->tz_flags & ~TZ_FLAG_NO_SCP)
969 * If we have no more work, sleep for a while, setting PDROP so that
970 * the mutex will not be reacquired. Otherwise, drop the mutex and
971 * loop to handle more events.
974 msleep(&acpi_tz_proc, &thermal_mutex, PZERO | PDROP, "tzpoll",
975 hz * acpi_tz_polling_rate);
977 ACPI_UNLOCK(thermal);
982 acpi_tz_cpufreq_restore(struct acpi_tz_softc *sc)
987 if (!sc->tz_cooling_updated)
989 if ((dev = devclass_get_device(devclass_find("cpufreq"), 0)) == NULL)
991 ACPI_VPRINT(sc->tz_dev, acpi_device_get_parent_softc(sc->tz_dev),
992 "temperature %d.%dC: resuming previous clock speed (%d MHz)\n",
993 TZ_KELVTOC(sc->tz_temperature), sc->tz_cooling_saved_freq);
994 error = CPUFREQ_SET(dev, NULL, CPUFREQ_PRIO_KERN);
996 sc->tz_cooling_updated = FALSE;
1001 acpi_tz_cpufreq_update(struct acpi_tz_softc *sc, int req)
1004 struct cf_level *levels;
1005 int num_levels, error, freq, desired_freq, perf, i;
1007 levels = malloc(CPUFREQ_MAX_LEVELS * sizeof(*levels), M_TEMP, M_NOWAIT);
1012 * Find the main device, cpufreq0. We don't yet support independent
1013 * CPU frequency control on SMP.
1015 if ((dev = devclass_get_device(devclass_find("cpufreq"), 0)) == NULL) {
1020 /* Get the current frequency. */
1021 error = CPUFREQ_GET(dev, &levels[0]);
1024 freq = levels[0].total_set.freq;
1026 /* Get the current available frequency levels. */
1027 num_levels = CPUFREQ_MAX_LEVELS;
1028 error = CPUFREQ_LEVELS(dev, levels, &num_levels);
1031 printf("cpufreq: need to increase CPUFREQ_MAX_LEVELS\n");
1035 /* Calculate the desired frequency as a percent of the max frequency. */
1036 perf = 100 * freq / levels[0].total_set.freq - req;
1039 else if (perf > 100)
1041 desired_freq = levels[0].total_set.freq * perf / 100;
1043 if (desired_freq < freq) {
1044 /* Find the closest available frequency, rounding down. */
1045 for (i = 0; i < num_levels; i++)
1046 if (levels[i].total_set.freq <= desired_freq)
1049 /* If we didn't find a relevant setting, use the lowest. */
1050 if (i == num_levels)
1053 /* If we didn't decrease frequency yet, don't increase it. */
1054 if (!sc->tz_cooling_updated) {
1055 sc->tz_cooling_active = FALSE;
1059 /* Use saved cpu frequency as maximum value. */
1060 if (desired_freq > sc->tz_cooling_saved_freq)
1061 desired_freq = sc->tz_cooling_saved_freq;
1063 /* Find the closest available frequency, rounding up. */
1064 for (i = num_levels - 1; i >= 0; i--)
1065 if (levels[i].total_set.freq >= desired_freq)
1068 /* If we didn't find a relevant setting, use the highest. */
1072 /* If we're going to the highest frequency, restore the old setting. */
1073 if (i == 0 || desired_freq == sc->tz_cooling_saved_freq) {
1074 error = acpi_tz_cpufreq_restore(sc);
1076 sc->tz_cooling_active = FALSE;
1081 /* If we are going to a new frequency, activate it. */
1082 if (levels[i].total_set.freq != freq) {
1083 ACPI_VPRINT(sc->tz_dev, acpi_device_get_parent_softc(sc->tz_dev),
1084 "temperature %d.%dC: %screasing clock speed "
1085 "from %d MHz to %d MHz\n",
1086 TZ_KELVTOC(sc->tz_temperature),
1087 (freq > levels[i].total_set.freq) ? "de" : "in",
1088 freq, levels[i].total_set.freq);
1089 error = CPUFREQ_SET(dev, &levels[i], CPUFREQ_PRIO_KERN);
1090 if (error == 0 && !sc->tz_cooling_updated) {
1091 sc->tz_cooling_saved_freq = freq;
1092 sc->tz_cooling_updated = TRUE;
1098 free(levels, M_TEMP);
1103 * Passive cooling thread; monitors current temperature according to the
1104 * cooling interval and calculates whether to scale back CPU frequency.
1107 acpi_tz_cooling_thread(void *arg)
1109 struct acpi_tz_softc *sc;
1110 int error, perf, curr_temp, prev_temp;
1112 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1114 sc = (struct acpi_tz_softc *)arg;
1116 prev_temp = sc->tz_temperature;
1117 while (sc->tz_cooling_enabled) {
1118 if (sc->tz_cooling_active)
1119 (void)acpi_tz_get_temperature(sc);
1120 curr_temp = sc->tz_temperature;
1121 if (curr_temp >= sc->tz_zone.psv)
1122 sc->tz_cooling_active = TRUE;
1123 if (sc->tz_cooling_active) {
1124 perf = sc->tz_zone.tc1 * (curr_temp - prev_temp) +
1125 sc->tz_zone.tc2 * (curr_temp - sc->tz_zone.psv);
1129 error = acpi_tz_cpufreq_update(sc, perf);
1132 * If error and not simply a higher priority setting was
1133 * active, disable cooling.
1135 if (error != 0 && error != EPERM) {
1136 device_printf(sc->tz_dev,
1137 "failed to set new freq, disabling passive cooling\n");
1138 sc->tz_cooling_enabled = FALSE;
1142 prev_temp = curr_temp;
1143 tsleep(&sc->tz_cooling_proc, PZERO, "cooling",
1144 hz * sc->tz_zone.tsp / 10);
1146 if (sc->tz_cooling_active) {
1147 acpi_tz_cpufreq_restore(sc);
1148 sc->tz_cooling_active = FALSE;
1150 sc->tz_cooling_proc = NULL;
1152 sc->tz_cooling_proc_running = FALSE;
1153 ACPI_UNLOCK(thermal);
1158 * TODO: We ignore _PSL (list of cooling devices) since cpufreq enumerates
1159 * all CPUs for us. However, it's possible in the future _PSL will
1160 * reference non-CPU devices so we may want to support it then.
1163 acpi_tz_cooling_is_available(struct acpi_tz_softc *sc)
1165 return (sc->tz_zone.tc1 != -1 && sc->tz_zone.tc2 != -1 &&
1166 sc->tz_zone.tsp != -1 && sc->tz_zone.tsp != 0 &&
1167 sc->tz_zone.psv != -1);
1171 acpi_tz_cooling_thread_start(struct acpi_tz_softc *sc)
1176 if (sc->tz_cooling_proc_running) {
1177 ACPI_UNLOCK(thermal);
1180 sc->tz_cooling_proc_running = TRUE;
1181 ACPI_UNLOCK(thermal);
1183 if (sc->tz_cooling_proc == NULL) {
1184 error = kproc_create(acpi_tz_cooling_thread, sc,
1185 &sc->tz_cooling_proc, RFHIGHPID, 0, "acpi_cooling%d",
1186 device_get_unit(sc->tz_dev));
1188 device_printf(sc->tz_dev, "could not create thread - %d", error);
1190 sc->tz_cooling_proc_running = FALSE;
1191 ACPI_UNLOCK(thermal);