Linux Audio

Check our new training course

Linux kernel drivers training

Mar 31-Apr 9, 2025, special US time zones
Register
Loading...
v3.5.6
  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(x...) printk(PREFIX x)
 
 22#else
 23#define DBG(x...) do { } while(0)
 
 
 
 
 24#endif
 25static LIST_HEAD(bus_type_list);
 26static DECLARE_RWSEM(bus_type_sem);
 27
 
 
 
 28int register_acpi_bus_type(struct acpi_bus_type *type)
 29{
 30	if (acpi_disabled)
 31		return -ENODEV;
 32	if (type && type->bus && type->find_device) {
 33		down_write(&bus_type_sem);
 34		list_add_tail(&type->list, &bus_type_list);
 35		up_write(&bus_type_sem);
 36		printk(KERN_INFO PREFIX "bus type %s registered\n",
 37		       type->bus->name);
 38		return 0;
 39	}
 40	return -ENODEV;
 41}
 
 42
 43int unregister_acpi_bus_type(struct acpi_bus_type *type)
 44{
 45	if (acpi_disabled)
 46		return 0;
 47	if (type) {
 48		down_write(&bus_type_sem);
 49		list_del_init(&type->list);
 50		up_write(&bus_type_sem);
 51		printk(KERN_INFO PREFIX "ACPI bus type %s unregistered\n",
 52		       type->bus->name);
 53		return 0;
 54	}
 55	return -ENODEV;
 56}
 
 57
 58static struct acpi_bus_type *acpi_get_bus_type(struct bus_type *type)
 59{
 60	struct acpi_bus_type *tmp, *ret = NULL;
 61
 62	down_read(&bus_type_sem);
 63	list_for_each_entry(tmp, &bus_type_list, list) {
 64		if (tmp->bus == type) {
 65			ret = tmp;
 66			break;
 67		}
 68	}
 69	up_read(&bus_type_sem);
 70	return ret;
 71}
 72EXPORT_SYMBOL_GPL(register_acpi_bus_type);
 73
 74static int acpi_find_bridge_device(struct device *dev, acpi_handle * handle)
 75{
 76	struct acpi_bus_type *tmp;
 77	int ret = -ENODEV;
 78
 79	down_read(&bus_type_sem);
 80	list_for_each_entry(tmp, &bus_type_list, list) {
 81		if (tmp->find_bridge && !tmp->find_bridge(dev, handle)) {
 82			ret = 0;
 83			break;
 84		}
 85	}
 86	up_read(&bus_type_sem);
 87	return ret;
 88}
 89EXPORT_SYMBOL_GPL(unregister_acpi_bus_type);
 90
 91/* Get device's handler per its address under its parent */
 92struct acpi_find_child {
 93	acpi_handle handle;
 94	u64 address;
 95};
 96
 97static acpi_status
 98do_acpi_find_child(acpi_handle handle, u32 lvl, void *context, void **rv)
 99{
 
 
100	acpi_status status;
101	struct acpi_device_info *info;
102	struct acpi_find_child *find = context;
103
104	status = acpi_get_object_info(handle, &info);
105	if (ACPI_SUCCESS(status)) {
106		if ((info->address == find->address)
107			&& (info->valid & ACPI_VALID_ADR))
108			find->handle = handle;
109		kfree(info);
110	}
111	return AE_OK;
112}
113
114acpi_handle acpi_get_child(acpi_handle parent, u64 address)
115{
116	struct acpi_find_child find = { NULL, address };
117
118	if (!parent)
119		return NULL;
120	acpi_walk_namespace(ACPI_TYPE_DEVICE, parent,
121			    1, do_acpi_find_child, NULL, &find, NULL);
122	return find.handle;
123}
124
125EXPORT_SYMBOL(acpi_get_child);
126
127/* Link ACPI devices with physical devices */
128static void acpi_glue_data_handler(acpi_handle handle,
129				   void *context)
130{
131	/* we provide an empty handler */
132}
133
134/* Note: a success call will increase reference count by one */
135struct device *acpi_get_physical_device(acpi_handle handle)
136{
137	acpi_status status;
138	struct device *dev;
139
140	status = acpi_get_data(handle, acpi_glue_data_handler, (void **)&dev);
141	if (ACPI_SUCCESS(status))
142		return get_device(dev);
143	return NULL;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
144}
 
