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