blob: f774c65ecb8bb03065ba406e658710aead5d02c0 [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. Wysockie3f02c52013-11-29 16:27:34 +010040 if (type && type->match && type->find_companion) {
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. Wysockid9fef0c2013-11-28 23:57:58 +010085static int find_child_checks(struct acpi_device *adev, bool check_children)
David Shaohua Li4e10d122005-03-18 18:45:35 -050086{
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +020087 bool sta_present = true;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +020088 unsigned long long sta;
89 acpi_status status;
David Shaohua Li4e10d122005-03-18 18:45:35 -050090
Rafael J. Wysockid9fef0c2013-11-28 23:57:58 +010091 status = acpi_evaluate_integer(adev->handle, "_STA", NULL, &sta);
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +020092 if (status == AE_NOT_FOUND)
93 sta_present = false;
94 else if (ACPI_FAILURE(status) || !(sta & ACPI_STA_DEVICE_ENABLED))
95 return -ENODEV;
David Shaohua Li4e10d122005-03-18 18:45:35 -050096
Rafael J. Wysockid9fef0c2013-11-28 23:57:58 +010097 if (check_children && list_empty(&adev->children))
98 return -ENODEV;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +020099
Rafael J. Wysocki11b88ee2013-09-09 23:07:47 +0200100 return sta_present ? FIND_CHILD_MAX_SCORE : FIND_CHILD_MIN_SCORE;
Rafael J. Wysocki33f767d2013-01-10 13:13:49 +0100101}
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200102
Rafael J. Wysockid9fef0c2013-11-28 23:57:58 +0100103struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
104 u64 address, bool check_children)
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200105{
Rafael J. Wysockid9fef0c2013-11-28 23:57:58 +0100106 struct acpi_device *adev, *ret = NULL;
107 int ret_score = 0;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200108
Rafael J. Wysocki5ce79d22013-11-28 23:58:08 +0100109 if (!parent)
110 return NULL;
111
Rafael J. Wysockid9fef0c2013-11-28 23:57:58 +0100112 list_for_each_entry(adev, &parent->children, node) {
113 unsigned long long addr;
114 acpi_status status;
115 int score;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200116
Rafael J. Wysockid9fef0c2013-11-28 23:57:58 +0100117 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 }
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200149 }
Rafael J. Wysockid9fef0c2013-11-28 23:57:58 +0100150 return ret;
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200151}
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100152EXPORT_SYMBOL_GPL(acpi_find_child_device);
Rafael J. Wysocki60f75b82013-08-07 22:55:00 +0200153
Rafael J. Wysockibdbdbf92013-08-07 01:19:23 +0200154static 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
Rafael J. Wysocki24dee1f2013-11-29 16:27:43 +0100163int acpi_bind_one(struct device *dev, struct acpi_device *acpi_dev)
David Shaohua Li4e10d122005-03-18 18:45:35 -0500164{
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100165 struct acpi_device_physical_node *physical_node, *pn;
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200166 char physical_node_name[PHYSICAL_NODE_NAME_SIZE];
167 struct list_head *physnode_list;
168 unsigned int node_id;
Lan Tianyu1033f902012-08-17 14:44:09 +0800169 int retval = -EINVAL;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500170
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100171 if (ACPI_COMPANION(dev)) {
Rafael J. Wysocki24dee1f2013-11-29 16:27:43 +0100172 if (acpi_dev) {
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100173 dev_warn(dev, "ACPI companion already set\n");
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100174 return -EINVAL;
175 } else {
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100176 acpi_dev = ACPI_COMPANION(dev);
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100177 }
David Shaohua Li4e10d122005-03-18 18:45:35 -0500178 }
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100179 if (!acpi_dev)
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100180 return -EINVAL;
Lan Tianyu1033f902012-08-17 14:44:09 +0800181
Rafael J. Wysockia104b4d2013-11-14 23:18:32 +0100182 get_device(&acpi_dev->dev);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500183 get_device(dev);
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100184 physical_node = kzalloc(sizeof(*physical_node), GFP_KERNEL);
Lan Tianyu1033f902012-08-17 14:44:09 +0800185 if (!physical_node) {
186 retval = -ENOMEM;
187 goto err;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500188 }
Lan Tianyu1033f902012-08-17 14:44:09 +0800189
190 mutex_lock(&acpi_dev->physical_node_lock);
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100191
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200192 /*
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. */
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100200 if (pn->dev == dev) {
Rafael J. Wysocki3342c752013-08-08 16:19:10 +0200201 mutex_unlock(&acpi_dev->physical_node_lock);
Rafael J. Wysocki3fe444a2013-08-07 01:15:25 +0200202
Rafael J. Wysocki3342c752013-08-08 16:19:10 +0200203 dev_warn(dev, "Already associated with ACPI node\n");
204 kfree(physical_node);
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100205 if (ACPI_COMPANION(dev) != acpi_dev)
Rafael J. Wysocki3342c752013-08-08 16:19:10 +0200206 goto err;
207
208 put_device(dev);
Rafael J. Wysockia104b4d2013-11-14 23:18:32 +0100209 put_device(&acpi_dev->dev);
Rafael J. Wysocki3342c752013-08-08 16:19:10 +0200210 return 0;
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100211 }
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200212 if (pn->node_id == node_id) {
213 physnode_list = &pn->node;
214 node_id++;
215 }
Lan Tianyu1033f902012-08-17 14:44:09 +0800216 }
217
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200218 physical_node->node_id = node_id;
Lan Tianyu1033f902012-08-17 14:44:09 +0800219 physical_node->dev = dev;
Rafael J. Wysocki007ccfc2013-08-06 14:32:54 +0200220 list_add(&physical_node->node, physnode_list);
Lan Tianyu1033f902012-08-17 14:44:09 +0800221 acpi_dev->physical_node_count++;
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100222
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100223 if (!ACPI_COMPANION(dev))
224 ACPI_COMPANION_SET(dev, acpi_dev);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500225
Rafael J. Wysockibdbdbf92013-08-07 01:19:23 +0200226 acpi_physnode_link_name(physical_node_name, node_id);
Lan Tianyu1033f902012-08-17 14:44:09 +0800227 retval = sysfs_create_link(&acpi_dev->dev.kobj, &dev->kobj,
Rafael J. Wysockif501b6e2013-08-07 01:19:52 +0200228 physical_node_name);
Rafael J. Wysocki464c1142013-08-08 16:19:19 +0200229 if (retval)
230 dev_err(&acpi_dev->dev, "Failed to create link %s (%d)\n",
231 physical_node_name, retval);
232
Lan Tianyu1033f902012-08-17 14:44:09 +0800233 retval = sysfs_create_link(&dev->kobj, &acpi_dev->dev.kobj,
Rafael J. Wysockif501b6e2013-08-07 01:19:52 +0200234 "firmware_node");
Rafael J. Wysocki464c1142013-08-08 16:19:19 +0200235 if (retval)
236 dev_err(dev, "Failed to create link firmware_node (%d)\n",
237 retval);
David Brownell10716952008-02-22 21:54:24 -0800238
Rafael J. Wysocki40055202013-08-07 01:19:37 +0200239 mutex_unlock(&acpi_dev->physical_node_lock);
240
Lan Tianyu1033f902012-08-17 14:44:09 +0800241 if (acpi_dev->wakeup.flags.valid)
242 device_set_wakeup_capable(dev, true);
David Brownell10716952008-02-22 21:54:24 -0800243
David Shaohua Li4e10d122005-03-18 18:45:35 -0500244 return 0;
Lan Tianyu1033f902012-08-17 14:44:09 +0800245
246 err:
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100247 ACPI_COMPANION_SET(dev, NULL);
Lan Tianyu1033f902012-08-17 14:44:09 +0800248 put_device(dev);
Rafael J. Wysockia104b4d2013-11-14 23:18:32 +0100249 put_device(&acpi_dev->dev);
Lan Tianyu1033f902012-08-17 14:44:09 +0800250 return retval;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500251}
Rafael J. Wysockiac212b62013-05-03 00:26:22 +0200252EXPORT_SYMBOL_GPL(acpi_bind_one);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500253
Rafael J. Wysockiac212b62013-05-03 00:26:22 +0200254int acpi_unbind_one(struct device *dev)
David Shaohua Li4e10d122005-03-18 18:45:35 -0500255{
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100256 struct acpi_device *acpi_dev = ACPI_COMPANION(dev);
Lan Tianyu1033f902012-08-17 14:44:09 +0800257 struct acpi_device_physical_node *entry;
Lan Tianyu1033f902012-08-17 14:44:09 +0800258
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100259 if (!acpi_dev)
David Shaohua Li4e10d122005-03-18 18:45:35 -0500260 return 0;
David Brownell10716952008-02-22 21:54:24 -0800261
Lan Tianyu1033f902012-08-17 14:44:09 +0800262 mutex_lock(&acpi_dev->physical_node_lock);
David Brownell10716952008-02-22 21:54:24 -0800263
Rafael J. Wysocki3e332782013-08-07 01:22:08 +0200264 list_for_each_entry(entry, &acpi_dev->physical_node_list, node)
265 if (entry->dev == dev) {
266 char physnode_name[PHYSICAL_NODE_NAME_SIZE];
Lan Tianyu1033f902012-08-17 14:44:09 +0800267
Rafael J. Wysocki3e332782013-08-07 01:22:08 +0200268 list_del(&entry->node);
269 acpi_dev->physical_node_count--;
Lan Tianyu1033f902012-08-17 14:44:09 +0800270
Rafael J. Wysocki3e332782013-08-07 01:22:08 +0200271 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");
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100274 ACPI_COMPANION_SET(dev, NULL);
Rafael J. Wysockia104b4d2013-11-14 23:18:32 +0100275 /* Drop references taken by acpi_bind_one(). */
Rafael J. Wysocki3e332782013-08-07 01:22:08 +0200276 put_device(dev);
Rafael J. Wysockia104b4d2013-11-14 23:18:32 +0100277 put_device(&acpi_dev->dev);
Rafael J. Wysocki3e332782013-08-07 01:22:08 +0200278 kfree(entry);
279 break;
280 }
281
Lan Tianyu1033f902012-08-17 14:44:09 +0800282 mutex_unlock(&acpi_dev->physical_node_lock);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500283 return 0;
284}
Rafael J. Wysockiac212b62013-05-03 00:26:22 +0200285EXPORT_SYMBOL_GPL(acpi_unbind_one);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500286
287static int acpi_platform_notify(struct device *dev)
288{
Rafael J. Wysocki53540092013-03-03 22:35:20 +0100289 struct acpi_bus_type *type = acpi_get_bus_type(dev);
Rafael J. Wysocki9cb32ac2014-02-11 00:35:46 +0100290 struct acpi_device *adev;
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100291 int ret;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500292
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100293 ret = acpi_bind_one(dev, NULL);
Rafael J. Wysocki92414482013-03-03 22:35:44 +0100294 if (ret && type) {
Rafael J. Wysockie3f02c52013-11-29 16:27:34 +0100295 struct acpi_device *adev;
296
297 adev = type->find_companion(dev);
298 if (!adev) {
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100299 DBG("Unable to get handle for %s\n", dev_name(dev));
Rafael J. Wysockie3f02c52013-11-29 16:27:34 +0100300 ret = -ENODEV;
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100301 goto out;
302 }
Rafael J. Wysocki24dee1f2013-11-29 16:27:43 +0100303 ret = acpi_bind_one(dev, adev);
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100304 if (ret)
305 goto out;
David Shaohua Li4e10d122005-03-18 18:45:35 -0500306 }
Rafael J. Wysocki9cb32ac2014-02-11 00:35:46 +0100307 adev = ACPI_COMPANION(dev);
308 if (!adev)
309 goto out;
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100310
311 if (type && type->setup)
312 type->setup(dev);
Rafael J. Wysocki9cb32ac2014-02-11 00:35:46 +0100313 else if (adev->handler && adev->handler->bind)
314 adev->handler->bind(dev);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500315
Rafael J. Wysockif3fd0c82012-11-21 00:21:39 +0100316 out:
David Shaohua Li4e10d122005-03-18 18:45:35 -0500317#if ACPI_GLUE_DEBUG
318 if (!ret) {
319 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
320
Yinghai Lua412a112013-01-12 14:00:06 +0100321 acpi_get_name(ACPI_HANDLE(dev), ACPI_FULL_PATHNAME, &buffer);
Kay Sieversdb1461a2009-01-25 23:40:56 +0100322 DBG("Device %s -> %s\n", dev_name(dev), (char *)buffer.pointer);
Len Brown02438d82006-06-30 03:19:10 -0400323 kfree(buffer.pointer);
David Shaohua Li4e10d122005-03-18 18:45:35 -0500324 } else
Kay Sieversdb1461a2009-01-25 23:40:56 +0100325 DBG("Device %s -> No ACPI support\n", dev_name(dev));
David Shaohua Li4e10d122005-03-18 18:45:35 -0500326#endif
327
328 return ret;
329}
330
331static int acpi_platform_notify_remove(struct device *dev)
332{
Rafael J. Wysocki9cb32ac2014-02-11 00:35:46 +0100333 struct acpi_device *adev = ACPI_COMPANION(dev);
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100334 struct acpi_bus_type *type;
335
Rafael J. Wysocki9cb32ac2014-02-11 00:35:46 +0100336 if (!adev)
337 return 0;
338
Rafael J. Wysocki53540092013-03-03 22:35:20 +0100339 type = acpi_get_bus_type(dev);
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100340 if (type && type->cleanup)
341 type->cleanup(dev);
Rafael J. Wysocki9cb32ac2014-02-11 00:35:46 +0100342 else if (adev->handler && adev->handler->unbind)
343 adev->handler->unbind(dev);
Rafael J. Wysocki11909ca2012-12-23 00:02:13 +0100344
David Shaohua Li4e10d122005-03-18 18:45:35 -0500345 acpi_unbind_one(dev);
346 return 0;
347}
348
Bjorn Helgaas0e465172009-03-24 16:50:09 -0600349int __init init_acpi_device_notify(void)
David Shaohua Li4e10d122005-03-18 18:45:35 -0500350{
David Shaohua Li4e10d122005-03-18 18:45:35 -0500351 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}