diff options
Diffstat (limited to 'static/freebsd/man4/acpi_battery.4 3.html')
| -rw-r--r-- | static/freebsd/man4/acpi_battery.4 3.html | 318 |
1 files changed, 318 insertions, 0 deletions
diff --git a/static/freebsd/man4/acpi_battery.4 3.html b/static/freebsd/man4/acpi_battery.4 3.html new file mode 100644 index 00000000..3c23170a --- /dev/null +++ b/static/freebsd/man4/acpi_battery.4 3.html @@ -0,0 +1,318 @@ +<table class="head"> + <tr> + <td class="head-ltitle">ACPI_BATTERY(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">ACPI_BATTERY(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">acpi_battery</code> — + <span class="Nd">ACPI battery management subsystem</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp"><code class="Cd">device acpi</code></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">acpi_battery</code> is a driver for battery + management features of the ACPI module.</p> +<p class="Pp">An ACPI-compatible battery device supports either a Control Method + Battery interface or a Smart Battery subsystem interface. The former is + accessed by the AML (ACPI Machine Language) code control methods, and the + latter is controlled directly through the ACPI EC (Embedded Controller) + typically via an SMBus interface.</p> +<p class="Pp">This driver supports the <a class="Xr">sysctl(8)</a> and + <a class="Xr">ioctl(2)</a> interfaces as well as the + <a class="Xr">devd(8)</a> event notification interface.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="IOCTLS"><a class="permalink" href="#IOCTLS">IOCTLS</a></h1> +<p class="Pp">Every ioctl for the <code class="Nm">acpi_battery</code> driver + takes a single integer value for the battery unit number as an argument, and + returns a specific structure for each request. A special unit number + <code class="Dv">ACPI_BATTERY_ALL_UNITS</code> specifies all of the attached + units and reports accumulated information.</p> +<dl class="Bl-tag"> + <dt id="ACPIIO_BATT_GET_UNITS"><a class="permalink" href="#ACPIIO_BATT_GET_UNITS"><code class="Dv">ACPIIO_BATT_GET_UNITS</code></a> + <var class="Vt">int</var></dt> + <dd>Returns the number of battery units in the system. The unit number + argument will be ignored.</dd> + <dt id="ACPIIO_BATT_GET_BATTINFO"><a class="permalink" href="#ACPIIO_BATT_GET_BATTINFO"><code class="Dv">ACPIIO_BATT_GET_BATTINFO</code></a> + <var class="Vt">struct acpi_battinfo</var></dt> + <dd>Returns the following: + <dl class="Bl-tag"> + <dt id="cap"><var class="Va">cap</var></dt> + <dd>Battery capacity in percent,</dd> + <dt id="min"><var class="Va">min</var></dt> + <dd>Remaining battery life in minutes,</dd> + <dt id="state"><var class="Va">state</var></dt> + <dd>Current status of the battery encoded in the following: + <dl class="Bl-tag"> + <dt id="ACPI_BATT_STAT_DISCHARG"><a class="permalink" href="#ACPI_BATT_STAT_DISCHARG"><code class="Dv">ACPI_BATT_STAT_DISCHARG</code></a> + (0x0001)</dt> + <dd>Battery is discharging,</dd> + <dt id="ACPI_BATT_STAT_CHARGING"><a class="permalink" href="#ACPI_BATT_STAT_CHARGING"><code class="Dv">ACPI_BATT_STAT_CHARGING</code></a> + (0x0002)</dt> + <dd>Battery is being charged, or</dd> + <dt id="ACPI_BATT_STAT_CRITICAL"><a class="permalink" href="#ACPI_BATT_STAT_CRITICAL"><code class="Dv">ACPI_BATT_STAT_CRITICAL</code></a> + (0x0004)</dt> + <dd>Remaining battery life is critically low.</dd> + </dl> + <p class="Pp">Note that the status bits of each battery will be + consolidated when <code class="Dv">ACPI_BATTERY_ALL_UNITS</code> is + specified.</p> + </dd> + <dt id="rate"><var class="Va">rate</var></dt> + <dd>Current battery discharging rate in mW. <code class="Li">-1</code> + means not discharging right now.</dd> + </dl> + </dd> + <dt id="ACPIIO_BATT_GET_BIX"><a class="permalink" href="#ACPIIO_BATT_GET_BIX"><code class="Dv">ACPIIO_BATT_GET_BIX</code></a> + <var class="Vt">struct acpi_bix</var></dt> + <dd>Returns battery information given by the ACPI <code class="Li">_BIX</code> + (Battery Information) object, which is the static portion of the Control + Method Battery information. In the case of a Smart Battery attached to + SMBus or a Control Method Battery with a <code class="Li">_BIF</code> + object, this ioctl will build a <var class="Vt">struct acpi_bix</var> + structure based on the obtained information and return it. + <dl class="Bl-tag"> + <dt id="rev"><var class="Va">rev</var></dt> + <dd>Revision number of the object. There are the following well-known + values: + <dl class="Bl-tag"> + <dt id="ACPI_BIX_REV_0"><a class="permalink" href="#ACPI_BIX_REV_0"><code class="Dv">ACPI_BIX_REV_0</code></a> + (0x0000)</dt> + <dd>A <code class="Li">_BIX</code> object in ACPI 4.0.</dd> + <dt id="ACPI_BIX_REV_1"><a class="permalink" href="#ACPI_BIX_REV_1"><code class="Dv">ACPI_BIX_REV_1</code></a> + (0x0001)</dt> + <dd>A <code class="Li">_BIX</code> object in ACPI 6.0.</dd> + <dt id="ACPI_BIX_REV_BIF"><a class="permalink" href="#ACPI_BIX_REV_BIF"><code class="Dv">ACPI_BIX_REV_BIF</code></a> + (0xffff)</dt> + <dd>A <code class="Li">_BIX</code> object built from the + <code class="Li">_BIF</code> object found on the system.</dd> + </dl> + <p class="Pp" id="ACPI_BIX_REV_MIN_CHECK">Note that this field should be + checked by using + <a class="permalink" href="#ACPI_BIX_REV_MIN_CHECK"><code class="Fn">ACPI_BIX_REV_MIN_CHECK</code></a>(<var class="Fa">var</var>, + <var class="Fa">rev</var>) macro when checking the minimum revision + number.</p> + </dd> + <dt id="units"><var class="Va">units</var></dt> + <dd>Indicates the units used by the battery to report its capacity and + charge rate encoded in the following: + <dl class="Bl-tag"> + <dt>ACPI_BIX_UNITS_MW (0x00000000)</dt> + <dd>in mW (power)</dd> + <dt>ACPI_BIX_UNITS_MA (0x00000001)</dt> + <dd>in mA (current)</dd> + </dl> + <p class="Pp">Note that capacity is expressed in mWh or mAh, and rate is + expressed in mW or mA, respectively.</p> + </dd> + <dt id="dcap"><var class="Va">dcap</var></dt> + <dd>The Battery's design capacity, which is the nominal capacity of a new + battery. This is expressed as power or current depending on the value + of <var class="Va">units</var>.</dd> + <dt id="lfcap"><var class="Va">lfcap</var></dt> + <dd>Predicted battery capacity when fully charged. Typically this will + decrease every charging cycle.</dd> + <dt>btech</dt> + <dd>Battery technology: + <dl class="Bl-tag"> + <dt>0x00000000 Primary cell (non-rechargeable)</dt> + <dd style="width: auto;"> </dd> + <dt>0x00000001 Secondary cell (rechargeable)</dt> + <dd style="width: auto;"> </dd> + </dl> + </dd> + <dt id="dvol"><var class="Va">dvol</var></dt> + <dd>Design voltage in mV, which is the nominal voltage of a new + battery.</dd> + <dt id="wcap"><var class="Va">wcap</var></dt> + <dd>Design capacity of warning. When a discharging battery device reaches + this capacity, notification is sent to the system.</dd> + <dt id="lcap"><var class="Va">lcap</var></dt> + <dd>Design capacity of low.</dd> + <dt id="cycles"><var class="Va">cycles</var></dt> + <dd>(rev 0 or newer) The number of cycles the battery has experienced. A + cycle means an amount of discharge occurred which was approximately + equal to the value of Design Capacity.</dd> + <dt id="accuracy"><var class="Va">accuracy</var></dt> + <dd>(rev 0 or newer) The accuracy of the battery capacity measurement, in + thousandth of a percent.</dd> + <dt id="stmax"><var class="Va">stmax</var></dt> + <dd>(rev 0 or newer) The Maximum Sampling Time of the battery in + milliseconds. This is the maximum duration between two consecutive + measurements of the battery's capacities specified in + <code class="Li">_BST</code>. If two succeeding readings of + <code class="Li">_BST</code> beyond this duration occur, two different + results can be returned.</dd> + <dt id="stmin"><var class="Va">stmin</var></dt> + <dd>(rev 0 or newer) The Minimum Sampling Time of the battery in + milliseconds.</dd> + <dt id="aimax"><var class="Va">aimax</var></dt> + <dd>(rev 0 or newer) The Maximum Average Interval of the battery in + milliseconds. This is the length of time within which the battery + averages the capacity measurements specified in + <code class="Li">_BST</code>. The Sampling Time specifies the + frequency of measurements, and the Average Interval specifies the + width of the time window of every measurement.</dd> + <dt id="aimin"><var class="Va">aimin</var></dt> + <dd>(rev 0 or newer) The Minimum Average Interval of the battery in + milliseconds.</dd> + <dt id="gra1"><var class="Va">gra1</var></dt> + <dd>Battery capacity granularity between <var class="Va">low</var> and + <var class="Va">warning</var>. This is expressed as power or current + depending on the value of <var class="Va">units</var>.</dd> + <dt id="gra2"><var class="Va">gra2</var></dt> + <dd>Battery capacity granularity between <var class="Va">warning</var> and + <var class="Va">full</var>. This is expressed as power or current + depending on the value of <var class="Va">units</var>.</dd> + <dt id="model"><var class="Va">model</var></dt> + <dd>Model number of the battery as a string.</dd> + <dt id="serial"><var class="Va">serial</var></dt> + <dd>Serial number of the battery as a string.</dd> + <dt id="type"><var class="Va">type</var></dt> + <dd>Type identifier of the battery as a string.</dd> + <dt id="oeminfo"><var class="Va">oeminfo</var></dt> + <dd>OEM-specific information of the battery as a string.</dd> + <dt id="scap"><var class="Va">scap</var></dt> + <dd>(rev 1 or newer) Battery swapping capability encoded in the following: + <dl class="Bl-tag"> + <dt>ACPI_BIX_SCAP_NO (0x00000000)</dt> + <dd>Non-swappable</dd> + <dt>ACPI_BIX_SCAP_COLD (0x00000001)</dt> + <dd>Cold-swappable</dd> + <dt>ACPI_BIX_SCAP_HOT (0x00000010)</dt> + <dd>Hot-swappable</dd> + </dl> + </dd> + </dl> + </dd> + <dt id="ACPIIO_BATT_GET_BIF"><a class="permalink" href="#ACPIIO_BATT_GET_BIF"><code class="Dv">ACPIIO_BATT_GET_BIF</code></a> + <var class="Vt">struct acpi_bif</var></dt> + <dd>(deprecated) Returns battery information given by the ACPI + <code class="Li">_BIF</code> (Battery Information) object, which was + deprecated in ACPI 4.0 specification. The data structure is a subset of + <var class="Vt">struct acpi_bix</var>. + <p class="Pp">Note that this ioctl will built a <var class="Vt">struct + acpi_bif</var> structure based on the obtained information even if this + object is not available and a <code class="Li">_BIX</code> object is + found.</p> + </dd> + <dt>ACPIIO_BATT_GET_BST <var class="Vt">struct acpi_bst</var></dt> + <dd>Returns battery information given by the ACPI <code class="Li">_BST</code> + (Battery Status) object, which is the present battery status. In the case + of a Smart Battery attached to SMBus, this ioctl will build a + <var class="Vt">struct acpi_bst</var> structure based on the obtained + information and return it. + <dl class="Bl-tag"> + <dt id="state~2"><var class="Va">state</var></dt> + <dd>Battery state. The value is encoded in the same way as + <var class="Va">state</var> of <var class="Vt">struct + acpi_battinfo</var>.</dd> + <dt id="rate~2"><var class="Va">rate</var></dt> + <dd>Battery present rate of charging or discharging. The unit of the value + depends on <var class="Va">unit</var> of <var class="Vt">struct + acpi_bif</var>.</dd> + <dt id="cap~2"><var class="Va">cap</var></dt> + <dd>Battery remaining capacity. The unit of this value depends on + <var class="Va">unit</var> of <var class="Vt">struct + acpi_bif</var>.</dd> + <dt id="volt"><var class="Va">volt</var></dt> + <dd>Battery present voltage.</dd> + </dl> + </dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL + VARIABLES</a></h1> +<p class="Pp">The following <a class="Xr">sysctl(8)</a> variables export battery + status. Note that they are accumulated status of all of the connected + batteries:</p> +<dl class="Bl-tag"> + <dt id="hw.acpi.battery.info_expire"><var class="Va">hw.acpi.battery.info_expire</var></dt> + <dd>Information cache expiration time in seconds. The battery information + obtained by <code class="Li">_BIX</code> or <code class="Li">_BIF</code> + object will be stored and reused for successive read access to this MIB + within the specified period.</dd> + <dt id="hw.acpi.battery.units"><var class="Va">hw.acpi.battery.units</var></dt> + <dd>Number of battery units in the system.</dd> + <dt id="hw.acpi.battery.state"><var class="Va">hw.acpi.battery.state</var></dt> + <dd>Current battery charging status. This is same as + <var class="Va">state</var> of <var class="Vt">struct + acpi_battinfo</var>.</dd> + <dt id="hw.acpi.battery.rate"><var class="Va">hw.acpi.battery.rate</var></dt> + <dd>Current battery discharging rate in mW.</dd> + <dt id="hw.acpi.battery.time"><var class="Va">hw.acpi.battery.time</var></dt> + <dd>Remaining battery life in minutes. If the battery is not discharging, the + value shows <code class="Li">-1</code>.</dd> + <dt id="hw.acpi.battery.life"><var class="Va">hw.acpi.battery.life</var></dt> + <dd>Battery capacity in percent.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="EVENT_NOTIFICATIONS"><a class="permalink" href="#EVENT_NOTIFICATIONS">EVENT + NOTIFICATIONS</a></h1> +<p class="Pp">Battery-related event notifications are sent to the userland via + the <a class="Xr">devd(8)</a> interface. See + <span class="Pa">/etc/devd.conf</span> and <a class="Xr">devd.conf(5)</a> + for more details. Note that notifications are supported only by the Control + Method Battery.</p> +<p class="Pp">The <code class="Nm">acpi_battery</code> driver sends events with + the following attributes:</p> +<p class="Pp"></p> +<dl class="Bl-tag Bl-compact"> + <dt id="ACPI">system</dt> + <dd><a class="permalink" href="#ACPI"><code class="Li">ACPI</code></a></dd> + <dt id="CMBAT">subsystem</dt> + <dd><a class="permalink" href="#CMBAT"><code class="Li">CMBAT</code></a></dd> + <dt>type</dt> + <dd>The fully qualified battery object path as in the ASL.</dd> + <dt>notify</dt> + <dd>An integer designating the event: + <p class="Pp"></p> + <dl class="Bl-tag Bl-compact"> + <dt id="0x80"><a class="permalink" href="#0x80"><code class="Li">0x80</code></a></dt> + <dd>Battery status was changed.</dd> + <dt id="0x81"><a class="permalink" href="#0x81"><code class="Li">0x81</code></a></dt> + <dd>Battery information was changed.</dd> + </dl> + </dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">acpi(4)</a>, <a class="Xr">acpiconf(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp"><span class="An">Nate Lawson</span> + <<a class="Mt" href="mailto:njl@FreeBSD.org">njl@FreeBSD.org</a>>, + <span class="An">Munehiro Matsuda</span>, <span class="An">Takanori + Watanabe</span> + <<a class="Mt" href="mailto:takawata@FreeBSD.org">takawata@FreeBSD.org</a>>, + <span class="An">Mitsuru IWASAKI</span> + <<a class="Mt" href="mailto:iwasaki@FreeBSD.org">iwasaki@FreeBSD.org</a>>, + <span class="An">Hans Petter Selasky</span> + <<a class="Mt" href="mailto:hselasky@FreeBSD.org">hselasky@FreeBSD.org</a>>, + and <span class="An">Hiroki Sato</span> + <<a class="Mt" href="mailto:hrs@FreeBSD.org">hrs@FreeBSD.org</a>>.</p> +<p class="Pp">This manual page was written by <span class="An">Takanori + Watanabe</span> + <<a class="Mt" href="mailto:takawata@FreeBSD.org">takawata@FreeBSD.org</a>> + and <span class="An">Hiroki Sato</span> + <<a class="Mt" href="mailto:hrs@FreeBSD.org">hrs@FreeBSD.org</a>>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">February 16, 2020</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |