WIP FPC-III support
[linux/fpc-iii.git] / Documentation / power / regulator / regulator.rst
blob794b3256fbb9f6a923274cb0de35e2dd9739730b
1 ==========================
2 Regulator Driver Interface
3 ==========================
5 The regulator driver interface is relatively simple and designed to allow
6 regulator drivers to register their services with the core framework.
9 Registration
10 ============
12 Drivers can register a regulator by calling::
14   struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc,
15                                            const struct regulator_config *config);
17 This will register the regulator's capabilities and operations to the regulator
18 core.
20 Regulators can be unregistered by calling::
22   void regulator_unregister(struct regulator_dev *rdev);
25 Regulator Events
26 ================
28 Regulators can send events (e.g. overtemperature, undervoltage, etc) to
29 consumer drivers by calling::
31   int regulator_notifier_call_chain(struct regulator_dev *rdev,
32                                     unsigned long event, void *data);