summaryrefslogtreecommitdiffstats
path: root/include/linux/regulator
diff options
context:
space:
mode:
authorDavid Brownell <david-b@pacbell.net>2009-02-26 13:28:41 -0800
committerLiam Girdwood <lrg@slimlogic.co.uk>2009-03-31 09:56:25 +0100
commit3b2a6061afe6fcc44437cd5ec641b0aeb2825ee3 (patch)
treede1d6cf774e001bc6fe8f3fd2e8cdf3340cd04e6 /include/linux/regulator
parent4367cfdc7c657ad8a797f51b9ffd3c64b31910e7 (diff)
downloadop-kernel-dev-3b2a6061afe6fcc44437cd5ec641b0aeb2825ee3.zip
op-kernel-dev-3b2a6061afe6fcc44437cd5ec641b0aeb2825ee3.tar.gz
regulator: get_status() grows kerneldoc
Add kerneldoc for the new get_status() message. Fix the existing kerneldoc for that struct in two ways: (a) Syntax, making sure parameter descriptions immediately follow the one-line struct description and that the first blank lines is before any more expansive description; (b) Presentation for a few points, to highlight the fact that the previous "get" methods exist only to report the current configuration, not to display actual status. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net> Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
Diffstat (limited to 'include/linux/regulator')
-rw-r--r--include/linux/regulator/driver.h19
1 files changed, 10 insertions, 9 deletions
diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
index 2255468..4848d8d 100644
--- a/include/linux/regulator/driver.h
+++ b/include/linux/regulator/driver.h
@@ -35,11 +35,8 @@ enum regulator_status {
/**
* struct regulator_ops - regulator operations.
*
- * This struct describes regulator operations which can be implemented by
- * regulator chip drivers.
- *
- * @enable: Enable the regulator.
- * @disable: Disable the regulator.
+ * @enable: Configure the regulator as enabled.
+ * @disable: Configure the regulator as disabled.
* @is_enabled: Return 1 if the regulator is enabled, 0 otherwise.
*
* @set_voltage: Set the voltage for the regulator within the range specified.
@@ -51,11 +48,11 @@ enum regulator_status {
* regulator_desc.n_voltages. Voltages may be reported in any order.
*
* @set_current_limit: Configure a limit for a current-limited regulator.
- * @get_current_limit: Get the limit for a current-limited regulator.
+ * @get_current_limit: Get the configured limit for a current-limited regulator.
*
- * @set_mode: Set the operating mode for the regulator.
- * @get_mode: Get the current operating mode for the regulator.
- * @get_status: Report the regulator status.
+ * @get_mode: Get the configured operating mode for the regulator.
+ * @get_status: Return actual (not as-configured) status of regulator, as a
+ * REGULATOR_STATUS value (or negative errno)
* @get_optimum_mode: Get the most efficient operating mode for the regulator
* when running with the specified parameters.
*
@@ -67,6 +64,9 @@ enum regulator_status {
* suspended.
* @set_suspend_mode: Set the operating mode for the regulator when the
* system is suspended.
+ *
+ * This struct describes regulator operations which can be implemented by
+ * regulator chip drivers.
*/
struct regulator_ops {
@@ -94,6 +94,7 @@ struct regulator_ops {
/* report regulator status ... most other accessors report
* control inputs, this reports results of combining inputs
* from Linux (and other sources) with the actual load.
+ * returns REGULATOR_STATUS_* or negative errno.
*/
int (*get_status)(struct regulator_dev *);
OpenPOWER on IntegriCloud