freebsd-dev/usr.sbin/acpi/acpiconf/acpiconf.c
Hiroki Sato 294de6bbd6 Add _BIX (Battery Information Extended) object support.
ACPI Control Method Batteries have a _BIF and/or _BIX object which
provide static properties of the battery.  FreeBSD acpi_cmbat module
supported _BIF object only, which was deprecated as of ACPI 4.0.
_BIX is an extended version of _BIF defined in ACPI 4.0 or later.

As of writing, _BIX has two revisions.  One is in ACPI 4.0 (rev.0) and
another is in ACPI 6.0 (rev.1).  It seems that hardware vendors still
stick to _BIF only or _BIX rev.0 + _BIF for the maximum compatibility.
Microsoft requires _BIX rev.0 for Windows machines, so there are some
laptop machines with _BIX rev.0 only. In this case, FreeBSD does not
recognize the battery information.

After this change, the acpi_cmbat module gets battery information from
_BIX or _BIF object and internally uses _BIX rev.1 data structure as
the primary information store in the kernel.  ACPIIO_BATT_GET_BI[FX]
returns an acpi_bi[fx] structure built by using information obtained
from a _BIF or a _BIX object found on the system.  The revision number
field can be used to check which field is available.  The acpiconf(8)
utility will show additional information if _BIX is available.

Although ABIs of ACPIIO_BATT_* were changed, the existing APIs for
userland utilities are not changed and the backward-compatible ABIs
are provided.  This means that older versions of acpiconf(8) can also
work with the new kernel. The (union acpi_battery_ioctl_arg) was
padded to 256 byte long to avoid another ABI change in the future.
A _BIX object with its revision number >1 will be treated as
compatible with the rev.1 _BIX format.

Reviewed by:	takawata
MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D23728
2020-02-19 06:28:55 +00:00

