-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
regulator: Add some brief design documentation
Provide some brief documentation of some of the design decisions that are made by the regulator API. Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com> Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
- Loading branch information
Mark Brown
authored and
Liam Girdwood
committed
Sep 22, 2009
1 parent
55c1d7c
commit 63209a7
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
Regulator API design notes | ||
========================== | ||
|
||
This document provides a brief, partially structured, overview of some | ||
of the design considerations which impact the regulator API design. | ||
|
||
Safety | ||
------ | ||
|
||
- Errors in regulator configuration can have very serious consequences | ||
for the system, potentially including lasting hardware damage. | ||
- It is not possible to automatically determine the power confugration | ||
of the system - software-equivalent variants of the same chip may | ||
have different power requirments, and not all components with power | ||
requirements are visible to software. | ||
|
||
=> The API should make no changes to the hardware state unless it has | ||
specific knowledge that these changes are safe to do perform on | ||
this particular system. | ||
|
||
Consumer use cases | ||
------------------ | ||
|
||
- The overwhelming majority of devices in a system will have no | ||
requirement to do any runtime configuration of their power beyond | ||
being able to turn it on or off. | ||
|
||
- Many of the power supplies in the system will be shared between many | ||
different consumers. | ||
|
||
=> The consumer API should be structured so that these use cases are | ||
very easy to handle and so that consumers will work with shared | ||
supplies without any additional effort. |