ds2782_battery.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * I2C client/driver for the Maxim/Dallas DS2782 Stand-Alone Fuel Gauge IC
  4. *
  5. * Copyright (C) 2009 Bluewater Systems Ltd
  6. *
  7. * Author: Ryan Mallon
  8. *
  9. * DS2786 added by Yulia Vilensky <[email protected]>
  10. *
  11. * UEvent sending added by Evgeny Romanov <[email protected]>
  12. */
  13. #include <linux/kernel.h>
  14. #include <linux/module.h>
  15. #include <linux/types.h>
  16. #include <linux/errno.h>
  17. #include <linux/swab.h>
  18. #include <linux/i2c.h>
  19. #include <linux/delay.h>
  20. #include <linux/idr.h>
  21. #include <linux/power_supply.h>
  22. #include <linux/slab.h>
  23. #include <linux/ds2782_battery.h>
  24. #define DS2782_REG_RARC 0x06 /* Remaining active relative capacity */
  25. #define DS278x_REG_VOLT_MSB 0x0c
  26. #define DS278x_REG_TEMP_MSB 0x0a
  27. #define DS278x_REG_CURRENT_MSB 0x0e
  28. /* EEPROM Block */
  29. #define DS2782_REG_RSNSP 0x69 /* Sense resistor value */
  30. /* Current unit measurement in uA for a 1 milli-ohm sense resistor */
  31. #define DS2782_CURRENT_UNITS 1563
  32. #define DS2786_REG_RARC 0x02 /* Remaining active relative capacity */
  33. #define DS2786_CURRENT_UNITS 25
  34. #define DS278x_DELAY 1000
  35. struct ds278x_info;
  36. struct ds278x_battery_ops {
  37. int (*get_battery_current)(struct ds278x_info *info, int *current_uA);
  38. int (*get_battery_voltage)(struct ds278x_info *info, int *voltage_uV);
  39. int (*get_battery_capacity)(struct ds278x_info *info, int *capacity);
  40. };
  41. #define to_ds278x_info(x) power_supply_get_drvdata(x)
  42. struct ds278x_info {
  43. struct i2c_client *client;
  44. struct power_supply *battery;
  45. struct power_supply_desc battery_desc;
  46. const struct ds278x_battery_ops *ops;
  47. struct delayed_work bat_work;
  48. int id;
  49. int rsns;
  50. int capacity;
  51. int status; /* State Of Charge */
  52. };
  53. static DEFINE_IDR(battery_id);
  54. static DEFINE_MUTEX(battery_lock);
  55. static inline int ds278x_read_reg(struct ds278x_info *info, int reg, u8 *val)
  56. {
  57. int ret;
  58. ret = i2c_smbus_read_byte_data(info->client, reg);
  59. if (ret < 0) {
  60. dev_err(&info->client->dev, "register read failed\n");
  61. return ret;
  62. }
  63. *val = ret;
  64. return 0;
  65. }
  66. static inline int ds278x_read_reg16(struct ds278x_info *info, int reg_msb,
  67. s16 *val)
  68. {
  69. int ret;
  70. ret = i2c_smbus_read_word_data(info->client, reg_msb);
  71. if (ret < 0) {
  72. dev_err(&info->client->dev, "register read failed\n");
  73. return ret;
  74. }
  75. *val = swab16(ret);
  76. return 0;
  77. }
  78. static int ds278x_get_temp(struct ds278x_info *info, int *temp)
  79. {
  80. s16 raw;
  81. int err;
  82. /*
  83. * Temperature is measured in units of 0.125 degrees celcius, the
  84. * power_supply class measures temperature in tenths of degrees
  85. * celsius. The temperature value is stored as a 10 bit number, plus
  86. * sign in the upper bits of a 16 bit register.
  87. */
  88. err = ds278x_read_reg16(info, DS278x_REG_TEMP_MSB, &raw);
  89. if (err)
  90. return err;
  91. *temp = ((raw / 32) * 125) / 100;
  92. return 0;
  93. }
  94. static int ds2782_get_current(struct ds278x_info *info, int *current_uA)
  95. {
  96. int sense_res;
  97. int err;
  98. u8 sense_res_raw;
  99. s16 raw;
  100. /*
  101. * The units of measurement for current are dependent on the value of
  102. * the sense resistor.
  103. */
  104. err = ds278x_read_reg(info, DS2782_REG_RSNSP, &sense_res_raw);
  105. if (err)
  106. return err;
  107. if (sense_res_raw == 0) {
  108. dev_err(&info->client->dev, "sense resistor value is 0\n");
  109. return -ENXIO;
  110. }
  111. sense_res = 1000 / sense_res_raw;
  112. dev_dbg(&info->client->dev, "sense resistor = %d milli-ohms\n",
  113. sense_res);
  114. err = ds278x_read_reg16(info, DS278x_REG_CURRENT_MSB, &raw);
  115. if (err)
  116. return err;
  117. *current_uA = raw * (DS2782_CURRENT_UNITS / sense_res);
  118. return 0;
  119. }
  120. static int ds2782_get_voltage(struct ds278x_info *info, int *voltage_uV)
  121. {
  122. s16 raw;
  123. int err;
  124. /*
  125. * Voltage is measured in units of 4.88mV. The voltage is stored as
  126. * a 10-bit number plus sign, in the upper bits of a 16-bit register
  127. */
  128. err = ds278x_read_reg16(info, DS278x_REG_VOLT_MSB, &raw);
  129. if (err)
  130. return err;
  131. *voltage_uV = (raw / 32) * 4800;
  132. return 0;
  133. }
  134. static int ds2782_get_capacity(struct ds278x_info *info, int *capacity)
  135. {
  136. int err;
  137. u8 raw;
  138. err = ds278x_read_reg(info, DS2782_REG_RARC, &raw);
  139. if (err)
  140. return err;
  141. *capacity = raw;
  142. return 0;
  143. }
  144. static int ds2786_get_current(struct ds278x_info *info, int *current_uA)
  145. {
  146. int err;
  147. s16 raw;
  148. err = ds278x_read_reg16(info, DS278x_REG_CURRENT_MSB, &raw);
  149. if (err)
  150. return err;
  151. *current_uA = (raw / 16) * (DS2786_CURRENT_UNITS / info->rsns);
  152. return 0;
  153. }
  154. static int ds2786_get_voltage(struct ds278x_info *info, int *voltage_uV)
  155. {
  156. s16 raw;
  157. int err;
  158. /*
  159. * Voltage is measured in units of 1.22mV. The voltage is stored as
  160. * a 12-bit number plus sign, in the upper bits of a 16-bit register
  161. */
  162. err = ds278x_read_reg16(info, DS278x_REG_VOLT_MSB, &raw);
  163. if (err)
  164. return err;
  165. *voltage_uV = (raw / 8) * 1220;
  166. return 0;
  167. }
  168. static int ds2786_get_capacity(struct ds278x_info *info, int *capacity)
  169. {
  170. int err;
  171. u8 raw;
  172. err = ds278x_read_reg(info, DS2786_REG_RARC, &raw);
  173. if (err)
  174. return err;
  175. /* Relative capacity is displayed with resolution 0.5 % */
  176. *capacity = raw/2 ;
  177. return 0;
  178. }
  179. static int ds278x_get_status(struct ds278x_info *info, int *status)
  180. {
  181. int err;
  182. int current_uA;
  183. int capacity;
  184. err = info->ops->get_battery_current(info, &current_uA);
  185. if (err)
  186. return err;
  187. err = info->ops->get_battery_capacity(info, &capacity);
  188. if (err)
  189. return err;
  190. info->capacity = capacity;
  191. if (capacity == 100)
  192. *status = POWER_SUPPLY_STATUS_FULL;
  193. else if (current_uA == 0)
  194. *status = POWER_SUPPLY_STATUS_NOT_CHARGING;
  195. else if (current_uA < 0)
  196. *status = POWER_SUPPLY_STATUS_DISCHARGING;
  197. else
  198. *status = POWER_SUPPLY_STATUS_CHARGING;
  199. return 0;
  200. }
  201. static int ds278x_battery_get_property(struct power_supply *psy,
  202. enum power_supply_property prop,
  203. union power_supply_propval *val)
  204. {
  205. struct ds278x_info *info = to_ds278x_info(psy);
  206. int ret;
  207. switch (prop) {
  208. case POWER_SUPPLY_PROP_STATUS:
  209. ret = ds278x_get_status(info, &val->intval);
  210. break;
  211. case POWER_SUPPLY_PROP_CAPACITY:
  212. ret = info->ops->get_battery_capacity(info, &val->intval);
  213. break;
  214. case POWER_SUPPLY_PROP_VOLTAGE_NOW:
  215. ret = info->ops->get_battery_voltage(info, &val->intval);
  216. break;
  217. case POWER_SUPPLY_PROP_CURRENT_NOW:
  218. ret = info->ops->get_battery_current(info, &val->intval);
  219. break;
  220. case POWER_SUPPLY_PROP_TEMP:
  221. ret = ds278x_get_temp(info, &val->intval);
  222. break;
  223. default:
  224. ret = -EINVAL;
  225. }
  226. return ret;
  227. }
  228. static void ds278x_bat_update(struct ds278x_info *info)
  229. {
  230. int old_status = info->status;
  231. int old_capacity = info->capacity;
  232. ds278x_get_status(info, &info->status);
  233. if ((old_status != info->status) || (old_capacity != info->capacity))
  234. power_supply_changed(info->battery);
  235. }
  236. static void ds278x_bat_work(struct work_struct *work)
  237. {
  238. struct ds278x_info *info;
  239. info = container_of(work, struct ds278x_info, bat_work.work);
  240. ds278x_bat_update(info);
  241. schedule_delayed_work(&info->bat_work, DS278x_DELAY);
  242. }
  243. static enum power_supply_property ds278x_battery_props[] = {
  244. POWER_SUPPLY_PROP_STATUS,
  245. POWER_SUPPLY_PROP_CAPACITY,
  246. POWER_SUPPLY_PROP_VOLTAGE_NOW,
  247. POWER_SUPPLY_PROP_CURRENT_NOW,
  248. POWER_SUPPLY_PROP_TEMP,
  249. };
  250. static void ds278x_power_supply_init(struct power_supply_desc *battery)
  251. {
  252. battery->type = POWER_SUPPLY_TYPE_BATTERY;
  253. battery->properties = ds278x_battery_props;
  254. battery->num_properties = ARRAY_SIZE(ds278x_battery_props);
  255. battery->get_property = ds278x_battery_get_property;
  256. battery->external_power_changed = NULL;
  257. }
  258. static void ds278x_battery_remove(struct i2c_client *client)
  259. {
  260. struct ds278x_info *info = i2c_get_clientdata(client);
  261. int id = info->id;
  262. power_supply_unregister(info->battery);
  263. cancel_delayed_work_sync(&info->bat_work);
  264. kfree(info->battery_desc.name);
  265. kfree(info);
  266. mutex_lock(&battery_lock);
  267. idr_remove(&battery_id, id);
  268. mutex_unlock(&battery_lock);
  269. }
  270. #ifdef CONFIG_PM_SLEEP
  271. static int ds278x_suspend(struct device *dev)
  272. {
  273. struct i2c_client *client = to_i2c_client(dev);
  274. struct ds278x_info *info = i2c_get_clientdata(client);
  275. cancel_delayed_work(&info->bat_work);
  276. return 0;
  277. }
  278. static int ds278x_resume(struct device *dev)
  279. {
  280. struct i2c_client *client = to_i2c_client(dev);
  281. struct ds278x_info *info = i2c_get_clientdata(client);
  282. schedule_delayed_work(&info->bat_work, DS278x_DELAY);
  283. return 0;
  284. }
  285. #endif /* CONFIG_PM_SLEEP */
  286. static SIMPLE_DEV_PM_OPS(ds278x_battery_pm_ops, ds278x_suspend, ds278x_resume);
  287. enum ds278x_num_id {
  288. DS2782 = 0,
  289. DS2786,
  290. };
  291. static const struct ds278x_battery_ops ds278x_ops[] = {
  292. [DS2782] = {
  293. .get_battery_current = ds2782_get_current,
  294. .get_battery_voltage = ds2782_get_voltage,
  295. .get_battery_capacity = ds2782_get_capacity,
  296. },
  297. [DS2786] = {
  298. .get_battery_current = ds2786_get_current,
  299. .get_battery_voltage = ds2786_get_voltage,
  300. .get_battery_capacity = ds2786_get_capacity,
  301. }
  302. };
  303. static int ds278x_battery_probe(struct i2c_client *client,
  304. const struct i2c_device_id *id)
  305. {
  306. struct ds278x_platform_data *pdata = client->dev.platform_data;
  307. struct power_supply_config psy_cfg = {};
  308. struct ds278x_info *info;
  309. int ret;
  310. int num;
  311. /*
  312. * ds2786 should have the sense resistor value set
  313. * in the platform data
  314. */
  315. if (id->driver_data == DS2786 && !pdata) {
  316. dev_err(&client->dev, "missing platform data for ds2786\n");
  317. return -EINVAL;
  318. }
  319. /* Get an ID for this battery */
  320. mutex_lock(&battery_lock);
  321. ret = idr_alloc(&battery_id, client, 0, 0, GFP_KERNEL);
  322. mutex_unlock(&battery_lock);
  323. if (ret < 0)
  324. goto fail_id;
  325. num = ret;
  326. info = kzalloc(sizeof(*info), GFP_KERNEL);
  327. if (!info) {
  328. ret = -ENOMEM;
  329. goto fail_info;
  330. }
  331. info->battery_desc.name = kasprintf(GFP_KERNEL, "%s-%d",
  332. client->name, num);
  333. if (!info->battery_desc.name) {
  334. ret = -ENOMEM;
  335. goto fail_name;
  336. }
  337. if (id->driver_data == DS2786)
  338. info->rsns = pdata->rsns;
  339. i2c_set_clientdata(client, info);
  340. info->client = client;
  341. info->id = num;
  342. info->ops = &ds278x_ops[id->driver_data];
  343. ds278x_power_supply_init(&info->battery_desc);
  344. psy_cfg.drv_data = info;
  345. info->capacity = 100;
  346. info->status = POWER_SUPPLY_STATUS_FULL;
  347. INIT_DELAYED_WORK(&info->bat_work, ds278x_bat_work);
  348. info->battery = power_supply_register(&client->dev,
  349. &info->battery_desc, &psy_cfg);
  350. if (IS_ERR(info->battery)) {
  351. dev_err(&client->dev, "failed to register battery\n");
  352. ret = PTR_ERR(info->battery);
  353. goto fail_register;
  354. } else {
  355. schedule_delayed_work(&info->bat_work, DS278x_DELAY);
  356. }
  357. return 0;
  358. fail_register:
  359. kfree(info->battery_desc.name);
  360. fail_name:
  361. kfree(info);
  362. fail_info:
  363. mutex_lock(&battery_lock);
  364. idr_remove(&battery_id, num);
  365. mutex_unlock(&battery_lock);
  366. fail_id:
  367. return ret;
  368. }
  369. static const struct i2c_device_id ds278x_id[] = {
  370. {"ds2782", DS2782},
  371. {"ds2786", DS2786},
  372. {},
  373. };
  374. MODULE_DEVICE_TABLE(i2c, ds278x_id);
  375. static struct i2c_driver ds278x_battery_driver = {
  376. .driver = {
  377. .name = "ds2782-battery",
  378. .pm = &ds278x_battery_pm_ops,
  379. },
  380. .probe = ds278x_battery_probe,
  381. .remove = ds278x_battery_remove,
  382. .id_table = ds278x_id,
  383. };
  384. module_i2c_driver(ds278x_battery_driver);
  385. MODULE_AUTHOR("Ryan Mallon");
  386. MODULE_DESCRIPTION("Maxim/Dallas DS2782 Stand-Alone Fuel Gauge IC driver");
  387. MODULE_LICENSE("GPL");