2 * Battery driver for One Laptop Per Child board.
4 * Copyright © 2006-2010 David Woodhouse <dwmw2@infradead.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/types.h>
14 #include <linux/err.h>
15 #include <linux/device.h>
16 #include <linux/platform_device.h>
17 #include <linux/power_supply.h>
18 #include <linux/jiffies.h>
19 #include <linux/sched.h>
23 #define EC_BAT_VOLTAGE 0x10 /* uint16_t, *9.76/32, mV */
24 #define EC_BAT_CURRENT 0x11 /* int16_t, *15.625/120, mA */
25 #define EC_BAT_ACR 0x12 /* int16_t, *6250/15, µAh */
26 #define EC_BAT_TEMP 0x13 /* uint16_t, *100/256, °C */
27 #define EC_AMB_TEMP 0x14 /* uint16_t, *100/256, °C */
28 #define EC_BAT_STATUS 0x15 /* uint8_t, bitmask */
29 #define EC_BAT_SOC 0x16 /* uint8_t, percentage */
30 #define EC_BAT_SERIAL 0x17 /* uint8_t[6] */
31 #define EC_BAT_EEPROM 0x18 /* uint8_t adr as input, uint8_t output */
32 #define EC_BAT_ERRCODE 0x1f /* uint8_t, bitmask */
34 #define BAT_STAT_PRESENT 0x01
35 #define BAT_STAT_FULL 0x02
36 #define BAT_STAT_LOW 0x04
37 #define BAT_STAT_DESTROY 0x08
38 #define BAT_STAT_AC 0x10
39 #define BAT_STAT_CHARGING 0x20
40 #define BAT_STAT_DISCHARGING 0x40
41 #define BAT_STAT_TRICKLE 0x80
43 #define BAT_ERR_INFOFAIL 0x02
44 #define BAT_ERR_OVERVOLTAGE 0x04
45 #define BAT_ERR_OVERTEMP 0x05
46 #define BAT_ERR_GAUGESTOP 0x06
47 #define BAT_ERR_OUT_OF_CONTROL 0x07
48 #define BAT_ERR_ID_FAIL 0x09
49 #define BAT_ERR_ACR_FAIL 0x10
51 #define BAT_ADDR_MFR_TYPE 0x5F
53 /*********************************************************************
55 *********************************************************************/
57 static int olpc_ac_get_prop(struct power_supply *psy,
58 enum power_supply_property psp,
59 union power_supply_propval *val)
65 case POWER_SUPPLY_PROP_ONLINE:
66 ret = olpc_ec_cmd(EC_BAT_STATUS, NULL, 0, &status, 1);
70 val->intval = !!(status & BAT_STAT_AC);
79 static enum power_supply_property olpc_ac_props[] = {
80 POWER_SUPPLY_PROP_ONLINE,
83 static struct power_supply olpc_ac = {
85 .type = POWER_SUPPLY_TYPE_MAINS,
86 .properties = olpc_ac_props,
87 .num_properties = ARRAY_SIZE(olpc_ac_props),
88 .get_property = olpc_ac_get_prop,
91 static char bat_serial[17]; /* Ick */
93 static int olpc_bat_get_status(union power_supply_propval *val, uint8_t ec_byte)
95 if (olpc_platform_info.ecver > 0x44) {
96 if (ec_byte & (BAT_STAT_CHARGING | BAT_STAT_TRICKLE))
97 val->intval = POWER_SUPPLY_STATUS_CHARGING;
98 else if (ec_byte & BAT_STAT_DISCHARGING)
99 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
100 else if (ec_byte & BAT_STAT_FULL)
101 val->intval = POWER_SUPPLY_STATUS_FULL;
103 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
105 /* Older EC didn't report charge/discharge bits */
106 if (!(ec_byte & BAT_STAT_AC)) /* No AC means discharging */
107 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
108 else if (ec_byte & BAT_STAT_FULL)
109 val->intval = POWER_SUPPLY_STATUS_FULL;
110 else /* Not _necessarily_ true but EC doesn't tell all yet */
111 val->intval = POWER_SUPPLY_STATUS_CHARGING;
117 static int olpc_bat_get_health(union power_supply_propval *val)
122 ret = olpc_ec_cmd(EC_BAT_ERRCODE, NULL, 0, &ec_byte, 1);
128 val->intval = POWER_SUPPLY_HEALTH_GOOD;
131 case BAT_ERR_OVERTEMP:
132 val->intval = POWER_SUPPLY_HEALTH_OVERHEAT;
135 case BAT_ERR_OVERVOLTAGE:
136 val->intval = POWER_SUPPLY_HEALTH_OVERVOLTAGE;
139 case BAT_ERR_INFOFAIL:
140 case BAT_ERR_OUT_OF_CONTROL:
141 case BAT_ERR_ID_FAIL:
142 case BAT_ERR_ACR_FAIL:
143 val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE;
147 /* Eep. We don't know this failure code */
154 static int olpc_bat_get_mfr(union power_supply_propval *val)
159 ec_byte = BAT_ADDR_MFR_TYPE;
160 ret = olpc_ec_cmd(EC_BAT_EEPROM, &ec_byte, 1, &ec_byte, 1);
164 switch (ec_byte >> 4) {
166 val->strval = "Gold Peak";
172 val->strval = "Unknown";
179 static int olpc_bat_get_tech(union power_supply_propval *val)
184 ec_byte = BAT_ADDR_MFR_TYPE;
185 ret = olpc_ec_cmd(EC_BAT_EEPROM, &ec_byte, 1, &ec_byte, 1);
189 switch (ec_byte & 0xf) {
191 val->intval = POWER_SUPPLY_TECHNOLOGY_NiMH;
194 val->intval = POWER_SUPPLY_TECHNOLOGY_LiFe;
197 val->intval = POWER_SUPPLY_TECHNOLOGY_UNKNOWN;
204 static int olpc_bat_get_charge_full_design(union power_supply_propval *val)
207 union power_supply_propval tech;
210 ret = olpc_bat_get_tech(&tech);
214 ec_byte = BAT_ADDR_MFR_TYPE;
215 ret = olpc_ec_cmd(EC_BAT_EEPROM, &ec_byte, 1, &ec_byte, 1);
221 switch (tech.intval) {
222 case POWER_SUPPLY_TECHNOLOGY_NiMH:
224 case 1: /* Gold Peak */
225 val->intval = 3000000*.8;
232 case POWER_SUPPLY_TECHNOLOGY_LiFe:
234 case 1: /* Gold Peak, fall through */
236 val->intval = 2800000;
250 static int olpc_bat_get_charge_now(union power_supply_propval *val)
253 union power_supply_propval full;
256 ret = olpc_ec_cmd(EC_BAT_SOC, NULL, 0, &soc, 1);
260 ret = olpc_bat_get_charge_full_design(&full);
264 val->intval = soc * (full.intval / 100);
268 static int olpc_bat_get_voltage_max_design(union power_supply_propval *val)
271 union power_supply_propval tech;
275 ret = olpc_bat_get_tech(&tech);
279 ec_byte = BAT_ADDR_MFR_TYPE;
280 ret = olpc_ec_cmd(EC_BAT_EEPROM, &ec_byte, 1, &ec_byte, 1);
286 switch (tech.intval) {
287 case POWER_SUPPLY_TECHNOLOGY_NiMH:
289 case 1: /* Gold Peak */
290 val->intval = 6000000;
297 case POWER_SUPPLY_TECHNOLOGY_LiFe:
299 case 1: /* Gold Peak */
300 val->intval = 6400000;
303 val->intval = 6500000;
317 /*********************************************************************
319 *********************************************************************/
320 static int olpc_bat_get_property(struct power_supply *psy,
321 enum power_supply_property psp,
322 union power_supply_propval *val)
329 ret = olpc_ec_cmd(EC_BAT_STATUS, NULL, 0, &ec_byte, 1);
333 /* Theoretically there's a race here -- the battery could be
334 removed immediately after we check whether it's present, and
335 then we query for some other property of the now-absent battery.
336 It doesn't matter though -- the EC will return the last-known
337 information, and it's as if we just ran that _little_ bit faster
338 and managed to read it out before the battery went away. */
339 if (!(ec_byte & (BAT_STAT_PRESENT | BAT_STAT_TRICKLE)) &&
340 psp != POWER_SUPPLY_PROP_PRESENT)
344 case POWER_SUPPLY_PROP_STATUS:
345 ret = olpc_bat_get_status(val, ec_byte);
349 case POWER_SUPPLY_PROP_CHARGE_TYPE:
350 if (ec_byte & BAT_STAT_TRICKLE)
351 val->intval = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
352 else if (ec_byte & BAT_STAT_CHARGING)
353 val->intval = POWER_SUPPLY_CHARGE_TYPE_FAST;
355 val->intval = POWER_SUPPLY_CHARGE_TYPE_NONE;
357 case POWER_SUPPLY_PROP_PRESENT:
358 val->intval = !!(ec_byte & (BAT_STAT_PRESENT |
362 case POWER_SUPPLY_PROP_HEALTH:
363 if (ec_byte & BAT_STAT_DESTROY)
364 val->intval = POWER_SUPPLY_HEALTH_DEAD;
366 ret = olpc_bat_get_health(val);
372 case POWER_SUPPLY_PROP_MANUFACTURER:
373 ret = olpc_bat_get_mfr(val);
377 case POWER_SUPPLY_PROP_TECHNOLOGY:
378 ret = olpc_bat_get_tech(val);
382 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
383 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
384 ret = olpc_ec_cmd(EC_BAT_VOLTAGE, NULL, 0, (void *)&ec_word, 2);
388 val->intval = (s16)be16_to_cpu(ec_word) * 9760L / 32;
390 case POWER_SUPPLY_PROP_CURRENT_AVG:
391 case POWER_SUPPLY_PROP_CURRENT_NOW:
392 ret = olpc_ec_cmd(EC_BAT_CURRENT, NULL, 0, (void *)&ec_word, 2);
396 val->intval = (s16)be16_to_cpu(ec_word) * 15625L / 120;
398 case POWER_SUPPLY_PROP_CAPACITY:
399 ret = olpc_ec_cmd(EC_BAT_SOC, NULL, 0, &ec_byte, 1);
402 val->intval = ec_byte;
404 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
405 if (ec_byte & BAT_STAT_FULL)
406 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
407 else if (ec_byte & BAT_STAT_LOW)
408 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
410 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
412 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
413 ret = olpc_bat_get_charge_full_design(val);
417 case POWER_SUPPLY_PROP_CHARGE_NOW:
418 ret = olpc_bat_get_charge_now(val);
422 case POWER_SUPPLY_PROP_TEMP:
423 ret = olpc_ec_cmd(EC_BAT_TEMP, NULL, 0, (void *)&ec_word, 2);
427 val->intval = (s16)be16_to_cpu(ec_word) * 100 / 256;
429 case POWER_SUPPLY_PROP_TEMP_AMBIENT:
430 ret = olpc_ec_cmd(EC_AMB_TEMP, NULL, 0, (void *)&ec_word, 2);
434 val->intval = (int)be16_to_cpu(ec_word) * 100 / 256;
436 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
437 ret = olpc_ec_cmd(EC_BAT_ACR, NULL, 0, (void *)&ec_word, 2);
441 val->intval = (s16)be16_to_cpu(ec_word) * 6250 / 15;
443 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
444 ret = olpc_ec_cmd(EC_BAT_SERIAL, NULL, 0, (void *)&ser_buf, 8);
448 sprintf(bat_serial, "%016llx", (long long)be64_to_cpu(ser_buf));
449 val->strval = bat_serial;
451 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
452 ret = olpc_bat_get_voltage_max_design(val);
464 static enum power_supply_property olpc_xo1_bat_props[] = {
465 POWER_SUPPLY_PROP_STATUS,
466 POWER_SUPPLY_PROP_CHARGE_TYPE,
467 POWER_SUPPLY_PROP_PRESENT,
468 POWER_SUPPLY_PROP_HEALTH,
469 POWER_SUPPLY_PROP_TECHNOLOGY,
470 POWER_SUPPLY_PROP_VOLTAGE_AVG,
471 POWER_SUPPLY_PROP_VOLTAGE_NOW,
472 POWER_SUPPLY_PROP_CURRENT_AVG,
473 POWER_SUPPLY_PROP_CURRENT_NOW,
474 POWER_SUPPLY_PROP_CAPACITY,
475 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
476 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
477 POWER_SUPPLY_PROP_CHARGE_NOW,
478 POWER_SUPPLY_PROP_TEMP,
479 POWER_SUPPLY_PROP_TEMP_AMBIENT,
480 POWER_SUPPLY_PROP_MANUFACTURER,
481 POWER_SUPPLY_PROP_SERIAL_NUMBER,
482 POWER_SUPPLY_PROP_CHARGE_COUNTER,
483 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
486 /* XO-1.5 does not have ambient temperature property */
487 static enum power_supply_property olpc_xo15_bat_props[] = {
488 POWER_SUPPLY_PROP_STATUS,
489 POWER_SUPPLY_PROP_CHARGE_TYPE,
490 POWER_SUPPLY_PROP_PRESENT,
491 POWER_SUPPLY_PROP_HEALTH,
492 POWER_SUPPLY_PROP_TECHNOLOGY,
493 POWER_SUPPLY_PROP_VOLTAGE_AVG,
494 POWER_SUPPLY_PROP_VOLTAGE_NOW,
495 POWER_SUPPLY_PROP_CURRENT_AVG,
496 POWER_SUPPLY_PROP_CURRENT_NOW,
497 POWER_SUPPLY_PROP_CAPACITY,
498 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
499 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
500 POWER_SUPPLY_PROP_CHARGE_NOW,
501 POWER_SUPPLY_PROP_TEMP,
502 POWER_SUPPLY_PROP_MANUFACTURER,
503 POWER_SUPPLY_PROP_SERIAL_NUMBER,
504 POWER_SUPPLY_PROP_CHARGE_COUNTER,
505 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
508 /* EEPROM reading goes completely around the power_supply API, sadly */
510 #define EEPROM_START 0x20
511 #define EEPROM_END 0x80
512 #define EEPROM_SIZE (EEPROM_END - EEPROM_START)
514 static ssize_t olpc_bat_eeprom_read(struct file *filp, struct kobject *kobj,
515 struct bin_attribute *attr, char *buf, loff_t off, size_t count)
521 if (off >= EEPROM_SIZE)
523 if (off + count > EEPROM_SIZE)
524 count = EEPROM_SIZE - off;
526 for (i = 0; i < count; i++) {
527 ec_byte = EEPROM_START + off + i;
528 ret = olpc_ec_cmd(EC_BAT_EEPROM, &ec_byte, 1, &buf[i], 1);
530 pr_err("olpc-battery: "
531 "EC_BAT_EEPROM cmd @ 0x%x failed - %d!\n",
540 static struct bin_attribute olpc_bat_eeprom = {
546 .read = olpc_bat_eeprom_read,
549 /* Allow userspace to see the specific error value pulled from the EC */
551 static ssize_t olpc_bat_error_read(struct device *dev,
552 struct device_attribute *attr, char *buf)
557 ret = olpc_ec_cmd(EC_BAT_ERRCODE, NULL, 0, &ec_byte, 1);
561 return sprintf(buf, "%d\n", ec_byte);
564 static struct device_attribute olpc_bat_error = {
569 .show = olpc_bat_error_read,
572 /*********************************************************************
574 *********************************************************************/
576 static struct power_supply olpc_bat = {
577 .name = "olpc-battery",
578 .get_property = olpc_bat_get_property,
582 static int olpc_battery_suspend(struct platform_device *pdev,
585 if (device_may_wakeup(olpc_ac.dev))
586 olpc_ec_wakeup_set(EC_SCI_SRC_ACPWR);
588 olpc_ec_wakeup_clear(EC_SCI_SRC_ACPWR);
590 if (device_may_wakeup(olpc_bat.dev))
591 olpc_ec_wakeup_set(EC_SCI_SRC_BATTERY | EC_SCI_SRC_BATSOC
592 | EC_SCI_SRC_BATERR);
594 olpc_ec_wakeup_clear(EC_SCI_SRC_BATTERY | EC_SCI_SRC_BATSOC
595 | EC_SCI_SRC_BATERR);
600 static int __devinit olpc_battery_probe(struct platform_device *pdev)
606 * We've seen a number of EC protocol changes; this driver requires
607 * the latest EC protocol, supported by 0x44 and above.
609 if (olpc_platform_info.ecver < 0x44) {
610 printk(KERN_NOTICE "OLPC EC version 0x%02x too old for "
611 "battery driver.\n", olpc_platform_info.ecver);
615 ret = olpc_ec_cmd(EC_BAT_STATUS, NULL, 0, &status, 1);
619 /* Ignore the status. It doesn't actually matter */
621 ret = power_supply_register(&pdev->dev, &olpc_ac);
625 if (olpc_board_at_least(olpc_board_pre(0xd0))) { /* XO-1.5 */
626 olpc_bat.properties = olpc_xo15_bat_props;
627 olpc_bat.num_properties = ARRAY_SIZE(olpc_xo15_bat_props);
629 olpc_bat.properties = olpc_xo1_bat_props;
630 olpc_bat.num_properties = ARRAY_SIZE(olpc_xo1_bat_props);
633 ret = power_supply_register(&pdev->dev, &olpc_bat);
637 ret = device_create_bin_file(olpc_bat.dev, &olpc_bat_eeprom);
641 ret = device_create_file(olpc_bat.dev, &olpc_bat_error);
645 if (olpc_ec_wakeup_available()) {
646 device_set_wakeup_capable(olpc_ac.dev, true);
647 device_set_wakeup_capable(olpc_bat.dev, true);
653 device_remove_bin_file(olpc_bat.dev, &olpc_bat_eeprom);
655 power_supply_unregister(&olpc_bat);
657 power_supply_unregister(&olpc_ac);
661 static int __devexit olpc_battery_remove(struct platform_device *pdev)
663 device_remove_file(olpc_bat.dev, &olpc_bat_error);
664 device_remove_bin_file(olpc_bat.dev, &olpc_bat_eeprom);
665 power_supply_unregister(&olpc_bat);
666 power_supply_unregister(&olpc_ac);
670 static const struct of_device_id olpc_battery_ids[] __devinitconst = {
671 { .compatible = "olpc,xo1-battery" },
674 MODULE_DEVICE_TABLE(of, olpc_battery_ids);
676 static struct platform_driver olpc_battery_driver = {
678 .name = "olpc-battery",
679 .owner = THIS_MODULE,
680 .of_match_table = olpc_battery_ids,
682 .probe = olpc_battery_probe,
683 .remove = __devexit_p(olpc_battery_remove),
684 .suspend = olpc_battery_suspend,
687 module_platform_driver(olpc_battery_driver);
689 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
690 MODULE_LICENSE("GPL");
691 MODULE_DESCRIPTION("Battery driver for One Laptop Per Child 'XO' machine");