Documentation/driver-api/regulator.rst

1 .. Copyright 2007-2008 Wolfson Microelectronics
8 Voltage and current regulator API
18 control voltage and current regulators.
20 The intention is to allow systems to dynamically control regulator power
27 ``Documentation/power/regulator``.
30 --------
32 The regulator API uses a number of terms which may not be familiar:
34 Regulator
37     can enable and disable their output and some can also control their
42     Electronic device which consumes power provided by a regulator. These
44     requiring active management of the regulator at runtime.
48     The electronic circuit supplied by a given regulator, including the
49     regulator and all consumer devices. The configuration of the regulator
62 drivers use `get <#API-regulator-get>`__ and
63 `put <#API-regulator-put>`__ operations to acquire and release
64 regulators. Functions are provided to `enable <#API-regulator-enable>`__
65 and `disable <#API-regulator-disable>`__ the regulator and to get and
66 set the runtime parameters of the regulator.
69 supplies, such as "Vcc", which are mapped into actual regulator devices
72 A stub version of this API is provided when the regulator framework is
76 ----------------------
78 The regulator API provides reference counted enabling and disabling of
80 :c:func:`regulator_disable()` functions to enable and disable
83 Note that since multiple consumers may be using a regulator and machine
84 constraints may not allow the regulator to be disabled there is no
86 cause the supply provided by the regulator to be disabled. Consumer
87 drivers should assume that the regulator may be enabled at all times.
90 -------------
94 operating voltage for their cards. This may be done while the regulator
107 ---------
111 Regulator driver interface
114 Drivers for regulator chips register the regulators with the regulator
119 supplying a struct regulator_init_data for the regulator
130 --------
132 Regulator supplies are specified using struct
137 -----------
142 regulator devices will offer more flexibility than it is safe to use on
150 regulator in the constraints, which is particularly useful for use with
157 existing layout of the source code the entire regulator API is
160 .. kernel-doc:: include/linux/regulator/consumer.h
163 .. kernel-doc:: include/linux/regulator/machine.h
166 .. kernel-doc:: include/linux/regulator/driver.h
169 .. kernel-doc:: drivers/regulator/core.c