drivers/s390/cio/ccwgroup.c

   1 /*
   2  *  drivers/s390/cio/ccwgroup.c
   3  *  bus driver for ccwgroup
   4  *   $Revision: 1.27 $
   5  *
   6  *    Copyright (C) 2002 IBM Deutschland Entwicklung GmbH,
   7  *                       IBM Corporation
   8  *    Author(s): Arnd Bergmann (arndb@de.ibm.com)
   9  *               Cornelia Huck (cohuck@de.ibm.com)
  10  */
  11 #include <linux/module.h>
  12 #include <linux/errno.h>
  13 #include <linux/slab.h>
  14 #include <linux/list.h>
  15 #include <linux/device.h>
  16 #include <linux/init.h>
  17 #include <linux/ctype.h>
  18 #include <linux/dcache.h>
  19
  20 #include <asm/semaphore.h>
  21 #include <asm/ccwdev.h>
  22 #include <asm/ccwgroup.h>
  23
  24 /* In Linux 2.4, we had a channel device layer called "chandev"
  25  * that did all sorts of obscure stuff for networking devices.
  26  * This is another driver that serves as a replacement for just
  27  * one of its functions, namely the translation of single subchannels
  28  * to devices that use multiple subchannels.
  29  */
  30
  31 /* a device matches a driver if all its slave devices match the same
  32  * entry of the driver */
  33 static int
  34 ccwgroup_bus_match (struct device * dev, struct device_driver * drv)
  35 {
  36         struct ccwgroup_device *gdev;
  37         struct ccwgroup_driver *gdrv;
  38
  39         gdev = container_of(dev, struct ccwgroup_device, dev);
  40         gdrv = container_of(drv, struct ccwgroup_driver, driver);
  41
  42         if (gdev->creator_id == gdrv->driver_id)
  43                 return 1;
  44
  45         return 0;
  46 }
  47 static int
  48 ccwgroup_hotplug (struct device *dev, char **envp, int num_envp, char *buffer,
  49                   int buffer_size)
  50 {
  51         /* TODO */
  52         return 0;
  53 }
  54
  55 static struct bus_type ccwgroup_bus_type = {
  56         .name    = "ccwgroup",
  57         .match   = ccwgroup_bus_match,
  58         .hotplug = ccwgroup_hotplug,
  59 };
  60
  61 static inline void
  62 __ccwgroup_remove_symlinks(struct ccwgroup_device *gdev)
  63 {
  64         int i;
  65         char str[8];
  66
  67         for (i = 0; i < gdev->count; i++) {
  68                 sprintf(str, "cdev%d", i);
  69                 sysfs_remove_link(&gdev->dev.kobj, str);
  70                 sysfs_remove_link(&gdev->cdev[i]->dev.kobj, "group_device");
  71         }
  72
  73 }
  74
  75 /*
  76  * Provide an 'ungroup' attribute so the user can remove group devices no
  77  * longer needed or accidentially created. Saves memory :)
  78  */
  79 static ssize_t
  80 ccwgroup_ungroup_store(struct device *dev, const char *buf, size_t count)
  81 {
  82         struct ccwgroup_device *gdev;
  83
  84         gdev = to_ccwgroupdev(dev);
  85
  86         if (gdev->state != CCWGROUP_OFFLINE)
  87                 return -EINVAL;
  88
  89         __ccwgroup_remove_symlinks(gdev);
  90         device_unregister(dev);
  91
  92         return count;
  93 }
  94
  95 static DEVICE_ATTR(ungroup, 0200, NULL, ccwgroup_ungroup_store);
  96
  97 static void
  98 ccwgroup_release (struct device *dev)
  99 {
 100         struct ccwgroup_device *gdev;
 101         int i;
 102
 103         gdev = to_ccwgroupdev(dev);
 104
 105         for (i = 0; i < gdev->count; i++) {
 106                 gdev->cdev[i]->dev.driver_data = NULL;
 107                 put_device(&gdev->cdev[i]->dev);
 108         }
 109         kfree(gdev);
 110 }
 111
 112 static inline int
 113 __ccwgroup_create_symlinks(struct ccwgroup_device *gdev)
 114 {
 115         char str[8];
 116         int i, rc;
 117
 118         for (i = 0; i < gdev->count; i++) {
 119                 rc = sysfs_create_link(&gdev->cdev[i]->dev.kobj, &gdev->dev.kobj,
 120                                        "group_device");
 121                 if (rc) {
 122                         for (--i; i >= 0; i--)
 123                                 sysfs_remove_link(&gdev->cdev[i]->dev.kobj,
 124                                                   "group_device");
 125                         return rc;
 126                 }
 127         }
 128         for (i = 0; i < gdev->count; i++) {
 129                 sprintf(str, "cdev%d", i);
 130                 rc = sysfs_create_link(&gdev->dev.kobj, &gdev->cdev[i]->dev.kobj,
 131                                        str);
 132                 if (rc) {
 133                         for (--i; i >= 0; i--) {
 134                                 sprintf(str, "cdev%d", i);
 135                                 sysfs_remove_link(&gdev->dev.kobj, str);
 136                         }
 137                         for (i = 0; i < gdev->count; i++)
 138                                 sysfs_remove_link(&gdev->cdev[i]->dev.kobj,
 139                                                   "group_device");
 140                         return rc;
 141                 }
 142         }
 143         return 0;
 144 }
 145
 146 /*
 147  * try to add a new ccwgroup device for one driver
 148  * argc and argv[] are a list of bus_id's of devices
 149  * belonging to the driver.
 150  */
 151 int
 152 ccwgroup_create(struct device *root,
 153                 unsigned int creator_id,
 154                 struct ccw_driver *cdrv,
 155                 int argc, char *argv[])
 156 {
 157         struct ccwgroup_device *gdev;
 158         int i;
 159         int rc;
 160         int del_drvdata;
 161
 162         if (argc > 256) /* disallow dumb users */
 163                 return -EINVAL;
 164
 165         gdev = kmalloc(sizeof(*gdev) + argc*sizeof(gdev->cdev[0]), GFP_KERNEL);
 166         if (!gdev)
 167                 return -ENOMEM;
 168
 169         memset(gdev, 0, sizeof(*gdev) + argc*sizeof(gdev->cdev[0]));
 170         atomic_set(&gdev->onoff, 0);
 171
 172         del_drvdata = 0;
 173         for (i = 0; i < argc; i++) {
 174                 gdev->cdev[i] = get_ccwdev_by_busid(cdrv, argv[i]);
 175
 176                 /* all devices have to be of the same type in
 177                  * order to be grouped */
 178                 if (!gdev->cdev[i]
 179                     || gdev->cdev[i]->id.driver_info !=
 180                     gdev->cdev[0]->id.driver_info) {
 181                         rc = -EINVAL;
 182                         goto error;
 183                 }
 184                 /* Don't allow a device to belong to more than one group. */
 185                 if (gdev->cdev[i]->dev.driver_data) {
 186                         rc = -EINVAL;
 187                         goto error;
 188                 }
 189         }
 190         for (i = 0; i < argc; i++)
 191                 gdev->cdev[i]->dev.driver_data = gdev;
 192         del_drvdata = 1;
 193
 194         *gdev = (struct ccwgroup_device) {
 195                 .creator_id = creator_id,
 196                 .count = argc,
 197                 .dev = {
 198                         .bus = &ccwgroup_bus_type,
 199                         .parent = root,
 200                         .release = ccwgroup_release,
 201                 },
 202         };
 203
 204         snprintf (gdev->dev.bus_id, BUS_ID_SIZE, "%s",
 205                         gdev->cdev[0]->dev.bus_id);
 206
 207         rc = device_register(&gdev->dev);
 208
 209         if (rc)
 210                 goto error;
 211
 212         rc = device_create_file(&gdev->dev, &dev_attr_ungroup);
 213
 214         if (rc) {
 215                 device_unregister(&gdev->dev);
 216                 goto error;
 217         }
 218
 219         rc = __ccwgroup_create_symlinks(gdev);
 220         if (!rc)
 221                 return 0;
 222
 223         device_remove_file(&gdev->dev, &dev_attr_ungroup);
 224         device_unregister(&gdev->dev);
 225 error:
 226         for (i = 0; i < argc; i++)
 227                 if (gdev->cdev[i]) {
 228                         put_device(&gdev->cdev[i]->dev);
 229                         if (del_drvdata)
 230                                 gdev->cdev[i]->dev.driver_data = NULL;
 231                 }
 232         kfree(gdev);
 233
 234         return rc;
 235 }
 236
 237 static int __init
 238 init_ccwgroup (void)
 239 {
 240         return bus_register (&ccwgroup_bus_type);
 241 }
 242
 243 static void __exit
 244 cleanup_ccwgroup (void)
 245 {
 246         bus_unregister (&ccwgroup_bus_type);
 247 }
 248
 249 module_init(init_ccwgroup);
 250 module_exit(cleanup_ccwgroup);
 251
 252 /************************** driver stuff ******************************/
 253
 254 static int
 255 ccwgroup_set_online(struct ccwgroup_device *gdev)
 256 {
 257         struct ccwgroup_driver *gdrv;
 258         int ret;
 259
 260         if (atomic_compare_and_swap(0, 1, &gdev->onoff))
 261                 return -EAGAIN;
 262         if (gdev->state == CCWGROUP_ONLINE) {
 263                 ret = 0;
 264                 goto out;
 265         }
 266         if (!gdev->dev.driver) {
 267                 ret = -EINVAL;
 268                 goto out;
 269         }
 270         gdrv = to_ccwgroupdrv (gdev->dev.driver);
 271         if ((ret = gdrv->set_online(gdev)))
 272                 goto out;
 273
 274         gdev->state = CCWGROUP_ONLINE;
 275  out:
 276         atomic_set(&gdev->onoff, 0);
 277         return ret;
 278 }
 279
 280 static int
 281 ccwgroup_set_offline(struct ccwgroup_device *gdev)
 282 {
 283         struct ccwgroup_driver *gdrv;
 284         int ret;
 285
 286         if (atomic_compare_and_swap(0, 1, &gdev->onoff))
 287                 return -EAGAIN;
 288         if (gdev->state == CCWGROUP_OFFLINE) {
 289                 ret = 0;
 290                 goto out;
 291         }
 292         if (!gdev->dev.driver) {
 293                 ret = -EINVAL;
 294                 goto out;
 295         }
 296         gdrv = to_ccwgroupdrv (gdev->dev.driver);
 297         if ((ret = gdrv->set_offline(gdev)))
 298                 goto out;
 299
 300         gdev->state = CCWGROUP_OFFLINE;
 301  out:
 302         atomic_set(&gdev->onoff, 0);
 303         return ret;
 304 }
 305
 306 static ssize_t
 307 ccwgroup_online_store (struct device *dev, const char *buf, size_t count)
 308 {
 309         struct ccwgroup_device *gdev;
 310         struct ccwgroup_driver *gdrv;
 311         unsigned int value;
 312         int ret;
 313
 314         gdev = to_ccwgroupdev(dev);
 315         if (!dev->driver)
 316                 return count;
 317
 318         gdrv = to_ccwgroupdrv (gdev->dev.driver);
 319         if (!try_module_get(gdrv->owner))
 320                 return -EINVAL;
 321
 322         value = simple_strtoul(buf, 0, 0);
 323         ret = count;
 324         if (value == 1)
 325                 ccwgroup_set_online(gdev);
 326         else if (value == 0)
 327                 ccwgroup_set_offline(gdev);
 328         else
 329                 ret = -EINVAL;
 330         module_put(gdrv->owner);
 331         return ret;
 332 }
 333
 334 static ssize_t
 335 ccwgroup_online_show (struct device *dev, char *buf)
 336 {
 337         int online;
 338
 339         online = (to_ccwgroupdev(dev)->state == CCWGROUP_ONLINE);
 340
 341         return sprintf(buf, online ? "1\n" : "0\n");
 342 }
 343
 344 static DEVICE_ATTR(online, 0644, ccwgroup_online_show, ccwgroup_online_store);
 345
 346 static int
 347 ccwgroup_probe (struct device *dev)
 348 {
 349         struct ccwgroup_device *gdev;
 350         struct ccwgroup_driver *gdrv;
 351
 352         int ret;
 353
 354         gdev = to_ccwgroupdev(dev);
 355         gdrv = to_ccwgroupdrv(dev->driver);
 356
 357         if ((ret = device_create_file(dev, &dev_attr_online)))
 358                 return ret;
 359
 360         pr_debug("%s: device %s\n", __func__, gdev->dev.bus_id);
 361         ret = gdrv->probe ? gdrv->probe(gdev) : -ENODEV;
 362         if (ret)
 363                 device_remove_file(dev, &dev_attr_online);
 364
 365         return ret;
 366 }
 367
 368 static int
 369 ccwgroup_remove (struct device *dev)
 370 {
 371         struct ccwgroup_device *gdev;
 372         struct ccwgroup_driver *gdrv;
 373
 374         gdev = to_ccwgroupdev(dev);
 375         gdrv = to_ccwgroupdrv(dev->driver);
 376
 377         pr_debug("%s: device %s\n", __func__, gdev->dev.bus_id);
 378
 379         device_remove_file(dev, &dev_attr_online);
 380
 381         if (gdrv && gdrv->remove)
 382                 gdrv->remove(gdev);
 383         return 0;
 384 }
 385
 386 int
 387 ccwgroup_driver_register (struct ccwgroup_driver *cdriver)
 388 {
 389         /* register our new driver with the core */
 390         cdriver->driver = (struct device_driver) {
 391                 .bus = &ccwgroup_bus_type,
 392                 .name = cdriver->name,
 393                 .probe = ccwgroup_probe,
 394                 .remove = ccwgroup_remove,
 395         };
 396
 397         return driver_register(&cdriver->driver);
 398 }
 399
 400 static inline struct device *
 401 __get_next_ccwgroup_device(struct device_driver *drv)
 402 {
 403         struct device *dev, *d;
 404
 405         down_read(&drv->bus->subsys.rwsem);
 406         dev = NULL;
 407         list_for_each_entry(d, &drv->devices, driver_list) {
 408                 dev = get_device(d);
 409                 if (dev)
 410                         break;
 411         }
 412         up_read(&drv->bus->subsys.rwsem);
 413         return dev;
 414 }
 415
 416 void
 417 ccwgroup_driver_unregister (struct ccwgroup_driver *cdriver)
 418 {
 419         struct device *dev;
 420
 421         /* We don't want ccwgroup devices to live longer than their driver. */
 422         get_driver(&cdriver->driver);
 423         while ((dev = __get_next_ccwgroup_device(&cdriver->driver))) {
 424                 __ccwgroup_remove_symlinks(to_ccwgroupdev(dev));
 425                 device_unregister(dev);
 426                 put_device(dev);
 427         };
 428         put_driver(&cdriver->driver);
 429         driver_unregister(&cdriver->driver);
 430 }
 431
 432 int
 433 ccwgroup_probe_ccwdev(struct ccw_device *cdev)
 434 {
 435         return 0;
 436 }
 437
 438 static inline struct ccwgroup_device *
 439 __ccwgroup_get_gdev_by_cdev(struct ccw_device *cdev)
 440 {
 441         struct ccwgroup_device *gdev;
 442
 443         if (cdev->dev.driver_data) {
 444                 gdev = (struct ccwgroup_device *)cdev->dev.driver_data;
 445                 if (get_device(&gdev->dev)) {
 446                         if (!list_empty(&gdev->dev.node))
 447                                 return gdev;
 448                         put_device(&gdev->dev);
 449                 }
 450                 return NULL;
 451         }
 452         return NULL;
 453 }
 454
 455 void
 456 ccwgroup_remove_ccwdev(struct ccw_device *cdev)
 457 {
 458         struct ccwgroup_device *gdev;
 459
 460         /* Ignore offlining errors, device is gone anyway. */
 461         ccw_device_set_offline(cdev);
 462         /* If one of its devices is gone, the whole group is done for. */
 463         gdev = __ccwgroup_get_gdev_by_cdev(cdev);
 464         if (gdev) {
 465                 __ccwgroup_remove_symlinks(gdev);
 466                 device_unregister(&gdev->dev);
 467                 put_device(&gdev->dev);
 468         }
 469 }
 470
 471 MODULE_LICENSE("GPL");
 472 EXPORT_SYMBOL(ccwgroup_driver_register);
 473 EXPORT_SYMBOL(ccwgroup_driver_unregister);
 474 EXPORT_SYMBOL(ccwgroup_create);
 475 EXPORT_SYMBOL(ccwgroup_probe_ccwdev);
 476 EXPORT_SYMBOL(ccwgroup_remove_ccwdev);