1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * sbs.c - ACPI Smart Battery System Driver ($Revision: 2.0 $)
5 * Copyright (c) 2007 Alexey Starikovskiy <astarikovskiy@suse.de>
6 * Copyright (c) 2005-2007 Vladimir Lebedev <vladimir.p.lebedev@intel.com>
7 * Copyright (c) 2005 Rich Townsend <rhdt@bartol.udel.edu>
10 #include <linux/init.h>
11 #include <linux/slab.h>
12 #include <linux/module.h>
13 #include <linux/moduleparam.h>
14 #include <linux/kernel.h>
16 #include <linux/acpi.h>
17 #include <linux/timer.h>
18 #include <linux/jiffies.h>
19 #include <linux/delay.h>
20 #include <linux/power_supply.h>
21 #include <linux/platform_data/x86/apple.h>
22 #include <acpi/battery.h>
26 #define PREFIX "ACPI: "
28 #define ACPI_SBS_CLASS "sbs"
29 #define ACPI_AC_CLASS "ac_adapter"
30 #define ACPI_SBS_DEVICE_NAME "Smart Battery System"
31 #define ACPI_BATTERY_DIR_NAME "BAT%i"
32 #define ACPI_AC_DIR_NAME "AC0"
34 #define ACPI_SBS_NOTIFY_STATUS 0x80
35 #define ACPI_SBS_NOTIFY_INFO 0x81
37 MODULE_AUTHOR("Alexey Starikovskiy <astarikovskiy@suse.de>");
38 MODULE_DESCRIPTION("Smart Battery System ACPI interface driver");
39 MODULE_LICENSE("GPL");
41 static unsigned int cache_time = 1000;
42 module_param(cache_time, uint, 0644);
43 MODULE_PARM_DESC(cache_time, "cache time in milliseconds");
46 #define ACPI_SBS_BLOCK_MAX 32
48 static const struct acpi_device_id sbs_device_ids[] = {
52 MODULE_DEVICE_TABLE(acpi, sbs_device_ids);
55 struct power_supply *bat;
56 struct power_supply_desc bat_desc;
58 unsigned long update_time;
60 char manufacturer_name[ACPI_SBS_BLOCK_MAX];
61 char device_name[ACPI_SBS_BLOCK_MAX];
62 char device_chemistry[ACPI_SBS_BLOCK_MAX];
64 u16 full_charge_capacity;
80 u8 have_sysfs_alarm:1;
83 #define to_acpi_battery(x) power_supply_get_drvdata(x)
86 struct power_supply *charger;
87 struct acpi_device *device;
88 struct acpi_smb_hc *hc;
90 struct acpi_battery battery[MAX_SBS_BAT];
91 u8 batteries_supported:4;
97 #define to_acpi_sbs(x) power_supply_get_drvdata(x)
99 static int acpi_sbs_remove(struct acpi_device *device);
100 static int acpi_battery_get_state(struct acpi_battery *battery);
102 static inline int battery_scale(int log)
110 static inline int acpi_battery_vscale(struct acpi_battery *battery)
112 return battery_scale((battery->spec & 0x0f00) >> 8);
115 static inline int acpi_battery_ipscale(struct acpi_battery *battery)
117 return battery_scale((battery->spec & 0xf000) >> 12);
120 static inline int acpi_battery_mode(struct acpi_battery *battery)
122 return (battery->mode & 0x8000);
125 static inline int acpi_battery_scale(struct acpi_battery *battery)
127 return (acpi_battery_mode(battery) ? 10 : 1) *
128 acpi_battery_ipscale(battery);
131 static int sbs_get_ac_property(struct power_supply *psy,
132 enum power_supply_property psp,
133 union power_supply_propval *val)
135 struct acpi_sbs *sbs = to_acpi_sbs(psy);
137 case POWER_SUPPLY_PROP_ONLINE:
138 val->intval = sbs->charger_present;
146 static int acpi_battery_technology(struct acpi_battery *battery)
148 if (!strcasecmp("NiCd", battery->device_chemistry))
149 return POWER_SUPPLY_TECHNOLOGY_NiCd;
150 if (!strcasecmp("NiMH", battery->device_chemistry))
151 return POWER_SUPPLY_TECHNOLOGY_NiMH;
152 if (!strcasecmp("LION", battery->device_chemistry))
153 return POWER_SUPPLY_TECHNOLOGY_LION;
154 if (!strcasecmp("LiP", battery->device_chemistry))
155 return POWER_SUPPLY_TECHNOLOGY_LIPO;
156 return POWER_SUPPLY_TECHNOLOGY_UNKNOWN;
159 static int acpi_sbs_battery_get_property(struct power_supply *psy,
160 enum power_supply_property psp,
161 union power_supply_propval *val)
163 struct acpi_battery *battery = to_acpi_battery(psy);
165 if ((!battery->present) && psp != POWER_SUPPLY_PROP_PRESENT)
168 acpi_battery_get_state(battery);
170 case POWER_SUPPLY_PROP_STATUS:
171 if (battery->rate_now < 0)
172 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
173 else if (battery->rate_now > 0)
174 val->intval = POWER_SUPPLY_STATUS_CHARGING;
176 val->intval = POWER_SUPPLY_STATUS_FULL;
178 case POWER_SUPPLY_PROP_PRESENT:
179 val->intval = battery->present;
181 case POWER_SUPPLY_PROP_TECHNOLOGY:
182 val->intval = acpi_battery_technology(battery);
184 case POWER_SUPPLY_PROP_CYCLE_COUNT:
185 val->intval = battery->cycle_count;
187 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
188 val->intval = battery->design_voltage *
189 acpi_battery_vscale(battery) * 1000;
191 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
192 val->intval = battery->voltage_now *
193 acpi_battery_vscale(battery) * 1000;
195 case POWER_SUPPLY_PROP_CURRENT_NOW:
196 case POWER_SUPPLY_PROP_POWER_NOW:
197 val->intval = abs(battery->rate_now) *
198 acpi_battery_ipscale(battery) * 1000;
199 val->intval *= (acpi_battery_mode(battery)) ?
200 (battery->voltage_now *
201 acpi_battery_vscale(battery) / 1000) : 1;
203 case POWER_SUPPLY_PROP_CURRENT_AVG:
204 case POWER_SUPPLY_PROP_POWER_AVG:
205 val->intval = abs(battery->rate_avg) *
206 acpi_battery_ipscale(battery) * 1000;
207 val->intval *= (acpi_battery_mode(battery)) ?
208 (battery->voltage_now *
209 acpi_battery_vscale(battery) / 1000) : 1;
211 case POWER_SUPPLY_PROP_CAPACITY:
212 val->intval = battery->state_of_charge;
214 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
215 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
216 val->intval = battery->design_capacity *
217 acpi_battery_scale(battery) * 1000;
219 case POWER_SUPPLY_PROP_CHARGE_FULL:
220 case POWER_SUPPLY_PROP_ENERGY_FULL:
221 val->intval = battery->full_charge_capacity *
222 acpi_battery_scale(battery) * 1000;
224 case POWER_SUPPLY_PROP_CHARGE_NOW:
225 case POWER_SUPPLY_PROP_ENERGY_NOW:
226 val->intval = battery->capacity_now *
227 acpi_battery_scale(battery) * 1000;
229 case POWER_SUPPLY_PROP_TEMP:
230 val->intval = battery->temp_now - 2730; // dK -> dC
232 case POWER_SUPPLY_PROP_MODEL_NAME:
233 val->strval = battery->device_name;
235 case POWER_SUPPLY_PROP_MANUFACTURER:
236 val->strval = battery->manufacturer_name;
244 static enum power_supply_property sbs_ac_props[] = {
245 POWER_SUPPLY_PROP_ONLINE,
248 static enum power_supply_property sbs_charge_battery_props[] = {
249 POWER_SUPPLY_PROP_STATUS,
250 POWER_SUPPLY_PROP_PRESENT,
251 POWER_SUPPLY_PROP_TECHNOLOGY,
252 POWER_SUPPLY_PROP_CYCLE_COUNT,
253 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
254 POWER_SUPPLY_PROP_VOLTAGE_NOW,
255 POWER_SUPPLY_PROP_CURRENT_NOW,
256 POWER_SUPPLY_PROP_CURRENT_AVG,
257 POWER_SUPPLY_PROP_CAPACITY,
258 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
259 POWER_SUPPLY_PROP_CHARGE_FULL,
260 POWER_SUPPLY_PROP_CHARGE_NOW,
261 POWER_SUPPLY_PROP_TEMP,
262 POWER_SUPPLY_PROP_MODEL_NAME,
263 POWER_SUPPLY_PROP_MANUFACTURER,
266 static enum power_supply_property sbs_energy_battery_props[] = {
267 POWER_SUPPLY_PROP_STATUS,
268 POWER_SUPPLY_PROP_PRESENT,
269 POWER_SUPPLY_PROP_TECHNOLOGY,
270 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
271 POWER_SUPPLY_PROP_VOLTAGE_NOW,
272 POWER_SUPPLY_PROP_CURRENT_NOW,
273 POWER_SUPPLY_PROP_CURRENT_AVG,
274 POWER_SUPPLY_PROP_POWER_NOW,
275 POWER_SUPPLY_PROP_POWER_AVG,
276 POWER_SUPPLY_PROP_CAPACITY,
277 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
278 POWER_SUPPLY_PROP_ENERGY_FULL,
279 POWER_SUPPLY_PROP_ENERGY_NOW,
280 POWER_SUPPLY_PROP_TEMP,
281 POWER_SUPPLY_PROP_MODEL_NAME,
282 POWER_SUPPLY_PROP_MANUFACTURER,
285 static const struct power_supply_desc acpi_sbs_charger_desc = {
286 .name = "sbs-charger",
287 .type = POWER_SUPPLY_TYPE_MAINS,
288 .properties = sbs_ac_props,
289 .num_properties = ARRAY_SIZE(sbs_ac_props),
290 .get_property = sbs_get_ac_property,
293 /* --------------------------------------------------------------------------
294 Smart Battery System Management
295 -------------------------------------------------------------------------- */
297 struct acpi_battery_reader {
298 u8 command; /* command for battery */
299 u8 mode; /* word or block? */
300 size_t offset; /* offset inside struct acpi_sbs_battery */
303 static struct acpi_battery_reader info_readers[] = {
304 {0x01, SMBUS_READ_WORD, offsetof(struct acpi_battery, alarm_capacity)},
305 {0x03, SMBUS_READ_WORD, offsetof(struct acpi_battery, mode)},
306 {0x10, SMBUS_READ_WORD, offsetof(struct acpi_battery, full_charge_capacity)},
307 {0x17, SMBUS_READ_WORD, offsetof(struct acpi_battery, cycle_count)},
308 {0x18, SMBUS_READ_WORD, offsetof(struct acpi_battery, design_capacity)},
309 {0x19, SMBUS_READ_WORD, offsetof(struct acpi_battery, design_voltage)},
310 {0x1a, SMBUS_READ_WORD, offsetof(struct acpi_battery, spec)},
311 {0x1c, SMBUS_READ_WORD, offsetof(struct acpi_battery, serial_number)},
312 {0x20, SMBUS_READ_BLOCK, offsetof(struct acpi_battery, manufacturer_name)},
313 {0x21, SMBUS_READ_BLOCK, offsetof(struct acpi_battery, device_name)},
314 {0x22, SMBUS_READ_BLOCK, offsetof(struct acpi_battery, device_chemistry)},
317 static struct acpi_battery_reader state_readers[] = {
318 {0x08, SMBUS_READ_WORD, offsetof(struct acpi_battery, temp_now)},
319 {0x09, SMBUS_READ_WORD, offsetof(struct acpi_battery, voltage_now)},
320 {0x0a, SMBUS_READ_WORD, offsetof(struct acpi_battery, rate_now)},
321 {0x0b, SMBUS_READ_WORD, offsetof(struct acpi_battery, rate_avg)},
322 {0x0f, SMBUS_READ_WORD, offsetof(struct acpi_battery, capacity_now)},
323 {0x0e, SMBUS_READ_WORD, offsetof(struct acpi_battery, state_of_charge)},
324 {0x16, SMBUS_READ_WORD, offsetof(struct acpi_battery, state)},
327 static int acpi_manager_get_info(struct acpi_sbs *sbs)
330 u16 battery_system_info;
332 result = acpi_smbus_read(sbs->hc, SMBUS_READ_WORD, ACPI_SBS_MANAGER,
333 0x04, (u8 *)&battery_system_info);
335 sbs->batteries_supported = battery_system_info & 0x000f;
339 static int acpi_battery_get_info(struct acpi_battery *battery)
343 for (i = 0; i < ARRAY_SIZE(info_readers); ++i) {
344 result = acpi_smbus_read(battery->sbs->hc,
345 info_readers[i].mode,
347 info_readers[i].command,
349 info_readers[i].offset);
356 static int acpi_battery_get_state(struct acpi_battery *battery)
360 if (battery->update_time &&
361 time_before(jiffies, battery->update_time +
362 msecs_to_jiffies(cache_time)))
364 for (i = 0; i < ARRAY_SIZE(state_readers); ++i) {
365 result = acpi_smbus_read(battery->sbs->hc,
366 state_readers[i].mode,
368 state_readers[i].command,
370 state_readers[i].offset);
375 battery->update_time = jiffies;
379 static int acpi_battery_get_alarm(struct acpi_battery *battery)
381 return acpi_smbus_read(battery->sbs->hc, SMBUS_READ_WORD,
382 ACPI_SBS_BATTERY, 0x01,
383 (u8 *)&battery->alarm_capacity);
386 static int acpi_battery_set_alarm(struct acpi_battery *battery)
388 struct acpi_sbs *sbs = battery->sbs;
389 u16 value, sel = 1 << (battery->id + 12);
394 if (sbs->manager_present) {
395 ret = acpi_smbus_read(sbs->hc, SMBUS_READ_WORD, ACPI_SBS_MANAGER,
399 if ((value & 0xf000) != sel) {
402 ret = acpi_smbus_write(sbs->hc, SMBUS_WRITE_WORD,
404 0x01, (u8 *)&value, 2);
409 ret = acpi_smbus_write(sbs->hc, SMBUS_WRITE_WORD, ACPI_SBS_BATTERY,
410 0x01, (u8 *)&battery->alarm_capacity, 2);
415 static int acpi_ac_get_present(struct acpi_sbs *sbs)
420 result = acpi_smbus_read(sbs->hc, SMBUS_READ_WORD, ACPI_SBS_CHARGER,
421 0x13, (u8 *) & status);
427 * The spec requires that bit 4 always be 1. If it's not set, assume
428 * that the implementation doesn't support an SBS charger.
430 * And on some MacBooks a status of 0xffff is always returned, no
431 * matter whether the charger is plugged in or not, which is also
432 * wrong, so ignore the SBS charger for those too.
434 if (!((status >> 4) & 0x1) || status == 0xffff)
437 sbs->charger_present = (status >> 15) & 0x1;
441 static ssize_t acpi_battery_alarm_show(struct device *dev,
442 struct device_attribute *attr,
445 struct acpi_battery *battery = to_acpi_battery(dev_get_drvdata(dev));
446 acpi_battery_get_alarm(battery);
447 return sprintf(buf, "%d\n", battery->alarm_capacity *
448 acpi_battery_scale(battery) * 1000);
451 static ssize_t acpi_battery_alarm_store(struct device *dev,
452 struct device_attribute *attr,
453 const char *buf, size_t count)
456 struct acpi_battery *battery = to_acpi_battery(dev_get_drvdata(dev));
457 if (sscanf(buf, "%lu\n", &x) == 1)
458 battery->alarm_capacity = x /
459 (1000 * acpi_battery_scale(battery));
460 if (battery->present)
461 acpi_battery_set_alarm(battery);
465 static const struct device_attribute alarm_attr = {
466 .attr = {.name = "alarm", .mode = 0644},
467 .show = acpi_battery_alarm_show,
468 .store = acpi_battery_alarm_store,
471 /* --------------------------------------------------------------------------
473 -------------------------------------------------------------------------- */
474 static int acpi_battery_read(struct acpi_battery *battery)
476 int result = 0, saved_present = battery->present;
479 if (battery->sbs->manager_present) {
480 result = acpi_smbus_read(battery->sbs->hc, SMBUS_READ_WORD,
481 ACPI_SBS_MANAGER, 0x01, (u8 *)&state);
483 battery->present = state & (1 << battery->id);
485 state |= 1 << (battery->id + 12);
486 acpi_smbus_write(battery->sbs->hc, SMBUS_WRITE_WORD,
487 ACPI_SBS_MANAGER, 0x01, (u8 *)&state, 2);
488 } else if (battery->id == 0)
489 battery->present = 1;
491 if (result || !battery->present)
494 if (saved_present != battery->present) {
495 battery->update_time = 0;
496 result = acpi_battery_get_info(battery);
498 battery->present = 0;
502 result = acpi_battery_get_state(battery);
504 battery->present = 0;
509 static int acpi_battery_add(struct acpi_sbs *sbs, int id)
511 struct acpi_battery *battery = &sbs->battery[id];
512 struct power_supply_config psy_cfg = { .drv_data = battery, };
517 result = acpi_battery_read(battery);
521 sprintf(battery->name, ACPI_BATTERY_DIR_NAME, id);
522 battery->bat_desc.name = battery->name;
523 battery->bat_desc.type = POWER_SUPPLY_TYPE_BATTERY;
524 if (!acpi_battery_mode(battery)) {
525 battery->bat_desc.properties = sbs_charge_battery_props;
526 battery->bat_desc.num_properties =
527 ARRAY_SIZE(sbs_charge_battery_props);
529 battery->bat_desc.properties = sbs_energy_battery_props;
530 battery->bat_desc.num_properties =
531 ARRAY_SIZE(sbs_energy_battery_props);
533 battery->bat_desc.get_property = acpi_sbs_battery_get_property;
534 battery->bat = power_supply_register(&sbs->device->dev,
535 &battery->bat_desc, &psy_cfg);
536 if (IS_ERR(battery->bat)) {
537 result = PTR_ERR(battery->bat);
542 result = device_create_file(&battery->bat->dev, &alarm_attr);
545 battery->have_sysfs_alarm = 1;
547 printk(KERN_INFO PREFIX "%s [%s]: Battery Slot [%s] (battery %s)\n",
548 ACPI_SBS_DEVICE_NAME, acpi_device_bid(sbs->device),
549 battery->name, battery->present ? "present" : "absent");
553 static void acpi_battery_remove(struct acpi_sbs *sbs, int id)
555 struct acpi_battery *battery = &sbs->battery[id];
558 if (battery->have_sysfs_alarm)
559 device_remove_file(&battery->bat->dev, &alarm_attr);
560 power_supply_unregister(battery->bat);
564 static int acpi_charger_add(struct acpi_sbs *sbs)
567 struct power_supply_config psy_cfg = { .drv_data = sbs, };
569 result = acpi_ac_get_present(sbs);
573 sbs->charger_exists = 1;
574 sbs->charger = power_supply_register(&sbs->device->dev,
575 &acpi_sbs_charger_desc, &psy_cfg);
576 if (IS_ERR(sbs->charger)) {
577 result = PTR_ERR(sbs->charger);
580 printk(KERN_INFO PREFIX "%s [%s]: AC Adapter [%s] (%s)\n",
581 ACPI_SBS_DEVICE_NAME, acpi_device_bid(sbs->device),
582 ACPI_AC_DIR_NAME, sbs->charger_present ? "on-line" : "off-line");
587 static void acpi_charger_remove(struct acpi_sbs *sbs)
590 power_supply_unregister(sbs->charger);
593 static void acpi_sbs_callback(void *context)
596 struct acpi_sbs *sbs = context;
597 struct acpi_battery *bat;
598 u8 saved_charger_state = sbs->charger_present;
599 u8 saved_battery_state;
601 if (sbs->charger_exists) {
602 acpi_ac_get_present(sbs);
603 if (sbs->charger_present != saved_charger_state)
604 kobject_uevent(&sbs->charger->dev.kobj, KOBJ_CHANGE);
607 if (sbs->manager_present) {
608 for (id = 0; id < MAX_SBS_BAT; ++id) {
609 if (!(sbs->batteries_supported & (1 << id)))
611 bat = &sbs->battery[id];
612 saved_battery_state = bat->present;
613 acpi_battery_read(bat);
614 if (saved_battery_state == bat->present)
616 kobject_uevent(&bat->bat->dev.kobj, KOBJ_CHANGE);
621 static int acpi_sbs_add(struct acpi_device *device)
623 struct acpi_sbs *sbs;
627 sbs = kzalloc(sizeof(struct acpi_sbs), GFP_KERNEL);
633 mutex_init(&sbs->lock);
635 sbs->hc = acpi_driver_data(device->parent);
636 sbs->device = device;
637 strcpy(acpi_device_name(device), ACPI_SBS_DEVICE_NAME);
638 strcpy(acpi_device_class(device), ACPI_SBS_CLASS);
639 device->driver_data = sbs;
641 result = acpi_charger_add(sbs);
642 if (result && result != -ENODEV)
647 if (!x86_apple_machine) {
648 result = acpi_manager_get_info(sbs);
650 sbs->manager_present = 1;
651 for (id = 0; id < MAX_SBS_BAT; ++id)
652 if ((sbs->batteries_supported & (1 << id)))
653 acpi_battery_add(sbs, id);
657 if (!sbs->manager_present)
658 acpi_battery_add(sbs, 0);
660 acpi_smbus_register_callback(sbs->hc, acpi_sbs_callback, sbs);
663 acpi_sbs_remove(device);
667 static int acpi_sbs_remove(struct acpi_device *device)
669 struct acpi_sbs *sbs;
674 sbs = acpi_driver_data(device);
677 mutex_lock(&sbs->lock);
678 acpi_smbus_unregister_callback(sbs->hc);
679 for (id = 0; id < MAX_SBS_BAT; ++id)
680 acpi_battery_remove(sbs, id);
681 acpi_charger_remove(sbs);
682 mutex_unlock(&sbs->lock);
683 mutex_destroy(&sbs->lock);
688 #ifdef CONFIG_PM_SLEEP
689 static int acpi_sbs_resume(struct device *dev)
691 struct acpi_sbs *sbs;
694 sbs = to_acpi_device(dev)->driver_data;
695 acpi_sbs_callback(sbs);
699 #define acpi_sbs_resume NULL
702 static SIMPLE_DEV_PM_OPS(acpi_sbs_pm, NULL, acpi_sbs_resume);
704 static struct acpi_driver acpi_sbs_driver = {
706 .class = ACPI_SBS_CLASS,
707 .ids = sbs_device_ids,
710 .remove = acpi_sbs_remove,
712 .drv.pm = &acpi_sbs_pm,
715 static int __init acpi_sbs_init(void)
722 result = acpi_bus_register_driver(&acpi_sbs_driver);
729 static void __exit acpi_sbs_exit(void)
731 acpi_bus_unregister_driver(&acpi_sbs_driver);
735 module_init(acpi_sbs_init);
736 module_exit(acpi_sbs_exit);