Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e8695ebe authored by Liam Girdwood's avatar Liam Girdwood
Browse files

regulator: documentation - regulator driver



This adds documentation describing the regulator driver interface.

Signed-off-by: default avatarLiam Girdwood <lg@opensource.wolfsonmicro.com>
parent 6392776d
Loading
Loading
Loading
Loading
+30 −0
Original line number Diff line number Diff line
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);