xref: /openbmc/linux/drivers/acpi/ac.c (revision 3805e6a1)
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 "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 static const struct acpi_device_id ac_device_ids[] = {
61 	{"ACPI0003", 0},
62 	{"", 0},
63 };
64 MODULE_DEVICE_TABLE(acpi, ac_device_ids);
65 
66 #ifdef CONFIG_PM_SLEEP
67 static int acpi_ac_resume(struct device *dev);
68 #endif
69 static SIMPLE_DEV_PM_OPS(acpi_ac_pm, NULL, acpi_ac_resume);
70 
71 #ifdef CONFIG_ACPI_PROCFS_POWER
72 extern struct proc_dir_entry *acpi_lock_ac_dir(void);
73 extern void *acpi_unlock_ac_dir(struct proc_dir_entry *acpi_ac_dir);
74 static int acpi_ac_open_fs(struct inode *inode, struct file *file);
75 #endif
76 
77 
78 static int ac_sleep_before_get_state_ms;
79 
80 static struct acpi_driver acpi_ac_driver = {
81 	.name = "ac",
82 	.class = ACPI_AC_CLASS,
83 	.ids = ac_device_ids,
84 	.flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
85 	.ops = {
86 		.add = acpi_ac_add,
87 		.remove = acpi_ac_remove,
88 		.notify = acpi_ac_notify,
89 		},
90 	.drv.pm = &acpi_ac_pm,
91 };
92 
93 struct acpi_ac {
94 	struct power_supply *charger;
95 	struct power_supply_desc charger_desc;
96 	struct acpi_device * device;
97 	unsigned long long state;
98 	struct notifier_block battery_nb;
99 };
100 
101 #define to_acpi_ac(x) power_supply_get_drvdata(x)
102 
103 #ifdef CONFIG_ACPI_PROCFS_POWER
104 static const struct file_operations acpi_ac_fops = {
105 	.owner = THIS_MODULE,
106 	.open = acpi_ac_open_fs,
107 	.read = seq_read,
108 	.llseek = seq_lseek,
109 	.release = single_release,
110 };
111 #endif
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_open_fs(struct inode *inode, struct file *file)
202 {
203 	return single_open(file, acpi_ac_seq_show, PDE_DATA(inode));
204 }
205 
206 static int acpi_ac_add_fs(struct acpi_ac *ac)
207 {
208 	struct proc_dir_entry *entry = NULL;
209 
210 	printk(KERN_WARNING PREFIX "Deprecated procfs I/F for AC is loaded,"
211 			" please retry with CONFIG_ACPI_PROCFS_POWER cleared\n");
212 	if (!acpi_device_dir(ac->device)) {
213 		acpi_device_dir(ac->device) =
214 			proc_mkdir(acpi_device_bid(ac->device), acpi_ac_dir);
215 		if (!acpi_device_dir(ac->device))
216 			return -ENODEV;
217 	}
218 
219 	/* 'state' [R] */
220 	entry = proc_create_data(ACPI_AC_FILE_STATE,
221 				 S_IRUGO, acpi_device_dir(ac->device),
222 				 &acpi_ac_fops, ac);
223 	if (!entry)
224 		return -ENODEV;
225 	return 0;
226 }
227 
228 static int acpi_ac_remove_fs(struct acpi_ac *ac)
229 {
230 
231 	if (acpi_device_dir(ac->device)) {
232 		remove_proc_entry(ACPI_AC_FILE_STATE,
233 				  acpi_device_dir(ac->device));
234 		remove_proc_entry(acpi_device_bid(ac->device), acpi_ac_dir);
235 		acpi_device_dir(ac->device) = NULL;
236 	}
237 
238 	return 0;
239 }
240 #endif
241 
242 /* --------------------------------------------------------------------------
243                                    Driver Model
244    -------------------------------------------------------------------------- */
245 
246 static void acpi_ac_notify(struct acpi_device *device, u32 event)
247 {
248 	struct acpi_ac *ac = acpi_driver_data(device);
249 
250 	if (!ac)
251 		return;
252 
253 	switch (event) {
254 	default:
255 		ACPI_DEBUG_PRINT((ACPI_DB_INFO,
256 				  "Unsupported event [0x%x]\n", event));
257 	case ACPI_AC_NOTIFY_STATUS:
258 	case ACPI_NOTIFY_BUS_CHECK:
259 	case ACPI_NOTIFY_DEVICE_CHECK:
260 		/*
261 		 * A buggy BIOS may notify AC first and then sleep for
262 		 * a specific time before doing actual operations in the
263 		 * EC event handler (_Qxx). This will cause the AC state
264 		 * reported by the ACPI event to be incorrect, so wait for a
265 		 * specific time for the EC event handler to make progress.
266 		 */
267 		if (ac_sleep_before_get_state_ms > 0)
268 			msleep(ac_sleep_before_get_state_ms);
269 
270 		acpi_ac_get_state(ac);
271 		acpi_bus_generate_netlink_event(device->pnp.device_class,
272 						  dev_name(&device->dev), event,
273 						  (u32) ac->state);
274 		acpi_notifier_call_chain(device, event, (u32) ac->state);
275 		kobject_uevent(&ac->charger->dev.kobj, KOBJ_CHANGE);
276 	}
277 
278 	return;
279 }
280 
281 static int acpi_ac_battery_notify(struct notifier_block *nb,
282 				  unsigned long action, void *data)
283 {
284 	struct acpi_ac *ac = container_of(nb, struct acpi_ac, battery_nb);
285 	struct acpi_bus_event *event = (struct acpi_bus_event *)data;
286 
287 	/*
288 	 * On HP Pavilion dv6-6179er AC status notifications aren't triggered
289 	 * when adapter is plugged/unplugged. However, battery status
290 	 * notifcations are triggered when battery starts charging or
291 	 * discharging. Re-reading AC status triggers lost AC notifications,
292 	 * if AC status has changed.
293 	 */
294 	if (strcmp(event->device_class, ACPI_BATTERY_CLASS) == 0 &&
295 	    event->type == ACPI_BATTERY_NOTIFY_STATUS)
296 		acpi_ac_get_state(ac);
297 
298 	return NOTIFY_OK;
299 }
300 
301 static int thinkpad_e530_quirk(const struct dmi_system_id *d)
302 {
303 	ac_sleep_before_get_state_ms = 1000;
304 	return 0;
305 }
306 
307 static const struct dmi_system_id ac_dmi_table[] = {
308 	{
309 	.callback = thinkpad_e530_quirk,
310 	.ident = "thinkpad e530",
311 	.matches = {
312 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
313 		DMI_MATCH(DMI_PRODUCT_NAME, "32597CG"),
314 		},
315 	},
316 	{},
317 };
318 
319 static int acpi_ac_add(struct acpi_device *device)
320 {
321 	struct power_supply_config psy_cfg = {};
322 	int result = 0;
323 	struct acpi_ac *ac = NULL;
324 
325 
326 	if (!device)
327 		return -EINVAL;
328 
329 	ac = kzalloc(sizeof(struct acpi_ac), GFP_KERNEL);
330 	if (!ac)
331 		return -ENOMEM;
332 
333 	ac->device = device;
334 	strcpy(acpi_device_name(device), ACPI_AC_DEVICE_NAME);
335 	strcpy(acpi_device_class(device), ACPI_AC_CLASS);
336 	device->driver_data = ac;
337 
338 	result = acpi_ac_get_state(ac);
339 	if (result)
340 		goto end;
341 
342 	psy_cfg.drv_data = ac;
343 
344 	ac->charger_desc.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_desc.type = POWER_SUPPLY_TYPE_MAINS;
351 	ac->charger_desc.properties = ac_props;
352 	ac->charger_desc.num_properties = ARRAY_SIZE(ac_props);
353 	ac->charger_desc.get_property = get_ac_property;
354 	ac->charger = power_supply_register(&ac->device->dev,
355 					    &ac->charger_desc, &psy_cfg);
356 	if (IS_ERR(ac->charger)) {
357 		result = PTR_ERR(ac->charger);
358 		goto end;
359 	}
360 
361 	printk(KERN_INFO PREFIX "%s [%s] (%s)\n",
362 	       acpi_device_name(device), acpi_device_bid(device),
363 	       ac->state ? "on-line" : "off-line");
364 
365 	ac->battery_nb.notifier_call = acpi_ac_battery_notify;
366 	register_acpi_notifier(&ac->battery_nb);
367 end:
368 	if (result) {
369 #ifdef CONFIG_ACPI_PROCFS_POWER
370 		acpi_ac_remove_fs(ac);
371 #endif
372 		kfree(ac);
373 	}
374 
375 	dmi_check_system(ac_dmi_table);
376 	return result;
377 }
378 
379 #ifdef CONFIG_PM_SLEEP
380 static int acpi_ac_resume(struct device *dev)
381 {
382 	struct acpi_ac *ac;
383 	unsigned old_state;
384 
385 	if (!dev)
386 		return -EINVAL;
387 
388 	ac = acpi_driver_data(to_acpi_device(dev));
389 	if (!ac)
390 		return -EINVAL;
391 
392 	old_state = ac->state;
393 	if (acpi_ac_get_state(ac))
394 		return 0;
395 	if (old_state != ac->state)
396 		kobject_uevent(&ac->charger->dev.kobj, KOBJ_CHANGE);
397 	return 0;
398 }
399 #else
400 #define acpi_ac_resume NULL
401 #endif
402 
403 static int acpi_ac_remove(struct acpi_device *device)
404 {
405 	struct acpi_ac *ac = NULL;
406 
407 
408 	if (!device || !acpi_driver_data(device))
409 		return -EINVAL;
410 
411 	ac = acpi_driver_data(device);
412 
413 	power_supply_unregister(ac->charger);
414 	unregister_acpi_notifier(&ac->battery_nb);
415 
416 #ifdef CONFIG_ACPI_PROCFS_POWER
417 	acpi_ac_remove_fs(ac);
418 #endif
419 
420 	kfree(ac);
421 
422 	return 0;
423 }
424 
425 static int __init acpi_ac_init(void)
426 {
427 	int result;
428 
429 	if (acpi_disabled)
430 		return -ENODEV;
431 
432 #ifdef CONFIG_ACPI_PROCFS_POWER
433 	acpi_ac_dir = acpi_lock_ac_dir();
434 	if (!acpi_ac_dir)
435 		return -ENODEV;
436 #endif
437 
438 
439 	result = acpi_bus_register_driver(&acpi_ac_driver);
440 	if (result < 0) {
441 #ifdef CONFIG_ACPI_PROCFS_POWER
442 		acpi_unlock_ac_dir(acpi_ac_dir);
443 #endif
444 		return -ENODEV;
445 	}
446 
447 	return 0;
448 }
449 
450 static void __exit acpi_ac_exit(void)
451 {
452 	acpi_bus_unregister_driver(&acpi_ac_driver);
453 #ifdef CONFIG_ACPI_PROCFS_POWER
454 	acpi_unlock_ac_dir(acpi_ac_dir);
455 #endif
456 }
457 module_init(acpi_ac_init);
458 module_exit(acpi_ac_exit);
459