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>
31 static LIST_HEAD(container_list);
32 static DEFINE_MUTEX(container_list_lock);
33 static struct class enclosure_class;
36 * enclosure_find - find an enclosure given a parent device
37 * @dev: the parent to match against
38 * @start: Optional enclosure device to start from (NULL if none)
40 * Looks through the list of registered enclosures to find all those
41 * with @dev as a parent. Returns NULL if no enclosure is
42 * found. @start can be used as a starting point to obtain multiple
43 * enclosures per parent (should begin with NULL and then be set to
44 * each returned enclosure device). Obtains a reference to the
45 * enclosure class device which must be released with device_put().
46 * If @start is not NULL, a reference must be taken on it which is
47 * released before returning (this allows a loop through all
48 * enclosures to exit with only the reference on the enclosure of
49 * interest held). Note that the @dev may correspond to the actual
50 * device housing the enclosure, in which case no iteration via @start
53 struct enclosure_device *enclosure_find(struct device *dev,
54 struct enclosure_device *start)
56 struct enclosure_device *edev;
58 mutex_lock(&container_list_lock);
59 edev = list_prepare_entry(start, &container_list, node);
61 put_device(&start->edev);
63 list_for_each_entry_continue(edev, &container_list, node) {
64 struct device *parent = edev->edev.parent;
65 /* parent might not be immediate, so iterate up to
66 * the root of the tree if necessary */
69 get_device(&edev->edev);
70 mutex_unlock(&container_list_lock);
73 parent = parent->parent;
76 mutex_unlock(&container_list_lock);
80 EXPORT_SYMBOL_GPL(enclosure_find);
83 * enclosure_for_each_device - calls a function for each enclosure
84 * @fn: the function to call
85 * @data: the data to pass to each call
87 * Loops over all the enclosures calling the function.
89 * Note, this function uses a mutex which will be held across calls to
90 * @fn, so it must have non atomic context, and @fn may (although it
91 * should not) sleep or otherwise cause the mutex to be held for
94 int enclosure_for_each_device(int (*fn)(struct enclosure_device *, void *),
98 struct enclosure_device *edev;
100 mutex_lock(&container_list_lock);
101 list_for_each_entry(edev, &container_list, node) {
102 error = fn(edev, data);
106 mutex_unlock(&container_list_lock);
110 EXPORT_SYMBOL_GPL(enclosure_for_each_device);
113 * enclosure_register - register device as an enclosure
115 * @dev: device containing the enclosure
116 * @components: number of components in the enclosure
118 * This sets up the device for being an enclosure. Note that @dev does
119 * not have to be a dedicated enclosure device. It may be some other type
120 * of device that additionally responds to enclosure services
122 struct enclosure_device *
123 enclosure_register(struct device *dev, const char *name, int components,
124 struct enclosure_component_callbacks *cb)
126 struct enclosure_device *edev =
127 kzalloc(sizeof(struct enclosure_device) +
128 sizeof(struct enclosure_component)*components,
135 return ERR_PTR(-ENOMEM);
137 edev->components = components;
139 edev->edev.class = &enclosure_class;
140 edev->edev.parent = get_device(dev);
142 dev_set_name(&edev->edev, "%s", name);
143 err = device_register(&edev->edev);
147 for (i = 0; i < components; i++)
148 edev->component[i].number = -1;
150 mutex_lock(&container_list_lock);
151 list_add_tail(&edev->node, &container_list);
152 mutex_unlock(&container_list_lock);
157 put_device(edev->edev.parent);
161 EXPORT_SYMBOL_GPL(enclosure_register);
163 static struct enclosure_component_callbacks enclosure_null_callbacks;
166 * enclosure_unregister - remove an enclosure
168 * @edev: the registered enclosure to remove;
170 void enclosure_unregister(struct enclosure_device *edev)
174 mutex_lock(&container_list_lock);
175 list_del(&edev->node);
176 mutex_unlock(&container_list_lock);
178 for (i = 0; i < edev->components; i++)
179 if (edev->component[i].number != -1)
180 device_unregister(&edev->component[i].cdev);
182 /* prevent any callbacks into service user */
183 edev->cb = &enclosure_null_callbacks;
184 device_unregister(&edev->edev);
186 EXPORT_SYMBOL_GPL(enclosure_unregister);
188 #define ENCLOSURE_NAME_SIZE 64
190 static void enclosure_link_name(struct enclosure_component *cdev, char *name)
192 strcpy(name, "enclosure_device:");
193 strcat(name, dev_name(&cdev->cdev));
196 static void enclosure_remove_links(struct enclosure_component *cdev)
198 char name[ENCLOSURE_NAME_SIZE];
200 enclosure_link_name(cdev, name);
201 sysfs_remove_link(&cdev->dev->kobj, name);
202 sysfs_remove_link(&cdev->cdev.kobj, "device");
205 static int enclosure_add_links(struct enclosure_component *cdev)
208 char name[ENCLOSURE_NAME_SIZE];
210 error = sysfs_create_link(&cdev->cdev.kobj, &cdev->dev->kobj, "device");
214 enclosure_link_name(cdev, name);
215 error = sysfs_create_link(&cdev->dev->kobj, &cdev->cdev.kobj, name);
217 sysfs_remove_link(&cdev->cdev.kobj, "device");
222 static void enclosure_release(struct device *cdev)
224 struct enclosure_device *edev = to_enclosure_device(cdev);
226 put_device(cdev->parent);
230 static void enclosure_component_release(struct device *dev)
232 struct enclosure_component *cdev = to_enclosure_component(dev);
235 enclosure_remove_links(cdev);
236 put_device(cdev->dev);
238 put_device(dev->parent);
241 static const struct attribute_group *enclosure_groups[];
244 * enclosure_component_register - add a particular component to an enclosure
245 * @edev: the enclosure to add the component
246 * @num: the device number
247 * @type: the type of component being added
248 * @name: an optional name to appear in sysfs (leave NULL if none)
250 * Registers the component. The name is optional for enclosures that
251 * give their components a unique name. If not, leave the field NULL
252 * and a name will be assigned.
254 * Returns a pointer to the enclosure component or an error.
256 struct enclosure_component *
257 enclosure_component_register(struct enclosure_device *edev,
259 enum enclosure_component_type type,
262 struct enclosure_component *ecomp;
266 if (number >= edev->components)
267 return ERR_PTR(-EINVAL);
269 ecomp = &edev->component[number];
271 if (ecomp->number != -1)
272 return ERR_PTR(-EINVAL);
275 ecomp->number = number;
277 cdev->parent = get_device(&edev->edev);
279 dev_set_name(cdev, "%s", name);
281 dev_set_name(cdev, "%u", number);
283 cdev->release = enclosure_component_release;
284 cdev->groups = enclosure_groups;
286 err = device_register(cdev);
292 EXPORT_SYMBOL_GPL(enclosure_component_register);
295 * enclosure_add_device - add a device as being part of an enclosure
296 * @edev: the enclosure device being added to.
297 * @num: the number of the component
298 * @dev: the device being added
300 * Declares a real device to reside in slot (or identifier) @num of an
301 * enclosure. This will cause the relevant sysfs links to appear.
302 * This function may also be used to change a device associated with
303 * an enclosure without having to call enclosure_remove_device() in
306 * Returns zero on success or an error.
308 int enclosure_add_device(struct enclosure_device *edev, int component,
311 struct enclosure_component *cdev;
313 if (!edev || component >= edev->components)
316 cdev = &edev->component[component];
318 if (cdev->dev == dev)
322 enclosure_remove_links(cdev);
324 put_device(cdev->dev);
325 cdev->dev = get_device(dev);
326 return enclosure_add_links(cdev);
328 EXPORT_SYMBOL_GPL(enclosure_add_device);
331 * enclosure_remove_device - remove a device from an enclosure
332 * @edev: the enclosure device
333 * @num: the number of the component to remove
335 * Returns zero on success or an error.
338 int enclosure_remove_device(struct enclosure_device *edev, struct device *dev)
340 struct enclosure_component *cdev;
346 for (i = 0; i < edev->components; i++) {
347 cdev = &edev->component[i];
348 if (cdev->dev == dev) {
349 enclosure_remove_links(cdev);
350 device_del(&cdev->cdev);
353 return device_add(&cdev->cdev);
358 EXPORT_SYMBOL_GPL(enclosure_remove_device);
364 static ssize_t enclosure_show_components(struct device *cdev,
365 struct device_attribute *attr,
368 struct enclosure_device *edev = to_enclosure_device(cdev);
370 return snprintf(buf, 40, "%d\n", edev->components);
373 static struct device_attribute enclosure_attrs[] = {
374 __ATTR(components, S_IRUGO, enclosure_show_components, NULL),
378 static struct class enclosure_class = {
380 .owner = THIS_MODULE,
381 .dev_release = enclosure_release,
382 .dev_attrs = enclosure_attrs,
385 static const char *const enclosure_status [] = {
386 [ENCLOSURE_STATUS_UNSUPPORTED] = "unsupported",
387 [ENCLOSURE_STATUS_OK] = "OK",
388 [ENCLOSURE_STATUS_CRITICAL] = "critical",
389 [ENCLOSURE_STATUS_NON_CRITICAL] = "non-critical",
390 [ENCLOSURE_STATUS_UNRECOVERABLE] = "unrecoverable",
391 [ENCLOSURE_STATUS_NOT_INSTALLED] = "not installed",
392 [ENCLOSURE_STATUS_UNKNOWN] = "unknown",
393 [ENCLOSURE_STATUS_UNAVAILABLE] = "unavailable",
396 static const char *const enclosure_type [] = {
397 [ENCLOSURE_COMPONENT_DEVICE] = "device",
398 [ENCLOSURE_COMPONENT_ARRAY_DEVICE] = "array device",
401 static ssize_t get_component_fault(struct device *cdev,
402 struct device_attribute *attr, char *buf)
404 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
405 struct enclosure_component *ecomp = to_enclosure_component(cdev);
407 if (edev->cb->get_fault)
408 edev->cb->get_fault(edev, ecomp);
409 return snprintf(buf, 40, "%d\n", ecomp->fault);
412 static ssize_t set_component_fault(struct device *cdev,
413 struct device_attribute *attr,
414 const char *buf, size_t count)
416 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
417 struct enclosure_component *ecomp = to_enclosure_component(cdev);
418 int val = simple_strtoul(buf, NULL, 0);
420 if (edev->cb->set_fault)
421 edev->cb->set_fault(edev, ecomp, val);
425 static ssize_t get_component_status(struct device *cdev,
426 struct device_attribute *attr,char *buf)
428 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
429 struct enclosure_component *ecomp = to_enclosure_component(cdev);
431 if (edev->cb->get_status)
432 edev->cb->get_status(edev, ecomp);
433 return snprintf(buf, 40, "%s\n", enclosure_status[ecomp->status]);
436 static ssize_t set_component_status(struct device *cdev,
437 struct device_attribute *attr,
438 const char *buf, size_t count)
440 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
441 struct enclosure_component *ecomp = to_enclosure_component(cdev);
444 for (i = 0; enclosure_status[i]; i++) {
445 if (strncmp(buf, enclosure_status[i],
446 strlen(enclosure_status[i])) == 0 &&
447 (buf[strlen(enclosure_status[i])] == '\n' ||
448 buf[strlen(enclosure_status[i])] == '\0'))
452 if (enclosure_status[i] && edev->cb->set_status) {
453 edev->cb->set_status(edev, ecomp, i);
459 static ssize_t get_component_active(struct device *cdev,
460 struct device_attribute *attr, char *buf)
462 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
463 struct enclosure_component *ecomp = to_enclosure_component(cdev);
465 if (edev->cb->get_active)
466 edev->cb->get_active(edev, ecomp);
467 return snprintf(buf, 40, "%d\n", ecomp->active);
470 static ssize_t set_component_active(struct device *cdev,
471 struct device_attribute *attr,
472 const char *buf, size_t count)
474 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
475 struct enclosure_component *ecomp = to_enclosure_component(cdev);
476 int val = simple_strtoul(buf, NULL, 0);
478 if (edev->cb->set_active)
479 edev->cb->set_active(edev, ecomp, val);
483 static ssize_t get_component_locate(struct device *cdev,
484 struct device_attribute *attr, char *buf)
486 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
487 struct enclosure_component *ecomp = to_enclosure_component(cdev);
489 if (edev->cb->get_locate)
490 edev->cb->get_locate(edev, ecomp);
491 return snprintf(buf, 40, "%d\n", ecomp->locate);
494 static ssize_t set_component_locate(struct device *cdev,
495 struct device_attribute *attr,
496 const char *buf, size_t count)
498 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
499 struct enclosure_component *ecomp = to_enclosure_component(cdev);
500 int val = simple_strtoul(buf, NULL, 0);
502 if (edev->cb->set_locate)
503 edev->cb->set_locate(edev, ecomp, val);
507 static ssize_t get_component_type(struct device *cdev,
508 struct device_attribute *attr, char *buf)
510 struct enclosure_component *ecomp = to_enclosure_component(cdev);
512 return snprintf(buf, 40, "%s\n", enclosure_type[ecomp->type]);
516 static DEVICE_ATTR(fault, S_IRUGO | S_IWUSR, get_component_fault,
517 set_component_fault);
518 static DEVICE_ATTR(status, S_IRUGO | S_IWUSR, get_component_status,
519 set_component_status);
520 static DEVICE_ATTR(active, S_IRUGO | S_IWUSR, get_component_active,
521 set_component_active);
522 static DEVICE_ATTR(locate, S_IRUGO | S_IWUSR, get_component_locate,
523 set_component_locate);
524 static DEVICE_ATTR(type, S_IRUGO, get_component_type, NULL);
526 static struct attribute *enclosure_component_attrs[] = {
527 &dev_attr_fault.attr,
528 &dev_attr_status.attr,
529 &dev_attr_active.attr,
530 &dev_attr_locate.attr,
535 static struct attribute_group enclosure_group = {
536 .attrs = enclosure_component_attrs,
539 static const struct attribute_group *enclosure_groups[] = {
544 static int __init enclosure_init(void)
548 err = class_register(&enclosure_class);
555 static void __exit enclosure_exit(void)
557 class_unregister(&enclosure_class);
560 module_init(enclosure_init);
561 module_exit(enclosure_exit);
563 MODULE_AUTHOR("James Bottomley");
564 MODULE_DESCRIPTION("Enclosure Services");
565 MODULE_LICENSE("GPL v2");