]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/acpi/battery.c
powerpc: Put the gpr save/restore functions in their own section
[karo-tx-linux.git] / drivers / acpi / battery.c
1 /*
2  *  battery.c - ACPI Battery Driver (Revision: 2.0)
3  *
4  *  Copyright (C) 2007 Alexey Starikovskiy <astarikovskiy@suse.de>
5  *  Copyright (C) 2004-2007 Vladimir Lebedev <vladimir.p.lebedev@intel.com>
6  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
7  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
8  *
9  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10  *
11  *  This program is free software; you can redistribute it and/or modify
12  *  it under the terms of the GNU General Public License as published by
13  *  the Free Software Foundation; either version 2 of the License, or (at
14  *  your option) any later version.
15  *
16  *  This program is distributed in the hope that it will be useful, but
17  *  WITHOUT ANY WARRANTY; without even the implied warranty of
18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  *  General Public License for more details.
20  *
21  *  You should have received a copy of the GNU General Public License along
22  *  with this program; if not, write to the Free Software Foundation, Inc.,
23  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
24  *
25  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26  */
27
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/init.h>
31 #include <linux/types.h>
32 #include <linux/jiffies.h>
33 #include <linux/async.h>
34 #include <linux/dmi.h>
35 #include <linux/slab.h>
36 #include <linux/suspend.h>
37
38 #ifdef CONFIG_ACPI_PROCFS_POWER
39 #include <linux/proc_fs.h>
40 #include <linux/seq_file.h>
41 #include <asm/uaccess.h>
42 #endif
43
44 #include <acpi/acpi_bus.h>
45 #include <acpi/acpi_drivers.h>
46 #include <linux/power_supply.h>
47
48 #define PREFIX "ACPI: "
49
50 #define ACPI_BATTERY_VALUE_UNKNOWN 0xFFFFFFFF
51
52 #define ACPI_BATTERY_CLASS              "battery"
53 #define ACPI_BATTERY_DEVICE_NAME        "Battery"
54 #define ACPI_BATTERY_NOTIFY_STATUS      0x80
55 #define ACPI_BATTERY_NOTIFY_INFO        0x81
56 #define ACPI_BATTERY_NOTIFY_THRESHOLD   0x82
57
58 /* Battery power unit: 0 means mW, 1 means mA */
59 #define ACPI_BATTERY_POWER_UNIT_MA      1
60
61 #define _COMPONENT              ACPI_BATTERY_COMPONENT
62
63 ACPI_MODULE_NAME("battery");
64
65 MODULE_AUTHOR("Paul Diefenbaugh");
66 MODULE_AUTHOR("Alexey Starikovskiy <astarikovskiy@suse.de>");
67 MODULE_DESCRIPTION("ACPI Battery Driver");
68 MODULE_LICENSE("GPL");
69
70 static unsigned int cache_time = 1000;
71 module_param(cache_time, uint, 0644);
72 MODULE_PARM_DESC(cache_time, "cache time in milliseconds");
73
74 #ifdef CONFIG_ACPI_PROCFS_POWER
75 extern struct proc_dir_entry *acpi_lock_battery_dir(void);
76 extern void *acpi_unlock_battery_dir(struct proc_dir_entry *acpi_battery_dir);
77
78 enum acpi_battery_files {
79         info_tag = 0,
80         state_tag,
81         alarm_tag,
82         ACPI_BATTERY_NUMFILES,
83 };
84
85 #endif
86
87 static const struct acpi_device_id battery_device_ids[] = {
88         {"PNP0C0A", 0},
89         {"", 0},
90 };
91
92 MODULE_DEVICE_TABLE(acpi, battery_device_ids);
93
94 enum {
95         ACPI_BATTERY_ALARM_PRESENT,
96         ACPI_BATTERY_XINFO_PRESENT,
97         ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY,
98 };
99
100 struct acpi_battery {
101         struct mutex lock;
102         struct mutex sysfs_lock;
103         struct power_supply bat;
104         struct acpi_device *device;
105         struct notifier_block pm_nb;
106         unsigned long update_time;
107         int rate_now;
108         int capacity_now;
109         int voltage_now;
110         int design_capacity;
111         int full_charge_capacity;
112         int technology;
113         int design_voltage;
114         int design_capacity_warning;
115         int design_capacity_low;
116         int cycle_count;
117         int measurement_accuracy;
118         int max_sampling_time;
119         int min_sampling_time;
120         int max_averaging_interval;
121         int min_averaging_interval;
122         int capacity_granularity_1;
123         int capacity_granularity_2;
124         int alarm;
125         char model_number[32];
126         char serial_number[32];
127         char type[32];
128         char oem_info[32];
129         int state;
130         int power_unit;
131         unsigned long flags;
132 };
133
134 #define to_acpi_battery(x) container_of(x, struct acpi_battery, bat)
135
136 inline int acpi_battery_present(struct acpi_battery *battery)
137 {
138         return battery->device->status.battery_present;
139 }
140
141 static int acpi_battery_technology(struct acpi_battery *battery)
142 {
143         if (!strcasecmp("NiCd", battery->type))
144                 return POWER_SUPPLY_TECHNOLOGY_NiCd;
145         if (!strcasecmp("NiMH", battery->type))
146                 return POWER_SUPPLY_TECHNOLOGY_NiMH;
147         if (!strcasecmp("LION", battery->type))
148                 return POWER_SUPPLY_TECHNOLOGY_LION;
149         if (!strncasecmp("LI-ION", battery->type, 6))
150                 return POWER_SUPPLY_TECHNOLOGY_LION;
151         if (!strcasecmp("LiP", battery->type))
152                 return POWER_SUPPLY_TECHNOLOGY_LIPO;
153         return POWER_SUPPLY_TECHNOLOGY_UNKNOWN;
154 }
155
156 static int acpi_battery_get_state(struct acpi_battery *battery);
157
158 static int acpi_battery_is_charged(struct acpi_battery *battery)
159 {
160         /* either charging or discharging */
161         if (battery->state != 0)
162                 return 0;
163
164         /* battery not reporting charge */
165         if (battery->capacity_now == ACPI_BATTERY_VALUE_UNKNOWN ||
166             battery->capacity_now == 0)
167                 return 0;
168
169         /* good batteries update full_charge as the batteries degrade */
170         if (battery->full_charge_capacity == battery->capacity_now)
171                 return 1;
172
173         /* fallback to using design values for broken batteries */
174         if (battery->design_capacity == battery->capacity_now)
175                 return 1;
176
177         /* we don't do any sort of metric based on percentages */
178         return 0;
179 }
180
181 static int acpi_battery_get_property(struct power_supply *psy,
182                                      enum power_supply_property psp,
183                                      union power_supply_propval *val)
184 {
185         int ret = 0;
186         struct acpi_battery *battery = to_acpi_battery(psy);
187
188         if (acpi_battery_present(battery)) {
189                 /* run battery update only if it is present */
190                 acpi_battery_get_state(battery);
191         } else if (psp != POWER_SUPPLY_PROP_PRESENT)
192                 return -ENODEV;
193         switch (psp) {
194         case POWER_SUPPLY_PROP_STATUS:
195                 if (battery->state & 0x01)
196                         val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
197                 else if (battery->state & 0x02)
198                         val->intval = POWER_SUPPLY_STATUS_CHARGING;
199                 else if (acpi_battery_is_charged(battery))
200                         val->intval = POWER_SUPPLY_STATUS_FULL;
201                 else
202                         val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
203                 break;
204         case POWER_SUPPLY_PROP_PRESENT:
205                 val->intval = acpi_battery_present(battery);
206                 break;
207         case POWER_SUPPLY_PROP_TECHNOLOGY:
208                 val->intval = acpi_battery_technology(battery);
209                 break;
210         case POWER_SUPPLY_PROP_CYCLE_COUNT:
211                 val->intval = battery->cycle_count;
212                 break;
213         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
214                 if (battery->design_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
215                         ret = -ENODEV;
216                 else
217                         val->intval = battery->design_voltage * 1000;
218                 break;
219         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
220                 if (battery->voltage_now == ACPI_BATTERY_VALUE_UNKNOWN)
221                         ret = -ENODEV;
222                 else
223                         val->intval = battery->voltage_now * 1000;
224                 break;
225         case POWER_SUPPLY_PROP_CURRENT_NOW:
226         case POWER_SUPPLY_PROP_POWER_NOW:
227                 if (battery->rate_now == ACPI_BATTERY_VALUE_UNKNOWN)
228                         ret = -ENODEV;
229                 else
230                         val->intval = battery->rate_now * 1000;
231                 break;
232         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
233         case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
234                 if (battery->design_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
235                         ret = -ENODEV;
236                 else
237                         val->intval = battery->design_capacity * 1000;
238                 break;
239         case POWER_SUPPLY_PROP_CHARGE_FULL:
240         case POWER_SUPPLY_PROP_ENERGY_FULL:
241                 if (battery->full_charge_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
242                         ret = -ENODEV;
243                 else
244                         val->intval = battery->full_charge_capacity * 1000;
245                 break;
246         case POWER_SUPPLY_PROP_CHARGE_NOW:
247         case POWER_SUPPLY_PROP_ENERGY_NOW:
248                 if (battery->capacity_now == ACPI_BATTERY_VALUE_UNKNOWN)
249                         ret = -ENODEV;
250                 else
251                         val->intval = battery->capacity_now * 1000;
252                 break;
253         case POWER_SUPPLY_PROP_MODEL_NAME:
254                 val->strval = battery->model_number;
255                 break;
256         case POWER_SUPPLY_PROP_MANUFACTURER:
257                 val->strval = battery->oem_info;
258                 break;
259         case POWER_SUPPLY_PROP_SERIAL_NUMBER:
260                 val->strval = battery->serial_number;
261                 break;
262         default:
263                 ret = -EINVAL;
264         }
265         return ret;
266 }
267
268 static enum power_supply_property charge_battery_props[] = {
269         POWER_SUPPLY_PROP_STATUS,
270         POWER_SUPPLY_PROP_PRESENT,
271         POWER_SUPPLY_PROP_TECHNOLOGY,
272         POWER_SUPPLY_PROP_CYCLE_COUNT,
273         POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
274         POWER_SUPPLY_PROP_VOLTAGE_NOW,
275         POWER_SUPPLY_PROP_CURRENT_NOW,
276         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
277         POWER_SUPPLY_PROP_CHARGE_FULL,
278         POWER_SUPPLY_PROP_CHARGE_NOW,
279         POWER_SUPPLY_PROP_MODEL_NAME,
280         POWER_SUPPLY_PROP_MANUFACTURER,
281         POWER_SUPPLY_PROP_SERIAL_NUMBER,
282 };
283
284 static enum power_supply_property energy_battery_props[] = {
285         POWER_SUPPLY_PROP_STATUS,
286         POWER_SUPPLY_PROP_PRESENT,
287         POWER_SUPPLY_PROP_TECHNOLOGY,
288         POWER_SUPPLY_PROP_CYCLE_COUNT,
289         POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
290         POWER_SUPPLY_PROP_VOLTAGE_NOW,
291         POWER_SUPPLY_PROP_POWER_NOW,
292         POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
293         POWER_SUPPLY_PROP_ENERGY_FULL,
294         POWER_SUPPLY_PROP_ENERGY_NOW,
295         POWER_SUPPLY_PROP_MODEL_NAME,
296         POWER_SUPPLY_PROP_MANUFACTURER,
297         POWER_SUPPLY_PROP_SERIAL_NUMBER,
298 };
299
300 #ifdef CONFIG_ACPI_PROCFS_POWER
301 inline char *acpi_battery_units(struct acpi_battery *battery)
302 {
303         return (battery->power_unit == ACPI_BATTERY_POWER_UNIT_MA) ?
304                 "mA" : "mW";
305 }
306 #endif
307
308 /* --------------------------------------------------------------------------
309                                Battery Management
310    -------------------------------------------------------------------------- */
311 struct acpi_offsets {
312         size_t offset;          /* offset inside struct acpi_sbs_battery */
313         u8 mode;                /* int or string? */
314 };
315
316 static struct acpi_offsets state_offsets[] = {
317         {offsetof(struct acpi_battery, state), 0},
318         {offsetof(struct acpi_battery, rate_now), 0},
319         {offsetof(struct acpi_battery, capacity_now), 0},
320         {offsetof(struct acpi_battery, voltage_now), 0},
321 };
322
323 static struct acpi_offsets info_offsets[] = {
324         {offsetof(struct acpi_battery, power_unit), 0},
325         {offsetof(struct acpi_battery, design_capacity), 0},
326         {offsetof(struct acpi_battery, full_charge_capacity), 0},
327         {offsetof(struct acpi_battery, technology), 0},
328         {offsetof(struct acpi_battery, design_voltage), 0},
329         {offsetof(struct acpi_battery, design_capacity_warning), 0},
330         {offsetof(struct acpi_battery, design_capacity_low), 0},
331         {offsetof(struct acpi_battery, capacity_granularity_1), 0},
332         {offsetof(struct acpi_battery, capacity_granularity_2), 0},
333         {offsetof(struct acpi_battery, model_number), 1},
334         {offsetof(struct acpi_battery, serial_number), 1},
335         {offsetof(struct acpi_battery, type), 1},
336         {offsetof(struct acpi_battery, oem_info), 1},
337 };
338
339 static struct acpi_offsets extended_info_offsets[] = {
340         {offsetof(struct acpi_battery, power_unit), 0},
341         {offsetof(struct acpi_battery, design_capacity), 0},
342         {offsetof(struct acpi_battery, full_charge_capacity), 0},
343         {offsetof(struct acpi_battery, technology), 0},
344         {offsetof(struct acpi_battery, design_voltage), 0},
345         {offsetof(struct acpi_battery, design_capacity_warning), 0},
346         {offsetof(struct acpi_battery, design_capacity_low), 0},
347         {offsetof(struct acpi_battery, cycle_count), 0},
348         {offsetof(struct acpi_battery, measurement_accuracy), 0},
349         {offsetof(struct acpi_battery, max_sampling_time), 0},
350         {offsetof(struct acpi_battery, min_sampling_time), 0},
351         {offsetof(struct acpi_battery, max_averaging_interval), 0},
352         {offsetof(struct acpi_battery, min_averaging_interval), 0},
353         {offsetof(struct acpi_battery, capacity_granularity_1), 0},
354         {offsetof(struct acpi_battery, capacity_granularity_2), 0},
355         {offsetof(struct acpi_battery, model_number), 1},
356         {offsetof(struct acpi_battery, serial_number), 1},
357         {offsetof(struct acpi_battery, type), 1},
358         {offsetof(struct acpi_battery, oem_info), 1},
359 };
360
361 static int extract_package(struct acpi_battery *battery,
362                            union acpi_object *package,
363                            struct acpi_offsets *offsets, int num)
364 {
365         int i;
366         union acpi_object *element;
367         if (package->type != ACPI_TYPE_PACKAGE)
368                 return -EFAULT;
369         for (i = 0; i < num; ++i) {
370                 if (package->package.count <= i)
371                         return -EFAULT;
372                 element = &package->package.elements[i];
373                 if (offsets[i].mode) {
374                         u8 *ptr = (u8 *)battery + offsets[i].offset;
375                         if (element->type == ACPI_TYPE_STRING ||
376                             element->type == ACPI_TYPE_BUFFER)
377                                 strncpy(ptr, element->string.pointer, 32);
378                         else if (element->type == ACPI_TYPE_INTEGER) {
379                                 strncpy(ptr, (u8 *)&element->integer.value,
380                                         sizeof(u64));
381                                 ptr[sizeof(u64)] = 0;
382                         } else
383                                 *ptr = 0; /* don't have value */
384                 } else {
385                         int *x = (int *)((u8 *)battery + offsets[i].offset);
386                         *x = (element->type == ACPI_TYPE_INTEGER) ?
387                                 element->integer.value : -1;
388                 }
389         }
390         return 0;
391 }
392
393 static int acpi_battery_get_status(struct acpi_battery *battery)
394 {
395         if (acpi_bus_get_status(battery->device)) {
396                 ACPI_EXCEPTION((AE_INFO, AE_ERROR, "Evaluating _STA"));
397                 return -ENODEV;
398         }
399         return 0;
400 }
401
402 static int acpi_battery_get_info(struct acpi_battery *battery)
403 {
404         int result = -EFAULT;
405         acpi_status status = 0;
406         char *name = test_bit(ACPI_BATTERY_XINFO_PRESENT, &battery->flags)?
407                         "_BIX" : "_BIF";
408
409         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
410
411         if (!acpi_battery_present(battery))
412                 return 0;
413         mutex_lock(&battery->lock);
414         status = acpi_evaluate_object(battery->device->handle, name,
415                                                 NULL, &buffer);
416         mutex_unlock(&battery->lock);
417
418         if (ACPI_FAILURE(status)) {
419                 ACPI_EXCEPTION((AE_INFO, status, "Evaluating %s", name));
420                 return -ENODEV;
421         }
422         if (test_bit(ACPI_BATTERY_XINFO_PRESENT, &battery->flags))
423                 result = extract_package(battery, buffer.pointer,
424                                 extended_info_offsets,
425                                 ARRAY_SIZE(extended_info_offsets));
426         else
427                 result = extract_package(battery, buffer.pointer,
428                                 info_offsets, ARRAY_SIZE(info_offsets));
429         kfree(buffer.pointer);
430         if (test_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags))
431                 battery->full_charge_capacity = battery->design_capacity;
432         return result;
433 }
434
435 static int acpi_battery_get_state(struct acpi_battery *battery)
436 {
437         int result = 0;
438         acpi_status status = 0;
439         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
440
441         if (!acpi_battery_present(battery))
442                 return 0;
443
444         if (battery->update_time &&
445             time_before(jiffies, battery->update_time +
446                         msecs_to_jiffies(cache_time)))
447                 return 0;
448
449         mutex_lock(&battery->lock);
450         status = acpi_evaluate_object(battery->device->handle, "_BST",
451                                       NULL, &buffer);
452         mutex_unlock(&battery->lock);
453
454         if (ACPI_FAILURE(status)) {
455                 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _BST"));
456                 return -ENODEV;
457         }
458
459         result = extract_package(battery, buffer.pointer,
460                                  state_offsets, ARRAY_SIZE(state_offsets));
461         battery->update_time = jiffies;
462         kfree(buffer.pointer);
463
464         /* For buggy DSDTs that report negative 16-bit values for either
465          * charging or discharging current and/or report 0 as 65536
466          * due to bad math.
467          */
468         if (battery->power_unit == ACPI_BATTERY_POWER_UNIT_MA &&
469                 battery->rate_now != ACPI_BATTERY_VALUE_UNKNOWN &&
470                 (s16)(battery->rate_now) < 0) {
471                 battery->rate_now = abs((s16)battery->rate_now);
472                 printk_once(KERN_WARNING FW_BUG "battery: (dis)charge rate"
473                         " invalid.\n");
474         }
475
476         if (test_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags)
477             && battery->capacity_now >= 0 && battery->capacity_now <= 100)
478                 battery->capacity_now = (battery->capacity_now *
479                                 battery->full_charge_capacity) / 100;
480         return result;
481 }
482
483 static int acpi_battery_set_alarm(struct acpi_battery *battery)
484 {
485         acpi_status status = 0;
486         union acpi_object arg0 = { .type = ACPI_TYPE_INTEGER };
487         struct acpi_object_list arg_list = { 1, &arg0 };
488
489         if (!acpi_battery_present(battery) ||
490             !test_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags))
491                 return -ENODEV;
492
493         arg0.integer.value = battery->alarm;
494
495         mutex_lock(&battery->lock);
496         status = acpi_evaluate_object(battery->device->handle, "_BTP",
497                                  &arg_list, NULL);
498         mutex_unlock(&battery->lock);
499
500         if (ACPI_FAILURE(status))
501                 return -ENODEV;
502
503         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Alarm set to %d\n", battery->alarm));
504         return 0;
505 }
506
507 static int acpi_battery_init_alarm(struct acpi_battery *battery)
508 {
509         acpi_status status = AE_OK;
510         acpi_handle handle = NULL;
511
512         /* See if alarms are supported, and if so, set default */
513         status = acpi_get_handle(battery->device->handle, "_BTP", &handle);
514         if (ACPI_FAILURE(status)) {
515                 clear_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags);
516                 return 0;
517         }
518         set_bit(ACPI_BATTERY_ALARM_PRESENT, &battery->flags);
519         if (!battery->alarm)
520                 battery->alarm = battery->design_capacity_warning;
521         return acpi_battery_set_alarm(battery);
522 }
523
524 static ssize_t acpi_battery_alarm_show(struct device *dev,
525                                         struct device_attribute *attr,
526                                         char *buf)
527 {
528         struct acpi_battery *battery = to_acpi_battery(dev_get_drvdata(dev));
529         return sprintf(buf, "%d\n", battery->alarm * 1000);
530 }
531
532 static ssize_t acpi_battery_alarm_store(struct device *dev,
533                                         struct device_attribute *attr,
534                                         const char *buf, size_t count)
535 {
536         unsigned long x;
537         struct acpi_battery *battery = to_acpi_battery(dev_get_drvdata(dev));
538         if (sscanf(buf, "%ld\n", &x) == 1)
539                 battery->alarm = x/1000;
540         if (acpi_battery_present(battery))
541                 acpi_battery_set_alarm(battery);
542         return count;
543 }
544
545 static struct device_attribute alarm_attr = {
546         .attr = {.name = "alarm", .mode = 0644},
547         .show = acpi_battery_alarm_show,
548         .store = acpi_battery_alarm_store,
549 };
550
551 static int sysfs_add_battery(struct acpi_battery *battery)
552 {
553         int result;
554
555         if (battery->power_unit == ACPI_BATTERY_POWER_UNIT_MA) {
556                 battery->bat.properties = charge_battery_props;
557                 battery->bat.num_properties =
558                         ARRAY_SIZE(charge_battery_props);
559         } else {
560                 battery->bat.properties = energy_battery_props;
561                 battery->bat.num_properties =
562                         ARRAY_SIZE(energy_battery_props);
563         }
564
565         battery->bat.name = acpi_device_bid(battery->device);
566         battery->bat.type = POWER_SUPPLY_TYPE_BATTERY;
567         battery->bat.get_property = acpi_battery_get_property;
568
569         result = power_supply_register(&battery->device->dev, &battery->bat);
570         if (result)
571                 return result;
572         return device_create_file(battery->bat.dev, &alarm_attr);
573 }
574
575 static void sysfs_remove_battery(struct acpi_battery *battery)
576 {
577         mutex_lock(&battery->sysfs_lock);
578         if (!battery->bat.dev) {
579                 mutex_unlock(&battery->sysfs_lock);
580                 return;
581         }
582
583         device_remove_file(battery->bat.dev, &alarm_attr);
584         power_supply_unregister(&battery->bat);
585         battery->bat.dev = NULL;
586         mutex_unlock(&battery->sysfs_lock);
587 }
588
589 /*
590  * According to the ACPI spec, some kinds of primary batteries can
591  * report percentage battery remaining capacity directly to OS.
592  * In this case, it reports the Last Full Charged Capacity == 100
593  * and BatteryPresentRate == 0xFFFFFFFF.
594  *
595  * Now we found some battery reports percentage remaining capacity
596  * even if it's rechargeable.
597  * https://bugzilla.kernel.org/show_bug.cgi?id=15979
598  *
599  * Handle this correctly so that they won't break userspace.
600  */
601 static void acpi_battery_quirks(struct acpi_battery *battery)
602 {
603         if (test_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags))
604                 return ;
605
606         if (battery->full_charge_capacity == 100 &&
607             battery->rate_now == ACPI_BATTERY_VALUE_UNKNOWN &&
608             battery->capacity_now >=0 && battery->capacity_now <= 100) {
609                 set_bit(ACPI_BATTERY_QUIRK_PERCENTAGE_CAPACITY, &battery->flags);
610                 battery->full_charge_capacity = battery->design_capacity;
611                 battery->capacity_now = (battery->capacity_now *
612                                 battery->full_charge_capacity) / 100;
613         }
614 }
615
616 static int acpi_battery_update(struct acpi_battery *battery)
617 {
618         int result, old_present = acpi_battery_present(battery);
619         result = acpi_battery_get_status(battery);
620         if (result)
621                 return result;
622         if (!acpi_battery_present(battery)) {
623                 sysfs_remove_battery(battery);
624                 battery->update_time = 0;
625                 return 0;
626         }
627         if (!battery->update_time ||
628             old_present != acpi_battery_present(battery)) {
629                 result = acpi_battery_get_info(battery);
630                 if (result)
631                         return result;
632                 acpi_battery_init_alarm(battery);
633         }
634         if (!battery->bat.dev) {
635                 result = sysfs_add_battery(battery);
636                 if (result)
637                         return result;
638         }
639         result = acpi_battery_get_state(battery);
640         acpi_battery_quirks(battery);
641         return result;
642 }
643
644 static void acpi_battery_refresh(struct acpi_battery *battery)
645 {
646         int power_unit;
647
648         if (!battery->bat.dev)
649                 return;
650
651         power_unit = battery->power_unit;
652
653         acpi_battery_get_info(battery);
654
655         if (power_unit == battery->power_unit)
656                 return;
657
658         /* The battery has changed its reporting units. */
659         sysfs_remove_battery(battery);
660         sysfs_add_battery(battery);
661 }
662
663 /* --------------------------------------------------------------------------
664                               FS Interface (/proc)
665    -------------------------------------------------------------------------- */
666
667 #ifdef CONFIG_ACPI_PROCFS_POWER
668 static struct proc_dir_entry *acpi_battery_dir;
669
670 static int acpi_battery_print_info(struct seq_file *seq, int result)
671 {
672         struct acpi_battery *battery = seq->private;
673
674         if (result)
675                 goto end;
676
677         seq_printf(seq, "present:                 %s\n",
678                    acpi_battery_present(battery)?"yes":"no");
679         if (!acpi_battery_present(battery))
680                 goto end;
681         if (battery->design_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
682                 seq_printf(seq, "design capacity:         unknown\n");
683         else
684                 seq_printf(seq, "design capacity:         %d %sh\n",
685                            battery->design_capacity,
686                            acpi_battery_units(battery));
687
688         if (battery->full_charge_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
689                 seq_printf(seq, "last full capacity:      unknown\n");
690         else
691                 seq_printf(seq, "last full capacity:      %d %sh\n",
692                            battery->full_charge_capacity,
693                            acpi_battery_units(battery));
694
695         seq_printf(seq, "battery technology:      %srechargeable\n",
696                    (!battery->technology)?"non-":"");
697
698         if (battery->design_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
699                 seq_printf(seq, "design voltage:          unknown\n");
700         else
701                 seq_printf(seq, "design voltage:          %d mV\n",
702                            battery->design_voltage);
703         seq_printf(seq, "design capacity warning: %d %sh\n",
704                    battery->design_capacity_warning,
705                    acpi_battery_units(battery));
706         seq_printf(seq, "design capacity low:     %d %sh\n",
707                    battery->design_capacity_low,
708                    acpi_battery_units(battery));
709         seq_printf(seq, "cycle count:             %i\n", battery->cycle_count);
710         seq_printf(seq, "capacity granularity 1:  %d %sh\n",
711                    battery->capacity_granularity_1,
712                    acpi_battery_units(battery));
713         seq_printf(seq, "capacity granularity 2:  %d %sh\n",
714                    battery->capacity_granularity_2,
715                    acpi_battery_units(battery));
716         seq_printf(seq, "model number:            %s\n", battery->model_number);
717         seq_printf(seq, "serial number:           %s\n", battery->serial_number);
718         seq_printf(seq, "battery type:            %s\n", battery->type);
719         seq_printf(seq, "OEM info:                %s\n", battery->oem_info);
720       end:
721         if (result)
722                 seq_printf(seq, "ERROR: Unable to read battery info\n");
723         return result;
724 }
725
726 static int acpi_battery_print_state(struct seq_file *seq, int result)
727 {
728         struct acpi_battery *battery = seq->private;
729
730         if (result)
731                 goto end;
732
733         seq_printf(seq, "present:                 %s\n",
734                    acpi_battery_present(battery)?"yes":"no");
735         if (!acpi_battery_present(battery))
736                 goto end;
737
738         seq_printf(seq, "capacity state:          %s\n",
739                         (battery->state & 0x04)?"critical":"ok");
740         if ((battery->state & 0x01) && (battery->state & 0x02))
741                 seq_printf(seq,
742                            "charging state:          charging/discharging\n");
743         else if (battery->state & 0x01)
744                 seq_printf(seq, "charging state:          discharging\n");
745         else if (battery->state & 0x02)
746                 seq_printf(seq, "charging state:          charging\n");
747         else
748                 seq_printf(seq, "charging state:          charged\n");
749
750         if (battery->rate_now == ACPI_BATTERY_VALUE_UNKNOWN)
751                 seq_printf(seq, "present rate:            unknown\n");
752         else
753                 seq_printf(seq, "present rate:            %d %s\n",
754                            battery->rate_now, acpi_battery_units(battery));
755
756         if (battery->capacity_now == ACPI_BATTERY_VALUE_UNKNOWN)
757                 seq_printf(seq, "remaining capacity:      unknown\n");
758         else
759                 seq_printf(seq, "remaining capacity:      %d %sh\n",
760                            battery->capacity_now, acpi_battery_units(battery));
761         if (battery->voltage_now == ACPI_BATTERY_VALUE_UNKNOWN)
762                 seq_printf(seq, "present voltage:         unknown\n");
763         else
764                 seq_printf(seq, "present voltage:         %d mV\n",
765                            battery->voltage_now);
766       end:
767         if (result)
768                 seq_printf(seq, "ERROR: Unable to read battery state\n");
769
770         return result;
771 }
772
773 static int acpi_battery_print_alarm(struct seq_file *seq, int result)
774 {
775         struct acpi_battery *battery = seq->private;
776
777         if (result)
778                 goto end;
779
780         if (!acpi_battery_present(battery)) {
781                 seq_printf(seq, "present:                 no\n");
782                 goto end;
783         }
784         seq_printf(seq, "alarm:                   ");
785         if (!battery->alarm)
786                 seq_printf(seq, "unsupported\n");
787         else
788                 seq_printf(seq, "%u %sh\n", battery->alarm,
789                                 acpi_battery_units(battery));
790       end:
791         if (result)
792                 seq_printf(seq, "ERROR: Unable to read battery alarm\n");
793         return result;
794 }
795
796 static ssize_t acpi_battery_write_alarm(struct file *file,
797                                         const char __user * buffer,
798                                         size_t count, loff_t * ppos)
799 {
800         int result = 0;
801         char alarm_string[12] = { '\0' };
802         struct seq_file *m = file->private_data;
803         struct acpi_battery *battery = m->private;
804
805         if (!battery || (count > sizeof(alarm_string) - 1))
806                 return -EINVAL;
807         if (!acpi_battery_present(battery)) {
808                 result = -ENODEV;
809                 goto end;
810         }
811         if (copy_from_user(alarm_string, buffer, count)) {
812                 result = -EFAULT;
813                 goto end;
814         }
815         alarm_string[count] = '\0';
816         battery->alarm = simple_strtol(alarm_string, NULL, 0);
817         result = acpi_battery_set_alarm(battery);
818       end:
819         if (!result)
820                 return count;
821         return result;
822 }
823
824 typedef int(*print_func)(struct seq_file *seq, int result);
825
826 static print_func acpi_print_funcs[ACPI_BATTERY_NUMFILES] = {
827         acpi_battery_print_info,
828         acpi_battery_print_state,
829         acpi_battery_print_alarm,
830 };
831
832 static int acpi_battery_read(int fid, struct seq_file *seq)
833 {
834         struct acpi_battery *battery = seq->private;
835         int result = acpi_battery_update(battery);
836         return acpi_print_funcs[fid](seq, result);
837 }
838
839 #define DECLARE_FILE_FUNCTIONS(_name) \
840 static int acpi_battery_read_##_name(struct seq_file *seq, void *offset) \
841 { \
842         return acpi_battery_read(_name##_tag, seq); \
843 } \
844 static int acpi_battery_##_name##_open_fs(struct inode *inode, struct file *file) \
845 { \
846         return single_open(file, acpi_battery_read_##_name, PDE(inode)->data); \
847 }
848
849 DECLARE_FILE_FUNCTIONS(info);
850 DECLARE_FILE_FUNCTIONS(state);
851 DECLARE_FILE_FUNCTIONS(alarm);
852
853 #undef DECLARE_FILE_FUNCTIONS
854
855 #define FILE_DESCRIPTION_RO(_name) \
856         { \
857         .name = __stringify(_name), \
858         .mode = S_IRUGO, \
859         .ops = { \
860                 .open = acpi_battery_##_name##_open_fs, \
861                 .read = seq_read, \
862                 .llseek = seq_lseek, \
863                 .release = single_release, \
864                 .owner = THIS_MODULE, \
865                 }, \
866         }
867
868 #define FILE_DESCRIPTION_RW(_name) \
869         { \
870         .name = __stringify(_name), \
871         .mode = S_IFREG | S_IRUGO | S_IWUSR, \
872         .ops = { \
873                 .open = acpi_battery_##_name##_open_fs, \
874                 .read = seq_read, \
875                 .llseek = seq_lseek, \
876                 .write = acpi_battery_write_##_name, \
877                 .release = single_release, \
878                 .owner = THIS_MODULE, \
879                 }, \
880         }
881
882 static const struct battery_file {
883         struct file_operations ops;
884         umode_t mode;
885         const char *name;
886 } acpi_battery_file[] = {
887         FILE_DESCRIPTION_RO(info),
888         FILE_DESCRIPTION_RO(state),
889         FILE_DESCRIPTION_RW(alarm),
890 };
891
892 #undef FILE_DESCRIPTION_RO
893 #undef FILE_DESCRIPTION_RW
894
895 static int acpi_battery_add_fs(struct acpi_device *device)
896 {
897         struct proc_dir_entry *entry = NULL;
898         int i;
899
900         printk(KERN_WARNING PREFIX "Deprecated procfs I/F for battery is loaded,"
901                         " please retry with CONFIG_ACPI_PROCFS_POWER cleared\n");
902         if (!acpi_device_dir(device)) {
903                 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
904                                                      acpi_battery_dir);
905                 if (!acpi_device_dir(device))
906                         return -ENODEV;
907         }
908
909         for (i = 0; i < ACPI_BATTERY_NUMFILES; ++i) {
910                 entry = proc_create_data(acpi_battery_file[i].name,
911                                          acpi_battery_file[i].mode,
912                                          acpi_device_dir(device),
913                                          &acpi_battery_file[i].ops,
914                                          acpi_driver_data(device));
915                 if (!entry)
916                         return -ENODEV;
917         }
918         return 0;
919 }
920
921 static void acpi_battery_remove_fs(struct acpi_device *device)
922 {
923         int i;
924         if (!acpi_device_dir(device))
925                 return;
926         for (i = 0; i < ACPI_BATTERY_NUMFILES; ++i)
927                 remove_proc_entry(acpi_battery_file[i].name,
928                                   acpi_device_dir(device));
929
930         remove_proc_entry(acpi_device_bid(device), acpi_battery_dir);
931         acpi_device_dir(device) = NULL;
932 }
933
934 #endif
935
936 /* --------------------------------------------------------------------------
937                                  Driver Interface
938    -------------------------------------------------------------------------- */
939
940 static void acpi_battery_notify(struct acpi_device *device, u32 event)
941 {
942         struct acpi_battery *battery = acpi_driver_data(device);
943         struct device *old;
944
945         if (!battery)
946                 return;
947         old = battery->bat.dev;
948         if (event == ACPI_BATTERY_NOTIFY_INFO)
949                 acpi_battery_refresh(battery);
950         acpi_battery_update(battery);
951         acpi_bus_generate_proc_event(device, event,
952                                      acpi_battery_present(battery));
953         acpi_bus_generate_netlink_event(device->pnp.device_class,
954                                         dev_name(&device->dev), event,
955                                         acpi_battery_present(battery));
956         /* acpi_battery_update could remove power_supply object */
957         if (old && battery->bat.dev)
958                 power_supply_changed(&battery->bat);
959 }
960
961 static int battery_notify(struct notifier_block *nb,
962                                unsigned long mode, void *_unused)
963 {
964         struct acpi_battery *battery = container_of(nb, struct acpi_battery,
965                                                     pm_nb);
966         switch (mode) {
967         case PM_POST_HIBERNATION:
968         case PM_POST_SUSPEND:
969                 if (battery->bat.dev) {
970                         sysfs_remove_battery(battery);
971                         sysfs_add_battery(battery);
972                 }
973                 break;
974         }
975
976         return 0;
977 }
978
979 static int acpi_battery_add(struct acpi_device *device)
980 {
981         int result = 0;
982         struct acpi_battery *battery = NULL;
983         acpi_handle handle;
984         if (!device)
985                 return -EINVAL;
986         battery = kzalloc(sizeof(struct acpi_battery), GFP_KERNEL);
987         if (!battery)
988                 return -ENOMEM;
989         battery->device = device;
990         strcpy(acpi_device_name(device), ACPI_BATTERY_DEVICE_NAME);
991         strcpy(acpi_device_class(device), ACPI_BATTERY_CLASS);
992         device->driver_data = battery;
993         mutex_init(&battery->lock);
994         mutex_init(&battery->sysfs_lock);
995         if (ACPI_SUCCESS(acpi_get_handle(battery->device->handle,
996                         "_BIX", &handle)))
997                 set_bit(ACPI_BATTERY_XINFO_PRESENT, &battery->flags);
998         result = acpi_battery_update(battery);
999         if (result)
1000                 goto fail;
1001 #ifdef CONFIG_ACPI_PROCFS_POWER
1002         result = acpi_battery_add_fs(device);
1003 #endif
1004         if (result) {
1005 #ifdef CONFIG_ACPI_PROCFS_POWER
1006                 acpi_battery_remove_fs(device);
1007 #endif
1008                 goto fail;
1009         }
1010
1011         printk(KERN_INFO PREFIX "%s Slot [%s] (battery %s)\n",
1012                 ACPI_BATTERY_DEVICE_NAME, acpi_device_bid(device),
1013                 device->status.battery_present ? "present" : "absent");
1014
1015         battery->pm_nb.notifier_call = battery_notify;
1016         register_pm_notifier(&battery->pm_nb);
1017
1018         return result;
1019
1020 fail:
1021         sysfs_remove_battery(battery);
1022         mutex_destroy(&battery->lock);
1023         mutex_destroy(&battery->sysfs_lock);
1024         kfree(battery);
1025         return result;
1026 }
1027
1028 static int acpi_battery_remove(struct acpi_device *device, int type)
1029 {
1030         struct acpi_battery *battery = NULL;
1031
1032         if (!device || !acpi_driver_data(device))
1033                 return -EINVAL;
1034         battery = acpi_driver_data(device);
1035         unregister_pm_notifier(&battery->pm_nb);
1036 #ifdef CONFIG_ACPI_PROCFS_POWER
1037         acpi_battery_remove_fs(device);
1038 #endif
1039         sysfs_remove_battery(battery);
1040         mutex_destroy(&battery->lock);
1041         mutex_destroy(&battery->sysfs_lock);
1042         kfree(battery);
1043         return 0;
1044 }
1045
1046 /* this is needed to learn about changes made in suspended state */
1047 static int acpi_battery_resume(struct acpi_device *device)
1048 {
1049         struct acpi_battery *battery;
1050         if (!device)
1051                 return -EINVAL;
1052         battery = acpi_driver_data(device);
1053         battery->update_time = 0;
1054         acpi_battery_update(battery);
1055         return 0;
1056 }
1057
1058 static struct acpi_driver acpi_battery_driver = {
1059         .name = "battery",
1060         .class = ACPI_BATTERY_CLASS,
1061         .ids = battery_device_ids,
1062         .flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
1063         .ops = {
1064                 .add = acpi_battery_add,
1065                 .resume = acpi_battery_resume,
1066                 .remove = acpi_battery_remove,
1067                 .notify = acpi_battery_notify,
1068                 },
1069 };
1070
1071 static void __init acpi_battery_init_async(void *unused, async_cookie_t cookie)
1072 {
1073         if (acpi_disabled)
1074                 return;
1075 #ifdef CONFIG_ACPI_PROCFS_POWER
1076         acpi_battery_dir = acpi_lock_battery_dir();
1077         if (!acpi_battery_dir)
1078                 return;
1079 #endif
1080         if (acpi_bus_register_driver(&acpi_battery_driver) < 0) {
1081 #ifdef CONFIG_ACPI_PROCFS_POWER
1082                 acpi_unlock_battery_dir(acpi_battery_dir);
1083 #endif
1084                 return;
1085         }
1086         return;
1087 }
1088
1089 static int __init acpi_battery_init(void)
1090 {
1091         async_schedule(acpi_battery_init_async, NULL);
1092         return 0;
1093 }
1094
1095 static void __exit acpi_battery_exit(void)
1096 {
1097         acpi_bus_unregister_driver(&acpi_battery_driver);
1098 #ifdef CONFIG_ACPI_PROCFS_POWER
1099         acpi_unlock_battery_dir(acpi_battery_dir);
1100 #endif
1101 }
1102
1103 module_init(acpi_battery_init);
1104 module_exit(acpi_battery_exit);