1
2
3
4
5
6
7
8
9
10
11
12#include <linux/device.h>
13#include <linux/enclosure.h>
14#include <linux/err.h>
15#include <linux/list.h>
16#include <linux/kernel.h>
17#include <linux/module.h>
18#include <linux/mutex.h>
19#include <linux/slab.h>
20
21static LIST_HEAD(container_list);
22static DEFINE_MUTEX(container_list_lock);
23static struct class enclosure_class;
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43struct enclosure_device *enclosure_find(struct device *dev,
44 struct enclosure_device *start)
45{
46 struct enclosure_device *edev;
47
48 mutex_lock(&container_list_lock);
49 edev = list_prepare_entry(start, &container_list, node);
50 if (start)
51 put_device(&start->edev);
52
53 list_for_each_entry_continue(edev, &container_list, node) {
54 struct device *parent = edev->edev.parent;
55
56
57 while (parent) {
58 if (parent == dev) {
59 get_device(&edev->edev);
60 mutex_unlock(&container_list_lock);
61 return edev;
62 }
63 parent = parent->parent;
64 }
65 }
66 mutex_unlock(&container_list_lock);
67
68 return NULL;
69}
70EXPORT_SYMBOL_GPL(enclosure_find);
71
72
73
74
75
76
77
78
79
80
81
82
83
84int enclosure_for_each_device(int (*fn)(struct enclosure_device *, void *),
85 void *data)
86{
87 int error = 0;
88 struct enclosure_device *edev;
89
90 mutex_lock(&container_list_lock);
91 list_for_each_entry(edev, &container_list, node) {
92 error = fn(edev, data);
93 if (error)
94 break;
95 }
96 mutex_unlock(&container_list_lock);
97
98 return error;
99}
100EXPORT_SYMBOL_GPL(enclosure_for_each_device);
101
102
103
104
105
106
107
108
109
110
111
112struct enclosure_device *
113enclosure_register(struct device *dev, const char *name, int components,
114 struct enclosure_component_callbacks *cb)
115{
116 struct enclosure_device *edev =
117 kzalloc(struct_size(edev, component, components), GFP_KERNEL);
118 int err, i;
119
120 BUG_ON(!cb);
121
122 if (!edev)
123 return ERR_PTR(-ENOMEM);
124
125 edev->components = components;
126
127 edev->edev.class = &enclosure_class;
128 edev->edev.parent = get_device(dev);
129 edev->cb = cb;
130 dev_set_name(&edev->edev, "%s", name);
131 err = device_register(&edev->edev);
132 if (err)
133 goto err;
134
135 for (i = 0; i < components; i++) {
136 edev->component[i].number = -1;
137 edev->component[i].slot = -1;
138 edev->component[i].power_status = -1;
139 }
140
141 mutex_lock(&container_list_lock);
142 list_add_tail(&edev->node, &container_list);
143 mutex_unlock(&container_list_lock);
144
145 return edev;
146
147 err:
148 put_device(edev->edev.parent);
149 kfree(edev);
150 return ERR_PTR(err);
151}
152EXPORT_SYMBOL_GPL(enclosure_register);
153
154static struct enclosure_component_callbacks enclosure_null_callbacks;
155
156
157
158
159
160
161void enclosure_unregister(struct enclosure_device *edev)
162{
163 int i;
164
165 mutex_lock(&container_list_lock);
166 list_del(&edev->node);
167 mutex_unlock(&container_list_lock);
168
169 for (i = 0; i < edev->components; i++)
170 if (edev->component[i].number != -1)
171 device_unregister(&edev->component[i].cdev);
172
173
174 edev->cb = &enclosure_null_callbacks;
175 device_unregister(&edev->edev);
176}
177EXPORT_SYMBOL_GPL(enclosure_unregister);
178
179#define ENCLOSURE_NAME_SIZE 64
180#define COMPONENT_NAME_SIZE 64
181
182static void enclosure_link_name(struct enclosure_component *cdev, char *name)
183{
184 strcpy(name, "enclosure_device:");
185 strcat(name, dev_name(&cdev->cdev));
186}
187
188static void enclosure_remove_links(struct enclosure_component *cdev)
189{
190 char name[ENCLOSURE_NAME_SIZE];
191
192 enclosure_link_name(cdev, name);
193
194
195
196
197
198 if (cdev->dev->kobj.sd)
199 sysfs_remove_link(&cdev->dev->kobj, name);
200
201 if (cdev->cdev.kobj.sd)
202 sysfs_remove_link(&cdev->cdev.kobj, "device");
203}
204
205static int enclosure_add_links(struct enclosure_component *cdev)
206{
207 int error;
208 char name[ENCLOSURE_NAME_SIZE];
209
210 error = sysfs_create_link(&cdev->cdev.kobj, &cdev->dev->kobj, "device");
211 if (error)
212 return error;
213
214 enclosure_link_name(cdev, name);
215 error = sysfs_create_link(&cdev->dev->kobj, &cdev->cdev.kobj, name);
216 if (error)
217 sysfs_remove_link(&cdev->cdev.kobj, "device");
218
219 return error;
220}
221
222static void enclosure_release(struct device *cdev)
223{
224 struct enclosure_device *edev = to_enclosure_device(cdev);
225
226 put_device(cdev->parent);
227 kfree(edev);
228}
229
230static void enclosure_component_release(struct device *dev)
231{
232 struct enclosure_component *cdev = to_enclosure_component(dev);
233
234 if (cdev->dev) {
235 enclosure_remove_links(cdev);
236 put_device(cdev->dev);
237 }
238 put_device(dev->parent);
239}
240
241static struct enclosure_component *
242enclosure_component_find_by_name(struct enclosure_device *edev,
243 const char *name)
244{
245 int i;
246 const char *cname;
247 struct enclosure_component *ecomp;
248
249 if (!edev || !name || !name[0])
250 return NULL;
251
252 for (i = 0; i < edev->components; i++) {
253 ecomp = &edev->component[i];
254 cname = dev_name(&ecomp->cdev);
255 if (ecomp->number != -1 &&
256 cname && cname[0] &&
257 !strcmp(cname, name))
258 return ecomp;
259 }
260
261 return NULL;
262}
263
264static const struct attribute_group *enclosure_component_groups[];
265
266
267
268
269
270
271
272
273
274
275
276
277
278struct enclosure_component *
279enclosure_component_alloc(struct enclosure_device *edev,
280 unsigned int number,
281 enum enclosure_component_type type,
282 const char *name)
283{
284 struct enclosure_component *ecomp;
285 struct device *cdev;
286 int i;
287 char newname[COMPONENT_NAME_SIZE];
288
289 if (number >= edev->components)
290 return ERR_PTR(-EINVAL);
291
292 ecomp = &edev->component[number];
293
294 if (ecomp->number != -1)
295 return ERR_PTR(-EINVAL);
296
297 ecomp->type = type;
298 ecomp->number = number;
299 cdev = &ecomp->cdev;
300 cdev->parent = get_device(&edev->edev);
301
302 if (name && name[0]) {
303
304
305
306
307 i = 1;
308 snprintf(newname, COMPONENT_NAME_SIZE,
309 "%s", name);
310 while (enclosure_component_find_by_name(edev, newname))
311 snprintf(newname, COMPONENT_NAME_SIZE,
312 "%s-%i", name, i++);
313 dev_set_name(cdev, "%s", newname);
314 } else
315 dev_set_name(cdev, "%u", number);
316
317 cdev->release = enclosure_component_release;
318 cdev->groups = enclosure_component_groups;
319
320 return ecomp;
321}
322EXPORT_SYMBOL_GPL(enclosure_component_alloc);
323
324
325
326
327
328
329
330int enclosure_component_register(struct enclosure_component *ecomp)
331{
332 struct device *cdev;
333 int err;
334
335 cdev = &ecomp->cdev;
336 err = device_register(cdev);
337 if (err) {
338 ecomp->number = -1;
339 put_device(cdev);
340 return err;
341 }
342
343 return 0;
344}
345EXPORT_SYMBOL_GPL(enclosure_component_register);
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361int enclosure_add_device(struct enclosure_device *edev, int component,
362 struct device *dev)
363{
364 struct enclosure_component *cdev;
365 int err;
366
367 if (!edev || component >= edev->components)
368 return -EINVAL;
369
370 cdev = &edev->component[component];
371
372 if (cdev->dev == dev)
373 return -EEXIST;
374
375 if (cdev->dev) {
376 enclosure_remove_links(cdev);
377 put_device(cdev->dev);
378 }
379 cdev->dev = get_device(dev);
380 err = enclosure_add_links(cdev);
381 if (err) {
382 put_device(cdev->dev);
383 cdev->dev = NULL;
384 }
385 return err;
386}
387EXPORT_SYMBOL_GPL(enclosure_add_device);
388
389
390
391
392
393
394
395
396
397int enclosure_remove_device(struct enclosure_device *edev, struct device *dev)
398{
399 struct enclosure_component *cdev;
400 int i;
401
402 if (!edev || !dev)
403 return -EINVAL;
404
405 for (i = 0; i < edev->components; i++) {
406 cdev = &edev->component[i];
407 if (cdev->dev == dev) {
408 enclosure_remove_links(cdev);
409 device_del(&cdev->cdev);
410 put_device(dev);
411 cdev->dev = NULL;
412 return device_add(&cdev->cdev);
413 }
414 }
415 return -ENODEV;
416}
417EXPORT_SYMBOL_GPL(enclosure_remove_device);
418
419
420
421
422
423static ssize_t components_show(struct device *cdev,
424 struct device_attribute *attr, char *buf)
425{
426 struct enclosure_device *edev = to_enclosure_device(cdev);
427
428 return snprintf(buf, 40, "%d\n", edev->components);
429}
430static DEVICE_ATTR_RO(components);
431
432static ssize_t id_show(struct device *cdev,
433 struct device_attribute *attr,
434 char *buf)
435{
436 struct enclosure_device *edev = to_enclosure_device(cdev);
437
438 if (edev->cb->show_id)
439 return edev->cb->show_id(edev, buf);
440 return -EINVAL;
441}
442static DEVICE_ATTR_RO(id);
443
444static struct attribute *enclosure_class_attrs[] = {
445 &dev_attr_components.attr,
446 &dev_attr_id.attr,
447 NULL,
448};
449ATTRIBUTE_GROUPS(enclosure_class);
450
451static struct class enclosure_class = {
452 .name = "enclosure",
453 .owner = THIS_MODULE,
454 .dev_release = enclosure_release,
455 .dev_groups = enclosure_class_groups,
456};
457
458static const char *const enclosure_status[] = {
459 [ENCLOSURE_STATUS_UNSUPPORTED] = "unsupported",
460 [ENCLOSURE_STATUS_OK] = "OK",
461 [ENCLOSURE_STATUS_CRITICAL] = "critical",
462 [ENCLOSURE_STATUS_NON_CRITICAL] = "non-critical",
463 [ENCLOSURE_STATUS_UNRECOVERABLE] = "unrecoverable",
464 [ENCLOSURE_STATUS_NOT_INSTALLED] = "not installed",
465 [ENCLOSURE_STATUS_UNKNOWN] = "unknown",
466 [ENCLOSURE_STATUS_UNAVAILABLE] = "unavailable",
467 [ENCLOSURE_STATUS_MAX] = NULL,
468};
469
470static const char *const enclosure_type[] = {
471 [ENCLOSURE_COMPONENT_DEVICE] = "device",
472 [ENCLOSURE_COMPONENT_ARRAY_DEVICE] = "array device",
473};
474
475static ssize_t get_component_fault(struct device *cdev,
476 struct device_attribute *attr, char *buf)
477{
478 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
479 struct enclosure_component *ecomp = to_enclosure_component(cdev);
480
481 if (edev->cb->get_fault)
482 edev->cb->get_fault(edev, ecomp);
483 return snprintf(buf, 40, "%d\n", ecomp->fault);
484}
485
486static ssize_t set_component_fault(struct device *cdev,
487 struct device_attribute *attr,
488 const char *buf, size_t count)
489{
490 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
491 struct enclosure_component *ecomp = to_enclosure_component(cdev);
492 int val = simple_strtoul(buf, NULL, 0);
493
494 if (edev->cb->set_fault)
495 edev->cb->set_fault(edev, ecomp, val);
496 return count;
497}
498
499static ssize_t get_component_status(struct device *cdev,
500 struct device_attribute *attr,char *buf)
501{
502 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
503 struct enclosure_component *ecomp = to_enclosure_component(cdev);
504
505 if (edev->cb->get_status)
506 edev->cb->get_status(edev, ecomp);
507 return snprintf(buf, 40, "%s\n", enclosure_status[ecomp->status]);
508}
509
510static ssize_t set_component_status(struct device *cdev,
511 struct device_attribute *attr,
512 const char *buf, size_t count)
513{
514 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
515 struct enclosure_component *ecomp = to_enclosure_component(cdev);
516 int i;
517
518 for (i = 0; enclosure_status[i]; i++) {
519 if (strncmp(buf, enclosure_status[i],
520 strlen(enclosure_status[i])) == 0 &&
521 (buf[strlen(enclosure_status[i])] == '\n' ||
522 buf[strlen(enclosure_status[i])] == '\0'))
523 break;
524 }
525
526 if (enclosure_status[i] && edev->cb->set_status) {
527 edev->cb->set_status(edev, ecomp, i);
528 return count;
529 } else
530 return -EINVAL;
531}
532
533static ssize_t get_component_active(struct device *cdev,
534 struct device_attribute *attr, char *buf)
535{
536 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
537 struct enclosure_component *ecomp = to_enclosure_component(cdev);
538
539 if (edev->cb->get_active)
540 edev->cb->get_active(edev, ecomp);
541 return snprintf(buf, 40, "%d\n", ecomp->active);
542}
543
544static ssize_t set_component_active(struct device *cdev,
545 struct device_attribute *attr,
546 const char *buf, size_t count)
547{
548 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
549 struct enclosure_component *ecomp = to_enclosure_component(cdev);
550 int val = simple_strtoul(buf, NULL, 0);
551
552 if (edev->cb->set_active)
553 edev->cb->set_active(edev, ecomp, val);
554 return count;
555}
556
557static ssize_t get_component_locate(struct device *cdev,
558 struct device_attribute *attr, char *buf)
559{
560 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
561 struct enclosure_component *ecomp = to_enclosure_component(cdev);
562
563 if (edev->cb->get_locate)
564 edev->cb->get_locate(edev, ecomp);
565 return snprintf(buf, 40, "%d\n", ecomp->locate);
566}
567
568static ssize_t set_component_locate(struct device *cdev,
569 struct device_attribute *attr,
570 const char *buf, size_t count)
571{
572 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
573 struct enclosure_component *ecomp = to_enclosure_component(cdev);
574 int val = simple_strtoul(buf, NULL, 0);
575
576 if (edev->cb->set_locate)
577 edev->cb->set_locate(edev, ecomp, val);
578 return count;
579}
580
581static ssize_t get_component_power_status(struct device *cdev,
582 struct device_attribute *attr,
583 char *buf)
584{
585 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
586 struct enclosure_component *ecomp = to_enclosure_component(cdev);
587
588 if (edev->cb->get_power_status)
589 edev->cb->get_power_status(edev, ecomp);
590
591
592 if (ecomp->power_status == -1)
593 return (edev->cb->get_power_status) ? -EIO : -ENOTTY;
594
595 return snprintf(buf, 40, "%s\n", ecomp->power_status ? "on" : "off");
596}
597
598static ssize_t set_component_power_status(struct device *cdev,
599 struct device_attribute *attr,
600 const char *buf, size_t count)
601{
602 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
603 struct enclosure_component *ecomp = to_enclosure_component(cdev);
604 int val;
605
606 if (strncmp(buf, "on", 2) == 0 &&
607 (buf[2] == '\n' || buf[2] == '\0'))
608 val = 1;
609 else if (strncmp(buf, "off", 3) == 0 &&
610 (buf[3] == '\n' || buf[3] == '\0'))
611 val = 0;
612 else
613 return -EINVAL;
614
615 if (edev->cb->set_power_status)
616 edev->cb->set_power_status(edev, ecomp, val);
617 return count;
618}
619
620static ssize_t get_component_type(struct device *cdev,
621 struct device_attribute *attr, char *buf)
622{
623 struct enclosure_component *ecomp = to_enclosure_component(cdev);
624
625 return snprintf(buf, 40, "%s\n", enclosure_type[ecomp->type]);
626}
627
628static ssize_t get_component_slot(struct device *cdev,
629 struct device_attribute *attr, char *buf)
630{
631 struct enclosure_component *ecomp = to_enclosure_component(cdev);
632 int slot;
633
634
635 if (ecomp->slot >= 0)
636 slot = ecomp->slot;
637 else
638 slot = ecomp->number;
639
640 return snprintf(buf, 40, "%d\n", slot);
641}
642
643static DEVICE_ATTR(fault, S_IRUGO | S_IWUSR, get_component_fault,
644 set_component_fault);
645static DEVICE_ATTR(status, S_IRUGO | S_IWUSR, get_component_status,
646 set_component_status);
647static DEVICE_ATTR(active, S_IRUGO | S_IWUSR, get_component_active,
648 set_component_active);
649static DEVICE_ATTR(locate, S_IRUGO | S_IWUSR, get_component_locate,
650 set_component_locate);
651static DEVICE_ATTR(power_status, S_IRUGO | S_IWUSR, get_component_power_status,
652 set_component_power_status);
653static DEVICE_ATTR(type, S_IRUGO, get_component_type, NULL);
654static DEVICE_ATTR(slot, S_IRUGO, get_component_slot, NULL);
655
656static struct attribute *enclosure_component_attrs[] = {
657 &dev_attr_fault.attr,
658 &dev_attr_status.attr,
659 &dev_attr_active.attr,
660 &dev_attr_locate.attr,
661 &dev_attr_power_status.attr,
662 &dev_attr_type.attr,
663 &dev_attr_slot.attr,
664 NULL
665};
666ATTRIBUTE_GROUPS(enclosure_component);
667
668static int __init enclosure_init(void)
669{
670 return class_register(&enclosure_class);
671}
672
673static void __exit enclosure_exit(void)
674{
675 class_unregister(&enclosure_class);
676}
677
678module_init(enclosure_init);
679module_exit(enclosure_exit);
680
681MODULE_AUTHOR("James Bottomley");
682MODULE_DESCRIPTION("Enclosure Services");
683MODULE_LICENSE("GPL v2");
684