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
{
111 struct acpi_device
* device
;
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
;
136 if (!battery
|| !bif
)
141 status
= acpi_evaluate_object(battery
->device
->handle
, "_BIF", NULL
, &buffer
);
142 if (ACPI_FAILURE(status
)) {
143 ACPI_EXCEPTION((AE_INFO
, status
, "Evaluating _BIF"));
147 package
= (union acpi_object
*)buffer
.pointer
;
149 /* Extract Package Data */
151 status
= acpi_extract_package(package
, &format
, &data
);
152 if (status
!= AE_BUFFER_OVERFLOW
) {
153 ACPI_EXCEPTION((AE_INFO
, status
, "Extracting _BIF"));
158 data
.pointer
= kmalloc(data
.length
, GFP_KERNEL
);
163 memset(data
.pointer
, 0, data
.length
);
165 status
= acpi_extract_package(package
, &format
, &data
);
166 if (ACPI_FAILURE(status
)) {
167 ACPI_EXCEPTION((AE_INFO
, status
, "Extracting _BIF"));
174 kfree(buffer
.pointer
);
177 (*bif
) = (struct acpi_battery_info
*)data
.pointer
;
183 acpi_battery_get_status(struct acpi_battery
*battery
,
184 struct acpi_battery_status
**bst
)
187 acpi_status status
= 0;
188 struct acpi_buffer buffer
= { ACPI_ALLOCATE_BUFFER
, NULL
};
189 struct acpi_buffer format
= { sizeof(ACPI_BATTERY_FORMAT_BST
),
190 ACPI_BATTERY_FORMAT_BST
192 struct acpi_buffer data
= { 0, NULL
};
193 union acpi_object
*package
= NULL
;
196 if (!battery
|| !bst
)
201 status
= acpi_evaluate_object(battery
->device
->handle
, "_BST", NULL
, &buffer
);
202 if (ACPI_FAILURE(status
)) {
203 ACPI_EXCEPTION((AE_INFO
, status
, "Evaluating _BST"));
207 package
= (union acpi_object
*)buffer
.pointer
;
209 /* Extract Package Data */
211 status
= acpi_extract_package(package
, &format
, &data
);
212 if (status
!= AE_BUFFER_OVERFLOW
) {
213 ACPI_EXCEPTION((AE_INFO
, status
, "Extracting _BST"));
218 data
.pointer
= kmalloc(data
.length
, GFP_KERNEL
);
223 memset(data
.pointer
, 0, data
.length
);
225 status
= acpi_extract_package(package
, &format
, &data
);
226 if (ACPI_FAILURE(status
)) {
227 ACPI_EXCEPTION((AE_INFO
, status
, "Extracting _BST"));
234 kfree(buffer
.pointer
);
237 (*bst
) = (struct acpi_battery_status
*)data
.pointer
;
243 acpi_battery_set_alarm(struct acpi_battery
*battery
, unsigned long alarm
)
245 acpi_status status
= 0;
246 union acpi_object arg0
= { ACPI_TYPE_INTEGER
};
247 struct acpi_object_list arg_list
= { 1, &arg0
};
253 if (!battery
->flags
.alarm
)
256 arg0
.integer
.value
= alarm
;
258 status
= acpi_evaluate_object(battery
->device
->handle
, "_BTP", &arg_list
, NULL
);
259 if (ACPI_FAILURE(status
))
262 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Alarm set to %d\n", (u32
) alarm
));
264 battery
->alarm
= alarm
;
269 static int acpi_battery_check(struct acpi_battery
*battery
)
272 acpi_status status
= AE_OK
;
273 acpi_handle handle
= NULL
;
274 struct acpi_device
*device
= NULL
;
275 struct acpi_battery_info
*bif
= NULL
;
281 device
= battery
->device
;
283 result
= acpi_bus_get_status(device
);
289 if (!battery
->flags
.present
&& device
->status
.battery_present
) {
291 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Battery inserted\n"));
293 /* Evalute _BIF to get certain static information */
295 result
= acpi_battery_get_info(battery
, &bif
);
299 battery
->flags
.power_unit
= bif
->power_unit
;
300 battery
->trips
.warning
= bif
->design_capacity_warning
;
301 battery
->trips
.low
= bif
->design_capacity_low
;
304 /* See if alarms are supported, and if so, set default */
306 status
= acpi_get_handle(battery
->device
->handle
, "_BTP", &handle
);
307 if (ACPI_SUCCESS(status
)) {
308 battery
->flags
.alarm
= 1;
309 acpi_battery_set_alarm(battery
, battery
->trips
.warning
);
315 else if (battery
->flags
.present
&& !device
->status
.battery_present
) {
316 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Battery removed\n"));
319 battery
->flags
.present
= device
->status
.battery_present
;
324 /* --------------------------------------------------------------------------
326 -------------------------------------------------------------------------- */
328 static struct proc_dir_entry
*acpi_battery_dir
;
329 static int acpi_battery_read_info(struct seq_file
*seq
, void *offset
)
332 struct acpi_battery
*battery
= (struct acpi_battery
*)seq
->private;
333 struct acpi_battery_info
*bif
= NULL
;
340 if (battery
->flags
.present
)
341 seq_printf(seq
, "present: yes\n");
343 seq_printf(seq
, "present: no\n");
347 /* Battery Info (_BIF) */
349 result
= acpi_battery_get_info(battery
, &bif
);
350 if (result
|| !bif
) {
351 seq_printf(seq
, "ERROR: Unable to read battery information\n");
357 power_unit
? ACPI_BATTERY_UNITS_AMPS
: ACPI_BATTERY_UNITS_WATTS
;
359 if (bif
->design_capacity
== ACPI_BATTERY_VALUE_UNKNOWN
)
360 seq_printf(seq
, "design capacity: unknown\n");
362 seq_printf(seq
, "design capacity: %d %sh\n",
363 (u32
) bif
->design_capacity
, units
);
365 if (bif
->last_full_capacity
== ACPI_BATTERY_VALUE_UNKNOWN
)
366 seq_printf(seq
, "last full capacity: unknown\n");
368 seq_printf(seq
, "last full capacity: %d %sh\n",
369 (u32
) bif
->last_full_capacity
, units
);
371 switch ((u32
) bif
->battery_technology
) {
373 seq_printf(seq
, "battery technology: non-rechargeable\n");
376 seq_printf(seq
, "battery technology: rechargeable\n");
379 seq_printf(seq
, "battery technology: unknown\n");
383 if (bif
->design_voltage
== ACPI_BATTERY_VALUE_UNKNOWN
)
384 seq_printf(seq
, "design voltage: unknown\n");
386 seq_printf(seq
, "design voltage: %d mV\n",
387 (u32
) bif
->design_voltage
);
389 seq_printf(seq
, "design capacity warning: %d %sh\n",
390 (u32
) bif
->design_capacity_warning
, units
);
391 seq_printf(seq
, "design capacity low: %d %sh\n",
392 (u32
) bif
->design_capacity_low
, units
);
393 seq_printf(seq
, "capacity granularity 1: %d %sh\n",
394 (u32
) bif
->battery_capacity_granularity_1
, units
);
395 seq_printf(seq
, "capacity granularity 2: %d %sh\n",
396 (u32
) bif
->battery_capacity_granularity_2
, units
);
397 seq_printf(seq
, "model number: %s\n", bif
->model_number
);
398 seq_printf(seq
, "serial number: %s\n", bif
->serial_number
);
399 seq_printf(seq
, "battery type: %s\n", bif
->battery_type
);
400 seq_printf(seq
, "OEM info: %s\n", bif
->oem_info
);
408 static int acpi_battery_info_open_fs(struct inode
*inode
, struct file
*file
)
410 return single_open(file
, acpi_battery_read_info
, PDE(inode
)->data
);
413 static int acpi_battery_read_state(struct seq_file
*seq
, void *offset
)
416 struct acpi_battery
*battery
= (struct acpi_battery
*)seq
->private;
417 struct acpi_battery_status
*bst
= NULL
;
424 if (battery
->flags
.present
)
425 seq_printf(seq
, "present: yes\n");
427 seq_printf(seq
, "present: no\n");
435 power_unit
? ACPI_BATTERY_UNITS_AMPS
: ACPI_BATTERY_UNITS_WATTS
;
437 /* Battery Status (_BST) */
439 result
= acpi_battery_get_status(battery
, &bst
);
440 if (result
|| !bst
) {
441 seq_printf(seq
, "ERROR: Unable to read battery status\n");
445 if (!(bst
->state
& 0x04))
446 seq_printf(seq
, "capacity state: ok\n");
448 seq_printf(seq
, "capacity state: critical\n");
450 if ((bst
->state
& 0x01) && (bst
->state
& 0x02)) {
452 "charging state: charging/discharging\n");
453 } else if (bst
->state
& 0x01)
454 seq_printf(seq
, "charging state: discharging\n");
455 else if (bst
->state
& 0x02)
456 seq_printf(seq
, "charging state: charging\n");
458 seq_printf(seq
, "charging state: charged\n");
461 if (bst
->present_rate
== ACPI_BATTERY_VALUE_UNKNOWN
)
462 seq_printf(seq
, "present rate: unknown\n");
464 seq_printf(seq
, "present rate: %d %s\n",
465 (u32
) bst
->present_rate
, units
);
467 if (bst
->remaining_capacity
== ACPI_BATTERY_VALUE_UNKNOWN
)
468 seq_printf(seq
, "remaining capacity: unknown\n");
470 seq_printf(seq
, "remaining capacity: %d %sh\n",
471 (u32
) bst
->remaining_capacity
, units
);
473 if (bst
->present_voltage
== ACPI_BATTERY_VALUE_UNKNOWN
)
474 seq_printf(seq
, "present voltage: unknown\n");
476 seq_printf(seq
, "present voltage: %d mV\n",
477 (u32
) bst
->present_voltage
);
485 static int acpi_battery_state_open_fs(struct inode
*inode
, struct file
*file
)
487 return single_open(file
, acpi_battery_read_state
, PDE(inode
)->data
);
490 static int acpi_battery_read_alarm(struct seq_file
*seq
, void *offset
)
492 struct acpi_battery
*battery
= (struct acpi_battery
*)seq
->private;
499 if (!battery
->flags
.present
) {
500 seq_printf(seq
, "present: no\n");
508 power_unit
? ACPI_BATTERY_UNITS_AMPS
: ACPI_BATTERY_UNITS_WATTS
;
512 seq_printf(seq
, "alarm: ");
514 seq_printf(seq
, "unsupported\n");
516 seq_printf(seq
, "%d %sh\n", (u32
) battery
->alarm
, units
);
523 acpi_battery_write_alarm(struct file
*file
,
524 const char __user
* buffer
,
525 size_t count
, loff_t
* ppos
)
528 char alarm_string
[12] = { '\0' };
529 struct seq_file
*m
= (struct seq_file
*)file
->private_data
;
530 struct acpi_battery
*battery
= (struct acpi_battery
*)m
->private;
533 if (!battery
|| (count
> sizeof(alarm_string
) - 1))
536 if (!battery
->flags
.present
)
539 if (copy_from_user(alarm_string
, buffer
, count
))
542 alarm_string
[count
] = '\0';
544 result
= acpi_battery_set_alarm(battery
,
545 simple_strtoul(alarm_string
, NULL
, 0));
552 static int acpi_battery_alarm_open_fs(struct inode
*inode
, struct file
*file
)
554 return single_open(file
, acpi_battery_read_alarm
, PDE(inode
)->data
);
557 static struct file_operations acpi_battery_info_ops
= {
558 .open
= acpi_battery_info_open_fs
,
561 .release
= single_release
,
562 .owner
= THIS_MODULE
,
565 static struct file_operations acpi_battery_state_ops
= {
566 .open
= acpi_battery_state_open_fs
,
569 .release
= single_release
,
570 .owner
= THIS_MODULE
,
573 static struct file_operations acpi_battery_alarm_ops
= {
574 .open
= acpi_battery_alarm_open_fs
,
576 .write
= acpi_battery_write_alarm
,
578 .release
= single_release
,
579 .owner
= THIS_MODULE
,
582 static int acpi_battery_add_fs(struct acpi_device
*device
)
584 struct proc_dir_entry
*entry
= NULL
;
587 if (!acpi_device_dir(device
)) {
588 acpi_device_dir(device
) = proc_mkdir(acpi_device_bid(device
),
590 if (!acpi_device_dir(device
))
592 acpi_device_dir(device
)->owner
= THIS_MODULE
;
596 entry
= create_proc_entry(ACPI_BATTERY_FILE_INFO
,
597 S_IRUGO
, acpi_device_dir(device
));
601 entry
->proc_fops
= &acpi_battery_info_ops
;
602 entry
->data
= acpi_driver_data(device
);
603 entry
->owner
= THIS_MODULE
;
607 entry
= create_proc_entry(ACPI_BATTERY_FILE_STATUS
,
608 S_IRUGO
, acpi_device_dir(device
));
612 entry
->proc_fops
= &acpi_battery_state_ops
;
613 entry
->data
= acpi_driver_data(device
);
614 entry
->owner
= THIS_MODULE
;
618 entry
= create_proc_entry(ACPI_BATTERY_FILE_ALARM
,
619 S_IFREG
| S_IRUGO
| S_IWUSR
,
620 acpi_device_dir(device
));
624 entry
->proc_fops
= &acpi_battery_alarm_ops
;
625 entry
->data
= acpi_driver_data(device
);
626 entry
->owner
= THIS_MODULE
;
632 static int acpi_battery_remove_fs(struct acpi_device
*device
)
635 if (acpi_device_dir(device
)) {
636 remove_proc_entry(ACPI_BATTERY_FILE_ALARM
,
637 acpi_device_dir(device
));
638 remove_proc_entry(ACPI_BATTERY_FILE_STATUS
,
639 acpi_device_dir(device
));
640 remove_proc_entry(ACPI_BATTERY_FILE_INFO
,
641 acpi_device_dir(device
));
643 remove_proc_entry(acpi_device_bid(device
), acpi_battery_dir
);
644 acpi_device_dir(device
) = NULL
;
650 /* --------------------------------------------------------------------------
652 -------------------------------------------------------------------------- */
654 static void acpi_battery_notify(acpi_handle handle
, u32 event
, void *data
)
656 struct acpi_battery
*battery
= (struct acpi_battery
*)data
;
657 struct acpi_device
*device
= NULL
;
663 device
= battery
->device
;
666 case ACPI_BATTERY_NOTIFY_STATUS
:
667 case ACPI_BATTERY_NOTIFY_INFO
:
668 acpi_battery_check(battery
);
669 acpi_bus_generate_event(device
, event
, battery
->flags
.present
);
672 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
673 "Unsupported event [0x%x]\n", event
));
680 static int acpi_battery_add(struct acpi_device
*device
)
683 acpi_status status
= 0;
684 struct acpi_battery
*battery
= NULL
;
690 battery
= kmalloc(sizeof(struct acpi_battery
), GFP_KERNEL
);
693 memset(battery
, 0, sizeof(struct acpi_battery
));
695 battery
->device
= device
;
696 strcpy(acpi_device_name(device
), ACPI_BATTERY_DEVICE_NAME
);
697 strcpy(acpi_device_class(device
), ACPI_BATTERY_CLASS
);
698 acpi_driver_data(device
) = battery
;
700 result
= acpi_battery_check(battery
);
704 result
= acpi_battery_add_fs(device
);
708 status
= acpi_install_notify_handler(device
->handle
,
710 acpi_battery_notify
, battery
);
711 if (ACPI_FAILURE(status
)) {
716 printk(KERN_INFO PREFIX
"%s Slot [%s] (battery %s)\n",
717 ACPI_BATTERY_DEVICE_NAME
, acpi_device_bid(device
),
718 device
->status
.battery_present
? "present" : "absent");
722 acpi_battery_remove_fs(device
);
729 static int acpi_battery_remove(struct acpi_device
*device
, int type
)
731 acpi_status status
= 0;
732 struct acpi_battery
*battery
= NULL
;
735 if (!device
|| !acpi_driver_data(device
))
738 battery
= (struct acpi_battery
*)acpi_driver_data(device
);
740 status
= acpi_remove_notify_handler(device
->handle
,
742 acpi_battery_notify
);
744 acpi_battery_remove_fs(device
);
751 static int __init
acpi_battery_init(void)
756 acpi_battery_dir
= proc_mkdir(ACPI_BATTERY_CLASS
, acpi_root_dir
);
757 if (!acpi_battery_dir
)
759 acpi_battery_dir
->owner
= THIS_MODULE
;
761 result
= acpi_bus_register_driver(&acpi_battery_driver
);
763 remove_proc_entry(ACPI_BATTERY_CLASS
, acpi_root_dir
);
770 static void __exit
acpi_battery_exit(void)
773 acpi_bus_unregister_driver(&acpi_battery_driver
);
775 remove_proc_entry(ACPI_BATTERY_CLASS
, acpi_root_dir
);
780 module_init(acpi_battery_init
);
781 module_exit(acpi_battery_exit
);