projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'please-pull-fixmcelog' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-block.git] / drivers / power / sbs-battery.c
CommitLineData
a7640bfa 1/*
3ddca062 2 * Gas Gauge driver for SBS Compliant Batteries
a7640bfa
RK		 3 *
4 * Copyright (c) 2010, NVIDIA Corporation.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 */
20
21#include <linux/init.h>
22#include <linux/module.h>
23#include <linux/kernel.h>
24#include <linux/err.h>
25#include <linux/power_supply.h>
26#include <linux/i2c.h>
27#include <linux/slab.h>
bb879101
RK		 28#include <linux/interrupt.h>
29#include <linux/gpio.h>
075ed03c 30#include <linux/of.h>
bb879101 31
3ddca062 32#include <linux/power/sbs-battery.h>
a7640bfa
RK		 33
34enum {
35 REG_MANUFACTURER_DATA,
36 REG_TEMPERATURE,
37 REG_VOLTAGE,
38 REG_CURRENT,
39 REG_CAPACITY,
40 REG_TIME_TO_EMPTY,
41 REG_TIME_TO_FULL,
42 REG_STATUS,
43 REG_CYCLE_COUNT,
d3ab61ec
RK		 44 REG_SERIAL_NUMBER,
45 REG_REMAINING_CAPACITY,
51d07566 46 REG_REMAINING_CAPACITY_CHARGE,
d3ab61ec 47 REG_FULL_CHARGE_CAPACITY,
51d07566 48 REG_FULL_CHARGE_CAPACITY_CHARGE,
d3ab61ec 49 REG_DESIGN_CAPACITY,
51d07566 50 REG_DESIGN_CAPACITY_CHARGE,
4495b0ad
SQ		 51 REG_DESIGN_VOLTAGE_MIN,
52 REG_DESIGN_VOLTAGE_MAX,
9ea89402
CYC		 53 REG_MANUFACTURER,
54 REG_MODEL_NAME,
a7640bfa
RK		 55};
56
51d07566
RK		 57/* Battery Mode defines */
58#define BATTERY_MODE_OFFSET 0x03
59#define BATTERY_MODE_MASK 0x8000
3ddca062 60enum sbs_battery_mode {
51d07566
RK		 61 BATTERY_MODE_AMPS,
62 BATTERY_MODE_WATTS
63};
64
a7640bfa
RK		 65/* manufacturer access defines */
66#define MANUFACTURER_ACCESS_STATUS 0x0006
67#define MANUFACTURER_ACCESS_SLEEP 0x0011
68
69/* battery status value bits */
d3ab61ec 70#define BATTERY_DISCHARGING 0x40
a7640bfa
RK		 71#define BATTERY_FULL_CHARGED 0x20
72#define BATTERY_FULL_DISCHARGED 0x10
73
9ea89402 74/* min_value and max_value are only valid for numerical data */
3ddca062 75#define SBS_DATA(_psp, _addr, _min_value, _max_value) { \
a7640bfa
RK		 76 .psp = _psp, \
77 .addr = _addr, \
78 .min_value = _min_value, \
79 .max_value = _max_value, \
80}
81
3ddca062 82static const struct chip_data {
a7640bfa
RK		 83 enum power_supply_property psp;
84 u8 addr;
85 int min_value;
86 int max_value;
3ddca062 87} sbs_data[] = {
a7640bfa 88 [REG_MANUFACTURER_DATA] =
3ddca062 89 SBS_DATA(POWER_SUPPLY_PROP_PRESENT, 0x00, 0, 65535),
a7640bfa 90 [REG_TEMPERATURE] =
3ddca062 91 SBS_DATA(POWER_SUPPLY_PROP_TEMP, 0x08, 0, 65535),
a7640bfa 92 [REG_VOLTAGE] =
3ddca062 93 SBS_DATA(POWER_SUPPLY_PROP_VOLTAGE_NOW, 0x09, 0, 20000),
a7640bfa 94 [REG_CURRENT] =
3ddca062 95 SBS_DATA(POWER_SUPPLY_PROP_CURRENT_NOW, 0x0A, -32768, 32767),
a7640bfa 96 [REG_CAPACITY] =
b1f092f6 97 SBS_DATA(POWER_SUPPLY_PROP_CAPACITY, 0x0D, 0, 100),
d3ab61ec 98 [REG_REMAINING_CAPACITY] =
3ddca062 99 SBS_DATA(POWER_SUPPLY_PROP_ENERGY_NOW, 0x0F, 0, 65535),
51d07566 100 [REG_REMAINING_CAPACITY_CHARGE] =
3ddca062 101 SBS_DATA(POWER_SUPPLY_PROP_CHARGE_NOW, 0x0F, 0, 65535),
d3ab61ec 102 [REG_FULL_CHARGE_CAPACITY] =
3ddca062 103 SBS_DATA(POWER_SUPPLY_PROP_ENERGY_FULL, 0x10, 0, 65535),
51d07566 104 [REG_FULL_CHARGE_CAPACITY_CHARGE] =
3ddca062 105 SBS_DATA(POWER_SUPPLY_PROP_CHARGE_FULL, 0x10, 0, 65535),
a7640bfa 106 [REG_TIME_TO_EMPTY] =
3ddca062 107 SBS_DATA(POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG, 0x12, 0, 65535),
a7640bfa 108 [REG_TIME_TO_FULL] =
3ddca062 109 SBS_DATA(POWER_SUPPLY_PROP_TIME_TO_FULL_AVG, 0x13, 0, 65535),
a7640bfa 110 [REG_STATUS] =
3ddca062 111 SBS_DATA(POWER_SUPPLY_PROP_STATUS, 0x16, 0, 65535),
a7640bfa 112 [REG_CYCLE_COUNT] =
3ddca062 113 SBS_DATA(POWER_SUPPLY_PROP_CYCLE_COUNT, 0x17, 0, 65535),
d3ab61ec 114 [REG_DESIGN_CAPACITY] =
3ddca062 115 SBS_DATA(POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN, 0x18, 0, 65535),
51d07566 116 [REG_DESIGN_CAPACITY_CHARGE] =
3ddca062 117 SBS_DATA(POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN, 0x18, 0, 65535),
4495b0ad
SQ		 118 [REG_DESIGN_VOLTAGE_MIN] =
119 SBS_DATA(POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN, 0x19, 0, 65535),
120 [REG_DESIGN_VOLTAGE_MAX] =
3ddca062 121 SBS_DATA(POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN, 0x19, 0, 65535),
a7640bfa 122 [REG_SERIAL_NUMBER] =
3ddca062 123 SBS_DATA(POWER_SUPPLY_PROP_SERIAL_NUMBER, 0x1C, 0, 65535),
9ea89402
CYC		 124 /* Properties of type `const char *' */
125 [REG_MANUFACTURER] =
126 SBS_DATA(POWER_SUPPLY_PROP_MANUFACTURER, 0x20, 0, 65535),
127 [REG_MODEL_NAME] =
128 SBS_DATA(POWER_SUPPLY_PROP_MODEL_NAME, 0x21, 0, 65535)
a7640bfa
RK		 129};
130
3ddca062 131static enum power_supply_property sbs_properties[] = {
a7640bfa
RK		 132 POWER_SUPPLY_PROP_STATUS,
133 POWER_SUPPLY_PROP_HEALTH,
134 POWER_SUPPLY_PROP_PRESENT,
135 POWER_SUPPLY_PROP_TECHNOLOGY,
136 POWER_SUPPLY_PROP_CYCLE_COUNT,
137 POWER_SUPPLY_PROP_VOLTAGE_NOW,
138 POWER_SUPPLY_PROP_CURRENT_NOW,
139 POWER_SUPPLY_PROP_CAPACITY,
140 POWER_SUPPLY_PROP_TEMP,
141 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
142 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
143 POWER_SUPPLY_PROP_SERIAL_NUMBER,
4495b0ad 144 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
d3ab61ec
RK		 145 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
146 POWER_SUPPLY_PROP_ENERGY_NOW,
147 POWER_SUPPLY_PROP_ENERGY_FULL,
148 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
51d07566
RK		 149 POWER_SUPPLY_PROP_CHARGE_NOW,
150 POWER_SUPPLY_PROP_CHARGE_FULL,
151 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
9ea89402
CYC		 152 /* Properties of type `const char *' */
153 POWER_SUPPLY_PROP_MANUFACTURER,
154 POWER_SUPPLY_PROP_MODEL_NAME
a7640bfa
RK		 155};
156
3ddca062 157struct sbs_info {
bb879101
RK		 158 struct i2c_client *client;
159 struct power_supply power_supply;
3ddca062 160 struct sbs_platform_data *pdata;
bb879101
RK		 161 bool is_present;
162 bool gpio_detect;
163 bool enable_detection;
164 int irq;
58ddafae
RK		 165 int last_state;
166 int poll_time;
167 struct delayed_work work;
168 int ignore_changes;
a7640bfa
RK		 169};
170
9ea89402
CYC		 171static char model_name[I2C_SMBUS_BLOCK_MAX + 1];
172static char manufacturer[I2C_SMBUS_BLOCK_MAX + 1];
173
3ddca062 174static int sbs_read_word_data(struct i2c_client *client, u8 address)
d3ab61ec 175{
3ddca062 176 struct sbs_info *chip = i2c_get_clientdata(client);
ff28fcef
RK		 177 s32 ret = 0;
178 int retries = 1;
179
3ddca062
RK		 180 if (chip->pdata)
181 retries = max(chip->pdata->i2c_retry_count + 1, 1);
ff28fcef
RK		 182
183 while (retries > 0) {
184 ret = i2c_smbus_read_word_data(client, address);
185 if (ret >= 0)
186 break;
187 retries--;
188 }
d3ab61ec 189
d3ab61ec 190 if (ret < 0) {
a7d9ace4 191 dev_dbg(&client->dev,
d3ab61ec
RK		 192 "%s: i2c read at address 0x%x failed\n",
193 __func__, address);
194 return ret;
195 }
ff28fcef 196
d3ab61ec
RK		 197 return le16_to_cpu(ret);
198}
199
9ea89402
CYC		 200static int sbs_read_string_data(struct i2c_client *client, u8 address,
201 char *values)
202{
203 struct sbs_info *chip = i2c_get_clientdata(client);
204 s32 ret = 0, block_length = 0;
205 int retries_length = 1, retries_block = 1;
206 u8 block_buffer[I2C_SMBUS_BLOCK_MAX + 1];
207
208 if (chip->pdata) {
209 retries_length = max(chip->pdata->i2c_retry_count + 1, 1);
210 retries_block = max(chip->pdata->i2c_retry_count + 1, 1);
211 }
212
213 /* Adapter needs to support these two functions */
214 if (!i2c_check_functionality(client->adapter,
215 I2C_FUNC_SMBUS_BYTE_DATA |
216 I2C_FUNC_SMBUS_I2C_BLOCK)){
217 return -ENODEV;
218 }
219
220 /* Get the length of block data */
221 while (retries_length > 0) {
222 ret = i2c_smbus_read_byte_data(client, address);
223 if (ret >= 0)
224 break;
225 retries_length--;
226 }
227
228 if (ret < 0) {
229 dev_dbg(&client->dev,
230 "%s: i2c read at address 0x%x failed\n",
231 __func__, address);
232 return ret;
233 }
234
235 /* block_length does not include NULL terminator */
236 block_length = ret;
237 if (block_length > I2C_SMBUS_BLOCK_MAX) {
238 dev_err(&client->dev,
239 "%s: Returned block_length is longer than 0x%x\n",
240 __func__, I2C_SMBUS_BLOCK_MAX);
241 return -EINVAL;
242 }
243
244 /* Get the block data */
245 while (retries_block > 0) {
246 ret = i2c_smbus_read_i2c_block_data(
247 client, address,
248 block_length + 1, block_buffer);
249 if (ret >= 0)
250 break;
251 retries_block--;
252 }
253
254 if (ret < 0) {
255 dev_dbg(&client->dev,
256 "%s: i2c read at address 0x%x failed\n",
257 __func__, address);
258 return ret;
259 }
260
261 /* block_buffer[0] == block_length */
262 memcpy(values, block_buffer + 1, block_length);
263 values[block_length] = '\0';
264
265 return le16_to_cpu(ret);
266}
267
3ddca062 268static int sbs_write_word_data(struct i2c_client *client, u8 address,
d3ab61ec
RK		 269 u16 value)
270{
3ddca062 271 struct sbs_info *chip = i2c_get_clientdata(client);
ff28fcef
RK		 272 s32 ret = 0;
273 int retries = 1;
274
3ddca062
RK		 275 if (chip->pdata)
276 retries = max(chip->pdata->i2c_retry_count + 1, 1);
ff28fcef
RK		 277
278 while (retries > 0) {
279 ret = i2c_smbus_write_word_data(client, address,
280 le16_to_cpu(value));
281 if (ret >= 0)
282 break;
283 retries--;
284 }
d3ab61ec 285
d3ab61ec 286 if (ret < 0) {
a7d9ace4 287 dev_dbg(&client->dev,
d3ab61ec
RK		 288 "%s: i2c write to address 0x%x failed\n",
289 __func__, address);
290 return ret;
291 }
ff28fcef 292
d3ab61ec
RK		 293 return 0;
294}
295
3ddca062 296static int sbs_get_battery_presence_and_health(
a7640bfa
RK		 297 struct i2c_client *client, enum power_supply_property psp,
298 union power_supply_propval *val)
299{
300 s32 ret;
3ddca062 301 struct sbs_info *chip = i2c_get_clientdata(client);
bb879101
RK		 302
303 if (psp == POWER_SUPPLY_PROP_PRESENT &&
3ddca062
RK		 304 chip->gpio_detect) {
305 ret = gpio_get_value(chip->pdata->battery_detect);
306 if (ret == chip->pdata->battery_detect_present)
bb879101
RK		 307 val->intval = 1;
308 else
309 val->intval = 0;
3ddca062 310 chip->is_present = val->intval;
bb879101
RK		 311 return ret;
312 }
a7640bfa
RK		 313
314 /* Write to ManufacturerAccess with
315 * ManufacturerAccess command and then
316 * read the status */
3ddca062
RK		 317 ret = sbs_write_word_data(client, sbs_data[REG_MANUFACTURER_DATA].addr,
318 MANUFACTURER_ACCESS_STATUS);
bb879101
RK		 319 if (ret < 0) {
320 if (psp == POWER_SUPPLY_PROP_PRESENT)
321 val->intval = 0; /* battery removed */
d3ab61ec 322 return ret;
bb879101 323 }
a7640bfa 324
3ddca062 325 ret = sbs_read_word_data(client, sbs_data[REG_MANUFACTURER_DATA].addr);
a7d9ace4
RK		 326 if (ret < 0)
327 return ret;
328
3ddca062
RK		 329 if (ret < sbs_data[REG_MANUFACTURER_DATA].min_value ||
330 ret > sbs_data[REG_MANUFACTURER_DATA].max_value) {
a7640bfa
RK		 331 val->intval = 0;
332 return 0;
333 }
334
335 /* Mask the upper nibble of 2nd byte and
336 * lower byte of response then
337 * shift the result by 8 to get status*/
338 ret &= 0x0F00;
339 ret >>= 8;
340 if (psp == POWER_SUPPLY_PROP_PRESENT) {
341 if (ret == 0x0F)
342 /* battery removed */
343 val->intval = 0;
344 else
345 val->intval = 1;
346 } else if (psp == POWER_SUPPLY_PROP_HEALTH) {
347 if (ret == 0x09)
348 val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE;
349 else if (ret == 0x0B)
350 val->intval = POWER_SUPPLY_HEALTH_OVERHEAT;
351 else if (ret == 0x0C)
352 val->intval = POWER_SUPPLY_HEALTH_DEAD;
353 else
354 val->intval = POWER_SUPPLY_HEALTH_GOOD;
355 }
356
357 return 0;
358}
359
3ddca062 360static int sbs_get_battery_property(struct i2c_client *client,
a7640bfa
RK		 361 int reg_offset, enum power_supply_property psp,
362 union power_supply_propval *val)
363{
3ddca062 364 struct sbs_info *chip = i2c_get_clientdata(client);
a7640bfa
RK		 365 s32 ret;
366
3ddca062 367 ret = sbs_read_word_data(client, sbs_data[reg_offset].addr);
d3ab61ec
RK		 368 if (ret < 0)
369 return ret;
370
371 /* returned values are 16 bit */
3ddca062 372 if (sbs_data[reg_offset].min_value < 0)
d3ab61ec 373 ret = (s16)ret;
a7640bfa 374
3ddca062
RK		 375 if (ret >= sbs_data[reg_offset].min_value &&
376 ret <= sbs_data[reg_offset].max_value) {
a7640bfa 377 val->intval = ret;
58ddafae
RK		 378 if (psp != POWER_SUPPLY_PROP_STATUS)
379 return 0;
380
381 if (ret & BATTERY_FULL_CHARGED)
382 val->intval = POWER_SUPPLY_STATUS_FULL;
383 else if (ret & BATTERY_FULL_DISCHARGED)
384 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
385 else if (ret & BATTERY_DISCHARGING)
386 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
387 else
388 val->intval = POWER_SUPPLY_STATUS_CHARGING;
389
3ddca062
RK		 390 if (chip->poll_time == 0)
391 chip->last_state = val->intval;
392 else if (chip->last_state != val->intval) {
393 cancel_delayed_work_sync(&chip->work);
394 power_supply_changed(&chip->power_supply);
395 chip->poll_time = 0;
a7640bfa 396 }
a7640bfa
RK		 397 } else {
398 if (psp == POWER_SUPPLY_PROP_STATUS)
399 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
400 else
401 val->intval = 0;
402 }
403
404 return 0;
405}
406
9ea89402
CYC		 407static int sbs_get_battery_string_property(struct i2c_client *client,
408 int reg_offset, enum power_supply_property psp, char *val)
409{
410 s32 ret;
411
412 ret = sbs_read_string_data(client, sbs_data[reg_offset].addr, val);
413
414 if (ret < 0)
415 return ret;
416
417 return 0;
418}
419
3ddca062 420static void sbs_unit_adjustment(struct i2c_client *client,
d3ab61ec
RK		 421 enum power_supply_property psp, union power_supply_propval *val)
422{
423#define BASE_UNIT_CONVERSION 1000
424#define BATTERY_MODE_CAP_MULT_WATT (10 * BASE_UNIT_CONVERSION)
909a78b3
BL		 425#define TIME_UNIT_CONVERSION 60
426#define TEMP_KELVIN_TO_CELSIUS 2731
d3ab61ec
RK		 427 switch (psp) {
428 case POWER_SUPPLY_PROP_ENERGY_NOW:
429 case POWER_SUPPLY_PROP_ENERGY_FULL:
430 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
3ddca062 431 /* sbs provides energy in units of 10mWh.
909a78b3
BL		 432 * Convert to µWh
433 */
d3ab61ec
RK		 434 val->intval *= BATTERY_MODE_CAP_MULT_WATT;
435 break;
436
437 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
4495b0ad 438 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
d3ab61ec
RK		 439 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
440 case POWER_SUPPLY_PROP_CURRENT_NOW:
51d07566
RK		 441 case POWER_SUPPLY_PROP_CHARGE_NOW:
442 case POWER_SUPPLY_PROP_CHARGE_FULL:
443 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
d3ab61ec
RK		 444 val->intval *= BASE_UNIT_CONVERSION;
445 break;
446
447 case POWER_SUPPLY_PROP_TEMP:
3ddca062 448 /* sbs provides battery temperature in 0.1K
909a78b3
BL		 449 * so convert it to 0.1°C
450 */
451 val->intval -= TEMP_KELVIN_TO_CELSIUS;
d3ab61ec
RK		 452 break;
453
454 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG:
455 case POWER_SUPPLY_PROP_TIME_TO_FULL_AVG:
3ddca062 456 /* sbs provides time to empty and time to full in minutes.
909a78b3
BL		 457 * Convert to seconds
458 */
d3ab61ec
RK		 459 val->intval *= TIME_UNIT_CONVERSION;
460 break;
461
462 default:
463 dev_dbg(&client->dev,
464 "%s: no need for unit conversion %d\n", __func__, psp);
465 }
466}
467
3ddca062
RK		 468static enum sbs_battery_mode sbs_set_battery_mode(struct i2c_client *client,
469 enum sbs_battery_mode mode)
51d07566
RK		 470{
471 int ret, original_val;
472
3ddca062 473 original_val = sbs_read_word_data(client, BATTERY_MODE_OFFSET);
51d07566
RK		 474 if (original_val < 0)
475 return original_val;
476
477 if ((original_val & BATTERY_MODE_MASK) == mode)
478 return mode;
479
480 if (mode == BATTERY_MODE_AMPS)
481 ret = original_val & ~BATTERY_MODE_MASK;
482 else
483 ret = original_val | BATTERY_MODE_MASK;
484
3ddca062 485 ret = sbs_write_word_data(client, BATTERY_MODE_OFFSET, ret);
51d07566
RK		 486 if (ret < 0)
487 return ret;
488
489 return original_val & BATTERY_MODE_MASK;
490}
491
3ddca062 492static int sbs_get_battery_capacity(struct i2c_client *client,
d3ab61ec 493 int reg_offset, enum power_supply_property psp,
a7640bfa
RK		 494 union power_supply_propval *val)
495{
496 s32 ret;
3ddca062 497 enum sbs_battery_mode mode = BATTERY_MODE_WATTS;
51d07566
RK		 498
499 if (power_supply_is_amp_property(psp))
500 mode = BATTERY_MODE_AMPS;
501
3ddca062 502 mode = sbs_set_battery_mode(client, mode);
51d07566
RK		 503 if (mode < 0)
504 return mode;
a7640bfa 505
3ddca062 506 ret = sbs_read_word_data(client, sbs_data[reg_offset].addr);
d3ab61ec
RK		 507 if (ret < 0)
508 return ret;
a7640bfa 509
d3ab61ec 510 if (psp == POWER_SUPPLY_PROP_CAPACITY) {
3ddca062 511 /* sbs spec says that this can be >100 %
d3ab61ec
RK		 512 * even if max value is 100 % */
513 val->intval = min(ret, 100);
514 } else
515 val->intval = ret;
516
3ddca062 517 ret = sbs_set_battery_mode(client, mode);
51d07566
RK		 518 if (ret < 0)
519 return ret;
520
d3ab61ec
RK		 521 return 0;
522}
523
3ddca062
RK		 524static char sbs_serial[5];
525static int sbs_get_battery_serial_number(struct i2c_client *client,
d3ab61ec
RK		 526 union power_supply_propval *val)
527{
528 int ret;
529
3ddca062 530 ret = sbs_read_word_data(client, sbs_data[REG_SERIAL_NUMBER].addr);
d3ab61ec
RK		 531 if (ret < 0)
532 return ret;
533
3ddca062
RK		 534 ret = sprintf(sbs_serial, "%04x", ret);
535 val->strval = sbs_serial;
a7640bfa
RK		 536
537 return 0;
538}
539
3ddca062 540static int sbs_get_property_index(struct i2c_client *client,
51d07566
RK		 541 enum power_supply_property psp)
542{
543 int count;
3ddca062
RK		 544 for (count = 0; count < ARRAY_SIZE(sbs_data); count++)
545 if (psp == sbs_data[count].psp)
51d07566
RK		 546 return count;
547
548 dev_warn(&client->dev,
549 "%s: Invalid Property - %d\n", __func__, psp);
550
551 return -EINVAL;
552}
553
3ddca062 554static int sbs_get_property(struct power_supply *psy,
a7640bfa
RK		 555 enum power_supply_property psp,
556 union power_supply_propval *val)
557{
bb879101 558 int ret = 0;
3ddca062
RK		 559 struct sbs_info *chip = container_of(psy,
560 struct sbs_info, power_supply);
561 struct i2c_client *client = chip->client;
a7640bfa
RK		 562
563 switch (psp) {
564 case POWER_SUPPLY_PROP_PRESENT:
565 case POWER_SUPPLY_PROP_HEALTH:
3ddca062 566 ret = sbs_get_battery_presence_and_health(client, psp, val);
a7d9ace4
RK		 567 if (psp == POWER_SUPPLY_PROP_PRESENT)
568 return 0;
a7640bfa
RK		 569 break;
570
571 case POWER_SUPPLY_PROP_TECHNOLOGY:
572 val->intval = POWER_SUPPLY_TECHNOLOGY_LION;
5da50988 573 goto done; /* don't trigger power_supply_changed()! */
a7640bfa 574
d3ab61ec
RK		 575 case POWER_SUPPLY_PROP_ENERGY_NOW:
576 case POWER_SUPPLY_PROP_ENERGY_FULL:
577 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
51d07566
RK		 578 case POWER_SUPPLY_PROP_CHARGE_NOW:
579 case POWER_SUPPLY_PROP_CHARGE_FULL:
580 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
a7640bfa 581 case POWER_SUPPLY_PROP_CAPACITY:
3ddca062 582 ret = sbs_get_property_index(client, psp);
bb879101
RK		 583 if (ret < 0)
584 break;
d3ab61ec 585
3ddca062 586 ret = sbs_get_battery_capacity(client, ret, psp, val);
d3ab61ec
RK		 587 break;
588
589 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
3ddca062 590 ret = sbs_get_battery_serial_number(client, val);
a7640bfa
RK		 591 break;
592
593 case POWER_SUPPLY_PROP_STATUS:
594 case POWER_SUPPLY_PROP_CYCLE_COUNT:
595 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
596 case POWER_SUPPLY_PROP_CURRENT_NOW:
597 case POWER_SUPPLY_PROP_TEMP:
598 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG:
599 case POWER_SUPPLY_PROP_TIME_TO_FULL_AVG:
4495b0ad 600 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
d3ab61ec 601 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
3ddca062 602 ret = sbs_get_property_index(client, psp);
bb879101
RK		 603 if (ret < 0)
604 break;
d3ab61ec 605
3ddca062 606 ret = sbs_get_battery_property(client, ret, psp, val);
a7640bfa
RK		 607 break;
608
9ea89402
CYC		 609 case POWER_SUPPLY_PROP_MODEL_NAME:
610 ret = sbs_get_property_index(client, psp);
611 if (ret < 0)
612 break;
613
614 ret = sbs_get_battery_string_property(client, ret, psp,
615 model_name);
616 val->strval = model_name;
617 break;
618
619 case POWER_SUPPLY_PROP_MANUFACTURER:
620 ret = sbs_get_property_index(client, psp);
621 if (ret < 0)
622 break;
623
624 ret = sbs_get_battery_string_property(client, ret, psp,
625 manufacturer);
626 val->strval = manufacturer;
627 break;
628
a7640bfa
RK		 629 default:
630 dev_err(&client->dev,
631 "%s: INVALID property\n", __func__);
632 return -EINVAL;
633 }
634
3ddca062 635 if (!chip->enable_detection)
bb879101
RK		 636 goto done;
637
3ddca062
RK		 638 if (!chip->gpio_detect &&
639 chip->is_present != (ret >= 0)) {
640 chip->is_present = (ret >= 0);
641 power_supply_changed(&chip->power_supply);
bb879101
RK		 642 }
643
644done:
645 if (!ret) {
646 /* Convert units to match requirements for power supply class */
3ddca062 647 sbs_unit_adjustment(client, psp, val);
bb879101 648 }
d3ab61ec 649
a7640bfa 650 dev_dbg(&client->dev,
a7d9ace4
RK		 651 "%s: property = %d, value = %x\n", __func__, psp, val->intval);
652
3ddca062 653 if (ret && chip->is_present)
a7d9ace4
RK		 654 return ret;
655
656 /* battery not present, so return NODATA for properties */
657 if (ret)
658 return -ENODATA;
a7640bfa 659
a7d9ace4 660 return 0;
a7640bfa
RK		 661}
662
3ddca062 663static irqreturn_t sbs_irq(int irq, void *devid)
bb879101
RK		 664{
665 struct power_supply *battery = devid;
666
667 power_supply_changed(battery);
668
669 return IRQ_HANDLED;
670}
671
3ddca062 672static void sbs_external_power_changed(struct power_supply *psy)
58ddafae 673{
3ddca062 674 struct sbs_info *chip;
58ddafae 675
3ddca062 676 chip = container_of(psy, struct sbs_info, power_supply);
58ddafae 677
3ddca062
RK		 678 if (chip->ignore_changes > 0) {
679 chip->ignore_changes--;
58ddafae
RK		 680 return;
681 }
682
683 /* cancel outstanding work */
3ddca062 684 cancel_delayed_work_sync(&chip->work);
58ddafae 685
3ddca062
RK		 686 schedule_delayed_work(&chip->work, HZ);
687 chip->poll_time = chip->pdata->poll_retry_count;
58ddafae
RK		 688}
689
3ddca062 690static void sbs_delayed_work(struct work_struct *work)
58ddafae 691{
3ddca062 692 struct sbs_info *chip;
58ddafae
RK		 693 s32 ret;
694
3ddca062 695 chip = container_of(work, struct sbs_info, work.work);
58ddafae 696
3ddca062 697 ret = sbs_read_word_data(chip->client, sbs_data[REG_STATUS].addr);
58ddafae
RK		 698 /* if the read failed, give up on this work */
699 if (ret < 0) {
3ddca062 700 chip->poll_time = 0;
58ddafae
RK		 701 return;
702 }
703
704 if (ret & BATTERY_FULL_CHARGED)
705 ret = POWER_SUPPLY_STATUS_FULL;
706 else if (ret & BATTERY_FULL_DISCHARGED)
707 ret = POWER_SUPPLY_STATUS_NOT_CHARGING;
708 else if (ret & BATTERY_DISCHARGING)
709 ret = POWER_SUPPLY_STATUS_DISCHARGING;
710 else
711 ret = POWER_SUPPLY_STATUS_CHARGING;
712
3ddca062
RK		 713 if (chip->last_state != ret) {
714 chip->poll_time = 0;
715 power_supply_changed(&chip->power_supply);
58ddafae
RK		 716 return;
717 }
3ddca062
RK		 718 if (chip->poll_time > 0) {
719 schedule_delayed_work(&chip->work, HZ);
720 chip->poll_time--;
58ddafae
RK		 721 return;
722 }
723}
724
6c75ea1e
RK		 725#if defined(CONFIG_OF)
726
727#include <linux/of_device.h>
728#include <linux/of_gpio.h>
729
3ddca062
RK		 730static const struct of_device_id sbs_dt_ids[] = {
731 { .compatible = "sbs,sbs-battery" },
6c75ea1e
RK		 732 { .compatible = "ti,bq20z75" },
733 { }
734};
62df3935 735MODULE_DEVICE_TABLE(of, sbs_dt_ids);
6c75ea1e 736
3ddca062 737static struct sbs_platform_data *sbs_of_populate_pdata(
6c75ea1e
RK		 738 struct i2c_client *client)
739{
740 struct device_node *of_node = client->dev.of_node;
3ddca062 741 struct sbs_platform_data *pdata = client->dev.platform_data;
6c75ea1e
RK		 742 enum of_gpio_flags gpio_flags;
743 int rc;
744 u32 prop;
745
746 /* verify this driver matches this device */
747 if (!of_node)
748 return NULL;
749
750 /* if platform data is set, honor it */
751 if (pdata)
752 return pdata;
753
754 /* first make sure at least one property is set, otherwise
755 * it won't change behavior from running without pdata.
756 */
3ddca062
RK		 757 if (!of_get_property(of_node, "sbs,i2c-retry-count", NULL) &&
758 !of_get_property(of_node, "sbs,poll-retry-count", NULL) &&
759 !of_get_property(of_node, "sbs,battery-detect-gpios", NULL))
6c75ea1e
RK		 760 goto of_out;
761
3ddca062 762 pdata = devm_kzalloc(&client->dev, sizeof(struct sbs_platform_data),
6c75ea1e
RK		 763 GFP_KERNEL);
764 if (!pdata)
765 goto of_out;
766
3ddca062 767 rc = of_property_read_u32(of_node, "sbs,i2c-retry-count", &prop);
6c75ea1e
RK		 768 if (!rc)
769 pdata->i2c_retry_count = prop;
770
3ddca062 771 rc = of_property_read_u32(of_node, "sbs,poll-retry-count", &prop);
6c75ea1e
RK		 772 if (!rc)
773 pdata->poll_retry_count = prop;
774
3ddca062 775 if (!of_get_property(of_node, "sbs,battery-detect-gpios", NULL)) {
6c75ea1e
RK		 776 pdata->battery_detect = -1;
777 goto of_out;
778 }
779
780 pdata->battery_detect = of_get_named_gpio_flags(of_node,
3ddca062 781 "sbs,battery-detect-gpios", 0, &gpio_flags);
6c75ea1e
RK		 782
783 if (gpio_flags & OF_GPIO_ACTIVE_LOW)
784 pdata->battery_detect_present = 0;
785 else
786 pdata->battery_detect_present = 1;
787
788of_out:
789 return pdata;
790}
791#else
3ddca062 792static struct sbs_platform_data *sbs_of_populate_pdata(
6c75ea1e
RK		 793 struct i2c_client *client)
794{
795 return client->dev.platform_data;
796}
797#endif
798
c8afa640 799static int sbs_probe(struct i2c_client *client,
a7640bfa
RK		 800 const struct i2c_device_id *id)
801{
3ddca062
RK		 802 struct sbs_info *chip;
803 struct sbs_platform_data *pdata = client->dev.platform_data;
a7640bfa 804 int rc;
bb879101 805 int irq;
52f56c69 806 char *name;
a7640bfa 807
52f56c69
RK		 808 name = kasprintf(GFP_KERNEL, "sbs-%s", dev_name(&client->dev));
809 if (!name) {
810 dev_err(&client->dev, "Failed to allocate device name\n");
a7640bfa 811 return -ENOMEM;
52f56c69
RK		 812 }
813
814 chip = kzalloc(sizeof(struct sbs_info), GFP_KERNEL);
815 if (!chip) {
816 rc = -ENOMEM;
817 goto exit_free_name;
818 }
a7640bfa 819
3ddca062
RK		 820 chip->client = client;
821 chip->enable_detection = false;
822 chip->gpio_detect = false;
52f56c69 823 chip->power_supply.name = name;
3ddca062
RK		 824 chip->power_supply.type = POWER_SUPPLY_TYPE_BATTERY;
825 chip->power_supply.properties = sbs_properties;
826 chip->power_supply.num_properties = ARRAY_SIZE(sbs_properties);
827 chip->power_supply.get_property = sbs_get_property;
89a22b1a 828 chip->power_supply.of_node = client->dev.of_node;
58ddafae
RK		 829 /* ignore first notification of external change, it is generated
830 * from the power_supply_register call back
831 */
3ddca062
RK		 832 chip->ignore_changes = 1;
833 chip->last_state = POWER_SUPPLY_STATUS_UNKNOWN;
834 chip->power_supply.external_power_changed = sbs_external_power_changed;
a7640bfa 835
3ddca062 836 pdata = sbs_of_populate_pdata(client);
6c75ea1e 837
bb879101 838 if (pdata) {
3ddca062
RK		 839 chip->gpio_detect = gpio_is_valid(pdata->battery_detect);
840 chip->pdata = pdata;
bb879101
RK		 841 }
842
3ddca062 843 i2c_set_clientdata(client, chip);
a7640bfa 844
3ddca062 845 if (!chip->gpio_detect)
bb879101
RK		 846 goto skip_gpio;
847
848 rc = gpio_request(pdata->battery_detect, dev_name(&client->dev));
849 if (rc) {
850 dev_warn(&client->dev, "Failed to request gpio: %d\n", rc);
3ddca062 851 chip->gpio_detect = false;
bb879101
RK		 852 goto skip_gpio;
853 }
854
855 rc = gpio_direction_input(pdata->battery_detect);
856 if (rc) {
857 dev_warn(&client->dev, "Failed to get gpio as input: %d\n", rc);
858 gpio_free(pdata->battery_detect);
3ddca062 859 chip->gpio_detect = false;
bb879101
RK		 860 goto skip_gpio;
861 }
862
863 irq = gpio_to_irq(pdata->battery_detect);
864 if (irq <= 0) {
865 dev_warn(&client->dev, "Failed to get gpio as irq: %d\n", irq);
866 gpio_free(pdata->battery_detect);
3ddca062 867 chip->gpio_detect = false;
bb879101
RK		 868 goto skip_gpio;
869 }
870
3ddca062 871 rc = request_irq(irq, sbs_irq,
bb879101 872 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
3ddca062 873 dev_name(&client->dev), &chip->power_supply);
bb879101
RK		 874 if (rc) {
875 dev_warn(&client->dev, "Failed to request irq: %d\n", rc);
876 gpio_free(pdata->battery_detect);
3ddca062 877 chip->gpio_detect = false;
bb879101
RK		 878 goto skip_gpio;
879 }
880
3ddca062 881 chip->irq = irq;
bb879101
RK		 882
883skip_gpio:
a22b41a3
OJ		 884 /*
885 * Before we register, we need to make sure we can actually talk
886 * to the battery.
887 */
888 rc = sbs_read_word_data(client, sbs_data[REG_STATUS].addr);
889 if (rc < 0) {
890 dev_err(&client->dev, "%s: Failed to get device status\n",
891 __func__);
892 goto exit_psupply;
893 }
bb879101 894
3ddca062 895 rc = power_supply_register(&client->dev, &chip->power_supply);
a7640bfa
RK		 896 if (rc) {
897 dev_err(&client->dev,
898 "%s: Failed to register power supply\n", __func__);
bb879101 899 goto exit_psupply;
a7640bfa
RK		 900 }
901
902 dev_info(&client->dev,
903 "%s: battery gas gauge device registered\n", client->name);
904
3ddca062 905 INIT_DELAYED_WORK(&chip->work, sbs_delayed_work);
58ddafae 906
3ddca062 907 chip->enable_detection = true;
ee177d96 908
a7640bfa 909 return 0;
bb879101
RK		 910
911exit_psupply:
3ddca062
RK		 912 if (chip->irq)
913 free_irq(chip->irq, &chip->power_supply);
914 if (chip->gpio_detect)
bb879101
RK		 915 gpio_free(pdata->battery_detect);
916
3ddca062 917 kfree(chip);
bb879101 918
52f56c69
RK		 919exit_free_name:
920 kfree(name);
921
bb879101 922 return rc;
a7640bfa
RK		 923}
924
415ec69f 925static int sbs_remove(struct i2c_client *client)
a7640bfa 926{
3ddca062 927 struct sbs_info *chip = i2c_get_clientdata(client);
a7640bfa 928
3ddca062
RK		 929 if (chip->irq)
930 free_irq(chip->irq, &chip->power_supply);
931 if (chip->gpio_detect)
932 gpio_free(chip->pdata->battery_detect);
bb879101 933
3ddca062 934 power_supply_unregister(&chip->power_supply);
58ddafae 935
3ddca062 936 cancel_delayed_work_sync(&chip->work);
58ddafae 937
52f56c69 938 kfree(chip->power_supply.name);
3ddca062
RK		 939 kfree(chip);
940 chip = NULL;
a7640bfa
RK		 941
942 return 0;
943}
944
9c1d1af0
LPC		 945#if defined CONFIG_PM_SLEEP
946
947static int sbs_suspend(struct device *dev)
a7640bfa 948{
9c1d1af0 949 struct i2c_client *client = to_i2c_client(dev);
3ddca062 950 struct sbs_info *chip = i2c_get_clientdata(client);
a7640bfa
RK		 951 s32 ret;
952
3ddca062
RK		 953 if (chip->poll_time > 0)
954 cancel_delayed_work_sync(&chip->work);
58ddafae 955
a7640bfa 956 /* write to manufacturer access with sleep command */
3ddca062 957 ret = sbs_write_word_data(client, sbs_data[REG_MANUFACTURER_DATA].addr,
a7640bfa 958 MANUFACTURER_ACCESS_SLEEP);
3ddca062 959 if (chip->is_present && ret < 0)
d3ab61ec 960 return ret;
a7640bfa
RK		 961
962 return 0;
963}
9c1d1af0
LPC		 964
965static SIMPLE_DEV_PM_OPS(sbs_pm_ops, sbs_suspend, NULL);
966#define SBS_PM_OPS (&sbs_pm_ops)
967
a7640bfa 968#else
9c1d1af0 969#define SBS_PM_OPS NULL
a7640bfa 970#endif
a7640bfa 971
3ddca062 972static const struct i2c_device_id sbs_id[] = {
a7640bfa 973 { "bq20z75", 0 },
3ddca062 974 { "sbs-battery", 1 },
a7640bfa
RK		 975 {}
976};
3ddca062
RK		 977MODULE_DEVICE_TABLE(i2c, sbs_id);
978
979static struct i2c_driver sbs_battery_driver = {
980 .probe = sbs_probe,
28ea73f4 981 .remove = sbs_remove,
3ddca062 982 .id_table = sbs_id,
a7640bfa 983 .driver = {
3ddca062 984 .name = "sbs-battery",
075ed03c 985 .of_match_table = of_match_ptr(sbs_dt_ids),
9c1d1af0 986 .pm = SBS_PM_OPS,
a7640bfa
RK		 987 },
988};
5ff92e7a 989module_i2c_driver(sbs_battery_driver);
a7640bfa 990
3ddca062 991MODULE_DESCRIPTION("SBS battery monitor driver");
a7640bfa 992MODULE_LICENSE("GPL");
Linux 6.x block layer and io_uring tree(s)