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