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 static int acpi_battery_add(struct acpi_device *device);
63 static int acpi_battery_remove(struct acpi_device *device, int type);
65 static struct acpi_driver acpi_battery_driver = {
66 .name = ACPI_BATTERY_DRIVER_NAME,
67 .class = ACPI_BATTERY_CLASS,
68 .ids = ACPI_BATTERY_HID,
70 .add = acpi_battery_add,
71 .remove = acpi_battery_remove,
75 struct acpi_battery_status {
77 acpi_integer present_rate;
78 acpi_integer remaining_capacity;
79 acpi_integer present_voltage;
82 struct acpi_battery_info {
83 acpi_integer power_unit;
84 acpi_integer design_capacity;
85 acpi_integer last_full_capacity;
86 acpi_integer battery_technology;
87 acpi_integer design_voltage;
88 acpi_integer design_capacity_warning;
89 acpi_integer design_capacity_low;
90 acpi_integer battery_capacity_granularity_1;
91 acpi_integer battery_capacity_granularity_2;
92 acpi_string model_number;
93 acpi_string serial_number;
94 acpi_string battery_type;
98 struct acpi_battery_flags {
99 u8 present:1; /* Bay occupied? */
100 u8 power_unit:1; /* 0=watts, 1=apms */
101 u8 alarm:1; /* _BTP present? */
105 struct acpi_battery_trips {
106 unsigned long warning;
110 struct acpi_battery {
112 struct acpi_battery_flags flags;
113 struct acpi_battery_trips trips;
115 struct acpi_battery_info *info;
118 /* --------------------------------------------------------------------------
120 -------------------------------------------------------------------------- */
123 acpi_battery_get_info(struct acpi_battery *battery,
124 struct acpi_battery_info **bif)
127 acpi_status status = 0;
128 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
129 struct acpi_buffer format = { sizeof(ACPI_BATTERY_FORMAT_BIF),
130 ACPI_BATTERY_FORMAT_BIF
132 struct acpi_buffer data = { 0, NULL };
133 union acpi_object *package = NULL;
135 ACPI_FUNCTION_TRACE("acpi_battery_get_info");
137 if (!battery || !bif)
138 return_VALUE(-EINVAL);
142 status = acpi_evaluate_object(battery->handle, "_BIF", NULL, &buffer);
143 if (ACPI_FAILURE(status)) {
144 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _BIF"));
145 return_VALUE(-ENODEV);
148 package = (union acpi_object *)buffer.pointer;
150 /* Extract Package Data */
152 status = acpi_extract_package(package, &format, &data);
153 if (status != AE_BUFFER_OVERFLOW) {
154 ACPI_EXCEPTION((AE_INFO, status, "Extracting _BIF"));
159 data.pointer = kmalloc(data.length, GFP_KERNEL);
164 memset(data.pointer, 0, data.length);
166 status = acpi_extract_package(package, &format, &data);
167 if (ACPI_FAILURE(status)) {
168 ACPI_EXCEPTION((AE_INFO, status, "Extracting _BIF"));
175 acpi_os_free(buffer.pointer);
178 (*bif) = (struct acpi_battery_info *)data.pointer;
180 return_VALUE(result);
184 acpi_battery_get_status(struct acpi_battery *battery,
185 struct acpi_battery_status **bst)
188 acpi_status status = 0;
189 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
190 struct acpi_buffer format = { sizeof(ACPI_BATTERY_FORMAT_BST),
191 ACPI_BATTERY_FORMAT_BST
193 struct acpi_buffer data = { 0, NULL };
194 union acpi_object *package = NULL;
196 ACPI_FUNCTION_TRACE("acpi_battery_get_status");
198 if (!battery || !bst)
199 return_VALUE(-EINVAL);
203 status = acpi_evaluate_object(battery->handle, "_BST", NULL, &buffer);
204 if (ACPI_FAILURE(status)) {
205 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _BST"));
206 return_VALUE(-ENODEV);
209 package = (union acpi_object *)buffer.pointer;
211 /* Extract Package Data */
213 status = acpi_extract_package(package, &format, &data);
214 if (status != AE_BUFFER_OVERFLOW) {
215 ACPI_EXCEPTION((AE_INFO, status, "Extracting _BST"));
220 data.pointer = kmalloc(data.length, GFP_KERNEL);
225 memset(data.pointer, 0, data.length);
227 status = acpi_extract_package(package, &format, &data);
228 if (ACPI_FAILURE(status)) {
229 ACPI_EXCEPTION((AE_INFO, status, "Extracting _BST"));
236 acpi_os_free(buffer.pointer);
239 (*bst) = (struct acpi_battery_status *)data.pointer;
241 return_VALUE(result);
245 acpi_battery_set_alarm(struct acpi_battery *battery, unsigned long alarm)
247 acpi_status status = 0;
248 union acpi_object arg0 = { ACPI_TYPE_INTEGER };
249 struct acpi_object_list arg_list = { 1, &arg0 };
251 ACPI_FUNCTION_TRACE("acpi_battery_set_alarm");
254 return_VALUE(-EINVAL);
256 if (!battery->flags.alarm)
257 return_VALUE(-ENODEV);
259 arg0.integer.value = alarm;
261 status = acpi_evaluate_object(battery->handle, "_BTP", &arg_list, NULL);
262 if (ACPI_FAILURE(status))
263 return_VALUE(-ENODEV);
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;
280 ACPI_FUNCTION_TRACE("acpi_battery_check");
283 return_VALUE(-EINVAL);
285 result = acpi_bus_get_device(battery->handle, &device);
287 return_VALUE(result);
289 result = acpi_bus_get_status(device);
291 return_VALUE(result);
295 if (!battery->flags.present && device->status.battery_present) {
297 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Battery inserted\n"));
299 /* Evalute _BIF to get certain static information */
301 result = acpi_battery_get_info(battery, &bif);
303 return_VALUE(result);
305 battery->flags.power_unit = bif->power_unit;
306 battery->trips.warning = bif->design_capacity_warning;
307 battery->trips.low = bif->design_capacity_low;
310 /* See if alarms are supported, and if so, set default */
312 status = acpi_get_handle(battery->handle, "_BTP", &handle);
313 if (ACPI_SUCCESS(status)) {
314 battery->flags.alarm = 1;
315 acpi_battery_set_alarm(battery, battery->trips.warning);
321 else if (battery->flags.present && !device->status.battery_present) {
322 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Battery removed\n"));
325 battery->flags.present = device->status.battery_present;
327 return_VALUE(result);
330 /* --------------------------------------------------------------------------
332 -------------------------------------------------------------------------- */
334 static struct proc_dir_entry *acpi_battery_dir;
335 static int acpi_battery_read_info(struct seq_file *seq, void *offset)
338 struct acpi_battery *battery = (struct acpi_battery *)seq->private;
339 struct acpi_battery_info *bif = NULL;
342 ACPI_FUNCTION_TRACE("acpi_battery_read_info");
347 if (battery->flags.present)
348 seq_printf(seq, "present: yes\n");
350 seq_printf(seq, "present: no\n");
354 /* Battery Info (_BIF) */
356 result = acpi_battery_get_info(battery, &bif);
357 if (result || !bif) {
358 seq_printf(seq, "ERROR: Unable to read battery information\n");
364 power_unit ? ACPI_BATTERY_UNITS_AMPS : ACPI_BATTERY_UNITS_WATTS;
366 if (bif->design_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
367 seq_printf(seq, "design capacity: unknown\n");
369 seq_printf(seq, "design capacity: %d %sh\n",
370 (u32) bif->design_capacity, units);
372 if (bif->last_full_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
373 seq_printf(seq, "last full capacity: unknown\n");
375 seq_printf(seq, "last full capacity: %d %sh\n",
376 (u32) bif->last_full_capacity, units);
378 switch ((u32) bif->battery_technology) {
380 seq_printf(seq, "battery technology: non-rechargeable\n");
383 seq_printf(seq, "battery technology: rechargeable\n");
386 seq_printf(seq, "battery technology: unknown\n");
390 if (bif->design_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
391 seq_printf(seq, "design voltage: unknown\n");
393 seq_printf(seq, "design voltage: %d mV\n",
394 (u32) bif->design_voltage);
396 seq_printf(seq, "design capacity warning: %d %sh\n",
397 (u32) bif->design_capacity_warning, units);
398 seq_printf(seq, "design capacity low: %d %sh\n",
399 (u32) bif->design_capacity_low, units);
400 seq_printf(seq, "capacity granularity 1: %d %sh\n",
401 (u32) bif->battery_capacity_granularity_1, units);
402 seq_printf(seq, "capacity granularity 2: %d %sh\n",
403 (u32) bif->battery_capacity_granularity_2, units);
404 seq_printf(seq, "model number: %s\n", bif->model_number);
405 seq_printf(seq, "serial number: %s\n", bif->serial_number);
406 seq_printf(seq, "battery type: %s\n", bif->battery_type);
407 seq_printf(seq, "OEM info: %s\n", bif->oem_info);
415 static int acpi_battery_info_open_fs(struct inode *inode, struct file *file)
417 return single_open(file, acpi_battery_read_info, PDE(inode)->data);
420 static int acpi_battery_read_state(struct seq_file *seq, void *offset)
423 struct acpi_battery *battery = (struct acpi_battery *)seq->private;
424 struct acpi_battery_status *bst = NULL;
427 ACPI_FUNCTION_TRACE("acpi_battery_read_state");
432 if (battery->flags.present)
433 seq_printf(seq, "present: yes\n");
435 seq_printf(seq, "present: no\n");
443 power_unit ? ACPI_BATTERY_UNITS_AMPS : ACPI_BATTERY_UNITS_WATTS;
445 /* Battery Status (_BST) */
447 result = acpi_battery_get_status(battery, &bst);
448 if (result || !bst) {
449 seq_printf(seq, "ERROR: Unable to read battery status\n");
453 if (!(bst->state & 0x04))
454 seq_printf(seq, "capacity state: ok\n");
456 seq_printf(seq, "capacity state: critical\n");
458 if ((bst->state & 0x01) && (bst->state & 0x02)) {
460 "charging state: charging/discharging\n");
461 } else if (bst->state & 0x01)
462 seq_printf(seq, "charging state: discharging\n");
463 else if (bst->state & 0x02)
464 seq_printf(seq, "charging state: charging\n");
466 seq_printf(seq, "charging state: charged\n");
469 if (bst->present_rate == ACPI_BATTERY_VALUE_UNKNOWN)
470 seq_printf(seq, "present rate: unknown\n");
472 seq_printf(seq, "present rate: %d %s\n",
473 (u32) bst->present_rate, units);
475 if (bst->remaining_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
476 seq_printf(seq, "remaining capacity: unknown\n");
478 seq_printf(seq, "remaining capacity: %d %sh\n",
479 (u32) bst->remaining_capacity, units);
481 if (bst->present_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
482 seq_printf(seq, "present voltage: unknown\n");
484 seq_printf(seq, "present voltage: %d mV\n",
485 (u32) bst->present_voltage);
493 static int acpi_battery_state_open_fs(struct inode *inode, struct file *file)
495 return single_open(file, acpi_battery_read_state, PDE(inode)->data);
498 static int acpi_battery_read_alarm(struct seq_file *seq, void *offset)
500 struct acpi_battery *battery = (struct acpi_battery *)seq->private;
503 ACPI_FUNCTION_TRACE("acpi_battery_read_alarm");
508 if (!battery->flags.present) {
509 seq_printf(seq, "present: no\n");
517 power_unit ? ACPI_BATTERY_UNITS_AMPS : ACPI_BATTERY_UNITS_WATTS;
521 seq_printf(seq, "alarm: ");
523 seq_printf(seq, "unsupported\n");
525 seq_printf(seq, "%d %sh\n", (u32) battery->alarm, units);
532 acpi_battery_write_alarm(struct file *file,
533 const char __user * buffer,
534 size_t count, loff_t * ppos)
537 char alarm_string[12] = { '\0' };
538 struct seq_file *m = (struct seq_file *)file->private_data;
539 struct acpi_battery *battery = (struct acpi_battery *)m->private;
541 ACPI_FUNCTION_TRACE("acpi_battery_write_alarm");
543 if (!battery || (count > sizeof(alarm_string) - 1))
544 return_VALUE(-EINVAL);
546 if (!battery->flags.present)
547 return_VALUE(-ENODEV);
549 if (copy_from_user(alarm_string, buffer, count))
550 return_VALUE(-EFAULT);
552 alarm_string[count] = '\0';
554 result = acpi_battery_set_alarm(battery,
555 simple_strtoul(alarm_string, NULL, 0));
557 return_VALUE(result);
562 static int acpi_battery_alarm_open_fs(struct inode *inode, struct file *file)
564 return single_open(file, acpi_battery_read_alarm, PDE(inode)->data);
567 static struct file_operations acpi_battery_info_ops = {
568 .open = acpi_battery_info_open_fs,
571 .release = single_release,
572 .owner = THIS_MODULE,
575 static struct file_operations acpi_battery_state_ops = {
576 .open = acpi_battery_state_open_fs,
579 .release = single_release,
580 .owner = THIS_MODULE,
583 static struct file_operations acpi_battery_alarm_ops = {
584 .open = acpi_battery_alarm_open_fs,
586 .write = acpi_battery_write_alarm,
588 .release = single_release,
589 .owner = THIS_MODULE,
592 static int acpi_battery_add_fs(struct acpi_device *device)
594 struct proc_dir_entry *entry = NULL;
596 ACPI_FUNCTION_TRACE("acpi_battery_add_fs");
598 if (!acpi_device_dir(device)) {
599 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
601 if (!acpi_device_dir(device))
602 return_VALUE(-ENODEV);
603 acpi_device_dir(device)->owner = THIS_MODULE;
607 entry = create_proc_entry(ACPI_BATTERY_FILE_INFO,
608 S_IRUGO, acpi_device_dir(device));
610 return_VALUE(-ENODEV);
612 entry->proc_fops = &acpi_battery_info_ops;
613 entry->data = acpi_driver_data(device);
614 entry->owner = THIS_MODULE;
618 entry = create_proc_entry(ACPI_BATTERY_FILE_STATUS,
619 S_IRUGO, acpi_device_dir(device));
621 return_VALUE(-ENODEV);
623 entry->proc_fops = &acpi_battery_state_ops;
624 entry->data = acpi_driver_data(device);
625 entry->owner = THIS_MODULE;
629 entry = create_proc_entry(ACPI_BATTERY_FILE_ALARM,
630 S_IFREG | S_IRUGO | S_IWUSR,
631 acpi_device_dir(device));
633 return_VALUE(-ENODEV);
635 entry->proc_fops = &acpi_battery_alarm_ops;
636 entry->data = acpi_driver_data(device);
637 entry->owner = THIS_MODULE;
643 static int acpi_battery_remove_fs(struct acpi_device *device)
645 ACPI_FUNCTION_TRACE("acpi_battery_remove_fs");
647 if (acpi_device_dir(device)) {
648 remove_proc_entry(ACPI_BATTERY_FILE_ALARM,
649 acpi_device_dir(device));
650 remove_proc_entry(ACPI_BATTERY_FILE_STATUS,
651 acpi_device_dir(device));
652 remove_proc_entry(ACPI_BATTERY_FILE_INFO,
653 acpi_device_dir(device));
655 remove_proc_entry(acpi_device_bid(device), acpi_battery_dir);
656 acpi_device_dir(device) = NULL;
662 /* --------------------------------------------------------------------------
664 -------------------------------------------------------------------------- */
666 static void acpi_battery_notify(acpi_handle handle, u32 event, void *data)
668 struct acpi_battery *battery = (struct acpi_battery *)data;
669 struct acpi_device *device = NULL;
671 ACPI_FUNCTION_TRACE("acpi_battery_notify");
676 if (acpi_bus_get_device(handle, &device))
680 case ACPI_BATTERY_NOTIFY_STATUS:
681 case ACPI_BATTERY_NOTIFY_INFO:
682 acpi_battery_check(battery);
683 acpi_bus_generate_event(device, event, battery->flags.present);
686 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
687 "Unsupported event [0x%x]\n", event));
694 static int acpi_battery_add(struct acpi_device *device)
697 acpi_status status = 0;
698 struct acpi_battery *battery = NULL;
700 ACPI_FUNCTION_TRACE("acpi_battery_add");
703 return_VALUE(-EINVAL);
705 battery = kmalloc(sizeof(struct acpi_battery), GFP_KERNEL);
707 return_VALUE(-ENOMEM);
708 memset(battery, 0, sizeof(struct acpi_battery));
710 battery->handle = device->handle;
711 strcpy(acpi_device_name(device), ACPI_BATTERY_DEVICE_NAME);
712 strcpy(acpi_device_class(device), ACPI_BATTERY_CLASS);
713 acpi_driver_data(device) = battery;
715 result = acpi_battery_check(battery);
719 result = acpi_battery_add_fs(device);
723 status = acpi_install_notify_handler(battery->handle,
725 acpi_battery_notify, battery);
726 if (ACPI_FAILURE(status)) {
731 printk(KERN_INFO PREFIX "%s Slot [%s] (battery %s)\n",
732 ACPI_BATTERY_DEVICE_NAME, acpi_device_bid(device),
733 device->status.battery_present ? "present" : "absent");
737 acpi_battery_remove_fs(device);
741 return_VALUE(result);
744 static int acpi_battery_remove(struct acpi_device *device, int type)
746 acpi_status status = 0;
747 struct acpi_battery *battery = NULL;
749 ACPI_FUNCTION_TRACE("acpi_battery_remove");
751 if (!device || !acpi_driver_data(device))
752 return_VALUE(-EINVAL);
754 battery = (struct acpi_battery *)acpi_driver_data(device);
756 status = acpi_remove_notify_handler(battery->handle,
758 acpi_battery_notify);
760 acpi_battery_remove_fs(device);
767 static int __init acpi_battery_init(void)
771 ACPI_FUNCTION_TRACE("acpi_battery_init");
773 acpi_battery_dir = proc_mkdir(ACPI_BATTERY_CLASS, acpi_root_dir);
774 if (!acpi_battery_dir)
775 return_VALUE(-ENODEV);
776 acpi_battery_dir->owner = THIS_MODULE;
778 result = acpi_bus_register_driver(&acpi_battery_driver);
780 remove_proc_entry(ACPI_BATTERY_CLASS, acpi_root_dir);
781 return_VALUE(-ENODEV);
787 static void __exit acpi_battery_exit(void)
789 ACPI_FUNCTION_TRACE("acpi_battery_exit");
791 acpi_bus_unregister_driver(&acpi_battery_driver);
793 remove_proc_entry(ACPI_BATTERY_CLASS, acpi_root_dir);
798 module_init(acpi_battery_init);
799 module_exit(acpi_battery_exit);