include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit...
[linux-3.10.git] / drivers / misc / enclosure.c
1 /*
2  * Enclosure Services
3  *
4  * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
5  *
6 **-----------------------------------------------------------------------------
7 **
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.
11 **
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.
16 **
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.
20 **
21 **-----------------------------------------------------------------------------
22 */
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>
31
32 static LIST_HEAD(container_list);
33 static DEFINE_MUTEX(container_list_lock);
34 static struct class enclosure_class;
35
36 /**
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)
40  *
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
52  * is required.
53  */
54 struct enclosure_device *enclosure_find(struct device *dev,
55                                         struct enclosure_device *start)
56 {
57         struct enclosure_device *edev;
58
59         mutex_lock(&container_list_lock);
60         edev = list_prepare_entry(start, &container_list, node);
61         if (start)
62                 put_device(&start->edev);
63
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 */
68                 while (parent) {
69                         if (parent == dev) {
70                                 get_device(&edev->edev);
71                                 mutex_unlock(&container_list_lock);
72                                 return edev;
73                         }
74                         parent = parent->parent;
75                 }
76         }
77         mutex_unlock(&container_list_lock);
78
79         return NULL;
80 }
81 EXPORT_SYMBOL_GPL(enclosure_find);
82
83 /**
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
87  *
88  * Loops over all the enclosures calling the function.
89  *
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
93  * indefinite periods
94  */
95 int enclosure_for_each_device(int (*fn)(struct enclosure_device *, void *),
96                               void *data)
97 {
98         int error = 0;
99         struct enclosure_device *edev;
100
101         mutex_lock(&container_list_lock);
102         list_for_each_entry(edev, &container_list, node) {
103                 error = fn(edev, data);
104                 if (error)
105                         break;
106         }
107         mutex_unlock(&container_list_lock);
108
109         return error;
110 }
111 EXPORT_SYMBOL_GPL(enclosure_for_each_device);
112
113 /**
114  * enclosure_register - register device as an enclosure
115  *
116  * @dev:        device containing the enclosure
117  * @components: number of components in the enclosure
118  *
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
122  */
123 struct enclosure_device *
124 enclosure_register(struct device *dev, const char *name, int components,
125                    struct enclosure_component_callbacks *cb)
126 {
127         struct enclosure_device *edev =
128                 kzalloc(sizeof(struct enclosure_device) +
129                         sizeof(struct enclosure_component)*components,
130                         GFP_KERNEL);
131         int err, i;
132
133         BUG_ON(!cb);
134
135         if (!edev)
136                 return ERR_PTR(-ENOMEM);
137
138         edev->components = components;
139
140         edev->edev.class = &enclosure_class;
141         edev->edev.parent = get_device(dev);
142         edev->cb = cb;
143         dev_set_name(&edev->edev, "%s", name);
144         err = device_register(&edev->edev);
145         if (err)
146                 goto err;
147
148         for (i = 0; i < components; i++)
149                 edev->component[i].number = -1;
150
151         mutex_lock(&container_list_lock);
152         list_add_tail(&edev->node, &container_list);
153         mutex_unlock(&container_list_lock);
154
155         return edev;
156
157  err:
158         put_device(edev->edev.parent);
159         kfree(edev);
160         return ERR_PTR(err);
161 }
162 EXPORT_SYMBOL_GPL(enclosure_register);
163
164 static struct enclosure_component_callbacks enclosure_null_callbacks;
165
166 /**
167  * enclosure_unregister - remove an enclosure
168  *
169  * @edev:       the registered enclosure to remove;
170  */
171 void enclosure_unregister(struct enclosure_device *edev)
172 {
173         int i;
174
175         mutex_lock(&container_list_lock);
176         list_del(&edev->node);
177         mutex_unlock(&container_list_lock);
178
179         for (i = 0; i < edev->components; i++)
180                 if (edev->component[i].number != -1)
181                         device_unregister(&edev->component[i].cdev);
182
183         /* prevent any callbacks into service user */
184         edev->cb = &enclosure_null_callbacks;
185         device_unregister(&edev->edev);
186 }
187 EXPORT_SYMBOL_GPL(enclosure_unregister);
188
189 #define ENCLOSURE_NAME_SIZE     64
190
191 static void enclosure_link_name(struct enclosure_component *cdev, char *name)
192 {
193         strcpy(name, "enclosure_device:");
194         strcat(name, dev_name(&cdev->cdev));
195 }
196
197 static void enclosure_remove_links(struct enclosure_component *cdev)
198 {
199         char name[ENCLOSURE_NAME_SIZE];
200
201         enclosure_link_name(cdev, name);
202         sysfs_remove_link(&cdev->dev->kobj, name);
203         sysfs_remove_link(&cdev->cdev.kobj, "device");
204 }
205
206 static int enclosure_add_links(struct enclosure_component *cdev)
207 {
208         int error;
209         char name[ENCLOSURE_NAME_SIZE];
210
211         error = sysfs_create_link(&cdev->cdev.kobj, &cdev->dev->kobj, "device");
212         if (error)
213                 return error;
214
215         enclosure_link_name(cdev, name);
216         error = sysfs_create_link(&cdev->dev->kobj, &cdev->cdev.kobj, name);
217         if (error)
218                 sysfs_remove_link(&cdev->cdev.kobj, "device");
219
220         return error;
221 }
222
223 static void enclosure_release(struct device *cdev)
224 {
225         struct enclosure_device *edev = to_enclosure_device(cdev);
226
227         put_device(cdev->parent);
228         kfree(edev);
229 }
230
231 static void enclosure_component_release(struct device *dev)
232 {
233         struct enclosure_component *cdev = to_enclosure_component(dev);
234
235         if (cdev->dev) {
236                 enclosure_remove_links(cdev);
237                 put_device(cdev->dev);
238         }
239         put_device(dev->parent);
240 }
241
242 static const struct attribute_group *enclosure_groups[];
243
244 /**
245  * enclosure_component_register - add a particular component to an enclosure
246  * @edev:       the enclosure to add the component
247  * @num:        the device number
248  * @type:       the type of component being added
249  * @name:       an optional name to appear in sysfs (leave NULL if none)
250  *
251  * Registers the component.  The name is optional for enclosures that
252  * give their components a unique name.  If not, leave the field NULL
253  * and a name will be assigned.
254  *
255  * Returns a pointer to the enclosure component or an error.
256  */
257 struct enclosure_component *
258 enclosure_component_register(struct enclosure_device *edev,
259                              unsigned int number,
260                              enum enclosure_component_type type,
261                              const char *name)
262 {
263         struct enclosure_component *ecomp;
264         struct device *cdev;
265         int err;
266
267         if (number >= edev->components)
268                 return ERR_PTR(-EINVAL);
269
270         ecomp = &edev->component[number];
271
272         if (ecomp->number != -1)
273                 return ERR_PTR(-EINVAL);
274
275         ecomp->type = type;
276         ecomp->number = number;
277         cdev = &ecomp->cdev;
278         cdev->parent = get_device(&edev->edev);
279         if (name && name[0])
280                 dev_set_name(cdev, "%s", name);
281         else
282                 dev_set_name(cdev, "%u", number);
283
284         cdev->release = enclosure_component_release;
285         cdev->groups = enclosure_groups;
286
287         err = device_register(cdev);
288         if (err)
289                 ERR_PTR(err);
290
291         return ecomp;
292 }
293 EXPORT_SYMBOL_GPL(enclosure_component_register);
294
295 /**
296  * enclosure_add_device - add a device as being part of an enclosure
297  * @edev:       the enclosure device being added to.
298  * @num:        the number of the component
299  * @dev:        the device being added
300  *
301  * Declares a real device to reside in slot (or identifier) @num of an
302  * enclosure.  This will cause the relevant sysfs links to appear.
303  * This function may also be used to change a device associated with
304  * an enclosure without having to call enclosure_remove_device() in
305  * between.
306  *
307  * Returns zero on success or an error.
308  */
309 int enclosure_add_device(struct enclosure_device *edev, int component,
310                          struct device *dev)
311 {
312         struct enclosure_component *cdev;
313
314         if (!edev || component >= edev->components)
315                 return -EINVAL;
316
317         cdev = &edev->component[component];
318
319         if (cdev->dev == dev)
320                 return -EEXIST;
321
322         if (cdev->dev)
323                 enclosure_remove_links(cdev);
324
325         put_device(cdev->dev);
326         cdev->dev = get_device(dev);
327         return enclosure_add_links(cdev);
328 }
329 EXPORT_SYMBOL_GPL(enclosure_add_device);
330
331 /**
332  * enclosure_remove_device - remove a device from an enclosure
333  * @edev:       the enclosure device
334  * @num:        the number of the component to remove
335  *
336  * Returns zero on success or an error.
337  *
338  */
339 int enclosure_remove_device(struct enclosure_device *edev, struct device *dev)
340 {
341         struct enclosure_component *cdev;
342         int i;
343
344         if (!edev || !dev)
345                 return -EINVAL;
346
347         for (i = 0; i < edev->components; i++) {
348                 cdev = &edev->component[i];
349                 if (cdev->dev == dev) {
350                         enclosure_remove_links(cdev);
351                         device_del(&cdev->cdev);
352                         put_device(dev);
353                         cdev->dev = NULL;
354                         return device_add(&cdev->cdev);
355                 }
356         }
357         return -ENODEV;
358 }
359 EXPORT_SYMBOL_GPL(enclosure_remove_device);
360
361 /*
362  * sysfs pieces below
363  */
364
365 static ssize_t enclosure_show_components(struct device *cdev,
366                                          struct device_attribute *attr,
367                                          char *buf)
368 {
369         struct enclosure_device *edev = to_enclosure_device(cdev);
370
371         return snprintf(buf, 40, "%d\n", edev->components);
372 }
373
374 static struct device_attribute enclosure_attrs[] = {
375         __ATTR(components, S_IRUGO, enclosure_show_components, NULL),
376         __ATTR_NULL
377 };
378
379 static struct class enclosure_class = {
380         .name                   = "enclosure",
381         .owner                  = THIS_MODULE,
382         .dev_release            = enclosure_release,
383         .dev_attrs              = enclosure_attrs,
384 };
385
386 static const char *const enclosure_status [] = {
387         [ENCLOSURE_STATUS_UNSUPPORTED] = "unsupported",
388         [ENCLOSURE_STATUS_OK] = "OK",
389         [ENCLOSURE_STATUS_CRITICAL] = "critical",
390         [ENCLOSURE_STATUS_NON_CRITICAL] = "non-critical",
391         [ENCLOSURE_STATUS_UNRECOVERABLE] = "unrecoverable",
392         [ENCLOSURE_STATUS_NOT_INSTALLED] = "not installed",
393         [ENCLOSURE_STATUS_UNKNOWN] = "unknown",
394         [ENCLOSURE_STATUS_UNAVAILABLE] = "unavailable",
395         [ENCLOSURE_STATUS_MAX] = NULL,
396 };
397
398 static const char *const enclosure_type [] = {
399         [ENCLOSURE_COMPONENT_DEVICE] = "device",
400         [ENCLOSURE_COMPONENT_ARRAY_DEVICE] = "array device",
401 };
402
403 static ssize_t get_component_fault(struct device *cdev,
404                                    struct device_attribute *attr, char *buf)
405 {
406         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
407         struct enclosure_component *ecomp = to_enclosure_component(cdev);
408
409         if (edev->cb->get_fault)
410                 edev->cb->get_fault(edev, ecomp);
411         return snprintf(buf, 40, "%d\n", ecomp->fault);
412 }
413
414 static ssize_t set_component_fault(struct device *cdev,
415                                    struct device_attribute *attr,
416                                    const char *buf, size_t count)
417 {
418         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
419         struct enclosure_component *ecomp = to_enclosure_component(cdev);
420         int val = simple_strtoul(buf, NULL, 0);
421
422         if (edev->cb->set_fault)
423                 edev->cb->set_fault(edev, ecomp, val);
424         return count;
425 }
426
427 static ssize_t get_component_status(struct device *cdev,
428                                     struct device_attribute *attr,char *buf)
429 {
430         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
431         struct enclosure_component *ecomp = to_enclosure_component(cdev);
432
433         if (edev->cb->get_status)
434                 edev->cb->get_status(edev, ecomp);
435         return snprintf(buf, 40, "%s\n", enclosure_status[ecomp->status]);
436 }
437
438 static ssize_t set_component_status(struct device *cdev,
439                                     struct device_attribute *attr,
440                                     const char *buf, size_t count)
441 {
442         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
443         struct enclosure_component *ecomp = to_enclosure_component(cdev);
444         int i;
445
446         for (i = 0; enclosure_status[i]; i++) {
447                 if (strncmp(buf, enclosure_status[i],
448                             strlen(enclosure_status[i])) == 0 &&
449                     (buf[strlen(enclosure_status[i])] == '\n' ||
450                      buf[strlen(enclosure_status[i])] == '\0'))
451                         break;
452         }
453
454         if (enclosure_status[i] && edev->cb->set_status) {
455                 edev->cb->set_status(edev, ecomp, i);
456                 return count;
457         } else
458                 return -EINVAL;
459 }
460
461 static ssize_t get_component_active(struct device *cdev,
462                                     struct device_attribute *attr, char *buf)
463 {
464         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
465         struct enclosure_component *ecomp = to_enclosure_component(cdev);
466
467         if (edev->cb->get_active)
468                 edev->cb->get_active(edev, ecomp);
469         return snprintf(buf, 40, "%d\n", ecomp->active);
470 }
471
472 static ssize_t set_component_active(struct device *cdev,
473                                     struct device_attribute *attr,
474                                     const char *buf, size_t count)
475 {
476         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
477         struct enclosure_component *ecomp = to_enclosure_component(cdev);
478         int val = simple_strtoul(buf, NULL, 0);
479
480         if (edev->cb->set_active)
481                 edev->cb->set_active(edev, ecomp, val);
482         return count;
483 }
484
485 static ssize_t get_component_locate(struct device *cdev,
486                                     struct device_attribute *attr, char *buf)
487 {
488         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
489         struct enclosure_component *ecomp = to_enclosure_component(cdev);
490
491         if (edev->cb->get_locate)
492                 edev->cb->get_locate(edev, ecomp);
493         return snprintf(buf, 40, "%d\n", ecomp->locate);
494 }
495
496 static ssize_t set_component_locate(struct device *cdev,
497                                     struct device_attribute *attr,
498                                     const char *buf, size_t count)
499 {
500         struct enclosure_device *edev = to_enclosure_device(cdev->parent);
501         struct enclosure_component *ecomp = to_enclosure_component(cdev);
502         int val = simple_strtoul(buf, NULL, 0);
503
504         if (edev->cb->set_locate)
505                 edev->cb->set_locate(edev, ecomp, val);
506         return count;
507 }
508
509 static ssize_t get_component_type(struct device *cdev,
510                                   struct device_attribute *attr, char *buf)
511 {
512         struct enclosure_component *ecomp = to_enclosure_component(cdev);
513
514         return snprintf(buf, 40, "%s\n", enclosure_type[ecomp->type]);
515 }
516
517
518 static DEVICE_ATTR(fault, S_IRUGO | S_IWUSR, get_component_fault,
519                     set_component_fault);
520 static DEVICE_ATTR(status, S_IRUGO | S_IWUSR, get_component_status,
521                    set_component_status);
522 static DEVICE_ATTR(active, S_IRUGO | S_IWUSR, get_component_active,
523                    set_component_active);
524 static DEVICE_ATTR(locate, S_IRUGO | S_IWUSR, get_component_locate,
525                    set_component_locate);
526 static DEVICE_ATTR(type, S_IRUGO, get_component_type, NULL);
527
528 static struct attribute *enclosure_component_attrs[] = {
529         &dev_attr_fault.attr,
530         &dev_attr_status.attr,
531         &dev_attr_active.attr,
532         &dev_attr_locate.attr,
533         &dev_attr_type.attr,
534         NULL
535 };
536
537 static struct attribute_group enclosure_group = {
538         .attrs = enclosure_component_attrs,
539 };
540
541 static const struct attribute_group *enclosure_groups[] = {
542         &enclosure_group,
543         NULL
544 };
545
546 static int __init enclosure_init(void)
547 {
548         int err;
549
550         err = class_register(&enclosure_class);
551         if (err)
552                 return err;
553
554         return 0;
555 }
556
557 static void __exit enclosure_exit(void)
558 {
559         class_unregister(&enclosure_class);
560 }
561
562 module_init(enclosure_init);
563 module_exit(enclosure_exit);
564
565 MODULE_AUTHOR("James Bottomley");
566 MODULE_DESCRIPTION("Enclosure Services");
567 MODULE_LICENSE("GPL v2");