Loading...
1// SPDX-License-Identifier: GPL-2.0-only
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.
7 */
8
9#define pr_fmt(fmt) "ACPI: " fmt
10
11#include <linux/acpi_iort.h>
12#include <linux/export.h>
13#include <linux/init.h>
14#include <linux/list.h>
15#include <linux/device.h>
16#include <linux/slab.h>
17#include <linux/rwsem.h>
18#include <linux/acpi.h>
19#include <linux/dma-mapping.h>
20#include <linux/pci.h>
21#include <linux/pci-acpi.h>
22#include <linux/platform_device.h>
23
24#include "internal.h"
25
26static LIST_HEAD(bus_type_list);
27static DECLARE_RWSEM(bus_type_sem);
28
29#define PHYSICAL_NODE_STRING "physical_node"
30#define PHYSICAL_NODE_NAME_SIZE (sizeof(PHYSICAL_NODE_STRING) + 10)
31
32int register_acpi_bus_type(struct acpi_bus_type *type)
33{
34 if (acpi_disabled)
35 return -ENODEV;
36 if (type && type->match && type->find_companion) {
37 down_write(&bus_type_sem);
38 list_add_tail(&type->list, &bus_type_list);
39 up_write(&bus_type_sem);
40 pr_info("bus type %s registered\n", type->name);
41 return 0;
42 }
43 return -ENODEV;
44}
45EXPORT_SYMBOL_GPL(register_acpi_bus_type);
46
47int unregister_acpi_bus_type(struct acpi_bus_type *type)
48{
49 if (acpi_disabled)
50 return 0;
51 if (type) {
52 down_write(&bus_type_sem);
53 list_del_init(&type->list);
54 up_write(&bus_type_sem);
55 pr_info("bus type %s unregistered\n", type->name);
56 return 0;
57 }
58 return -ENODEV;
59}
60EXPORT_SYMBOL_GPL(unregister_acpi_bus_type);
61
62static struct acpi_bus_type *acpi_get_bus_type(struct device *dev)
63{
64 struct acpi_bus_type *tmp, *ret = NULL;
65
66 down_read(&bus_type_sem);
67 list_for_each_entry(tmp, &bus_type_list, list) {
68 if (tmp->match(dev)) {
69 ret = tmp;
70 break;
71 }
72 }
73 up_read(&bus_type_sem);
74 return ret;
75}
76
77#define FIND_CHILD_MIN_SCORE 1
78#define FIND_CHILD_MID_SCORE 2
79#define FIND_CHILD_MAX_SCORE 3
80
81static int match_any(struct acpi_device *adev, void *not_used)
82{
83 return 1;
84}
85
86static bool acpi_dev_has_children(struct acpi_device *adev)
87{
88 return acpi_dev_for_each_child(adev, match_any, NULL) > 0;
89}
90
91static int find_child_checks(struct acpi_device *adev, bool check_children)
92{
93 unsigned long long sta;
94 acpi_status status;
95
96 if (check_children && !acpi_dev_has_children(adev))
97 return -ENODEV;
98
99 status = acpi_evaluate_integer(adev->handle, "_STA", NULL, &sta);
100 if (status == AE_NOT_FOUND) {
101 /*
102 * Special case: backlight device objects without _STA are
103 * preferred to other objects with the same _ADR value, because
104 * it is more likely that they are actually useful.
105 */
106 if (adev->pnp.type.backlight)
107 return FIND_CHILD_MID_SCORE;
108
109 return FIND_CHILD_MIN_SCORE;
110 }
111
112 if (ACPI_FAILURE(status) || !(sta & ACPI_STA_DEVICE_ENABLED))
113 return -ENODEV;
114
115 /*
116 * If the device has a _HID returning a valid ACPI/PNP device ID, it is
117 * better to make it look less attractive here, so that the other device
118 * with the same _ADR value (that may not have a valid device ID) can be
119 * matched going forward. [This means a second spec violation in a row,
120 * so whatever we do here is best effort anyway.]
121 */
122 if (adev->pnp.type.platform_id)
123 return FIND_CHILD_MIN_SCORE;
124
125 return FIND_CHILD_MAX_SCORE;
126}
127
128struct find_child_walk_data {
129 struct acpi_device *adev;
130 u64 address;
131 int score;
132 bool check_sta;
133 bool check_children;
134};
135
136static int check_one_child(struct acpi_device *adev, void *data)
137{
138 struct find_child_walk_data *wd = data;
139 int score;
140
141 if (!adev->pnp.type.bus_address || acpi_device_adr(adev) != wd->address)
142 return 0;
143
144 if (!wd->adev) {
145 /*
146 * This is the first matching object, so save it. If it is not
147 * necessary to look for any other matching objects, stop the
148 * search.
149 */
150 wd->adev = adev;
151 return !(wd->check_sta || wd->check_children);
152 }
153
154 /*
155 * There is more than one matching device object with the same _ADR
156 * value. That really is unexpected, so we are kind of beyond the scope
157 * of the spec here. We have to choose which one to return, though.
158 *
159 * First, get the score for the previously found object and terminate
160 * the walk if it is maximum.
161 */
162 if (!wd->score) {
163 score = find_child_checks(wd->adev, wd->check_children);
164 if (score == FIND_CHILD_MAX_SCORE)
165 return 1;
166
167 wd->score = score;
168 }
169 /*
170 * Second, if the object that has just been found has a better score,
171 * replace the previously found one with it and terminate the walk if
172 * the new score is maximum.
173 */
174 score = find_child_checks(adev, wd->check_children);
175 if (score > wd->score) {
176 wd->adev = adev;
177 if (score == FIND_CHILD_MAX_SCORE)
178 return 1;
179
180 wd->score = score;
181 }
182
183 /* Continue, because there may be better matches. */
184 return 0;
185}
186
187static struct acpi_device *acpi_find_child(struct acpi_device *parent,
188 u64 address, bool check_children,
189 bool check_sta)
190{
191 struct find_child_walk_data wd = {
192 .address = address,
193 .check_children = check_children,
194 .check_sta = check_sta,
195 .adev = NULL,
196 .score = 0,
197 };
198
199 if (parent)
200 acpi_dev_for_each_child(parent, check_one_child, &wd);
201
202 return wd.adev;
203}
204
205struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
206 u64 address, bool check_children)
207{
208 return acpi_find_child(parent, address, check_children, true);
209}
210EXPORT_SYMBOL_GPL(acpi_find_child_device);
211
212struct acpi_device *acpi_find_child_by_adr(struct acpi_device *adev,
213 acpi_bus_address adr)
214{
215 return acpi_find_child(adev, adr, false, false);
216}
217EXPORT_SYMBOL_GPL(acpi_find_child_by_adr);
218
219static void acpi_physnode_link_name(char *buf, unsigned int node_id)
220{
221 if (node_id > 0)
222 snprintf(buf, PHYSICAL_NODE_NAME_SIZE,
223 PHYSICAL_NODE_STRING "%u", node_id);
224 else
225 strcpy(buf, PHYSICAL_NODE_STRING);
226}
227
228int acpi_bind_one(struct device *dev, struct acpi_device *acpi_dev)
229{
230 struct acpi_device_physical_node *physical_node, *pn;
231 char physical_node_name[PHYSICAL_NODE_NAME_SIZE];
232 struct list_head *physnode_list;
233 unsigned int node_id;
234 int retval = -EINVAL;
235
236 if (has_acpi_companion(dev)) {
237 if (acpi_dev) {
238 dev_warn(dev, "ACPI companion already set\n");
239 return -EINVAL;
240 } else {
241 acpi_dev = ACPI_COMPANION(dev);
242 }
243 }
244 if (!acpi_dev)
245 return -EINVAL;
246
247 acpi_dev_get(acpi_dev);
248 get_device(dev);
249 physical_node = kzalloc(sizeof(*physical_node), GFP_KERNEL);
250 if (!physical_node) {
251 retval = -ENOMEM;
252 goto err;
253 }
254
255 mutex_lock(&acpi_dev->physical_node_lock);
256
257 /*
258 * Keep the list sorted by node_id so that the IDs of removed nodes can
259 * be recycled easily.
260 */
261 physnode_list = &acpi_dev->physical_node_list;
262 node_id = 0;
263 list_for_each_entry(pn, &acpi_dev->physical_node_list, node) {
264 /* Sanity check. */
265 if (pn->dev == dev) {
266 mutex_unlock(&acpi_dev->physical_node_lock);
267
268 dev_warn(dev, "Already associated with ACPI node\n");
269 kfree(physical_node);
270 if (ACPI_COMPANION(dev) != acpi_dev)
271 goto err;
272
273 put_device(dev);
274 acpi_dev_put(acpi_dev);
275 return 0;
276 }
277 if (pn->node_id == node_id) {
278 physnode_list = &pn->node;
279 node_id++;
280 }
281 }
282
283 physical_node->node_id = node_id;
284 physical_node->dev = dev;
285 list_add(&physical_node->node, physnode_list);
286 acpi_dev->physical_node_count++;
287
288 if (!has_acpi_companion(dev))
289 ACPI_COMPANION_SET(dev, acpi_dev);
290
291 acpi_physnode_link_name(physical_node_name, node_id);
292 retval = sysfs_create_link(&acpi_dev->dev.kobj, &dev->kobj,
293 physical_node_name);
294 if (retval)
295 dev_err(&acpi_dev->dev, "Failed to create link %s (%d)\n",
296 physical_node_name, retval);
297
298 retval = sysfs_create_link(&dev->kobj, &acpi_dev->dev.kobj,
299 "firmware_node");
300 if (retval)
301 dev_err(dev, "Failed to create link firmware_node (%d)\n",
302 retval);
303
304 mutex_unlock(&acpi_dev->physical_node_lock);
305
306 if (acpi_dev->wakeup.flags.valid)
307 device_set_wakeup_capable(dev, true);
308
309 return 0;
310
311 err:
312 ACPI_COMPANION_SET(dev, NULL);
313 put_device(dev);
314 acpi_dev_put(acpi_dev);
315 return retval;
316}
317EXPORT_SYMBOL_GPL(acpi_bind_one);
318
319int acpi_unbind_one(struct device *dev)
320{
321 struct acpi_device *acpi_dev = ACPI_COMPANION(dev);
322 struct acpi_device_physical_node *entry;
323
324 if (!acpi_dev)
325 return 0;
326
327 mutex_lock(&acpi_dev->physical_node_lock);
328
329 list_for_each_entry(entry, &acpi_dev->physical_node_list, node)
330 if (entry->dev == dev) {
331 char physnode_name[PHYSICAL_NODE_NAME_SIZE];
332
333 list_del(&entry->node);
334 acpi_dev->physical_node_count--;
335
336 acpi_physnode_link_name(physnode_name, entry->node_id);
337 sysfs_remove_link(&acpi_dev->dev.kobj, physnode_name);
338 sysfs_remove_link(&dev->kobj, "firmware_node");
339 ACPI_COMPANION_SET(dev, NULL);
340 /* Drop references taken by acpi_bind_one(). */
341 put_device(dev);
342 acpi_dev_put(acpi_dev);
343 kfree(entry);
344 break;
345 }
346
347 mutex_unlock(&acpi_dev->physical_node_lock);
348 return 0;
349}
350EXPORT_SYMBOL_GPL(acpi_unbind_one);
351
352void acpi_device_notify(struct device *dev)
353{
354 struct acpi_device *adev;
355 int ret;
356
357 ret = acpi_bind_one(dev, NULL);
358 if (ret) {
359 struct acpi_bus_type *type = acpi_get_bus_type(dev);
360
361 if (!type)
362 goto err;
363
364 adev = type->find_companion(dev);
365 if (!adev) {
366 dev_dbg(dev, "ACPI companion not found\n");
367 goto err;
368 }
369 ret = acpi_bind_one(dev, adev);
370 if (ret)
371 goto err;
372
373 if (type->setup) {
374 type->setup(dev);
375 goto done;
376 }
377 } else {
378 adev = ACPI_COMPANION(dev);
379
380 if (dev_is_pci(dev)) {
381 pci_acpi_setup(dev, adev);
382 goto done;
383 } else if (dev_is_platform(dev)) {
384 acpi_configure_pmsi_domain(dev);
385 }
386 }
387
388 if (adev->handler && adev->handler->bind)
389 adev->handler->bind(dev);
390
391done:
392 acpi_handle_debug(ACPI_HANDLE(dev), "Bound to device %s\n",
393 dev_name(dev));
394
395 return;
396
397err:
398 dev_dbg(dev, "No ACPI support\n");
399}
400
401void acpi_device_notify_remove(struct device *dev)
402{
403 struct acpi_device *adev = ACPI_COMPANION(dev);
404
405 if (!adev)
406 return;
407
408 if (dev_is_pci(dev))
409 pci_acpi_cleanup(dev, adev);
410 else if (adev->handler && adev->handler->unbind)
411 adev->handler->unbind(dev);
412
413 acpi_unbind_one(dev);
414}
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 */
9#include <linux/export.h>
10#include <linux/init.h>
11#include <linux/list.h>
12#include <linux/device.h>
13#include <linux/slab.h>
14#include <linux/rwsem.h>
15#include <linux/acpi.h>
16
17#include "internal.h"
18
19#define ACPI_GLUE_DEBUG 0
20#if ACPI_GLUE_DEBUG
21#define DBG(fmt, ...) \
22 printk(KERN_DEBUG PREFIX fmt, ##__VA_ARGS__)
23#else
24#define DBG(fmt, ...) \
25do { \
26 if (0) \
27 printk(KERN_DEBUG PREFIX fmt, ##__VA_ARGS__); \
28} while (0)
29#endif
30static LIST_HEAD(bus_type_list);
31static DECLARE_RWSEM(bus_type_sem);
32
33#define PHYSICAL_NODE_STRING "physical_node"
34#define PHYSICAL_NODE_NAME_SIZE (sizeof(PHYSICAL_NODE_STRING) + 10)
35
36int register_acpi_bus_type(struct acpi_bus_type *type)
37{
38 if (acpi_disabled)
39 return -ENODEV;
40 if (type && type->match && type->find_companion) {
41 down_write(&bus_type_sem);
42 list_add_tail(&type->list, &bus_type_list);
43 up_write(&bus_type_sem);
44 printk(KERN_INFO PREFIX "bus type %s registered\n", type->name);
45 return 0;
46 }
47 return -ENODEV;
48}
49EXPORT_SYMBOL_GPL(register_acpi_bus_type);
50
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);
59 printk(KERN_INFO PREFIX "bus type %s unregistered\n",
60 type->name);
61 return 0;
62 }
63 return -ENODEV;
64}
65EXPORT_SYMBOL_GPL(unregister_acpi_bus_type);
66
67static struct acpi_bus_type *acpi_get_bus_type(struct device *dev)
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) {
73 if (tmp->match(dev)) {
74 ret = tmp;
75 break;
76 }
77 }
78 up_read(&bus_type_sem);
79 return ret;
80}
81
82#define FIND_CHILD_MIN_SCORE 1
83#define FIND_CHILD_MAX_SCORE 2
84
85static int find_child_checks(struct acpi_device *adev, bool check_children)
86{
87 bool sta_present = true;
88 unsigned long long sta;
89 acpi_status status;
90
91 status = acpi_evaluate_integer(adev->handle, "_STA", NULL, &sta);
92 if (status == AE_NOT_FOUND)
93 sta_present = false;
94 else if (ACPI_FAILURE(status) || !(sta & ACPI_STA_DEVICE_ENABLED))
95 return -ENODEV;
96
97 if (check_children && list_empty(&adev->children))
98 return -ENODEV;
99
100 return sta_present ? FIND_CHILD_MAX_SCORE : FIND_CHILD_MIN_SCORE;
101}
102
103struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
104 u64 address, bool check_children)
105{
106 struct acpi_device *adev, *ret = NULL;
107 int ret_score = 0;
108
109 if (!parent)
110 return NULL;
111
112 list_for_each_entry(adev, &parent->children, node) {
113 unsigned long long addr;
114 acpi_status status;
115 int score;
116
117 status = acpi_evaluate_integer(adev->handle, METHOD_NAME__ADR,
118 NULL, &addr);
119 if (ACPI_FAILURE(status) || addr != address)
120 continue;
121
122 if (!ret) {
123 /* This is the first matching object. Save it. */
124 ret = adev;
125 continue;
126 }
127 /*
128 * There is more than one matching device object with the same
129 * _ADR value. That really is unexpected, so we are kind of
130 * beyond the scope of the spec here. We have to choose which
131 * one to return, though.
132 *
133 * First, check if the previously found object is good enough
134 * and return it if so. Second, do the same for the object that
135 * we've just found.
136 */
137 if (!ret_score) {
138 ret_score = find_child_checks(ret, check_children);
139 if (ret_score == FIND_CHILD_MAX_SCORE)
140 return ret;
141 }
142 score = find_child_checks(adev, check_children);
143 if (score == FIND_CHILD_MAX_SCORE) {
144 return adev;
145 } else if (score > ret_score) {
146 ret = adev;
147 ret_score = score;
148 }
149 }
150 return ret;
151}
152EXPORT_SYMBOL_GPL(acpi_find_child_device);
153
154static void acpi_physnode_link_name(char *buf, unsigned int node_id)
155{
156 if (node_id > 0)
157 snprintf(buf, PHYSICAL_NODE_NAME_SIZE,
158 PHYSICAL_NODE_STRING "%u", node_id);
159 else
160 strcpy(buf, PHYSICAL_NODE_STRING);
161}
162
163int acpi_bind_one(struct device *dev, struct acpi_device *acpi_dev)
164{
165 struct acpi_device_physical_node *physical_node, *pn;
166 char physical_node_name[PHYSICAL_NODE_NAME_SIZE];
167 struct list_head *physnode_list;
168 unsigned int node_id;
169 int retval = -EINVAL;
170
171 if (ACPI_COMPANION(dev)) {
172 if (acpi_dev) {
173 dev_warn(dev, "ACPI companion already set\n");
174 return -EINVAL;
175 } else {
176 acpi_dev = ACPI_COMPANION(dev);
177 }
178 }
179 if (!acpi_dev)
180 return -EINVAL;
181
182 get_device(&acpi_dev->dev);
183 get_device(dev);
184 physical_node = kzalloc(sizeof(*physical_node), GFP_KERNEL);
185 if (!physical_node) {
186 retval = -ENOMEM;
187 goto err;
188 }
189
190 mutex_lock(&acpi_dev->physical_node_lock);
191
192 /*
193 * Keep the list sorted by node_id so that the IDs of removed nodes can
194 * be recycled easily.
195 */
196 physnode_list = &acpi_dev->physical_node_list;
197 node_id = 0;
198 list_for_each_entry(pn, &acpi_dev->physical_node_list, node) {
199 /* Sanity check. */
200 if (pn->dev == dev) {
201 mutex_unlock(&acpi_dev->physical_node_lock);
202
203 dev_warn(dev, "Already associated with ACPI node\n");
204 kfree(physical_node);
205 if (ACPI_COMPANION(dev) != acpi_dev)
206 goto err;
207
208 put_device(dev);
209 put_device(&acpi_dev->dev);
210 return 0;
211 }
212 if (pn->node_id == node_id) {
213 physnode_list = &pn->node;
214 node_id++;
215 }
216 }
217
218 physical_node->node_id = node_id;
219 physical_node->dev = dev;
220 list_add(&physical_node->node, physnode_list);
221 acpi_dev->physical_node_count++;
222
223 if (!ACPI_COMPANION(dev))
224 ACPI_COMPANION_SET(dev, acpi_dev);
225
226 acpi_physnode_link_name(physical_node_name, node_id);
227 retval = sysfs_create_link(&acpi_dev->dev.kobj, &dev->kobj,
228 physical_node_name);
229 if (retval)
230 dev_err(&acpi_dev->dev, "Failed to create link %s (%d)\n",
231 physical_node_name, retval);
232
233 retval = sysfs_create_link(&dev->kobj, &acpi_dev->dev.kobj,
234 "firmware_node");
235 if (retval)
236 dev_err(dev, "Failed to create link firmware_node (%d)\n",
237 retval);
238
239 mutex_unlock(&acpi_dev->physical_node_lock);
240
241 if (acpi_dev->wakeup.flags.valid)
242 device_set_wakeup_capable(dev, true);
243
244 return 0;
245
246 err:
247 ACPI_COMPANION_SET(dev, NULL);
248 put_device(dev);
249 put_device(&acpi_dev->dev);
250 return retval;
251}
252EXPORT_SYMBOL_GPL(acpi_bind_one);
253
254int acpi_unbind_one(struct device *dev)
255{
256 struct acpi_device *acpi_dev = ACPI_COMPANION(dev);
257 struct acpi_device_physical_node *entry;
258
259 if (!acpi_dev)
260 return 0;
261
262 mutex_lock(&acpi_dev->physical_node_lock);
263
264 list_for_each_entry(entry, &acpi_dev->physical_node_list, node)
265 if (entry->dev == dev) {
266 char physnode_name[PHYSICAL_NODE_NAME_SIZE];
267
268 list_del(&entry->node);
269 acpi_dev->physical_node_count--;
270
271 acpi_physnode_link_name(physnode_name, entry->node_id);
272 sysfs_remove_link(&acpi_dev->dev.kobj, physnode_name);
273 sysfs_remove_link(&dev->kobj, "firmware_node");
274 ACPI_COMPANION_SET(dev, NULL);
275 /* Drop references taken by acpi_bind_one(). */
276 put_device(dev);
277 put_device(&acpi_dev->dev);
278 kfree(entry);
279 break;
280 }
281
282 mutex_unlock(&acpi_dev->physical_node_lock);
283 return 0;
284}
285EXPORT_SYMBOL_GPL(acpi_unbind_one);
286
287static int acpi_platform_notify(struct device *dev)
288{
289 struct acpi_bus_type *type = acpi_get_bus_type(dev);
290 struct acpi_device *adev;
291 int ret;
292
293 ret = acpi_bind_one(dev, NULL);
294 if (ret && type) {
295 struct acpi_device *adev;
296
297 adev = type->find_companion(dev);
298 if (!adev) {
299 DBG("Unable to get handle for %s\n", dev_name(dev));
300 ret = -ENODEV;
301 goto out;
302 }
303 ret = acpi_bind_one(dev, adev);
304 if (ret)
305 goto out;
306 }
307 adev = ACPI_COMPANION(dev);
308 if (!adev)
309 goto out;
310
311 if (type && type->setup)
312 type->setup(dev);
313 else if (adev->handler && adev->handler->bind)
314 adev->handler->bind(dev);
315
316 out:
317#if ACPI_GLUE_DEBUG
318 if (!ret) {
319 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
320
321 acpi_get_name(ACPI_HANDLE(dev), ACPI_FULL_PATHNAME, &buffer);
322 DBG("Device %s -> %s\n", dev_name(dev), (char *)buffer.pointer);
323 kfree(buffer.pointer);
324 } else
325 DBG("Device %s -> No ACPI support\n", dev_name(dev));
326#endif
327
328 return ret;
329}
330
331static int acpi_platform_notify_remove(struct device *dev)
332{
333 struct acpi_device *adev = ACPI_COMPANION(dev);
334 struct acpi_bus_type *type;
335
336 if (!adev)
337 return 0;
338
339 type = acpi_get_bus_type(dev);
340 if (type && type->cleanup)
341 type->cleanup(dev);
342 else if (adev->handler && adev->handler->unbind)
343 adev->handler->unbind(dev);
344
345 acpi_unbind_one(dev);
346 return 0;
347}
348
349int __init init_acpi_device_notify(void)
350{
351 if (platform_notify || platform_notify_remove) {
352 printk(KERN_ERR PREFIX "Can't use platform_notify\n");
353 return 0;
354 }
355 platform_notify = acpi_platform_notify;
356 platform_notify_remove = acpi_platform_notify_remove;
357 return 0;
358}