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