2 * acpi_battery.c - ACPI Battery Driver ($Revision: 37 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/types.h>
30 #include <linux/proc_fs.h>
31 #include <linux/seq_file.h>
32 #include <asm/uaccess.h>
34 #include <acpi/acpi_bus.h>
35 #include <acpi/acpi_drivers.h>
37 #define ACPI_BATTERY_VALUE_UNKNOWN 0xFFFFFFFF
39 #define ACPI_BATTERY_FORMAT_BIF "NNNNNNNNNSSSS"
40 #define ACPI_BATTERY_FORMAT_BST "NNNN"
42 #define ACPI_BATTERY_COMPONENT 0x00040000
43 #define ACPI_BATTERY_CLASS "battery"
44 #define ACPI_BATTERY_HID "PNP0C0A"
45 #define ACPI_BATTERY_DRIVER_NAME "ACPI Battery Driver"
46 #define ACPI_BATTERY_DEVICE_NAME "Battery"
47 #define ACPI_BATTERY_FILE_INFO "info"
48 #define ACPI_BATTERY_FILE_STATUS "state"
49 #define ACPI_BATTERY_FILE_ALARM "alarm"
50 #define ACPI_BATTERY_NOTIFY_STATUS 0x80
51 #define ACPI_BATTERY_NOTIFY_INFO 0x81
52 #define ACPI_BATTERY_UNITS_WATTS "mW"
53 #define ACPI_BATTERY_UNITS_AMPS "mA"
55 #define _COMPONENT ACPI_BATTERY_COMPONENT
56 ACPI_MODULE_NAME("acpi_battery")
58 MODULE_AUTHOR("Paul Diefenbaugh");
59 MODULE_DESCRIPTION(ACPI_BATTERY_DRIVER_NAME);
60 MODULE_LICENSE("GPL");
62 extern struct proc_dir_entry *acpi_lock_battery_dir(void);
63 extern void *acpi_unlock_battery_dir(struct proc_dir_entry *acpi_battery_dir);
65 static int acpi_battery_add(struct acpi_device *device);
66 static int acpi_battery_remove(struct acpi_device *device, int type);
68 static struct acpi_driver acpi_battery_driver = {
69 .name = ACPI_BATTERY_DRIVER_NAME,
70 .class = ACPI_BATTERY_CLASS,
71 .ids = ACPI_BATTERY_HID,
73 .add = acpi_battery_add,
74 .remove = acpi_battery_remove,
78 struct acpi_battery_status {
80 acpi_integer present_rate;
81 acpi_integer remaining_capacity;
82 acpi_integer present_voltage;
85 struct acpi_battery_info {
86 acpi_integer power_unit;
87 acpi_integer design_capacity;
88 acpi_integer last_full_capacity;
89 acpi_integer battery_technology;
90 acpi_integer design_voltage;
91 acpi_integer design_capacity_warning;
92 acpi_integer design_capacity_low;
93 acpi_integer battery_capacity_granularity_1;
94 acpi_integer battery_capacity_granularity_2;
95 acpi_string model_number;
96 acpi_string serial_number;
97 acpi_string battery_type;
101 struct acpi_battery_flags {
102 u8 present:1; /* Bay occupied? */
103 u8 power_unit:1; /* 0=watts, 1=apms */
104 u8 alarm:1; /* _BTP present? */
108 struct acpi_battery_trips {
109 unsigned long warning;
113 struct acpi_battery {
114 struct acpi_device * device;
115 struct acpi_battery_flags flags;
116 struct acpi_battery_trips trips;
118 struct acpi_battery_info *info;
121 /* --------------------------------------------------------------------------
123 -------------------------------------------------------------------------- */
126 acpi_battery_get_info(struct acpi_battery *battery,
127 struct acpi_battery_info **bif)
130 acpi_status status = 0;
131 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
132 struct acpi_buffer format = { sizeof(ACPI_BATTERY_FORMAT_BIF),
133 ACPI_BATTERY_FORMAT_BIF
135 struct acpi_buffer data = { 0, NULL };
136 union acpi_object *package = NULL;
139 if (!battery || !bif)
144 status = acpi_evaluate_object(battery->device->handle, "_BIF", NULL, &buffer);
145 if (ACPI_FAILURE(status)) {
146 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _BIF"));
150 package = (union acpi_object *)buffer.pointer;
152 /* Extract Package Data */
154 status = acpi_extract_package(package, &format, &data);
155 if (status != AE_BUFFER_OVERFLOW) {
156 ACPI_EXCEPTION((AE_INFO, status, "Extracting _BIF"));
161 data.pointer = kmalloc(data.length, GFP_KERNEL);
166 memset(data.pointer, 0, data.length);
168 status = acpi_extract_package(package, &format, &data);
169 if (ACPI_FAILURE(status)) {
170 ACPI_EXCEPTION((AE_INFO, status, "Extracting _BIF"));
177 kfree(buffer.pointer);
180 (*bif) = (struct acpi_battery_info *)data.pointer;
186 acpi_battery_get_status(struct acpi_battery *battery,
187 struct acpi_battery_status **bst)
190 acpi_status status = 0;
191 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
192 struct acpi_buffer format = { sizeof(ACPI_BATTERY_FORMAT_BST),
193 ACPI_BATTERY_FORMAT_BST
195 struct acpi_buffer data = { 0, NULL };
196 union acpi_object *package = NULL;
199 if (!battery || !bst)
204 status = acpi_evaluate_object(battery->device->handle, "_BST", NULL, &buffer);
205 if (ACPI_FAILURE(status)) {
206 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _BST"));
210 package = (union acpi_object *)buffer.pointer;
212 /* Extract Package Data */
214 status = acpi_extract_package(package, &format, &data);
215 if (status != AE_BUFFER_OVERFLOW) {
216 ACPI_EXCEPTION((AE_INFO, status, "Extracting _BST"));
221 data.pointer = kmalloc(data.length, GFP_KERNEL);
226 memset(data.pointer, 0, data.length);
228 status = acpi_extract_package(package, &format, &data);
229 if (ACPI_FAILURE(status)) {
230 ACPI_EXCEPTION((AE_INFO, status, "Extracting _BST"));
237 kfree(buffer.pointer);
240 (*bst) = (struct acpi_battery_status *)data.pointer;
246 acpi_battery_set_alarm(struct acpi_battery *battery, unsigned long alarm)
248 acpi_status status = 0;
249 union acpi_object arg0 = { ACPI_TYPE_INTEGER };
250 struct acpi_object_list arg_list = { 1, &arg0 };
256 if (!battery->flags.alarm)
259 arg0.integer.value = alarm;
261 status = acpi_evaluate_object(battery->device->handle, "_BTP", &arg_list, NULL);
262 if (ACPI_FAILURE(status))
265 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Alarm set to %d\n", (u32) alarm));
267 battery->alarm = alarm;
272 static int acpi_battery_check(struct acpi_battery *battery)
275 acpi_status status = AE_OK;
276 acpi_handle handle = NULL;
277 struct acpi_device *device = NULL;
278 struct acpi_battery_info *bif = NULL;
284 device = battery->device;
286 result = acpi_bus_get_status(device);
292 if (!battery->flags.present && device->status.battery_present) {
294 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Battery inserted\n"));
296 /* Evalute _BIF to get certain static information */
298 result = acpi_battery_get_info(battery, &bif);
302 battery->flags.power_unit = bif->power_unit;
303 battery->trips.warning = bif->design_capacity_warning;
304 battery->trips.low = bif->design_capacity_low;
307 /* See if alarms are supported, and if so, set default */
309 status = acpi_get_handle(battery->device->handle, "_BTP", &handle);
310 if (ACPI_SUCCESS(status)) {
311 battery->flags.alarm = 1;
312 acpi_battery_set_alarm(battery, battery->trips.warning);
318 else if (battery->flags.present && !device->status.battery_present) {
319 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Battery removed\n"));
322 battery->flags.present = device->status.battery_present;
327 /* --------------------------------------------------------------------------
329 -------------------------------------------------------------------------- */
331 static struct proc_dir_entry *acpi_battery_dir;
332 static int acpi_battery_read_info(struct seq_file *seq, void *offset)
335 struct acpi_battery *battery = (struct acpi_battery *)seq->private;
336 struct acpi_battery_info *bif = NULL;
343 if (battery->flags.present)
344 seq_printf(seq, "present: yes\n");
346 seq_printf(seq, "present: no\n");
350 /* Battery Info (_BIF) */
352 result = acpi_battery_get_info(battery, &bif);
353 if (result || !bif) {
354 seq_printf(seq, "ERROR: Unable to read battery information\n");
360 power_unit ? ACPI_BATTERY_UNITS_AMPS : ACPI_BATTERY_UNITS_WATTS;
362 if (bif->design_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
363 seq_printf(seq, "design capacity: unknown\n");
365 seq_printf(seq, "design capacity: %d %sh\n",
366 (u32) bif->design_capacity, units);
368 if (bif->last_full_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
369 seq_printf(seq, "last full capacity: unknown\n");
371 seq_printf(seq, "last full capacity: %d %sh\n",
372 (u32) bif->last_full_capacity, units);
374 switch ((u32) bif->battery_technology) {
376 seq_printf(seq, "battery technology: non-rechargeable\n");
379 seq_printf(seq, "battery technology: rechargeable\n");
382 seq_printf(seq, "battery technology: unknown\n");
386 if (bif->design_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
387 seq_printf(seq, "design voltage: unknown\n");
389 seq_printf(seq, "design voltage: %d mV\n",
390 (u32) bif->design_voltage);
392 seq_printf(seq, "design capacity warning: %d %sh\n",
393 (u32) bif->design_capacity_warning, units);
394 seq_printf(seq, "design capacity low: %d %sh\n",
395 (u32) bif->design_capacity_low, units);
396 seq_printf(seq, "capacity granularity 1: %d %sh\n",
397 (u32) bif->battery_capacity_granularity_1, units);
398 seq_printf(seq, "capacity granularity 2: %d %sh\n",
399 (u32) bif->battery_capacity_granularity_2, units);
400 seq_printf(seq, "model number: %s\n", bif->model_number);
401 seq_printf(seq, "serial number: %s\n", bif->serial_number);
402 seq_printf(seq, "battery type: %s\n", bif->battery_type);
403 seq_printf(seq, "OEM info: %s\n", bif->oem_info);
411 static int acpi_battery_info_open_fs(struct inode *inode, struct file *file)
413 return single_open(file, acpi_battery_read_info, PDE(inode)->data);
416 static int acpi_battery_read_state(struct seq_file *seq, void *offset)
419 struct acpi_battery *battery = (struct acpi_battery *)seq->private;
420 struct acpi_battery_status *bst = NULL;
427 if (battery->flags.present)
428 seq_printf(seq, "present: yes\n");
430 seq_printf(seq, "present: no\n");
438 power_unit ? ACPI_BATTERY_UNITS_AMPS : ACPI_BATTERY_UNITS_WATTS;
440 /* Battery Status (_BST) */
442 result = acpi_battery_get_status(battery, &bst);
443 if (result || !bst) {
444 seq_printf(seq, "ERROR: Unable to read battery status\n");
448 if (!(bst->state & 0x04))
449 seq_printf(seq, "capacity state: ok\n");
451 seq_printf(seq, "capacity state: critical\n");
453 if ((bst->state & 0x01) && (bst->state & 0x02)) {
455 "charging state: charging/discharging\n");
456 } else if (bst->state & 0x01)
457 seq_printf(seq, "charging state: discharging\n");
458 else if (bst->state & 0x02)
459 seq_printf(seq, "charging state: charging\n");
461 seq_printf(seq, "charging state: charged\n");
464 if (bst->present_rate == ACPI_BATTERY_VALUE_UNKNOWN)
465 seq_printf(seq, "present rate: unknown\n");
467 seq_printf(seq, "present rate: %d %s\n",
468 (u32) bst->present_rate, units);
470 if (bst->remaining_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
471 seq_printf(seq, "remaining capacity: unknown\n");
473 seq_printf(seq, "remaining capacity: %d %sh\n",
474 (u32) bst->remaining_capacity, units);
476 if (bst->present_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
477 seq_printf(seq, "present voltage: unknown\n");
479 seq_printf(seq, "present voltage: %d mV\n",
480 (u32) bst->present_voltage);
488 static int acpi_battery_state_open_fs(struct inode *inode, struct file *file)
490 return single_open(file, acpi_battery_read_state, PDE(inode)->data);
493 static int acpi_battery_read_alarm(struct seq_file *seq, void *offset)
495 struct acpi_battery *battery = (struct acpi_battery *)seq->private;
502 if (!battery->flags.present) {
503 seq_printf(seq, "present: no\n");
511 power_unit ? ACPI_BATTERY_UNITS_AMPS : ACPI_BATTERY_UNITS_WATTS;
515 seq_printf(seq, "alarm: ");
517 seq_printf(seq, "unsupported\n");
519 seq_printf(seq, "%d %sh\n", (u32) battery->alarm, units);
526 acpi_battery_write_alarm(struct file *file,
527 const char __user * buffer,
528 size_t count, loff_t * ppos)
531 char alarm_string[12] = { '\0' };
532 struct seq_file *m = (struct seq_file *)file->private_data;
533 struct acpi_battery *battery = (struct acpi_battery *)m->private;
536 if (!battery || (count > sizeof(alarm_string) - 1))
539 if (!battery->flags.present)
542 if (copy_from_user(alarm_string, buffer, count))
545 alarm_string[count] = '\0';
547 result = acpi_battery_set_alarm(battery,
548 simple_strtoul(alarm_string, NULL, 0));
555 static int acpi_battery_alarm_open_fs(struct inode *inode, struct file *file)
557 return single_open(file, acpi_battery_read_alarm, PDE(inode)->data);
560 static const struct file_operations acpi_battery_info_ops = {
561 .open = acpi_battery_info_open_fs,
564 .release = single_release,
565 .owner = THIS_MODULE,
568 static const struct file_operations acpi_battery_state_ops = {
569 .open = acpi_battery_state_open_fs,
572 .release = single_release,
573 .owner = THIS_MODULE,
576 static const struct file_operations acpi_battery_alarm_ops = {
577 .open = acpi_battery_alarm_open_fs,
579 .write = acpi_battery_write_alarm,
581 .release = single_release,
582 .owner = THIS_MODULE,
585 static int acpi_battery_add_fs(struct acpi_device *device)
587 struct proc_dir_entry *entry = NULL;
590 if (!acpi_device_dir(device)) {
591 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
593 if (!acpi_device_dir(device))
595 acpi_device_dir(device)->owner = THIS_MODULE;
599 entry = create_proc_entry(ACPI_BATTERY_FILE_INFO,
600 S_IRUGO, acpi_device_dir(device));
604 entry->proc_fops = &acpi_battery_info_ops;
605 entry->data = acpi_driver_data(device);
606 entry->owner = THIS_MODULE;
610 entry = create_proc_entry(ACPI_BATTERY_FILE_STATUS,
611 S_IRUGO, acpi_device_dir(device));
615 entry->proc_fops = &acpi_battery_state_ops;
616 entry->data = acpi_driver_data(device);
617 entry->owner = THIS_MODULE;
621 entry = create_proc_entry(ACPI_BATTERY_FILE_ALARM,
622 S_IFREG | S_IRUGO | S_IWUSR,
623 acpi_device_dir(device));
627 entry->proc_fops = &acpi_battery_alarm_ops;
628 entry->data = acpi_driver_data(device);
629 entry->owner = THIS_MODULE;
635 static int acpi_battery_remove_fs(struct acpi_device *device)
638 if (acpi_device_dir(device)) {
639 remove_proc_entry(ACPI_BATTERY_FILE_ALARM,
640 acpi_device_dir(device));
641 remove_proc_entry(ACPI_BATTERY_FILE_STATUS,
642 acpi_device_dir(device));
643 remove_proc_entry(ACPI_BATTERY_FILE_INFO,
644 acpi_device_dir(device));
646 remove_proc_entry(acpi_device_bid(device), acpi_battery_dir);
647 acpi_device_dir(device) = NULL;
653 /* --------------------------------------------------------------------------
655 -------------------------------------------------------------------------- */
657 static void acpi_battery_notify(acpi_handle handle, u32 event, void *data)
659 struct acpi_battery *battery = (struct acpi_battery *)data;
660 struct acpi_device *device = NULL;
666 device = battery->device;
669 case ACPI_BATTERY_NOTIFY_STATUS:
670 case ACPI_BATTERY_NOTIFY_INFO:
671 case ACPI_NOTIFY_BUS_CHECK:
672 case ACPI_NOTIFY_DEVICE_CHECK:
673 acpi_battery_check(battery);
674 acpi_bus_generate_event(device, event, battery->flags.present);
677 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
678 "Unsupported event [0x%x]\n", event));
685 static int acpi_battery_add(struct acpi_device *device)
688 acpi_status status = 0;
689 struct acpi_battery *battery = NULL;
695 battery = kmalloc(sizeof(struct acpi_battery), GFP_KERNEL);
698 memset(battery, 0, sizeof(struct acpi_battery));
700 battery->device = device;
701 strcpy(acpi_device_name(device), ACPI_BATTERY_DEVICE_NAME);
702 strcpy(acpi_device_class(device), ACPI_BATTERY_CLASS);
703 acpi_driver_data(device) = battery;
705 result = acpi_battery_check(battery);
709 result = acpi_battery_add_fs(device);
713 status = acpi_install_notify_handler(device->handle,
715 acpi_battery_notify, battery);
716 if (ACPI_FAILURE(status)) {
721 printk(KERN_INFO PREFIX "%s Slot [%s] (battery %s)\n",
722 ACPI_BATTERY_DEVICE_NAME, acpi_device_bid(device),
723 device->status.battery_present ? "present" : "absent");
727 acpi_battery_remove_fs(device);
734 static int acpi_battery_remove(struct acpi_device *device, int type)
736 acpi_status status = 0;
737 struct acpi_battery *battery = NULL;
740 if (!device || !acpi_driver_data(device))
743 battery = (struct acpi_battery *)acpi_driver_data(device);
745 status = acpi_remove_notify_handler(device->handle,
747 acpi_battery_notify);
749 acpi_battery_remove_fs(device);
756 static int __init acpi_battery_init(void)
760 acpi_battery_dir = acpi_lock_battery_dir();
761 if (!acpi_battery_dir)
764 result = acpi_bus_register_driver(&acpi_battery_driver);
766 acpi_unlock_battery_dir(acpi_battery_dir);
773 static void __exit acpi_battery_exit(void)
776 acpi_bus_unregister_driver(&acpi_battery_driver);
778 acpi_unlock_battery_dir(acpi_battery_dir);
783 module_init(acpi_battery_init);
784 module_exit(acpi_battery_exit);