Skip to content

Commit

Permalink
regulator: documentation - regulator driver
Browse files Browse the repository at this point in the history
This adds documentation describing the regulator driver interface.

Signed-off-by: Liam Girdwood <lg@opensource.wolfsonmicro.com>
  • Loading branch information
Liam Girdwood committed Jul 30, 2008
1 parent 6392776 commit e8695eb
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions Documentation/power/regulator/regulator.txt
Original file line number Diff line number Diff line change
@@ -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);

0 comments on commit e8695eb

Please sign in to comment.