SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/base/sys.c

   1 /*
   2  * sys.c - pseudo-bus for system 'devices' (cpus, PICs, timers, etc)
   3  *
   4  * Copyright (c) 2002-3 Patrick Mochel
   5  *               2002-3 Open Source Development Lab
   6  *
   7  * This file is released under the GPLv2
   8  *
   9  * This exports a 'system' bus type.
  10  * By default, a 'sys' bus gets added to the root of the system. There will
  11  * always be core system devices. Devices can use sysdev_register() to
  12  * add themselves as children of the system bus.
  13  */
  14
  15 #include <linux/sysdev.h>
  16 #include <linux/err.h>
  17 #include <linux/module.h>
  18 #include <linux/kernel.h>
  19 #include <linux/init.h>
  20 #include <linux/slab.h>
  21 #include <linux/string.h>
  22 #include <linux/pm.h>
  23 #include <linux/device.h>
  24 #include <linux/mutex.h>
  25 #include <linux/interrupt.h>
  26
  27 #include "base.h"
  28
  29 #define to_sysdev(k) container_of(k, struct sys_device, kobj)
  30 #define to_sysdev_attr(a) container_of(a, struct sysdev_attribute, attr)
  31
  32
  33 static ssize_t
  34 sysdev_show(struct kobject *kobj, struct attribute *attr, char *buffer)
  35 {
  36         struct sys_device *sysdev = to_sysdev(kobj);
  37         struct sysdev_attribute *sysdev_attr = to_sysdev_attr(attr);
  38
  39         if (sysdev_attr->show)
  40                 return sysdev_attr->show(sysdev, sysdev_attr, buffer);
  41         return -EIO;
  42 }
  43
  44
  45 static ssize_t
  46 sysdev_store(struct kobject *kobj, struct attribute *attr,
  47              const char *buffer, size_t count)
  48 {
  49         struct sys_device *sysdev = to_sysdev(kobj);
  50         struct sysdev_attribute *sysdev_attr = to_sysdev_attr(attr);
  51
  52         if (sysdev_attr->store)
  53                 return sysdev_attr->store(sysdev, sysdev_attr, buffer, count);
  54         return -EIO;
  55 }
  56
  57 static struct sysfs_ops sysfs_ops = {
  58         .show   = sysdev_show,
  59         .store  = sysdev_store,
  60 };
  61
  62 static struct kobj_type ktype_sysdev = {
  63         .sysfs_ops      = &sysfs_ops,
  64 };
  65
  66
  67 int sysdev_create_file(struct sys_device *s, struct sysdev_attribute *a)
  68 {
  69         return sysfs_create_file(&s->kobj, &a->attr);
  70 }
  71
  72
  73 void sysdev_remove_file(struct sys_device *s, struct sysdev_attribute *a)
  74 {
  75         sysfs_remove_file(&s->kobj, &a->attr);
  76 }
  77
  78 EXPORT_SYMBOL_GPL(sysdev_create_file);
  79 EXPORT_SYMBOL_GPL(sysdev_remove_file);
  80
  81 #define to_sysdev_class(k) container_of(k, struct sysdev_class, kset.kobj)
  82 #define to_sysdev_class_attr(a) container_of(a, \
  83         struct sysdev_class_attribute, attr)
  84
  85 static ssize_t sysdev_class_show(struct kobject *kobj, struct attribute *attr,
  86                                  char *buffer)
  87 {
  88         struct sysdev_class *class = to_sysdev_class(kobj);
  89         struct sysdev_class_attribute *class_attr = to_sysdev_class_attr(attr);
  90
  91         if (class_attr->show)
  92                 return class_attr->show(class, class_attr, buffer);
  93         return -EIO;
  94 }
  95
  96 static ssize_t sysdev_class_store(struct kobject *kobj, struct attribute *attr,
  97                                   const char *buffer, size_t count)
  98 {
  99         struct sysdev_class *class = to_sysdev_class(kobj);
 100         struct sysdev_class_attribute *class_attr = to_sysdev_class_attr(attr);
 101
 102         if (class_attr->store)
 103                 return class_attr->store(class, class_attr, buffer, count);
 104         return -EIO;
 105 }
 106
 107 static struct sysfs_ops sysfs_class_ops = {
 108         .show   = sysdev_class_show,
 109         .store  = sysdev_class_store,
 110 };
 111
 112 static struct kobj_type ktype_sysdev_class = {
 113         .sysfs_ops      = &sysfs_class_ops,
 114 };
 115
 116 int sysdev_class_create_file(struct sysdev_class *c,
 117                              struct sysdev_class_attribute *a)
 118 {
 119         return sysfs_create_file(&c->kset.kobj, &a->attr);
 120 }
 121 EXPORT_SYMBOL_GPL(sysdev_class_create_file);
 122
 123 void sysdev_class_remove_file(struct sysdev_class *c,
 124                               struct sysdev_class_attribute *a)
 125 {
 126         sysfs_remove_file(&c->kset.kobj, &a->attr);
 127 }
 128 EXPORT_SYMBOL_GPL(sysdev_class_remove_file);
 129
 130 static struct kset *system_kset;
 131
 132 int sysdev_class_register(struct sysdev_class *cls)
 133 {
 134         int retval;
 135
 136         pr_debug("Registering sysdev class '%s'\n", cls->name);
 137
 138         INIT_LIST_HEAD(&cls->drivers);
 139         memset(&cls->kset.kobj, 0x00, sizeof(struct kobject));
 140         cls->kset.kobj.parent = &system_kset->kobj;
 141         cls->kset.kobj.ktype = &ktype_sysdev_class;
 142         cls->kset.kobj.kset = system_kset;
 143
 144         retval = kobject_set_name(&cls->kset.kobj, "%s", cls->name);
 145         if (retval)
 146                 return retval;
 147
 148         retval = kset_register(&cls->kset);
 149         if (!retval && cls->attrs)
 150                 retval = sysfs_create_files(&cls->kset.kobj,
 151                                             (const struct attribute **)cls->attrs);
 152         return retval;
 153 }
 154
 155 void sysdev_class_unregister(struct sysdev_class *cls)
 156 {
 157         pr_debug("Unregistering sysdev class '%s'\n",
 158                  kobject_name(&cls->kset.kobj));
 159         if (cls->attrs)
 160                 sysfs_remove_files(&cls->kset.kobj,
 161                                    (const struct attribute **)cls->attrs);
 162         kset_unregister(&cls->kset);
 163 }
 164
 165 EXPORT_SYMBOL_GPL(sysdev_class_register);
 166 EXPORT_SYMBOL_GPL(sysdev_class_unregister);
 167
 168 static DEFINE_MUTEX(sysdev_drivers_lock);
 169
 170 /**
 171  *      sysdev_driver_register - Register auxillary driver
 172  *      @cls:   Device class driver belongs to.
 173  *      @drv:   Driver.
 174  *
 175  *      @drv is inserted into @cls->drivers to be
 176  *      called on each operation on devices of that class. The refcount
 177  *      of @cls is incremented.
 178  */
 179
 180 int sysdev_driver_register(struct sysdev_class *cls, struct sysdev_driver *drv)
 181 {
 182         int err = 0;
 183
 184         if (!cls) {
 185                 WARN(1, KERN_WARNING "sysdev: invalid class passed to "
 186                         "sysdev_driver_register!\n");
 187                 return -EINVAL;
 188         }
 189
 190         /* Check whether this driver has already been added to a class. */
 191         if (drv->entry.next && !list_empty(&drv->entry))
 192                 WARN(1, KERN_WARNING "sysdev: class %s: driver (%p) has already"
 193                         " been registered to a class, something is wrong, but "
 194                         "will forge on!\n", cls->name, drv);
 195
 196         mutex_lock(&sysdev_drivers_lock);
 197         if (cls && kset_get(&cls->kset)) {
 198                 list_add_tail(&drv->entry, &cls->drivers);
 199
 200                 /* If devices of this class already exist, tell the driver */
 201                 if (drv->add) {
 202                         struct sys_device *dev;
 203                         list_for_each_entry(dev, &cls->kset.list, kobj.entry)
 204                                 drv->add(dev);
 205                 }
 206         } else {
 207                 err = -EINVAL;
 208                 WARN(1, KERN_ERR "%s: invalid device class\n", __func__);
 209         }
 210         mutex_unlock(&sysdev_drivers_lock);
 211         return err;
 212 }
 213
 214
 215 /**
 216  *      sysdev_driver_unregister - Remove an auxillary driver.
 217  *      @cls:   Class driver belongs to.
 218  *      @drv:   Driver.
 219  */
 220 void sysdev_driver_unregister(struct sysdev_class *cls,
 221                               struct sysdev_driver *drv)
 222 {
 223         mutex_lock(&sysdev_drivers_lock);
 224         list_del_init(&drv->entry);
 225         if (cls) {
 226                 if (drv->remove) {
 227                         struct sys_device *dev;
 228                         list_for_each_entry(dev, &cls->kset.list, kobj.entry)
 229                                 drv->remove(dev);
 230                 }
 231                 kset_put(&cls->kset);
 232         }
 233         mutex_unlock(&sysdev_drivers_lock);
 234 }
 235
 236 EXPORT_SYMBOL_GPL(sysdev_driver_register);
 237 EXPORT_SYMBOL_GPL(sysdev_driver_unregister);
 238
 239
 240
 241 /**
 242  *      sysdev_register - add a system device to the tree
 243  *      @sysdev:        device in question
 244  *
 245  */
 246 int sysdev_register(struct sys_device *sysdev)
 247 {
 248         int error;
 249         struct sysdev_class *cls = sysdev->cls;
 250
 251         if (!cls)
 252                 return -EINVAL;
 253
 254         pr_debug("Registering sys device of class '%s'\n",
 255                  kobject_name(&cls->kset.kobj));
 256
 257         /* initialize the kobject to 0, in case it had previously been used */
 258         memset(&sysdev->kobj, 0x00, sizeof(struct kobject));
 259
 260         /* Make sure the kset is set */
 261         sysdev->kobj.kset = &cls->kset;
 262
 263         /* Register the object */
 264         error = kobject_init_and_add(&sysdev->kobj, &ktype_sysdev, NULL,
 265                                      "%s%d", kobject_name(&cls->kset.kobj),
 266                                      sysdev->id);
 267
 268         if (!error) {
 269                 struct sysdev_driver *drv;
 270
 271                 pr_debug("Registering sys device '%s'\n",
 272                          kobject_name(&sysdev->kobj));
 273
 274                 mutex_lock(&sysdev_drivers_lock);
 275                 /* Generic notification is implicit, because it's that
 276                  * code that should have called us.
 277                  */
 278
 279                 /* Notify class auxillary drivers */
 280                 list_for_each_entry(drv, &cls->drivers, entry) {
 281                         if (drv->add)
 282                                 drv->add(sysdev);
 283                 }
 284                 mutex_unlock(&sysdev_drivers_lock);
 285                 kobject_uevent(&sysdev->kobj, KOBJ_ADD);
 286         }
 287
 288         return error;
 289 }
 290
 291 void sysdev_unregister(struct sys_device *sysdev)
 292 {
 293         struct sysdev_driver *drv;
 294
 295         mutex_lock(&sysdev_drivers_lock);
 296         list_for_each_entry(drv, &sysdev->cls->drivers, entry) {
 297                 if (drv->remove)
 298                         drv->remove(sysdev);
 299         }
 300         mutex_unlock(&sysdev_drivers_lock);
 301
 302         kobject_put(&sysdev->kobj);
 303 }
 304
 305
 306
 307 /**
 308  *      sysdev_shutdown - Shut down all system devices.
 309  *
 310  *      Loop over each class of system devices, and the devices in each
 311  *      of those classes. For each device, we call the shutdown method for
 312  *      each driver registered for the device - the auxillaries,
 313  *      and the class driver.
 314  *
 315  *      Note: The list is iterated in reverse order, so that we shut down
 316  *      child devices before we shut down their parents. The list ordering
 317  *      is guaranteed by virtue of the fact that child devices are registered
 318  *      after their parents.
 319  */
 320 void sysdev_shutdown(void)
 321 {
 322         struct sysdev_class *cls;
 323
 324         pr_debug("Shutting Down System Devices\n");
 325
 326         mutex_lock(&sysdev_drivers_lock);
 327         list_for_each_entry_reverse(cls, &system_kset->list, kset.kobj.entry) {
 328                 struct sys_device *sysdev;
 329
 330                 pr_debug("Shutting down type '%s':\n",
 331                          kobject_name(&cls->kset.kobj));
 332
 333                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
 334                         struct sysdev_driver *drv;
 335                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
 336
 337                         /* Call auxillary drivers first */
 338                         list_for_each_entry(drv, &cls->drivers, entry) {
 339                                 if (drv->shutdown)
 340                                         drv->shutdown(sysdev);
 341                         }
 342
 343                         /* Now call the generic one */
 344                         if (cls->shutdown)
 345                                 cls->shutdown(sysdev);
 346                 }
 347         }
 348         mutex_unlock(&sysdev_drivers_lock);
 349 }
 350
 351 static void __sysdev_resume(struct sys_device *dev)
 352 {
 353         struct sysdev_class *cls = dev->cls;
 354         struct sysdev_driver *drv;
 355
 356         /* First, call the class-specific one */
 357         if (cls->resume)
 358                 cls->resume(dev);
 359         WARN_ONCE(!irqs_disabled(),
 360                 "Interrupts enabled after %pF\n", cls->resume);
 361
 362         /* Call auxillary drivers next. */
 363         list_for_each_entry(drv, &cls->drivers, entry) {
 364                 if (drv->resume)
 365                         drv->resume(dev);
 366                 WARN_ONCE(!irqs_disabled(),
 367                         "Interrupts enabled after %pF\n", drv->resume);
 368         }
 369 }
 370
 371 /**
 372  *      sysdev_suspend - Suspend all system devices.
 373  *      @state:         Power state to enter.
 374  *
 375  *      We perform an almost identical operation as sysdev_shutdown()
 376  *      above, though calling ->suspend() instead. Interrupts are disabled
 377  *      when this called. Devices are responsible for both saving state and
 378  *      quiescing or powering down the device.
 379  *
 380  *      This is only called by the device PM core, so we let them handle
 381  *      all synchronization.
 382  */
 383 int sysdev_suspend(pm_message_t state)
 384 {
 385         struct sysdev_class *cls;
 386         struct sys_device *sysdev, *err_dev;
 387         struct sysdev_driver *drv, *err_drv;
 388         int ret;
 389
 390         pr_debug("Checking wake-up interrupts\n");
 391
 392         /* Return error code if there are any wake-up interrupts pending */
 393         ret = check_wakeup_irqs();
 394         if (ret)
 395                 return ret;
 396
 397         WARN_ONCE(!irqs_disabled(),
 398                 "Interrupts enabled while suspending system devices\n");
 399
 400         pr_debug("Suspending System Devices\n");
 401
 402         list_for_each_entry_reverse(cls, &system_kset->list, kset.kobj.entry) {
 403                 pr_debug("Suspending type '%s':\n",
 404                          kobject_name(&cls->kset.kobj));
 405
 406                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
 407                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
 408
 409                         /* Call auxillary drivers first */
 410                         list_for_each_entry(drv, &cls->drivers, entry) {
 411                                 if (drv->suspend) {
 412                                         ret = drv->suspend(sysdev, state);
 413                                         if (ret)
 414                                                 goto aux_driver;
 415                                 }
 416                                 WARN_ONCE(!irqs_disabled(),
 417                                         "Interrupts enabled after %pF\n",
 418                                         drv->suspend);
 419                         }
 420
 421                         /* Now call the generic one */
 422                         if (cls->suspend) {
 423                                 ret = cls->suspend(sysdev, state);
 424                                 if (ret)
 425                                         goto cls_driver;
 426                                 WARN_ONCE(!irqs_disabled(),
 427                                         "Interrupts enabled after %pF\n",
 428                                         cls->suspend);
 429                         }
 430                 }
 431         }
 432         return 0;
 433         /* resume current sysdev */
 434 cls_driver:
 435         drv = NULL;
 436         printk(KERN_ERR "Class suspend failed for %s\n",
 437                 kobject_name(&sysdev->kobj));
 438
 439 aux_driver:
 440         if (drv)
 441                 printk(KERN_ERR "Class driver suspend failed for %s\n",
 442                                 kobject_name(&sysdev->kobj));
 443         list_for_each_entry(err_drv, &cls->drivers, entry) {
 444                 if (err_drv == drv)
 445                         break;
 446                 if (err_drv->resume)
 447                         err_drv->resume(sysdev);
 448         }
 449
 450         /* resume other sysdevs in current class */
 451         list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
 452                 if (err_dev == sysdev)
 453                         break;
 454                 pr_debug(" %s\n", kobject_name(&err_dev->kobj));
 455                 __sysdev_resume(err_dev);
 456         }
 457
 458         /* resume other classes */
 459         list_for_each_entry_continue(cls, &system_kset->list, kset.kobj.entry) {
 460                 list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
 461                         pr_debug(" %s\n", kobject_name(&err_dev->kobj));
 462                         __sysdev_resume(err_dev);
 463                 }
 464         }
 465         return ret;
 466 }
 467 EXPORT_SYMBOL_GPL(sysdev_suspend);
 468
 469 /**
 470  *      sysdev_resume - Bring system devices back to life.
 471  *
 472  *      Similar to sysdev_suspend(), but we iterate the list forwards
 473  *      to guarantee that parent devices are resumed before their children.
 474  *
 475  *      Note: Interrupts are disabled when called.
 476  */
 477 int sysdev_resume(void)
 478 {
 479         struct sysdev_class *cls;
 480
 481         WARN_ONCE(!irqs_disabled(),
 482                 "Interrupts enabled while resuming system devices\n");
 483
 484         pr_debug("Resuming System Devices\n");
 485
 486         list_for_each_entry(cls, &system_kset->list, kset.kobj.entry) {
 487                 struct sys_device *sysdev;
 488
 489                 pr_debug("Resuming type '%s':\n",
 490                          kobject_name(&cls->kset.kobj));
 491
 492                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
 493                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
 494
 495                         __sysdev_resume(sysdev);
 496                 }
 497         }
 498         return 0;
 499 }
 500 EXPORT_SYMBOL_GPL(sysdev_resume);
 501
 502 int __init system_bus_init(void)
 503 {
 504         system_kset = kset_create_and_add("system", NULL, &devices_kset->kobj);
 505         if (!system_kset)
 506                 return -ENOMEM;
 507         return 0;
 508 }
 509
 510 EXPORT_SYMBOL_GPL(sysdev_register);
 511 EXPORT_SYMBOL_GPL(sysdev_unregister);
 512
 513 #define to_ext_attr(x) container_of(x, struct sysdev_ext_attribute, attr)
 514
 515 ssize_t sysdev_store_ulong(struct sys_device *sysdev,
 516                            struct sysdev_attribute *attr,
 517                            const char *buf, size_t size)
 518 {
 519         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
 520         char *end;
 521         unsigned long new = simple_strtoul(buf, &end, 0);
 522         if (end == buf)
 523                 return -EINVAL;
 524         *(unsigned long *)(ea->var) = new;
 525         /* Always return full write size even if we didn't consume all */
 526         return size;
 527 }
 528 EXPORT_SYMBOL_GPL(sysdev_store_ulong);
 529
 530 ssize_t sysdev_show_ulong(struct sys_device *sysdev,
 531                           struct sysdev_attribute *attr,
 532                           char *buf)
 533 {
 534         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
 535         return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
 536 }
 537 EXPORT_SYMBOL_GPL(sysdev_show_ulong);
 538
 539 ssize_t sysdev_store_int(struct sys_device *sysdev,
 540                            struct sysdev_attribute *attr,
 541                            const char *buf, size_t size)
 542 {
 543         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
 544         char *end;
 545         long new = simple_strtol(buf, &end, 0);
 546         if (end == buf || new > INT_MAX || new < INT_MIN)
 547                 return -EINVAL;
 548         *(int *)(ea->var) = new;
 549         /* Always return full write size even if we didn't consume all */
 550         return size;
 551 }
 552 EXPORT_SYMBOL_GPL(sysdev_store_int);
 553
 554 ssize_t sysdev_show_int(struct sys_device *sysdev,
 555                           struct sysdev_attribute *attr,
 556                           char *buf)
 557 {
 558         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
 559         return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
 560 }
 561 EXPORT_SYMBOL_GPL(sysdev_show_int);
 562