Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/axp209.4
- This file was added.
.\"- | |||||
.\" Copyright (c) 2017 Emmanuel Vadot <manu@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. | |||||
.\" | |||||
.\" $FreeBSD$ | |||||
.\" | |||||
.Dd Dec 26, 2017 | |||||
.Dt AXP209 4 | |||||
bcr: Bump .Dd | |||||
.Os | |||||
.Sh NAME | |||||
.Nm axp209 | |||||
.Nd driver for the X-Power AXP209/AXP221 PMIC | |||||
.Sh SYNOPSIS | |||||
.Cd "device axp209" | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Nm | |||||
device driver provides support for the AXP209 and AXP221 Power Management | |||||
Integrated Circuit from X-Powers. | |||||
Some information like overvoltage, battery charging and power line status events | |||||
are passed to | |||||
.Xr devd 8 | |||||
for easy handling in userspace. | |||||
.Sh HARDWARE | |||||
The current version of the | |||||
.Nm | |||||
driver supports the AXP209 and AXP221 model. | |||||
GPIO is also supported for both models. | |||||
.Sh SYSCTL VARIABLES | |||||
Done Inline Actionss/model/models/ bcr: s/model/models/ | |||||
The following read-only variables are available for the AXP209 via | |||||
.Xr sysctl 8 : | |||||
.Bl -tag -width indent | |||||
.It Va dev.axp2xx_pmu.acvolt | |||||
Display the voltage present on the AC line (in microVolt). | |||||
.It Va dev.axp2xx_pmu.accurrent | |||||
Display the current drawn from the AC line (in microAmpere). | |||||
.It Va dev.axp2xx_pmu.vbusvolt | |||||
Done Inline ActionsNot sure about the drew here. Better use "drawn"? bcr: Not sure about the drew here. Better use "drawn"? | |||||
Display the voltage present on the VBUS line (in microVolt). | |||||
.It Va dev.axp2xx_pmu.accurrent | |||||
Display the current drawn from the VBUS line (in microAmpere). | |||||
.El | |||||
Done Inline ActionsSame here. bcr: Same here. | |||||
.Pp | |||||
The following read-only variables are available for both the AXP209 and AXP221 | |||||
via | |||||
.Xr sysctl 8 : | |||||
.Bl -tag -width indent | |||||
.It Va dev.axp2xx_pmu.batvolt | |||||
Display the voltage present on the BATT line (in microVolt). | |||||
.It Va dev.axp2xx_pmu.batchargecurrent | |||||
Display the battery charging current (in microAmpere). | |||||
.It Va dev.axp2xx_pmu.batdischargecurrent | |||||
Display the battery discharging current (in microAmpere). | |||||
.It Va dev.axp2xx_pmu.temp | |||||
Display the internal temperature (in Celcius). | |||||
.El | |||||
.Sh SEE ALSO | |||||
.Xr devctl 4 , | |||||
.Xr gpio 4 , | |||||
.Xr iicbus 4 , | |||||
.Xr devd 8 | |||||
.Sh HISTORY | |||||
The | |||||
.Nm | |||||
device driver first appeared in | |||||
.Fx 11.0 . | |||||
.Sh AUTHORS | |||||
The | |||||
.Nm | |||||
device driver and man page was written by | |||||
.An Emmanuel Vadot Aq Mt manu@freebsd.org . |
Bump .Dd