From 1c8b3f4b0d21a63d0e55cf6560b6aa261944e991 Mon Sep 17 00:00:00 2001 From: Mark Brown Date: Tue, 22 Sep 2009 08:50:32 -0700 Subject: [PATCH] --- yaml --- r: 165407 b: refs/heads/master c: 63209a71e8e7727f52208d17bb7180cd392edcfb h: refs/heads/master i: 165405: 3165d4b9c129f235f95296553fcabb51e3844ee8 165403: 6245110b63bf9f9384e05290885598107966ecf3 165399: 33d931e98e69eb22790ddca1d7886af1d0da62a7 165391: 7f8a281e4b1f333bf6e78ea9e7fc956662b06c58 165375: f5d0b400dafbcd03b682d82c569ed89b7bd74806 v: v3 --- [refs] | 2 +- .../Documentation/power/regulator/design.txt | 33 +++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 trunk/Documentation/power/regulator/design.txt diff --git a/[refs] b/[refs] index 4d07b43f6c45..e97a1f6c4229 100644 --- a/[refs] +++ b/[refs] @@ -1,2 +1,2 @@ --- -refs/heads/master: 55c1d7c60d9b269551cd7cc31e6be8323e1d94ec +refs/heads/master: 63209a71e8e7727f52208d17bb7180cd392edcfb diff --git a/trunk/Documentation/power/regulator/design.txt b/trunk/Documentation/power/regulator/design.txt new file mode 100644 index 000000000000..f9b56b72b782 --- /dev/null +++ b/trunk/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.