xref: /netbsd-src/sys/dev/acpi/acpi_bat.c (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: acpi_bat.c,v 1.104 2010/08/14 05:41:22 jruoho Exp $	*/
2 
3 /*-
4  * Copyright (c) 2003 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum of By Noon Software, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Copyright 2001 Bill Sommerfeld.
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed for the NetBSD Project by
47  *	Wasabi Systems, Inc.
48  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
49  *    or promote products derived from this software without specific prior
50  *    written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
54  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
55  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
56  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
57  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
58  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
59  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
60  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
61  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
62  * POSSIBILITY OF SUCH DAMAGE.
63  */
64 
65 /*
66  * ACPI Battery Driver.
67  *
68  * ACPI defines two different battery device interfaces: "Control
69  * Method" batteries, in which AML methods are defined in order to get
70  * battery status and set battery alarm thresholds, and a "Smart
71  * Battery" device, which is an SMbus device accessed through the ACPI
72  * Embedded Controller device.
73  *
74  * This driver is for the "Control Method"-style battery only.
75  */
76 
77 #include <sys/cdefs.h>
78 __KERNEL_RCSID(0, "$NetBSD: acpi_bat.c,v 1.104 2010/08/14 05:41:22 jruoho Exp $");
79 
80 #include <sys/param.h>
81 #include <sys/condvar.h>
82 #include <sys/device.h>
83 #include <sys/kernel.h>
84 #include <sys/kmem.h>
85 #include <sys/module.h>
86 #include <sys/mutex.h>
87 #include <sys/systm.h>
88 
89 #include <dev/acpi/acpireg.h>
90 #include <dev/acpi/acpivar.h>
91 
92 #define _COMPONENT		 ACPI_BAT_COMPONENT
93 ACPI_MODULE_NAME		 ("acpi_bat")
94 
95 #define	ACPI_NOTIFY_BAT_STATUS	 0x80
96 #define	ACPI_NOTIFY_BAT_INFO	 0x81
97 
98 /*
99  * Sensor indexes.
100  */
101 enum {
102 	ACPIBAT_PRESENT		 = 0,
103 	ACPIBAT_DVOLTAGE	 = 1,
104 	ACPIBAT_VOLTAGE		 = 2,
105 	ACPIBAT_DCAPACITY	 = 3,
106 	ACPIBAT_LFCCAPACITY	 = 4,
107 	ACPIBAT_CAPACITY	 = 5,
108 	ACPIBAT_CHARGERATE	 = 6,
109 	ACPIBAT_DISCHARGERATE	 = 7,
110 	ACPIBAT_CHARGING	 = 8,
111 	ACPIBAT_CHARGE_STATE	 = 9,
112 	ACPIBAT_COUNT		 = 10
113 };
114 
115 /*
116  * Battery Information, _BIF
117  * (ACPI 3.0, sec. 10.2.2.1).
118  */
119 enum {
120 	ACPIBAT_BIF_UNIT	 = 0,
121 	ACPIBAT_BIF_DCAPACITY	 = 1,
122 	ACPIBAT_BIF_LFCCAPACITY	 = 2,
123 	ACPIBAT_BIF_TECHNOLOGY	 = 3,
124 	ACPIBAT_BIF_DVOLTAGE	 = 4,
125 	ACPIBAT_BIF_WCAPACITY	 = 5,
126 	ACPIBAT_BIF_LCAPACITY	 = 6,
127 	ACPIBAT_BIF_GRANULARITY1 = 7,
128 	ACPIBAT_BIF_GRANULARITY2 = 8,
129 	ACPIBAT_BIF_MODEL	 = 9,
130 	ACPIBAT_BIF_SERIAL	 = 10,
131 	ACPIBAT_BIF_TYPE	 = 11,
132 	ACPIBAT_BIF_OEM		 = 12,
133 	ACPIBAT_BIF_COUNT	 = 13
134 };
135 
136 /*
137  * Battery Status, _BST
138  * (ACPI 3.0, sec. 10.2.2.3).
139  */
140 enum {
141 	ACPIBAT_BST_STATE	 = 0,
142 	ACPIBAT_BST_RATE	 = 1,
143 	ACPIBAT_BST_CAPACITY	 = 2,
144 	ACPIBAT_BST_VOLTAGE	 = 3,
145 	ACPIBAT_BST_COUNT	 = 4
146 };
147 
148 struct acpibat_softc {
149 	struct acpi_devnode	*sc_node;
150 	struct sysmon_envsys	*sc_sme;
151 	envsys_data_t		*sc_sensor;
152 	char			 sc_serial[64];
153 	kmutex_t		 sc_mutex;
154 	kcondvar_t		 sc_condvar;
155 	int32_t			 sc_lcapacity;
156 	int32_t			 sc_wcapacity;
157 	int                      sc_present;
158 };
159 
160 static const char * const bat_hid[] = {
161 	"PNP0C0A",
162 	NULL
163 };
164 
165 #define ACPIBAT_PWRUNIT_MA	0x00000001  /* mA not mW */
166 #define ACPIBAT_ST_DISCHARGING	0x00000001  /* battery is discharging */
167 #define ACPIBAT_ST_CHARGING	0x00000002  /* battery is charging */
168 #define ACPIBAT_ST_CRITICAL	0x00000004  /* battery is critical */
169 
170 /*
171  * A value used when _BST or _BIF is temporarily unknown.
172  */
173 #define ACPIBAT_VAL_UNKNOWN	0xFFFFFFFF
174 
175 #define ACPIBAT_VAL_ISVALID(x)						      \
176 	(((x) != ACPIBAT_VAL_UNKNOWN) ? ENVSYS_SVALID : ENVSYS_SINVALID)
177 
178 static int	    acpibat_match(device_t, cfdata_t, void *);
179 static void	    acpibat_attach(device_t, device_t, void *);
180 static int	    acpibat_detach(device_t, int);
181 static int          acpibat_get_sta(device_t);
182 static ACPI_OBJECT *acpibat_get_object(ACPI_HANDLE, const char *, int);
183 static void         acpibat_get_info(device_t);
184 static void	    acpibat_print_info(device_t, ACPI_OBJECT *);
185 static void         acpibat_get_status(device_t);
186 static void         acpibat_update_info(void *);
187 static void         acpibat_update_status(void *);
188 static void         acpibat_init_envsys(device_t);
189 static void         acpibat_notify_handler(ACPI_HANDLE, uint32_t, void *);
190 static void         acpibat_refresh(struct sysmon_envsys *, envsys_data_t *);
191 static bool	    acpibat_resume(device_t, const pmf_qual_t *);
192 static void	    acpibat_get_limits(struct sysmon_envsys *, envsys_data_t *,
193 				       sysmon_envsys_lim_t *, uint32_t *);
194 
195 CFATTACH_DECL_NEW(acpibat, sizeof(struct acpibat_softc),
196     acpibat_match, acpibat_attach, acpibat_detach, NULL);
197 
198 /*
199  * acpibat_match:
200  *
201  *	Autoconfiguration `match' routine.
202  */
203 static int
204 acpibat_match(device_t parent, cfdata_t match, void *aux)
205 {
206 	struct acpi_attach_args *aa = aux;
207 
208 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
209 		return 0;
210 
211 	return acpi_match_hid(aa->aa_node->ad_devinfo, bat_hid);
212 }
213 
214 /*
215  * acpibat_attach:
216  *
217  *	Autoconfiguration `attach' routine.
218  */
219 static void
220 acpibat_attach(device_t parent, device_t self, void *aux)
221 {
222 	struct acpibat_softc *sc = device_private(self);
223 	struct acpi_attach_args *aa = aux;
224 
225 	aprint_naive(": ACPI Battery\n");
226 	aprint_normal(": ACPI Battery\n");
227 
228 	sc->sc_node = aa->aa_node;
229 
230 	sc->sc_present = 0;
231 	sc->sc_lcapacity = 0;
232 	sc->sc_wcapacity = 0;
233 
234 	sc->sc_sme = NULL;
235 	sc->sc_sensor = NULL;
236 
237 	mutex_init(&sc->sc_mutex, MUTEX_DEFAULT, IPL_NONE);
238 	cv_init(&sc->sc_condvar, device_xname(self));
239 
240 	(void)pmf_device_register(self, NULL, acpibat_resume);
241 	(void)memset(sc->sc_serial, '\0', sizeof(sc->sc_serial));
242 	(void)acpi_register_notify(sc->sc_node, acpibat_notify_handler);
243 
244 	sc->sc_sensor = kmem_zalloc(ACPIBAT_COUNT *
245 	    sizeof(*sc->sc_sensor), KM_SLEEP);
246 
247 	if (sc->sc_sensor == NULL)
248 		return;
249 
250 	acpibat_init_envsys(self);
251 }
252 
253 /*
254  * acpibat_detach:
255  *
256  *	Autoconfiguration `detach' routine.
257  */
258 static int
259 acpibat_detach(device_t self, int flags)
260 {
261 	struct acpibat_softc *sc = device_private(self);
262 
263 	acpi_deregister_notify(sc->sc_node);
264 
265 	cv_destroy(&sc->sc_condvar);
266 	mutex_destroy(&sc->sc_mutex);
267 
268 	if (sc->sc_sme != NULL)
269 		sysmon_envsys_unregister(sc->sc_sme);
270 
271 	if (sc->sc_sensor != NULL)
272 		kmem_free(sc->sc_sensor, ACPIBAT_COUNT *
273 		    sizeof(*sc->sc_sensor));
274 
275 	pmf_device_deregister(self);
276 
277 	return 0;
278 }
279 
280 /*
281  * acpibat_get_sta:
282  *
283  *	Evaluate whether the battery is present or absent.
284  *
285  *	Returns: 0 for no battery, 1 for present, and -1 on error.
286  */
287 static int
288 acpibat_get_sta(device_t dv)
289 {
290 	struct acpibat_softc *sc = device_private(dv);
291 	ACPI_INTEGER val;
292 	ACPI_STATUS rv;
293 
294 	rv = acpi_eval_integer(sc->sc_node->ad_handle, "_STA", &val);
295 
296 	if (ACPI_FAILURE(rv)) {
297 		aprint_error_dev(dv, "failed to evaluate _STA\n");
298 		return -1;
299 	}
300 
301 	sc->sc_sensor[ACPIBAT_PRESENT].state = ENVSYS_SVALID;
302 
303 	if ((val & ACPI_STA_BATTERY_PRESENT) == 0) {
304 		sc->sc_sensor[ACPIBAT_PRESENT].value_cur = 0;
305 		return 0;
306 	}
307 
308 	sc->sc_sensor[ACPIBAT_PRESENT].value_cur = 1;
309 
310 	return 1;
311 }
312 
313 static ACPI_OBJECT *
314 acpibat_get_object(ACPI_HANDLE hdl, const char *pth, int count)
315 {
316 	ACPI_OBJECT *obj;
317 	ACPI_BUFFER buf;
318 	ACPI_STATUS rv;
319 
320 	rv = acpi_eval_struct(hdl, pth, &buf);
321 
322 	if (ACPI_FAILURE(rv))
323 		return NULL;
324 
325 	obj = buf.Pointer;
326 
327 	if (obj->Type != ACPI_TYPE_PACKAGE) {
328 		ACPI_FREE(buf.Pointer);
329 		return NULL;
330 	}
331 
332 	if (obj->Package.Count != count) {
333 		ACPI_FREE(buf.Pointer);
334 		return NULL;
335 	}
336 
337 	return obj;
338 }
339 
340 /*
341  * acpibat_get_info:
342  *
343  * 	Get the battery info.
344  */
345 static void
346 acpibat_get_info(device_t dv)
347 {
348 	struct acpibat_softc *sc = device_private(dv);
349 	ACPI_HANDLE hdl = sc->sc_node->ad_handle;
350 	int capunit, i, rateunit, val;
351 	ACPI_OBJECT *elm, *obj;
352 	ACPI_STATUS rv = AE_OK;
353 
354 	obj = acpibat_get_object(hdl, "_BIF", ACPIBAT_BIF_COUNT);
355 
356 	if (obj == NULL) {
357 		rv = AE_ERROR;
358 		goto out;
359 	}
360 
361 	elm = obj->Package.Elements;
362 
363 	for (i = ACPIBAT_BIF_UNIT; i < ACPIBAT_BIF_MODEL; i++) {
364 
365 		if (elm[i].Type != ACPI_TYPE_INTEGER) {
366 			rv = AE_TYPE;
367 			goto out;
368 		}
369 
370 		KDASSERT((uint64_t)elm[i].Integer.Value < INT_MAX);
371 	}
372 
373 	if ((elm[ACPIBAT_BIF_UNIT].Integer.Value & ACPIBAT_PWRUNIT_MA) != 0) {
374 		capunit = ENVSYS_SAMPHOUR;
375 		rateunit = ENVSYS_SAMPS;
376 	} else {
377 		capunit = ENVSYS_SWATTHOUR;
378 		rateunit = ENVSYS_SWATTS;
379 	}
380 
381 	sc->sc_sensor[ACPIBAT_DCAPACITY].units = capunit;
382 	sc->sc_sensor[ACPIBAT_LFCCAPACITY].units = capunit;
383 	sc->sc_sensor[ACPIBAT_CHARGERATE].units = rateunit;
384 	sc->sc_sensor[ACPIBAT_DISCHARGERATE].units = rateunit;
385 	sc->sc_sensor[ACPIBAT_CAPACITY].units = capunit;
386 
387 	/* Design capacity. */
388 	val = elm[ACPIBAT_BIF_DCAPACITY].Integer.Value;
389 	sc->sc_sensor[ACPIBAT_DCAPACITY].value_cur = val * 1000;
390 	sc->sc_sensor[ACPIBAT_DCAPACITY].state = ACPIBAT_VAL_ISVALID(val);
391 
392 	/* Last full charge capacity. */
393 	val = elm[ACPIBAT_BIF_LFCCAPACITY].Integer.Value;
394 	sc->sc_sensor[ACPIBAT_LFCCAPACITY].value_cur = val * 1000;
395 	sc->sc_sensor[ACPIBAT_LFCCAPACITY].state = ACPIBAT_VAL_ISVALID(val);
396 
397 	/* Design voltage. */
398 	val = elm[ACPIBAT_BIF_DVOLTAGE].Integer.Value;
399 	sc->sc_sensor[ACPIBAT_DVOLTAGE].value_cur = val * 1000;
400 	sc->sc_sensor[ACPIBAT_DVOLTAGE].state = ACPIBAT_VAL_ISVALID(val);
401 
402 	/* Design low and warning capacity. */
403 	sc->sc_lcapacity = elm[ACPIBAT_BIF_LCAPACITY].Integer.Value * 1000;
404 	sc->sc_wcapacity = elm[ACPIBAT_BIF_WCAPACITY].Integer.Value * 1000;
405 
406 	/*
407 	 * Initialize the maximum of current capacity
408 	 * to the last known full charge capacity.
409 	 */
410 	val = sc->sc_sensor[ACPIBAT_LFCCAPACITY].value_cur;
411 	sc->sc_sensor[ACPIBAT_CAPACITY].value_max = val;
412 
413 	acpibat_print_info(dv, elm);
414 
415 out:
416 	if (obj != NULL)
417 		ACPI_FREE(obj);
418 
419 	if (ACPI_FAILURE(rv))
420 		aprint_error_dev(dv, "failed to evaluate _BIF: %s\n",
421 		    AcpiFormatException(rv));
422 }
423 
424 /*
425  * acpibat_print_info:
426  *
427  * 	Display the battery info.
428  */
429 static void
430 acpibat_print_info(device_t dv, ACPI_OBJECT *elm)
431 {
432 	struct acpibat_softc *sc = device_private(dv);
433 	const char *model, *serial, *tech, *unit;
434 	int i;
435 
436 	for (i = ACPIBAT_BIF_OEM; i > ACPIBAT_BIF_GRANULARITY2; i--) {
437 
438 		if (elm[i].Type != ACPI_TYPE_STRING)
439 			return;
440 
441 		if (elm[i].String.Pointer == NULL)
442 			return;
443 
444 		if (elm[i].String.Pointer[0] == '\0')
445 			return;
446 	}
447 
448 	model = elm[ACPIBAT_BIF_MODEL].String.Pointer;
449 	serial = elm[ACPIBAT_BIF_SERIAL].String.Pointer;
450 
451 	if (elm[ACPIBAT_BIF_SERIAL].String.Length > sizeof(sc->sc_serial))
452 		return;
453 
454 	if (sc->sc_serial[0] == '\0')
455 		(void)strlcpy(sc->sc_serial, serial, sizeof(sc->sc_serial));
456 	else {
457 		if (strcmp(sc->sc_serial, serial) == 0)
458 			return;
459 
460 		(void)memset(sc->sc_serial, '\0', sizeof(sc->sc_serial));
461 		(void)strlcpy(sc->sc_serial, serial, sizeof(sc->sc_serial));
462 	}
463 
464 	tech = (elm[ACPIBAT_BIF_TECHNOLOGY].Integer.Value != 0) ?
465 	    "rechargeable" : "non-rechargeable";
466 
467 	aprint_normal_dev(dv, "%s %s %s battery\n",
468 	    elm[ACPIBAT_BIF_OEM].String.Pointer,
469 	    elm[ACPIBAT_BIF_TYPE].String.Pointer, tech);
470 
471 	aprint_verbose_dev(dv, "model number %s, serial number %s\n",
472 	    model, serial);
473 
474 #define SCALE(x) (((int)x) / 1000000), ((((int)x) % 1000000) / 1000)
475 
476 	/*
477 	 * These values are defined as follows (ACPI 4.0, p. 388):
478 	 *
479 	 * Granularity 1.	"Battery capacity granularity between low
480 	 *			 and warning in [mAh] or [mWh]. That is,
481 	 *			 this is the smallest increment in capacity
482 	 *			 that the battery is capable of measuring."
483 	 *
484 	 * Granularity 2.	"Battery capacity granularity between warning
485 	 *			 and full in [mAh] or [mWh]. [...]"
486 	 */
487 	if ((elm[ACPIBAT_BIF_UNIT].Integer.Value & ACPIBAT_PWRUNIT_MA) != 0)
488 		unit = "Ah";
489 	else
490 		unit = "Wh";
491 
492 	aprint_verbose_dev(dv, "granularity: "
493 	    "low->warn %d.%03d %s, warn->full %d.%03d %s\n",
494 	    SCALE(elm[ACPIBAT_BIF_GRANULARITY1].Integer.Value * 1000), unit,
495 	    SCALE(elm[ACPIBAT_BIF_GRANULARITY2].Integer.Value * 1000), unit);
496 }
497 
498 /*
499  * acpibat_get_status:
500  *
501  *	Get the current battery status.
502  */
503 static void
504 acpibat_get_status(device_t dv)
505 {
506 	struct acpibat_softc *sc = device_private(dv);
507 	ACPI_HANDLE hdl = sc->sc_node->ad_handle;
508 	int i, rate, state, val;
509 	ACPI_OBJECT *elm, *obj;
510 	ACPI_STATUS rv = AE_OK;
511 
512 	obj = acpibat_get_object(hdl, "_BST", ACPIBAT_BST_COUNT);
513 
514 	if (obj == NULL) {
515 		rv = AE_ERROR;
516 		goto out;
517 	}
518 
519 	elm = obj->Package.Elements;
520 
521 	for (i = ACPIBAT_BST_STATE; i < ACPIBAT_BST_COUNT; i++) {
522 
523 		if (elm[i].Type != ACPI_TYPE_INTEGER) {
524 			rv = AE_TYPE;
525 			goto out;
526 		}
527 	}
528 
529 	state = elm[ACPIBAT_BST_STATE].Integer.Value;
530 
531 	if ((state & ACPIBAT_ST_CHARGING) != 0) {
532 		/* XXX rate can be invalid */
533 		rate = elm[ACPIBAT_BST_RATE].Integer.Value;
534 		sc->sc_sensor[ACPIBAT_CHARGERATE].state = ENVSYS_SVALID;
535 		sc->sc_sensor[ACPIBAT_CHARGERATE].value_cur = rate * 1000;
536 		sc->sc_sensor[ACPIBAT_DISCHARGERATE].state = ENVSYS_SINVALID;
537 		sc->sc_sensor[ACPIBAT_CHARGING].state = ENVSYS_SVALID;
538 		sc->sc_sensor[ACPIBAT_CHARGING].value_cur = 1;
539 	} else if ((state & ACPIBAT_ST_DISCHARGING) != 0) {
540 		rate = elm[ACPIBAT_BST_RATE].Integer.Value;
541 		sc->sc_sensor[ACPIBAT_DISCHARGERATE].state = ENVSYS_SVALID;
542 		sc->sc_sensor[ACPIBAT_DISCHARGERATE].value_cur = rate * 1000;
543 		sc->sc_sensor[ACPIBAT_CHARGERATE].state = ENVSYS_SINVALID;
544 		sc->sc_sensor[ACPIBAT_CHARGING].state = ENVSYS_SVALID;
545 		sc->sc_sensor[ACPIBAT_CHARGING].value_cur = 0;
546 	} else {
547 		sc->sc_sensor[ACPIBAT_CHARGING].state = ENVSYS_SVALID;
548 		sc->sc_sensor[ACPIBAT_CHARGING].value_cur = 0;
549 		sc->sc_sensor[ACPIBAT_CHARGERATE].state = ENVSYS_SINVALID;
550 		sc->sc_sensor[ACPIBAT_DISCHARGERATE].state = ENVSYS_SINVALID;
551 	}
552 
553 	/* Remaining capacity. */
554 	val = elm[ACPIBAT_BST_CAPACITY].Integer.Value;
555 	sc->sc_sensor[ACPIBAT_CAPACITY].value_cur = val * 1000;
556 	sc->sc_sensor[ACPIBAT_CAPACITY].state = ACPIBAT_VAL_ISVALID(val);
557 
558 	/* Battery voltage. */
559 	val = elm[ACPIBAT_BST_VOLTAGE].Integer.Value;
560 	sc->sc_sensor[ACPIBAT_VOLTAGE].value_cur = val * 1000;
561 	sc->sc_sensor[ACPIBAT_VOLTAGE].state = ACPIBAT_VAL_ISVALID(val);
562 
563 	sc->sc_sensor[ACPIBAT_CHARGE_STATE].state = ENVSYS_SVALID;
564 	sc->sc_sensor[ACPIBAT_CHARGE_STATE].value_cur =
565 	    ENVSYS_BATTERY_CAPACITY_NORMAL;
566 
567 	if (sc->sc_sensor[ACPIBAT_CAPACITY].value_cur < sc->sc_wcapacity) {
568 		sc->sc_sensor[ACPIBAT_CAPACITY].state = ENVSYS_SWARNUNDER;
569 		sc->sc_sensor[ACPIBAT_CHARGE_STATE].value_cur =
570 		    ENVSYS_BATTERY_CAPACITY_WARNING;
571 	}
572 
573 	if (sc->sc_sensor[ACPIBAT_CAPACITY].value_cur < sc->sc_lcapacity) {
574 		sc->sc_sensor[ACPIBAT_CAPACITY].state = ENVSYS_SCRITUNDER;
575 		sc->sc_sensor[ACPIBAT_CHARGE_STATE].value_cur =
576 		    ENVSYS_BATTERY_CAPACITY_LOW;
577 	}
578 
579 	if ((state & ACPIBAT_ST_CRITICAL) != 0) {
580 		sc->sc_sensor[ACPIBAT_CAPACITY].state = ENVSYS_SCRITICAL;
581 		sc->sc_sensor[ACPIBAT_CHARGE_STATE].value_cur =
582 		    ENVSYS_BATTERY_CAPACITY_CRITICAL;
583 	}
584 
585 out:
586 	if (obj != NULL)
587 		ACPI_FREE(obj);
588 
589 	if (ACPI_FAILURE(rv))
590 		aprint_error_dev(dv, "failed to evaluate _BST: %s\n",
591 		    AcpiFormatException(rv));
592 }
593 
594 static void
595 acpibat_update_info(void *arg)
596 {
597 	device_t dv = arg;
598 	struct acpibat_softc *sc = device_private(dv);
599 	int i, rv;
600 
601 	mutex_enter(&sc->sc_mutex);
602 
603 	rv = acpibat_get_sta(dv);
604 
605 	if (rv > 0) {
606 		acpibat_get_info(dv);
607 
608 		/*
609 		 * If the status changed, update the limits.
610 		 */
611 		if (sc->sc_present == 0 &&
612 		    sc->sc_sensor[ACPIBAT_CAPACITY].value_max > 0)
613 			sysmon_envsys_update_limits(sc->sc_sme,
614 			    &sc->sc_sensor[ACPIBAT_CAPACITY]);
615 	} else {
616 		i = (rv < 0) ? 0 : ACPIBAT_DVOLTAGE;
617 
618 		while (i < ACPIBAT_COUNT) {
619 			sc->sc_sensor[i].state = ENVSYS_SINVALID;
620 			i++;
621 		}
622 	}
623 
624 	sc->sc_present = rv;
625 
626 	mutex_exit(&sc->sc_mutex);
627 }
628 
629 static void
630 acpibat_update_status(void *arg)
631 {
632 	device_t dv = arg;
633 	struct acpibat_softc *sc = device_private(dv);
634 	int i, rv;
635 
636 	mutex_enter(&sc->sc_mutex);
637 
638 	rv = acpibat_get_sta(dv);
639 
640 	if (rv > 0) {
641 
642 		if (sc->sc_present == 0)
643 			acpibat_get_info(dv);
644 
645 		acpibat_get_status(dv);
646 	} else {
647 		i = (rv < 0) ? 0 : ACPIBAT_DVOLTAGE;
648 
649 		while (i < ACPIBAT_COUNT) {
650 			sc->sc_sensor[i].state = ENVSYS_SINVALID;
651 			i++;
652 		}
653 	}
654 
655 	sc->sc_present = rv;
656 
657 	cv_broadcast(&sc->sc_condvar);
658 	mutex_exit(&sc->sc_mutex);
659 }
660 
661 /*
662  * acpibat_notify_handler:
663  *
664  *	Callback from ACPI interrupt handler to notify us of an event.
665  */
666 static void
667 acpibat_notify_handler(ACPI_HANDLE handle, uint32_t notify, void *context)
668 {
669 	static const int handler = OSL_NOTIFY_HANDLER;
670 	device_t dv = context;
671 
672 	switch (notify) {
673 
674 	case ACPI_NOTIFY_BUS_CHECK:
675 		break;
676 
677 	case ACPI_NOTIFY_BAT_INFO:
678 	case ACPI_NOTIFY_DEVICE_CHECK:
679 		(void)AcpiOsExecute(handler, acpibat_update_info, dv);
680 		break;
681 
682 	case ACPI_NOTIFY_BAT_STATUS:
683 		(void)AcpiOsExecute(handler, acpibat_update_status, dv);
684 		break;
685 
686 	default:
687 		aprint_error_dev(dv, "unknown notify: 0x%02X\n", notify);
688 	}
689 }
690 
691 static void
692 acpibat_init_envsys(device_t dv)
693 {
694 	struct acpibat_softc *sc = device_private(dv);
695 	int i;
696 
697 #define INITDATA(index, unit, string)					\
698 	do {								\
699 		sc->sc_sensor[index].state = ENVSYS_SVALID;		\
700 		sc->sc_sensor[index].units = unit;			\
701 		(void)strlcpy(sc->sc_sensor[index].desc, string,	\
702 		    sizeof(sc->sc_sensor[index].desc));			\
703 	} while (/* CONSTCOND */ 0)
704 
705 	INITDATA(ACPIBAT_PRESENT, ENVSYS_INDICATOR, "present");
706 	INITDATA(ACPIBAT_DCAPACITY, ENVSYS_SWATTHOUR, "design cap");
707 	INITDATA(ACPIBAT_LFCCAPACITY, ENVSYS_SWATTHOUR, "last full cap");
708 	INITDATA(ACPIBAT_DVOLTAGE, ENVSYS_SVOLTS_DC, "design voltage");
709 	INITDATA(ACPIBAT_VOLTAGE, ENVSYS_SVOLTS_DC, "voltage");
710 	INITDATA(ACPIBAT_CHARGERATE, ENVSYS_SWATTS, "charge rate");
711 	INITDATA(ACPIBAT_DISCHARGERATE, ENVSYS_SWATTS, "discharge rate");
712 	INITDATA(ACPIBAT_CAPACITY, ENVSYS_SWATTHOUR, "charge");
713 	INITDATA(ACPIBAT_CHARGING, ENVSYS_BATTERY_CHARGE, "charging");
714 	INITDATA(ACPIBAT_CHARGE_STATE, ENVSYS_BATTERY_CAPACITY, "charge state");
715 
716 #undef INITDATA
717 
718 	sc->sc_sensor[ACPIBAT_CAPACITY].flags |=
719 	    ENVSYS_FPERCENT | ENVSYS_FVALID_MAX | ENVSYS_FMONLIMITS;
720 
721 	sc->sc_sensor[ACPIBAT_CHARGE_STATE].flags |= ENVSYS_FMONSTCHANGED;
722 
723 	/* Disable userland monitoring on these sensors. */
724 	sc->sc_sensor[ACPIBAT_VOLTAGE].flags = ENVSYS_FMONNOTSUPP;
725 	sc->sc_sensor[ACPIBAT_CHARGERATE].flags = ENVSYS_FMONNOTSUPP;
726 	sc->sc_sensor[ACPIBAT_DISCHARGERATE].flags = ENVSYS_FMONNOTSUPP;
727 	sc->sc_sensor[ACPIBAT_DCAPACITY].flags = ENVSYS_FMONNOTSUPP;
728 	sc->sc_sensor[ACPIBAT_LFCCAPACITY].flags = ENVSYS_FMONNOTSUPP;
729 	sc->sc_sensor[ACPIBAT_DVOLTAGE].flags = ENVSYS_FMONNOTSUPP;
730 
731 	sc->sc_sme = sysmon_envsys_create();
732 
733 	for (i = 0; i < ACPIBAT_COUNT; i++) {
734 
735 		if (sysmon_envsys_sensor_attach(sc->sc_sme,
736 			&sc->sc_sensor[i]))
737 			goto fail;
738 	}
739 
740 	sc->sc_sme->sme_name = device_xname(dv);
741 	sc->sc_sme->sme_cookie = dv;
742 	sc->sc_sme->sme_refresh = acpibat_refresh;
743 	sc->sc_sme->sme_class = SME_CLASS_BATTERY;
744 	sc->sc_sme->sme_flags = SME_POLL_ONLY | SME_INIT_REFRESH;
745 	sc->sc_sme->sme_get_limits = acpibat_get_limits;
746 
747 	acpibat_update_info(dv);
748 	acpibat_update_status(dv);
749 
750 	if (sysmon_envsys_register(sc->sc_sme))
751 		goto fail;
752 
753 	return;
754 
755 fail:
756 	aprint_error_dev(dv, "failed to initialize sysmon\n");
757 
758 	sysmon_envsys_destroy(sc->sc_sme);
759 	kmem_free(sc->sc_sensor, ACPIBAT_COUNT * sizeof(*sc->sc_sensor));
760 
761 	sc->sc_sme = NULL;
762 	sc->sc_sensor = NULL;
763 }
764 
765 static void
766 acpibat_refresh(struct sysmon_envsys *sme, envsys_data_t *edata)
767 {
768 	device_t dv = sme->sme_cookie;
769 	struct acpibat_softc *sc = device_private(dv);
770 	ACPI_STATUS rv;
771 
772 	if (mutex_tryenter(&sc->sc_mutex) == 0)
773 		return;
774 
775 	rv = AcpiOsExecute(OSL_NOTIFY_HANDLER, acpibat_update_status, dv);
776 
777 	if (ACPI_SUCCESS(rv))
778 		cv_timedwait(&sc->sc_condvar, &sc->sc_mutex, hz);
779 
780 	mutex_exit(&sc->sc_mutex);
781 }
782 
783 static bool
784 acpibat_resume(device_t dv, const pmf_qual_t *qual)
785 {
786 
787 	acpibat_update_info(dv);
788 	acpibat_update_status(dv);
789 
790 	return true;
791 }
792 
793 static void
794 acpibat_get_limits(struct sysmon_envsys *sme, envsys_data_t *edata,
795     sysmon_envsys_lim_t *limits, uint32_t *props)
796 {
797 	device_t dv = sme->sme_cookie;
798 	struct acpibat_softc *sc = device_private(dv);
799 
800 	if (edata->sensor != ACPIBAT_CAPACITY)
801 		return;
802 
803 	limits->sel_critmin = sc->sc_lcapacity;
804 	limits->sel_warnmin = sc->sc_wcapacity;
805 
806 	*props |= PROP_BATTCAP | PROP_BATTWARN | PROP_DRIVER_LIMITS;
807 }
808 
809 #ifdef _MODULE
810 
811 MODULE(MODULE_CLASS_DRIVER, acpibat, NULL);
812 
813 #include "ioconf.c"
814 
815 static int
816 acpibat_modcmd(modcmd_t cmd, void *context)
817 {
818 
819 	switch (cmd) {
820 
821 	case MODULE_CMD_INIT:
822 		return config_init_component(cfdriver_ioconf_acpibat,
823 		    cfattach_ioconf_acpibat, cfdata_ioconf_acpibat);
824 
825 	case MODULE_CMD_FINI:
826 		return config_fini_component(cfdriver_ioconf_acpibat,
827 		    cfattach_ioconf_acpibat, cfdata_ioconf_acpibat);
828 
829 	default:
830 		return ENOTTY;
831 	}
832 }
833 
834 #endif	/* _MODULE */
835