1/*
2 *  acpi_ac.c - ACPI AC Adapter Driver ($Revision: 27 $)
3 *
4 *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
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.
13 *
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.
18 *
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.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
25
26#include <linux/kernel.h>
27#include <linux/module.h>
28#include <linux/slab.h>
29#include <linux/init.h>
30#include <linux/types.h>
31#include <linux/dmi.h>
32#include <linux/delay.h>
33#ifdef CONFIG_ACPI_PROCFS_POWER
34#include <linux/proc_fs.h>
35#include <linux/seq_file.h>
36#endif
37#include <linux/platform_device.h>
38#include <linux/power_supply.h>
39#include <linux/acpi.h>
40#include "battery.h"
41
42#define PREFIX "ACPI: "
43
44#define ACPI_AC_CLASS			"ac_adapter"
45#define ACPI_AC_DEVICE_NAME		"AC Adapter"
46#define ACPI_AC_FILE_STATE		"state"
47#define ACPI_AC_NOTIFY_STATUS		0x80
48#define ACPI_AC_STATUS_OFFLINE		0x00
49#define ACPI_AC_STATUS_ONLINE		0x01
50#define ACPI_AC_STATUS_UNKNOWN		0xFF
51
52#define _COMPONENT		ACPI_AC_COMPONENT
53ACPI_MODULE_NAME("ac");
54
55MODULE_AUTHOR("Paul Diefenbaugh");
56MODULE_DESCRIPTION("ACPI AC Adapter Driver");
57MODULE_LICENSE("GPL");
58
59
60static int acpi_ac_add(struct acpi_device *device);
61static int acpi_ac_remove(struct acpi_device *device);
62static void acpi_ac_notify(struct acpi_device *device, u32 event);
63
64static const struct acpi_device_id ac_device_ids[] = {
65	{"ACPI0003", 0},
66	{"", 0},
67};
68MODULE_DEVICE_TABLE(acpi, ac_device_ids);
69
70#ifdef CONFIG_PM_SLEEP
71static int acpi_ac_resume(struct device *dev);
72#endif
73static SIMPLE_DEV_PM_OPS(acpi_ac_pm, NULL, acpi_ac_resume);
74
75#ifdef CONFIG_ACPI_PROCFS_POWER
76extern struct proc_dir_entry *acpi_lock_ac_dir(void);
77extern void *acpi_unlock_ac_dir(struct proc_dir_entry *acpi_ac_dir);
78static int acpi_ac_open_fs(struct inode *inode, struct file *file);
79#endif
80
81
82static int ac_sleep_before_get_state_ms;
83
84static struct acpi_driver acpi_ac_driver = {
85	.name = "ac",
86	.class = ACPI_AC_CLASS,
87	.ids = ac_device_ids,
88	.flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
89	.ops = {
90		.add = acpi_ac_add,
91		.remove = acpi_ac_remove,
92		.notify = acpi_ac_notify,
93		},
94	.drv.pm = &acpi_ac_pm,
95};
96
97struct acpi_ac {
98	struct power_supply charger;
99	struct acpi_device * device;
100	unsigned long long state;
101	struct notifier_block battery_nb;
102};
103
104#define to_acpi_ac(x) container_of(x, struct acpi_ac, charger)
105
106#ifdef CONFIG_ACPI_PROCFS_POWER
107static const struct file_operations acpi_ac_fops = {
108	.owner = THIS_MODULE,
109	.open = acpi_ac_open_fs,
110	.read = seq_read,
111	.llseek = seq_lseek,
112	.release = single_release,
113};
114#endif
115
116/* --------------------------------------------------------------------------
117                               AC Adapter Management
118   -------------------------------------------------------------------------- */
119
120static int acpi_ac_get_state(struct acpi_ac *ac)
121{
122	acpi_status status = AE_OK;
123
124	if (!ac)
125		return -EINVAL;
126
127	status = acpi_evaluate_integer(ac->device->handle, "_PSR", NULL,
128				       &ac->state);
129	if (ACPI_FAILURE(status)) {
130		ACPI_EXCEPTION((AE_INFO, status,
131				"Error reading AC Adapter state"));
132		ac->state = ACPI_AC_STATUS_UNKNOWN;
133		return -ENODEV;
134	}
135
136	return 0;
137}
138
139/* --------------------------------------------------------------------------
140                            sysfs I/F
141   -------------------------------------------------------------------------- */
142static int get_ac_property(struct power_supply *psy,
143			   enum power_supply_property psp,
144			   union power_supply_propval *val)
145{
146	struct acpi_ac *ac = to_acpi_ac(psy);
147
148	if (!ac)
149		return -ENODEV;
150
151	if (acpi_ac_get_state(ac))
152		return -ENODEV;
153
154	switch (psp) {
155	case POWER_SUPPLY_PROP_ONLINE:
156		val->intval = ac->state;
157		break;
158	default:
159		return -EINVAL;
160	}
161	return 0;
162}
163
164static enum power_supply_property ac_props[] = {
165	POWER_SUPPLY_PROP_ONLINE,
166};
167
168#ifdef CONFIG_ACPI_PROCFS_POWER
169/* --------------------------------------------------------------------------
170                              FS Interface (/proc)
171   -------------------------------------------------------------------------- */
172
173static struct proc_dir_entry *acpi_ac_dir;
174
175static int acpi_ac_seq_show(struct seq_file *seq, void *offset)
176{
177	struct acpi_ac *ac = seq->private;
178
179
180	if (!ac)
181		return 0;
182
183	if (acpi_ac_get_state(ac)) {
184		seq_puts(seq, "ERROR: Unable to read AC Adapter state\n");
185		return 0;
186	}
187
188	seq_puts(seq, "state:                   ");
189	switch (ac->state) {
190	case ACPI_AC_STATUS_OFFLINE:
191		seq_puts(seq, "off-line\n");
192		break;
193	case ACPI_AC_STATUS_ONLINE:
194		seq_puts(seq, "on-line\n");
195		break;
196	default:
197		seq_puts(seq, "unknown\n");
198		break;
199	}
200
201	return 0;
202}
203
204static int acpi_ac_open_fs(struct inode *inode, struct file *file)
205{
206	return single_open(file, acpi_ac_seq_show, PDE_DATA(inode));
207}
208
209static int acpi_ac_add_fs(struct acpi_ac *ac)
210{
211	struct proc_dir_entry *entry = NULL;
212
213	printk(KERN_WARNING PREFIX "Deprecated procfs I/F for AC is loaded,"
214			" please retry with CONFIG_ACPI_PROCFS_POWER cleared\n");
215	if (!acpi_device_dir(ac->device)) {
216		acpi_device_dir(ac->device) =
217			proc_mkdir(acpi_device_bid(ac->device), acpi_ac_dir);
218		if (!acpi_device_dir(ac->device))
219			return -ENODEV;
220	}
221
222	/* 'state' [R] */
223	entry = proc_create_data(ACPI_AC_FILE_STATE,
224				 S_IRUGO, acpi_device_dir(ac->device),
225				 &acpi_ac_fops, ac);
226	if (!entry)
227		return -ENODEV;
228	return 0;
229}
230
231static int acpi_ac_remove_fs(struct acpi_ac *ac)
232{
233
234	if (acpi_device_dir(ac->device)) {
235		remove_proc_entry(ACPI_AC_FILE_STATE,
236				  acpi_device_dir(ac->device));
237		remove_proc_entry(acpi_device_bid(ac->device), acpi_ac_dir);
238		acpi_device_dir(ac->device) = NULL;
239	}
240
241	return 0;
242}
243#endif
244
245/* --------------------------------------------------------------------------
246                                   Driver Model
247   -------------------------------------------------------------------------- */
248
249static void acpi_ac_notify(struct acpi_device *device, u32 event)
250{
251	struct acpi_ac *ac = acpi_driver_data(device);
252
253	if (!ac)
254		return;
255
256	switch (event) {
257	default:
258		ACPI_DEBUG_PRINT((ACPI_DB_INFO,
259				  "Unsupported event [0x%x]\n", event));
260	case ACPI_AC_NOTIFY_STATUS:
261	case ACPI_NOTIFY_BUS_CHECK:
262	case ACPI_NOTIFY_DEVICE_CHECK:
263		/*
264		 * A buggy BIOS may notify AC first and then sleep for
265		 * a specific time before doing actual operations in the
266		 * EC event handler (_Qxx). This will cause the AC state
267		 * reported by the ACPI event to be incorrect, so wait for a
268		 * specific time for the EC event handler to make progress.
269		 */
270		if (ac_sleep_before_get_state_ms > 0)
271			msleep(ac_sleep_before_get_state_ms);
272
273		acpi_ac_get_state(ac);
274		acpi_bus_generate_netlink_event(device->pnp.device_class,
275						  dev_name(&device->dev), event,
276						  (u32) ac->state);
277		acpi_notifier_call_chain(device, event, (u32) ac->state);
278		kobject_uevent(&ac->charger.dev->kobj, KOBJ_CHANGE);
279	}
280
281	return;
282}
283
284static int acpi_ac_battery_notify(struct notifier_block *nb,
285				  unsigned long action, void *data)
286{
287	struct acpi_ac *ac = container_of(nb, struct acpi_ac, battery_nb);
288	struct acpi_bus_event *event = (struct acpi_bus_event *)data;
289
290	/*
291	 * On HP Pavilion dv6-6179er AC status notifications aren't triggered
292	 * when adapter is plugged/unplugged. However, battery status
293	 * notifcations are triggered when battery starts charging or
294	 * discharging. Re-reading AC status triggers lost AC notifications,
295	 * if AC status has changed.
296	 */
297	if (strcmp(event->device_class, ACPI_BATTERY_CLASS) == 0 &&
298	    event->type == ACPI_BATTERY_NOTIFY_STATUS)
299		acpi_ac_get_state(ac);
300
301	return NOTIFY_OK;
302}
303
304static int thinkpad_e530_quirk(const struct dmi_system_id *d)
305{
306	ac_sleep_before_get_state_ms = 1000;
307	return 0;
308}
309
310static struct dmi_system_id ac_dmi_table[] = {
311	{
312	.callback = thinkpad_e530_quirk,
313	.ident = "thinkpad e530",
314	.matches = {
315		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
316		DMI_MATCH(DMI_PRODUCT_NAME, "32597CG"),
317		},
318	},
319	{},
320};
321
322static int acpi_ac_add(struct acpi_device *device)
323{
324	int result = 0;
325	struct acpi_ac *ac = NULL;
326
327
328	if (!device)
329		return -EINVAL;
330
331	ac = kzalloc(sizeof(struct acpi_ac), GFP_KERNEL);
332	if (!ac)
333		return -ENOMEM;
334
335	ac->device = device;
336	strcpy(acpi_device_name(device), ACPI_AC_DEVICE_NAME);
337	strcpy(acpi_device_class(device), ACPI_AC_CLASS);
338	device->driver_data = ac;
339
340	result = acpi_ac_get_state(ac);
341	if (result)
342		goto end;
343
344	ac->charger.name = acpi_device_bid(device);
345#ifdef CONFIG_ACPI_PROCFS_POWER
346	result = acpi_ac_add_fs(ac);
347	if (result)
348		goto end;
349#endif
350	ac->charger.type = POWER_SUPPLY_TYPE_MAINS;
351	ac->charger.properties = ac_props;
352	ac->charger.num_properties = ARRAY_SIZE(ac_props);
353	ac->charger.get_property = get_ac_property;
354	result = power_supply_register(&ac->device->dev, &ac->charger);
355	if (result)
356		goto end;
357
358	printk(KERN_INFO PREFIX "%s [%s] (%s)\n",
359	       acpi_device_name(device), acpi_device_bid(device),
360	       ac->state ? "on-line" : "off-line");
361
362	ac->battery_nb.notifier_call = acpi_ac_battery_notify;
363	register_acpi_notifier(&ac->battery_nb);
364end:
365	if (result) {
366#ifdef CONFIG_ACPI_PROCFS_POWER
367		acpi_ac_remove_fs(ac);
368#endif
369		kfree(ac);
370	}
371
372	dmi_check_system(ac_dmi_table);
373	return result;
374}
375
376#ifdef CONFIG_PM_SLEEP
377static int acpi_ac_resume(struct device *dev)
378{
379	struct acpi_ac *ac;
380	unsigned old_state;
381
382	if (!dev)
383		return -EINVAL;
384
385	ac = acpi_driver_data(to_acpi_device(dev));
386	if (!ac)
387		return -EINVAL;
388
389	old_state = ac->state;
390	if (acpi_ac_get_state(ac))
391		return 0;
392	if (old_state != ac->state)
393		kobject_uevent(&ac->charger.dev->kobj, KOBJ_CHANGE);
394	return 0;
395}
396#else
397#define acpi_ac_resume NULL
398#endif
399
400static int acpi_ac_remove(struct acpi_device *device)
401{
402	struct acpi_ac *ac = NULL;
403
404
405	if (!device || !acpi_driver_data(device))
406		return -EINVAL;
407
408	ac = acpi_driver_data(device);
409
410	if (ac->charger.dev)
411		power_supply_unregister(&ac->charger);
412	unregister_acpi_notifier(&ac->battery_nb);
413
414#ifdef CONFIG_ACPI_PROCFS_POWER
415	acpi_ac_remove_fs(ac);
416#endif
417
418	kfree(ac);
419
420	return 0;
421}
422
423static int __init acpi_ac_init(void)
424{
425	int result;
426
427	if (acpi_disabled)
428		return -ENODEV;
429
430#ifdef CONFIG_ACPI_PROCFS_POWER
431	acpi_ac_dir = acpi_lock_ac_dir();
432	if (!acpi_ac_dir)
433		return -ENODEV;
434#endif
435
436
437	result = acpi_bus_register_driver(&acpi_ac_driver);
438	if (result < 0) {
439#ifdef CONFIG_ACPI_PROCFS_POWER
440		acpi_unlock_ac_dir(acpi_ac_dir);
441#endif
442		return -ENODEV;
443	}
444
445	return 0;
446}
447
448static void __exit acpi_ac_exit(void)
449{
450	acpi_bus_unregister_driver(&acpi_ac_driver);
451#ifdef CONFIG_ACPI_PROCFS_POWER
452	acpi_unlock_ac_dir(acpi_ac_dir);
453#endif
454}
455module_init(acpi_ac_init);
456module_exit(acpi_ac_exit);
457