regulator: documentation - regulator driver
Subsystems (2)
PATCH 11/13 regulator: documentation - regulator driver
This adds documentation describing the regulator driver interface.
Signed-off-by Liam Girdwood <[email protected]>
--- Documentation/power/regulator/regulator.txt | 30 +++++++++++++++++++++++++++ 1 files changed, 30 insertions(+), 0 deletions(-) create mode 100644 Documentation/power/regulator/regulator.txt
Documentation/power/regulator/regulator.txt new file +30 -0
@@ -0,0 +1,30 @@ +Regulator Driver Interface +========================== + +The regulator driver interface is relatively simple and designed to allow +regulator drivers to register their services with the core framework. + + +Registration +============ + +Drivers can register a regulator by calling :- + +struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc, + void *reg_data); + +This will register the regulators capabilities and operations the regulator +core. The core does not touch reg_data (private to regulator driver). + +Regulators can be unregistered by calling :- + +void regulator_unregister(struct regulator_dev *rdev); + + +Regulator Events +================ +Regulators can send events (e.g. over temp, under voltage, etc) to consumer +drivers by calling :- + +int regulator_notifier_call_chain(struct regulator_dev *rdev, + unsigned long event, void *data);
Signature · 1 line
1.5.4.3