304 lines
8.6 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 1999 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $Id: acpiconf.c,v 1.5 2000/08/08 14:12:19 iwasaki Exp $
* $FreeBSD$
*/
#include <sys/param.h>
#include <err.h>
#include <fcntl.h>
#include <stdio.h>
#include <sys/ioctl.h>
#include <sysexits.h>
#include <unistd.h>
#include <dev/acpica/acpiio.h>
#include <contrib/dev/acpica/include/acpi.h>
#define ACPIDEV "/dev/acpi"
static int acpifd;
static void
acpi_init(void)
{
acpifd = open(ACPIDEV, O_RDWR);
if (acpifd == -1)
acpifd = open(ACPIDEV, O_RDONLY);
if (acpifd == -1)
err(EX_OSFILE, ACPIDEV);
}
/* Prepare to sleep and then wait for the signal that sleeping can occur. */
static void
acpi_sleep(int sleep_type)
{
int ret;
/* Notify OS that we want to sleep. devd(8) gets this notify. */
ret = ioctl(acpifd, ACPIIO_REQSLPSTATE, &sleep_type);
if (ret != 0)
err(EX_IOERR, "request sleep type (%d) failed", sleep_type);
}
/* Ack or abort a pending suspend request. */
static void
acpi_sleep_ack(int err_val)
{
int ret;
ret = ioctl(acpifd, ACPIIO_ACKSLPSTATE, &err_val);
if (ret != 0)
err(EX_IOERR, "ack sleep type failed");
}
/* should be a acpi define, but doesn't appear to be */
#define UNKNOWN_CAP 0xffffffff
#define UNKNOWN_VOLTAGE 0xffffffff
static int
acpi_battinfo(int num)
{
union acpi_battery_ioctl_arg battio;
const char *pwr_units;
int hours, min, amp;
uint32_t volt;
if (num < 0 || num > 64)
errx(EX_USAGE, "invalid battery %d", num);
/* Print battery design information. */
battio.unit = num;
if (ioctl(acpifd, ACPIIO_BATT_GET_BIX, &battio) == -1)
err(EX_IOERR, "get battery info (%d) failed", num);
amp = battio.bix.units;
pwr_units = amp ? "mA" : "mW";
if (battio.bix.dcap == UNKNOWN_CAP)
printf("Design capacity:\tunknown\n");
else
printf("Design capacity:\t%d %sh\n", battio.bix.dcap,
pwr_units);
if (battio.bix.lfcap == UNKNOWN_CAP)
printf("Last full capacity:\tunknown\n");
else
printf("Last full capacity:\t%d %sh\n", battio.bix.lfcap,
pwr_units);
printf("Technology:\t\t%s\n", battio.bix.btech == 0 ?
"primary (non-rechargeable)" : "secondary (rechargeable)");
if (ACPI_BIX_REV_MIN_CHECK(battio.bix.rev, ACPI_BIX_REV_1)) {
printf("Battery Swappable Capability:\t");
if (battio.bix.scap == ACPI_BIX_SCAP_NO)
printf("Non-swappable\n");
else if (battio.bix.scap == ACPI_BIX_SCAP_COLD)
printf("cold swap\n");
else if (battio.bix.scap == ACPI_BIX_SCAP_HOT)
printf("hot swap\n");
else
printf("unknown\n");
}
if (battio.bix.dvol == UNKNOWN_CAP)
printf("Design voltage:\t\tunknown\n");
else
printf("Design voltage:\t\t%d mV\n", battio.bix.dvol);
printf("Capacity (warn):\t%d %sh\n", battio.bix.wcap, pwr_units);
printf("Capacity (low):\t\t%d %sh\n", battio.bix.lcap, pwr_units);
if (ACPI_BIX_REV_MIN_CHECK(battio.bix.rev, ACPI_BIX_REV_0)) {
if (battio.bix.cycles != ACPI_BATT_UNKNOWN)
printf("Cycle Count:\t\t%d\n", battio.bix.cycles);
printf("Mesurement Accuracy:\t%d %%\n",
battio.bix.accuracy / 1000);
if (battio.bix.stmax != ACPI_BATT_UNKNOWN)
printf("Max Sampling Time:\t%d ms\n",
battio.bix.stmax);
if (battio.bix.stmin != ACPI_BATT_UNKNOWN)
printf("Min Sampling Time:\t%d ms\n",
battio.bix.stmin);
printf("Max Average Interval:\t%d ms\n",
battio.bix.aimax);
printf("Min Average Interval:\t%d ms\n",
battio.bix.aimin);
}
printf("Low/warn granularity:\t%d %sh\n", battio.bix.gra1, pwr_units);
printf("Warn/full granularity:\t%d %sh\n", battio.bix.gra2, pwr_units);
printf("Model number:\t\t%s\n", battio.bix.model);
printf("Serial number:\t\t%s\n", battio.bix.serial);
printf("Type:\t\t\t%s\n", battio.bix.type);
printf("OEM info:\t\t%s\n", battio.bix.oeminfo);
/* Fetch battery voltage information. */
volt = UNKNOWN_VOLTAGE;
battio.unit = num;
if (ioctl(acpifd, ACPIIO_BATT_GET_BST, &battio) == -1)
err(EX_IOERR, "get battery status (%d) failed", num);
if (battio.bst.state != ACPI_BATT_STAT_NOT_PRESENT)
volt = battio.bst.volt;
/* Print current battery state information. */
battio.unit = num;
if (ioctl(acpifd, ACPIIO_BATT_GET_BATTINFO, &battio) == -1)
err(EX_IOERR, "get battery user info (%d) failed", num);
if (battio.battinfo.state != ACPI_BATT_STAT_NOT_PRESENT) {
const char *state;
switch (battio.battinfo.state & ACPI_BATT_STAT_BST_MASK) {
case 0:
state = "high";
break;
case ACPI_BATT_STAT_DISCHARG:
state = "discharging";
break;
case ACPI_BATT_STAT_CHARGING:
state = "charging";
break;
case ACPI_BATT_STAT_CRITICAL:
state = "critical";
break;
case ACPI_BATT_STAT_DISCHARG | ACPI_BATT_STAT_CRITICAL:
state = "critical discharging";
break;
case ACPI_BATT_STAT_CHARGING | ACPI_BATT_STAT_CRITICAL:
state = "critical charging";
break;
default:
state = "invalid";
}
printf("State:\t\t\t%s\n", state);
if (battio.battinfo.cap == -1)
printf("Remaining capacity:\tunknown\n");
else
printf("Remaining capacity:\t%d%%\n",
battio.battinfo.cap);
if (battio.battinfo.min == -1)
printf("Remaining time:\t\tunknown\n");
else {
hours = battio.battinfo.min / 60;
min = battio.battinfo.min % 60;
printf("Remaining time:\t\t%d:%02d\n", hours, min);
}
if (battio.battinfo.rate == -1)
printf("Present rate:\t\tunknown\n");
else if (amp && volt != UNKNOWN_VOLTAGE) {
printf("Present rate:\t\t%d mA (%d mW)\n",
battio.battinfo.rate,
battio.battinfo.rate * volt / 1000);
} else
printf("Present rate:\t\t%d %s\n",
battio.battinfo.rate, pwr_units);
} else
printf("State:\t\t\tnot present\n");
/* Print battery voltage information. */
if (volt == UNKNOWN_VOLTAGE)
printf("Present voltage:\tunknown\n");
else
printf("Present voltage:\t%d mV\n", volt);
return (0);
}
static void
usage(const char* prog)
{
printf("usage: %s [-h] [-i batt] [-k ack] [-s 1-4]\n", prog);
exit(0);
}
int
main(int argc, char *argv[])
{
char *prog, *end;
int c, sleep_type, battery, ack;
int iflag = 0, kflag = 0, sflag = 0;
prog = argv[0];
if (argc < 2)
usage(prog);
/* NOTREACHED */
sleep_type = -1;
acpi_init();
while ((c = getopt(argc, argv, "hi:k:s:")) != -1) {
switch (c) {
case 'i':
iflag = 1;
battery = strtol(optarg, &end, 10);
if ((size_t)(end - optarg) != strlen(optarg))
errx(EX_USAGE, "invalid battery");
break;
case 'k':
kflag = 1;
ack = strtol(optarg, &end, 10);
if ((size_t)(end - optarg) != strlen(optarg))
errx(EX_USAGE, "invalid ack argument");
break;
case 's':
sflag = 1;
if (optarg[0] == 'S')
optarg++;
sleep_type = strtol(optarg, &end, 10);
if ((size_t)(end - optarg) != strlen(optarg))
errx(EX_USAGE, "invalid sleep type");
if (sleep_type < 1 || sleep_type > 4)
errx(EX_USAGE, "invalid sleep type (%d)",
sleep_type);
break;
case 'h':
default:
usage(prog);
/* NOTREACHED */
}
}
argc -= optind;
argv += optind;
if (iflag != 0 && kflag != 0 && sflag != 0)
errx(EX_USAGE, "-i, -k and -s are mutually exclusive");
if (iflag != 0) {
if (kflag != 0)
errx(EX_USAGE, "-i and -k are mutually exclusive");
if (sflag != 0)
errx(EX_USAGE, "-i and -s are mutually exclusive");
acpi_battinfo(battery);
}
if (kflag != 0) {
if (sflag != 0)
errx(EX_USAGE, "-k and -s are mutually exclusive");
acpi_sleep_ack(ack);
}
if (sflag != 0)
acpi_sleep(sleep_type);
close(acpifd);
exit (0);
}