1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * battery.c - ACPI Battery Driver (Revision: 2.0)
5 * Copyright (C) 2007 Alexey Starikovskiy <astarikovskiy@suse.de>
6 * Copyright (C) 2004-2007 Vladimir Lebedev <vladimir.p.lebedev@intel.com>
7 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
8 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
11 #define pr_fmt(fmt) "ACPI: battery: " fmt
13 #include <linux/async.h>
14 #include <linux/delay.h>
15 #include <linux/dmi.h>
16 #include <linux/jiffies.h>
17 #include <linux/kernel.h>
18 #include <linux/list.h>
19 #include <linux/module.h>
20 #include <linux/mutex.h>
21 #include <linux/slab.h>
22 #include <linux/suspend.h>
23 #include <linux/types.h>
25 #include <asm/unaligned.h>
27 #include <linux/acpi.h>
28 #include <linux/power_supply.h>
30 #include <acpi/battery.h>
32 #define ACPI_BATTERY_VALUE_UNKNOWN 0xFFFFFFFF
33 #define ACPI_BATTERY_CAPACITY_VALID(capacity) \
34 ((capacity) != 0 && (capacity) != ACPI_BATTERY_VALUE_UNKNOWN)
36 #define ACPI_BATTERY_DEVICE_NAME "Battery"
38 /* Battery power unit: 0 means mW, 1 means mA */
39 #define ACPI_BATTERY_POWER_UNIT_MA 1
41 #define ACPI_BATTERY_STATE_DISCHARGING 0x1
42 #define ACPI_BATTERY_STATE_CHARGING 0x2
43 #define ACPI_BATTERY_STATE_CRITICAL 0x4
45 MODULE_AUTHOR("Paul Diefenbaugh");
46 MODULE_AUTHOR("Alexey Starikovskiy <astarikovskiy@suse.de>");
47 MODULE_DESCRIPTION("ACPI Battery Driver");
48 MODULE_LICENSE("GPL");
50 static async_cookie_t async_cookie;
51 static bool battery_driver_registered;
52 static int battery_bix_broken_package;
53 static int battery_notification_delay_ms;
54 static int battery_ac_is_broken;
55 static int battery_check_pmic = 1;
56 static unsigned int cache_time = 1000;
57 module_param(cache_time, uint, 0644);
58 MODULE_PARM_DESC(cache_time, "cache time in milliseconds");
60 static const struct acpi_device_id battery_device_ids[] = {
65 MODULE_DEVICE_TABLE(acpi, battery_device_ids);
67 /* Lists of PMIC ACPI HIDs with an (often better) native battery driver */
68 static const char * const acpi_battery_blacklist[] = {
69 "INT33F4", /* X-Powers AXP288 PMIC */
73 ACPI_BATTERY_ALARM_PRESENT,
74 ACPI_BATTERY_XINFO_PRESENT,
75 ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY,
76 /* On Lenovo Thinkpad models from 2010 and 2011, the power unit
77 * switches between mWh and mAh depending on whether the system
78 * is running on battery or not. When mAh is the unit, most
79 * reported values are incorrect and need to be adjusted by
80 * 10000/design_voltage. Verified on x201, t410, t410s, and x220.
81 * Pre-2010 and 2012 models appear to always report in mWh and
82 * are thus unaffected (tested with t42, t61, t500, x200, x300,
83 * and x230). Also, in mid-2012 Lenovo issued a BIOS update for
84 * the 2011 models that fixes the issue (tested on x220 with a
85 * post-1.29 BIOS), but as of Nov. 2012, no such update is
86 * available for the 2010 models.
88 ACPI_BATTERY_QUIRK_THINKPAD_MAH,
89 /* for batteries reporting current capacity with design capacity
90 * on a full charge, but showing degradation in full charge cap.
92 ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE,
97 struct mutex sysfs_lock;
98 struct power_supply *bat;
99 struct power_supply_desc bat_desc;
100 struct acpi_device *device;
101 struct notifier_block pm_nb;
102 struct list_head list;
103 unsigned long update_time;
109 int full_charge_capacity;
112 int design_capacity_warning;
113 int design_capacity_low;
115 int measurement_accuracy;
116 int max_sampling_time;
117 int min_sampling_time;
118 int max_averaging_interval;
119 int min_averaging_interval;
120 int capacity_granularity_1;
121 int capacity_granularity_2;
123 char model_number[32];
124 char serial_number[32];
132 #define to_acpi_battery(x) power_supply_get_drvdata(x)
134 static inline int acpi_battery_present(struct acpi_battery *battery)
136 return battery->device->status.battery_present;
139 static int acpi_battery_technology(struct acpi_battery *battery)
141 if (!strcasecmp("NiCd", battery->type))
142 return POWER_SUPPLY_TECHNOLOGY_NiCd;
143 if (!strcasecmp("NiMH", battery->type))
144 return POWER_SUPPLY_TECHNOLOGY_NiMH;
145 if (!strcasecmp("LION", battery->type))
146 return POWER_SUPPLY_TECHNOLOGY_LION;
147 if (!strncasecmp("LI-ION", battery->type, 6))
148 return POWER_SUPPLY_TECHNOLOGY_LION;
149 if (!strcasecmp("LiP", battery->type))
150 return POWER_SUPPLY_TECHNOLOGY_LIPO;
151 return POWER_SUPPLY_TECHNOLOGY_UNKNOWN;
154 static int acpi_battery_get_state(struct acpi_battery *battery);
156 static int acpi_battery_is_charged(struct acpi_battery *battery)
158 /* charging, discharging or critical low */
159 if (battery->state != 0)
162 /* battery not reporting charge */
163 if (battery->capacity_now == ACPI_BATTERY_VALUE_UNKNOWN ||
164 battery->capacity_now == 0)
167 /* good batteries update full_charge as the batteries degrade */
168 if (battery->full_charge_capacity == battery->capacity_now)
171 /* fallback to using design values for broken batteries */
172 if (battery->design_capacity == battery->capacity_now)
175 /* we don't do any sort of metric based on percentages */
179 static bool acpi_battery_is_degraded(struct acpi_battery *battery)
181 return ACPI_BATTERY_CAPACITY_VALID(battery->full_charge_capacity) &&
182 ACPI_BATTERY_CAPACITY_VALID(battery->design_capacity) &&
183 battery->full_charge_capacity < battery->design_capacity;
186 static int acpi_battery_handle_discharging(struct acpi_battery *battery)
189 * Some devices wrongly report discharging if the battery's charge level
190 * was above the device's start charging threshold atm the AC adapter
191 * was plugged in and the device thus did not start a new charge cycle.
193 if ((battery_ac_is_broken || power_supply_is_system_supplied()) &&
194 battery->rate_now == 0)
195 return POWER_SUPPLY_STATUS_NOT_CHARGING;
197 return POWER_SUPPLY_STATUS_DISCHARGING;
200 static int acpi_battery_get_property(struct power_supply *psy,
201 enum power_supply_property psp,
202 union power_supply_propval *val)
204 int full_capacity = ACPI_BATTERY_VALUE_UNKNOWN, ret = 0;
205 struct acpi_battery *battery = to_acpi_battery(psy);
207 if (acpi_battery_present(battery)) {
208 /* run battery update only if it is present */
209 acpi_battery_get_state(battery);
210 } else if (psp != POWER_SUPPLY_PROP_PRESENT)
213 case POWER_SUPPLY_PROP_STATUS:
214 if (battery->state & ACPI_BATTERY_STATE_DISCHARGING)
215 val->intval = acpi_battery_handle_discharging(battery);
216 else if (battery->state & ACPI_BATTERY_STATE_CHARGING)
217 val->intval = POWER_SUPPLY_STATUS_CHARGING;
218 else if (acpi_battery_is_charged(battery))
219 val->intval = POWER_SUPPLY_STATUS_FULL;
221 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
223 case POWER_SUPPLY_PROP_PRESENT:
224 val->intval = acpi_battery_present(battery);
226 case POWER_SUPPLY_PROP_TECHNOLOGY:
227 val->intval = acpi_battery_technology(battery);
229 case POWER_SUPPLY_PROP_CYCLE_COUNT:
230 val->intval = battery->cycle_count;
232 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
233 if (battery->design_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
236 val->intval = battery->design_voltage * 1000;
238 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
239 if (battery->voltage_now == ACPI_BATTERY_VALUE_UNKNOWN)
242 val->intval = battery->voltage_now * 1000;
244 case POWER_SUPPLY_PROP_CURRENT_NOW:
245 case POWER_SUPPLY_PROP_POWER_NOW:
246 if (battery->rate_now == ACPI_BATTERY_VALUE_UNKNOWN)
249 val->intval = battery->rate_now * 1000;
251 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
252 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
253 if (!ACPI_BATTERY_CAPACITY_VALID(battery->design_capacity))
256 val->intval = battery->design_capacity * 1000;
258 case POWER_SUPPLY_PROP_CHARGE_FULL:
259 case POWER_SUPPLY_PROP_ENERGY_FULL:
260 if (!ACPI_BATTERY_CAPACITY_VALID(battery->full_charge_capacity))
263 val->intval = battery->full_charge_capacity * 1000;
265 case POWER_SUPPLY_PROP_CHARGE_NOW:
266 case POWER_SUPPLY_PROP_ENERGY_NOW:
267 if (battery->capacity_now == ACPI_BATTERY_VALUE_UNKNOWN)
270 val->intval = battery->capacity_now * 1000;
272 case POWER_SUPPLY_PROP_CAPACITY:
273 if (ACPI_BATTERY_CAPACITY_VALID(battery->full_charge_capacity))
274 full_capacity = battery->full_charge_capacity;
275 else if (ACPI_BATTERY_CAPACITY_VALID(battery->design_capacity))
276 full_capacity = battery->design_capacity;
278 if (battery->capacity_now == ACPI_BATTERY_VALUE_UNKNOWN ||
279 full_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
282 val->intval = battery->capacity_now * 100/
285 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
286 if (battery->state & ACPI_BATTERY_STATE_CRITICAL)
287 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
288 else if (test_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags) &&
289 (battery->capacity_now <= battery->alarm))
290 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
291 else if (acpi_battery_is_charged(battery))
292 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
294 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
296 case POWER_SUPPLY_PROP_MODEL_NAME:
297 val->strval = battery->model_number;
299 case POWER_SUPPLY_PROP_MANUFACTURER:
300 val->strval = battery->oem_info;
302 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
303 val->strval = battery->serial_number;
311 static enum power_supply_property charge_battery_props[] = {
312 POWER_SUPPLY_PROP_STATUS,
313 POWER_SUPPLY_PROP_PRESENT,
314 POWER_SUPPLY_PROP_TECHNOLOGY,
315 POWER_SUPPLY_PROP_CYCLE_COUNT,
316 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
317 POWER_SUPPLY_PROP_VOLTAGE_NOW,
318 POWER_SUPPLY_PROP_CURRENT_NOW,
319 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
320 POWER_SUPPLY_PROP_CHARGE_FULL,
321 POWER_SUPPLY_PROP_CHARGE_NOW,
322 POWER_SUPPLY_PROP_CAPACITY,
323 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
324 POWER_SUPPLY_PROP_MODEL_NAME,
325 POWER_SUPPLY_PROP_MANUFACTURER,
326 POWER_SUPPLY_PROP_SERIAL_NUMBER,
329 static enum power_supply_property charge_battery_full_cap_broken_props[] = {
330 POWER_SUPPLY_PROP_STATUS,
331 POWER_SUPPLY_PROP_PRESENT,
332 POWER_SUPPLY_PROP_TECHNOLOGY,
333 POWER_SUPPLY_PROP_CYCLE_COUNT,
334 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
335 POWER_SUPPLY_PROP_VOLTAGE_NOW,
336 POWER_SUPPLY_PROP_CURRENT_NOW,
337 POWER_SUPPLY_PROP_CHARGE_NOW,
338 POWER_SUPPLY_PROP_MODEL_NAME,
339 POWER_SUPPLY_PROP_MANUFACTURER,
340 POWER_SUPPLY_PROP_SERIAL_NUMBER,
343 static enum power_supply_property energy_battery_props[] = {
344 POWER_SUPPLY_PROP_STATUS,
345 POWER_SUPPLY_PROP_PRESENT,
346 POWER_SUPPLY_PROP_TECHNOLOGY,
347 POWER_SUPPLY_PROP_CYCLE_COUNT,
348 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
349 POWER_SUPPLY_PROP_VOLTAGE_NOW,
350 POWER_SUPPLY_PROP_POWER_NOW,
351 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
352 POWER_SUPPLY_PROP_ENERGY_FULL,
353 POWER_SUPPLY_PROP_ENERGY_NOW,
354 POWER_SUPPLY_PROP_CAPACITY,
355 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
356 POWER_SUPPLY_PROP_MODEL_NAME,
357 POWER_SUPPLY_PROP_MANUFACTURER,
358 POWER_SUPPLY_PROP_SERIAL_NUMBER,
361 static enum power_supply_property energy_battery_full_cap_broken_props[] = {
362 POWER_SUPPLY_PROP_STATUS,
363 POWER_SUPPLY_PROP_PRESENT,
364 POWER_SUPPLY_PROP_TECHNOLOGY,
365 POWER_SUPPLY_PROP_CYCLE_COUNT,
366 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
367 POWER_SUPPLY_PROP_VOLTAGE_NOW,
368 POWER_SUPPLY_PROP_POWER_NOW,
369 POWER_SUPPLY_PROP_ENERGY_NOW,
370 POWER_SUPPLY_PROP_MODEL_NAME,
371 POWER_SUPPLY_PROP_MANUFACTURER,
372 POWER_SUPPLY_PROP_SERIAL_NUMBER,
375 /* Battery Management */
376 struct acpi_offsets {
377 size_t offset; /* offset inside struct acpi_sbs_battery */
378 u8 mode; /* int or string? */
381 static const struct acpi_offsets state_offsets[] = {
382 {offsetof(struct acpi_battery, state), 0},
383 {offsetof(struct acpi_battery, rate_now), 0},
384 {offsetof(struct acpi_battery, capacity_now), 0},
385 {offsetof(struct acpi_battery, voltage_now), 0},
388 static const struct acpi_offsets info_offsets[] = {
389 {offsetof(struct acpi_battery, power_unit), 0},
390 {offsetof(struct acpi_battery, design_capacity), 0},
391 {offsetof(struct acpi_battery, full_charge_capacity), 0},
392 {offsetof(struct acpi_battery, technology), 0},
393 {offsetof(struct acpi_battery, design_voltage), 0},
394 {offsetof(struct acpi_battery, design_capacity_warning), 0},
395 {offsetof(struct acpi_battery, design_capacity_low), 0},
396 {offsetof(struct acpi_battery, capacity_granularity_1), 0},
397 {offsetof(struct acpi_battery, capacity_granularity_2), 0},
398 {offsetof(struct acpi_battery, model_number), 1},
399 {offsetof(struct acpi_battery, serial_number), 1},
400 {offsetof(struct acpi_battery, type), 1},
401 {offsetof(struct acpi_battery, oem_info), 1},
404 static const struct acpi_offsets extended_info_offsets[] = {
405 {offsetof(struct acpi_battery, revision), 0},
406 {offsetof(struct acpi_battery, power_unit), 0},
407 {offsetof(struct acpi_battery, design_capacity), 0},
408 {offsetof(struct acpi_battery, full_charge_capacity), 0},
409 {offsetof(struct acpi_battery, technology), 0},
410 {offsetof(struct acpi_battery, design_voltage), 0},
411 {offsetof(struct acpi_battery, design_capacity_warning), 0},
412 {offsetof(struct acpi_battery, design_capacity_low), 0},
413 {offsetof(struct acpi_battery, cycle_count), 0},
414 {offsetof(struct acpi_battery, measurement_accuracy), 0},
415 {offsetof(struct acpi_battery, max_sampling_time), 0},
416 {offsetof(struct acpi_battery, min_sampling_time), 0},
417 {offsetof(struct acpi_battery, max_averaging_interval), 0},
418 {offsetof(struct acpi_battery, min_averaging_interval), 0},
419 {offsetof(struct acpi_battery, capacity_granularity_1), 0},
420 {offsetof(struct acpi_battery, capacity_granularity_2), 0},
421 {offsetof(struct acpi_battery, model_number), 1},
422 {offsetof(struct acpi_battery, serial_number), 1},
423 {offsetof(struct acpi_battery, type), 1},
424 {offsetof(struct acpi_battery, oem_info), 1},
427 static int extract_package(struct acpi_battery *battery,
428 union acpi_object *package,
429 const struct acpi_offsets *offsets, int num)
432 union acpi_object *element;
434 if (package->type != ACPI_TYPE_PACKAGE)
436 for (i = 0; i < num; ++i) {
437 if (package->package.count <= i)
439 element = &package->package.elements[i];
440 if (offsets[i].mode) {
441 u8 *ptr = (u8 *)battery + offsets[i].offset;
443 if (element->type == ACPI_TYPE_STRING ||
444 element->type == ACPI_TYPE_BUFFER)
445 strncpy(ptr, element->string.pointer, 32);
446 else if (element->type == ACPI_TYPE_INTEGER) {
447 strncpy(ptr, (u8 *)&element->integer.value,
449 ptr[sizeof(u64)] = 0;
451 *ptr = 0; /* don't have value */
453 int *x = (int *)((u8 *)battery + offsets[i].offset);
454 *x = (element->type == ACPI_TYPE_INTEGER) ?
455 element->integer.value : -1;
461 static int acpi_battery_get_status(struct acpi_battery *battery)
463 if (acpi_bus_get_status(battery->device)) {
464 acpi_handle_info(battery->device->handle,
465 "_STA evaluation failed\n");
472 static int extract_battery_info(const int use_bix,
473 struct acpi_battery *battery,
474 const struct acpi_buffer *buffer)
476 int result = -EFAULT;
478 if (use_bix && battery_bix_broken_package)
479 result = extract_package(battery, buffer->pointer,
480 extended_info_offsets + 1,
481 ARRAY_SIZE(extended_info_offsets) - 1);
483 result = extract_package(battery, buffer->pointer,
484 extended_info_offsets,
485 ARRAY_SIZE(extended_info_offsets));
487 result = extract_package(battery, buffer->pointer,
488 info_offsets, ARRAY_SIZE(info_offsets));
489 if (test_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags))
490 battery->full_charge_capacity = battery->design_capacity;
491 if (test_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH, &battery->flags) &&
492 battery->power_unit && battery->design_voltage) {
493 battery->design_capacity = battery->design_capacity *
494 10000 / battery->design_voltage;
495 battery->full_charge_capacity = battery->full_charge_capacity *
496 10000 / battery->design_voltage;
497 battery->design_capacity_warning =
498 battery->design_capacity_warning *
499 10000 / battery->design_voltage;
500 /* Curiously, design_capacity_low, unlike the rest of them,
503 /* capacity_granularity_* equal 1 on the systems tested, so
504 * it's impossible to tell if they would need an adjustment
505 * or not if their values were higher.
508 if (test_bit(ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE, &battery->flags) &&
509 battery->capacity_now > battery->full_charge_capacity)
510 battery->capacity_now = battery->full_charge_capacity;
515 static int acpi_battery_get_info(struct acpi_battery *battery)
517 const int xinfo = test_bit(ACPI_BATTERY_XINFO_PRESENT, &battery->flags);
519 int result = -ENODEV;
521 if (!acpi_battery_present(battery))
525 for (use_bix = xinfo ? 1 : 0; use_bix >= 0; use_bix--) {
526 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
527 acpi_status status = AE_ERROR;
529 mutex_lock(&battery->lock);
530 status = acpi_evaluate_object(battery->device->handle,
531 use_bix ? "_BIX":"_BIF",
533 mutex_unlock(&battery->lock);
535 if (ACPI_FAILURE(status)) {
536 acpi_handle_info(battery->device->handle,
537 "%s evaluation failed: %s\n",
538 use_bix ? "_BIX":"_BIF",
539 acpi_format_exception(status));
541 result = extract_battery_info(use_bix,
545 kfree(buffer.pointer);
550 if (!result && !use_bix && xinfo)
551 pr_warn(FW_BUG "The _BIX method is broken, using _BIF.\n");
556 static int acpi_battery_get_state(struct acpi_battery *battery)
559 acpi_status status = 0;
560 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
562 if (!acpi_battery_present(battery))
565 if (battery->update_time &&
566 time_before(jiffies, battery->update_time +
567 msecs_to_jiffies(cache_time)))
570 mutex_lock(&battery->lock);
571 status = acpi_evaluate_object(battery->device->handle, "_BST",
573 mutex_unlock(&battery->lock);
575 if (ACPI_FAILURE(status)) {
576 acpi_handle_info(battery->device->handle,
577 "_BST evaluation failed: %s",
578 acpi_format_exception(status));
582 result = extract_package(battery, buffer.pointer,
583 state_offsets, ARRAY_SIZE(state_offsets));
584 battery->update_time = jiffies;
585 kfree(buffer.pointer);
587 /* For buggy DSDTs that report negative 16-bit values for either
588 * charging or discharging current and/or report 0 as 65536
591 if (battery->power_unit == ACPI_BATTERY_POWER_UNIT_MA &&
592 battery->rate_now != ACPI_BATTERY_VALUE_UNKNOWN &&
593 (s16)(battery->rate_now) < 0) {
594 battery->rate_now = abs((s16)battery->rate_now);
595 pr_warn_once(FW_BUG "(dis)charge rate invalid.\n");
598 if (test_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags)
599 && battery->capacity_now >= 0 && battery->capacity_now <= 100)
600 battery->capacity_now = (battery->capacity_now *
601 battery->full_charge_capacity) / 100;
602 if (test_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH, &battery->flags) &&
603 battery->power_unit && battery->design_voltage) {
604 battery->capacity_now = battery->capacity_now *
605 10000 / battery->design_voltage;
607 if (test_bit(ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE, &battery->flags) &&
608 battery->capacity_now > battery->full_charge_capacity)
609 battery->capacity_now = battery->full_charge_capacity;
614 static int acpi_battery_set_alarm(struct acpi_battery *battery)
616 acpi_status status = 0;
618 if (!acpi_battery_present(battery) ||
619 !test_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags))
622 mutex_lock(&battery->lock);
623 status = acpi_execute_simple_method(battery->device->handle, "_BTP",
625 mutex_unlock(&battery->lock);
627 if (ACPI_FAILURE(status))
630 acpi_handle_debug(battery->device->handle, "Alarm set to %d\n",
636 static int acpi_battery_init_alarm(struct acpi_battery *battery)
638 /* See if alarms are supported, and if so, set default */
639 if (!acpi_has_method(battery->device->handle, "_BTP")) {
640 clear_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags);
643 set_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags);
645 battery->alarm = battery->design_capacity_warning;
646 return acpi_battery_set_alarm(battery);
649 static ssize_t acpi_battery_alarm_show(struct device *dev,
650 struct device_attribute *attr,
653 struct acpi_battery *battery = to_acpi_battery(dev_get_drvdata(dev));
655 return sprintf(buf, "%d\n", battery->alarm * 1000);
658 static ssize_t acpi_battery_alarm_store(struct device *dev,
659 struct device_attribute *attr,
660 const char *buf, size_t count)
663 struct acpi_battery *battery = to_acpi_battery(dev_get_drvdata(dev));
665 if (sscanf(buf, "%lu\n", &x) == 1)
666 battery->alarm = x/1000;
667 if (acpi_battery_present(battery))
668 acpi_battery_set_alarm(battery);
672 static const struct device_attribute alarm_attr = {
673 .attr = {.name = "alarm", .mode = 0644},
674 .show = acpi_battery_alarm_show,
675 .store = acpi_battery_alarm_store,
679 * The Battery Hooking API
681 * This API is used inside other drivers that need to expose
682 * platform-specific behaviour within the generic driver in a
687 static LIST_HEAD(acpi_battery_list);
688 static LIST_HEAD(battery_hook_list);
689 static DEFINE_MUTEX(hook_mutex);
691 static void __battery_hook_unregister(struct acpi_battery_hook *hook, int lock)
693 struct acpi_battery *battery;
695 * In order to remove a hook, we first need to
696 * de-register all the batteries that are registered.
699 mutex_lock(&hook_mutex);
700 list_for_each_entry(battery, &acpi_battery_list, list) {
701 hook->remove_battery(battery->bat);
703 list_del(&hook->list);
705 mutex_unlock(&hook_mutex);
706 pr_info("extension unregistered: %s\n", hook->name);
709 void battery_hook_unregister(struct acpi_battery_hook *hook)
711 __battery_hook_unregister(hook, 1);
713 EXPORT_SYMBOL_GPL(battery_hook_unregister);
715 void battery_hook_register(struct acpi_battery_hook *hook)
717 struct acpi_battery *battery;
719 mutex_lock(&hook_mutex);
720 INIT_LIST_HEAD(&hook->list);
721 list_add(&hook->list, &battery_hook_list);
723 * Now that the driver is registered, we need
724 * to notify the hook that a battery is available
725 * for each battery, so that the driver may add
728 list_for_each_entry(battery, &acpi_battery_list, list) {
729 if (hook->add_battery(battery->bat)) {
731 * If a add-battery returns non-zero,
732 * the registration of the extension has failed,
733 * and we will not add it to the list of loaded
736 pr_err("extension failed to load: %s", hook->name);
737 __battery_hook_unregister(hook, 0);
741 pr_info("new extension: %s\n", hook->name);
743 mutex_unlock(&hook_mutex);
745 EXPORT_SYMBOL_GPL(battery_hook_register);
748 * This function gets called right after the battery sysfs
749 * attributes have been added, so that the drivers that
750 * define custom sysfs attributes can add their own.
752 static void battery_hook_add_battery(struct acpi_battery *battery)
754 struct acpi_battery_hook *hook_node, *tmp;
756 mutex_lock(&hook_mutex);
757 INIT_LIST_HEAD(&battery->list);
758 list_add(&battery->list, &acpi_battery_list);
760 * Since we added a new battery to the list, we need to
761 * iterate over the hooks and call add_battery for each
762 * hook that was registered. This usually happens
763 * when a battery gets hotplugged or initialized
764 * during the battery module initialization.
766 list_for_each_entry_safe(hook_node, tmp, &battery_hook_list, list) {
767 if (hook_node->add_battery(battery->bat)) {
769 * The notification of the extensions has failed, to
770 * prevent further errors we will unload the extension.
772 pr_err("error in extension, unloading: %s",
774 __battery_hook_unregister(hook_node, 0);
777 mutex_unlock(&hook_mutex);
780 static void battery_hook_remove_battery(struct acpi_battery *battery)
782 struct acpi_battery_hook *hook;
784 mutex_lock(&hook_mutex);
786 * Before removing the hook, we need to remove all
787 * custom attributes from the battery.
789 list_for_each_entry(hook, &battery_hook_list, list) {
790 hook->remove_battery(battery->bat);
792 /* Then, just remove the battery from the list */
793 list_del(&battery->list);
794 mutex_unlock(&hook_mutex);
797 static void __exit battery_hook_exit(void)
799 struct acpi_battery_hook *hook;
800 struct acpi_battery_hook *ptr;
802 * At this point, the acpi_bus_unregister_driver()
803 * has called remove for all batteries. We just
804 * need to remove the hooks.
806 list_for_each_entry_safe(hook, ptr, &battery_hook_list, list) {
807 __battery_hook_unregister(hook, 1);
809 mutex_destroy(&hook_mutex);
812 static int sysfs_add_battery(struct acpi_battery *battery)
814 struct power_supply_config psy_cfg = { .drv_data = battery, };
815 bool full_cap_broken = false;
817 if (!ACPI_BATTERY_CAPACITY_VALID(battery->full_charge_capacity) &&
818 !ACPI_BATTERY_CAPACITY_VALID(battery->design_capacity))
819 full_cap_broken = true;
821 if (battery->power_unit == ACPI_BATTERY_POWER_UNIT_MA) {
822 if (full_cap_broken) {
823 battery->bat_desc.properties =
824 charge_battery_full_cap_broken_props;
825 battery->bat_desc.num_properties =
826 ARRAY_SIZE(charge_battery_full_cap_broken_props);
828 battery->bat_desc.properties = charge_battery_props;
829 battery->bat_desc.num_properties =
830 ARRAY_SIZE(charge_battery_props);
833 if (full_cap_broken) {
834 battery->bat_desc.properties =
835 energy_battery_full_cap_broken_props;
836 battery->bat_desc.num_properties =
837 ARRAY_SIZE(energy_battery_full_cap_broken_props);
839 battery->bat_desc.properties = energy_battery_props;
840 battery->bat_desc.num_properties =
841 ARRAY_SIZE(energy_battery_props);
845 battery->bat_desc.name = acpi_device_bid(battery->device);
846 battery->bat_desc.type = POWER_SUPPLY_TYPE_BATTERY;
847 battery->bat_desc.get_property = acpi_battery_get_property;
849 battery->bat = power_supply_register_no_ws(&battery->device->dev,
850 &battery->bat_desc, &psy_cfg);
852 if (IS_ERR(battery->bat)) {
853 int result = PTR_ERR(battery->bat);
858 battery_hook_add_battery(battery);
859 return device_create_file(&battery->bat->dev, &alarm_attr);
862 static void sysfs_remove_battery(struct acpi_battery *battery)
864 mutex_lock(&battery->sysfs_lock);
866 mutex_unlock(&battery->sysfs_lock);
869 battery_hook_remove_battery(battery);
870 device_remove_file(&battery->bat->dev, &alarm_attr);
871 power_supply_unregister(battery->bat);
873 mutex_unlock(&battery->sysfs_lock);
876 static void find_battery(const struct dmi_header *dm, void *private)
878 struct acpi_battery *battery = (struct acpi_battery *)private;
879 /* Note: the hardcoded offsets below have been extracted from
880 * the source code of dmidecode.
882 if (dm->type == DMI_ENTRY_PORTABLE_BATTERY && dm->length >= 8) {
883 const u8 *dmi_data = (const u8 *)(dm + 1);
884 int dmi_capacity = get_unaligned((const u16 *)(dmi_data + 6));
886 if (dm->length >= 18)
887 dmi_capacity *= dmi_data[17];
888 if (battery->design_capacity * battery->design_voltage / 1000
890 battery->design_capacity * 10 == dmi_capacity)
891 set_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH,
897 * According to the ACPI spec, some kinds of primary batteries can
898 * report percentage battery remaining capacity directly to OS.
899 * In this case, it reports the Last Full Charged Capacity == 100
900 * and BatteryPresentRate == 0xFFFFFFFF.
902 * Now we found some battery reports percentage remaining capacity
903 * even if it's rechargeable.
904 * https://bugzilla.kernel.org/show_bug.cgi?id=15979
906 * Handle this correctly so that they won't break userspace.
908 static void acpi_battery_quirks(struct acpi_battery *battery)
910 if (test_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags))
913 if (battery->full_charge_capacity == 100 &&
914 battery->rate_now == ACPI_BATTERY_VALUE_UNKNOWN &&
915 battery->capacity_now >= 0 && battery->capacity_now <= 100) {
916 set_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags);
917 battery->full_charge_capacity = battery->design_capacity;
918 battery->capacity_now = (battery->capacity_now *
919 battery->full_charge_capacity) / 100;
922 if (test_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH, &battery->flags))
925 if (battery->power_unit && dmi_name_in_vendors("LENOVO")) {
928 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
929 if (s && !strncasecmp(s, "ThinkPad", 8)) {
930 dmi_walk(find_battery, battery);
931 if (test_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH,
933 battery->design_voltage) {
934 battery->design_capacity =
935 battery->design_capacity *
936 10000 / battery->design_voltage;
937 battery->full_charge_capacity =
938 battery->full_charge_capacity *
939 10000 / battery->design_voltage;
940 battery->design_capacity_warning =
941 battery->design_capacity_warning *
942 10000 / battery->design_voltage;
943 battery->capacity_now = battery->capacity_now *
944 10000 / battery->design_voltage;
949 if (test_bit(ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE, &battery->flags))
952 if (acpi_battery_is_degraded(battery) &&
953 battery->capacity_now > battery->full_charge_capacity) {
954 set_bit(ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE, &battery->flags);
955 battery->capacity_now = battery->full_charge_capacity;
959 static int acpi_battery_update(struct acpi_battery *battery, bool resume)
961 int result = acpi_battery_get_status(battery);
966 if (!acpi_battery_present(battery)) {
967 sysfs_remove_battery(battery);
968 battery->update_time = 0;
975 if (!battery->update_time) {
976 result = acpi_battery_get_info(battery);
979 acpi_battery_init_alarm(battery);
982 result = acpi_battery_get_state(battery);
985 acpi_battery_quirks(battery);
988 result = sysfs_add_battery(battery);
994 * Wakeup the system if battery is critical low
995 * or lower than the alarm level
997 if ((battery->state & ACPI_BATTERY_STATE_CRITICAL) ||
998 (test_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags) &&
999 (battery->capacity_now <= battery->alarm)))
1000 acpi_pm_wakeup_event(&battery->device->dev);
1005 static void acpi_battery_refresh(struct acpi_battery *battery)
1012 power_unit = battery->power_unit;
1014 acpi_battery_get_info(battery);
1016 if (power_unit == battery->power_unit)
1019 /* The battery has changed its reporting units. */
1020 sysfs_remove_battery(battery);
1021 sysfs_add_battery(battery);
1024 /* Driver Interface */
1025 static void acpi_battery_notify(struct acpi_device *device, u32 event)
1027 struct acpi_battery *battery = acpi_driver_data(device);
1028 struct power_supply *old;
1034 * On Acer Aspire V5-573G notifications are sometimes triggered too
1035 * early. For example, when AC is unplugged and notification is
1036 * triggered, battery state is still reported as "Full", and changes to
1037 * "Discharging" only after short delay, without any notification.
1039 if (battery_notification_delay_ms > 0)
1040 msleep(battery_notification_delay_ms);
1041 if (event == ACPI_BATTERY_NOTIFY_INFO)
1042 acpi_battery_refresh(battery);
1043 acpi_battery_update(battery, false);
1044 acpi_bus_generate_netlink_event(device->pnp.device_class,
1045 dev_name(&device->dev), event,
1046 acpi_battery_present(battery));
1047 acpi_notifier_call_chain(device, event, acpi_battery_present(battery));
1048 /* acpi_battery_update could remove power_supply object */
1049 if (old && battery->bat)
1050 power_supply_changed(battery->bat);
1053 static int battery_notify(struct notifier_block *nb,
1054 unsigned long mode, void *_unused)
1056 struct acpi_battery *battery = container_of(nb, struct acpi_battery,
1061 case PM_POST_HIBERNATION:
1062 case PM_POST_SUSPEND:
1063 if (!acpi_battery_present(battery))
1067 acpi_battery_refresh(battery);
1069 result = acpi_battery_get_info(battery);
1073 result = sysfs_add_battery(battery);
1078 acpi_battery_init_alarm(battery);
1079 acpi_battery_get_state(battery);
1087 battery_bix_broken_package_quirk(const struct dmi_system_id *d)
1089 battery_bix_broken_package = 1;
1094 battery_notification_delay_quirk(const struct dmi_system_id *d)
1096 battery_notification_delay_ms = 1000;
1101 battery_ac_is_broken_quirk(const struct dmi_system_id *d)
1103 battery_ac_is_broken = 1;
1108 battery_do_not_check_pmic_quirk(const struct dmi_system_id *d)
1110 battery_check_pmic = 0;
1114 static const struct dmi_system_id bat_dmi_table[] __initconst = {
1117 .callback = battery_bix_broken_package_quirk,
1119 DMI_MATCH(DMI_SYS_VENDOR, "NEC"),
1120 DMI_MATCH(DMI_PRODUCT_NAME, "PC-LZ750LS"),
1124 /* Acer Aspire V5-573G */
1125 .callback = battery_notification_delay_quirk,
1127 DMI_MATCH(DMI_SYS_VENDOR, "Acer"),
1128 DMI_MATCH(DMI_PRODUCT_NAME, "Aspire V5-573G"),
1132 /* Point of View mobii wintab p800w */
1133 .callback = battery_ac_is_broken_quirk,
1135 DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
1136 DMI_MATCH(DMI_BOARD_NAME, "Aptio CRB"),
1137 DMI_MATCH(DMI_BIOS_VERSION, "3BAIR1013"),
1138 /* Above matches are too generic, add bios-date match */
1139 DMI_MATCH(DMI_BIOS_DATE, "08/22/2014"),
1143 /* ECS EF20EA, AXP288 PMIC but uses separate fuel-gauge */
1144 .callback = battery_do_not_check_pmic_quirk,
1146 DMI_MATCH(DMI_PRODUCT_NAME, "EF20EA"),
1150 /* Lenovo Ideapad Miix 320, AXP288 PMIC, separate fuel-gauge */
1151 .callback = battery_do_not_check_pmic_quirk,
1153 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
1154 DMI_MATCH(DMI_PRODUCT_NAME, "80XF"),
1155 DMI_MATCH(DMI_PRODUCT_VERSION, "Lenovo MIIX 320-10ICR"),
1162 * Some machines'(E,G Lenovo Z480) ECs are not stable
1163 * during boot up and this causes battery driver fails to be
1164 * probed due to failure of getting battery information
1165 * from EC sometimes. After several retries, the operation
1166 * may work. So add retry code here and 20ms sleep between
1169 static int acpi_battery_update_retry(struct acpi_battery *battery)
1173 for (retry = 5; retry; retry--) {
1174 ret = acpi_battery_update(battery, false);
1183 static int acpi_battery_add(struct acpi_device *device)
1186 struct acpi_battery *battery = NULL;
1191 if (device->dep_unmet)
1192 return -EPROBE_DEFER;
1194 battery = kzalloc(sizeof(struct acpi_battery), GFP_KERNEL);
1197 battery->device = device;
1198 strcpy(acpi_device_name(device), ACPI_BATTERY_DEVICE_NAME);
1199 strcpy(acpi_device_class(device), ACPI_BATTERY_CLASS);
1200 device->driver_data = battery;
1201 mutex_init(&battery->lock);
1202 mutex_init(&battery->sysfs_lock);
1203 if (acpi_has_method(battery->device->handle, "_BIX"))
1204 set_bit(ACPI_BATTERY_XINFO_PRESENT, &battery->flags);
1206 result = acpi_battery_update_retry(battery);
1210 pr_info("Slot [%s] (battery %s)\n", acpi_device_bid(device),
1211 device->status.battery_present ? "present" : "absent");
1213 battery->pm_nb.notifier_call = battery_notify;
1214 register_pm_notifier(&battery->pm_nb);
1216 device_init_wakeup(&device->dev, 1);
1221 sysfs_remove_battery(battery);
1222 mutex_destroy(&battery->lock);
1223 mutex_destroy(&battery->sysfs_lock);
1228 static int acpi_battery_remove(struct acpi_device *device)
1230 struct acpi_battery *battery = NULL;
1232 if (!device || !acpi_driver_data(device))
1234 device_init_wakeup(&device->dev, 0);
1235 battery = acpi_driver_data(device);
1236 unregister_pm_notifier(&battery->pm_nb);
1237 sysfs_remove_battery(battery);
1238 mutex_destroy(&battery->lock);
1239 mutex_destroy(&battery->sysfs_lock);
1244 #ifdef CONFIG_PM_SLEEP
1245 /* this is needed to learn about changes made in suspended state */
1246 static int acpi_battery_resume(struct device *dev)
1248 struct acpi_battery *battery;
1253 battery = acpi_driver_data(to_acpi_device(dev));
1257 battery->update_time = 0;
1258 acpi_battery_update(battery, true);
1262 #define acpi_battery_resume NULL
1265 static SIMPLE_DEV_PM_OPS(acpi_battery_pm, NULL, acpi_battery_resume);
1267 static struct acpi_driver acpi_battery_driver = {
1269 .class = ACPI_BATTERY_CLASS,
1270 .ids = battery_device_ids,
1271 .flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
1273 .add = acpi_battery_add,
1274 .remove = acpi_battery_remove,
1275 .notify = acpi_battery_notify,
1277 .drv.pm = &acpi_battery_pm,
1280 static void __init acpi_battery_init_async(void *unused, async_cookie_t cookie)
1285 dmi_check_system(bat_dmi_table);
1287 if (battery_check_pmic) {
1288 for (i = 0; i < ARRAY_SIZE(acpi_battery_blacklist); i++)
1289 if (acpi_dev_present(acpi_battery_blacklist[i], "1", -1)) {
1290 pr_info("found native %s PMIC, not loading\n",
1291 acpi_battery_blacklist[i]);
1296 result = acpi_bus_register_driver(&acpi_battery_driver);
1297 battery_driver_registered = (result == 0);
1300 static int __init acpi_battery_init(void)
1305 async_cookie = async_schedule(acpi_battery_init_async, NULL);
1309 static void __exit acpi_battery_exit(void)
1311 async_synchronize_cookie(async_cookie + 1);
1312 if (battery_driver_registered) {
1313 acpi_bus_unregister_driver(&acpi_battery_driver);
1314 battery_hook_exit();
1318 module_init(acpi_battery_init);
1319 module_exit(acpi_battery_exit);