Documentation/driver-api/regulator.rst

1 .. Copyright 2007-2008 Wolfson Microelectronics
20 The intention is to allow systems to dynamically control regulator power
21 output in order to save power and prolong battery life. This applies to
27 ``Documentation/power/regulator``.
30 --------
36     Electronic device that supplies power to other devices. Most regulators
42     Electronic device which consumes power provided by a regulator. These
44     requiring active management of the regulator at runtime.
46 Power Domain
52 Power Management Integrated Circuit (PMIC)
54     An IC which contains numerous regulators and often also other
55     subsystems. In an embedded system the primary PMIC is often equivalent
56     to a combination of the PSU and southbridge in a desktop system.
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
68 When requesting regulators consumers use symbolic names for their
76 ----------------------
90 -------------
93 supplies. For example, MMC drivers may need to select the correct
94 operating voltage for their cards. This may be done while the regulator
99 interface for this. Both take ranges of voltages and currents, supporting
107 ---------
109 Callbacks may also be registered for events such as regulation failures.
114 Drivers for regulator chips register the regulators with the regulator
119 supplying a struct regulator_init_data for the regulator
126 consumers on a given system and what the valid operating parameters are
127 for the system.
130 --------
137 -----------
143 a given system, for example supporting higher supply voltages than the
144 consumers are rated for.
149 The constraints may also specify an initial configuration for the
150 regulator in the constraints, which is particularly useful for use with
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