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 */
235 val->intval = 2800000;
238 val->intval = 3100000;
252 static int olpc_bat_get_charge_now(union power_supply_propval *val)
255 union power_supply_propval full;
258 ret = olpc_ec_cmd(EC_BAT_SOC, NULL, 0, &soc, 1);
262 ret = olpc_bat_get_charge_full_design(&full);
266 val->intval = soc * (full.intval / 100);
270 /*********************************************************************
272 *********************************************************************/
273 static int olpc_bat_get_property(struct power_supply *psy,
274 enum power_supply_property psp,
275 union power_supply_propval *val)
282 ret = olpc_ec_cmd(EC_BAT_STATUS, NULL, 0, &ec_byte, 1);
286 /* Theoretically there's a race here -- the battery could be
287 removed immediately after we check whether it's present, and
288 then we query for some other property of the now-absent battery.
289 It doesn't matter though -- the EC will return the last-known
290 information, and it's as if we just ran that _little_ bit faster
291 and managed to read it out before the battery went away. */
292 if (!(ec_byte & (BAT_STAT_PRESENT | BAT_STAT_TRICKLE)) &&
293 psp != POWER_SUPPLY_PROP_PRESENT)
297 case POWER_SUPPLY_PROP_STATUS:
298 ret = olpc_bat_get_status(val, ec_byte);
302 case POWER_SUPPLY_PROP_CHARGE_TYPE:
303 if (ec_byte & BAT_STAT_TRICKLE)
304 val->intval = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
305 else if (ec_byte & BAT_STAT_CHARGING)
306 val->intval = POWER_SUPPLY_CHARGE_TYPE_FAST;
308 val->intval = POWER_SUPPLY_CHARGE_TYPE_NONE;
310 case POWER_SUPPLY_PROP_PRESENT:
311 val->intval = !!(ec_byte & (BAT_STAT_PRESENT |
315 case POWER_SUPPLY_PROP_HEALTH:
316 if (ec_byte & BAT_STAT_DESTROY)
317 val->intval = POWER_SUPPLY_HEALTH_DEAD;
319 ret = olpc_bat_get_health(val);
325 case POWER_SUPPLY_PROP_MANUFACTURER:
326 ret = olpc_bat_get_mfr(val);
330 case POWER_SUPPLY_PROP_TECHNOLOGY:
331 ret = olpc_bat_get_tech(val);
335 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
336 ret = olpc_ec_cmd(EC_BAT_VOLTAGE, NULL, 0, (void *)&ec_word, 2);
340 val->intval = (s16)be16_to_cpu(ec_word) * 9760L / 32;
342 case POWER_SUPPLY_PROP_CURRENT_AVG:
343 ret = olpc_ec_cmd(EC_BAT_CURRENT, NULL, 0, (void *)&ec_word, 2);
347 val->intval = (s16)be16_to_cpu(ec_word) * 15625L / 120;
349 case POWER_SUPPLY_PROP_CAPACITY:
350 ret = olpc_ec_cmd(EC_BAT_SOC, NULL, 0, &ec_byte, 1);
353 val->intval = ec_byte;
355 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
356 if (ec_byte & BAT_STAT_FULL)
357 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
358 else if (ec_byte & BAT_STAT_LOW)
359 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
361 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
363 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
364 ret = olpc_bat_get_charge_full_design(val);
368 case POWER_SUPPLY_PROP_CHARGE_NOW:
369 ret = olpc_bat_get_charge_now(val);
373 case POWER_SUPPLY_PROP_TEMP:
374 ret = olpc_ec_cmd(EC_BAT_TEMP, NULL, 0, (void *)&ec_word, 2);
378 val->intval = (s16)be16_to_cpu(ec_word) * 100 / 256;
380 case POWER_SUPPLY_PROP_TEMP_AMBIENT:
381 ret = olpc_ec_cmd(EC_AMB_TEMP, NULL, 0, (void *)&ec_word, 2);
385 val->intval = (int)be16_to_cpu(ec_word) * 100 / 256;
387 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
388 ret = olpc_ec_cmd(EC_BAT_ACR, NULL, 0, (void *)&ec_word, 2);
392 val->intval = (s16)be16_to_cpu(ec_word) * 6250 / 15;
394 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
395 ret = olpc_ec_cmd(EC_BAT_SERIAL, NULL, 0, (void *)&ser_buf, 8);
399 sprintf(bat_serial, "%016llx", (long long)be64_to_cpu(ser_buf));
400 val->strval = bat_serial;
410 static enum power_supply_property olpc_xo1_bat_props[] = {
411 POWER_SUPPLY_PROP_STATUS,
412 POWER_SUPPLY_PROP_CHARGE_TYPE,
413 POWER_SUPPLY_PROP_PRESENT,
414 POWER_SUPPLY_PROP_HEALTH,
415 POWER_SUPPLY_PROP_TECHNOLOGY,
416 POWER_SUPPLY_PROP_VOLTAGE_AVG,
417 POWER_SUPPLY_PROP_CURRENT_AVG,
418 POWER_SUPPLY_PROP_CAPACITY,
419 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
420 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
421 POWER_SUPPLY_PROP_CHARGE_NOW,
422 POWER_SUPPLY_PROP_TEMP,
423 POWER_SUPPLY_PROP_TEMP_AMBIENT,
424 POWER_SUPPLY_PROP_MANUFACTURER,
425 POWER_SUPPLY_PROP_SERIAL_NUMBER,
426 POWER_SUPPLY_PROP_CHARGE_COUNTER,
429 /* XO-1.5 does not have ambient temperature property */
430 static enum power_supply_property olpc_xo15_bat_props[] = {
431 POWER_SUPPLY_PROP_STATUS,
432 POWER_SUPPLY_PROP_CHARGE_TYPE,
433 POWER_SUPPLY_PROP_PRESENT,
434 POWER_SUPPLY_PROP_HEALTH,
435 POWER_SUPPLY_PROP_TECHNOLOGY,
436 POWER_SUPPLY_PROP_VOLTAGE_AVG,
437 POWER_SUPPLY_PROP_CURRENT_AVG,
438 POWER_SUPPLY_PROP_CAPACITY,
439 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
440 POWER_SUPPLY_PROP_TEMP,
441 POWER_SUPPLY_PROP_MANUFACTURER,
442 POWER_SUPPLY_PROP_SERIAL_NUMBER,
443 POWER_SUPPLY_PROP_CHARGE_COUNTER,
446 /* EEPROM reading goes completely around the power_supply API, sadly */
448 #define EEPROM_START 0x20
449 #define EEPROM_END 0x80
450 #define EEPROM_SIZE (EEPROM_END - EEPROM_START)
452 static ssize_t olpc_bat_eeprom_read(struct file *filp, struct kobject *kobj,
453 struct bin_attribute *attr, char *buf, loff_t off, size_t count)
459 if (off >= EEPROM_SIZE)
461 if (off + count > EEPROM_SIZE)
462 count = EEPROM_SIZE - off;
464 for (i = 0; i < count; i++) {
465 ec_byte = EEPROM_START + off + i;
466 ret = olpc_ec_cmd(EC_BAT_EEPROM, &ec_byte, 1, &buf[i], 1);
468 pr_err("olpc-battery: "
469 "EC_BAT_EEPROM cmd @ 0x%x failed - %d!\n",
478 static struct bin_attribute olpc_bat_eeprom = {
484 .read = olpc_bat_eeprom_read,
487 /* Allow userspace to see the specific error value pulled from the EC */
489 static ssize_t olpc_bat_error_read(struct device *dev,
490 struct device_attribute *attr, char *buf)
495 ret = olpc_ec_cmd(EC_BAT_ERRCODE, NULL, 0, &ec_byte, 1);
499 return sprintf(buf, "%d\n", ec_byte);
502 static struct device_attribute olpc_bat_error = {
507 .show = olpc_bat_error_read,
510 /*********************************************************************
512 *********************************************************************/
514 static struct platform_device *bat_pdev;
516 static struct power_supply olpc_bat = {
517 .get_property = olpc_bat_get_property,
521 void olpc_battery_trigger_uevent(unsigned long cause)
523 if (cause & EC_SCI_SRC_ACPWR)
524 kobject_uevent(&olpc_ac.dev->kobj, KOBJ_CHANGE);
525 if (cause & (EC_SCI_SRC_BATERR|EC_SCI_SRC_BATSOC|EC_SCI_SRC_BATTERY))
526 kobject_uevent(&olpc_bat.dev->kobj, KOBJ_CHANGE);
529 static int __init olpc_bat_init(void)
534 if (!olpc_platform_info.ecver)
538 * We've seen a number of EC protocol changes; this driver requires
539 * the latest EC protocol, supported by 0x44 and above.
541 if (olpc_platform_info.ecver < 0x44) {
542 printk(KERN_NOTICE "OLPC EC version 0x%02x too old for "
543 "battery driver.\n", olpc_platform_info.ecver);
547 ret = olpc_ec_cmd(EC_BAT_STATUS, NULL, 0, &status, 1);
551 /* Ignore the status. It doesn't actually matter */
553 bat_pdev = platform_device_register_simple("olpc-battery", 0, NULL, 0);
554 if (IS_ERR(bat_pdev))
555 return PTR_ERR(bat_pdev);
557 ret = power_supply_register(&bat_pdev->dev, &olpc_ac);
561 olpc_bat.name = bat_pdev->name;
562 if (olpc_board_at_least(olpc_board_pre(0xd0))) { /* XO-1.5 */
563 olpc_bat.properties = olpc_xo15_bat_props;
564 olpc_bat.num_properties = ARRAY_SIZE(olpc_xo15_bat_props);
566 olpc_bat.properties = olpc_xo1_bat_props;
567 olpc_bat.num_properties = ARRAY_SIZE(olpc_xo1_bat_props);
570 ret = power_supply_register(&bat_pdev->dev, &olpc_bat);
574 ret = device_create_bin_file(olpc_bat.dev, &olpc_bat_eeprom);
578 ret = device_create_file(olpc_bat.dev, &olpc_bat_error);
585 device_remove_bin_file(olpc_bat.dev, &olpc_bat_eeprom);
587 power_supply_unregister(&olpc_bat);
589 power_supply_unregister(&olpc_ac);
591 platform_device_unregister(bat_pdev);
596 static void __exit olpc_bat_exit(void)
598 device_remove_file(olpc_bat.dev, &olpc_bat_error);
599 device_remove_bin_file(olpc_bat.dev, &olpc_bat_eeprom);
600 power_supply_unregister(&olpc_bat);
601 power_supply_unregister(&olpc_ac);
602 platform_device_unregister(bat_pdev);
605 module_init(olpc_bat_init);
606 module_exit(olpc_bat_exit);
608 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
609 MODULE_LICENSE("GPL");
610 MODULE_DESCRIPTION("Battery driver for One Laptop Per Child 'XO' machine");