145
146EXPORT_SYMBOL(acpi_get_physical_device);
147
148static int acpi_bind_one(struct device *dev, acpi_handle handle)
149{
150	struct acpi_device *acpi_dev;
151	acpi_status status;
152
153	if (dev->archdata.acpi_handle) {
154		dev_warn(dev, "Drivers changed 'acpi_handle'\n");
155		return -EINVAL;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
156	}
157	get_device(dev);
158	status = acpi_attach_data(handle, acpi_glue_data_handler, dev);
159	if (ACPI_FAILURE(status)) {
160		put_device(dev);
161		return -EINVAL;
162	}
163	dev->archdata.acpi_handle = handle;
164
165	status = acpi_bus_get_device(handle, &acpi_dev);
166	if (!ACPI_FAILURE(status)) {
167		int ret;
168
169		ret = sysfs_create_link(&dev->kobj, &acpi_dev->dev.kobj,
170				"firmware_node");
171		ret = sysfs_create_link(&acpi_dev->dev.kobj, &dev->kobj,
172				"physical_node");
173		if (acpi_dev->wakeup.flags.valid)
174			device_set_wakeup_capable(dev, true);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
175	}
176
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
177	return 0;
 
 
 
 
 
 
178}
 
179
180static int acpi_unbind_one(struct device *dev)
181{
182	if (!dev->archdata.acpi_handle)
 
 
 
183		return 0;
184	if (dev == acpi_get_physical_device(dev->archdata.acpi_handle)) {
185		struct acpi_device *acpi_dev;
186
187		/* acpi_get_physical_device increase refcnt by one */
188		put_device(dev);
 
 
 
189
190		if (!acpi_bus_get_device(dev->archdata.acpi_handle,
191					&acpi_dev)) {
 
 
 
192			sysfs_remove_link(&dev->kobj, "firmware_node");
193			sysfs_remove_link(&acpi_dev->dev.kobj, "physical_node");
 
 
 
 
 
194		}
195
196		acpi_detach_data(dev->archdata.acpi_handle,
197				 acpi_glue_data_handler);
198		dev->archdata.acpi_handle = NULL;
199		/* acpi_bind_one increase refcnt by one */
200		put_device(dev);
201	} else {
202		dev_err(dev, "Oops, 'acpi_handle' corrupt\n");
203	}
204	return 0;
205}
 
206
207static int acpi_platform_notify(struct device *dev)
208{
209	struct acpi_bus_type *type;
210	acpi_handle handle;
211	int ret = -EINVAL;
212
213	if (!dev->bus || !dev->parent) {
214		/* bridge devices genernally haven't bus or parent */
215		ret = acpi_find_bridge_device(dev, &handle);
216		goto end;
217	}
218	type = acpi_get_bus_type(dev->bus);
219	if (!type) {
220		DBG("No ACPI bus support for %s\n", dev_name(dev));
221		ret = -EINVAL;
222		goto end;
223	}
224	if ((ret = type->find_device(dev, &handle)) != 0)
225		DBG("Can't get handler for %s\n", dev_name(dev));
226      end:
227	if (!ret)
228		acpi_bind_one(dev, handle);
 
 
 
 
 
 
229
 
230#if ACPI_GLUE_DEBUG
231	if (!ret) {
232		struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
233
234		acpi_get_name(dev->archdata.acpi_handle,
235			      ACPI_FULL_PATHNAME, &buffer);
236		DBG("Device %s -> %s\n", dev_name(dev), (char *)buffer.pointer);
237		kfree(buffer.pointer);
238	} else
239		DBG("Device %s -> No ACPI support\n", dev_name(dev));
240#endif
241
242	return ret;
243}
244
245static int acpi_platform_notify_remove(struct device *dev)
246{
 
 
 
 
 
 
 
 
 
 
 
 
247	acpi_unbind_one(dev);
248	return 0;
249}
250
251int __init init_acpi_device_notify(void)
252{
253	if (platform_notify || platform_notify_remove) {
254		printk(KERN_ERR PREFIX "Can't use platform_notify\n");
255		return 0;
256	}
257	platform_notify = acpi_platform_notify;
258	platform_notify_remove = acpi_platform_notify_remove;
259	return 0;
260}
v3.15
  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}