1.. _regulator_api: 2 3Regulators 4########## 5 6This subsystem provides control of voltage and current regulators. A common 7example is a GPIO that controls a transistor that supplies current to a device 8that is not always needed. Another example is a PMIC, typically a much more 9complex device. 10 11The ``*-supply`` devicetree properties are used to identify the regulator(s) 12that a devicetree node directly depends on. Within the driver for the node the 13regulator API is used to issue requests for power when the device is to be 14active, and release the power request when the device shuts down. 15 16The simplest case where a regulator is needed is one where there is only one 17client. For those situations the cost of using the regulator device 18infrastructure is not justified, and ``*-gpios`` devicetree properties should be 19used. There is no device interface to these regulators as they are entirely 20controlled within the driver for the corresponding node, e.g. a sensor. 21 22.. _regulator_api_reference: 23 24API Reference 25************** 26 27.. doxygengroup:: regulator_interface 28
