xref: /netbsd-src/share/man/man4/tps65217pmic.4 (revision 565352da0cf797e364f1d199289423e72913fcd0)
1.\" $NetBSD: tps65217pmic.4,v 1.10 2018/06/28 22:00:50 wiz Exp $
2.\"
3.\" Copyright (c) 2013 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Radoslaw Kujawa.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd June 28, 2018
31.Dt TPS65217PMIC 4
32.Os
33.Sh NAME
34.Nm tps65217pmic
35.Nd Texas Instruments TPS65217 Power Management IC driver
36.Sh SYNOPSIS
37.Cd "tps65217pmic0 at iic? addr 0x24"
38.Sh DESCRIPTION
39The
40.Nm
41driver provides minimal support for the TPS65217 chip and allows reporting
42regulated voltages through the
43.Xr envsys 4
44API.
45.Pp
46The TPS65217 consists of low-dropout regulators (LDO) and step-down converters
47with integrated switching FETs (DCDC):
48.Bl -bullet -compact
49.It
50LDO1: 1.0V - 3.3V
51.It
52LDO2: 0.9V - 3.3V
53.It
54LDO3: 1.5V - 3.3V
55.It
56LDO4: 1.5V - 3.3V
57.It
58DCDC1: 0.9V - 1.8V
59.It
60DCDC2: 0.9V - 3.3V
61.It
62DCDC1: 0.9V - 1.5V
63.El
64.Sh SEE ALSO
65.Xr envsys 4
66.Sh HISTORY
67The
68.Nm
69device first appeared in
70.Nx 7.0 .
71.Sh AUTHORS
72.An -nosplit
73The
74.Nm
75driver was written by
76.An Radoslaw Kujawa Aq Mt radoslaw.kujawa@gmail.com .
77Voltage change callback for AM335x was added by
78.An Manuel Bouyer .
79White LED (backlight) support was added by
80.An KIYOHARA Takashi .
81.Sh CAVEATS
82The driver can only report current voltage regulator settings.
83It can not measure the real voltage, as the TPS65217 chip lacks hardware to do
84that.
85Some boards allow voltage measurement by connecting the power output to
86external sensor, or analog input of the MPU, but this is outside of the
87scope of this driver.
88.Pp
89Modifying voltage regulator parameters from user space was deliberately left
90unimplemented, as these parameters should only be set at the firmware or
91kernel level.
92Setting wrong parameters may result in permanent hardware damage.
93.Pp
94The
95.Nm
96driver offers a function that can be used to change the voltage from other
97kernel components (currently used by AM335x support code).
98.Sh BUGS
99Battery and interrupt support is not implemented.
100