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_quirk_notcharging;
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);
68 ACPI_BATTERY_ALARM_PRESENT,
69 ACPI_BATTERY_XINFO_PRESENT,
70 ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY,
71 /* On Lenovo Thinkpad models from 2010 and 2011, the power unit
72 * switches between mWh and mAh depending on whether the system
73 * is running on battery or not. When mAh is the unit, most
74 * reported values are incorrect and need to be adjusted by
75 * 10000/design_voltage. Verified on x201, t410, t410s, and x220.
76 * Pre-2010 and 2012 models appear to always report in mWh and
77 * are thus unaffected (tested with t42, t61, t500, x200, x300,
78 * and x230). Also, in mid-2012 Lenovo issued a BIOS update for
79 * the 2011 models that fixes the issue (tested on x220 with a
80 * post-1.29 BIOS), but as of Nov. 2012, no such update is
81 * available for the 2010 models.
83 ACPI_BATTERY_QUIRK_THINKPAD_MAH,
84 /* for batteries reporting current capacity with design capacity
85 * on a full charge, but showing degradation in full charge cap.
87 ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE,
92 struct mutex sysfs_lock;
93 struct power_supply *bat;
94 struct power_supply_desc bat_desc;
95 struct acpi_device *device;
96 struct notifier_block pm_nb;
97 struct list_head list;
98 unsigned long update_time;
104 int full_charge_capacity;
107 int design_capacity_warning;
108 int design_capacity_low;
110 int measurement_accuracy;
111 int max_sampling_time;
112 int min_sampling_time;
113 int max_averaging_interval;
114 int min_averaging_interval;
115 int capacity_granularity_1;
116 int capacity_granularity_2;
118 char model_number[32];
119 char serial_number[32];
127 #define to_acpi_battery(x) power_supply_get_drvdata(x)
129 static inline int acpi_battery_present(struct acpi_battery *battery)
131 return battery->device->status.battery_present;
134 static int acpi_battery_technology(struct acpi_battery *battery)
136 if (!strcasecmp("NiCd", battery->type))
137 return POWER_SUPPLY_TECHNOLOGY_NiCd;
138 if (!strcasecmp("NiMH", battery->type))
139 return POWER_SUPPLY_TECHNOLOGY_NiMH;
140 if (!strcasecmp("LION", battery->type))
141 return POWER_SUPPLY_TECHNOLOGY_LION;
142 if (!strncasecmp("LI-ION", battery->type, 6))
143 return POWER_SUPPLY_TECHNOLOGY_LION;
144 if (!strcasecmp("LiP", battery->type))
145 return POWER_SUPPLY_TECHNOLOGY_LIPO;
146 return POWER_SUPPLY_TECHNOLOGY_UNKNOWN;
149 static int acpi_battery_get_state(struct acpi_battery *battery);
151 static int acpi_battery_is_charged(struct acpi_battery *battery)
153 /* charging, discharging or critical low */
154 if (battery->state != 0)
157 /* battery not reporting charge */
158 if (battery->capacity_now == ACPI_BATTERY_VALUE_UNKNOWN ||
159 battery->capacity_now == 0)
162 /* good batteries update full_charge as the batteries degrade */
163 if (battery->full_charge_capacity == battery->capacity_now)
166 /* fallback to using design values for broken batteries */
167 if (battery->design_capacity <= battery->capacity_now)
170 /* we don't do any sort of metric based on percentages */
174 static bool acpi_battery_is_degraded(struct acpi_battery *battery)
176 return ACPI_BATTERY_CAPACITY_VALID(battery->full_charge_capacity) &&
177 ACPI_BATTERY_CAPACITY_VALID(battery->design_capacity) &&
178 battery->full_charge_capacity < battery->design_capacity;
181 static int acpi_battery_handle_discharging(struct acpi_battery *battery)
184 * Some devices wrongly report discharging if the battery's charge level
185 * was above the device's start charging threshold atm the AC adapter
186 * was plugged in and the device thus did not start a new charge cycle.
188 if ((battery_ac_is_broken || power_supply_is_system_supplied()) &&
189 battery->rate_now == 0)
190 return POWER_SUPPLY_STATUS_NOT_CHARGING;
192 return POWER_SUPPLY_STATUS_DISCHARGING;
195 static int acpi_battery_get_property(struct power_supply *psy,
196 enum power_supply_property psp,
197 union power_supply_propval *val)
199 int full_capacity = ACPI_BATTERY_VALUE_UNKNOWN, ret = 0;
200 struct acpi_battery *battery = to_acpi_battery(psy);
202 if (acpi_battery_present(battery)) {
203 /* run battery update only if it is present */
204 acpi_battery_get_state(battery);
205 } else if (psp != POWER_SUPPLY_PROP_PRESENT)
208 case POWER_SUPPLY_PROP_STATUS:
209 if (battery->state & ACPI_BATTERY_STATE_DISCHARGING)
210 val->intval = acpi_battery_handle_discharging(battery);
211 else if (battery->state & ACPI_BATTERY_STATE_CHARGING)
212 val->intval = POWER_SUPPLY_STATUS_CHARGING;
213 else if (acpi_battery_is_charged(battery))
214 val->intval = POWER_SUPPLY_STATUS_FULL;
215 else if (battery_quirk_notcharging)
216 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
218 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
220 case POWER_SUPPLY_PROP_PRESENT:
221 val->intval = acpi_battery_present(battery);
223 case POWER_SUPPLY_PROP_TECHNOLOGY:
224 val->intval = acpi_battery_technology(battery);
226 case POWER_SUPPLY_PROP_CYCLE_COUNT:
227 val->intval = battery->cycle_count;
229 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
230 if (battery->design_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
233 val->intval = battery->design_voltage * 1000;
235 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
236 if (battery->voltage_now == ACPI_BATTERY_VALUE_UNKNOWN)
239 val->intval = battery->voltage_now * 1000;
241 case POWER_SUPPLY_PROP_CURRENT_NOW:
242 case POWER_SUPPLY_PROP_POWER_NOW:
243 if (battery->rate_now == ACPI_BATTERY_VALUE_UNKNOWN)
246 val->intval = battery->rate_now * 1000;
248 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
249 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
250 if (!ACPI_BATTERY_CAPACITY_VALID(battery->design_capacity))
253 val->intval = battery->design_capacity * 1000;
255 case POWER_SUPPLY_PROP_CHARGE_FULL:
256 case POWER_SUPPLY_PROP_ENERGY_FULL:
257 if (!ACPI_BATTERY_CAPACITY_VALID(battery->full_charge_capacity))
260 val->intval = battery->full_charge_capacity * 1000;
262 case POWER_SUPPLY_PROP_CHARGE_NOW:
263 case POWER_SUPPLY_PROP_ENERGY_NOW:
264 if (battery->capacity_now == ACPI_BATTERY_VALUE_UNKNOWN)
267 val->intval = battery->capacity_now * 1000;
269 case POWER_SUPPLY_PROP_CAPACITY:
270 if (ACPI_BATTERY_CAPACITY_VALID(battery->full_charge_capacity))
271 full_capacity = battery->full_charge_capacity;
272 else if (ACPI_BATTERY_CAPACITY_VALID(battery->design_capacity))
273 full_capacity = battery->design_capacity;
275 if (battery->capacity_now == ACPI_BATTERY_VALUE_UNKNOWN ||
276 full_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
279 val->intval = battery->capacity_now * 100/
282 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
283 if (battery->state & ACPI_BATTERY_STATE_CRITICAL)
284 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
285 else if (test_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags) &&
286 (battery->capacity_now <= battery->alarm))
287 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
288 else if (acpi_battery_is_charged(battery))
289 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
291 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
293 case POWER_SUPPLY_PROP_MODEL_NAME:
294 val->strval = battery->model_number;
296 case POWER_SUPPLY_PROP_MANUFACTURER:
297 val->strval = battery->oem_info;
299 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
300 val->strval = battery->serial_number;
308 static enum power_supply_property charge_battery_props[] = {
309 POWER_SUPPLY_PROP_STATUS,
310 POWER_SUPPLY_PROP_PRESENT,
311 POWER_SUPPLY_PROP_TECHNOLOGY,
312 POWER_SUPPLY_PROP_CYCLE_COUNT,
313 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
314 POWER_SUPPLY_PROP_VOLTAGE_NOW,
315 POWER_SUPPLY_PROP_CURRENT_NOW,
316 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
317 POWER_SUPPLY_PROP_CHARGE_FULL,
318 POWER_SUPPLY_PROP_CHARGE_NOW,
319 POWER_SUPPLY_PROP_CAPACITY,
320 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
321 POWER_SUPPLY_PROP_MODEL_NAME,
322 POWER_SUPPLY_PROP_MANUFACTURER,
323 POWER_SUPPLY_PROP_SERIAL_NUMBER,
326 static enum power_supply_property charge_battery_full_cap_broken_props[] = {
327 POWER_SUPPLY_PROP_STATUS,
328 POWER_SUPPLY_PROP_PRESENT,
329 POWER_SUPPLY_PROP_TECHNOLOGY,
330 POWER_SUPPLY_PROP_CYCLE_COUNT,
331 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
332 POWER_SUPPLY_PROP_VOLTAGE_NOW,
333 POWER_SUPPLY_PROP_CURRENT_NOW,
334 POWER_SUPPLY_PROP_CHARGE_NOW,
335 POWER_SUPPLY_PROP_MODEL_NAME,
336 POWER_SUPPLY_PROP_MANUFACTURER,
337 POWER_SUPPLY_PROP_SERIAL_NUMBER,
340 static enum power_supply_property energy_battery_props[] = {
341 POWER_SUPPLY_PROP_STATUS,
342 POWER_SUPPLY_PROP_PRESENT,
343 POWER_SUPPLY_PROP_TECHNOLOGY,
344 POWER_SUPPLY_PROP_CYCLE_COUNT,
345 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
346 POWER_SUPPLY_PROP_VOLTAGE_NOW,
347 POWER_SUPPLY_PROP_POWER_NOW,
348 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
349 POWER_SUPPLY_PROP_ENERGY_FULL,
350 POWER_SUPPLY_PROP_ENERGY_NOW,
351 POWER_SUPPLY_PROP_CAPACITY,
352 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
353 POWER_SUPPLY_PROP_MODEL_NAME,
354 POWER_SUPPLY_PROP_MANUFACTURER,
355 POWER_SUPPLY_PROP_SERIAL_NUMBER,
358 static enum power_supply_property energy_battery_full_cap_broken_props[] = {
359 POWER_SUPPLY_PROP_STATUS,
360 POWER_SUPPLY_PROP_PRESENT,
361 POWER_SUPPLY_PROP_TECHNOLOGY,
362 POWER_SUPPLY_PROP_CYCLE_COUNT,
363 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
364 POWER_SUPPLY_PROP_VOLTAGE_NOW,
365 POWER_SUPPLY_PROP_POWER_NOW,
366 POWER_SUPPLY_PROP_ENERGY_NOW,
367 POWER_SUPPLY_PROP_MODEL_NAME,
368 POWER_SUPPLY_PROP_MANUFACTURER,
369 POWER_SUPPLY_PROP_SERIAL_NUMBER,
372 /* Battery Management */
373 struct acpi_offsets {
374 size_t offset; /* offset inside struct acpi_sbs_battery */
375 u8 mode; /* int or string? */
378 static const struct acpi_offsets state_offsets[] = {
379 {offsetof(struct acpi_battery, state), 0},
380 {offsetof(struct acpi_battery, rate_now), 0},
381 {offsetof(struct acpi_battery, capacity_now), 0},
382 {offsetof(struct acpi_battery, voltage_now), 0},
385 static const struct acpi_offsets info_offsets[] = {
386 {offsetof(struct acpi_battery, power_unit), 0},
387 {offsetof(struct acpi_battery, design_capacity), 0},
388 {offsetof(struct acpi_battery, full_charge_capacity), 0},
389 {offsetof(struct acpi_battery, technology), 0},
390 {offsetof(struct acpi_battery, design_voltage), 0},
391 {offsetof(struct acpi_battery, design_capacity_warning), 0},
392 {offsetof(struct acpi_battery, design_capacity_low), 0},
393 {offsetof(struct acpi_battery, capacity_granularity_1), 0},
394 {offsetof(struct acpi_battery, capacity_granularity_2), 0},
395 {offsetof(struct acpi_battery, model_number), 1},
396 {offsetof(struct acpi_battery, serial_number), 1},
397 {offsetof(struct acpi_battery, type), 1},
398 {offsetof(struct acpi_battery, oem_info), 1},
401 static const struct acpi_offsets extended_info_offsets[] = {
402 {offsetof(struct acpi_battery, revision), 0},
403 {offsetof(struct acpi_battery, power_unit), 0},
404 {offsetof(struct acpi_battery, design_capacity), 0},
405 {offsetof(struct acpi_battery, full_charge_capacity), 0},
406 {offsetof(struct acpi_battery, technology), 0},
407 {offsetof(struct acpi_battery, design_voltage), 0},
408 {offsetof(struct acpi_battery, design_capacity_warning), 0},
409 {offsetof(struct acpi_battery, design_capacity_low), 0},
410 {offsetof(struct acpi_battery, cycle_count), 0},
411 {offsetof(struct acpi_battery, measurement_accuracy), 0},
412 {offsetof(struct acpi_battery, max_sampling_time), 0},
413 {offsetof(struct acpi_battery, min_sampling_time), 0},
414 {offsetof(struct acpi_battery, max_averaging_interval), 0},
415 {offsetof(struct acpi_battery, min_averaging_interval), 0},
416 {offsetof(struct acpi_battery, capacity_granularity_1), 0},
417 {offsetof(struct acpi_battery, capacity_granularity_2), 0},
418 {offsetof(struct acpi_battery, model_number), 1},
419 {offsetof(struct acpi_battery, serial_number), 1},
420 {offsetof(struct acpi_battery, type), 1},
421 {offsetof(struct acpi_battery, oem_info), 1},
424 static int extract_package(struct acpi_battery *battery,
425 union acpi_object *package,
426 const struct acpi_offsets *offsets, int num)
429 union acpi_object *element;
431 if (package->type != ACPI_TYPE_PACKAGE)
433 for (i = 0; i < num; ++i) {
434 if (package->package.count <= i)
436 element = &package->package.elements[i];
437 if (offsets[i].mode) {
438 u8 *ptr = (u8 *)battery + offsets[i].offset;
440 if (element->type == ACPI_TYPE_STRING ||
441 element->type == ACPI_TYPE_BUFFER)
442 strncpy(ptr, element->string.pointer, 32);
443 else if (element->type == ACPI_TYPE_INTEGER) {
444 strncpy(ptr, (u8 *)&element->integer.value,
446 ptr[sizeof(u64)] = 0;
448 *ptr = 0; /* don't have value */
450 int *x = (int *)((u8 *)battery + offsets[i].offset);
451 *x = (element->type == ACPI_TYPE_INTEGER) ?
452 element->integer.value : -1;
458 static int acpi_battery_get_status(struct acpi_battery *battery)
460 if (acpi_bus_get_status(battery->device)) {
461 acpi_handle_info(battery->device->handle,
462 "_STA evaluation failed\n");
469 static int extract_battery_info(const int use_bix,
470 struct acpi_battery *battery,
471 const struct acpi_buffer *buffer)
473 int result = -EFAULT;
475 if (use_bix && battery_bix_broken_package)
476 result = extract_package(battery, buffer->pointer,
477 extended_info_offsets + 1,
478 ARRAY_SIZE(extended_info_offsets) - 1);
480 result = extract_package(battery, buffer->pointer,
481 extended_info_offsets,
482 ARRAY_SIZE(extended_info_offsets));
484 result = extract_package(battery, buffer->pointer,
485 info_offsets, ARRAY_SIZE(info_offsets));
486 if (test_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags))
487 battery->full_charge_capacity = battery->design_capacity;
488 if (test_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH, &battery->flags) &&
489 battery->power_unit && battery->design_voltage) {
490 battery->design_capacity = battery->design_capacity *
491 10000 / battery->design_voltage;
492 battery->full_charge_capacity = battery->full_charge_capacity *
493 10000 / battery->design_voltage;
494 battery->design_capacity_warning =
495 battery->design_capacity_warning *
496 10000 / battery->design_voltage;
497 /* Curiously, design_capacity_low, unlike the rest of them,
500 /* capacity_granularity_* equal 1 on the systems tested, so
501 * it's impossible to tell if they would need an adjustment
502 * or not if their values were higher.
505 if (test_bit(ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE, &battery->flags) &&
506 battery->capacity_now > battery->full_charge_capacity)
507 battery->capacity_now = battery->full_charge_capacity;
512 static int acpi_battery_get_info(struct acpi_battery *battery)
514 const int xinfo = test_bit(ACPI_BATTERY_XINFO_PRESENT, &battery->flags);
516 int result = -ENODEV;
518 if (!acpi_battery_present(battery))
522 for (use_bix = xinfo ? 1 : 0; use_bix >= 0; use_bix--) {
523 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
524 acpi_status status = AE_ERROR;
526 mutex_lock(&battery->lock);
527 status = acpi_evaluate_object(battery->device->handle,
528 use_bix ? "_BIX":"_BIF",
530 mutex_unlock(&battery->lock);
532 if (ACPI_FAILURE(status)) {
533 acpi_handle_info(battery->device->handle,
534 "%s evaluation failed: %s\n",
535 use_bix ? "_BIX":"_BIF",
536 acpi_format_exception(status));
538 result = extract_battery_info(use_bix,
542 kfree(buffer.pointer);
547 if (!result && !use_bix && xinfo)
548 pr_warn(FW_BUG "The _BIX method is broken, using _BIF.\n");
553 static int acpi_battery_get_state(struct acpi_battery *battery)
556 acpi_status status = 0;
557 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
559 if (!acpi_battery_present(battery))
562 if (battery->update_time &&
563 time_before(jiffies, battery->update_time +
564 msecs_to_jiffies(cache_time)))
567 mutex_lock(&battery->lock);
568 status = acpi_evaluate_object(battery->device->handle, "_BST",
570 mutex_unlock(&battery->lock);
572 if (ACPI_FAILURE(status)) {
573 acpi_handle_info(battery->device->handle,
574 "_BST evaluation failed: %s",
575 acpi_format_exception(status));
579 result = extract_package(battery, buffer.pointer,
580 state_offsets, ARRAY_SIZE(state_offsets));
581 battery->update_time = jiffies;
582 kfree(buffer.pointer);
584 /* For buggy DSDTs that report negative 16-bit values for either
585 * charging or discharging current and/or report 0 as 65536
588 if (battery->power_unit == ACPI_BATTERY_POWER_UNIT_MA &&
589 battery->rate_now != ACPI_BATTERY_VALUE_UNKNOWN &&
590 (s16)(battery->rate_now) < 0) {
591 battery->rate_now = abs((s16)battery->rate_now);
592 pr_warn_once(FW_BUG "(dis)charge rate invalid.\n");
595 if (test_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags)
596 && battery->capacity_now >= 0 && battery->capacity_now <= 100)
597 battery->capacity_now = (battery->capacity_now *
598 battery->full_charge_capacity) / 100;
599 if (test_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH, &battery->flags) &&
600 battery->power_unit && battery->design_voltage) {
601 battery->capacity_now = battery->capacity_now *
602 10000 / battery->design_voltage;
604 if (test_bit(ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE, &battery->flags) &&
605 battery->capacity_now > battery->full_charge_capacity)
606 battery->capacity_now = battery->full_charge_capacity;
611 static int acpi_battery_set_alarm(struct acpi_battery *battery)
613 acpi_status status = 0;
615 if (!acpi_battery_present(battery) ||
616 !test_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags))
619 mutex_lock(&battery->lock);
620 status = acpi_execute_simple_method(battery->device->handle, "_BTP",
622 mutex_unlock(&battery->lock);
624 if (ACPI_FAILURE(status))
627 acpi_handle_debug(battery->device->handle, "Alarm set to %d\n",
633 static int acpi_battery_init_alarm(struct acpi_battery *battery)
635 /* See if alarms are supported, and if so, set default */
636 if (!acpi_has_method(battery->device->handle, "_BTP")) {
637 clear_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags);
640 set_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags);
642 battery->alarm = battery->design_capacity_warning;
643 return acpi_battery_set_alarm(battery);
646 static ssize_t acpi_battery_alarm_show(struct device *dev,
647 struct device_attribute *attr,
650 struct acpi_battery *battery = to_acpi_battery(dev_get_drvdata(dev));
652 return sprintf(buf, "%d\n", battery->alarm * 1000);
655 static ssize_t acpi_battery_alarm_store(struct device *dev,
656 struct device_attribute *attr,
657 const char *buf, size_t count)
660 struct acpi_battery *battery = to_acpi_battery(dev_get_drvdata(dev));
662 if (sscanf(buf, "%lu\n", &x) == 1)
663 battery->alarm = x/1000;
664 if (acpi_battery_present(battery))
665 acpi_battery_set_alarm(battery);
669 static const struct device_attribute alarm_attr = {
670 .attr = {.name = "alarm", .mode = 0644},
671 .show = acpi_battery_alarm_show,
672 .store = acpi_battery_alarm_store,
676 * The Battery Hooking API
678 * This API is used inside other drivers that need to expose
679 * platform-specific behaviour within the generic driver in a
684 static LIST_HEAD(acpi_battery_list);
685 static LIST_HEAD(battery_hook_list);
686 static DEFINE_MUTEX(hook_mutex);
688 static void __battery_hook_unregister(struct acpi_battery_hook *hook, int lock)
690 struct acpi_battery *battery;
692 * In order to remove a hook, we first need to
693 * de-register all the batteries that are registered.
696 mutex_lock(&hook_mutex);
697 list_for_each_entry(battery, &acpi_battery_list, list) {
698 hook->remove_battery(battery->bat);
700 list_del(&hook->list);
702 mutex_unlock(&hook_mutex);
703 pr_info("extension unregistered: %s\n", hook->name);
706 void battery_hook_unregister(struct acpi_battery_hook *hook)
708 __battery_hook_unregister(hook, 1);
710 EXPORT_SYMBOL_GPL(battery_hook_unregister);
712 void battery_hook_register(struct acpi_battery_hook *hook)
714 struct acpi_battery *battery;
716 mutex_lock(&hook_mutex);
717 INIT_LIST_HEAD(&hook->list);
718 list_add(&hook->list, &battery_hook_list);
720 * Now that the driver is registered, we need
721 * to notify the hook that a battery is available
722 * for each battery, so that the driver may add
725 list_for_each_entry(battery, &acpi_battery_list, list) {
726 if (hook->add_battery(battery->bat)) {
728 * If a add-battery returns non-zero,
729 * the registration of the extension has failed,
730 * and we will not add it to the list of loaded
733 pr_err("extension failed to load: %s", hook->name);
734 __battery_hook_unregister(hook, 0);
738 pr_info("new extension: %s\n", hook->name);
740 mutex_unlock(&hook_mutex);
742 EXPORT_SYMBOL_GPL(battery_hook_register);
745 * This function gets called right after the battery sysfs
746 * attributes have been added, so that the drivers that
747 * define custom sysfs attributes can add their own.
749 static void battery_hook_add_battery(struct acpi_battery *battery)
751 struct acpi_battery_hook *hook_node, *tmp;
753 mutex_lock(&hook_mutex);
754 INIT_LIST_HEAD(&battery->list);
755 list_add(&battery->list, &acpi_battery_list);
757 * Since we added a new battery to the list, we need to
758 * iterate over the hooks and call add_battery for each
759 * hook that was registered. This usually happens
760 * when a battery gets hotplugged or initialized
761 * during the battery module initialization.
763 list_for_each_entry_safe(hook_node, tmp, &battery_hook_list, list) {
764 if (hook_node->add_battery(battery->bat)) {
766 * The notification of the extensions has failed, to
767 * prevent further errors we will unload the extension.
769 pr_err("error in extension, unloading: %s",
771 __battery_hook_unregister(hook_node, 0);
774 mutex_unlock(&hook_mutex);
777 static void battery_hook_remove_battery(struct acpi_battery *battery)
779 struct acpi_battery_hook *hook;
781 mutex_lock(&hook_mutex);
783 * Before removing the hook, we need to remove all
784 * custom attributes from the battery.
786 list_for_each_entry(hook, &battery_hook_list, list) {
787 hook->remove_battery(battery->bat);
789 /* Then, just remove the battery from the list */
790 list_del(&battery->list);
791 mutex_unlock(&hook_mutex);
794 static void __exit battery_hook_exit(void)
796 struct acpi_battery_hook *hook;
797 struct acpi_battery_hook *ptr;
799 * At this point, the acpi_bus_unregister_driver()
800 * has called remove for all batteries. We just
801 * need to remove the hooks.
803 list_for_each_entry_safe(hook, ptr, &battery_hook_list, list) {
804 __battery_hook_unregister(hook, 1);
806 mutex_destroy(&hook_mutex);
809 static int sysfs_add_battery(struct acpi_battery *battery)
811 struct power_supply_config psy_cfg = { .drv_data = battery, };
812 bool full_cap_broken = false;
814 if (!ACPI_BATTERY_CAPACITY_VALID(battery->full_charge_capacity) &&
815 !ACPI_BATTERY_CAPACITY_VALID(battery->design_capacity))
816 full_cap_broken = true;
818 if (battery->power_unit == ACPI_BATTERY_POWER_UNIT_MA) {
819 if (full_cap_broken) {
820 battery->bat_desc.properties =
821 charge_battery_full_cap_broken_props;
822 battery->bat_desc.num_properties =
823 ARRAY_SIZE(charge_battery_full_cap_broken_props);
825 battery->bat_desc.properties = charge_battery_props;
826 battery->bat_desc.num_properties =
827 ARRAY_SIZE(charge_battery_props);
830 if (full_cap_broken) {
831 battery->bat_desc.properties =
832 energy_battery_full_cap_broken_props;
833 battery->bat_desc.num_properties =
834 ARRAY_SIZE(energy_battery_full_cap_broken_props);
836 battery->bat_desc.properties = energy_battery_props;
837 battery->bat_desc.num_properties =
838 ARRAY_SIZE(energy_battery_props);
842 battery->bat_desc.name = acpi_device_bid(battery->device);
843 battery->bat_desc.type = POWER_SUPPLY_TYPE_BATTERY;
844 battery->bat_desc.get_property = acpi_battery_get_property;
846 battery->bat = power_supply_register_no_ws(&battery->device->dev,
847 &battery->bat_desc, &psy_cfg);
849 if (IS_ERR(battery->bat)) {
850 int result = PTR_ERR(battery->bat);
855 battery_hook_add_battery(battery);
856 return device_create_file(&battery->bat->dev, &alarm_attr);
859 static void sysfs_remove_battery(struct acpi_battery *battery)
861 mutex_lock(&battery->sysfs_lock);
863 mutex_unlock(&battery->sysfs_lock);
866 battery_hook_remove_battery(battery);
867 device_remove_file(&battery->bat->dev, &alarm_attr);
868 power_supply_unregister(battery->bat);
870 mutex_unlock(&battery->sysfs_lock);
873 static void find_battery(const struct dmi_header *dm, void *private)
875 struct acpi_battery *battery = (struct acpi_battery *)private;
876 /* Note: the hardcoded offsets below have been extracted from
877 * the source code of dmidecode.
879 if (dm->type == DMI_ENTRY_PORTABLE_BATTERY && dm->length >= 8) {
880 const u8 *dmi_data = (const u8 *)(dm + 1);
881 int dmi_capacity = get_unaligned((const u16 *)(dmi_data + 6));
883 if (dm->length >= 18)
884 dmi_capacity *= dmi_data[17];
885 if (battery->design_capacity * battery->design_voltage / 1000
887 battery->design_capacity * 10 == dmi_capacity)
888 set_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH,
894 * According to the ACPI spec, some kinds of primary batteries can
895 * report percentage battery remaining capacity directly to OS.
896 * In this case, it reports the Last Full Charged Capacity == 100
897 * and BatteryPresentRate == 0xFFFFFFFF.
899 * Now we found some battery reports percentage remaining capacity
900 * even if it's rechargeable.
901 * https://bugzilla.kernel.org/show_bug.cgi?id=15979
903 * Handle this correctly so that they won't break userspace.
905 static void acpi_battery_quirks(struct acpi_battery *battery)
907 if (test_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags))
910 if (battery->full_charge_capacity == 100 &&
911 battery->rate_now == ACPI_BATTERY_VALUE_UNKNOWN &&
912 battery->capacity_now >= 0 && battery->capacity_now <= 100) {
913 set_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags);
914 battery->full_charge_capacity = battery->design_capacity;
915 battery->capacity_now = (battery->capacity_now *
916 battery->full_charge_capacity) / 100;
919 if (test_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH, &battery->flags))
922 if (battery->power_unit && dmi_name_in_vendors("LENOVO")) {
925 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
926 if (s && !strncasecmp(s, "ThinkPad", 8)) {
927 dmi_walk(find_battery, battery);
928 if (test_bit(ACPI_BATTERY_QUIRK_THINKPAD_MAH,
930 battery->design_voltage) {
931 battery->design_capacity =
932 battery->design_capacity *
933 10000 / battery->design_voltage;
934 battery->full_charge_capacity =
935 battery->full_charge_capacity *
936 10000 / battery->design_voltage;
937 battery->design_capacity_warning =
938 battery->design_capacity_warning *
939 10000 / battery->design_voltage;
940 battery->capacity_now = battery->capacity_now *
941 10000 / battery->design_voltage;
946 if (test_bit(ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE, &battery->flags))
949 if (acpi_battery_is_degraded(battery) &&
950 battery->capacity_now > battery->full_charge_capacity) {
951 set_bit(ACPI_BATTERY_QUIRK_DEGRADED_FULL_CHARGE, &battery->flags);
952 battery->capacity_now = battery->full_charge_capacity;
956 static int acpi_battery_update(struct acpi_battery *battery, bool resume)
958 int result = acpi_battery_get_status(battery);
963 if (!acpi_battery_present(battery)) {
964 sysfs_remove_battery(battery);
965 battery->update_time = 0;
972 if (!battery->update_time) {
973 result = acpi_battery_get_info(battery);
976 acpi_battery_init_alarm(battery);
979 result = acpi_battery_get_state(battery);
982 acpi_battery_quirks(battery);
985 result = sysfs_add_battery(battery);
991 * Wakeup the system if battery is critical low
992 * or lower than the alarm level
994 if ((battery->state & ACPI_BATTERY_STATE_CRITICAL) ||
995 (test_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags) &&
996 (battery->capacity_now <= battery->alarm)))
997 acpi_pm_wakeup_event(&battery->device->dev);
1002 static void acpi_battery_refresh(struct acpi_battery *battery)
1009 power_unit = battery->power_unit;
1011 acpi_battery_get_info(battery);
1013 if (power_unit == battery->power_unit)
1016 /* The battery has changed its reporting units. */
1017 sysfs_remove_battery(battery);
1018 sysfs_add_battery(battery);
1021 /* Driver Interface */
1022 static void acpi_battery_notify(struct acpi_device *device, u32 event)
1024 struct acpi_battery *battery = acpi_driver_data(device);
1025 struct power_supply *old;
1031 * On Acer Aspire V5-573G notifications are sometimes triggered too
1032 * early. For example, when AC is unplugged and notification is
1033 * triggered, battery state is still reported as "Full", and changes to
1034 * "Discharging" only after short delay, without any notification.
1036 if (battery_notification_delay_ms > 0)
1037 msleep(battery_notification_delay_ms);
1038 if (event == ACPI_BATTERY_NOTIFY_INFO)
1039 acpi_battery_refresh(battery);
1040 acpi_battery_update(battery, false);
1041 acpi_bus_generate_netlink_event(device->pnp.device_class,
1042 dev_name(&device->dev), event,
1043 acpi_battery_present(battery));
1044 acpi_notifier_call_chain(device, event, acpi_battery_present(battery));
1045 /* acpi_battery_update could remove power_supply object */
1046 if (old && battery->bat)
1047 power_supply_changed(battery->bat);
1050 static int battery_notify(struct notifier_block *nb,
1051 unsigned long mode, void *_unused)
1053 struct acpi_battery *battery = container_of(nb, struct acpi_battery,
1058 case PM_POST_HIBERNATION:
1059 case PM_POST_SUSPEND:
1060 if (!acpi_battery_present(battery))
1064 acpi_battery_refresh(battery);
1066 result = acpi_battery_get_info(battery);
1070 result = sysfs_add_battery(battery);
1075 acpi_battery_init_alarm(battery);
1076 acpi_battery_get_state(battery);
1084 battery_bix_broken_package_quirk(const struct dmi_system_id *d)
1086 battery_bix_broken_package = 1;
1091 battery_notification_delay_quirk(const struct dmi_system_id *d)
1093 battery_notification_delay_ms = 1000;
1098 battery_ac_is_broken_quirk(const struct dmi_system_id *d)
1100 battery_ac_is_broken = 1;
1104 static int __init battery_quirk_not_charging(const struct dmi_system_id *d)
1106 battery_quirk_notcharging = 1;
1110 static const struct dmi_system_id bat_dmi_table[] __initconst = {
1113 .callback = battery_bix_broken_package_quirk,
1115 DMI_MATCH(DMI_SYS_VENDOR, "NEC"),
1116 DMI_MATCH(DMI_PRODUCT_NAME, "PC-LZ750LS"),
1120 /* Acer Aspire V5-573G */
1121 .callback = battery_notification_delay_quirk,
1123 DMI_MATCH(DMI_SYS_VENDOR, "Acer"),
1124 DMI_MATCH(DMI_PRODUCT_NAME, "Aspire V5-573G"),
1128 /* Point of View mobii wintab p800w */
1129 .callback = battery_ac_is_broken_quirk,
1131 DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
1132 DMI_MATCH(DMI_BOARD_NAME, "Aptio CRB"),
1133 DMI_MATCH(DMI_BIOS_VERSION, "3BAIR1013"),
1134 /* Above matches are too generic, add bios-date match */
1135 DMI_MATCH(DMI_BIOS_DATE, "08/22/2014"),
1140 * On Lenovo ThinkPads the BIOS specification defines
1141 * a state when the bits for charging and discharging
1142 * are both set to 0. That state is "Not Charging".
1144 .callback = battery_quirk_not_charging,
1145 .ident = "Lenovo ThinkPad",
1147 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
1148 DMI_MATCH(DMI_PRODUCT_VERSION, "ThinkPad"),
1155 * Some machines'(E,G Lenovo Z480) ECs are not stable
1156 * during boot up and this causes battery driver fails to be
1157 * probed due to failure of getting battery information
1158 * from EC sometimes. After several retries, the operation
1159 * may work. So add retry code here and 20ms sleep between
1162 static int acpi_battery_update_retry(struct acpi_battery *battery)
1166 for (retry = 5; retry; retry--) {
1167 ret = acpi_battery_update(battery, false);
1176 static int acpi_battery_add(struct acpi_device *device)
1179 struct acpi_battery *battery = NULL;
1184 if (device->dep_unmet)
1185 return -EPROBE_DEFER;
1187 battery = kzalloc(sizeof(struct acpi_battery), GFP_KERNEL);
1190 battery->device = device;
1191 strcpy(acpi_device_name(device), ACPI_BATTERY_DEVICE_NAME);
1192 strcpy(acpi_device_class(device), ACPI_BATTERY_CLASS);
1193 device->driver_data = battery;
1194 mutex_init(&battery->lock);
1195 mutex_init(&battery->sysfs_lock);
1196 if (acpi_has_method(battery->device->handle, "_BIX"))
1197 set_bit(ACPI_BATTERY_XINFO_PRESENT, &battery->flags);
1199 result = acpi_battery_update_retry(battery);
1203 pr_info("Slot [%s] (battery %s)\n", acpi_device_bid(device),
1204 device->status.battery_present ? "present" : "absent");
1206 battery->pm_nb.notifier_call = battery_notify;
1207 register_pm_notifier(&battery->pm_nb);
1209 device_init_wakeup(&device->dev, 1);
1214 sysfs_remove_battery(battery);
1215 mutex_destroy(&battery->lock);
1216 mutex_destroy(&battery->sysfs_lock);
1221 static int acpi_battery_remove(struct acpi_device *device)
1223 struct acpi_battery *battery = NULL;
1225 if (!device || !acpi_driver_data(device))
1227 device_init_wakeup(&device->dev, 0);
1228 battery = acpi_driver_data(device);
1229 unregister_pm_notifier(&battery->pm_nb);
1230 sysfs_remove_battery(battery);
1231 mutex_destroy(&battery->lock);
1232 mutex_destroy(&battery->sysfs_lock);
1237 #ifdef CONFIG_PM_SLEEP
1238 /* this is needed to learn about changes made in suspended state */
1239 static int acpi_battery_resume(struct device *dev)
1241 struct acpi_battery *battery;
1246 battery = acpi_driver_data(to_acpi_device(dev));
1250 battery->update_time = 0;
1251 acpi_battery_update(battery, true);
1255 #define acpi_battery_resume NULL
1258 static SIMPLE_DEV_PM_OPS(acpi_battery_pm, NULL, acpi_battery_resume);
1260 static struct acpi_driver acpi_battery_driver = {
1262 .class = ACPI_BATTERY_CLASS,
1263 .ids = battery_device_ids,
1264 .flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
1266 .add = acpi_battery_add,
1267 .remove = acpi_battery_remove,
1268 .notify = acpi_battery_notify,
1270 .drv.pm = &acpi_battery_pm,
1273 static void __init acpi_battery_init_async(void *unused, async_cookie_t cookie)
1277 if (acpi_quirk_skip_acpi_ac_and_battery())
1280 dmi_check_system(bat_dmi_table);
1282 result = acpi_bus_register_driver(&acpi_battery_driver);
1283 battery_driver_registered = (result == 0);
1286 static int __init acpi_battery_init(void)
1291 async_cookie = async_schedule(acpi_battery_init_async, NULL);
1295 static void __exit acpi_battery_exit(void)
1297 async_synchronize_cookie(async_cookie + 1);
1298 if (battery_driver_registered) {
1299 acpi_bus_unregister_driver(&acpi_battery_driver);
1300 battery_hook_exit();
1304 module_init(acpi_battery_init);
1305 module_exit(acpi_battery_exit);