diff options
author | Mark Brown <broonie@opensource.wolfsonmicro.com> | 2009-09-22 08:50:32 -0700 |
---|---|---|
committer | Liam Girdwood <lrg@slimlogic.co.uk> | 2009-09-22 22:16:53 +0100 |
commit | 63209a71e8e7727f52208d17bb7180cd392edcfb (patch) | |
tree | 66f39826fdde64d0d77555a98c744d171df1e4fc /Documentation/power | |
parent | 55c1d7c60d9b269551cd7cc31e6be8323e1d94ec (diff) | |
download | linux-3.10-63209a71e8e7727f52208d17bb7180cd392edcfb.tar.gz linux-3.10-63209a71e8e7727f52208d17bb7180cd392edcfb.tar.bz2 linux-3.10-63209a71e8e7727f52208d17bb7180cd392edcfb.zip |
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>
Diffstat (limited to 'Documentation/power')
-rw-r--r-- | Documentation/power/regulator/design.txt | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/Documentation/power/regulator/design.txt b/Documentation/power/regulator/design.txt new file mode 100644 index 00000000000..f9b56b72b78 --- /dev/null +++ b/Documentation/power/regulator/design.txt @@ -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. |