xref: /openbmc/linux/drivers/pnp/pnpacpi/core.c (revision afc98d90)
1 /*
2  * pnpacpi -- PnP ACPI driver
3  *
4  * Copyright (c) 2004 Matthieu Castet <castet.matthieu@free.fr>
5  * Copyright (c) 2004 Li Shaohua <shaohua.li@intel.com>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by the
9  * Free Software Foundation; either version 2, or (at your option) any
10  * later version.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21 
22 #include <linux/export.h>
23 #include <linux/acpi.h>
24 #include <linux/pnp.h>
25 #include <linux/slab.h>
26 #include <linux/mod_devicetable.h>
27 
28 #include "../base.h"
29 #include "pnpacpi.h"
30 
31 static int num;
32 
33 /* We need only to blacklist devices that have already an acpi driver that
34  * can't use pnp layer. We don't need to blacklist device that are directly
35  * used by the kernel (PCI root, ...), as it is harmless and there were
36  * already present in pnpbios. But there is an exception for devices that
37  * have irqs (PIC, Timer) because we call acpi_register_gsi.
38  * Finally, only devices that have a CRS method need to be in this list.
39  */
40 static struct acpi_device_id excluded_id_list[] __initdata = {
41 	{"PNP0C09", 0},		/* EC */
42 	{"PNP0C0F", 0},		/* Link device */
43 	{"PNP0000", 0},		/* PIC */
44 	{"PNP0100", 0},		/* Timer */
45 	{"", 0},
46 };
47 
48 static inline int __init is_exclusive_device(struct acpi_device *dev)
49 {
50 	return (!acpi_match_device_ids(dev, excluded_id_list));
51 }
52 
53 /*
54  * Compatible Device IDs
55  */
56 #define TEST_HEX(c) \
57 	if (!(('0' <= (c) && (c) <= '9') || ('A' <= (c) && (c) <= 'F'))) \
58 		return 0
59 #define TEST_ALPHA(c) \
60 	if (!('A' <= (c) && (c) <= 'Z')) \
61 		return 0
62 static int __init ispnpidacpi(const char *id)
63 {
64 	TEST_ALPHA(id[0]);
65 	TEST_ALPHA(id[1]);
66 	TEST_ALPHA(id[2]);
67 	TEST_HEX(id[3]);
68 	TEST_HEX(id[4]);
69 	TEST_HEX(id[5]);
70 	TEST_HEX(id[6]);
71 	if (id[7] != '\0')
72 		return 0;
73 	return 1;
74 }
75 
76 static int pnpacpi_get_resources(struct pnp_dev *dev)
77 {
78 	pnp_dbg(&dev->dev, "get resources\n");
79 	return pnpacpi_parse_allocated_resource(dev);
80 }
81 
82 static int pnpacpi_set_resources(struct pnp_dev *dev)
83 {
84 	struct acpi_device *acpi_dev;
85 	acpi_handle handle;
86 	struct acpi_buffer buffer;
87 	int ret;
88 
89 	pnp_dbg(&dev->dev, "set resources\n");
90 
91 	handle = ACPI_HANDLE(&dev->dev);
92 	if (!handle || acpi_bus_get_device(handle, &acpi_dev)) {
93 		dev_dbg(&dev->dev, "ACPI device not found in %s!\n", __func__);
94 		return -ENODEV;
95 	}
96 
97 	if (WARN_ON_ONCE(acpi_dev != dev->data))
98 		dev->data = acpi_dev;
99 
100 	ret = pnpacpi_build_resource_template(dev, &buffer);
101 	if (ret)
102 		return ret;
103 	ret = pnpacpi_encode_resources(dev, &buffer);
104 	if (ret) {
105 		kfree(buffer.pointer);
106 		return ret;
107 	}
108 	if (ACPI_FAILURE(acpi_set_current_resources(handle, &buffer)))
109 		ret = -EINVAL;
110 	else if (acpi_bus_power_manageable(handle))
111 		ret = acpi_bus_set_power(handle, ACPI_STATE_D0);
112 	kfree(buffer.pointer);
113 	return ret;
114 }
115 
116 static int pnpacpi_disable_resources(struct pnp_dev *dev)
117 {
118 	struct acpi_device *acpi_dev;
119 	acpi_handle handle;
120 	int ret;
121 
122 	dev_dbg(&dev->dev, "disable resources\n");
123 
124 	handle = ACPI_HANDLE(&dev->dev);
125 	if (!handle || acpi_bus_get_device(handle, &acpi_dev)) {
126 		dev_dbg(&dev->dev, "ACPI device not found in %s!\n", __func__);
127 		return 0;
128 	}
129 
130 	/* acpi_unregister_gsi(pnp_irq(dev, 0)); */
131 	ret = 0;
132 	if (acpi_bus_power_manageable(handle))
133 		acpi_bus_set_power(handle, ACPI_STATE_D3_COLD);
134 		/* continue even if acpi_bus_set_power() fails */
135 	if (ACPI_FAILURE(acpi_evaluate_object(handle, "_DIS", NULL, NULL)))
136 		ret = -ENODEV;
137 	return ret;
138 }
139 
140 #ifdef CONFIG_ACPI_SLEEP
141 static bool pnpacpi_can_wakeup(struct pnp_dev *dev)
142 {
143 	struct acpi_device *acpi_dev;
144 	acpi_handle handle;
145 
146 	handle = ACPI_HANDLE(&dev->dev);
147 	if (!handle || acpi_bus_get_device(handle, &acpi_dev)) {
148 		dev_dbg(&dev->dev, "ACPI device not found in %s!\n", __func__);
149 		return false;
150 	}
151 
152 	return acpi_bus_can_wakeup(handle);
153 }
154 
155 static int pnpacpi_suspend(struct pnp_dev *dev, pm_message_t state)
156 {
157 	struct acpi_device *acpi_dev;
158 	acpi_handle handle;
159 	int error = 0;
160 
161 	handle = ACPI_HANDLE(&dev->dev);
162 	if (!handle || acpi_bus_get_device(handle, &acpi_dev)) {
163 		dev_dbg(&dev->dev, "ACPI device not found in %s!\n", __func__);
164 		return 0;
165 	}
166 
167 	if (device_can_wakeup(&dev->dev)) {
168 		error = acpi_pm_device_sleep_wake(&dev->dev,
169 				device_may_wakeup(&dev->dev));
170 		if (error)
171 			return error;
172 	}
173 
174 	if (acpi_bus_power_manageable(handle)) {
175 		int power_state = acpi_pm_device_sleep_state(&dev->dev, NULL,
176 							ACPI_STATE_D3_COLD);
177 		if (power_state < 0)
178 			power_state = (state.event == PM_EVENT_ON) ?
179 					ACPI_STATE_D0 : ACPI_STATE_D3_COLD;
180 
181 		/*
182 		 * acpi_bus_set_power() often fails (keyboard port can't be
183 		 * powered-down?), and in any case, our return value is ignored
184 		 * by pnp_bus_suspend().  Hence we don't revert the wakeup
185 		 * setting if the set_power fails.
186 		 */
187 		error = acpi_bus_set_power(handle, power_state);
188 	}
189 
190 	return error;
191 }
192 
193 static int pnpacpi_resume(struct pnp_dev *dev)
194 {
195 	struct acpi_device *acpi_dev;
196 	acpi_handle handle = ACPI_HANDLE(&dev->dev);
197 	int error = 0;
198 
199 	if (!handle || acpi_bus_get_device(handle, &acpi_dev)) {
200 		dev_dbg(&dev->dev, "ACPI device not found in %s!\n", __func__);
201 		return -ENODEV;
202 	}
203 
204 	if (device_may_wakeup(&dev->dev))
205 		acpi_pm_device_sleep_wake(&dev->dev, false);
206 
207 	if (acpi_bus_power_manageable(handle))
208 		error = acpi_bus_set_power(handle, ACPI_STATE_D0);
209 
210 	return error;
211 }
212 #endif
213 
214 struct pnp_protocol pnpacpi_protocol = {
215 	.name	 = "Plug and Play ACPI",
216 	.get	 = pnpacpi_get_resources,
217 	.set	 = pnpacpi_set_resources,
218 	.disable = pnpacpi_disable_resources,
219 #ifdef CONFIG_ACPI_SLEEP
220 	.can_wakeup = pnpacpi_can_wakeup,
221 	.suspend = pnpacpi_suspend,
222 	.resume = pnpacpi_resume,
223 #endif
224 };
225 EXPORT_SYMBOL(pnpacpi_protocol);
226 
227 static char *__init pnpacpi_get_id(struct acpi_device *device)
228 {
229 	struct acpi_hardware_id *id;
230 
231 	list_for_each_entry(id, &device->pnp.ids, list) {
232 		if (ispnpidacpi(id->id))
233 			return id->id;
234 	}
235 
236 	return NULL;
237 }
238 
239 static int __init pnpacpi_add_device(struct acpi_device *device)
240 {
241 	struct pnp_dev *dev;
242 	char *pnpid;
243 	struct acpi_hardware_id *id;
244 	int error;
245 
246 	/* Skip devices that are already bound */
247 	if (device->physical_node_count)
248 		return 0;
249 
250 	/*
251 	 * If a PnPacpi device is not present , the device
252 	 * driver should not be loaded.
253 	 */
254 	if (!acpi_has_method(device->handle, "_CRS"))
255 		return 0;
256 
257 	pnpid = pnpacpi_get_id(device);
258 	if (!pnpid)
259 		return 0;
260 
261 	if (is_exclusive_device(device) || !device->status.present)
262 		return 0;
263 
264 	dev = pnp_alloc_dev(&pnpacpi_protocol, num, pnpid);
265 	if (!dev)
266 		return -ENOMEM;
267 
268 	dev->data = device;
269 	/* .enabled means the device can decode the resources */
270 	dev->active = device->status.enabled;
271 	if (acpi_has_method(device->handle, "_SRS"))
272 		dev->capabilities |= PNP_CONFIGURABLE;
273 	dev->capabilities |= PNP_READ;
274 	if (device->flags.dynamic_status && (dev->capabilities & PNP_CONFIGURABLE))
275 		dev->capabilities |= PNP_WRITE;
276 	if (device->flags.removable)
277 		dev->capabilities |= PNP_REMOVABLE;
278 	if (acpi_has_method(device->handle, "_DIS"))
279 		dev->capabilities |= PNP_DISABLE;
280 
281 	if (strlen(acpi_device_name(device)))
282 		strncpy(dev->name, acpi_device_name(device), sizeof(dev->name));
283 	else
284 		strncpy(dev->name, acpi_device_bid(device), sizeof(dev->name));
285 
286 	if (dev->active)
287 		pnpacpi_parse_allocated_resource(dev);
288 
289 	if (dev->capabilities & PNP_CONFIGURABLE)
290 		pnpacpi_parse_resource_option_data(dev);
291 
292 	list_for_each_entry(id, &device->pnp.ids, list) {
293 		if (!strcmp(id->id, pnpid))
294 			continue;
295 		if (!ispnpidacpi(id->id))
296 			continue;
297 		pnp_add_id(dev, id->id);
298 	}
299 
300 	/* clear out the damaged flags */
301 	if (!dev->active)
302 		pnp_init_resources(dev);
303 
304 	error = pnp_add_device(dev);
305 	if (error) {
306 		put_device(&dev->dev);
307 		return error;
308 	}
309 
310 	num++;
311 
312 	return 0;
313 }
314 
315 static acpi_status __init pnpacpi_add_device_handler(acpi_handle handle,
316 						     u32 lvl, void *context,
317 						     void **rv)
318 {
319 	struct acpi_device *device;
320 
321 	if (!acpi_bus_get_device(handle, &device))
322 		pnpacpi_add_device(device);
323 	else
324 		return AE_CTRL_DEPTH;
325 	return AE_OK;
326 }
327 
328 static int __init acpi_pnp_match(struct device *dev, void *_pnp)
329 {
330 	struct acpi_device *acpi = to_acpi_device(dev);
331 	struct pnp_dev *pnp = _pnp;
332 
333 	/* true means it matched */
334 	return !acpi->physical_node_count
335 	    && compare_pnp_id(pnp->id, acpi_device_hid(acpi));
336 }
337 
338 static struct acpi_device * __init acpi_pnp_find_companion(struct device *dev)
339 {
340 	dev = bus_find_device(&acpi_bus_type, NULL, to_pnp_dev(dev),
341 			      acpi_pnp_match);
342 	if (!dev)
343 		return NULL;
344 
345 	put_device(dev);
346 	return to_acpi_device(dev);
347 }
348 
349 /* complete initialization of a PNPACPI device includes having
350  * pnpdev->dev.archdata.acpi_handle point to its ACPI sibling.
351  */
352 static bool acpi_pnp_bus_match(struct device *dev)
353 {
354 	return dev->bus == &pnp_bus_type;
355 }
356 
357 static struct acpi_bus_type __initdata acpi_pnp_bus = {
358 	.name	     = "PNP",
359 	.match	     = acpi_pnp_bus_match,
360 	.find_companion = acpi_pnp_find_companion,
361 };
362 
363 int pnpacpi_disabled __initdata;
364 static int __init pnpacpi_init(void)
365 {
366 	if (acpi_disabled || pnpacpi_disabled) {
367 		printk(KERN_INFO "pnp: PnP ACPI: disabled\n");
368 		return 0;
369 	}
370 	printk(KERN_INFO "pnp: PnP ACPI init\n");
371 	pnp_register_protocol(&pnpacpi_protocol);
372 	register_acpi_bus_type(&acpi_pnp_bus);
373 	acpi_get_devices(NULL, pnpacpi_add_device_handler, NULL, NULL);
374 	printk(KERN_INFO "pnp: PnP ACPI: found %d devices\n", num);
375 	unregister_acpi_bus_type(&acpi_pnp_bus);
376 	pnp_platform_devices = 1;
377 	return 0;
378 }
379 
380 fs_initcall(pnpacpi_init);
381 
382 static int __init pnpacpi_setup(char *str)
383 {
384 	if (str == NULL)
385 		return 1;
386 	if (!strncmp(str, "off", 3))
387 		pnpacpi_disabled = 1;
388 	return 1;
389 }
390 
391 __setup("pnpacpi=", pnpacpi_setup);
392