[deliverable/linux.git] / Documentation / power / regulator / regulator.txt

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,
					 const struct regulator_config *config);

This will register the regulator's capabilities and operations to the regulator
core.

Regulators can be unregistered by calling :-

void regulator_unregister(struct regulator_dev *rdev);


Regulator Events
================
Regulators can send events (e.g. overtemperature, undervoltage, etc) to
consumer drivers by calling :-

int regulator_notifier_call_chain(struct regulator_dev *rdev,
				  unsigned long event, void *data);
Commit	Line	Data
e8695ebe LG	1	Regulator Driver Interface
	2	==========================
	3
	4	The regulator driver interface is relatively simple and designed to allow
	5	regulator drivers to register their services with the core framework.
	6
	7
	8	Registration
	9	============
	10
	11	Drivers can register a regulator by calling :-
	12
040932cd	13	struct regulator_dev regulator_register(struct regulator_desc regulator_desc,
127ef627	14	const struct regulator_config *config);
e8695ebe	15
3a4c6959	16	This will register the regulator's capabilities and operations to the regulator
a5766f11	17	core.
e8695ebe LG	18
	19	Regulators can be unregistered by calling :-
	20
	21	void regulator_unregister(struct regulator_dev *rdev);
	22
	23
	24	Regulator Events
	25	================
3a4c6959 GU	26	Regulators can send events (e.g. overtemperature, undervoltage, etc) to
3a4c6959 GU	27	consumer drivers by calling :-
e8695ebe LG	28
	29	int regulator_notifier_call_chain(struct regulator_dev *rdev,
	30	unsigned long event, void *data);