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
  26 #include "base.h"
  27
  28 #define to_sysdev(k) container_of(k, struct sys_device, kobj)
  29 #define to_sysdev_attr(a) container_of(a, struct sysdev_attribute, attr)
  30
  31
  32 static ssize_t
  33 sysdev_show(struct kobject * kobj, struct attribute * attr, char * buffer)
  34 {
  35         struct sys_device * sysdev = to_sysdev(kobj);
  36         struct sysdev_attribute * sysdev_attr = to_sysdev_attr(attr);
  37
  38         if (sysdev_attr->show)
  39                 return sysdev_attr->show(sysdev, buffer);
  40         return -EIO;
  41 }
  42
  43
  44 static ssize_t
  45 sysdev_store(struct kobject * kobj, struct attribute * attr,
  46              const char * buffer, size_t count)
  47 {
  48         struct sys_device * sysdev = to_sysdev(kobj);
  49         struct sysdev_attribute * sysdev_attr = to_sysdev_attr(attr);
  50
  51         if (sysdev_attr->store)
  52                 return sysdev_attr->store(sysdev, buffer, count);
  53         return -EIO;
  54 }
  55
  56 static struct sysfs_ops sysfs_ops = {
  57         .show   = sysdev_show,
  58         .store  = sysdev_store,
  59 };
  60
  61 static struct kobj_type ktype_sysdev = {
  62         .sysfs_ops      = &sysfs_ops,
  63 };
  64
  65
  66 int sysdev_create_file(struct sys_device * s, struct sysdev_attribute * a)
  67 {
  68         return sysfs_create_file(&s->kobj, &a->attr);
  69 }
  70
  71
  72 void sysdev_remove_file(struct sys_device * s, struct sysdev_attribute * a)
  73 {
  74         sysfs_remove_file(&s->kobj, &a->attr);
  75 }
  76
  77 EXPORT_SYMBOL_GPL(sysdev_create_file);
  78 EXPORT_SYMBOL_GPL(sysdev_remove_file);
  79
  80 #define to_sysdev_class(k) container_of(k, struct sysdev_class, kset.kobj)
  81 #define to_sysdev_class_attr(a) container_of(a, \
  82         struct sysdev_class_attribute, attr)
  83
  84 static ssize_t sysdev_class_show(struct kobject *kobj, struct attribute *attr,
  85                                  char *buffer)
  86 {
  87         struct sysdev_class * class = to_sysdev_class(kobj);
  88         struct sysdev_class_attribute *class_attr = to_sysdev_class_attr(attr);
  89
  90         if (class_attr->show)
  91                 return class_attr->show(class, buffer);
  92         return -EIO;
  93 }
  94
  95 static ssize_t sysdev_class_store(struct kobject *kobj, struct attribute *attr,
  96                                   const char *buffer, size_t count)
  97 {
  98         struct sysdev_class * class = to_sysdev_class(kobj);
  99         struct sysdev_class_attribute * class_attr = to_sysdev_class_attr(attr);
 100
 101         if (class_attr->store)
 102                 return class_attr->store(class, buffer, count);
 103         return -EIO;
 104 }
 105
 106 static struct sysfs_ops sysfs_class_ops = {
 107         .show   = sysdev_class_show,
 108         .store  = sysdev_class_store,
 109 };
 110
 111 static struct kobj_type ktype_sysdev_class = {
 112         .sysfs_ops      = &sysfs_class_ops,
 113 };
 114
 115 int sysdev_class_create_file(struct sysdev_class *c,
 116                              struct sysdev_class_attribute *a)
 117 {
 118         return sysfs_create_file(&c->kset.kobj, &a->attr);
 119 }
 120 EXPORT_SYMBOL_GPL(sysdev_class_create_file);
 121
 122 void sysdev_class_remove_file(struct sysdev_class *c,
 123                               struct sysdev_class_attribute *a)
 124 {
 125         sysfs_remove_file(&c->kset.kobj, &a->attr);
 126 }
 127 EXPORT_SYMBOL_GPL(sysdev_class_remove_file);
 128
 129 /*
 130  * declare system_subsys
 131  */
 132 static decl_subsys(system, NULL);
 133
 134 int sysdev_class_register(struct sysdev_class * cls)
 135 {
 136         pr_debug("Registering sysdev class '%s'\n",
 137                  kobject_name(&cls->kset.kobj));
 138         INIT_LIST_HEAD(&cls->drivers);
 139         cls->kset.kobj.parent = &system_subsys.kobj;
 140         cls->kset.kobj.ktype = &ktype_sysdev_class;
 141         cls->kset.kobj.kset = &system_subsys;
 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         mutex_lock(&sysdev_drivers_lock);
 172         if (cls && kset_get(&cls->kset)) {
 173                 list_add_tail(&drv->entry, &cls->drivers);
 174
 175                 /* If devices of this class already exist, tell the driver */
 176                 if (drv->add) {
 177                         struct sys_device *dev;
 178                         list_for_each_entry(dev, &cls->kset.list, kobj.entry)
 179                                 drv->add(dev);
 180                 }
 181         } else {
 182                 err = -EINVAL;
 183                 printk(KERN_ERR "%s: invalid device class\n", __FUNCTION__);
 184                 WARN_ON(1);
 185         }
 186         mutex_unlock(&sysdev_drivers_lock);
 187         return err;
 188 }
 189
 190
 191 /**
 192  *      sysdev_driver_unregister - Remove an auxillary driver.
 193  *      @cls:   Class driver belongs to.
 194  *      @drv:   Driver.
 195  */
 196 void sysdev_driver_unregister(struct sysdev_class * cls,
 197                               struct sysdev_driver * drv)
 198 {
 199         mutex_lock(&sysdev_drivers_lock);
 200         list_del_init(&drv->entry);
 201         if (cls) {
 202                 if (drv->remove) {
 203                         struct sys_device *dev;
 204                         list_for_each_entry(dev, &cls->kset.list, kobj.entry)
 205                                 drv->remove(dev);
 206                 }
 207                 kset_put(&cls->kset);
 208         }
 209         mutex_unlock(&sysdev_drivers_lock);
 210 }
 211
 212 EXPORT_SYMBOL_GPL(sysdev_driver_register);
 213 EXPORT_SYMBOL_GPL(sysdev_driver_unregister);
 214
 215
 216
 217 /**
 218  *      sysdev_register - add a system device to the tree
 219  *      @sysdev:        device in question
 220  *
 221  */
 222 int sysdev_register(struct sys_device * sysdev)
 223 {
 224         int error;
 225         struct sysdev_class * cls = sysdev->cls;
 226
 227         if (!cls)
 228                 return -EINVAL;
 229
 230         /* Make sure the kset is set */
 231         sysdev->kobj.kset = &cls->kset;
 232
 233         /* But make sure we point to the right type for sysfs translation */
 234         sysdev->kobj.ktype = &ktype_sysdev;
 235         error = kobject_set_name(&sysdev->kobj, "%s%d",
 236                          kobject_name(&cls->kset.kobj), sysdev->id);
 237         if (error)
 238                 return error;
 239
 240         pr_debug("Registering sys device '%s'\n", kobject_name(&sysdev->kobj));
 241
 242         /* Register the object */
 243         error = kobject_register(&sysdev->kobj);
 244
 245         if (!error) {
 246                 struct sysdev_driver * drv;
 247
 248                 mutex_lock(&sysdev_drivers_lock);
 249                 /* Generic notification is implicit, because it's that
 250                  * code that should have called us.
 251                  */
 252
 253                 /* Notify class auxillary drivers */
 254                 list_for_each_entry(drv, &cls->drivers, entry) {
 255                         if (drv->add)
 256                                 drv->add(sysdev);
 257                 }
 258                 mutex_unlock(&sysdev_drivers_lock);
 259         }
 260         return error;
 261 }
 262
 263 void sysdev_unregister(struct sys_device * sysdev)
 264 {
 265         struct sysdev_driver * drv;
 266
 267         mutex_lock(&sysdev_drivers_lock);
 268         list_for_each_entry(drv, &sysdev->cls->drivers, entry) {
 269                 if (drv->remove)
 270                         drv->remove(sysdev);
 271         }
 272         mutex_unlock(&sysdev_drivers_lock);
 273
 274         kobject_unregister(&sysdev->kobj);
 275 }
 276
 277
 278
 279 /**
 280  *      sysdev_shutdown - Shut down all system devices.
 281  *
 282  *      Loop over each class of system devices, and the devices in each
 283  *      of those classes. For each device, we call the shutdown method for
 284  *      each driver registered for the device - the auxillaries,
 285  *      and the class driver.
 286  *
 287  *      Note: The list is iterated in reverse order, so that we shut down
 288  *      child devices before we shut down thier parents. The list ordering
 289  *      is guaranteed by virtue of the fact that child devices are registered
 290  *      after their parents.
 291  */
 292
 293 void sysdev_shutdown(void)
 294 {
 295         struct sysdev_class * cls;
 296
 297         pr_debug("Shutting Down System Devices\n");
 298
 299         mutex_lock(&sysdev_drivers_lock);
 300         list_for_each_entry_reverse(cls, &system_subsys.list,
 301                                     kset.kobj.entry) {
 302                 struct sys_device * sysdev;
 303
 304                 pr_debug("Shutting down type '%s':\n",
 305                          kobject_name(&cls->kset.kobj));
 306
 307                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
 308                         struct sysdev_driver * drv;
 309                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
 310
 311                         /* Call auxillary drivers first */
 312                         list_for_each_entry(drv, &cls->drivers, entry) {
 313                                 if (drv->shutdown)
 314                                         drv->shutdown(sysdev);
 315                         }
 316
 317                         /* Now call the generic one */
 318                         if (cls->shutdown)
 319                                 cls->shutdown(sysdev);
 320                 }
 321         }
 322         mutex_unlock(&sysdev_drivers_lock);
 323 }
 324
 325 static void __sysdev_resume(struct sys_device *dev)
 326 {
 327         struct sysdev_class *cls = dev->cls;
 328         struct sysdev_driver *drv;
 329
 330         /* First, call the class-specific one */
 331         if (cls->resume)
 332                 cls->resume(dev);
 333
 334         /* Call auxillary drivers next. */
 335         list_for_each_entry(drv, &cls->drivers, entry) {
 336                 if (drv->resume)
 337                         drv->resume(dev);
 338         }
 339 }
 340
 341 /**
 342  *      sysdev_suspend - Suspend all system devices.
 343  *      @state:         Power state to enter.
 344  *
 345  *      We perform an almost identical operation as sys_device_shutdown()
 346  *      above, though calling ->suspend() instead. Interrupts are disabled
 347  *      when this called. Devices are responsible for both saving state and
 348  *      quiescing or powering down the device.
 349  *
 350  *      This is only called by the device PM core, so we let them handle
 351  *      all synchronization.
 352  */
 353
 354 int sysdev_suspend(pm_message_t state)
 355 {
 356         struct sysdev_class * cls;
 357         struct sys_device *sysdev, *err_dev;
 358         struct sysdev_driver *drv, *err_drv;
 359         int ret;
 360
 361         pr_debug("Suspending System Devices\n");
 362
 363         list_for_each_entry_reverse(cls, &system_subsys.list,
 364                                     kset.kobj.entry) {
 365
 366                 pr_debug("Suspending type '%s':\n",
 367                          kobject_name(&cls->kset.kobj));
 368
 369                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
 370                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
 371
 372                         /* Call auxillary drivers first */
 373                         list_for_each_entry(drv, &cls->drivers, entry) {
 374                                 if (drv->suspend) {
 375                                         ret = drv->suspend(sysdev, state);
 376                                         if (ret)
 377                                                 goto aux_driver;
 378                                 }
 379                         }
 380
 381                         /* Now call the generic one */
 382                         if (cls->suspend) {
 383                                 ret = cls->suspend(sysdev, state);
 384                                 if (ret)
 385                                         goto cls_driver;
 386                         }
 387                 }
 388         }
 389         return 0;
 390         /* resume current sysdev */
 391 cls_driver:
 392         drv = NULL;
 393         printk(KERN_ERR "Class suspend failed for %s\n",
 394                 kobject_name(&sysdev->kobj));
 395
 396 aux_driver:
 397         if (drv)
 398                 printk(KERN_ERR "Class driver suspend failed for %s\n",
 399                                 kobject_name(&sysdev->kobj));
 400         list_for_each_entry(err_drv, &cls->drivers, entry) {
 401                 if (err_drv == drv)
 402                         break;
 403                 if (err_drv->resume)
 404                         err_drv->resume(sysdev);
 405         }
 406
 407         /* resume other sysdevs in current class */
 408         list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
 409                 if (err_dev == sysdev)
 410                         break;
 411                 pr_debug(" %s\n", kobject_name(&err_dev->kobj));
 412                 __sysdev_resume(err_dev);
 413         }
 414
 415         /* resume other classes */
 416         list_for_each_entry_continue(cls, &system_subsys.list,
 417                                         kset.kobj.entry) {
 418                 list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
 419                         pr_debug(" %s\n", kobject_name(&err_dev->kobj));
 420                         __sysdev_resume(err_dev);
 421                 }
 422         }
 423         return ret;
 424 }
 425
 426
 427 /**
 428  *      sysdev_resume - Bring system devices back to life.
 429  *
 430  *      Similar to sys_device_suspend(), but we iterate the list forwards
 431  *      to guarantee that parent devices are resumed before their children.
 432  *
 433  *      Note: Interrupts are disabled when called.
 434  */
 435
 436 int sysdev_resume(void)
 437 {
 438         struct sysdev_class * cls;
 439
 440         pr_debug("Resuming System Devices\n");
 441
 442         list_for_each_entry(cls, &system_subsys.list, kset.kobj.entry) {
 443                 struct sys_device * sysdev;
 444
 445                 pr_debug("Resuming type '%s':\n",
 446                          kobject_name(&cls->kset.kobj));
 447
 448                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
 449                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
 450
 451                         __sysdev_resume(sysdev);
 452                 }
 453         }
 454         return 0;
 455 }
 456
 457
 458 int __init system_bus_init(void)
 459 {
 460         system_subsys.kobj.parent = &devices_kset->kobj;
 461         return subsystem_register(&system_subsys);
 462 }
 463
 464 EXPORT_SYMBOL_GPL(sysdev_register);
 465 EXPORT_SYMBOL_GPL(sysdev_unregister);