git.oblomov.eu Git - 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, 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, 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         pr_debug("Registering sysdev class '%s'\n", cls->name);
 135
 136         INIT_LIST_HEAD(&cls->drivers);
 137         memset(&cls->kset.kobj, 0x00, sizeof(struct kobject));
 138         cls->kset.kobj.parent = &system_kset->kobj;
 139         cls->kset.kobj.ktype = &ktype_sysdev_class;
 140         cls->kset.kobj.kset = system_kset;
 141         kobject_set_name(&cls->kset.kobj, cls->name);
 142         return kset_register(&cls->kset);
 143 }
 144
 145 void sysdev_class_unregister(struct sysdev_class *cls)
 146 {
 147         pr_debug("Unregistering sysdev class '%s'\n",
 148                  kobject_name(&cls->kset.kobj));
 149         kset_unregister(&cls->kset);
 150 }
 151
 152 EXPORT_SYMBOL_GPL(sysdev_class_register);
 153 EXPORT_SYMBOL_GPL(sysdev_class_unregister);
 154
 155 static DEFINE_MUTEX(sysdev_drivers_lock);
 156
 157 /**
 158  *      sysdev_driver_register - Register auxillary driver
 159  *      @cls:   Device class driver belongs to.
 160  *      @drv:   Driver.
 161  *
 162  *      @drv is inserted into @cls->drivers to be
 163  *      called on each operation on devices of that class. The refcount
 164  *      of @cls is incremented.
 165  */
 166
 167 int sysdev_driver_register(struct sysdev_class *cls, struct sysdev_driver *drv)
 168 {
 169         int err = 0;
 170
 171         if (!cls) {
 172                 WARN(1, KERN_WARNING "sysdev: invalid class passed to "
 173                         "sysdev_driver_register!\n");
 174                 return -EINVAL;
 175         }
 176
 177         /* Check whether this driver has already been added to a class. */
 178         if (drv->entry.next && !list_empty(&drv->entry))
 179                 WARN(1, KERN_WARNING "sysdev: class %s: driver (%p) has already"
 180                         " been registered to a class, something is wrong, but "
 181                         "will forge on!\n", cls->name, drv);
 182
 183         mutex_lock(&sysdev_drivers_lock);
 184         if (cls && kset_get(&cls->kset)) {
 185                 list_add_tail(&drv->entry, &cls->drivers);
 186
 187                 /* If devices of this class already exist, tell the driver */
 188                 if (drv->add) {
 189                         struct sys_device *dev;
 190                         list_for_each_entry(dev, &cls->kset.list, kobj.entry)
 191                                 drv->add(dev);
 192                 }
 193         } else {
 194                 err = -EINVAL;
 195                 WARN(1, KERN_ERR "%s: invalid device class\n", __func__);
 196         }
 197         mutex_unlock(&sysdev_drivers_lock);
 198         return err;
 199 }
 200
 201
 202 /**
 203  *      sysdev_driver_unregister - Remove an auxillary driver.
 204  *      @cls:   Class driver belongs to.
 205  *      @drv:   Driver.
 206  */
 207 void sysdev_driver_unregister(struct sysdev_class *cls,
 208                               struct sysdev_driver *drv)
 209 {
 210         mutex_lock(&sysdev_drivers_lock);
 211         list_del_init(&drv->entry);
 212         if (cls) {
 213                 if (drv->remove) {
 214                         struct sys_device *dev;
 215                         list_for_each_entry(dev, &cls->kset.list, kobj.entry)
 216                                 drv->remove(dev);
 217                 }
 218                 kset_put(&cls->kset);
 219         }
 220         mutex_unlock(&sysdev_drivers_lock);
 221 }
 222
 223 EXPORT_SYMBOL_GPL(sysdev_driver_register);
 224 EXPORT_SYMBOL_GPL(sysdev_driver_unregister);
 225
 226
 227
 228 /**
 229  *      sysdev_register - add a system device to the tree
 230  *      @sysdev:        device in question
 231  *
 232  */
 233 int sysdev_register(struct sys_device *sysdev)
 234 {
 235         int error;
 236         struct sysdev_class *cls = sysdev->cls;
 237
 238         if (!cls)
 239                 return -EINVAL;
 240
 241         pr_debug("Registering sys device of class '%s'\n",
 242                  kobject_name(&cls->kset.kobj));
 243
 244         /* initialize the kobject to 0, in case it had previously been used */
 245         memset(&sysdev->kobj, 0x00, sizeof(struct kobject));
 246
 247         /* Make sure the kset is set */
 248         sysdev->kobj.kset = &cls->kset;
 249
 250         /* Register the object */
 251         error = kobject_init_and_add(&sysdev->kobj, &ktype_sysdev, NULL,
 252                                      "%s%d", kobject_name(&cls->kset.kobj),
 253                                      sysdev->id);
 254
 255         if (!error) {
 256                 struct sysdev_driver *drv;
 257
 258                 pr_debug("Registering sys device '%s'\n",
 259                          kobject_name(&sysdev->kobj));
 260
 261                 mutex_lock(&sysdev_drivers_lock);
 262                 /* Generic notification is implicit, because it's that
 263                  * code that should have called us.
 264                  */
 265
 266                 /* Notify class auxillary drivers */
 267                 list_for_each_entry(drv, &cls->drivers, entry) {
 268                         if (drv->add)
 269                                 drv->add(sysdev);
 270                 }
 271                 mutex_unlock(&sysdev_drivers_lock);
 272         }
 273
 274         kobject_uevent(&sysdev->kobj, KOBJ_ADD);
 275         return error;
 276 }
 277
 278 void sysdev_unregister(struct sys_device *sysdev)
 279 {
 280         struct sysdev_driver *drv;
 281
 282         mutex_lock(&sysdev_drivers_lock);
 283         list_for_each_entry(drv, &sysdev->cls->drivers, entry) {
 284                 if (drv->remove)
 285                         drv->remove(sysdev);
 286         }
 287         mutex_unlock(&sysdev_drivers_lock);
 288
 289         kobject_put(&sysdev->kobj);
 290 }
 291
 292
 293
 294 /**
 295  *      sysdev_shutdown - Shut down all system devices.
 296  *
 297  *      Loop over each class of system devices, and the devices in each
 298  *      of those classes. For each device, we call the shutdown method for
 299  *      each driver registered for the device - the auxillaries,
 300  *      and the class driver.
 301  *
 302  *      Note: The list is iterated in reverse order, so that we shut down
 303  *      child devices before we shut down their parents. The list ordering
 304  *      is guaranteed by virtue of the fact that child devices are registered
 305  *      after their parents.
 306  */
 307 void sysdev_shutdown(void)
 308 {
 309         struct sysdev_class *cls;
 310
 311         pr_debug("Shutting Down System Devices\n");
 312
 313         mutex_lock(&sysdev_drivers_lock);
 314         list_for_each_entry_reverse(cls, &system_kset->list, kset.kobj.entry) {
 315                 struct sys_device *sysdev;
 316
 317                 pr_debug("Shutting down type '%s':\n",
 318                          kobject_name(&cls->kset.kobj));
 319
 320                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
 321                         struct sysdev_driver *drv;
 322                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
 323
 324                         /* Call auxillary drivers first */
 325                         list_for_each_entry(drv, &cls->drivers, entry) {
 326                                 if (drv->shutdown)
 327                                         drv->shutdown(sysdev);
 328                         }
 329
 330                         /* Now call the generic one */
 331                         if (cls->shutdown)
 332                                 cls->shutdown(sysdev);
 333                 }
 334         }
 335         mutex_unlock(&sysdev_drivers_lock);
 336 }
 337
 338 static void __sysdev_resume(struct sys_device *dev)
 339 {
 340         struct sysdev_class *cls = dev->cls;
 341         struct sysdev_driver *drv;
 342
 343         /* First, call the class-specific one */
 344         if (cls->resume)
 345                 cls->resume(dev);
 346
 347         /* Call auxillary drivers next. */
 348         list_for_each_entry(drv, &cls->drivers, entry) {
 349                 if (drv->resume)
 350                         drv->resume(dev);
 351         }
 352 }
 353
 354 /**
 355  *      sysdev_suspend - Suspend all system devices.
 356  *      @state:         Power state to enter.
 357  *
 358  *      We perform an almost identical operation as sysdev_shutdown()
 359  *      above, though calling ->suspend() instead. Interrupts are disabled
 360  *      when this called. Devices are responsible for both saving state and
 361  *      quiescing or powering down the device.
 362  *
 363  *      This is only called by the device PM core, so we let them handle
 364  *      all synchronization.
 365  */
 366 int sysdev_suspend(pm_message_t state)
 367 {
 368         struct sysdev_class *cls;
 369         struct sys_device *sysdev, *err_dev;
 370         struct sysdev_driver *drv, *err_drv;
 371         int ret;
 372
 373         pr_debug("Checking wake-up interrupts\n");
 374
 375         /* Return error code if there are any wake-up interrupts pending */
 376         ret = check_wakeup_irqs();
 377         if (ret)
 378                 return ret;
 379
 380         pr_debug("Suspending System Devices\n");
 381
 382         list_for_each_entry_reverse(cls, &system_kset->list, kset.kobj.entry) {
 383                 pr_debug("Suspending type '%s':\n",
 384                          kobject_name(&cls->kset.kobj));
 385
 386                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
 387                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
 388
 389                         /* Call auxillary drivers first */
 390                         list_for_each_entry(drv, &cls->drivers, entry) {
 391                                 if (drv->suspend) {
 392                                         ret = drv->suspend(sysdev, state);
 393                                         if (ret)
 394                                                 goto aux_driver;
 395                                 }
 396                         }
 397
 398                         /* Now call the generic one */
 399                         if (cls->suspend) {
 400                                 ret = cls->suspend(sysdev, state);
 401                                 if (ret)
 402                                         goto cls_driver;
 403                         }
 404                 }
 405         }
 406         return 0;
 407         /* resume current sysdev */
 408 cls_driver:
 409         drv = NULL;
 410         printk(KERN_ERR "Class suspend failed for %s\n",
 411                 kobject_name(&sysdev->kobj));
 412
 413 aux_driver:
 414         if (drv)
 415                 printk(KERN_ERR "Class driver suspend failed for %s\n",
 416                                 kobject_name(&sysdev->kobj));
 417         list_for_each_entry(err_drv, &cls->drivers, entry) {
 418                 if (err_drv == drv)
 419                         break;
 420                 if (err_drv->resume)
 421                         err_drv->resume(sysdev);
 422         }
 423
 424         /* resume other sysdevs in current class */
 425         list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
 426                 if (err_dev == sysdev)
 427                         break;
 428                 pr_debug(" %s\n", kobject_name(&err_dev->kobj));
 429                 __sysdev_resume(err_dev);
 430         }
 431
 432         /* resume other classes */
 433         list_for_each_entry_continue(cls, &system_kset->list, kset.kobj.entry) {
 434                 list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
 435                         pr_debug(" %s\n", kobject_name(&err_dev->kobj));
 436                         __sysdev_resume(err_dev);
 437                 }
 438         }
 439         return ret;
 440 }
 441 EXPORT_SYMBOL_GPL(sysdev_suspend);
 442
 443 /**
 444  *      sysdev_resume - Bring system devices back to life.
 445  *
 446  *      Similar to sysdev_suspend(), but we iterate the list forwards
 447  *      to guarantee that parent devices are resumed before their children.
 448  *
 449  *      Note: Interrupts are disabled when called.
 450  */
 451 int sysdev_resume(void)
 452 {
 453         struct sysdev_class *cls;
 454
 455         pr_debug("Resuming System Devices\n");
 456
 457         list_for_each_entry(cls, &system_kset->list, kset.kobj.entry) {
 458                 struct sys_device *sysdev;
 459
 460                 pr_debug("Resuming type '%s':\n",
 461                          kobject_name(&cls->kset.kobj));
 462
 463                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
 464                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
 465
 466                         __sysdev_resume(sysdev);
 467                 }
 468         }
 469         return 0;
 470 }
 471 EXPORT_SYMBOL_GPL(sysdev_resume);
 472
 473 int __init system_bus_init(void)
 474 {
 475         system_kset = kset_create_and_add("system", NULL, &devices_kset->kobj);
 476         if (!system_kset)
 477                 return -ENOMEM;
 478         return 0;
 479 }
 480
 481 EXPORT_SYMBOL_GPL(sysdev_register);
 482 EXPORT_SYMBOL_GPL(sysdev_unregister);
 483
 484 #define to_ext_attr(x) container_of(x, struct sysdev_ext_attribute, attr)
 485
 486 ssize_t sysdev_store_ulong(struct sys_device *sysdev,
 487                            struct sysdev_attribute *attr,
 488                            const char *buf, size_t size)
 489 {
 490         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
 491         char *end;
 492         unsigned long new = simple_strtoul(buf, &end, 0);
 493         if (end == buf)
 494                 return -EINVAL;
 495         *(unsigned long *)(ea->var) = new;
 496         /* Always return full write size even if we didn't consume all */
 497         return size;
 498 }
 499 EXPORT_SYMBOL_GPL(sysdev_store_ulong);
 500
 501 ssize_t sysdev_show_ulong(struct sys_device *sysdev,
 502                           struct sysdev_attribute *attr,
 503                           char *buf)
 504 {
 505         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
 506         return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
 507 }
 508 EXPORT_SYMBOL_GPL(sysdev_show_ulong);
 509
 510 ssize_t sysdev_store_int(struct sys_device *sysdev,
 511                            struct sysdev_attribute *attr,
 512                            const char *buf, size_t size)
 513 {
 514         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
 515         char *end;
 516         long new = simple_strtol(buf, &end, 0);
 517         if (end == buf || new > INT_MAX || new < INT_MIN)
 518                 return -EINVAL;
 519         *(int *)(ea->var) = new;
 520         /* Always return full write size even if we didn't consume all */
 521         return size;
 522 }
 523 EXPORT_SYMBOL_GPL(sysdev_store_int);
 524
 525 ssize_t sysdev_show_int(struct sys_device *sysdev,
 526                           struct sysdev_attribute *attr,
 527                           char *buf)
 528 {
 529         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
 530         return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
 531 }
 532 EXPORT_SYMBOL_GPL(sysdev_show_int);
 533