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(struct_size(edev
, component
, components
), GFP_KERNEL
);
134 return ERR_PTR(-ENOMEM
);
136 edev
->components
= components
;
138 edev
->edev
.class = &enclosure_class
;
139 edev
->edev
.parent
= get_device(dev
);
141 dev_set_name(&edev
->edev
, "%s", name
);
142 err
= device_register(&edev
->edev
);
146 for (i
= 0; i
< components
; i
++) {
147 edev
->component
[i
].number
= -1;
148 edev
->component
[i
].slot
= -1;
149 edev
->component
[i
].power_status
= -1;
152 mutex_lock(&container_list_lock
);
153 list_add_tail(&edev
->node
, &container_list
);
154 mutex_unlock(&container_list_lock
);
159 put_device(edev
->edev
.parent
);
163 EXPORT_SYMBOL_GPL(enclosure_register
);
165 static struct enclosure_component_callbacks enclosure_null_callbacks
;
168 * enclosure_unregister - remove an enclosure
170 * @edev: the registered enclosure to remove;
172 void enclosure_unregister(struct enclosure_device
*edev
)
176 mutex_lock(&container_list_lock
);
177 list_del(&edev
->node
);
178 mutex_unlock(&container_list_lock
);
180 for (i
= 0; i
< edev
->components
; i
++)
181 if (edev
->component
[i
].number
!= -1)
182 device_unregister(&edev
->component
[i
].cdev
);
184 /* prevent any callbacks into service user */
185 edev
->cb
= &enclosure_null_callbacks
;
186 device_unregister(&edev
->edev
);
188 EXPORT_SYMBOL_GPL(enclosure_unregister
);
190 #define ENCLOSURE_NAME_SIZE 64
191 #define COMPONENT_NAME_SIZE 64
193 static void enclosure_link_name(struct enclosure_component
*cdev
, char *name
)
195 strcpy(name
, "enclosure_device:");
196 strcat(name
, dev_name(&cdev
->cdev
));
199 static void enclosure_remove_links(struct enclosure_component
*cdev
)
201 char name
[ENCLOSURE_NAME_SIZE
];
203 enclosure_link_name(cdev
, name
);
206 * In odd circumstances, like multipath devices, something else may
207 * already have removed the links, so check for this condition first.
209 if (cdev
->dev
->kobj
.sd
)
210 sysfs_remove_link(&cdev
->dev
->kobj
, name
);
212 if (cdev
->cdev
.kobj
.sd
)
213 sysfs_remove_link(&cdev
->cdev
.kobj
, "device");
216 static int enclosure_add_links(struct enclosure_component
*cdev
)
219 char name
[ENCLOSURE_NAME_SIZE
];
221 error
= sysfs_create_link(&cdev
->cdev
.kobj
, &cdev
->dev
->kobj
, "device");
225 enclosure_link_name(cdev
, name
);
226 error
= sysfs_create_link(&cdev
->dev
->kobj
, &cdev
->cdev
.kobj
, name
);
228 sysfs_remove_link(&cdev
->cdev
.kobj
, "device");
233 static void enclosure_release(struct device
*cdev
)
235 struct enclosure_device
*edev
= to_enclosure_device(cdev
);
237 put_device(cdev
->parent
);
241 static void enclosure_component_release(struct device
*dev
)
243 struct enclosure_component
*cdev
= to_enclosure_component(dev
);
246 enclosure_remove_links(cdev
);
247 put_device(cdev
->dev
);
249 put_device(dev
->parent
);
252 static struct enclosure_component
*
253 enclosure_component_find_by_name(struct enclosure_device
*edev
,
258 struct enclosure_component
*ecomp
;
260 if (!edev
|| !name
|| !name
[0])
263 for (i
= 0; i
< edev
->components
; i
++) {
264 ecomp
= &edev
->component
[i
];
265 cname
= dev_name(&ecomp
->cdev
);
266 if (ecomp
->number
!= -1 &&
268 !strcmp(cname
, name
))
275 static const struct attribute_group
*enclosure_component_groups
[];
278 * enclosure_component_alloc - prepare a new enclosure component
279 * @edev: the enclosure to add the component
280 * @num: the device number
281 * @type: the type of component being added
282 * @name: an optional name to appear in sysfs (leave NULL if none)
284 * The name is optional for enclosures that give their components a unique
285 * name. If not, leave the field NULL and a name will be assigned.
287 * Returns a pointer to the enclosure component or an error.
289 struct enclosure_component
*
290 enclosure_component_alloc(struct enclosure_device
*edev
,
292 enum enclosure_component_type type
,
295 struct enclosure_component
*ecomp
;
298 char newname
[COMPONENT_NAME_SIZE
];
300 if (number
>= edev
->components
)
301 return ERR_PTR(-EINVAL
);
303 ecomp
= &edev
->component
[number
];
305 if (ecomp
->number
!= -1)
306 return ERR_PTR(-EINVAL
);
309 ecomp
->number
= number
;
311 cdev
->parent
= get_device(&edev
->edev
);
313 if (name
&& name
[0]) {
314 /* Some hardware (e.g. enclosure in RX300 S6) has components
315 * with non unique names. Registering duplicates in sysfs
316 * will lead to warnings during bootup. So make the names
317 * unique by appending consecutive numbers -1, -2, ... */
319 snprintf(newname
, COMPONENT_NAME_SIZE
,
321 while (enclosure_component_find_by_name(edev
, newname
))
322 snprintf(newname
, COMPONENT_NAME_SIZE
,
324 dev_set_name(cdev
, "%s", newname
);
326 dev_set_name(cdev
, "%u", number
);
328 cdev
->release
= enclosure_component_release
;
329 cdev
->groups
= enclosure_component_groups
;
333 EXPORT_SYMBOL_GPL(enclosure_component_alloc
);
336 * enclosure_component_register - publishes an initialized enclosure component
337 * @ecomp: component to add
339 * Returns 0 on successful registration, releases the component otherwise
341 int enclosure_component_register(struct enclosure_component
*ecomp
)
347 err
= device_register(cdev
);
356 EXPORT_SYMBOL_GPL(enclosure_component_register
);
359 * enclosure_add_device - add a device as being part of an enclosure
360 * @edev: the enclosure device being added to.
361 * @num: the number of the component
362 * @dev: the device being added
364 * Declares a real device to reside in slot (or identifier) @num of an
365 * enclosure. This will cause the relevant sysfs links to appear.
366 * This function may also be used to change a device associated with
367 * an enclosure without having to call enclosure_remove_device() in
370 * Returns zero on success or an error.
372 int enclosure_add_device(struct enclosure_device
*edev
, int component
,
375 struct enclosure_component
*cdev
;
378 if (!edev
|| component
>= edev
->components
)
381 cdev
= &edev
->component
[component
];
383 if (cdev
->dev
== dev
)
387 enclosure_remove_links(cdev
);
388 put_device(cdev
->dev
);
390 cdev
->dev
= get_device(dev
);
391 err
= enclosure_add_links(cdev
);
393 put_device(cdev
->dev
);
398 EXPORT_SYMBOL_GPL(enclosure_add_device
);
401 * enclosure_remove_device - remove a device from an enclosure
402 * @edev: the enclosure device
403 * @num: the number of the component to remove
405 * Returns zero on success or an error.
408 int enclosure_remove_device(struct enclosure_device
*edev
, struct device
*dev
)
410 struct enclosure_component
*cdev
;
416 for (i
= 0; i
< edev
->components
; i
++) {
417 cdev
= &edev
->component
[i
];
418 if (cdev
->dev
== dev
) {
419 enclosure_remove_links(cdev
);
420 device_del(&cdev
->cdev
);
423 return device_add(&cdev
->cdev
);
428 EXPORT_SYMBOL_GPL(enclosure_remove_device
);
434 static ssize_t
components_show(struct device
*cdev
,
435 struct device_attribute
*attr
, char *buf
)
437 struct enclosure_device
*edev
= to_enclosure_device(cdev
);
439 return snprintf(buf
, 40, "%d\n", edev
->components
);
441 static DEVICE_ATTR_RO(components
);
443 static ssize_t
id_show(struct device
*cdev
,
444 struct device_attribute
*attr
,
447 struct enclosure_device
*edev
= to_enclosure_device(cdev
);
449 if (edev
->cb
->show_id
)
450 return edev
->cb
->show_id(edev
, buf
);
453 static DEVICE_ATTR_RO(id
);
455 static struct attribute
*enclosure_class_attrs
[] = {
456 &dev_attr_components
.attr
,
460 ATTRIBUTE_GROUPS(enclosure_class
);
462 static struct class enclosure_class
= {
464 .owner
= THIS_MODULE
,
465 .dev_release
= enclosure_release
,
466 .dev_groups
= enclosure_class_groups
,
469 static const char *const enclosure_status
[] = {
470 [ENCLOSURE_STATUS_UNSUPPORTED
] = "unsupported",
471 [ENCLOSURE_STATUS_OK
] = "OK",
472 [ENCLOSURE_STATUS_CRITICAL
] = "critical",
473 [ENCLOSURE_STATUS_NON_CRITICAL
] = "non-critical",
474 [ENCLOSURE_STATUS_UNRECOVERABLE
] = "unrecoverable",
475 [ENCLOSURE_STATUS_NOT_INSTALLED
] = "not installed",
476 [ENCLOSURE_STATUS_UNKNOWN
] = "unknown",
477 [ENCLOSURE_STATUS_UNAVAILABLE
] = "unavailable",
478 [ENCLOSURE_STATUS_MAX
] = NULL
,
481 static const char *const enclosure_type
[] = {
482 [ENCLOSURE_COMPONENT_DEVICE
] = "device",
483 [ENCLOSURE_COMPONENT_ARRAY_DEVICE
] = "array device",
486 static ssize_t
get_component_fault(struct device
*cdev
,
487 struct device_attribute
*attr
, char *buf
)
489 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
490 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
492 if (edev
->cb
->get_fault
)
493 edev
->cb
->get_fault(edev
, ecomp
);
494 return snprintf(buf
, 40, "%d\n", ecomp
->fault
);
497 static ssize_t
set_component_fault(struct device
*cdev
,
498 struct device_attribute
*attr
,
499 const char *buf
, size_t count
)
501 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
502 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
503 int val
= simple_strtoul(buf
, NULL
, 0);
505 if (edev
->cb
->set_fault
)
506 edev
->cb
->set_fault(edev
, ecomp
, val
);
510 static ssize_t
get_component_status(struct device
*cdev
,
511 struct device_attribute
*attr
,char *buf
)
513 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
514 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
516 if (edev
->cb
->get_status
)
517 edev
->cb
->get_status(edev
, ecomp
);
518 return snprintf(buf
, 40, "%s\n", enclosure_status
[ecomp
->status
]);
521 static ssize_t
set_component_status(struct device
*cdev
,
522 struct device_attribute
*attr
,
523 const char *buf
, size_t count
)
525 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
526 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
529 for (i
= 0; enclosure_status
[i
]; i
++) {
530 if (strncmp(buf
, enclosure_status
[i
],
531 strlen(enclosure_status
[i
])) == 0 &&
532 (buf
[strlen(enclosure_status
[i
])] == '\n' ||
533 buf
[strlen(enclosure_status
[i
])] == '\0'))
537 if (enclosure_status
[i
] && edev
->cb
->set_status
) {
538 edev
->cb
->set_status(edev
, ecomp
, i
);
544 static ssize_t
get_component_active(struct device
*cdev
,
545 struct device_attribute
*attr
, char *buf
)
547 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
548 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
550 if (edev
->cb
->get_active
)
551 edev
->cb
->get_active(edev
, ecomp
);
552 return snprintf(buf
, 40, "%d\n", ecomp
->active
);
555 static ssize_t
set_component_active(struct device
*cdev
,
556 struct device_attribute
*attr
,
557 const char *buf
, size_t count
)
559 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
560 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
561 int val
= simple_strtoul(buf
, NULL
, 0);
563 if (edev
->cb
->set_active
)
564 edev
->cb
->set_active(edev
, ecomp
, val
);
568 static ssize_t
get_component_locate(struct device
*cdev
,
569 struct device_attribute
*attr
, char *buf
)
571 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
572 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
574 if (edev
->cb
->get_locate
)
575 edev
->cb
->get_locate(edev
, ecomp
);
576 return snprintf(buf
, 40, "%d\n", ecomp
->locate
);
579 static ssize_t
set_component_locate(struct device
*cdev
,
580 struct device_attribute
*attr
,
581 const char *buf
, size_t count
)
583 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
584 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
585 int val
= simple_strtoul(buf
, NULL
, 0);
587 if (edev
->cb
->set_locate
)
588 edev
->cb
->set_locate(edev
, ecomp
, val
);
592 static ssize_t
get_component_power_status(struct device
*cdev
,
593 struct device_attribute
*attr
,
596 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
597 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
599 if (edev
->cb
->get_power_status
)
600 edev
->cb
->get_power_status(edev
, ecomp
);
602 /* If still uninitialized, the callback failed or does not exist. */
603 if (ecomp
->power_status
== -1)
604 return (edev
->cb
->get_power_status
) ? -EIO
: -ENOTTY
;
606 return snprintf(buf
, 40, "%s\n", ecomp
->power_status
? "on" : "off");
609 static ssize_t
set_component_power_status(struct device
*cdev
,
610 struct device_attribute
*attr
,
611 const char *buf
, size_t count
)
613 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
614 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
617 if (strncmp(buf
, "on", 2) == 0 &&
618 (buf
[2] == '\n' || buf
[2] == '\0'))
620 else if (strncmp(buf
, "off", 3) == 0 &&
621 (buf
[3] == '\n' || buf
[3] == '\0'))
626 if (edev
->cb
->set_power_status
)
627 edev
->cb
->set_power_status(edev
, ecomp
, val
);
631 static ssize_t
get_component_type(struct device
*cdev
,
632 struct device_attribute
*attr
, char *buf
)
634 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
636 return snprintf(buf
, 40, "%s\n", enclosure_type
[ecomp
->type
]);
639 static ssize_t
get_component_slot(struct device
*cdev
,
640 struct device_attribute
*attr
, char *buf
)
642 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
645 /* if the enclosure does not override then use 'number' as a stand-in */
646 if (ecomp
->slot
>= 0)
649 slot
= ecomp
->number
;
651 return snprintf(buf
, 40, "%d\n", slot
);
654 static DEVICE_ATTR(fault
, S_IRUGO
| S_IWUSR
, get_component_fault
,
655 set_component_fault
);
656 static DEVICE_ATTR(status
, S_IRUGO
| S_IWUSR
, get_component_status
,
657 set_component_status
);
658 static DEVICE_ATTR(active
, S_IRUGO
| S_IWUSR
, get_component_active
,
659 set_component_active
);
660 static DEVICE_ATTR(locate
, S_IRUGO
| S_IWUSR
, get_component_locate
,
661 set_component_locate
);
662 static DEVICE_ATTR(power_status
, S_IRUGO
| S_IWUSR
, get_component_power_status
,
663 set_component_power_status
);
664 static DEVICE_ATTR(type
, S_IRUGO
, get_component_type
, NULL
);
665 static DEVICE_ATTR(slot
, S_IRUGO
, get_component_slot
, NULL
);
667 static struct attribute
*enclosure_component_attrs
[] = {
668 &dev_attr_fault
.attr
,
669 &dev_attr_status
.attr
,
670 &dev_attr_active
.attr
,
671 &dev_attr_locate
.attr
,
672 &dev_attr_power_status
.attr
,
677 ATTRIBUTE_GROUPS(enclosure_component
);
679 static int __init
enclosure_init(void)
681 return class_register(&enclosure_class
);
684 static void __exit
enclosure_exit(void)
686 class_unregister(&enclosure_class
);
689 module_init(enclosure_init
);
690 module_exit(enclosure_exit
);
692 MODULE_AUTHOR("James Bottomley");
693 MODULE_DESCRIPTION("Enclosure Services");
694 MODULE_LICENSE("GPL v2");