[src/trunk]: src/share/man/man4 Add man page for TPS65217 PMIC.

[rkujawa <rkujawa%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/c7caf2db0fca
branches:  trunk
changeset: 786341:c7caf2db0fca
user:      rkujawa <rkujawa%NetBSD.org@localhost>
date:      Fri Apr 26 20:08:53 2013 +0000

description:
Add man page for TPS65217 PMIC.

diffstat:

 share/man/man4/Makefile       |   4 +-
 share/man/man4/tps65217pmic.4 |  67 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+), 2 deletions(-)

diffs (89 lines):

diff -r 0b01cbdbd983 -r c7caf2db0fca share/man/man4/Makefile
--- a/share/man/man4/Makefile   Fri Apr 26 19:37:18 2013 +0000
+++ b/share/man/man4/Makefile   Fri Apr 26 20:08:53 2013 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.597 2013/03/30 02:38:58 christos Exp $
+#      $NetBSD: Makefile,v 1.598 2013/04/26 20:08:53 rkujawa Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   aac.4 ac97.4 acardide.4 aceride.4 acphy.4 \
@@ -121,7 +121,7 @@
 MAN+=  fwohci.4 fwip.4 sbp.4
 
 # machine-independent I2C devices
-MAN+=  dbcool.4 g760a.4 lmtemp.4 sdtemp.4 smscmon.4 spdmem.4
+MAN+=  dbcool.4 g760a.4 lmtemp.4 sdtemp.4 smscmon.4 spdmem.4 tps65217pmic.4
 
 # machine-independent SPI devices
 MAN += m25p.4 tm121temp.4
diff -r 0b01cbdbd983 -r c7caf2db0fca share/man/man4/tps65217pmic.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/tps65217pmic.4     Fri Apr 26 20:08:53 2013 +0000
@@ -0,0 +1,67 @@
+.\" $NetBSD: tps65217pmic.4,v 1.1 2013/04/26 20:08:53 rkujawa Exp $
+.\"
+.\" Copyright (c) 2013 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Radoslaw Kujawa.
+.\"
+.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
+.\"
+.Dd April 26, 2013
+.Dt TPS65217PMIC 4
+.Os
+.Sh NAME
+.Nm tps65217pmic 
+.Nd Texas Instruments TPS65217 Power Management IC driver
+.Sh SYNOPSIS
+.Cd "tps65217pmic0 at iic? addr 0x24"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides minimal support for the TPS65217 chip and allows reporting
+regulated voltages through
+.Xr envsys 4 
+API.
+.Sh SEE ALSO
+.Xr envsys 4
+.Sh HISTORY
+The
+.Nm
+device first appeared in
+.Nx 7.0 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Radoslaw Kujawa Aq radoslaw.kujawa%gmail.com@localhost .
+.Sh CAVEATS
+The driver can only report current voltage regulator settings.
+It can not measure the real voltage, as TPS65217 chip lacks hardware to do
+that.
+
+Modifying voltage regulator parameters was deliberately left unimplemented, as
+these parameters should only be set at the firmware level.
+Setting wrong parameters may result in permanent hardware damange.
+.Sh BUGS
+Battery and interrupt support is not implemented.