public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: "Andrew F. Davis" <afd@ti.com>
To: "Pali Rohár" <pali.rohar@gmail.com>,
	"Sebastian Reichel" <sre@kernel.org>,
	"Dmitry Eremin-Solenikov" <dbaryshkov@gmail.com>,
	"David Woodhouse" <dwmw2@infradead.org>
Cc: Dan Murphy <dmurphy@ti.com>, <linux-pm@vger.kernel.org>,
	<linux-kernel@vger.kernel.org>, "Andrew F. Davis" <afd@ti.com>
Subject: [PATCH v4 4/7] power: bq27xxx_battery: Fix typos and change naming for state of charge functions
Date: Mon, 14 Sep 2015 16:26:10 -0500	[thread overview]
Message-ID: <1442265973-32261-5-git-send-email-afd@ti.com> (raw)
In-Reply-To: <1442265973-32261-1-git-send-email-afd@ti.com>

Fix typos and change "relative state of charge" to "state of charge" as not
all supported devices use relative state of charge.

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 drivers/power/bq27xxx_battery.c | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/drivers/power/bq27xxx_battery.c b/drivers/power/bq27xxx_battery.c
index 0734413..1ff88ad 100644
--- a/drivers/power/bq27xxx_battery.c
+++ b/drivers/power/bq27xxx_battery.c
@@ -229,26 +229,26 @@ static bool bq27xxx_is_chip_version_higher(struct bq27xxx_device_info *di)
 }
 
 /*
- * Return the battery Relative State-of-Charge
+ * Return the battery State-of-Charge
  * Or < 0 if something fails.
  */
-static int bq27xxx_battery_read_rsoc(struct bq27xxx_device_info *di)
+static int bq27xxx_battery_read_soc(struct bq27xxx_device_info *di)
 {
-	int rsoc;
+	int soc;
 
 	if (di->chip == BQ27500 || di->chip == BQ27742)
-		rsoc = bq27xxx_read(di, BQ27500_REG_SOC, false);
+		soc = bq27xxx_read(di, BQ27500_REG_SOC, false);
 	else if (di->chip == BQ27510)
-		rsoc = bq27xxx_read(di, BQ27510_REG_SOC, false);
+		soc = bq27xxx_read(di, BQ27510_REG_SOC, false);
 	else if (di->chip == BQ27425)
-		rsoc = bq27xxx_read(di, BQ27425_REG_SOC, false);
-	else
-		rsoc = bq27xxx_read(di, BQ27000_REG_RSOC, true);
+		soc = bq27xxx_read(di, BQ27425_REG_SOC, false);
+	else /* for the bq27000 we read the "relative" SoC register */
+		soc = bq27xxx_read(di, BQ27000_REG_RSOC, true);
 
-	if (rsoc < 0)
-		dev_dbg(di->dev, "error reading relative State-of-Charge\n");
+	if (soc < 0)
+		dev_dbg(di->dev, "error reading State-of-Charge\n");
 
-	return rsoc;
+	return soc;
 }
 
 /*
@@ -275,7 +275,7 @@ static int bq27xxx_battery_read_charge(struct bq27xxx_device_info *di, u8 reg)
 }
 
 /*
- * Return the battery Nominal available capaciy in µAh
+ * Return the battery Nominal available capacity in µAh
  * Or < 0 if something fails.
  */
 static inline int bq27xxx_battery_read_nac(struct bq27xxx_device_info *di)
@@ -416,7 +416,7 @@ static int bq27xxx_battery_read_time(struct bq27xxx_device_info *di, u8 reg)
 }
 
 /*
- * Read a power avg register.
+ * Read an average power register.
  * Return < 0 if something fails.
  */
 static int bq27xxx_battery_read_pwr_avg(struct bq27xxx_device_info *di, u8 reg)
@@ -498,7 +498,7 @@ static void bq27xxx_battery_update(struct bq27xxx_device_info *di)
 			cache.charge_full = -ENODATA;
 			cache.health = -ENODATA;
 		} else {
-			cache.capacity = bq27xxx_battery_read_rsoc(di);
+			cache.capacity = bq27xxx_battery_read_soc(di);
 			if (is_bq27742 || is_bq27510)
 				cache.time_to_empty =
 					bq27xxx_battery_read_time(di,
-- 
1.9.1


  parent reply	other threads:[~2015-09-14 21:26 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-09-14 21:26 [PATCH v4 0/7] Add support for additional bq27xxx devices Andrew F. Davis
2015-09-14 21:26 ` [PATCH v4 1/7] power: bq27x00_battery: Remove unneeded i2c MODULE_ALIAS Andrew F. Davis
2015-09-21  8:33   ` Pali Rohár
2015-09-22 15:18   ` Sebastian Reichel
2015-09-14 21:26 ` [PATCH v4 2/7] power: bq27x00_battery: Renaming for consistency Andrew F. Davis
2015-09-15  8:32   ` Laurentiu Palcu
2015-09-15 16:53     ` Andrew F. Davis
2015-09-22 16:10   ` Sebastian Reichel
2015-09-14 21:26 ` [PATCH v4 3/7] power: bq27xxx_battery: Platform initialization must declare a device Andrew F. Davis
2015-09-21  8:41   ` Pali Rohár
2015-09-21 18:40     ` Andrew F. Davis
2015-09-14 21:26 ` Andrew F. Davis [this message]
2015-09-21  8:36   ` [PATCH v4 4/7] power: bq27xxx_battery: Fix typos and change naming for state of charge functions Pali Rohár
2015-09-14 21:26 ` [PATCH v4 5/7] power: bq27xxx_battery: Add support for additional bq27xxx family devices Andrew F. Davis
2015-09-21  8:46   ` Pali Rohár
2015-09-21 19:02     ` Andrew F. Davis
2015-09-14 21:26 ` [PATCH v4 6/7] power: bq27xxx_battery: Cleanup health checking Andrew F. Davis
2015-09-21  8:35   ` Pali Rohár
2015-09-14 21:26 ` [PATCH v4 7/7] power: bq27xxx_battery: Add interrupt handling support Andrew F. Davis
2015-09-15 18:47   ` Andreas Dannenberg
2015-09-15 20:53     ` Andrew F. Davis

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1442265973-32261-5-git-send-email-afd@ti.com \
    --to=afd@ti.com \
    --cc=dbaryshkov@gmail.com \
    --cc=dmurphy@ti.com \
    --cc=dwmw2@infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=pali.rohar@gmail.com \
    --cc=sre@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox