drivers/misc/enclosure.c

   1 /*
   2  * Enclosure Services
   3  *
   4  * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
   5  *
   6 **-----------------------------------------------------------------------------
   7 **
   8 **  This program is free software; you can redistribute it and/or
   9 **  modify it under the terms of the GNU General Public License
  10 **  version 2 as published by the Free Software Foundation.
  11 **
  12 **  This program is distributed in the hope that it will be useful,
  13 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 **  GNU General Public License for more details.
  16 **
  17 **  You should have received a copy of the GNU General Public License
  18 **  along with this program; if not, write to the Free Software
  19 **  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 **
  21 **-----------------------------------------------------------------------------
  22 */
  23 #include <linux/device.h>
  24 #include <linux/enclosure.h>
  25 #include <linux/err.h>
  26 #include <linux/list.h>
  27 #include <linux/kernel.h>
  28 #include <linux/module.h>
  29 #include <linux/mutex.h>
  30 #include <linux/slab.h>
  31
  32 static LIST_HEAD(container_list);
  33 static DEFINE_MUTEX(container_list_lock);
  34 static struct class enclosure_class;
  35
  36 /**
  37  * enclosure_find - find an enclosure given a parent device
  38  * @dev:        the parent to match against
  39  * @start:      Optional enclosure device to start from (NULL if none)
  40  *
  41  * Looks through the list of registered enclosures to find all those
  42  * with @dev as a parent.  Returns NULL if no enclosure is
  43  * found. @start can be used as a starting point to obtain multiple
  44  * enclosures per parent (should begin with NULL and then be set to
  45  * each returned enclosure device). Obtains a reference to the
  46  * enclosure class device which must be released with device_put().
  47  * If @start is not NULL, a reference must be taken on it which is
  48  * released before returning (this allows a loop through all
  49  * enclosures to exit with only the reference on the enclosure of
  50  * interest held).  Note that the @dev may correspond to the actual
  51  * device housing the enclosure, in which case no iteration via @start
  52  * is required.
  53  */
  54 struct enclosure_device *enclosure_find(struct device *dev,
  55                                         struct enclosure_device *start)
  56 {
  57         struct enclosure_device *edev;
  58
  59         mutex_lock(&container_list_lock);
  60         edev = list_prepare_entry(start, &container_list, node);
  61         if (start)
  62                 put_device(&start->edev);
  63
  64         list_for_each_entry_continue(edev, &container_list, node) {
  65                 struct device *parent = edev->edev.parent;
  66                 /* parent might not be immediate, so iterate up to
  67                  * the root of the tree if necessary */
  68                 while (parent) {
  69                         if (parent == dev) {
  70                                 get_device(&edev->edev);
  71                                 mutex_unlock(&container_list_lock);
  72                                 return edev;
  73                         }
  74                         parent = parent->parent;
  75                 }
  76         }
  77         mutex_unlock(&container_list_lock);
  78
  79         return NULL;
  80 }
  81 EXPORT_SYMBOL_GPL(enclosure_find);
  82
  83 /**
  84  * enclosure_for_each_device - calls a function for each enclosure
  85  * @fn:         the function to call
  86  * @data:       the data to pass to each call
  87  *
  88  * Loops over all the enclosures calling the function.
  89  *
  90  * Note, this function uses a mutex which will be held across calls to
  91  * @fn, so it must have non atomic context, and @fn may (although it
  92  * should not) sleep or otherwise cause the mutex to be held for
  93  * indefinite periods
  94  */
  95 int enclosure_for_each_device(int (*fn)(struct enclosure_device *, void *),
  96                               void *data)
  97 {
  98         int error = 0;
  99         struct enclosure_device *edev;
 100
 101         mutex_lock(&container_list_lock);
 102         list_for_each_entry(edev, &container_list, node) {
 103                 error = fn(edev, data);
 104                 if (error)
 105                         break;
 106         }
 107         mutex_unlock(&container_list_lock);
 108
 109         return error;
 110 }
 111 EXPORT_SYMBOL_GPL(enclosure_for_each_device);
 112
 113 /**
 114  * enclosure_register - register device as an enclosure
 115  *
 116  * @dev:        device containing the enclosure
 117  * @components: number of components in the enclosure
 118  *
 119  * This sets up the device for being an enclosure.  Note that @dev does
 120  * not have to be a dedicated enclosure device.  It may be some other type
 121  * of device that additionally responds to enclosure services
 122  */
 123 struct enclosure_device *
 124 enclosure_register(struct device *dev, const char *name, int components,
 125                    struct enclosure_component_callbacks *cb)
 126 {
 127         struct enclosure_device *edev =
 128                 kzalloc(sizeof(struct enclosure_device) +
 129                         sizeof(struct enclosure_component)*components,
 130                         GFP_KERNEL);
 131         int err, i;
 132
 133         BUG_ON(!cb);
 134
 135         if (!edev)
 136                 return ERR_PTR(-ENOMEM);
 137
 138         edev->components = components;
 139
 140         edev->edev.class = &enclosure_class;
 141         edev->edev.parent = get_device(dev);
 142         edev->cb = cb;
 143         dev_set_name(&edev->edev, "%s", name);
 144         err = device_register(&edev->edev);
 145         if (err)
 146                 goto err;
 147
 148         for (i = 0; i < components; i++)
 149                 edev->component[i].number = -1;
 150
 151         mutex_lock(&container_list_lock);
 152         list_add_tail(&edev->node, &container_list);
 153         mutex_unlock(&container_list_lock);
 154
 155         return edev;
 156
 157  err:
 158         put_device(edev->edev.parent);
 159         kfree(edev);
 160         return ERR_PTR(err);
 161 }
 162 EXPORT_SYMBOL_GPL(enclosure_register);
 163
 164 static struct enclosure_component_callbacks enclosure_null_callbacks;
 165
 166 /**
 167  * enclosure_unregister - remove an enclosure
 168  *
 169  * @edev:       the registered enclosure to remove;
 170  */
 171 void enclosure_unregister(struct enclosure_device *edev)
 172 {
 173         int i;
 174
 175         mutex_lock(&container_list_lock);
 176         list_del(&edev->node);
 177         mutex_unlock(&container_list_lock);
 178
 179         for (i = 0; i < edev->components; i++)
 180                 if (edev->component[i].number != -1)
 181                         device_unregister(&edev->component[i].cdev);
 182
 183         /* prevent any callbacks into service user */
 184         edev->cb = &enclosure_null_callbacks;
 185         device_unregister(&edev->edev);
 186 }
 187 EXPORT_SYMBOL_GPL(enclosure_unregister);
 188
 189 #define ENCLOSURE_NAME_SIZE     64
 190 #define COMPONENT_NAME_SIZE     64
 191
 192 static void enclosure_link_name(struct enclosure_component *cdev, char *name)
 193 {
 194         strcpy(name, "enclosure_device:");
 195         strcat(name, dev_name(&cdev->cdev));
 196 }
 197
 198 static void enclosure_remove_links(struct enclosure_component *cdev)
 199 {
 200         char name[ENCLOSURE_NAME_SIZE];
 201
 202         /*
 203          * In odd circumstances, like multipath devices, something else may
 204          * already have removed the links, so check for this condition first.
 205          */
 206         if (!cdev->dev->kobj.sd)
 207                 return;
 208
 209         enclosure_link_name(cdev, name);
 210         sysfs_remove_link(&cdev->dev->kobj, name);
 211         sysfs_remove_link(&cdev->cdev.kobj, "device");
 212 }
 213
 214 static int enclosure_add_links(struct enclosure_component *cdev)
 215 {
 216         int error;
 217         char name[ENCLOSURE_NAME_SIZE];
 218
 219         error = sysfs_create_link(&cdev->cdev.kobj, &cdev->dev->kobj, "device");
 220         if (error)
 221                 return error;
 222
 223         enclosure_link_name(cdev, name);
 224         error = sysfs_create_link(&cdev->dev->kobj, &cdev->cdev.kobj, name);
 225         if (error)
 226                 sysfs_remove_link(&cdev->cdev.kobj, "device");
 227
 228         return error;
 229 }
 230
 231 static void enclosure_release(struct device *cdev)
 232 {
 233         struct enclosure_device *edev = to_enclosure_device(cdev);
 234
 235         put_device(cdev->parent);
 236         kfree(edev);
 237 }
 238
 239 static void enclosure_component_release(struct device *dev)
 240 {
 241         struct enclosure_component *cdev = to_enclosure_component(dev);
 242
 243         if (cdev->dev) {
 244                 enclosure_remove_links(cdev);
 245                 put_device(cdev->dev);
 246         }
 247         put_device(dev->parent);
 248 }
 249
 250 static struct enclosure_component *
 251 enclosure_component_find_by_name(struct enclosure_device *edev,
 252                                 const char *name)
 253 {
 254         int i;
 255         const char *cname;
 256         struct enclosure_component *ecomp;
 257
 258         if (!edev || !name || !name[0])
 259                 return NULL;
 260
 261         for (i = 0; i < edev->components; i++) {
 262                 ecomp = &edev->component[i];
 263                 cname = dev_name(&ecomp->cdev);
 264                 if (ecomp->number != -1 &&
 265                     cname && cname[0] &&
 266                     !strcmp(cname, name))
 267                         return ecomp;
 268         }
 269
 270         return NULL;
 271 }
 272
 273 static const struct attribute_group *enclosure_component_groups[];
 274
 275 /**
 276  * enclosure_component_alloc - prepare a new enclosure component
 277  * @edev:       the enclosure to add the component
 278  * @num:        the device number
 279  * @type:       the type of component being added
 280  * @name:       an optional name to appear in sysfs (leave NULL if none)
 281  *
 282  * The name is optional for enclosures that give their components a unique
 283  * name.  If not, leave the field NULL and a name will be assigned.
 284  *
 285  * Returns a pointer to the enclosure component or an error.
 286  */
 287 struct enclosure_component *
 288 enclosure_component_alloc(struct enclosure_device *edev,
 289                           unsigned int number,
 290                           enum enclosure_component_type type,
 291                           const char *name)
 292 {
 293         struct enclosure_component *ecomp;
 294         struct device *cdev;
 295         int i;
 296         char newname[COMPONENT_NAME_SIZE];
 297
 298         if (number >= edev->components)
 299                 return ERR_PTR(-EINVAL);
 300
 301         ecomp = &edev->component[number];
 302
 303         if (ecomp->number != -1)
 304                 return ERR_PTR(-EINVAL);
 305
 306         ecomp->type = type;
 307         ecomp->number = number;
 308         cdev = &ecomp->cdev;
 309         cdev->parent = get_device(&edev->edev);
 310
 311         if (name && name[0]) {
 312                 /* Some hardware (e.g. enclosure in RX300 S6) has components
 313                  * with non unique names. Registering duplicates in sysfs
 314                  * will lead to warnings during bootup. So make the names
 315                  * unique by appending consecutive numbers -1, -2, ... */
 316                 i = 1;
 317                 snprintf(newname, COMPONENT_NAME_SIZE,
 318                          "%s", name);
 319                 while (enclosure_component_find_by_name(edev, newname))
 320                         snprintf(newname, COMPONENT_NAME_SIZE,
 321                                  "%s-%i", name, i++);
 322                 dev_set_name(cdev, "%s", newname);
 323         } else
 324                 dev_set_name(cdev, "%u", number);
 325
 326         cdev->release = enclosure_component_release;
 327         cdev->groups = enclosure_component_groups;
 328
 329         return ecomp;
 330 }
 331 EXPORT_SYMBOL_GPL(enclosure_component_alloc);
 332
 333 /**
 334  * enclosure_component_register - publishes an initialized enclosure component
 335  * @ecomp:      component to add
 336  *
 337  * Returns 0 on successful registration, releases the component otherwise
 338  */
 339 int enclosure_component_register(struct enclosure_component *ecomp)
 340 {
 341         struct device *cdev;
 342         int err;
 343
 344         cdev = &ecomp->cdev;
 345         err = device_register(cdev);
 346         if (err) {
 347                 ecomp->number = -1;
 348                 put_device(cdev);
 349                 return err;
 350         }
 351
 352         return 0;
 353 }
 354 EXPORT_SYMBOL_GPL(enclosure_component_register);
 355
 356 /**
 357  * enclosure_add_device - add a device as being part of an enclosure
 358  * @edev:       the enclosure device being added to.
 359  * @num:        the number of the component
 360  * @dev:        the device being added
 361  *
 362  * Declares a real device to reside in slot (or identifier) @num of an
 363  * enclosure.  This will cause the relevant sysfs links to appear.
 364  * This function may also be used to change a device associated with
 365  * an enclosure without having to call enclosure_remove_device() in
 366  * between.
 367  *
 368  * Returns zero on success or an error.
 369  */
 370 int enclosure_add_device(struct enclosure_device *edev, int component,
 371                          struct device *dev)
 372 {
 373         struct enclosure_component *cdev;
 374
 375         if (!edev || component >= edev->components)
 376                 return -EINVAL;
 377
 378         cdev = &edev->component[component];
 379
 380         if (cdev->dev == dev)
 381                 return -EEXIST;
 382
 383         if (cdev->dev)
 384                 enclosure_remove_links(cdev);
 385
 386         put_device(cdev->dev);
 387         cdev->dev = get_device(dev);
 388         return enclosure_add_links(cdev);
 389 }
 390 EXPORT_SYMBOL_GPL(enclosure_add_device);
 391
 392 /**
 393  * enclosure_remove_device - remove a device from an enclosure
 394  * @edev:       the enclosure device
 395  * @num:        the number of the component to remove
 396  *
 397  * Returns zero on success or an error.
 398  *
 399  */
 400 int enclosure_remove_device(struct enclosure_device *edev, struct device *dev)
 401 {
 402         struct enclosure_component *cdev;
 403         int i;
 404
 405         if (!edev || !dev)
 406                 return -EINVAL;
 407
 408         for (i = 0; i < edev->components; i++) {
 409                 cdev = &edev->component[i];
 410                 if (cdev->dev == dev) {
 411                         enclosure_remove_links(cdev);
 412                         device_del(&cdev->cdev);
 413                         put_device(dev);
 414                         cdev->dev = NULL;
 415                         return device_add(&cdev->cdev);
 416                 }
 417         }
 418         return -ENODEV;
 419 }
 420 EXPORT_SYMBOL_GPL(enclosure_remove_device);
 421
 422 /*
 423  * sysfs pieces below
 424  */
 425
 426 static ssize_t components_show(struct device *cdev,
 427                                struct device_attribute *attr, char *buf)
 428 {
 429         struct enclosure_device *edev = to_enclosure_device(cdev);
 430
 431         return snprintf(buf, 40, "%d\n", edev->components);
 432 }
 433 static DEVICE_ATTR_RO(components);
 434
 435 static ssize_t id_show(struct device *cdev,
 436                                  struct device_attribute *attr,
 437                                  char *buf)
 438 {
 439         struct enclosure_device *edev = to_enclosure_device(cdev);
 440
 441         if (edev->cb->show_id)
 442                 return edev->cb->show_id(edev, buf);
 443         return -EINVAL;
 444 }
 445 static DEVICE_ATTR_RO(id);
 446
 447 static struct attribute *enclosure_class_attrs[] = {
 448         &dev_attr_components.attr,
 449         &dev_attr_id.attr,
 450         NULL,
 451 };
 452 ATTRIBUTE_GROUPS(enclosure_class);
 453
 454 static struct class enclosure_class = {
 455         .name                   = "enclosure",
 456         .owner                  = THIS_MODULE,
 457         .dev_release            = enclosure_release,
 458         .dev_groups             = enclosure_class_groups,
 459 };
 460
 461 static const char *const enclosure_status [] = {
 462         [ENCLOSURE_STATUS_UNSUPPORTED] = "unsupported",
 463         [ENCLOSURE_STATUS_OK] = "OK",
 464         [ENCLOSURE_STATUS_CRITICAL] = "critical",
 465         [ENCLOSURE_STATUS_NON_CRITICAL] = "non-critical",
 466         [ENCLOSURE_STATUS_UNRECOVERABLE] = "unrecoverable",
 467         [ENCLOSURE_STATUS_NOT_INSTALLED] = "not installed",
 468         [ENCLOSURE_STATUS_UNKNOWN] = "unknown",
 469         [ENCLOSURE_STATUS_UNAVAILABLE] = "unavailable",
 470         [ENCLOSURE_STATUS_MAX] = NULL,
 471 };
 472
 473 static const char *const enclosure_type [] = {
 474         [ENCLOSURE_COMPONENT_DEVICE] = "device",
 475         [ENCLOSURE_COMPONENT_ARRAY_DEVICE] = "array device",
 476 };
 477
 478 static ssize_t get_component_fault(struct device *cdev,
 479                                    struct device_attribute *attr, char *buf)
 480 {
 481         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
 482         struct enclosure_component *ecomp = to_enclosure_component(cdev);
 483
 484         if (edev->cb->get_fault)
 485                 edev->cb->get_fault(edev, ecomp);
 486         return snprintf(buf, 40, "%d\n", ecomp->fault);
 487 }
 488
 489 static ssize_t set_component_fault(struct device *cdev,
 490                                    struct device_attribute *attr,
 491                                    const char *buf, size_t count)
 492 {
 493         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
 494         struct enclosure_component *ecomp = to_enclosure_component(cdev);
 495         int val = simple_strtoul(buf, NULL, 0);
 496
 497         if (edev->cb->set_fault)
 498                 edev->cb->set_fault(edev, ecomp, val);
 499         return count;
 500 }
 501
 502 static ssize_t get_component_status(struct device *cdev,
 503                                     struct device_attribute *attr,char *buf)
 504 {
 505         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
 506         struct enclosure_component *ecomp = to_enclosure_component(cdev);
 507
 508         if (edev->cb->get_status)
 509                 edev->cb->get_status(edev, ecomp);
 510         return snprintf(buf, 40, "%s\n", enclosure_status[ecomp->status]);
 511 }
 512
 513 static ssize_t set_component_status(struct device *cdev,
 514                                     struct device_attribute *attr,
 515                                     const char *buf, size_t count)
 516 {
 517         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
 518         struct enclosure_component *ecomp = to_enclosure_component(cdev);
 519         int i;
 520
 521         for (i = 0; enclosure_status[i]; i++) {
 522                 if (strncmp(buf, enclosure_status[i],
 523                             strlen(enclosure_status[i])) == 0 &&
 524                     (buf[strlen(enclosure_status[i])] == '\n' ||
 525                      buf[strlen(enclosure_status[i])] == '\0'))
 526                         break;
 527         }
 528
 529         if (enclosure_status[i] && edev->cb->set_status) {
 530                 edev->cb->set_status(edev, ecomp, i);
 531                 return count;
 532         } else
 533                 return -EINVAL;
 534 }
 535
 536 static ssize_t get_component_active(struct device *cdev,
 537                                     struct device_attribute *attr, char *buf)
 538 {
 539         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
 540         struct enclosure_component *ecomp = to_enclosure_component(cdev);
 541
 542         if (edev->cb->get_active)
 543                 edev->cb->get_active(edev, ecomp);
 544         return snprintf(buf, 40, "%d\n", ecomp->active);
 545 }
 546
 547 static ssize_t set_component_active(struct device *cdev,
 548                                     struct device_attribute *attr,
 549                                     const char *buf, size_t count)
 550 {
 551         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
 552         struct enclosure_component *ecomp = to_enclosure_component(cdev);
 553         int val = simple_strtoul(buf, NULL, 0);
 554
 555         if (edev->cb->set_active)
 556                 edev->cb->set_active(edev, ecomp, val);
 557         return count;
 558 }
 559
 560 static ssize_t get_component_locate(struct device *cdev,
 561                                     struct device_attribute *attr, char *buf)
 562 {
 563         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
 564         struct enclosure_component *ecomp = to_enclosure_component(cdev);
 565
 566         if (edev->cb->get_locate)
 567                 edev->cb->get_locate(edev, ecomp);
 568         return snprintf(buf, 40, "%d\n", ecomp->locate);
 569 }
 570
 571 static ssize_t set_component_locate(struct device *cdev,
 572                                     struct device_attribute *attr,
 573                                     const char *buf, size_t count)
 574 {
 575         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
 576         struct enclosure_component *ecomp = to_enclosure_component(cdev);
 577         int val = simple_strtoul(buf, NULL, 0);
 578
 579         if (edev->cb->set_locate)
 580                 edev->cb->set_locate(edev, ecomp, val);
 581         return count;
 582 }
 583
 584 static ssize_t get_component_type(struct device *cdev,
 585                                   struct device_attribute *attr, char *buf)
 586 {
 587         struct enclosure_component *ecomp = to_enclosure_component(cdev);
 588
 589         return snprintf(buf, 40, "%s\n", enclosure_type[ecomp->type]);
 590 }
 591
 592
 593 static DEVICE_ATTR(fault, S_IRUGO | S_IWUSR, get_component_fault,
 594                     set_component_fault);
 595 static DEVICE_ATTR(status, S_IRUGO | S_IWUSR, get_component_status,
 596                    set_component_status);
 597 static DEVICE_ATTR(active, S_IRUGO | S_IWUSR, get_component_active,
 598                    set_component_active);
 599 static DEVICE_ATTR(locate, S_IRUGO | S_IWUSR, get_component_locate,
 600                    set_component_locate);
 601 static DEVICE_ATTR(type, S_IRUGO, get_component_type, NULL);
 602
 603 static struct attribute *enclosure_component_attrs[] = {
 604         &dev_attr_fault.attr,
 605         &dev_attr_status.attr,
 606         &dev_attr_active.attr,
 607         &dev_attr_locate.attr,
 608         &dev_attr_type.attr,
 609         NULL
 610 };
 611 ATTRIBUTE_GROUPS(enclosure_component);
 612
 613 static int __init enclosure_init(void)
 614 {
 615         int err;
 616
 617         err = class_register(&enclosure_class);
 618         if (err)
 619                 return err;
 620
 621         return 0;
 622 }
 623
 624 static void __exit enclosure_exit(void)
 625 {
 626         class_unregister(&enclosure_class);
 627 }
 628
 629 module_init(enclosure_init);
 630 module_exit(enclosure_exit);
 631
 632 MODULE_AUTHOR("James Bottomley");
 633 MODULE_DESCRIPTION("Enclosure Services");
 634 MODULE_LICENSE("GPL v2");