blob: 10f0f40587bb73309eee9e959fc1049cbaf6dc05 [file] [log] [blame]
David Shaohua Li4e10d122005-03-18 18:45:35 -05001/*
2 * Link physical devices with ACPI devices support
3 *
4 * Copyright (c) 2005 David Shaohua Li <shaohua.li@intel.com>
5 * Copyright (c) 2005 Intel Corp.
6 *
7 * This file is released under the GPLv2.
8 */
Paul Gortmaker214f2c92011-10-26 16:22:14 -04009#include <linux/export.h>
David Shaohua Li4e10d122005-03-18 18:45:35 -050010#include <linux/init.h>
11#include <linux/list.h>
12#include <linux/device.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090013#include <linux/slab.h>
David Shaohua Li4e10d122005-03-18 18:45:35 -050014#include <linux/rwsem.h>
15#include <linux/acpi.h>
16
Len Browna192a952009-07-28 16:45:54 -040017#include "internal.h"
18
David Shaohua Li4e10d122005-03-18 18:45:35 -050019#define ACPI_GLUE_DEBUG 0
20#if ACPI_GLUE_DEBUG
Joe Perches23415eb2012-12-18 06:31:30 +000021#define DBG(fmt, ...) \
22 printk(KERN_DEBUG PREFIX fmt, ##__VA_ARGS__)
David Shaohua Li4e10d122005-03-18 18:45:35 -050023#else
Joe Perches23415eb2012-12-18 06:31:30 +000024#define DBG(fmt, ...) \
25do { \
26 if (0) \
27 printk(KERN_DEBUG PREFIX fmt, ##__VA_ARGS__); \
28} while (0)
David Shaohua Li4e10d122005-03-18 18:45:35 -050029#endif
30static LIST_HEAD(bus_type_list);
31static DECLARE_RWSEM(bus_type_sem);
32
Lan Tianyu1033f902012-08-17 14:44:09 +080033#define PHYSICAL_NODE_STRING "physical_node"
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +020034#define PHYSICAL_NODE_NAME_SIZE (sizeof(PHYSICAL_NODE_STRING) + 10)
Lan Tianyu1033f902012-08-17 14:44:09 +080035
David Shaohua Li4e10d122005-03-18 18:45:35 -050036int register_acpi_bus_type(struct acpi_bus_type *type)
37{
38 if (acpi_disabled)
39 return -ENODEV;
Rafael J. Wysocki53540092013-03-03 22:35:20 +010040 if (type && type->match && type->find_device) {
David Shaohua Li4e10d122005-03-18 18:45:35 -050041 down_write(&bus_type_sem);
42 list_add_tail(&type->list, &bus_type_list);
43 up_write(&bus_type_sem);
Rafael J. Wysocki53540092013-03-03 22:35:20 +010044 printk(KERN_INFO PREFIX "bus type %s registered\n", type->name);
David Shaohua Li4e10d122005-03-18 18:45:35 -050045 return 0;
46 }
47 return -ENODEV;
48}
Jeff Garzik91e4d5a2012-07-25 14:24:13 -040049EXPORT_SYMBOL_GPL(register_acpi_bus_type);
David Shaohua Li4e10d122005-03-18 18:45:35 -050050
David Shaohua Li4e10d122005-03-18 18:45:35 -050051int unregister_acpi_bus_type(struct acpi_bus_type *type)
52{
53 if (acpi_disabled)
54 return 0;
55 if (type) {
56 down_write(&bus_type_sem);
57 list_del_init(&type->list);
58 up_write(&bus_type_sem);
Rafael J. Wysocki53540092013-03-03 22:35:20 +010059 printk(KERN_INFO PREFIX "bus type %s unregistered\n",
60 type->name);
David Shaohua Li4e10d122005-03-18 18:45:35 -050061 return 0;
62 }
63 return -ENODEV;
64}
Jeff Garzik91e4d5a2012-07-25 14:24:13 -040065EXPORT_SYMBOL_GPL(unregister_acpi_bus_type);
David Shaohua Li4e10d122005-03-18 18:45:35 -050066
Rafael J. Wysocki53540092013-03-03 22:35:20 +010067static struct acpi_bus_type *acpi_get_bus_type(struct device *dev)
David Shaohua Li4e10d122005-03-18 18:45:35 -050068{
69 struct acpi_bus_type *tmp, *ret = NULL;
70
71 down_read(&bus_type_sem);
72 list_for_each_entry(tmp, &bus_type_list, list) {
Rafael J. Wysocki53540092013-03-03 22:35:20 +010073 if (tmp->match(dev)) {
David Shaohua Li4e10d122005-03-18 18:45:35 -050074 ret = tmp;
75 break;
76 }
77 }
78 up_read(&bus_type_sem);
79 return ret;
80}
81
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +020082#define FIND_CHILD_MIN_SCORE 1
83#define FIND_CHILD_MAX_SCORE 2
84
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +020085static acpi_status acpi_dev_present(acpi_handle handle, u32 lvl_not_used,
86 void *not_used, void **ret_p)
David Shaohua Li4e10d122005-03-18 18:45:35 -050087{
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +020088 struct acpi_device *adev = NULL;
David Shaohua Li4e10d122005-03-18 18:45:35 -050089
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +020090 acpi_bus_get_device(handle, &adev);
91 if (adev) {
Rafael J. Wysocki33f767d2013-01-10 13:13:49 +010092 *ret_p = handle;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +020093 return AE_CTRL_TERMINATE;
David Shaohua Li4e10d122005-03-18 18:45:35 -050094 }
95 return AE_OK;
96}
97
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +020098static int do_find_child_checks(acpi_handle handle, bool is_bridge)
David Shaohua Li4e10d122005-03-18 18:45:35 -050099{
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200100 bool sta_present = true;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200101 unsigned long long sta;
102 acpi_status status;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500103
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200104 status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
105 if (status == AE_NOT_FOUND)
106 sta_present = false;
107 else if (ACPI_FAILURE(status) || !(sta & ACPI_STA_DEVICE_ENABLED))
108 return -ENODEV;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500109
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200110 if (is_bridge) {
111 void *test = NULL;
112
113 /* Check if this object has at least one child device. */
114 acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
115 acpi_dev_present, NULL, NULL, &test);
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200116 if (!test)
117 return -ENODEV;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200118 }
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200119 return sta_present ? FIND_CHILD_MAX_SCORE : FIND_CHILD_MIN_SCORE;
Rafael J. Wysocki33f767d2013-01-10 13:13:49 +0100120}
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200121
122struct find_child_context {
123 u64 addr;
124 bool is_bridge;
125 acpi_handle ret;
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200126 int ret_score;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200127};
128
129static acpi_status do_find_child(acpi_handle handle, u32 lvl_not_used,
130 void *data, void **not_used)
131{
132 struct find_child_context *context = data;
133 unsigned long long addr;
134 acpi_status status;
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200135 int score;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200136
137 status = acpi_evaluate_integer(handle, METHOD_NAME__ADR, NULL, &addr);
138 if (ACPI_FAILURE(status) || addr != context->addr)
139 return AE_OK;
140
141 if (!context->ret) {
142 /* This is the first matching object. Save its handle. */
143 context->ret = handle;
144 return AE_OK;
145 }
146 /*
147 * There is more than one matching object with the same _ADR value.
148 * That really is unexpected, so we are kind of beyond the scope of the
149 * spec here. We have to choose which one to return, though.
150 *
151 * First, check if the previously found object is good enough and return
152 * its handle if so. Second, check the same for the object that we've
153 * just found.
154 */
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200155 if (!context->ret_score) {
156 score = do_find_child_checks(context->ret, context->is_bridge);
157 if (score == FIND_CHILD_MAX_SCORE)
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200158 return AE_CTRL_TERMINATE;
159 else
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200160 context->ret_score = score;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200161 }
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200162 score = do_find_child_checks(handle, context->is_bridge);
163 if (score == FIND_CHILD_MAX_SCORE) {
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200164 context->ret = handle;
165 return AE_CTRL_TERMINATE;
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200166 } else if (score > context->ret_score) {
167 context->ret = handle;
168 context->ret_score = score;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200169 }
170 return AE_OK;
171}
172
173acpi_handle acpi_find_child(acpi_handle parent, u64 addr, bool is_bridge)
174{
175 if (parent) {
176 struct find_child_context context = {
177 .addr = addr,
178 .is_bridge = is_bridge,
179 };
180
181 acpi_walk_namespace(ACPI_TYPE_DEVICE, parent, 1, do_find_child,
182 NULL, &context, NULL);
183 return context.ret;
184 }
185 return NULL;
186}
187EXPORT_SYMBOL_GPL(acpi_find_child);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500188
Rafael J. Wysockibdbdbf92013-08-07 01:19:23 +0200189static void acpi_physnode_link_name(char *buf, unsigned int node_id)
190{
191 if (node_id > 0)
192 snprintf(buf, PHYSICAL_NODE_NAME_SIZE,
193 PHYSICAL_NODE_STRING "%u", node_id);
194 else
195 strcpy(buf, PHYSICAL_NODE_STRING);
196}
197
Rafael J. Wysockiac212b62013-05-03 00:26:22 +0200198int acpi_bind_one(struct device *dev, acpi_handle handle)
David Shaohua Li4e10d122005-03-18 18:45:35 -0500199{
David Brownell10716952008-02-22 21:54:24 -0800200 struct acpi_device *acpi_dev;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500201 acpi_status status;
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100202 struct acpi_device_physical_node *physical_node, *pn;
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200203 char physical_node_name[PHYSICAL_NODE_NAME_SIZE];
204 struct list_head *physnode_list;
205 unsigned int node_id;
Lan Tianyu1033f902012-08-17 14:44:09 +0800206 int retval = -EINVAL;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500207
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100208 if (ACPI_HANDLE(dev)) {
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100209 if (handle) {
210 dev_warn(dev, "ACPI handle is already set\n");
211 return -EINVAL;
212 } else {
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100213 handle = ACPI_HANDLE(dev);
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100214 }
David Shaohua Li4e10d122005-03-18 18:45:35 -0500215 }
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100216 if (!handle)
217 return -EINVAL;
Lan Tianyu1033f902012-08-17 14:44:09 +0800218
David Shaohua Li4e10d122005-03-18 18:45:35 -0500219 get_device(dev);
Lan Tianyu1033f902012-08-17 14:44:09 +0800220 status = acpi_bus_get_device(handle, &acpi_dev);
221 if (ACPI_FAILURE(status))
222 goto err;
223
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100224 physical_node = kzalloc(sizeof(*physical_node), GFP_KERNEL);
Lan Tianyu1033f902012-08-17 14:44:09 +0800225 if (!physical_node) {
226 retval = -ENOMEM;
227 goto err;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500228 }
Lan Tianyu1033f902012-08-17 14:44:09 +0800229
230 mutex_lock(&acpi_dev->physical_node_lock);
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100231
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200232 /*
233 * Keep the list sorted by node_id so that the IDs of removed nodes can
234 * be recycled easily.
235 */
236 physnode_list = &acpi_dev->physical_node_list;
237 node_id = 0;
238 list_for_each_entry(pn, &acpi_dev->physical_node_list, node) {
239 /* Sanity check. */
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100240 if (pn->dev == dev) {
Rafael J. Wysocki3342c752013-08-08 16:19:10 +0200241 mutex_unlock(&acpi_dev->physical_node_lock);
Rafael J. Wysocki3fe444a2013-08-07 01:15:25 +0200242
Rafael J. Wysocki3342c752013-08-08 16:19:10 +0200243 dev_warn(dev, "Already associated with ACPI node\n");
244 kfree(physical_node);
245 if (ACPI_HANDLE(dev) != handle)
246 goto err;
247
248 put_device(dev);
249 return 0;
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100250 }
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200251 if (pn->node_id == node_id) {
252 physnode_list = &pn->node;
253 node_id++;
254 }
Lan Tianyu1033f902012-08-17 14:44:09 +0800255 }
256
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200257 physical_node->node_id = node_id;
Lan Tianyu1033f902012-08-17 14:44:09 +0800258 physical_node->dev = dev;
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200259 list_add(&physical_node->node, physnode_list);
Lan Tianyu1033f902012-08-17 14:44:09 +0800260 acpi_dev->physical_node_count++;
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100261
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100262 if (!ACPI_HANDLE(dev))
263 ACPI_HANDLE_SET(dev, acpi_dev->handle);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500264
Rafael J. Wysockibdbdbf92013-08-07 01:19:23 +0200265 acpi_physnode_link_name(physical_node_name, node_id);
Lan Tianyu1033f902012-08-17 14:44:09 +0800266 retval = sysfs_create_link(&acpi_dev->dev.kobj, &dev->kobj,
Rafael J. Wysockif501b6e2013-08-07 01:19:52 +0200267 physical_node_name);
Rafael J. Wysocki464c1142013-08-08 16:19:19 +0200268 if (retval)
269 dev_err(&acpi_dev->dev, "Failed to create link %s (%d)\n",
270 physical_node_name, retval);
271
Lan Tianyu1033f902012-08-17 14:44:09 +0800272 retval = sysfs_create_link(&dev->kobj, &acpi_dev->dev.kobj,
Rafael J. Wysockif501b6e2013-08-07 01:19:52 +0200273 "firmware_node");
Rafael J. Wysocki464c1142013-08-08 16:19:19 +0200274 if (retval)
275 dev_err(dev, "Failed to create link firmware_node (%d)\n",
276 retval);
David Brownell10716952008-02-22 21:54:24 -0800277
Rafael J. Wysocki40055202013-08-07 01:19:37 +0200278 mutex_unlock(&acpi_dev->physical_node_lock);
279
Lan Tianyu1033f902012-08-17 14:44:09 +0800280 if (acpi_dev->wakeup.flags.valid)
281 device_set_wakeup_capable(dev, true);
David Brownell10716952008-02-22 21:54:24 -0800282
David Shaohua Li4e10d122005-03-18 18:45:35 -0500283 return 0;
Lan Tianyu1033f902012-08-17 14:44:09 +0800284
285 err:
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100286 ACPI_HANDLE_SET(dev, NULL);
Lan Tianyu1033f902012-08-17 14:44:09 +0800287 put_device(dev);
288 return retval;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500289}
Rafael J. Wysockiac212b62013-05-03 00:26:22 +0200290EXPORT_SYMBOL_GPL(acpi_bind_one);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500291
Rafael J. Wysockiac212b62013-05-03 00:26:22 +0200292int acpi_unbind_one(struct device *dev)
David Shaohua Li4e10d122005-03-18 18:45:35 -0500293{
Lan Tianyu1033f902012-08-17 14:44:09 +0800294 struct acpi_device_physical_node *entry;
295 struct acpi_device *acpi_dev;
296 acpi_status status;
Lan Tianyu1033f902012-08-17 14:44:09 +0800297
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100298 if (!ACPI_HANDLE(dev))
David Shaohua Li4e10d122005-03-18 18:45:35 -0500299 return 0;
David Brownell10716952008-02-22 21:54:24 -0800300
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100301 status = acpi_bus_get_device(ACPI_HANDLE(dev), &acpi_dev);
Rafael J. Wysocki38e888392013-08-07 01:22:51 +0200302 if (ACPI_FAILURE(status)) {
303 dev_err(dev, "Oops, ACPI handle corrupt in %s()\n", __func__);
304 return -EINVAL;
305 }
David Brownell10716952008-02-22 21:54:24 -0800306
Lan Tianyu1033f902012-08-17 14:44:09 +0800307 mutex_lock(&acpi_dev->physical_node_lock);
David Brownell10716952008-02-22 21:54:24 -0800308
Rafael J. Wysocki3e332782013-08-07 01:22:08 +0200309 list_for_each_entry(entry, &acpi_dev->physical_node_list, node)
310 if (entry->dev == dev) {
311 char physnode_name[PHYSICAL_NODE_NAME_SIZE];
Lan Tianyu1033f902012-08-17 14:44:09 +0800312
Rafael J. Wysocki3e332782013-08-07 01:22:08 +0200313 list_del(&entry->node);
314 acpi_dev->physical_node_count--;
Lan Tianyu1033f902012-08-17 14:44:09 +0800315
Rafael J. Wysocki3e332782013-08-07 01:22:08 +0200316 acpi_physnode_link_name(physnode_name, entry->node_id);
317 sysfs_remove_link(&acpi_dev->dev.kobj, physnode_name);
318 sysfs_remove_link(&dev->kobj, "firmware_node");
319 ACPI_HANDLE_SET(dev, NULL);
320 /* acpi_bind_one() increase refcnt by one. */
321 put_device(dev);
322 kfree(entry);
323 break;
324 }
325
Lan Tianyu1033f902012-08-17 14:44:09 +0800326 mutex_unlock(&acpi_dev->physical_node_lock);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500327 return 0;
328}
Rafael J. Wysockiac212b62013-05-03 00:26:22 +0200329EXPORT_SYMBOL_GPL(acpi_unbind_one);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500330
331static int acpi_platform_notify(struct device *dev)
332{
Rafael J. Wysocki53540092013-03-03 22:35:20 +0100333 struct acpi_bus_type *type = acpi_get_bus_type(dev);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500334 acpi_handle handle;
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100335 int ret;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500336
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100337 ret = acpi_bind_one(dev, NULL);
Rafael J. Wysocki92414482013-03-03 22:35:44 +0100338 if (ret && type) {
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100339 ret = type->find_device(dev, &handle);
340 if (ret) {
341 DBG("Unable to get handle for %s\n", dev_name(dev));
342 goto out;
343 }
344 ret = acpi_bind_one(dev, handle);
345 if (ret)
346 goto out;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500347 }
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100348
349 if (type && type->setup)
350 type->setup(dev);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500351
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100352 out:
David Shaohua Li4e10d122005-03-18 18:45:35 -0500353#if ACPI_GLUE_DEBUG
354 if (!ret) {
355 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
356
Yinghai Lua412a112013-01-12 14:00:06 +0100357 acpi_get_name(ACPI_HANDLE(dev), ACPI_FULL_PATHNAME, &buffer);
Kay Sieversdb1461a2009-01-25 23:40:56 +0100358 DBG("Device %s -> %s\n", dev_name(dev), (char *)buffer.pointer);
Len Brown02438d82006-06-30 03:19:10 -0400359 kfree(buffer.pointer);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500360 } else
Kay Sieversdb1461a2009-01-25 23:40:56 +0100361 DBG("Device %s -> No ACPI support\n", dev_name(dev));
David Shaohua Li4e10d122005-03-18 18:45:35 -0500362#endif
363
364 return ret;
365}
366
367static int acpi_platform_notify_remove(struct device *dev)
368{
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100369 struct acpi_bus_type *type;
370
Rafael J. Wysocki53540092013-03-03 22:35:20 +0100371 type = acpi_get_bus_type(dev);
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100372 if (type && type->cleanup)
373 type->cleanup(dev);
374
David Shaohua Li4e10d122005-03-18 18:45:35 -0500375 acpi_unbind_one(dev);
376 return 0;
377}
378
Bjorn Helgaas0e46517d2009-03-24 16:50:09 -0600379int __init init_acpi_device_notify(void)
David Shaohua Li4e10d122005-03-18 18:45:35 -0500380{
David Shaohua Li4e10d122005-03-18 18:45:35 -0500381 if (platform_notify || platform_notify_remove) {
382 printk(KERN_ERR PREFIX "Can't use platform_notify\n");
383 return 0;
384 }
385 platform_notify = acpi_platform_notify;
386 platform_notify_remove = acpi_platform_notify_remove;
387 return 0;
388}