diff options
author | Geert Uytterhoeven <geert+renesas@glider.be> | 2014-08-25 04:47:51 -0400 |
---|---|---|
committer | Mark Brown <broonie@linaro.org> | 2014-08-27 17:04:36 -0400 |
commit | 3a4c695965cb1b3fd5b7e420eeab958af139328c (patch) | |
tree | c5290eea6dba7090358236d31517341b4ddfd9ae /Documentation/power | |
parent | 7d1311b93e58ed55f3a31cc8f94c4b8fe988a2b9 (diff) |
regulator: Proofread documentation
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Mark Brown <broonie@linaro.org>
Diffstat (limited to 'Documentation/power')
-rw-r--r-- | Documentation/power/regulator/consumer.txt | 7 | ||||
-rw-r--r-- | Documentation/power/regulator/design.txt | 8 | ||||
-rw-r--r-- | Documentation/power/regulator/machine.txt | 4 | ||||
-rw-r--r-- | Documentation/power/regulator/overview.txt | 6 | ||||
-rw-r--r-- | Documentation/power/regulator/regulator.txt | 6 |
5 files changed, 16 insertions, 15 deletions
diff --git a/Documentation/power/regulator/consumer.txt b/Documentation/power/regulator/consumer.txt index 81c0e2b49cd8..8afb236ca765 100644 --- a/Documentation/power/regulator/consumer.txt +++ b/Documentation/power/regulator/consumer.txt | |||
@@ -143,8 +143,9 @@ This will cause the core to recalculate the total load on the regulator (based | |||
143 | on all its consumers) and change operating mode (if necessary and permitted) | 143 | on all its consumers) and change operating mode (if necessary and permitted) |
144 | to best match the current operating load. | 144 | to best match the current operating load. |
145 | 145 | ||
146 | The load_uA value can be determined from the consumers datasheet. e.g.most | 146 | The load_uA value can be determined from the consumer's datasheet. e.g. most |
147 | datasheets have tables showing the max current consumed in certain situations. | 147 | datasheets have tables showing the maximum current consumed in certain |
148 | situations. | ||
148 | 149 | ||
149 | Most consumers will use indirect operating mode control since they have no | 150 | Most consumers will use indirect operating mode control since they have no |
150 | knowledge of the regulator or whether the regulator is shared with other | 151 | knowledge of the regulator or whether the regulator is shared with other |
@@ -173,7 +174,7 @@ Consumers can register interest in regulator events by calling :- | |||
173 | int regulator_register_notifier(struct regulator *regulator, | 174 | int regulator_register_notifier(struct regulator *regulator, |
174 | struct notifier_block *nb); | 175 | struct notifier_block *nb); |
175 | 176 | ||
176 | Consumers can uregister interest by calling :- | 177 | Consumers can unregister interest by calling :- |
177 | 178 | ||
178 | int regulator_unregister_notifier(struct regulator *regulator, | 179 | int regulator_unregister_notifier(struct regulator *regulator, |
179 | struct notifier_block *nb); | 180 | struct notifier_block *nb); |
diff --git a/Documentation/power/regulator/design.txt b/Documentation/power/regulator/design.txt index f9b56b72b782..fdd919b96830 100644 --- a/Documentation/power/regulator/design.txt +++ b/Documentation/power/regulator/design.txt | |||
@@ -9,14 +9,14 @@ Safety | |||
9 | 9 | ||
10 | - Errors in regulator configuration can have very serious consequences | 10 | - Errors in regulator configuration can have very serious consequences |
11 | for the system, potentially including lasting hardware damage. | 11 | for the system, potentially including lasting hardware damage. |
12 | - It is not possible to automatically determine the power confugration | 12 | - It is not possible to automatically determine the power configuration |
13 | of the system - software-equivalent variants of the same chip may | 13 | of the system - software-equivalent variants of the same chip may |
14 | have different power requirments, and not all components with power | 14 | have different power requirements, and not all components with power |
15 | requirements are visible to software. | 15 | requirements are visible to software. |
16 | 16 | ||
17 | => The API should make no changes to the hardware state unless it has | 17 | => The API should make no changes to the hardware state unless it has |
18 | specific knowledge that these changes are safe to do perform on | 18 | specific knowledge that these changes are safe to perform on this |
19 | this particular system. | 19 | particular system. |
20 | 20 | ||
21 | Consumer use cases | 21 | Consumer use cases |
22 | ------------------ | 22 | ------------------ |
diff --git a/Documentation/power/regulator/machine.txt b/Documentation/power/regulator/machine.txt index ce63af0a8e35..757e3b53dc11 100644 --- a/Documentation/power/regulator/machine.txt +++ b/Documentation/power/regulator/machine.txt | |||
@@ -11,7 +11,7 @@ Consider the following machine :- | |||
11 | +-> [Consumer B @ 3.3V] | 11 | +-> [Consumer B @ 3.3V] |
12 | 12 | ||
13 | The drivers for consumers A & B must be mapped to the correct regulator in | 13 | The drivers for consumers A & B must be mapped to the correct regulator in |
14 | order to control their power supply. This mapping can be achieved in machine | 14 | order to control their power supplies. This mapping can be achieved in machine |
15 | initialisation code by creating a struct regulator_consumer_supply for | 15 | initialisation code by creating a struct regulator_consumer_supply for |
16 | each regulator. | 16 | each regulator. |
17 | 17 | ||
@@ -39,7 +39,7 @@ to the 'Vcc' supply for Consumer A. | |||
39 | 39 | ||
40 | Constraints can now be registered by defining a struct regulator_init_data | 40 | Constraints can now be registered by defining a struct regulator_init_data |
41 | for each regulator power domain. This structure also maps the consumers | 41 | for each regulator power domain. This structure also maps the consumers |
42 | to their supply regulator :- | 42 | to their supply regulators :- |
43 | 43 | ||
44 | static struct regulator_init_data regulator1_data = { | 44 | static struct regulator_init_data regulator1_data = { |
45 | .constraints = { | 45 | .constraints = { |
diff --git a/Documentation/power/regulator/overview.txt b/Documentation/power/regulator/overview.txt index 8ed17587a74b..40ca2d6e2742 100644 --- a/Documentation/power/regulator/overview.txt +++ b/Documentation/power/regulator/overview.txt | |||
@@ -36,11 +36,11 @@ Some terms used in this document:- | |||
36 | Consumers can be classified into two types:- | 36 | Consumers can be classified into two types:- |
37 | 37 | ||
38 | Static: consumer does not change its supply voltage or | 38 | Static: consumer does not change its supply voltage or |
39 | current limit. It only needs to enable or disable it's | 39 | current limit. It only needs to enable or disable its |
40 | power supply. Its supply voltage is set by the hardware, | 40 | power supply. Its supply voltage is set by the hardware, |
41 | bootloader, firmware or kernel board initialisation code. | 41 | bootloader, firmware or kernel board initialisation code. |
42 | 42 | ||
43 | Dynamic: consumer needs to change it's supply voltage or | 43 | Dynamic: consumer needs to change its supply voltage or |
44 | current limit to meet operation demands. | 44 | current limit to meet operation demands. |
45 | 45 | ||
46 | 46 | ||
@@ -156,7 +156,7 @@ relevant to non SoC devices and is split into the following four interfaces:- | |||
156 | This interface is for machine specific code and allows the creation of | 156 | This interface is for machine specific code and allows the creation of |
157 | voltage/current domains (with constraints) for each regulator. It can | 157 | voltage/current domains (with constraints) for each regulator. It can |
158 | provide regulator constraints that will prevent device damage through | 158 | provide regulator constraints that will prevent device damage through |
159 | overvoltage or over current caused by buggy client drivers. It also | 159 | overvoltage or overcurrent caused by buggy client drivers. It also |
160 | allows the creation of a regulator tree whereby some regulators are | 160 | allows the creation of a regulator tree whereby some regulators are |
161 | supplied by others (similar to a clock tree). | 161 | supplied by others (similar to a clock tree). |
162 | 162 | ||
diff --git a/Documentation/power/regulator/regulator.txt b/Documentation/power/regulator/regulator.txt index 13902778ae44..b17e5833ce21 100644 --- a/Documentation/power/regulator/regulator.txt +++ b/Documentation/power/regulator/regulator.txt | |||
@@ -13,7 +13,7 @@ Drivers can register a regulator by calling :- | |||
13 | struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc, | 13 | struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc, |
14 | const struct regulator_config *config); | 14 | const struct regulator_config *config); |
15 | 15 | ||
16 | This will register the regulators capabilities and operations to the regulator | 16 | This will register the regulator's capabilities and operations to the regulator |
17 | core. | 17 | core. |
18 | 18 | ||
19 | Regulators can be unregistered by calling :- | 19 | Regulators can be unregistered by calling :- |
@@ -23,8 +23,8 @@ void regulator_unregister(struct regulator_dev *rdev); | |||
23 | 23 | ||
24 | Regulator Events | 24 | Regulator Events |
25 | ================ | 25 | ================ |
26 | Regulators can send events (e.g. over temp, under voltage, etc) to consumer | 26 | Regulators can send events (e.g. overtemperature, undervoltage, etc) to |
27 | drivers by calling :- | 27 | consumer drivers by calling :- |
28 | 28 | ||
29 | int regulator_notifier_call_chain(struct regulator_dev *rdev, | 29 | int regulator_notifier_call_chain(struct regulator_dev *rdev, |
30 | unsigned long event, void *data); | 30 | unsigned long event, void *data); |