]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/acpi/glue.c
ACPI / bind: Simplify child device lookups
[mirror_ubuntu-bionic-kernel.git] / drivers / acpi / glue.c
CommitLineData
4e10d12a
DSL
1/*
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 */
214f2c90 9#include <linux/export.h>
4e10d12a
DSL
10#include <linux/init.h>
11#include <linux/list.h>
12#include <linux/device.h>
5a0e3ad6 13#include <linux/slab.h>
4e10d12a
DSL
14#include <linux/rwsem.h>
15#include <linux/acpi.h>
16
a192a958
LB
17#include "internal.h"
18
4e10d12a
DSL
19#define ACPI_GLUE_DEBUG 0
20#if ACPI_GLUE_DEBUG
23415eb5
JP
21#define DBG(fmt, ...) \
22 printk(KERN_DEBUG PREFIX fmt, ##__VA_ARGS__)
4e10d12a 23#else
23415eb5
JP
24#define DBG(fmt, ...) \
25do { \
26 if (0) \
27 printk(KERN_DEBUG PREFIX fmt, ##__VA_ARGS__); \
28} while (0)
4e10d12a
DSL
29#endif
30static LIST_HEAD(bus_type_list);
31static DECLARE_RWSEM(bus_type_sem);
32
1033f904 33#define PHYSICAL_NODE_STRING "physical_node"
007ccfcf 34#define PHYSICAL_NODE_NAME_SIZE (sizeof(PHYSICAL_NODE_STRING) + 10)
1033f904 35
4e10d12a
DSL
36int register_acpi_bus_type(struct acpi_bus_type *type)
37{
38 if (acpi_disabled)
39 return -ENODEV;
53540098 40 if (type && type->match && type->find_device) {
4e10d12a
DSL
41 down_write(&bus_type_sem);
42 list_add_tail(&type->list, &bus_type_list);
43 up_write(&bus_type_sem);
53540098 44 printk(KERN_INFO PREFIX "bus type %s registered\n", type->name);
4e10d12a
DSL
45 return 0;
46 }
47 return -ENODEV;
48}
91e4d5a1 49EXPORT_SYMBOL_GPL(register_acpi_bus_type);
4e10d12a 50
4e10d12a
DSL
51int 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);
53540098
RW
59 printk(KERN_INFO PREFIX "bus type %s unregistered\n",
60 type->name);
4e10d12a
DSL
61 return 0;
62 }
63 return -ENODEV;
64}
91e4d5a1 65EXPORT_SYMBOL_GPL(unregister_acpi_bus_type);
4e10d12a 66
53540098 67static struct acpi_bus_type *acpi_get_bus_type(struct device *dev)
4e10d12a
DSL
68{
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) {
53540098 73 if (tmp->match(dev)) {
4e10d12a
DSL
74 ret = tmp;
75 break;
76 }
77 }
78 up_read(&bus_type_sem);
79 return ret;
80}
81
11b88ee2
RW
82#define FIND_CHILD_MIN_SCORE 1
83#define FIND_CHILD_MAX_SCORE 2
84
d9fef0c4 85static int find_child_checks(struct acpi_device *adev, bool check_children)
60f75b8e 86{
11b88ee2 87 bool sta_present = true;
60f75b8e
RW
88 unsigned long long sta;
89 acpi_status status;
90
d9fef0c4 91 status = acpi_evaluate_integer(adev->handle, "_STA", NULL, &sta);
11b88ee2
RW
92 if (status == AE_NOT_FOUND)
93 sta_present = false;
94 else if (ACPI_FAILURE(status) || !(sta & ACPI_STA_DEVICE_ENABLED))
95 return -ENODEV;
60f75b8e 96
d9fef0c4
RW
97 if (check_children && list_empty(&adev->children))
98 return -ENODEV;
60f75b8e 99
11b88ee2 100 return sta_present ? FIND_CHILD_MAX_SCORE : FIND_CHILD_MIN_SCORE;
60f75b8e
RW
101}
102
d9fef0c4
RW
103struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
104 u64 address, bool check_children)
60f75b8e 105{
d9fef0c4
RW
106 struct acpi_device *adev, *ret = NULL;
107 int ret_score = 0;
108
109 list_for_each_entry(adev, &parent->children, node) {
110 unsigned long long addr;
111 acpi_status status;
112 int score;
113
114 status = acpi_evaluate_integer(adev->handle, METHOD_NAME__ADR,
115 NULL, &addr);
116 if (ACPI_FAILURE(status) || addr != address)
117 continue;
118
119 if (!ret) {
120 /* This is the first matching object. Save it. */
121 ret = adev;
122 continue;
123 }
124 /*
125 * There is more than one matching device object with the same
126 * _ADR value. That really is unexpected, so we are kind of
127 * beyond the scope of the spec here. We have to choose which
128 * one to return, though.
129 *
130 * First, check if the previously found object is good enough
131 * and return it if so. Second, do the same for the object that
132 * we've just found.
133 */
134 if (!ret_score) {
135 ret_score = find_child_checks(ret, check_children);
136 if (ret_score == FIND_CHILD_MAX_SCORE)
137 return ret;
138 }
139 score = find_child_checks(adev, check_children);
140 if (score == FIND_CHILD_MAX_SCORE) {
141 return adev;
142 } else if (score > ret_score) {
143 ret = adev;
144 ret_score = score;
145 }
4e10d12a 146 }
d9fef0c4 147 return ret;
4e10d12a
DSL
148}
149
d9fef0c4 150acpi_handle acpi_find_child(acpi_handle handle, u64 addr, bool is_bridge)
4e10d12a 151{
d9fef0c4
RW
152 struct acpi_device *adev;
153
154 if (!handle || acpi_bus_get_device(handle, &adev))
155 return NULL;
156
157 adev = acpi_find_child_device(adev, addr, is_bridge);
158 return adev ? adev->handle : NULL;
33f767d7 159}
60f75b8e 160EXPORT_SYMBOL_GPL(acpi_find_child);
4e10d12a 161
bdbdbf91
RW
162static void acpi_physnode_link_name(char *buf, unsigned int node_id)
163{
164 if (node_id > 0)
165 snprintf(buf, PHYSICAL_NODE_NAME_SIZE,
166 PHYSICAL_NODE_STRING "%u", node_id);
167 else
168 strcpy(buf, PHYSICAL_NODE_STRING);
169}
170
ac212b69 171int acpi_bind_one(struct device *dev, acpi_handle handle)
4e10d12a 172{
7b199811 173 struct acpi_device *acpi_dev = NULL;
f3fd0c8a 174 struct acpi_device_physical_node *physical_node, *pn;
007ccfcf
RW
175 char physical_node_name[PHYSICAL_NODE_NAME_SIZE];
176 struct list_head *physnode_list;
177 unsigned int node_id;
1033f904 178 int retval = -EINVAL;
4e10d12a 179
7b199811 180 if (ACPI_COMPANION(dev)) {
f3fd0c8a 181 if (handle) {
7b199811 182 dev_warn(dev, "ACPI companion already set\n");
f3fd0c8a
RW
183 return -EINVAL;
184 } else {
7b199811 185 acpi_dev = ACPI_COMPANION(dev);
f3fd0c8a 186 }
7b199811
RW
187 } else {
188 acpi_bus_get_device(handle, &acpi_dev);
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
7b199811
RW
234 if (!ACPI_COMPANION(dev))
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
7b199811
RW
298void acpi_preset_companion(struct device *dev, acpi_handle parent, u64 addr)
299{
300 struct acpi_device *adev;
301
302 if (!acpi_bus_get_device(acpi_get_child(parent, addr), &adev))
303 ACPI_COMPANION_SET(dev, adev);
304}
305EXPORT_SYMBOL_GPL(acpi_preset_companion);
306
4e10d12a
DSL
307static int acpi_platform_notify(struct device *dev)
308{
53540098 309 struct acpi_bus_type *type = acpi_get_bus_type(dev);
4e10d12a 310 acpi_handle handle;
11909ca1 311 int ret;
4e10d12a 312
f3fd0c8a 313 ret = acpi_bind_one(dev, NULL);
92414481 314 if (ret && type) {
11909ca1
RW
315 ret = type->find_device(dev, &handle);
316 if (ret) {
317 DBG("Unable to get handle for %s\n", dev_name(dev));
318 goto out;
319 }
320 ret = acpi_bind_one(dev, handle);
321 if (ret)
322 goto out;
4e10d12a 323 }
11909ca1
RW
324
325 if (type && type->setup)
326 type->setup(dev);
4e10d12a 327
f3fd0c8a 328 out:
4e10d12a
DSL
329#if ACPI_GLUE_DEBUG
330 if (!ret) {
331 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
332
a412a11d 333 acpi_get_name(ACPI_HANDLE(dev), ACPI_FULL_PATHNAME, &buffer);
db1461ad 334 DBG("Device %s -> %s\n", dev_name(dev), (char *)buffer.pointer);
02438d87 335 kfree(buffer.pointer);
4e10d12a 336 } else
db1461ad 337 DBG("Device %s -> No ACPI support\n", dev_name(dev));
4e10d12a
DSL
338#endif
339
340 return ret;
341}
342
343static int acpi_platform_notify_remove(struct device *dev)
344{
11909ca1
RW
345 struct acpi_bus_type *type;
346
53540098 347 type = acpi_get_bus_type(dev);
11909ca1
RW
348 if (type && type->cleanup)
349 type->cleanup(dev);
350
4e10d12a
DSL
351 acpi_unbind_one(dev);
352 return 0;
353}
354
0e46517d 355int __init init_acpi_device_notify(void)
4e10d12a 356{
4e10d12a
DSL
357 if (platform_notify || platform_notify_remove) {
358 printk(KERN_ERR PREFIX "Can't use platform_notify\n");
359 return 0;
360 }
361 platform_notify = acpi_platform_notify;
362 platform_notify_remove = acpi_platform_notify_remove;
363 return 0;
364}