2 * acpi_battery.c - ACPI Battery Driver ($Revision: 36 $)
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/compatmac.h>
31 #include <linux/proc_fs.h>
32 #include <acpi/acpi_bus.h>
33 #include <acpi/acpi_drivers.h>
36 #define _COMPONENT ACPI_BATTERY_COMPONENT
37 ACPI_MODULE_NAME ("acpi_battery")
39 MODULE_AUTHOR("Paul Diefenbaugh");
40 MODULE_DESCRIPTION(ACPI_BATTERY_DRIVER_NAME);
41 MODULE_LICENSE("GPL");
43 #define PREFIX "ACPI: "
46 #define ACPI_BATTERY_VALUE_UNKNOWN 0xFFFFFFFF
48 #define ACPI_BATTERY_FORMAT_BIF "NNNNNNNNNSSSS"
49 #define ACPI_BATTERY_FORMAT_BST "NNNN"
51 static int acpi_battery_add (struct acpi_device *device);
52 static int acpi_battery_remove (struct acpi_device *device, int type);
54 static struct acpi_driver acpi_battery_driver = {
55 .name = ACPI_BATTERY_DRIVER_NAME,
56 .class = ACPI_BATTERY_CLASS,
57 .ids = ACPI_BATTERY_HID,
59 .add = acpi_battery_add,
60 .remove = acpi_battery_remove,
64 struct acpi_battery_status {
66 acpi_integer present_rate;
67 acpi_integer remaining_capacity;
68 acpi_integer present_voltage;
71 struct acpi_battery_info {
72 acpi_integer power_unit;
73 acpi_integer design_capacity;
74 acpi_integer last_full_capacity;
75 acpi_integer battery_technology;
76 acpi_integer design_voltage;
77 acpi_integer design_capacity_warning;
78 acpi_integer design_capacity_low;
79 acpi_integer battery_capacity_granularity_1;
80 acpi_integer battery_capacity_granularity_2;
81 acpi_string model_number;
82 acpi_string serial_number;
83 acpi_string battery_type;
87 struct acpi_battery_flags {
88 u8 present:1; /* Bay occupied? */
89 u8 power_unit:1; /* 0=watts, 1=apms */
90 u8 alarm:1; /* _BTP present? */
94 struct acpi_battery_trips {
95 unsigned long warning;
101 struct acpi_battery_flags flags;
102 struct acpi_battery_trips trips;
104 struct acpi_battery_info *info;
108 /* --------------------------------------------------------------------------
110 -------------------------------------------------------------------------- */
113 acpi_battery_get_info (
114 struct acpi_battery *battery,
115 struct acpi_battery_info **bif)
118 acpi_status status = 0;
119 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
120 struct acpi_buffer format = {sizeof(ACPI_BATTERY_FORMAT_BIF),
121 ACPI_BATTERY_FORMAT_BIF};
122 struct acpi_buffer data = {0, NULL};
123 union acpi_object *package = NULL;
125 ACPI_FUNCTION_TRACE("acpi_battery_get_info");
127 if (!battery || !bif)
128 return_VALUE(-EINVAL);
132 status = acpi_evaluate_object(battery->handle, "_BIF", NULL, &buffer);
133 if (ACPI_FAILURE(status)) {
134 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Error evaluating _BIF\n"));
135 return_VALUE(-ENODEV);
138 package = (union acpi_object *) buffer.pointer;
140 /* Extract Package Data */
142 status = acpi_extract_package(package, &format, &data);
143 if (status != AE_BUFFER_OVERFLOW) {
144 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Error extracting _BIF\n"));
149 data.pointer = kmalloc(data.length, GFP_KERNEL);
154 memset(data.pointer, 0, data.length);
156 status = acpi_extract_package(package, &format, &data);
157 if (ACPI_FAILURE(status)) {
158 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Error extracting _BIF\n"));
165 acpi_os_free(buffer.pointer);
168 (*bif) = (struct acpi_battery_info *) data.pointer;
170 return_VALUE(result);
174 acpi_battery_get_status (
175 struct acpi_battery *battery,
176 struct acpi_battery_status **bst)
179 acpi_status status = 0;
180 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
181 struct acpi_buffer format = {sizeof(ACPI_BATTERY_FORMAT_BST),
182 ACPI_BATTERY_FORMAT_BST};
183 struct acpi_buffer data = {0, NULL};
184 union acpi_object *package = NULL;
186 ACPI_FUNCTION_TRACE("acpi_battery_get_status");
188 if (!battery || !bst)
189 return_VALUE(-EINVAL);
193 status = acpi_evaluate_object(battery->handle, "_BST", NULL, &buffer);
194 if (ACPI_FAILURE(status)) {
195 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Error evaluating _BST\n"));
196 return_VALUE(-ENODEV);
199 package = (union acpi_object *) buffer.pointer;
201 /* Extract Package Data */
203 status = acpi_extract_package(package, &format, &data);
204 if (status != AE_BUFFER_OVERFLOW) {
205 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Error extracting _BST\n"));
210 data.pointer = kmalloc(data.length, GFP_KERNEL);
215 memset(data.pointer, 0, data.length);
217 status = acpi_extract_package(package, &format, &data);
218 if (ACPI_FAILURE(status)) {
219 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Error extracting _BST\n"));
226 acpi_os_free(buffer.pointer);
229 (*bst) = (struct acpi_battery_status *) data.pointer;
231 return_VALUE(result);
236 acpi_battery_set_alarm (
237 struct acpi_battery *battery,
240 acpi_status status = 0;
241 union acpi_object arg0 = {ACPI_TYPE_INTEGER};
242 struct acpi_object_list arg_list = {1, &arg0};
244 ACPI_FUNCTION_TRACE("acpi_battery_set_alarm");
247 return_VALUE(-EINVAL);
249 if (!battery->flags.alarm)
250 return_VALUE(-ENODEV);
252 arg0.integer.value = alarm;
254 status = acpi_evaluate_object(battery->handle, "_BTP", &arg_list, NULL);
255 if (ACPI_FAILURE(status))
256 return_VALUE(-ENODEV);
258 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Alarm set to %d\n", (u32) alarm));
260 battery->alarm = alarm;
268 struct acpi_battery *battery)
271 acpi_status status = AE_OK;
272 acpi_handle handle = NULL;
273 struct acpi_device *device = NULL;
274 struct acpi_battery_info *bif = NULL;
276 ACPI_FUNCTION_TRACE("acpi_battery_check");
279 return_VALUE(-EINVAL);
281 result = acpi_bus_get_device(battery->handle, &device);
283 return_VALUE(result);
285 result = acpi_bus_get_status(device);
287 return_VALUE(result);
291 if (!battery->flags.present && device->status.battery_present) {
293 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Battery inserted\n"));
295 /* Evalute _BIF to get certain static information */
297 result = acpi_battery_get_info(battery, &bif);
299 return_VALUE(result);
301 battery->flags.power_unit = bif->power_unit;
302 battery->trips.warning = bif->design_capacity_warning;
303 battery->trips.low = bif->design_capacity_low;
306 /* See if alarms are supported, and if so, set default */
308 status = acpi_get_handle(battery->handle, "_BTP", &handle);
309 if (ACPI_SUCCESS(status)) {
310 battery->flags.alarm = 1;
311 acpi_battery_set_alarm(battery, battery->trips.warning);
317 else if (battery->flags.present && !device->status.battery_present) {
318 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Battery removed\n"));
321 battery->flags.present = device->status.battery_present;
323 return_VALUE(result);
327 /* --------------------------------------------------------------------------
329 -------------------------------------------------------------------------- */
331 struct proc_dir_entry *acpi_battery_dir;
334 acpi_battery_read_info (
343 struct acpi_battery *battery = (struct acpi_battery *) data;
344 struct acpi_battery_info *bif = NULL;
349 ACPI_FUNCTION_TRACE("acpi_battery_read_info");
351 if (!battery || (off != 0))
354 if (battery->flags.present)
355 p += sprintf(p, "present: yes\n");
357 p += sprintf(p, "present: no\n");
361 /* Battery Info (_BIF) */
363 result = acpi_battery_get_info(battery, &bif);
364 if (result || !bif) {
365 p += sprintf(p, "ERROR: Unable to read battery information\n");
369 units = bif->power_unit ? ACPI_BATTERY_UNITS_AMPS : ACPI_BATTERY_UNITS_WATTS;
371 if (bif->design_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
372 p += sprintf(p, "design capacity: unknown\n");
374 p += sprintf(p, "design capacity: %d %sh\n",
375 (u32) bif->design_capacity, units);
377 if (bif->last_full_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
378 p += sprintf(p, "last full capacity: unknown\n");
380 p += sprintf(p, "last full capacity: %d %sh\n",
381 (u32) bif->last_full_capacity, units);
383 switch ((u32) bif->battery_technology) {
385 p += sprintf(p, "battery technology: non-rechargeable\n");
388 p += sprintf(p, "battery technology: rechargeable\n");
391 p += sprintf(p, "battery technology: unknown\n");
395 if (bif->design_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
396 p += sprintf(p, "design voltage: unknown\n");
398 p += sprintf(p, "design voltage: %d mV\n",
399 (u32) bif->design_voltage);
401 p += sprintf(p, "design capacity warning: %d %sh\n",
402 (u32) bif->design_capacity_warning, units);
403 p += sprintf(p, "design capacity low: %d %sh\n",
404 (u32) bif->design_capacity_low, units);
405 p += sprintf(p, "capacity granularity 1: %d %sh\n",
406 (u32) bif->battery_capacity_granularity_1, units);
407 p += sprintf(p, "capacity granularity 2: %d %sh\n",
408 (u32) bif->battery_capacity_granularity_2, units);
409 p += sprintf(p, "model number: %s\n",
411 p += sprintf(p, "serial number: %s\n",
413 p += sprintf(p, "battery type: %s\n",
415 p += sprintf(p, "OEM info: %s\n",
422 if (len <= off+count) *eof = 1;
425 if (len>count) len = count;
433 acpi_battery_read_state (
442 struct acpi_battery *battery = (struct acpi_battery *) data;
443 struct acpi_battery_status *bst = NULL;
448 ACPI_FUNCTION_TRACE("acpi_battery_read_state");
450 if (!battery || (off != 0))
453 if (battery->flags.present)
454 p += sprintf(p, "present: yes\n");
456 p += sprintf(p, "present: no\n");
462 units = battery->flags.power_unit ? ACPI_BATTERY_UNITS_AMPS : ACPI_BATTERY_UNITS_WATTS;
464 /* Battery Status (_BST) */
466 result = acpi_battery_get_status(battery, &bst);
467 if (result || !bst) {
468 p += sprintf(p, "ERROR: Unable to read battery status\n");
472 if (!(bst->state & 0x04))
473 p += sprintf(p, "capacity state: ok\n");
475 p += sprintf(p, "capacity state: critical\n");
477 if ((bst->state & 0x01) && (bst->state & 0x02)){
478 p += sprintf(p, "charging state: charging/discharging\n");
479 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
480 "Battery Charging and Discharging?\n"));
482 else if (bst->state & 0x01)
483 p += sprintf(p, "charging state: discharging\n");
484 else if (bst->state & 0x02)
485 p += sprintf(p, "charging state: charging\n");
487 p += sprintf(p, "charging state: charged\n");
490 if (bst->present_rate == ACPI_BATTERY_VALUE_UNKNOWN)
491 p += sprintf(p, "present rate: unknown\n");
493 p += sprintf(p, "present rate: %d %s\n",
494 (u32) bst->present_rate, units);
496 if (bst->remaining_capacity == ACPI_BATTERY_VALUE_UNKNOWN)
497 p += sprintf(p, "remaining capacity: unknown\n");
499 p += sprintf(p, "remaining capacity: %d %sh\n",
500 (u32) bst->remaining_capacity, units);
502 if (bst->present_voltage == ACPI_BATTERY_VALUE_UNKNOWN)
503 p += sprintf(p, "present voltage: unknown\n");
505 p += sprintf(p, "present voltage: %d mV\n",
506 (u32) bst->present_voltage);
512 if (len <= off+count) *eof = 1;
515 if (len>count) len = count;
523 acpi_battery_read_alarm (
531 struct acpi_battery *battery = (struct acpi_battery *) data;
536 ACPI_FUNCTION_TRACE("acpi_battery_read_alarm");
538 if (!battery || (off != 0))
541 if (!battery->flags.present) {
542 p += sprintf(p, "present: no\n");
548 units = battery->flags.power_unit ? ACPI_BATTERY_UNITS_AMPS : ACPI_BATTERY_UNITS_WATTS;
552 p += sprintf(p, "alarm: ");
554 p += sprintf(p, "unsupported\n");
556 p += sprintf(p, "%d %sh\n", (u32) battery->alarm, units);
560 if (len <= off+count) *eof = 1;
563 if (len>count) len = count;
571 acpi_battery_write_alarm (
578 struct acpi_battery *battery = (struct acpi_battery *) data;
579 char alarm_string[12] = {'\0'};
581 ACPI_FUNCTION_TRACE("acpi_battery_write_alarm");
583 if (!battery || (count > sizeof(alarm_string) - 1))
584 return_VALUE(-EINVAL);
586 if (!battery->flags.present)
587 return_VALUE(-ENODEV);
589 if (copy_from_user(alarm_string, buffer, count))
590 return_VALUE(-EFAULT);
592 alarm_string[count] = '\0';
594 result = acpi_battery_set_alarm(battery,
595 simple_strtoul(alarm_string, NULL, 0));
597 return_VALUE(result);
604 acpi_battery_add_fs (
605 struct acpi_device *device)
607 struct proc_dir_entry *entry = NULL;
609 ACPI_FUNCTION_TRACE("acpi_battery_add_fs");
611 if (!acpi_device_dir(device)) {
612 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
614 if (!acpi_device_dir(device))
615 return_VALUE(-ENODEV);
616 acpi_device_dir(device)->owner = THIS_MODULE;
620 entry = create_proc_entry(ACPI_BATTERY_FILE_INFO,
621 S_IRUGO, acpi_device_dir(device));
623 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
624 "Unable to create '%s' fs entry\n",
625 ACPI_BATTERY_FILE_INFO));
627 entry->read_proc = acpi_battery_read_info;
628 entry->data = acpi_driver_data(device);
629 entry->owner = THIS_MODULE;
633 entry = create_proc_entry(ACPI_BATTERY_FILE_STATUS,
634 S_IRUGO, acpi_device_dir(device));
636 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
637 "Unable to create '%s' fs entry\n",
638 ACPI_BATTERY_FILE_STATUS));
640 entry->read_proc = acpi_battery_read_state;
641 entry->data = acpi_driver_data(device);
642 entry->owner = THIS_MODULE;
646 entry = create_proc_entry(ACPI_BATTERY_FILE_ALARM,
647 S_IFREG|S_IRUGO|S_IWUSR, acpi_device_dir(device));
649 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
650 "Unable to create '%s' fs entry\n",
651 ACPI_BATTERY_FILE_ALARM));
653 entry->read_proc = acpi_battery_read_alarm;
654 entry->write_proc = acpi_battery_write_alarm;
655 entry->data = acpi_driver_data(device);
656 entry->owner = THIS_MODULE;
664 acpi_battery_remove_fs (
665 struct acpi_device *device)
667 ACPI_FUNCTION_TRACE("acpi_battery_remove_fs");
669 if (acpi_device_dir(device)) {
670 remove_proc_entry(ACPI_BATTERY_FILE_ALARM,
671 acpi_device_dir(device));
672 remove_proc_entry(ACPI_BATTERY_FILE_STATUS,
673 acpi_device_dir(device));
674 remove_proc_entry(ACPI_BATTERY_FILE_INFO,
675 acpi_device_dir(device));
676 remove_proc_entry(acpi_device_bid(device), acpi_battery_dir);
677 acpi_device_dir(device) = NULL;
684 /* --------------------------------------------------------------------------
686 -------------------------------------------------------------------------- */
689 acpi_battery_notify (
694 struct acpi_battery *battery = (struct acpi_battery *) data;
695 struct acpi_device *device = NULL;
697 ACPI_FUNCTION_TRACE("acpi_battery_notify");
702 if (acpi_bus_get_device(handle, &device))
706 case ACPI_BATTERY_NOTIFY_STATUS:
707 case ACPI_BATTERY_NOTIFY_INFO:
708 acpi_battery_check(battery);
709 acpi_bus_generate_event(device, event, battery->flags.present);
712 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
713 "Unsupported event [0x%x]\n", event));
723 struct acpi_device *device)
726 acpi_status status = 0;
727 struct acpi_battery *battery = NULL;
729 ACPI_FUNCTION_TRACE("acpi_battery_add");
732 return_VALUE(-EINVAL);
734 battery = kmalloc(sizeof(struct acpi_battery), GFP_KERNEL);
736 return_VALUE(-ENOMEM);
737 memset(battery, 0, sizeof(struct acpi_battery));
739 battery->handle = device->handle;
740 sprintf(acpi_device_name(device), "%s", ACPI_BATTERY_DEVICE_NAME);
741 sprintf(acpi_device_class(device), "%s", ACPI_BATTERY_CLASS);
742 acpi_driver_data(device) = battery;
744 result = acpi_battery_check(battery);
748 result = acpi_battery_add_fs(device);
752 status = acpi_install_notify_handler(battery->handle,
753 ACPI_DEVICE_NOTIFY, acpi_battery_notify, battery);
754 if (ACPI_FAILURE(status)) {
755 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
756 "Error installing notify handler\n"));
761 printk(KERN_INFO PREFIX "%s Slot [%s] (battery %s)\n",
762 ACPI_BATTERY_DEVICE_NAME, acpi_device_bid(device),
763 device->status.battery_present?"present":"absent");
767 acpi_battery_remove_fs(device);
771 return_VALUE(result);
776 acpi_battery_remove (
777 struct acpi_device *device,
780 acpi_status status = 0;
781 struct acpi_battery *battery = NULL;
783 ACPI_FUNCTION_TRACE("acpi_battery_remove");
785 if (!device || !acpi_driver_data(device))
786 return_VALUE(-EINVAL);
788 battery = (struct acpi_battery *) acpi_driver_data(device);
790 status = acpi_remove_notify_handler(battery->handle,
791 ACPI_DEVICE_NOTIFY, acpi_battery_notify);
792 if (ACPI_FAILURE(status))
793 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
794 "Error removing notify handler\n"));
796 acpi_battery_remove_fs(device);
805 acpi_battery_init (void)
809 ACPI_FUNCTION_TRACE("acpi_battery_init");
811 acpi_battery_dir = proc_mkdir(ACPI_BATTERY_CLASS, acpi_root_dir);
812 if (!acpi_battery_dir)
813 return_VALUE(-ENODEV);
814 acpi_battery_dir->owner = THIS_MODULE;
816 result = acpi_bus_register_driver(&acpi_battery_driver);
818 remove_proc_entry(ACPI_BATTERY_CLASS, acpi_root_dir);
819 return_VALUE(-ENODEV);
827 acpi_battery_exit (void)
829 ACPI_FUNCTION_TRACE("acpi_battery_exit");
831 acpi_bus_unregister_driver(&acpi_battery_driver);
833 remove_proc_entry(ACPI_BATTERY_CLASS, acpi_root_dir);
839 module_init(acpi_battery_init);
840 module_exit(acpi_battery_exit);