1 /* $NetBSD: atk0110.c,v 1.4 2010/02/11 06:54:57 cnst Exp $ */
2 /* $OpenBSD: atk0110.c,v 1.1 2009/07/23 01:38:16 cnst Exp $ */
5 * Copyright (c) 2009, 2010 Constantine A. Murenin <cnst++@FreeBSD.org>
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include <sys/cdefs.h>
21 __FBSDID("$FreeBSD$");
23 #include <machine/_inttypes.h>
24 #include <sys/param.h>
25 #include <sys/systm.h>
26 #include <sys/kernel.h>
28 #include <sys/module.h>
29 #include <sys/malloc.h>
30 #include <sys/sysctl.h>
31 #include <sys/stdint.h>
33 #include <contrib/dev/acpica/include/acpi.h>
34 #include <dev/acpica/acpivar.h>
37 * ASUSTeK AI Booster (ACPI ASOC ATK0110).
39 * This code was originally written for OpenBSD after the techniques
40 * described in the Linux's asus_atk0110.c and FreeBSD's Takanori Watanabe's
41 * acpi_aiboost.c were verified to be accurate on the actual hardware kindly
42 * provided by Sam Fourman Jr. It was subsequently ported from OpenBSD to
43 * DragonFly BSD, to NetBSD's sysmon_envsys(9) and to FreeBSD's sysctl(9).
45 * -- Constantine A. Murenin <http://cnst.su/>
48 #define _COMPONENT ACPI_OEM
49 ACPI_MODULE_NAME("aibs");
50 ACPI_SERIAL_DECL(aibs, "aibs");
52 #define AIBS_MORE_SENSORS
55 #define AIBS_GROUP_SENSORS 0x06
57 #define AIBS_SENS_TYPE(x) (((x) >> 16) & 0xff)
58 #define AIBS_SENS_TYPE_VOLT 2
59 #define AIBS_SENS_TYPE_TEMP 3
60 #define AIBS_SENS_TYPE_FAN 4
62 #define AIBS_SENS_TYPE_VOLT_NAME "volt"
63 #define AIBS_SENS_TYPE_VOLT_TEMP "temp"
64 #define AIBS_SENS_TYPE_VOLT_FAN "fan"
78 struct aibs_sensor *sc_asens_volt;
79 struct aibs_sensor *sc_asens_temp;
80 struct aibs_sensor *sc_asens_fan;
81 struct aibs_sensor *sc_asens_all;
83 struct sysctl_oid *sc_volt_sysctl;
84 struct sysctl_oid *sc_temp_sysctl;
85 struct sysctl_oid *sc_fan_sysctl;
90 static int aibs_probe(device_t);
91 static int aibs_attach(device_t);
92 static int aibs_detach(device_t);
93 static int aibs_sysctl(SYSCTL_HANDLER_ARGS);
94 static int aibs_sysctl_ggrp(SYSCTL_HANDLER_ARGS);
96 static int aibs_attach_ggrp(struct aibs_softc *);
97 static int aibs_attach_sif(struct aibs_softc *, int);
99 static device_method_t aibs_methods[] = {
100 DEVMETHOD(device_probe, aibs_probe),
101 DEVMETHOD(device_attach, aibs_attach),
102 DEVMETHOD(device_detach, aibs_detach),
106 static driver_t aibs_driver = {
109 sizeof(struct aibs_softc)
112 static devclass_t aibs_devclass;
114 DRIVER_MODULE(aibs, acpi, aibs_driver, aibs_devclass, NULL, NULL);
115 MODULE_DEPEND(aibs, acpi, 1, 1, 1);
117 static char* aibs_hids[] = {
123 aibs_probe(device_t dev)
125 if (acpi_disabled("aibs") ||
126 ACPI_ID_PROBE(device_get_parent(dev), dev, aibs_hids) == NULL)
129 device_set_desc(dev, "ASUSTeK AI Booster (ACPI ASOC ATK0110)");
134 aibs_attach(device_t dev)
136 struct aibs_softc *sc = device_get_softc(dev);
140 sc->sc_ah = acpi_get_handle(dev);
142 sc->sc_ggrp_method = false;
143 err = aibs_attach_sif(sc, AIBS_SENS_TYPE_VOLT);
145 err = aibs_attach_sif(sc, AIBS_SENS_TYPE_TEMP);
147 err = aibs_attach_sif(sc, AIBS_SENS_TYPE_FAN);
152 /* Clean up whatever was allocated earlier. */
153 if (sc->sc_volt_sysctl != NULL)
154 sysctl_remove_oid(sc->sc_volt_sysctl, true, true);
155 if (sc->sc_temp_sysctl != NULL)
156 sysctl_remove_oid(sc->sc_temp_sysctl, true, true);
157 if (sc->sc_fan_sysctl != NULL)
158 sysctl_remove_oid(sc->sc_fan_sysctl, true, true);
161 sc->sc_ggrp_method = true;
162 err = aibs_attach_ggrp(sc);
167 aibs_add_sensor(struct aibs_softc *sc, ACPI_OBJECT *o,
168 struct aibs_sensor* sensor, const char ** descr)
173 * Packages for the old and new methods are quite
174 * similar except that the new package has two
175 * new (unknown / unused) fields after the name field.
177 if (sc->sc_ggrp_method)
182 if (o->Type != ACPI_TYPE_PACKAGE) {
183 device_printf(sc->sc_dev,
184 "sensor object is not a package: %i type\n",
188 if (o[0].Package.Count != (off + 3) ||
189 o->Package.Elements[0].Type != ACPI_TYPE_INTEGER ||
190 o->Package.Elements[1].Type != ACPI_TYPE_STRING ||
191 o->Package.Elements[off].Type != ACPI_TYPE_INTEGER ||
192 o->Package.Elements[off + 1].Type != ACPI_TYPE_INTEGER ||
193 o->Package.Elements[off + 2].Type != ACPI_TYPE_INTEGER) {
194 device_printf(sc->sc_dev, "unexpected package content\n");
198 sensor->i = o->Package.Elements[0].Integer.Value;
199 *descr = o->Package.Elements[1].String.Pointer;
200 sensor->l = o->Package.Elements[off].Integer.Value;
201 sensor->h = o->Package.Elements[off + 1].Integer.Value;
202 /* For the new method the second value is a range size. */
203 if (sc->sc_ggrp_method)
204 sensor->h += sensor->l;
205 sensor->t = AIBS_SENS_TYPE(sensor->i);
208 case AIBS_SENS_TYPE_VOLT:
209 case AIBS_SENS_TYPE_TEMP:
210 case AIBS_SENS_TYPE_FAN:
213 device_printf(sc->sc_dev, "unknown sensor type 0x%x",
220 aibs_sensor_added(struct aibs_softc *sc, struct sysctl_oid *so,
221 const char *type_name, int idx, struct aibs_sensor *sensor,
226 snprintf(sysctl_name, sizeof(sysctl_name), "%i", idx);
228 device_printf(sc->sc_dev, "%c%i: 0x%08jx %20s %5jd / %5jd\n",
230 (uintmax_t)sensor->i, descr, (intmax_t)sensor->l,
231 (intmax_t)sensor->h);
233 SYSCTL_ADD_PROC(device_get_sysctl_ctx(sc->sc_dev),
234 SYSCTL_CHILDREN(so), idx, sysctl_name,
235 CTLTYPE_INT | CTLFLAG_RD, sc, (uintptr_t)sensor,
236 sc->sc_ggrp_method ? aibs_sysctl_ggrp : aibs_sysctl,
237 sensor->t == AIBS_SENS_TYPE_TEMP ? "IK" : "I", descr);
241 aibs_attach_ggrp(struct aibs_softc *sc)
248 ACPI_OBJECT_LIST arg;
255 struct aibs_sensor *sensor;
256 struct sysctl_oid **so;
258 /* First see if GITM is available. */
259 s = AcpiGetHandle(sc->sc_ah, "GITM", &h);
260 if (ACPI_FAILURE(s)) {
262 device_printf(sc->sc_dev, "GITM not found\n");
267 * Now call GGRP with the appropriate argument to list sensors.
268 * The method lists different groups of entities depending on
271 id.Integer.Value = AIBS_GROUP_SENSORS;
272 id.Type = ACPI_TYPE_INTEGER;
275 buf.Length = ACPI_ALLOCATE_BUFFER;
277 s = AcpiEvaluateObjectTyped(sc->sc_ah, "GGRP", &arg, &buf,
279 if (ACPI_FAILURE(s)) {
280 device_printf(sc->sc_dev, "GGRP not found\n");
285 sc->sc_asens_all = malloc(sizeof(*sc->sc_asens_all) * bp->Package.Count,
286 M_DEVBUF, M_WAITOK | M_ZERO);
288 for (i = 0; i < bp->Package.Count; i++) {
289 sensor = &sc->sc_asens_all[i];
290 err = aibs_add_sensor(sc, &bp->Package.Elements[i], sensor,
296 case AIBS_SENS_TYPE_VOLT:
298 so = &sc->sc_volt_sysctl;
301 case AIBS_SENS_TYPE_TEMP:
303 so = &sc->sc_temp_sysctl;
306 case AIBS_SENS_TYPE_FAN:
308 so = &sc->sc_fan_sysctl;
312 panic("add_sensor succeeded for unknown sensor type %d",
317 /* sysctl subtree for sensors of this type */
318 *so = SYSCTL_ADD_NODE(device_get_sysctl_ctx(sc->sc_dev),
319 SYSCTL_CHILDREN(device_get_sysctl_tree(sc->sc_dev)),
320 sensor->t, name, CTLFLAG_RD, NULL, NULL);
322 aibs_sensor_added(sc, *so, name, *s_idx, sensor, descr);
326 AcpiOsFree(buf.Pointer);
331 aibs_attach_sif(struct aibs_softc *sc, int st)
333 char name[] = "?SIF";
338 struct aibs_sensor *as;
339 struct sysctl_oid **so;
344 case AIBS_SENS_TYPE_VOLT:
347 so = &sc->sc_volt_sysctl;
349 case AIBS_SENS_TYPE_TEMP:
352 so = &sc->sc_temp_sysctl;
354 case AIBS_SENS_TYPE_FAN:
357 so = &sc->sc_fan_sysctl;
360 panic("Unsupported sensor type %d", st);
363 b.Length = ACPI_ALLOCATE_BUFFER;
364 s = AcpiEvaluateObjectTyped(sc->sc_ah, name, NULL, &b,
366 if (ACPI_FAILURE(s)) {
367 device_printf(sc->sc_dev, "%s not found\n", name);
372 o = bp->Package.Elements;
373 if (o[0].Type != ACPI_TYPE_INTEGER) {
374 device_printf(sc->sc_dev, "%s[0]: invalid type\n", name);
375 AcpiOsFree(b.Pointer);
379 n = o[0].Integer.Value;
380 if (bp->Package.Count - 1 < n) {
381 device_printf(sc->sc_dev, "%s: invalid package\n", name);
382 AcpiOsFree(b.Pointer);
384 } else if (bp->Package.Count - 1 > n) {
387 #ifdef AIBS_MORE_SENSORS
388 n = bp->Package.Count - 1;
390 device_printf(sc->sc_dev, "%s: malformed package: %i/%i"
391 ", assume %i\n", name, on, bp->Package.Count - 1, n);
394 device_printf(sc->sc_dev, "%s: no members in the package\n",
396 AcpiOsFree(b.Pointer);
400 as = malloc(sizeof(*as) * n, M_DEVBUF, M_WAITOK | M_ZERO);
402 case AIBS_SENS_TYPE_VOLT:
403 sc->sc_asens_volt = as;
405 case AIBS_SENS_TYPE_TEMP:
406 sc->sc_asens_temp = as;
408 case AIBS_SENS_TYPE_FAN:
409 sc->sc_asens_fan = as;
413 /* sysctl subtree for sensors of this type */
414 *so = SYSCTL_ADD_NODE(device_get_sysctl_ctx(sc->sc_dev),
415 SYSCTL_CHILDREN(device_get_sysctl_tree(sc->sc_dev)), st,
416 node, CTLFLAG_RD, NULL, NULL);
418 for (i = 0, o++; i < n; i++, o++) {
421 err = aibs_add_sensor(sc, o, &as[i], &descr);
423 aibs_sensor_added(sc, *so, node, i, &as[i], descr);
426 AcpiOsFree(b.Pointer);
431 aibs_detach(device_t dev)
433 struct aibs_softc *sc = device_get_softc(dev);
435 if (sc->sc_asens_volt != NULL)
436 free(sc->sc_asens_volt, M_DEVBUF);
437 if (sc->sc_asens_temp != NULL)
438 free(sc->sc_asens_temp, M_DEVBUF);
439 if (sc->sc_asens_fan != NULL)
440 free(sc->sc_asens_fan, M_DEVBUF);
441 if (sc->sc_asens_all != NULL)
442 free(sc->sc_asens_all, M_DEVBUF);
447 #define ddevice_printf(x...) device_printf(x)
449 #define ddevice_printf(x...)
453 aibs_sysctl(SYSCTL_HANDLER_ARGS)
455 struct aibs_softc *sc = arg1;
456 struct aibs_sensor *sensor = (void *)arg2;
457 int i = oidp->oid_number;
463 ACPI_INTEGER v, l, h;
467 case AIBS_SENS_TYPE_VOLT:
470 case AIBS_SENS_TYPE_TEMP:
473 case AIBS_SENS_TYPE_FAN:
481 p.Type = ACPI_TYPE_INTEGER;
482 p.Integer.Value = sensor->i;
485 b.Length = ACPI_ALLOCATE_BUFFER;
486 ACPI_SERIAL_BEGIN(aibs);
487 rs = AcpiEvaluateObjectTyped(sc->sc_ah, name, &mp, &b,
489 if (ACPI_FAILURE(rs)) {
490 ddevice_printf(sc->sc_dev,
491 "%s: %i: evaluation failed\n",
493 ACPI_SERIAL_END(aibs);
497 v = bp->Integer.Value;
498 AcpiOsFree(b.Pointer);
499 ACPI_SERIAL_END(aibs);
502 case AIBS_SENS_TYPE_VOLT:
504 case AIBS_SENS_TYPE_TEMP:
509 case AIBS_SENS_TYPE_FAN:
515 return (sysctl_handle_opaque(oidp, &so, sizeof(so), req));
519 aibs_sysctl_ggrp(SYSCTL_HANDLER_ARGS)
521 struct aibs_softc *sc = arg1;
522 struct aibs_sensor *sensor = (void *)arg2;
525 ACPI_OBJECT_LIST arg;
527 ACPI_INTEGER v, l, h;
535 p.Type = ACPI_TYPE_BUFFER;
536 p.Buffer.Pointer = (void *)cmd;
537 p.Buffer.Length = sizeof(cmd);
541 buf.Length = ACPI_ALLOCATE_BUFFER;
542 ACPI_SERIAL_BEGIN(aibs);
543 rs = AcpiEvaluateObjectTyped(sc->sc_ah, "GITM", &arg, &buf,
545 ACPI_SERIAL_END(aibs);
546 if (ACPI_FAILURE(rs)) {
547 device_printf(sc->sc_dev, "GITM evaluation failed\n");
551 if (bp->Buffer.Length < 8) {
552 device_printf(sc->sc_dev, "GITM returned short buffer\n");
555 ret = (uint32_t *)bp->Buffer.Pointer;
557 device_printf(sc->sc_dev, "GITM returned error status\n");
561 AcpiOsFree(buf.Pointer);
567 case AIBS_SENS_TYPE_VOLT:
569 case AIBS_SENS_TYPE_TEMP:
574 case AIBS_SENS_TYPE_FAN:
580 return (sysctl_handle_opaque(oidp, &so, sizeof(so), req));