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
];
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
)
212 enclosure_link_name(cdev
, name
);
213 sysfs_remove_link(&cdev
->dev
->kobj
, name
);
214 sysfs_remove_link(&cdev
->cdev
.kobj
, "device");
217 static int enclosure_add_links(struct enclosure_component
*cdev
)
220 char name
[ENCLOSURE_NAME_SIZE
];
222 error
= sysfs_create_link(&cdev
->cdev
.kobj
, &cdev
->dev
->kobj
, "device");
226 enclosure_link_name(cdev
, name
);
227 error
= sysfs_create_link(&cdev
->dev
->kobj
, &cdev
->cdev
.kobj
, name
);
229 sysfs_remove_link(&cdev
->cdev
.kobj
, "device");
234 static void enclosure_release(struct device
*cdev
)
236 struct enclosure_device
*edev
= to_enclosure_device(cdev
);
238 put_device(cdev
->parent
);
242 static void enclosure_component_release(struct device
*dev
)
244 struct enclosure_component
*cdev
= to_enclosure_component(dev
);
247 enclosure_remove_links(cdev
);
248 put_device(cdev
->dev
);
250 put_device(dev
->parent
);
253 static struct enclosure_component
*
254 enclosure_component_find_by_name(struct enclosure_device
*edev
,
259 struct enclosure_component
*ecomp
;
261 if (!edev
|| !name
|| !name
[0])
264 for (i
= 0; i
< edev
->components
; i
++) {
265 ecomp
= &edev
->component
[i
];
266 cname
= dev_name(&ecomp
->cdev
);
267 if (ecomp
->number
!= -1 &&
269 !strcmp(cname
, name
))
276 static const struct attribute_group
*enclosure_component_groups
[];
279 * enclosure_component_alloc - prepare a new enclosure component
280 * @edev: the enclosure to add the component
281 * @num: the device number
282 * @type: the type of component being added
283 * @name: an optional name to appear in sysfs (leave NULL if none)
285 * The name is optional for enclosures that give their components a unique
286 * name. If not, leave the field NULL and a name will be assigned.
288 * Returns a pointer to the enclosure component or an error.
290 struct enclosure_component
*
291 enclosure_component_alloc(struct enclosure_device
*edev
,
293 enum enclosure_component_type type
,
296 struct enclosure_component
*ecomp
;
299 char newname
[COMPONENT_NAME_SIZE
];
301 if (number
>= edev
->components
)
302 return ERR_PTR(-EINVAL
);
304 ecomp
= &edev
->component
[number
];
306 if (ecomp
->number
!= -1)
307 return ERR_PTR(-EINVAL
);
310 ecomp
->number
= number
;
312 cdev
->parent
= get_device(&edev
->edev
);
314 if (name
&& name
[0]) {
315 /* Some hardware (e.g. enclosure in RX300 S6) has components
316 * with non unique names. Registering duplicates in sysfs
317 * will lead to warnings during bootup. So make the names
318 * unique by appending consecutive numbers -1, -2, ... */
320 snprintf(newname
, COMPONENT_NAME_SIZE
,
322 while (enclosure_component_find_by_name(edev
, newname
))
323 snprintf(newname
, COMPONENT_NAME_SIZE
,
325 dev_set_name(cdev
, "%s", newname
);
327 dev_set_name(cdev
, "%u", number
);
329 cdev
->release
= enclosure_component_release
;
330 cdev
->groups
= enclosure_component_groups
;
334 EXPORT_SYMBOL_GPL(enclosure_component_alloc
);
337 * enclosure_component_register - publishes an initialized enclosure component
338 * @ecomp: component to add
340 * Returns 0 on successful registration, releases the component otherwise
342 int enclosure_component_register(struct enclosure_component
*ecomp
)
348 err
= device_register(cdev
);
357 EXPORT_SYMBOL_GPL(enclosure_component_register
);
360 * enclosure_add_device - add a device as being part of an enclosure
361 * @edev: the enclosure device being added to.
362 * @num: the number of the component
363 * @dev: the device being added
365 * Declares a real device to reside in slot (or identifier) @num of an
366 * enclosure. This will cause the relevant sysfs links to appear.
367 * This function may also be used to change a device associated with
368 * an enclosure without having to call enclosure_remove_device() in
371 * Returns zero on success or an error.
373 int enclosure_add_device(struct enclosure_device
*edev
, int component
,
376 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
);
389 put_device(cdev
->dev
);
390 cdev
->dev
= get_device(dev
);
391 return enclosure_add_links(cdev
);
393 EXPORT_SYMBOL_GPL(enclosure_add_device
);
396 * enclosure_remove_device - remove a device from an enclosure
397 * @edev: the enclosure device
398 * @num: the number of the component to remove
400 * Returns zero on success or an error.
403 int enclosure_remove_device(struct enclosure_device
*edev
, struct device
*dev
)
405 struct enclosure_component
*cdev
;
411 for (i
= 0; i
< edev
->components
; i
++) {
412 cdev
= &edev
->component
[i
];
413 if (cdev
->dev
== dev
) {
414 enclosure_remove_links(cdev
);
415 device_del(&cdev
->cdev
);
418 return device_add(&cdev
->cdev
);
423 EXPORT_SYMBOL_GPL(enclosure_remove_device
);
429 static ssize_t
components_show(struct device
*cdev
,
430 struct device_attribute
*attr
, char *buf
)
432 struct enclosure_device
*edev
= to_enclosure_device(cdev
);
434 return snprintf(buf
, 40, "%d\n", edev
->components
);
436 static DEVICE_ATTR_RO(components
);
438 static ssize_t
id_show(struct device
*cdev
,
439 struct device_attribute
*attr
,
442 struct enclosure_device
*edev
= to_enclosure_device(cdev
);
444 if (edev
->cb
->show_id
)
445 return edev
->cb
->show_id(edev
, buf
);
448 static DEVICE_ATTR_RO(id
);
450 static struct attribute
*enclosure_class_attrs
[] = {
451 &dev_attr_components
.attr
,
455 ATTRIBUTE_GROUPS(enclosure_class
);
457 static struct class enclosure_class
= {
459 .owner
= THIS_MODULE
,
460 .dev_release
= enclosure_release
,
461 .dev_groups
= enclosure_class_groups
,
464 static const char *const enclosure_status
[] = {
465 [ENCLOSURE_STATUS_UNSUPPORTED
] = "unsupported",
466 [ENCLOSURE_STATUS_OK
] = "OK",
467 [ENCLOSURE_STATUS_CRITICAL
] = "critical",
468 [ENCLOSURE_STATUS_NON_CRITICAL
] = "non-critical",
469 [ENCLOSURE_STATUS_UNRECOVERABLE
] = "unrecoverable",
470 [ENCLOSURE_STATUS_NOT_INSTALLED
] = "not installed",
471 [ENCLOSURE_STATUS_UNKNOWN
] = "unknown",
472 [ENCLOSURE_STATUS_UNAVAILABLE
] = "unavailable",
473 [ENCLOSURE_STATUS_MAX
] = NULL
,
476 static const char *const enclosure_type
[] = {
477 [ENCLOSURE_COMPONENT_DEVICE
] = "device",
478 [ENCLOSURE_COMPONENT_ARRAY_DEVICE
] = "array device",
481 static ssize_t
get_component_fault(struct device
*cdev
,
482 struct device_attribute
*attr
, char *buf
)
484 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
485 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
487 if (edev
->cb
->get_fault
)
488 edev
->cb
->get_fault(edev
, ecomp
);
489 return snprintf(buf
, 40, "%d\n", ecomp
->fault
);
492 static ssize_t
set_component_fault(struct device
*cdev
,
493 struct device_attribute
*attr
,
494 const char *buf
, size_t count
)
496 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
497 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
498 int val
= simple_strtoul(buf
, NULL
, 0);
500 if (edev
->cb
->set_fault
)
501 edev
->cb
->set_fault(edev
, ecomp
, val
);
505 static ssize_t
get_component_status(struct device
*cdev
,
506 struct device_attribute
*attr
,char *buf
)
508 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
509 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
511 if (edev
->cb
->get_status
)
512 edev
->cb
->get_status(edev
, ecomp
);
513 return snprintf(buf
, 40, "%s\n", enclosure_status
[ecomp
->status
]);
516 static ssize_t
set_component_status(struct device
*cdev
,
517 struct device_attribute
*attr
,
518 const char *buf
, size_t count
)
520 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
521 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
524 for (i
= 0; enclosure_status
[i
]; i
++) {
525 if (strncmp(buf
, enclosure_status
[i
],
526 strlen(enclosure_status
[i
])) == 0 &&
527 (buf
[strlen(enclosure_status
[i
])] == '\n' ||
528 buf
[strlen(enclosure_status
[i
])] == '\0'))
532 if (enclosure_status
[i
] && edev
->cb
->set_status
) {
533 edev
->cb
->set_status(edev
, ecomp
, i
);
539 static ssize_t
get_component_active(struct device
*cdev
,
540 struct device_attribute
*attr
, char *buf
)
542 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
543 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
545 if (edev
->cb
->get_active
)
546 edev
->cb
->get_active(edev
, ecomp
);
547 return snprintf(buf
, 40, "%d\n", ecomp
->active
);
550 static ssize_t
set_component_active(struct device
*cdev
,
551 struct device_attribute
*attr
,
552 const char *buf
, size_t count
)
554 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
555 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
556 int val
= simple_strtoul(buf
, NULL
, 0);
558 if (edev
->cb
->set_active
)
559 edev
->cb
->set_active(edev
, ecomp
, val
);
563 static ssize_t
get_component_locate(struct device
*cdev
,
564 struct device_attribute
*attr
, char *buf
)
566 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
567 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
569 if (edev
->cb
->get_locate
)
570 edev
->cb
->get_locate(edev
, ecomp
);
571 return snprintf(buf
, 40, "%d\n", ecomp
->locate
);
574 static ssize_t
set_component_locate(struct device
*cdev
,
575 struct device_attribute
*attr
,
576 const char *buf
, size_t count
)
578 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
579 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
580 int val
= simple_strtoul(buf
, NULL
, 0);
582 if (edev
->cb
->set_locate
)
583 edev
->cb
->set_locate(edev
, ecomp
, val
);
587 static ssize_t
get_component_power_status(struct device
*cdev
,
588 struct device_attribute
*attr
,
591 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
592 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
594 if (edev
->cb
->get_power_status
)
595 edev
->cb
->get_power_status(edev
, ecomp
);
596 return snprintf(buf
, 40, "%s\n", ecomp
->power_status
? "on" : "off");
599 static ssize_t
set_component_power_status(struct device
*cdev
,
600 struct device_attribute
*attr
,
601 const char *buf
, size_t count
)
603 struct enclosure_device
*edev
= to_enclosure_device(cdev
->parent
);
604 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
607 if (strncmp(buf
, "on", 2) == 0 &&
608 (buf
[2] == '\n' || buf
[2] == '\0'))
610 else if (strncmp(buf
, "off", 3) == 0 &&
611 (buf
[3] == '\n' || buf
[3] == '\0'))
616 if (edev
->cb
->set_power_status
)
617 edev
->cb
->set_power_status(edev
, ecomp
, val
);
621 static ssize_t
get_component_type(struct device
*cdev
,
622 struct device_attribute
*attr
, char *buf
)
624 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
626 return snprintf(buf
, 40, "%s\n", enclosure_type
[ecomp
->type
]);
629 static ssize_t
get_component_slot(struct device
*cdev
,
630 struct device_attribute
*attr
, char *buf
)
632 struct enclosure_component
*ecomp
= to_enclosure_component(cdev
);
635 /* if the enclosure does not override then use 'number' as a stand-in */
636 if (ecomp
->slot
>= 0)
639 slot
= ecomp
->number
;
641 return snprintf(buf
, 40, "%d\n", slot
);
644 static DEVICE_ATTR(fault
, S_IRUGO
| S_IWUSR
, get_component_fault
,
645 set_component_fault
);
646 static DEVICE_ATTR(status
, S_IRUGO
| S_IWUSR
, get_component_status
,
647 set_component_status
);
648 static DEVICE_ATTR(active
, S_IRUGO
| S_IWUSR
, get_component_active
,
649 set_component_active
);
650 static DEVICE_ATTR(locate
, S_IRUGO
| S_IWUSR
, get_component_locate
,
651 set_component_locate
);
652 static DEVICE_ATTR(power_status
, S_IRUGO
| S_IWUSR
, get_component_power_status
,
653 set_component_power_status
);
654 static DEVICE_ATTR(type
, S_IRUGO
, get_component_type
, NULL
);
655 static DEVICE_ATTR(slot
, S_IRUGO
, get_component_slot
, NULL
);
657 static struct attribute
*enclosure_component_attrs
[] = {
658 &dev_attr_fault
.attr
,
659 &dev_attr_status
.attr
,
660 &dev_attr_active
.attr
,
661 &dev_attr_locate
.attr
,
662 &dev_attr_power_status
.attr
,
667 ATTRIBUTE_GROUPS(enclosure_component
);
669 static int __init
enclosure_init(void)
673 err
= class_register(&enclosure_class
);
680 static void __exit
enclosure_exit(void)
682 class_unregister(&enclosure_class
);
685 module_init(enclosure_init
);
686 module_exit(enclosure_exit
);
688 MODULE_AUTHOR("James Bottomley");
689 MODULE_DESCRIPTION("Enclosure Services");
690 MODULE_LICENSE("GPL v2");