drivers/acpi/glue.c

   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, ...)                                           \
  25 do {                                                            \
  26         if (0)                                                  \
  27                 printk(KERN_DEBUG PREFIX fmt, ##__VA_ARGS__);   \
  28 } while (0)
  29 #endif
  30 static LIST_HEAD(bus_type_list);
  31 static 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
  36 int register_acpi_bus_type(struct acpi_bus_type *type)
  37 {
  38         if (acpi_disabled)
  39                 return -ENODEV;
  40         if (type && type->match && type->find_device) {
  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 }
  49 EXPORT_SYMBOL_GPL(register_acpi_bus_type);
  50
  51 int 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 }
  65 EXPORT_SYMBOL_GPL(unregister_acpi_bus_type);
  66
  67 static 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
  85 static 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
 103 struct 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 }
 152
 153 acpi_handle acpi_find_child(acpi_handle handle, u64 addr, bool is_bridge)
 154 {
 155         struct acpi_device *adev;
 156
 157         if (!handle || acpi_bus_get_device(handle, &adev))
 158                 return NULL;
 159
 160         adev = acpi_find_child_device(adev, addr, is_bridge);
 161         return adev ? adev->handle : NULL;
 162 }
 163 EXPORT_SYMBOL_GPL(acpi_find_child);
 164
 165 static 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
 174 int acpi_bind_one(struct device *dev, acpi_handle handle)
 175 {
 176         struct acpi_device *acpi_dev = NULL;
 177         struct acpi_device_physical_node *physical_node, *pn;
 178         char physical_node_name[PHYSICAL_NODE_NAME_SIZE];
 179         struct list_head *physnode_list;
 180         unsigned int node_id;
 181         int retval = -EINVAL;
 182
 183         if (ACPI_COMPANION(dev)) {
 184                 if (handle) {
 185                         dev_warn(dev, "ACPI companion already set\n");
 186                         return -EINVAL;
 187                 } else {
 188                         acpi_dev = ACPI_COMPANION(dev);
 189                 }
 190         } else {
 191                 acpi_bus_get_device(handle, &acpi_dev);
 192         }
 193         if (!acpi_dev)
 194                 return -EINVAL;
 195
 196         get_device(&acpi_dev->dev);
 197         get_device(dev);
 198         physical_node = kzalloc(sizeof(*physical_node), GFP_KERNEL);
 199         if (!physical_node) {
 200                 retval = -ENOMEM;
 201                 goto err;
 202         }
 203
 204         mutex_lock(&acpi_dev->physical_node_lock);
 205
 206         /*
 207          * Keep the list sorted by node_id so that the IDs of removed nodes can
 208          * be recycled easily.
 209          */
 210         physnode_list = &acpi_dev->physical_node_list;
 211         node_id = 0;
 212         list_for_each_entry(pn, &acpi_dev->physical_node_list, node) {
 213                 /* Sanity check. */
 214                 if (pn->dev == dev) {
 215                         mutex_unlock(&acpi_dev->physical_node_lock);
 216
 217                         dev_warn(dev, "Already associated with ACPI node\n");
 218                         kfree(physical_node);
 219                         if (ACPI_COMPANION(dev) != acpi_dev)
 220                                 goto err;
 221
 222                         put_device(dev);
 223                         put_device(&acpi_dev->dev);
 224                         return 0;
 225                 }
 226                 if (pn->node_id == node_id) {
 227                         physnode_list = &pn->node;
 228                         node_id++;
 229                 }
 230         }
 231
 232         physical_node->node_id = node_id;
 233         physical_node->dev = dev;
 234         list_add(&physical_node->node, physnode_list);
 235         acpi_dev->physical_node_count++;
 236
 237         if (!ACPI_COMPANION(dev))
 238                 ACPI_COMPANION_SET(dev, acpi_dev);
 239
 240         acpi_physnode_link_name(physical_node_name, node_id);
 241         retval = sysfs_create_link(&acpi_dev->dev.kobj, &dev->kobj,
 242                                    physical_node_name);
 243         if (retval)
 244                 dev_err(&acpi_dev->dev, "Failed to create link %s (%d)\n",
 245                         physical_node_name, retval);
 246
 247         retval = sysfs_create_link(&dev->kobj, &acpi_dev->dev.kobj,
 248                                    "firmware_node");
 249         if (retval)
 250                 dev_err(dev, "Failed to create link firmware_node (%d)\n",
 251                         retval);
 252
 253         mutex_unlock(&acpi_dev->physical_node_lock);
 254
 255         if (acpi_dev->wakeup.flags.valid)
 256                 device_set_wakeup_capable(dev, true);
 257
 258         return 0;
 259
 260  err:
 261         ACPI_COMPANION_SET(dev, NULL);
 262         put_device(dev);
 263         put_device(&acpi_dev->dev);
 264         return retval;
 265 }
 266 EXPORT_SYMBOL_GPL(acpi_bind_one);
 267
 268 int acpi_unbind_one(struct device *dev)
 269 {
 270         struct acpi_device *acpi_dev = ACPI_COMPANION(dev);
 271         struct acpi_device_physical_node *entry;
 272
 273         if (!acpi_dev)
 274                 return 0;
 275
 276         mutex_lock(&acpi_dev->physical_node_lock);
 277
 278         list_for_each_entry(entry, &acpi_dev->physical_node_list, node)
 279                 if (entry->dev == dev) {
 280                         char physnode_name[PHYSICAL_NODE_NAME_SIZE];
 281
 282                         list_del(&entry->node);
 283                         acpi_dev->physical_node_count--;
 284
 285                         acpi_physnode_link_name(physnode_name, entry->node_id);
 286                         sysfs_remove_link(&acpi_dev->dev.kobj, physnode_name);
 287                         sysfs_remove_link(&dev->kobj, "firmware_node");
 288                         ACPI_COMPANION_SET(dev, NULL);
 289                         /* Drop references taken by acpi_bind_one(). */
 290                         put_device(dev);
 291                         put_device(&acpi_dev->dev);
 292                         kfree(entry);
 293                         break;
 294                 }
 295
 296         mutex_unlock(&acpi_dev->physical_node_lock);
 297         return 0;
 298 }
 299 EXPORT_SYMBOL_GPL(acpi_unbind_one);
 300
 301 void acpi_preset_companion(struct device *dev, acpi_handle parent, u64 addr)
 302 {
 303         struct acpi_device *adev;
 304
 305         if (!acpi_bus_get_device(acpi_get_child(parent, addr), &adev))
 306                 ACPI_COMPANION_SET(dev, adev);
 307 }
 308 EXPORT_SYMBOL_GPL(acpi_preset_companion);
 309
 310 static int acpi_platform_notify(struct device *dev)
 311 {
 312         struct acpi_bus_type *type = acpi_get_bus_type(dev);
 313         acpi_handle handle;
 314         int ret;
 315
 316         ret = acpi_bind_one(dev, NULL);
 317         if (ret && type) {
 318                 ret = type->find_device(dev, &handle);
 319                 if (ret) {
 320                         DBG("Unable to get handle for %s\n", dev_name(dev));
 321                         goto out;
 322                 }
 323                 ret = acpi_bind_one(dev, handle);
 324                 if (ret)
 325                         goto out;
 326         }
 327
 328         if (type && type->setup)
 329                 type->setup(dev);
 330
 331  out:
 332 #if ACPI_GLUE_DEBUG
 333         if (!ret) {
 334                 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
 335
 336                 acpi_get_name(ACPI_HANDLE(dev), ACPI_FULL_PATHNAME, &buffer);
 337                 DBG("Device %s -> %s\n", dev_name(dev), (char *)buffer.pointer);
 338                 kfree(buffer.pointer);
 339         } else
 340                 DBG("Device %s -> No ACPI support\n", dev_name(dev));
 341 #endif
 342
 343         return ret;
 344 }
 345
 346 static int acpi_platform_notify_remove(struct device *dev)
 347 {
 348         struct acpi_bus_type *type;
 349
 350         type = acpi_get_bus_type(dev);
 351         if (type && type->cleanup)
 352                 type->cleanup(dev);
 353
 354         acpi_unbind_one(dev);
 355         return 0;
 356 }
 357
 358 int __init init_acpi_device_notify(void)
 359 {
 360         if (platform_notify || platform_notify_remove) {
 361                 printk(KERN_ERR PREFIX "Can't use platform_notify\n");
 362                 return 0;
 363         }
 364         platform_notify = acpi_platform_notify;
 365         platform_notify_remove = acpi_platform_notify_remove;
 366         return 0;
 367 }