xref: /linux/drivers/acpi/ac.c (revision ea8a163e02d6925773129e2dd86e419e491b791d)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  acpi_ac.c - ACPI AC Adapter Driver (Revision: 27)
4  *
5  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7  */
8 
9 #define pr_fmt(fmt) "ACPI: AC: " fmt
10 
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/slab.h>
14 #include <linux/init.h>
15 #include <linux/types.h>
16 #include <linux/dmi.h>
17 #include <linux/delay.h>
18 #include <linux/platform_device.h>
19 #include <linux/power_supply.h>
20 #include <linux/acpi.h>
21 #include <acpi/battery.h>
22 
23 #define ACPI_AC_CLASS			"ac_adapter"
24 #define ACPI_AC_DEVICE_NAME		"AC Adapter"
25 #define ACPI_AC_FILE_STATE		"state"
26 #define ACPI_AC_NOTIFY_STATUS		0x80
27 #define ACPI_AC_STATUS_OFFLINE		0x00
28 #define ACPI_AC_STATUS_ONLINE		0x01
29 #define ACPI_AC_STATUS_UNKNOWN		0xFF
30 
31 MODULE_AUTHOR("Paul Diefenbaugh");
32 MODULE_DESCRIPTION("ACPI AC Adapter Driver");
33 MODULE_LICENSE("GPL");
34 
35 
36 static int acpi_ac_add(struct acpi_device *device);
37 static int acpi_ac_remove(struct acpi_device *device);
38 static void acpi_ac_notify(struct acpi_device *device, u32 event);
39 
40 struct acpi_ac_bl {
41 	const char *hid;
42 	int hrv;
43 };
44 
45 static const struct acpi_device_id ac_device_ids[] = {
46 	{"ACPI0003", 0},
47 	{"", 0},
48 };
49 MODULE_DEVICE_TABLE(acpi, ac_device_ids);
50 
51 /* Lists of PMIC ACPI HIDs with an (often better) native charger driver */
52 static const struct acpi_ac_bl acpi_ac_blacklist[] = {
53 	{ "INT33F4", -1 }, /* X-Powers AXP288 PMIC */
54 	{ "INT34D3",  3 }, /* Intel Cherrytrail Whiskey Cove PMIC */
55 };
56 
57 #ifdef CONFIG_PM_SLEEP
58 static int acpi_ac_resume(struct device *dev);
59 #endif
60 static SIMPLE_DEV_PM_OPS(acpi_ac_pm, NULL, acpi_ac_resume);
61 
62 static int ac_sleep_before_get_state_ms;
63 static int ac_check_pmic = 1;
64 static int ac_only;
65 
66 static struct acpi_driver acpi_ac_driver = {
67 	.name = "ac",
68 	.class = ACPI_AC_CLASS,
69 	.ids = ac_device_ids,
70 	.flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
71 	.ops = {
72 		.add = acpi_ac_add,
73 		.remove = acpi_ac_remove,
74 		.notify = acpi_ac_notify,
75 		},
76 	.drv.pm = &acpi_ac_pm,
77 };
78 
79 struct acpi_ac {
80 	struct power_supply *charger;
81 	struct power_supply_desc charger_desc;
82 	struct acpi_device *device;
83 	unsigned long long state;
84 	struct notifier_block battery_nb;
85 };
86 
87 #define to_acpi_ac(x) power_supply_get_drvdata(x)
88 
89 /* AC Adapter Management */
90 static int acpi_ac_get_state(struct acpi_ac *ac)
91 {
92 	acpi_status status = AE_OK;
93 
94 	if (!ac)
95 		return -EINVAL;
96 
97 	if (ac_only) {
98 		ac->state = 1;
99 		return 0;
100 	}
101 
102 	status = acpi_evaluate_integer(ac->device->handle, "_PSR", NULL,
103 				       &ac->state);
104 	if (ACPI_FAILURE(status)) {
105 		acpi_handle_info(ac->device->handle,
106 				"Error reading AC Adapter state: %s\n",
107 				acpi_format_exception(status));
108 		ac->state = ACPI_AC_STATUS_UNKNOWN;
109 		return -ENODEV;
110 	}
111 
112 	return 0;
113 }
114 
115 /* sysfs I/F */
116 static int get_ac_property(struct power_supply *psy,
117 			   enum power_supply_property psp,
118 			   union power_supply_propval *val)
119 {
120 	struct acpi_ac *ac = to_acpi_ac(psy);
121 
122 	if (!ac)
123 		return -ENODEV;
124 
125 	if (acpi_ac_get_state(ac))
126 		return -ENODEV;
127 
128 	switch (psp) {
129 	case POWER_SUPPLY_PROP_ONLINE:
130 		val->intval = ac->state;
131 		break;
132 	default:
133 		return -EINVAL;
134 	}
135 	return 0;
136 }
137 
138 static enum power_supply_property ac_props[] = {
139 	POWER_SUPPLY_PROP_ONLINE,
140 };
141 
142 /* Driver Model */
143 static void acpi_ac_notify(struct acpi_device *device, u32 event)
144 {
145 	struct acpi_ac *ac = acpi_driver_data(device);
146 
147 	if (!ac)
148 		return;
149 
150 	switch (event) {
151 	default:
152 		acpi_handle_debug(device->handle, "Unsupported event [0x%x]\n",
153 				  event);
154 		fallthrough;
155 	case ACPI_AC_NOTIFY_STATUS:
156 	case ACPI_NOTIFY_BUS_CHECK:
157 	case ACPI_NOTIFY_DEVICE_CHECK:
158 		/*
159 		 * A buggy BIOS may notify AC first and then sleep for
160 		 * a specific time before doing actual operations in the
161 		 * EC event handler (_Qxx). This will cause the AC state
162 		 * reported by the ACPI event to be incorrect, so wait for a
163 		 * specific time for the EC event handler to make progress.
164 		 */
165 		if (ac_sleep_before_get_state_ms > 0)
166 			msleep(ac_sleep_before_get_state_ms);
167 
168 		acpi_ac_get_state(ac);
169 		acpi_bus_generate_netlink_event(device->pnp.device_class,
170 						  dev_name(&device->dev), event,
171 						  (u32) ac->state);
172 		acpi_notifier_call_chain(device, event, (u32) ac->state);
173 		kobject_uevent(&ac->charger->dev.kobj, KOBJ_CHANGE);
174 	}
175 }
176 
177 static int acpi_ac_battery_notify(struct notifier_block *nb,
178 				  unsigned long action, void *data)
179 {
180 	struct acpi_ac *ac = container_of(nb, struct acpi_ac, battery_nb);
181 	struct acpi_bus_event *event = (struct acpi_bus_event *)data;
182 
183 	/*
184 	 * On HP Pavilion dv6-6179er AC status notifications aren't triggered
185 	 * when adapter is plugged/unplugged. However, battery status
186 	 * notifications are triggered when battery starts charging or
187 	 * discharging. Re-reading AC status triggers lost AC notifications,
188 	 * if AC status has changed.
189 	 */
190 	if (strcmp(event->device_class, ACPI_BATTERY_CLASS) == 0 &&
191 	    event->type == ACPI_BATTERY_NOTIFY_STATUS)
192 		acpi_ac_get_state(ac);
193 
194 	return NOTIFY_OK;
195 }
196 
197 static int __init thinkpad_e530_quirk(const struct dmi_system_id *d)
198 {
199 	ac_sleep_before_get_state_ms = 1000;
200 	return 0;
201 }
202 
203 static int __init ac_do_not_check_pmic_quirk(const struct dmi_system_id *d)
204 {
205 	ac_check_pmic = 0;
206 	return 0;
207 }
208 
209 static int __init ac_only_quirk(const struct dmi_system_id *d)
210 {
211 	ac_only = 1;
212 	return 0;
213 }
214 
215 /* Please keep this list alphabetically sorted */
216 static const struct dmi_system_id ac_dmi_table[]  __initconst = {
217 	{
218 		/* ECS EF20EA, AXP288 PMIC but uses separate fuel-gauge */
219 		.callback = ac_do_not_check_pmic_quirk,
220 		.matches = {
221 			DMI_MATCH(DMI_PRODUCT_NAME, "EF20EA"),
222 		},
223 	},
224 	{
225 		/* Kodlix GK45 returning incorrect state */
226 		.callback = ac_only_quirk,
227 		.matches = {
228 			DMI_MATCH(DMI_PRODUCT_NAME, "GK45"),
229 		},
230 	},
231 	{
232 		/* Lenovo Ideapad Miix 320, AXP288 PMIC, separate fuel-gauge */
233 		.callback = ac_do_not_check_pmic_quirk,
234 		.matches = {
235 			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
236 			DMI_MATCH(DMI_PRODUCT_NAME, "80XF"),
237 			DMI_MATCH(DMI_PRODUCT_VERSION, "Lenovo MIIX 320-10ICR"),
238 		},
239 	},
240 	{
241 		/* Lenovo Thinkpad e530, see comment in acpi_ac_notify() */
242 		.callback = thinkpad_e530_quirk,
243 		.matches = {
244 			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
245 			DMI_MATCH(DMI_PRODUCT_NAME, "32597CG"),
246 		},
247 	},
248 	{},
249 };
250 
251 static int acpi_ac_add(struct acpi_device *device)
252 {
253 	struct power_supply_config psy_cfg = {};
254 	int result = 0;
255 	struct acpi_ac *ac = NULL;
256 
257 
258 	if (!device)
259 		return -EINVAL;
260 
261 	ac = kzalloc(sizeof(struct acpi_ac), GFP_KERNEL);
262 	if (!ac)
263 		return -ENOMEM;
264 
265 	ac->device = device;
266 	strcpy(acpi_device_name(device), ACPI_AC_DEVICE_NAME);
267 	strcpy(acpi_device_class(device), ACPI_AC_CLASS);
268 	device->driver_data = ac;
269 
270 	result = acpi_ac_get_state(ac);
271 	if (result)
272 		goto end;
273 
274 	psy_cfg.drv_data = ac;
275 
276 	ac->charger_desc.name = acpi_device_bid(device);
277 	ac->charger_desc.type = POWER_SUPPLY_TYPE_MAINS;
278 	ac->charger_desc.properties = ac_props;
279 	ac->charger_desc.num_properties = ARRAY_SIZE(ac_props);
280 	ac->charger_desc.get_property = get_ac_property;
281 	ac->charger = power_supply_register(&ac->device->dev,
282 					    &ac->charger_desc, &psy_cfg);
283 	if (IS_ERR(ac->charger)) {
284 		result = PTR_ERR(ac->charger);
285 		goto end;
286 	}
287 
288 	pr_info("%s [%s] (%s)\n", acpi_device_name(device),
289 		acpi_device_bid(device), ac->state ? "on-line" : "off-line");
290 
291 	ac->battery_nb.notifier_call = acpi_ac_battery_notify;
292 	register_acpi_notifier(&ac->battery_nb);
293 end:
294 	if (result)
295 		kfree(ac);
296 
297 	return result;
298 }
299 
300 #ifdef CONFIG_PM_SLEEP
301 static int acpi_ac_resume(struct device *dev)
302 {
303 	struct acpi_ac *ac;
304 	unsigned int old_state;
305 
306 	if (!dev)
307 		return -EINVAL;
308 
309 	ac = acpi_driver_data(to_acpi_device(dev));
310 	if (!ac)
311 		return -EINVAL;
312 
313 	old_state = ac->state;
314 	if (acpi_ac_get_state(ac))
315 		return 0;
316 	if (old_state != ac->state)
317 		kobject_uevent(&ac->charger->dev.kobj, KOBJ_CHANGE);
318 	return 0;
319 }
320 #else
321 #define acpi_ac_resume NULL
322 #endif
323 
324 static int acpi_ac_remove(struct acpi_device *device)
325 {
326 	struct acpi_ac *ac = NULL;
327 
328 
329 	if (!device || !acpi_driver_data(device))
330 		return -EINVAL;
331 
332 	ac = acpi_driver_data(device);
333 
334 	power_supply_unregister(ac->charger);
335 	unregister_acpi_notifier(&ac->battery_nb);
336 
337 	kfree(ac);
338 
339 	return 0;
340 }
341 
342 static int __init acpi_ac_init(void)
343 {
344 	unsigned int i;
345 	int result;
346 
347 	if (acpi_disabled)
348 		return -ENODEV;
349 
350 	dmi_check_system(ac_dmi_table);
351 
352 	if (ac_check_pmic) {
353 		for (i = 0; i < ARRAY_SIZE(acpi_ac_blacklist); i++)
354 			if (acpi_dev_present(acpi_ac_blacklist[i].hid, "1",
355 					     acpi_ac_blacklist[i].hrv)) {
356 				pr_info("found native %s PMIC, not loading\n",
357 					acpi_ac_blacklist[i].hid);
358 				return -ENODEV;
359 			}
360 	}
361 
362 	result = acpi_bus_register_driver(&acpi_ac_driver);
363 	if (result < 0)
364 		return -ENODEV;
365 
366 	return 0;
367 }
368 
369 static void __exit acpi_ac_exit(void)
370 {
371 	acpi_bus_unregister_driver(&acpi_ac_driver);
372 }
373 module_init(acpi_ac_init);
374 module_exit(acpi_ac_exit);
375