ACPI: scan: Utilize match_string() API
[linux-2.6-block.git] / drivers / acpi / glue.c
CommitLineData
55716d26 1// SPDX-License-Identifier: GPL-2.0-only
4e10d12a
DSL
2/*
3 * Link physical devices with ACPI devices support
4 *
5 * Copyright (c) 2005 David Shaohua Li <shaohua.li@intel.com>
6 * Copyright (c) 2005 Intel Corp.
4e10d12a 7 */
d4f54a18
HG
8
9#include <linux/acpi_iort.h>
214f2c90 10#include <linux/export.h>
4e10d12a
DSL
11#include <linux/init.h>
12#include <linux/list.h>
13#include <linux/device.h>
5a0e3ad6 14#include <linux/slab.h>
4e10d12a
DSL
15#include <linux/rwsem.h>
16#include <linux/acpi.h>
d0562674 17#include <linux/dma-mapping.h>
d4f54a18 18#include <linux/platform_device.h>
4e10d12a 19
a192a958
LB
20#include "internal.h"
21
4e10d12a
DSL
22#define ACPI_GLUE_DEBUG 0
23#if ACPI_GLUE_DEBUG
23415eb5
JP
24#define DBG(fmt, ...) \
25 printk(KERN_DEBUG PREFIX fmt, ##__VA_ARGS__)
4e10d12a 26#else
23415eb5
JP
27#define DBG(fmt, ...) \
28do { \
29 if (0) \
30 printk(KERN_DEBUG PREFIX fmt, ##__VA_ARGS__); \
31} while (0)
4e10d12a
DSL
32#endif
33static LIST_HEAD(bus_type_list);
34static DECLARE_RWSEM(bus_type_sem);
35
1033f904 36#define PHYSICAL_NODE_STRING "physical_node"
007ccfcf 37#define PHYSICAL_NODE_NAME_SIZE (sizeof(PHYSICAL_NODE_STRING) + 10)
1033f904 38
4e10d12a
DSL
39int register_acpi_bus_type(struct acpi_bus_type *type)
40{
41 if (acpi_disabled)
42 return -ENODEV;
e3f02c52 43 if (type && type->match && type->find_companion) {
4e10d12a
DSL
44 down_write(&bus_type_sem);
45 list_add_tail(&type->list, &bus_type_list);
46 up_write(&bus_type_sem);
53540098 47 printk(KERN_INFO PREFIX "bus type %s registered\n", type->name);
4e10d12a
DSL
48 return 0;
49 }
50 return -ENODEV;
51}
91e4d5a1 52EXPORT_SYMBOL_GPL(register_acpi_bus_type);
4e10d12a 53
4e10d12a
DSL
54int unregister_acpi_bus_type(struct acpi_bus_type *type)
55{
56 if (acpi_disabled)
57 return 0;
58 if (type) {
59 down_write(&bus_type_sem);
60 list_del_init(&type->list);
61 up_write(&bus_type_sem);
53540098
RW
62 printk(KERN_INFO PREFIX "bus type %s unregistered\n",
63 type->name);
4e10d12a
DSL
64 return 0;
65 }
66 return -ENODEV;
67}
91e4d5a1 68EXPORT_SYMBOL_GPL(unregister_acpi_bus_type);
4e10d12a 69
53540098 70static struct acpi_bus_type *acpi_get_bus_type(struct device *dev)
4e10d12a
DSL
71{
72 struct acpi_bus_type *tmp, *ret = NULL;
73
74 down_read(&bus_type_sem);
75 list_for_each_entry(tmp, &bus_type_list, list) {
53540098 76 if (tmp->match(dev)) {
4e10d12a
DSL
77 ret = tmp;
78 break;
79 }
80 }
81 up_read(&bus_type_sem);
82 return ret;
83}
84
11b88ee2
RW
85#define FIND_CHILD_MIN_SCORE 1
86#define FIND_CHILD_MAX_SCORE 2
87
d9fef0c4 88static int find_child_checks(struct acpi_device *adev, bool check_children)
60f75b8e 89{
11b88ee2 90 bool sta_present = true;
60f75b8e
RW
91 unsigned long long sta;
92 acpi_status status;
93
d9fef0c4 94 status = acpi_evaluate_integer(adev->handle, "_STA", NULL, &sta);
11b88ee2
RW
95 if (status == AE_NOT_FOUND)
96 sta_present = false;
97 else if (ACPI_FAILURE(status) || !(sta & ACPI_STA_DEVICE_ENABLED))
98 return -ENODEV;
60f75b8e 99
d9fef0c4
RW
100 if (check_children && list_empty(&adev->children))
101 return -ENODEV;
60f75b8e 102
c2a6bbaf 103 /*
fdad4e7a
RW
104 * If the device has a _HID returning a valid ACPI/PNP device ID, it is
105 * better to make it look less attractive here, so that the other device
106 * with the same _ADR value (that may not have a valid device ID) can be
107 * matched going forward. [This means a second spec violation in a row,
108 * so whatever we do here is best effort anyway.]
c2a6bbaf 109 */
fdad4e7a 110 return sta_present && !adev->pnp.type.platform_id ?
c2a6bbaf 111 FIND_CHILD_MAX_SCORE : FIND_CHILD_MIN_SCORE;
60f75b8e
RW
112}
113
d9fef0c4
RW
114struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
115 u64 address, bool check_children)
60f75b8e 116{
d9fef0c4
RW
117 struct acpi_device *adev, *ret = NULL;
118 int ret_score = 0;
119
5ce79d20
RW
120 if (!parent)
121 return NULL;
122
d9fef0c4
RW
123 list_for_each_entry(adev, &parent->children, node) {
124 unsigned long long addr;
125 acpi_status status;
126 int score;
127
128 status = acpi_evaluate_integer(adev->handle, METHOD_NAME__ADR,
129 NULL, &addr);
130 if (ACPI_FAILURE(status) || addr != address)
131 continue;
132
133 if (!ret) {
134 /* This is the first matching object. Save it. */
135 ret = adev;
136 continue;
137 }
138 /*
139 * There is more than one matching device object with the same
140 * _ADR value. That really is unexpected, so we are kind of
141 * beyond the scope of the spec here. We have to choose which
142 * one to return, though.
143 *
144 * First, check if the previously found object is good enough
145 * and return it if so. Second, do the same for the object that
146 * we've just found.
147 */
148 if (!ret_score) {
149 ret_score = find_child_checks(ret, check_children);
150 if (ret_score == FIND_CHILD_MAX_SCORE)
151 return ret;
152 }
153 score = find_child_checks(adev, check_children);
154 if (score == FIND_CHILD_MAX_SCORE) {
155 return adev;
156 } else if (score > ret_score) {
157 ret = adev;
158 ret_score = score;
159 }
4e10d12a 160 }
d9fef0c4 161 return ret;
4e10d12a 162}
9c5ad36d 163EXPORT_SYMBOL_GPL(acpi_find_child_device);
4e10d12a 164
bdbdbf91
RW
165static void acpi_physnode_link_name(char *buf, unsigned int node_id)
166{
167 if (node_id > 0)
168 snprintf(buf, PHYSICAL_NODE_NAME_SIZE,
169 PHYSICAL_NODE_STRING "%u", node_id);
170 else
171 strcpy(buf, PHYSICAL_NODE_STRING);
172}
173
24dee1fc 174int acpi_bind_one(struct device *dev, struct acpi_device *acpi_dev)
4e10d12a 175{
f3fd0c8a 176 struct acpi_device_physical_node *physical_node, *pn;
007ccfcf
RW
177 char physical_node_name[PHYSICAL_NODE_NAME_SIZE];
178 struct list_head *physnode_list;
179 unsigned int node_id;
1033f904 180 int retval = -EINVAL;
4e10d12a 181
ca5b74d2 182 if (has_acpi_companion(dev)) {
24dee1fc 183 if (acpi_dev) {
7b199811 184 dev_warn(dev, "ACPI companion already set\n");
f3fd0c8a
RW
185 return -EINVAL;
186 } else {
7b199811 187 acpi_dev = ACPI_COMPANION(dev);
f3fd0c8a 188 }
4e10d12a 189 }
7b199811 190 if (!acpi_dev)
f3fd0c8a 191 return -EINVAL;
1033f904 192
a104b4d4 193 get_device(&acpi_dev->dev);
4e10d12a 194 get_device(dev);
f3fd0c8a 195 physical_node = kzalloc(sizeof(*physical_node), GFP_KERNEL);
1033f904
LT
196 if (!physical_node) {
197 retval = -ENOMEM;
198 goto err;
4e10d12a 199 }
4e10d12a 200
1033f904 201 mutex_lock(&acpi_dev->physical_node_lock);
f3fd0c8a 202
007ccfcf
RW
203 /*
204 * Keep the list sorted by node_id so that the IDs of removed nodes can
205 * be recycled easily.
206 */
207 physnode_list = &acpi_dev->physical_node_list;
208 node_id = 0;
209 list_for_each_entry(pn, &acpi_dev->physical_node_list, node) {
210 /* Sanity check. */
f3fd0c8a 211 if (pn->dev == dev) {
3342c753
RW
212 mutex_unlock(&acpi_dev->physical_node_lock);
213
f3fd0c8a 214 dev_warn(dev, "Already associated with ACPI node\n");
3342c753 215 kfree(physical_node);
7b199811 216 if (ACPI_COMPANION(dev) != acpi_dev)
3342c753 217 goto err;
3fe444ad 218
3342c753 219 put_device(dev);
a104b4d4 220 put_device(&acpi_dev->dev);
3342c753 221 return 0;
f3fd0c8a 222 }
007ccfcf
RW
223 if (pn->node_id == node_id) {
224 physnode_list = &pn->node;
225 node_id++;
226 }
1071695f
DB
227 }
228
007ccfcf 229 physical_node->node_id = node_id;
1033f904 230 physical_node->dev = dev;
007ccfcf 231 list_add(&physical_node->node, physnode_list);
1033f904 232 acpi_dev->physical_node_count++;
f3fd0c8a 233
ca5b74d2 234 if (!has_acpi_companion(dev))
7b199811 235 ACPI_COMPANION_SET(dev, acpi_dev);
1033f904 236
bdbdbf91 237 acpi_physnode_link_name(physical_node_name, node_id);
1033f904 238 retval = sysfs_create_link(&acpi_dev->dev.kobj, &dev->kobj,
f501b6ec 239 physical_node_name);
464c1147
RW
240 if (retval)
241 dev_err(&acpi_dev->dev, "Failed to create link %s (%d)\n",
242 physical_node_name, retval);
243
1033f904 244 retval = sysfs_create_link(&dev->kobj, &acpi_dev->dev.kobj,
f501b6ec 245 "firmware_node");
464c1147
RW
246 if (retval)
247 dev_err(dev, "Failed to create link firmware_node (%d)\n",
248 retval);
1033f904 249
40055206
RW
250 mutex_unlock(&acpi_dev->physical_node_lock);
251
1033f904
LT
252 if (acpi_dev->wakeup.flags.valid)
253 device_set_wakeup_capable(dev, true);
254
4e10d12a 255 return 0;
1033f904
LT
256
257 err:
7b199811 258 ACPI_COMPANION_SET(dev, NULL);
1033f904 259 put_device(dev);
a104b4d4 260 put_device(&acpi_dev->dev);
1033f904 261 return retval;
4e10d12a 262}
ac212b69 263EXPORT_SYMBOL_GPL(acpi_bind_one);
4e10d12a 264
ac212b69 265int acpi_unbind_one(struct device *dev)
4e10d12a 266{
7b199811 267 struct acpi_device *acpi_dev = ACPI_COMPANION(dev);
1033f904 268 struct acpi_device_physical_node *entry;
1033f904 269
7b199811 270 if (!acpi_dev)
4e10d12a 271 return 0;
1071695f 272
1033f904 273 mutex_lock(&acpi_dev->physical_node_lock);
3e332783
RW
274
275 list_for_each_entry(entry, &acpi_dev->physical_node_list, node)
276 if (entry->dev == dev) {
277 char physnode_name[PHYSICAL_NODE_NAME_SIZE];
278
279 list_del(&entry->node);
280 acpi_dev->physical_node_count--;
281
282 acpi_physnode_link_name(physnode_name, entry->node_id);
283 sysfs_remove_link(&acpi_dev->dev.kobj, physnode_name);
284 sysfs_remove_link(&dev->kobj, "firmware_node");
7b199811 285 ACPI_COMPANION_SET(dev, NULL);
a104b4d4 286 /* Drop references taken by acpi_bind_one(). */
3e332783 287 put_device(dev);
a104b4d4 288 put_device(&acpi_dev->dev);
3e332783
RW
289 kfree(entry);
290 break;
291 }
292
1033f904 293 mutex_unlock(&acpi_dev->physical_node_lock);
4e10d12a
DSL
294 return 0;
295}
ac212b69 296EXPORT_SYMBOL_GPL(acpi_unbind_one);
4e10d12a 297
7847a145 298static int acpi_device_notify(struct device *dev)
4e10d12a 299{
53540098 300 struct acpi_bus_type *type = acpi_get_bus_type(dev);
9cb32acf 301 struct acpi_device *adev;
11909ca1 302 int ret;
4e10d12a 303
f3fd0c8a 304 ret = acpi_bind_one(dev, NULL);
92414481 305 if (ret && type) {
e3f02c52
RW
306 struct acpi_device *adev;
307
308 adev = type->find_companion(dev);
309 if (!adev) {
11909ca1 310 DBG("Unable to get handle for %s\n", dev_name(dev));
e3f02c52 311 ret = -ENODEV;
11909ca1
RW
312 goto out;
313 }
24dee1fc 314 ret = acpi_bind_one(dev, adev);
11909ca1
RW
315 if (ret)
316 goto out;
4e10d12a 317 }
9cb32acf
RW
318 adev = ACPI_COMPANION(dev);
319 if (!adev)
320 goto out;
11909ca1 321
719cf71c 322 if (dev_is_platform(dev))
d4f54a18
HG
323 acpi_configure_pmsi_domain(dev);
324
11909ca1
RW
325 if (type && type->setup)
326 type->setup(dev);
9cb32acf
RW
327 else if (adev->handler && adev->handler->bind)
328 adev->handler->bind(dev);
4e10d12a 329
f3fd0c8a 330 out:
4e10d12a
DSL
331#if ACPI_GLUE_DEBUG
332 if (!ret) {
333 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
334
a412a11d 335 acpi_get_name(ACPI_HANDLE(dev), ACPI_FULL_PATHNAME, &buffer);
db1461ad 336 DBG("Device %s -> %s\n", dev_name(dev), (char *)buffer.pointer);
02438d87 337 kfree(buffer.pointer);
4e10d12a 338 } else
db1461ad 339 DBG("Device %s -> No ACPI support\n", dev_name(dev));
4e10d12a
DSL
340#endif
341
342 return ret;
343}
344
7847a145 345static int acpi_device_notify_remove(struct device *dev)
4e10d12a 346{
9cb32acf 347 struct acpi_device *adev = ACPI_COMPANION(dev);
11909ca1
RW
348 struct acpi_bus_type *type;
349
9cb32acf
RW
350 if (!adev)
351 return 0;
352
53540098 353 type = acpi_get_bus_type(dev);
11909ca1
RW
354 if (type && type->cleanup)
355 type->cleanup(dev);
9cb32acf
RW
356 else if (adev->handler && adev->handler->unbind)
357 adev->handler->unbind(dev);
11909ca1 358
4e10d12a
DSL
359 acpi_unbind_one(dev);
360 return 0;
361}
362
7847a145 363int acpi_platform_notify(struct device *dev, enum kobject_action action)
4e10d12a 364{
7847a145
HK
365 switch (action) {
366 case KOBJ_ADD:
367 acpi_device_notify(dev);
368 break;
369 case KOBJ_REMOVE:
370 acpi_device_notify_remove(dev);
371 break;
372 default:
373 break;
4e10d12a 374 }
7847a145 375 return 0;
4e10d12a 376}