Messages in this thread Patch in this message | | | From | David Brownell <> | Subject | Re: [patch 2.6.29-rc] regulator: add get_status() | Date | Thu, 15 Jan 2009 10:11:51 -0800 |
| |
On Thursday 15 January 2009, Liam Girdwood wrote: > > > ...this needs kerneldoc adding. > > Please send a separate patch for the kerneldoc as I've already applied.
Appended....
========== CUT HERE From: David Brownell <dbrownell@users.sourceforge.net> Subject: 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> --- include/linux/regulator/driver.h | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-)
--- a/include/linux/regulator/driver.h +++ b/include/linux/regulator/driver.h @@ -34,26 +34,20 @@ 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. * The driver should select the voltage closest to min_uV. * @get_voltage: Return the currently configured voltage for the regulator. - * * @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_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. - * * @set_suspend_voltage: Set the voltage for the regulator when the system * is suspended. * @set_suspend_enable: Mark the regulator as enabled when the system is @@ -62,6 +56,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 { @@ -86,6 +83,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 *);
| |