[2.6.29-rc6,1/2] regulator: enumerate voltages (v2)

Commit Message

David Brownell Feb. 26, 2009, 9:28 p.m. UTC

On Thursday 26 February 2009, Liam Girdwood wrote:
> Applied with git-am merge conflicts. It builds ok, can you check against
> your tree.

What were the conflicts -- just offsets?

Your "-next" regulator tree seems to be missing a doc patch
you had asked for, maybe that's an issue.

- Dave

--
To unsubscribe from this list: send the line "unsubscribe linux-omap" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Liam Girdwood Feb. 26, 2009, 9:58 p.m. UTC | #1

On Thu, 2009-02-26 at 13:28 -0800, David Brownell wrote:
> On Thursday 26 February 2009, Liam Girdwood wrote:
> > Applied with git-am merge conflicts. It builds ok, can you check against
> > your tree.
> 
> What were the conflicts -- just offsets?
> 
> Your "-next" regulator tree seems to be missing a doc patch
> you had asked for, maybe that's an issue.
> 
> - Dave
> 
> =========== CUT HERE
> From: David Brownell <[e-mail]>
> 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 <[e-mail]>
> ---
>  include/linux/regulator/driver.h |   22 ++++++++++------------
>  1 file changed, 10 insertions(+), 12 deletions(-)

Thanks.

Fixed.

Liam

--
To unsubscribe from this list: send the line "unsubscribe linux-omap" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

David Brownell Feb. 27, 2009, 12:10 a.m. UTC | #2

On Thursday 26 February 2009, Liam Girdwood wrote:
> 
> > What were the conflicts -- just offsets?
> > 
> > Your "-next" regulator tree seems to be missing a doc patch
> > you had asked for, maybe that's an issue.

And you seem to only have merged the header part of
the $SUBJECT patch, not the core.c parts ...

Everything gets kind of broken without the core.c
change!

- Dave


--
To unsubscribe from this list: send the line "unsubscribe linux-omap" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

=========== CUT HERE
From: David Brownell <[e-mail]>
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 <[e-mail]>
---
 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 *);