4 * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
6 **-----------------------------------------------------------------------------
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.
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.
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.
21 **-----------------------------------------------------------------------------
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>
32 static LIST_HEAD(container_list);
33 static DEFINE_MUTEX(container_list_lock);
34 static struct class enclosure_class;
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)
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
54 struct enclosure_device *enclosure_find(struct device *dev,
55 struct enclosure_device *start)
57 struct enclosure_device *edev;
59 mutex_lock(&container_list_lock);
60 edev = list_prepare_entry(start, &container_list, node);
62 put_device(&start->edev);
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 */
70 get_device(&edev->edev);
71 mutex_unlock(&container_list_lock);
74 parent = parent->parent;
77 mutex_unlock(&container_list_lock);
81 EXPORT_SYMBOL_GPL(enclosure_find);
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
88 * Loops over all the enclosures calling the function.
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
95 int enclosure_for_each_device(int (*fn)(struct enclosure_device *, void *),
99 struct enclosure_device *edev;
101 mutex_lock(&container_list_lock);
102 list_for_each_entry(edev, &container_list, node) {
103 error = fn(edev, data);
107 mutex_unlock(&container_list_lock);
111 EXPORT_SYMBOL_GPL(enclosure_for_each_device);
114 * enclosure_register - register device as an enclosure
116 * @dev: device containing the enclosure
117 * @components: number of components in the enclosure
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
123 struct enclosure_device *
124 enclosure_register(struct device *dev, const char *name, int components,
125 struct enclosure_component_callbacks *cb)
127 struct enclosure_device *edev =
128 kzalloc(sizeof(struct enclosure_device) +
129 sizeof(struct enclosure_component)*components,
136 return ERR_PTR(-ENOMEM);
138 edev->components = components;
140 edev->edev.class = &enclosure_class;
141 edev->edev.parent = get_device(dev);
143 dev_set_name(&edev->edev, "%s", name);
144 err = device_register(&edev->edev);
148 for (i = 0; i < components; i++) {
149 edev->component[i].number = -1;
150 edev->component[i].slot = -1;
151 edev->component[i].power_status = -1;
154 mutex_lock(&container_list_lock);
155 list_add_tail(&edev->node, &container_list);
156 mutex_unlock(&container_list_lock);
161 put_device(edev->edev.parent);
165 EXPORT_SYMBOL_GPL(enclosure_register);
167 static struct enclosure_component_callbacks enclosure_null_callbacks;
170 * enclosure_unregister - remove an enclosure
172 * @edev: the registered enclosure to remove;
174 void enclosure_unregister(struct enclosure_device *edev)
178 mutex_lock(&container_list_lock);
179 list_del(&edev->node);
180 mutex_unlock(&container_list_lock);
182 for (i = 0; i < edev->components; i++)
183 if (edev->component[i].number != -1)
184 device_unregister(&edev->component[i].cdev);
186 /* prevent any callbacks into service user */
187 edev->cb = &enclosure_null_callbacks;
188 device_unregister(&edev->edev);
190 EXPORT_SYMBOL_GPL(enclosure_unregister);
192 #define ENCLOSURE_NAME_SIZE 64
193 #define COMPONENT_NAME_SIZE 64
195 static void enclosure_link_name(struct enclosure_component *cdev, char *name)
197 strcpy(name, "enclosure_device:");
198 strcat(name, dev_name(&cdev->cdev));
201 static void enclosure_remove_links(struct enclosure_component *cdev)
203 char name[ENCLOSURE_NAME_SIZE];
205 enclosure_link_name(cdev, name);
208 * In odd circumstances, like multipath devices, something else may
209 * already have removed the links, so check for this condition first.
211 if (cdev->dev->kobj.sd)
212 sysfs_remove_link(&cdev->dev->kobj, name);
214 if (cdev->cdev.kobj.sd)
215 sysfs_remove_link(&cdev->cdev.kobj, "device");
218 static int enclosure_add_links(struct enclosure_component *cdev)
221 char name[ENCLOSURE_NAME_SIZE];
223 error = sysfs_create_link(&cdev->cdev.kobj, &cdev->dev->kobj, "device");
227 enclosure_link_name(cdev, name);
228 error = sysfs_create_link(&cdev->dev->kobj, &cdev->cdev.kobj, name);
230 sysfs_remove_link(&cdev->cdev.kobj, "device");
235 static void enclosure_release(struct device *cdev)
237 struct enclosure_device *edev = to_enclosure_device(cdev);
239 put_device(cdev->parent);
243 static void enclosure_component_release(struct device *dev)
245 struct enclosure_component *cdev = to_enclosure_component(dev);
248 enclosure_remove_links(cdev);
249 put_device(cdev->dev);
251 put_device(dev->parent);
254 static struct enclosure_component *
255 enclosure_component_find_by_name(struct enclosure_device *edev,
260 struct enclosure_component *ecomp;
262 if (!edev || !name || !name[0])
265 for (i = 0; i < edev->components; i++) {
266 ecomp = &edev->component[i];
267 cname = dev_name(&ecomp->cdev);
268 if (ecomp->number != -1 &&
270 !strcmp(cname, name))
277 static const struct attribute_group *enclosure_component_groups[];
280 * enclosure_component_alloc - prepare a new enclosure component
281 * @edev: the enclosure to add the component
282 * @num: the device number
283 * @type: the type of component being added
284 * @name: an optional name to appear in sysfs (leave NULL if none)
286 * The name is optional for enclosures that give their components a unique
287 * name. If not, leave the field NULL and a name will be assigned.
289 * Returns a pointer to the enclosure component or an error.
291 struct enclosure_component *
292 enclosure_component_alloc(struct enclosure_device *edev,
294 enum enclosure_component_type type,
297 struct enclosure_component *ecomp;
300 char newname[COMPONENT_NAME_SIZE];
302 if (number >= edev->components)
303 return ERR_PTR(-EINVAL);
305 ecomp = &edev->component[number];
307 if (ecomp->number != -1)
308 return ERR_PTR(-EINVAL);
311 ecomp->number = number;
313 cdev->parent = get_device(&edev->edev);
315 if (name && name[0]) {
316 /* Some hardware (e.g. enclosure in RX300 S6) has components
317 * with non unique names. Registering duplicates in sysfs
318 * will lead to warnings during bootup. So make the names
319 * unique by appending consecutive numbers -1, -2, ... */
321 snprintf(newname, COMPONENT_NAME_SIZE,
323 while (enclosure_component_find_by_name(edev, newname))
324 snprintf(newname, COMPONENT_NAME_SIZE,
326 dev_set_name(cdev, "%s", newname);
328 dev_set_name(cdev, "%u", number);
330 cdev->release = enclosure_component_release;
331 cdev->groups = enclosure_component_groups;
335 EXPORT_SYMBOL_GPL(enclosure_component_alloc);
338 * enclosure_component_register - publishes an initialized enclosure component
339 * @ecomp: component to add
341 * Returns 0 on successful registration, releases the component otherwise
343 int enclosure_component_register(struct enclosure_component *ecomp)
349 err = device_register(cdev);
358 EXPORT_SYMBOL_GPL(enclosure_component_register);
361 * enclosure_add_device - add a device as being part of an enclosure
362 * @edev: the enclosure device being added to.
363 * @num: the number of the component
364 * @dev: the device being added
366 * Declares a real device to reside in slot (or identifier) @num of an
367 * enclosure. This will cause the relevant sysfs links to appear.
368 * This function may also be used to change a device associated with
369 * an enclosure without having to call enclosure_remove_device() in
372 * Returns zero on success or an error.
374 int enclosure_add_device(struct enclosure_device *edev, int component,
377 struct enclosure_component *cdev;
379 if (!edev || component >= edev->components)
382 cdev = &edev->component[component];
384 if (cdev->dev == dev)
388 enclosure_remove_links(cdev);
390 put_device(cdev->dev);
391 cdev->dev = get_device(dev);
392 return enclosure_add_links(cdev);
394 EXPORT_SYMBOL_GPL(enclosure_add_device);
397 * enclosure_remove_device - remove a device from an enclosure
398 * @edev: the enclosure device
399 * @num: the number of the component to remove
401 * Returns zero on success or an error.
404 int enclosure_remove_device(struct enclosure_device *edev, struct device *dev)
406 struct enclosure_component *cdev;
412 for (i = 0; i < edev->components; i++) {
413 cdev = &edev->component[i];
414 if (cdev->dev == dev) {
415 enclosure_remove_links(cdev);
416 device_del(&cdev->cdev);
419 return device_add(&cdev->cdev);
424 EXPORT_SYMBOL_GPL(enclosure_remove_device);
430 static ssize_t components_show(struct device *cdev,
431 struct device_attribute *attr, char *buf)
433 struct enclosure_device *edev = to_enclosure_device(cdev);
435 return snprintf(buf, 40, "%d\n", edev->components);
437 static DEVICE_ATTR_RO(components);
439 static ssize_t id_show(struct device *cdev,
440 struct device_attribute *attr,
443 struct enclosure_device *edev = to_enclosure_device(cdev);
445 if (edev->cb->show_id)
446 return edev->cb->show_id(edev, buf);
449 static DEVICE_ATTR_RO(id);
451 static struct attribute *enclosure_class_attrs[] = {
452 &dev_attr_components.attr,
456 ATTRIBUTE_GROUPS(enclosure_class);
458 static struct class enclosure_class = {
460 .owner = THIS_MODULE,
461 .dev_release = enclosure_release,
462 .dev_groups = enclosure_class_groups,
465 static const char *const enclosure_status [] = {
466 [ENCLOSURE_STATUS_UNSUPPORTED] = "unsupported",
467 [ENCLOSURE_STATUS_OK] = "OK",
468 [ENCLOSURE_STATUS_CRITICAL] = "critical",
469 [ENCLOSURE_STATUS_NON_CRITICAL] = "non-critical",
470 [ENCLOSURE_STATUS_UNRECOVERABLE] = "unrecoverable",
471 [ENCLOSURE_STATUS_NOT_INSTALLED] = "not installed",
472 [ENCLOSURE_STATUS_UNKNOWN] = "unknown",
473 [ENCLOSURE_STATUS_UNAVAILABLE] = "unavailable",
474 [ENCLOSURE_STATUS_MAX] = NULL,
477 static const char *const enclosure_type [] = {
478 [ENCLOSURE_COMPONENT_DEVICE] = "device",
479 [ENCLOSURE_COMPONENT_ARRAY_DEVICE] = "array device",
482 static ssize_t get_component_fault(struct device *cdev,
483 struct device_attribute *attr, char *buf)
485 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
486 struct enclosure_component *ecomp = to_enclosure_component(cdev);
488 if (edev->cb->get_fault)
489 edev->cb->get_fault(edev, ecomp);
490 return snprintf(buf, 40, "%d\n", ecomp->fault);
493 static ssize_t set_component_fault(struct device *cdev,
494 struct device_attribute *attr,
495 const char *buf, size_t count)
497 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
498 struct enclosure_component *ecomp = to_enclosure_component(cdev);
499 int val = simple_strtoul(buf, NULL, 0);
501 if (edev->cb->set_fault)
502 edev->cb->set_fault(edev, ecomp, val);
506 static ssize_t get_component_status(struct device *cdev,
507 struct device_attribute *attr,char *buf)
509 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
510 struct enclosure_component *ecomp = to_enclosure_component(cdev);
512 if (edev->cb->get_status)
513 edev->cb->get_status(edev, ecomp);
514 return snprintf(buf, 40, "%s\n", enclosure_status[ecomp->status]);
517 static ssize_t set_component_status(struct device *cdev,
518 struct device_attribute *attr,
519 const char *buf, size_t count)
521 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
522 struct enclosure_component *ecomp = to_enclosure_component(cdev);
525 for (i = 0; enclosure_status[i]; i++) {
526 if (strncmp(buf, enclosure_status[i],
527 strlen(enclosure_status[i])) == 0 &&
528 (buf[strlen(enclosure_status[i])] == '\n' ||
529 buf[strlen(enclosure_status[i])] == '\0'))
533 if (enclosure_status[i] && edev->cb->set_status) {
534 edev->cb->set_status(edev, ecomp, i);
540 static ssize_t get_component_active(struct device *cdev,
541 struct device_attribute *attr, char *buf)
543 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
544 struct enclosure_component *ecomp = to_enclosure_component(cdev);
546 if (edev->cb->get_active)
547 edev->cb->get_active(edev, ecomp);
548 return snprintf(buf, 40, "%d\n", ecomp->active);
551 static ssize_t set_component_active(struct device *cdev,
552 struct device_attribute *attr,
553 const char *buf, size_t count)
555 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
556 struct enclosure_component *ecomp = to_enclosure_component(cdev);
557 int val = simple_strtoul(buf, NULL, 0);
559 if (edev->cb->set_active)
560 edev->cb->set_active(edev, ecomp, val);
564 static ssize_t get_component_locate(struct device *cdev,
565 struct device_attribute *attr, char *buf)
567 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
568 struct enclosure_component *ecomp = to_enclosure_component(cdev);
570 if (edev->cb->get_locate)
571 edev->cb->get_locate(edev, ecomp);
572 return snprintf(buf, 40, "%d\n", ecomp->locate);
575 static ssize_t set_component_locate(struct device *cdev,
576 struct device_attribute *attr,
577 const char *buf, size_t count)
579 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
580 struct enclosure_component *ecomp = to_enclosure_component(cdev);
581 int val = simple_strtoul(buf, NULL, 0);
583 if (edev->cb->set_locate)
584 edev->cb->set_locate(edev, ecomp, val);
588 static ssize_t get_component_power_status(struct device *cdev,
589 struct device_attribute *attr,
592 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
593 struct enclosure_component *ecomp = to_enclosure_component(cdev);
595 if (edev->cb->get_power_status)
596 edev->cb->get_power_status(edev, ecomp);
598 /* If still uninitialized, the callback failed or does not exist. */
599 if (ecomp->power_status == -1)
600 return (edev->cb->get_power_status) ? -EIO : -ENOTTY;
602 return snprintf(buf, 40, "%s\n", ecomp->power_status ? "on" : "off");
605 static ssize_t set_component_power_status(struct device *cdev,
606 struct device_attribute *attr,
607 const char *buf, size_t count)
609 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
610 struct enclosure_component *ecomp = to_enclosure_component(cdev);
613 if (strncmp(buf, "on", 2) == 0 &&
614 (buf[2] == '\n' || buf[2] == '\0'))
616 else if (strncmp(buf, "off", 3) == 0 &&
617 (buf[3] == '\n' || buf[3] == '\0'))
622 if (edev->cb->set_power_status)
623 edev->cb->set_power_status(edev, ecomp, val);
627 static ssize_t get_component_type(struct device *cdev,
628 struct device_attribute *attr, char *buf)
630 struct enclosure_component *ecomp = to_enclosure_component(cdev);
632 return snprintf(buf, 40, "%s\n", enclosure_type[ecomp->type]);
635 static ssize_t get_component_slot(struct device *cdev,
636 struct device_attribute *attr, char *buf)
638 struct enclosure_component *ecomp = to_enclosure_component(cdev);
641 /* if the enclosure does not override then use 'number' as a stand-in */
642 if (ecomp->slot >= 0)
645 slot = ecomp->number;
647 return snprintf(buf, 40, "%d\n", slot);
650 static DEVICE_ATTR(fault, S_IRUGO | S_IWUSR, get_component_fault,
651 set_component_fault);
652 static DEVICE_ATTR(status, S_IRUGO | S_IWUSR, get_component_status,
653 set_component_status);
654 static DEVICE_ATTR(active, S_IRUGO | S_IWUSR, get_component_active,
655 set_component_active);
656 static DEVICE_ATTR(locate, S_IRUGO | S_IWUSR, get_component_locate,
657 set_component_locate);
658 static DEVICE_ATTR(power_status, S_IRUGO | S_IWUSR, get_component_power_status,
659 set_component_power_status);
660 static DEVICE_ATTR(type, S_IRUGO, get_component_type, NULL);
661 static DEVICE_ATTR(slot, S_IRUGO, get_component_slot, NULL);
663 static struct attribute *enclosure_component_attrs[] = {
664 &dev_attr_fault.attr,
665 &dev_attr_status.attr,
666 &dev_attr_active.attr,
667 &dev_attr_locate.attr,
668 &dev_attr_power_status.attr,
673 ATTRIBUTE_GROUPS(enclosure_component);
675 static int __init enclosure_init(void)
679 err = class_register(&enclosure_class);
686 static void __exit enclosure_exit(void)
688 class_unregister(&enclosure_class);
691 module_init(enclosure_init);
692 module_exit(enclosure_exit);
694 MODULE_AUTHOR("James Bottomley");
695 MODULE_DESCRIPTION("Enclosure Services");
696 MODULE_LICENSE("GPL v2");