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