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