blob: eb29113e0bac2437f1714af1e4189b74fe992b6f [file] [log] [blame]
James Bottomleyd569d5b2008-02-03 15:40:56 -06001/*
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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090030#include <linux/slab.h>
James Bottomleyd569d5b2008-02-03 15:40:56 -060031
32static LIST_HEAD(container_list);
33static DEFINE_MUTEX(container_list_lock);
34static struct class enclosure_class;
James Bottomleyd569d5b2008-02-03 15:40:56 -060035
36/**
James Bottomley163f52b2009-08-01 00:39:36 +000037 * 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)
James Bottomleyd569d5b2008-02-03 15:40:56 -060040 *
James Bottomley163f52b2009-08-01 00:39:36 +000041 * 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.
James Bottomleyd569d5b2008-02-03 15:40:56 -060053 */
James Bottomley163f52b2009-08-01 00:39:36 +000054struct enclosure_device *enclosure_find(struct device *dev,
55 struct enclosure_device *start)
James Bottomleyd569d5b2008-02-03 15:40:56 -060056{
Tony Jonesee959b02008-02-22 00:13:36 +010057 struct enclosure_device *edev;
James Bottomleyd569d5b2008-02-03 15:40:56 -060058
59 mutex_lock(&container_list_lock);
James Bottomley163f52b2009-08-01 00:39:36 +000060 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;
James Bottomleyd569d5b2008-02-03 15:40:56 -060075 }
76 }
77 mutex_unlock(&container_list_lock);
78
79 return NULL;
80}
81EXPORT_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 */
95int 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}
111EXPORT_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 */
123struct enclosure_device *
124enclosure_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
Tony Jonesee959b02008-02-22 00:13:36 +0100140 edev->edev.class = &enclosure_class;
141 edev->edev.parent = get_device(dev);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600142 edev->cb = cb;
Yinghai Lu5e437542009-04-30 19:13:41 -0700143 dev_set_name(&edev->edev, "%s", name);
Tony Jonesee959b02008-02-22 00:13:36 +0100144 err = device_register(&edev->edev);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600145 if (err)
146 goto err;
147
Dan Williams921ce7f2014-12-30 14:46:17 -0800148 for (i = 0; i < components; i++) {
James Bottomleyd569d5b2008-02-03 15:40:56 -0600149 edev->component[i].number = -1;
Dan Williams921ce7f2014-12-30 14:46:17 -0800150 edev->component[i].slot = -1;
Mauricio Faria de Oliveira7cd70b32017-04-05 12:18:19 -0300151 edev->component[i].power_status = -1;
Dan Williams921ce7f2014-12-30 14:46:17 -0800152 }
James Bottomleyd569d5b2008-02-03 15:40:56 -0600153
154 mutex_lock(&container_list_lock);
155 list_add_tail(&edev->node, &container_list);
156 mutex_unlock(&container_list_lock);
157
158 return edev;
159
160 err:
Tony Jonesee959b02008-02-22 00:13:36 +0100161 put_device(edev->edev.parent);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600162 kfree(edev);
163 return ERR_PTR(err);
164}
165EXPORT_SYMBOL_GPL(enclosure_register);
166
167static struct enclosure_component_callbacks enclosure_null_callbacks;
168
169/**
170 * enclosure_unregister - remove an enclosure
171 *
172 * @edev: the registered enclosure to remove;
173 */
174void enclosure_unregister(struct enclosure_device *edev)
175{
176 int i;
177
178 mutex_lock(&container_list_lock);
179 list_del(&edev->node);
180 mutex_unlock(&container_list_lock);
181
182 for (i = 0; i < edev->components; i++)
183 if (edev->component[i].number != -1)
Tony Jonesee959b02008-02-22 00:13:36 +0100184 device_unregister(&edev->component[i].cdev);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600185
186 /* prevent any callbacks into service user */
187 edev->cb = &enclosure_null_callbacks;
Tony Jonesee959b02008-02-22 00:13:36 +0100188 device_unregister(&edev->edev);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600189}
190EXPORT_SYMBOL_GPL(enclosure_unregister);
191
James Bottomleycb6b7f42008-03-15 13:01:40 -0500192#define ENCLOSURE_NAME_SIZE 64
Markus Stockhausend2fd76e2014-10-04 13:35:15 +0000193#define COMPONENT_NAME_SIZE 64
James Bottomleycb6b7f42008-03-15 13:01:40 -0500194
195static void enclosure_link_name(struct enclosure_component *cdev, char *name)
196{
197 strcpy(name, "enclosure_device:");
Kay Sievers71610f52008-12-03 22:41:36 +0100198 strcat(name, dev_name(&cdev->cdev));
James Bottomleycb6b7f42008-03-15 13:01:40 -0500199}
200
201static void enclosure_remove_links(struct enclosure_component *cdev)
202{
203 char name[ENCLOSURE_NAME_SIZE];
204
James Bottomley11e52a62015-03-18 15:56:16 -0700205 enclosure_link_name(cdev, name);
206
James Bottomleya1470c72013-11-15 14:58:00 -0800207 /*
208 * In odd circumstances, like multipath devices, something else may
209 * already have removed the links, so check for this condition first.
210 */
James Bottomley11e52a62015-03-18 15:56:16 -0700211 if (cdev->dev->kobj.sd)
212 sysfs_remove_link(&cdev->dev->kobj, name);
James Bottomleya1470c72013-11-15 14:58:00 -0800213
James Bottomley11e52a62015-03-18 15:56:16 -0700214 if (cdev->cdev.kobj.sd)
215 sysfs_remove_link(&cdev->cdev.kobj, "device");
James Bottomleycb6b7f42008-03-15 13:01:40 -0500216}
217
218static int enclosure_add_links(struct enclosure_component *cdev)
219{
220 int error;
221 char name[ENCLOSURE_NAME_SIZE];
222
223 error = sysfs_create_link(&cdev->cdev.kobj, &cdev->dev->kobj, "device");
224 if (error)
225 return error;
226
227 enclosure_link_name(cdev, name);
228 error = sysfs_create_link(&cdev->dev->kobj, &cdev->cdev.kobj, name);
229 if (error)
230 sysfs_remove_link(&cdev->cdev.kobj, "device");
231
232 return error;
233}
234
Tony Jonesee959b02008-02-22 00:13:36 +0100235static void enclosure_release(struct device *cdev)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600236{
237 struct enclosure_device *edev = to_enclosure_device(cdev);
238
Tony Jonesee959b02008-02-22 00:13:36 +0100239 put_device(cdev->parent);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600240 kfree(edev);
241}
242
Tony Jonesee959b02008-02-22 00:13:36 +0100243static void enclosure_component_release(struct device *dev)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600244{
Tony Jonesee959b02008-02-22 00:13:36 +0100245 struct enclosure_component *cdev = to_enclosure_component(dev);
246
James Bottomleycb6b7f42008-03-15 13:01:40 -0500247 if (cdev->dev) {
248 enclosure_remove_links(cdev);
249 put_device(cdev->dev);
250 }
Tony Jonesee959b02008-02-22 00:13:36 +0100251 put_device(dev->parent);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600252}
253
Markus Stockhausend2fd76e2014-10-04 13:35:15 +0000254static struct enclosure_component *
255enclosure_component_find_by_name(struct enclosure_device *edev,
256 const char *name)
257{
258 int i;
259 const char *cname;
260 struct enclosure_component *ecomp;
261
262 if (!edev || !name || !name[0])
263 return NULL;
264
265 for (i = 0; i < edev->components; i++) {
266 ecomp = &edev->component[i];
267 cname = dev_name(&ecomp->cdev);
268 if (ecomp->number != -1 &&
269 cname && cname[0] &&
270 !strcmp(cname, name))
271 return ecomp;
272 }
273
274 return NULL;
275}
276
Greg Kroah-Hartman899826f2013-07-24 15:05:16 -0700277static const struct attribute_group *enclosure_component_groups[];
James Bottomleycb6b7f42008-03-15 13:01:40 -0500278
James Bottomleyd569d5b2008-02-03 15:40:56 -0600279/**
Dan Williamsed09dcc2014-12-30 14:46:14 -0800280 * enclosure_component_alloc - prepare a new enclosure component
James Bottomleyd569d5b2008-02-03 15:40:56 -0600281 * @edev: the enclosure to add the component
282 * @num: the device number
283 * @type: the type of component being added
284 * @name: an optional name to appear in sysfs (leave NULL if none)
285 *
Dan Williamsed09dcc2014-12-30 14:46:14 -0800286 * The name is optional for enclosures that give their components a unique
287 * name. If not, leave the field NULL and a name will be assigned.
James Bottomleyd569d5b2008-02-03 15:40:56 -0600288 *
289 * Returns a pointer to the enclosure component or an error.
290 */
291struct enclosure_component *
Dan Williamsed09dcc2014-12-30 14:46:14 -0800292enclosure_component_alloc(struct enclosure_device *edev,
293 unsigned int number,
294 enum enclosure_component_type type,
295 const char *name)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600296{
297 struct enclosure_component *ecomp;
Tony Jonesee959b02008-02-22 00:13:36 +0100298 struct device *cdev;
Dan Williamsed09dcc2014-12-30 14:46:14 -0800299 int i;
Markus Stockhausend2fd76e2014-10-04 13:35:15 +0000300 char newname[COMPONENT_NAME_SIZE];
James Bottomleyd569d5b2008-02-03 15:40:56 -0600301
302 if (number >= edev->components)
303 return ERR_PTR(-EINVAL);
304
305 ecomp = &edev->component[number];
306
307 if (ecomp->number != -1)
308 return ERR_PTR(-EINVAL);
309
310 ecomp->type = type;
311 ecomp->number = number;
312 cdev = &ecomp->cdev;
Tony Jonesee959b02008-02-22 00:13:36 +0100313 cdev->parent = get_device(&edev->edev);
Markus Stockhausend2fd76e2014-10-04 13:35:15 +0000314
315 if (name && name[0]) {
316 /* Some hardware (e.g. enclosure in RX300 S6) has components
317 * with non unique names. Registering duplicates in sysfs
318 * will lead to warnings during bootup. So make the names
319 * unique by appending consecutive numbers -1, -2, ... */
320 i = 1;
321 snprintf(newname, COMPONENT_NAME_SIZE,
322 "%s", name);
323 while (enclosure_component_find_by_name(edev, newname))
324 snprintf(newname, COMPONENT_NAME_SIZE,
325 "%s-%i", name, i++);
326 dev_set_name(cdev, "%s", newname);
327 } else
Kay Sievers71610f52008-12-03 22:41:36 +0100328 dev_set_name(cdev, "%u", number);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600329
James Bottomleycb6b7f42008-03-15 13:01:40 -0500330 cdev->release = enclosure_component_release;
Greg Kroah-Hartman899826f2013-07-24 15:05:16 -0700331 cdev->groups = enclosure_component_groups;
James Bottomleycb6b7f42008-03-15 13:01:40 -0500332
Dan Williamsed09dcc2014-12-30 14:46:14 -0800333 return ecomp;
334}
335EXPORT_SYMBOL_GPL(enclosure_component_alloc);
336
337/**
338 * enclosure_component_register - publishes an initialized enclosure component
339 * @ecomp: component to add
340 *
341 * Returns 0 on successful registration, releases the component otherwise
342 */
343int enclosure_component_register(struct enclosure_component *ecomp)
344{
345 struct device *cdev;
346 int err;
347
348 cdev = &ecomp->cdev;
Tony Jonesee959b02008-02-22 00:13:36 +0100349 err = device_register(cdev);
James Bottomleya91c1be2010-03-12 16:14:42 -0600350 if (err) {
351 ecomp->number = -1;
352 put_device(cdev);
Dan Williamsed09dcc2014-12-30 14:46:14 -0800353 return err;
James Bottomleya91c1be2010-03-12 16:14:42 -0600354 }
James Bottomleyd569d5b2008-02-03 15:40:56 -0600355
Dan Williamsed09dcc2014-12-30 14:46:14 -0800356 return 0;
James Bottomleyd569d5b2008-02-03 15:40:56 -0600357}
358EXPORT_SYMBOL_GPL(enclosure_component_register);
359
360/**
361 * enclosure_add_device - add a device as being part of an enclosure
362 * @edev: the enclosure device being added to.
363 * @num: the number of the component
364 * @dev: the device being added
365 *
366 * Declares a real device to reside in slot (or identifier) @num of an
367 * enclosure. This will cause the relevant sysfs links to appear.
368 * This function may also be used to change a device associated with
369 * an enclosure without having to call enclosure_remove_device() in
370 * between.
371 *
372 * Returns zero on success or an error.
373 */
374int enclosure_add_device(struct enclosure_device *edev, int component,
375 struct device *dev)
376{
Tony Jonesee959b02008-02-22 00:13:36 +0100377 struct enclosure_component *cdev;
Maurizio Lombardi542c0972017-06-27 11:53:27 +0200378 int err;
James Bottomleyd569d5b2008-02-03 15:40:56 -0600379
380 if (!edev || component >= edev->components)
381 return -EINVAL;
382
Tony Jonesee959b02008-02-22 00:13:36 +0100383 cdev = &edev->component[component];
James Bottomleyd569d5b2008-02-03 15:40:56 -0600384
James Bottomley21fab1d2009-08-01 00:43:59 +0000385 if (cdev->dev == dev)
386 return -EEXIST;
387
Maurizio Lombardi542c0972017-06-27 11:53:27 +0200388 if (cdev->dev) {
James Bottomleycb6b7f42008-03-15 13:01:40 -0500389 enclosure_remove_links(cdev);
Maurizio Lombardi542c0972017-06-27 11:53:27 +0200390 put_device(cdev->dev);
391 }
James Bottomleyd569d5b2008-02-03 15:40:56 -0600392 cdev->dev = get_device(dev);
Maurizio Lombardi542c0972017-06-27 11:53:27 +0200393 err = enclosure_add_links(cdev);
394 if (err) {
395 put_device(cdev->dev);
396 cdev->dev = NULL;
397 }
398 return err;
James Bottomleyd569d5b2008-02-03 15:40:56 -0600399}
400EXPORT_SYMBOL_GPL(enclosure_add_device);
401
402/**
403 * enclosure_remove_device - remove a device from an enclosure
404 * @edev: the enclosure device
405 * @num: the number of the component to remove
406 *
407 * Returns zero on success or an error.
408 *
409 */
James Bottomley43d8eb92009-08-01 00:41:22 +0000410int enclosure_remove_device(struct enclosure_device *edev, struct device *dev)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600411{
Tony Jonesee959b02008-02-22 00:13:36 +0100412 struct enclosure_component *cdev;
James Bottomley43d8eb92009-08-01 00:41:22 +0000413 int i;
James Bottomleyd569d5b2008-02-03 15:40:56 -0600414
James Bottomley43d8eb92009-08-01 00:41:22 +0000415 if (!edev || !dev)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600416 return -EINVAL;
417
James Bottomley43d8eb92009-08-01 00:41:22 +0000418 for (i = 0; i < edev->components; i++) {
419 cdev = &edev->component[i];
420 if (cdev->dev == dev) {
421 enclosure_remove_links(cdev);
422 device_del(&cdev->cdev);
423 put_device(dev);
424 cdev->dev = NULL;
425 return device_add(&cdev->cdev);
426 }
427 }
428 return -ENODEV;
James Bottomleyd569d5b2008-02-03 15:40:56 -0600429}
430EXPORT_SYMBOL_GPL(enclosure_remove_device);
431
432/*
433 * sysfs pieces below
434 */
435
Greg Kroah-Hartman899826f2013-07-24 15:05:16 -0700436static ssize_t components_show(struct device *cdev,
437 struct device_attribute *attr, char *buf)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600438{
439 struct enclosure_device *edev = to_enclosure_device(cdev);
440
441 return snprintf(buf, 40, "%d\n", edev->components);
442}
Greg Kroah-Hartman899826f2013-07-24 15:05:16 -0700443static DEVICE_ATTR_RO(components);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600444
Dan Williams967f7ba2014-12-30 14:46:16 -0800445static ssize_t id_show(struct device *cdev,
446 struct device_attribute *attr,
447 char *buf)
448{
449 struct enclosure_device *edev = to_enclosure_device(cdev);
450
451 if (edev->cb->show_id)
452 return edev->cb->show_id(edev, buf);
453 return -EINVAL;
454}
455static DEVICE_ATTR_RO(id);
456
Greg Kroah-Hartman899826f2013-07-24 15:05:16 -0700457static struct attribute *enclosure_class_attrs[] = {
458 &dev_attr_components.attr,
Dan Williams967f7ba2014-12-30 14:46:16 -0800459 &dev_attr_id.attr,
Greg Kroah-Hartman899826f2013-07-24 15:05:16 -0700460 NULL,
James Bottomleyd569d5b2008-02-03 15:40:56 -0600461};
Greg Kroah-Hartman899826f2013-07-24 15:05:16 -0700462ATTRIBUTE_GROUPS(enclosure_class);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600463
464static struct class enclosure_class = {
465 .name = "enclosure",
466 .owner = THIS_MODULE,
Tony Jonesee959b02008-02-22 00:13:36 +0100467 .dev_release = enclosure_release,
Greg Kroah-Hartman899826f2013-07-24 15:05:16 -0700468 .dev_groups = enclosure_class_groups,
James Bottomleyd569d5b2008-02-03 15:40:56 -0600469};
470
471static const char *const enclosure_status [] = {
472 [ENCLOSURE_STATUS_UNSUPPORTED] = "unsupported",
473 [ENCLOSURE_STATUS_OK] = "OK",
474 [ENCLOSURE_STATUS_CRITICAL] = "critical",
475 [ENCLOSURE_STATUS_NON_CRITICAL] = "non-critical",
476 [ENCLOSURE_STATUS_UNRECOVERABLE] = "unrecoverable",
477 [ENCLOSURE_STATUS_NOT_INSTALLED] = "not installed",
478 [ENCLOSURE_STATUS_UNKNOWN] = "unknown",
479 [ENCLOSURE_STATUS_UNAVAILABLE] = "unavailable",
James Bottomleycc9b2e92009-11-26 09:50:20 -0600480 [ENCLOSURE_STATUS_MAX] = NULL,
James Bottomleyd569d5b2008-02-03 15:40:56 -0600481};
482
483static const char *const enclosure_type [] = {
484 [ENCLOSURE_COMPONENT_DEVICE] = "device",
485 [ENCLOSURE_COMPONENT_ARRAY_DEVICE] = "array device",
486};
487
Tony Jonesee959b02008-02-22 00:13:36 +0100488static ssize_t get_component_fault(struct device *cdev,
489 struct device_attribute *attr, char *buf)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600490{
491 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
492 struct enclosure_component *ecomp = to_enclosure_component(cdev);
493
494 if (edev->cb->get_fault)
495 edev->cb->get_fault(edev, ecomp);
496 return snprintf(buf, 40, "%d\n", ecomp->fault);
497}
498
Tony Jonesee959b02008-02-22 00:13:36 +0100499static ssize_t set_component_fault(struct device *cdev,
500 struct device_attribute *attr,
501 const char *buf, size_t count)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600502{
503 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
504 struct enclosure_component *ecomp = to_enclosure_component(cdev);
505 int val = simple_strtoul(buf, NULL, 0);
506
507 if (edev->cb->set_fault)
508 edev->cb->set_fault(edev, ecomp, val);
509 return count;
510}
511
Tony Jonesee959b02008-02-22 00:13:36 +0100512static ssize_t get_component_status(struct device *cdev,
513 struct device_attribute *attr,char *buf)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600514{
515 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
516 struct enclosure_component *ecomp = to_enclosure_component(cdev);
517
518 if (edev->cb->get_status)
519 edev->cb->get_status(edev, ecomp);
520 return snprintf(buf, 40, "%s\n", enclosure_status[ecomp->status]);
521}
522
Tony Jonesee959b02008-02-22 00:13:36 +0100523static ssize_t set_component_status(struct device *cdev,
524 struct device_attribute *attr,
525 const char *buf, size_t count)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600526{
527 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
528 struct enclosure_component *ecomp = to_enclosure_component(cdev);
529 int i;
530
531 for (i = 0; enclosure_status[i]; i++) {
532 if (strncmp(buf, enclosure_status[i],
533 strlen(enclosure_status[i])) == 0 &&
534 (buf[strlen(enclosure_status[i])] == '\n' ||
535 buf[strlen(enclosure_status[i])] == '\0'))
536 break;
537 }
538
539 if (enclosure_status[i] && edev->cb->set_status) {
540 edev->cb->set_status(edev, ecomp, i);
541 return count;
542 } else
543 return -EINVAL;
544}
545
Tony Jonesee959b02008-02-22 00:13:36 +0100546static ssize_t get_component_active(struct device *cdev,
547 struct device_attribute *attr, char *buf)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600548{
549 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
550 struct enclosure_component *ecomp = to_enclosure_component(cdev);
551
552 if (edev->cb->get_active)
553 edev->cb->get_active(edev, ecomp);
554 return snprintf(buf, 40, "%d\n", ecomp->active);
555}
556
Tony Jonesee959b02008-02-22 00:13:36 +0100557static ssize_t set_component_active(struct device *cdev,
558 struct device_attribute *attr,
559 const char *buf, size_t count)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600560{
561 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
562 struct enclosure_component *ecomp = to_enclosure_component(cdev);
563 int val = simple_strtoul(buf, NULL, 0);
564
565 if (edev->cb->set_active)
566 edev->cb->set_active(edev, ecomp, val);
567 return count;
568}
569
Tony Jonesee959b02008-02-22 00:13:36 +0100570static ssize_t get_component_locate(struct device *cdev,
571 struct device_attribute *attr, char *buf)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600572{
573 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
574 struct enclosure_component *ecomp = to_enclosure_component(cdev);
575
576 if (edev->cb->get_locate)
577 edev->cb->get_locate(edev, ecomp);
578 return snprintf(buf, 40, "%d\n", ecomp->locate);
579}
580
Tony Jonesee959b02008-02-22 00:13:36 +0100581static ssize_t set_component_locate(struct device *cdev,
582 struct device_attribute *attr,
583 const char *buf, size_t count)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600584{
585 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
586 struct enclosure_component *ecomp = to_enclosure_component(cdev);
587 int val = simple_strtoul(buf, NULL, 0);
588
589 if (edev->cb->set_locate)
590 edev->cb->set_locate(edev, ecomp, val);
591 return count;
592}
593
Song Liu08024882014-12-30 14:46:18 -0800594static ssize_t get_component_power_status(struct device *cdev,
595 struct device_attribute *attr,
596 char *buf)
597{
598 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
599 struct enclosure_component *ecomp = to_enclosure_component(cdev);
600
601 if (edev->cb->get_power_status)
602 edev->cb->get_power_status(edev, ecomp);
Mauricio Faria de Oliveira7cd70b32017-04-05 12:18:19 -0300603
604 /* If still uninitialized, the callback failed or does not exist. */
605 if (ecomp->power_status == -1)
606 return (edev->cb->get_power_status) ? -EIO : -ENOTTY;
607
Song Liu08024882014-12-30 14:46:18 -0800608 return snprintf(buf, 40, "%s\n", ecomp->power_status ? "on" : "off");
609}
610
611static ssize_t set_component_power_status(struct device *cdev,
612 struct device_attribute *attr,
613 const char *buf, size_t count)
614{
615 struct enclosure_device *edev = to_enclosure_device(cdev->parent);
616 struct enclosure_component *ecomp = to_enclosure_component(cdev);
617 int val;
618
619 if (strncmp(buf, "on", 2) == 0 &&
620 (buf[2] == '\n' || buf[2] == '\0'))
621 val = 1;
622 else if (strncmp(buf, "off", 3) == 0 &&
623 (buf[3] == '\n' || buf[3] == '\0'))
624 val = 0;
625 else
626 return -EINVAL;
627
628 if (edev->cb->set_power_status)
629 edev->cb->set_power_status(edev, ecomp, val);
630 return count;
631}
632
Tony Jonesee959b02008-02-22 00:13:36 +0100633static ssize_t get_component_type(struct device *cdev,
634 struct device_attribute *attr, char *buf)
James Bottomleyd569d5b2008-02-03 15:40:56 -0600635{
636 struct enclosure_component *ecomp = to_enclosure_component(cdev);
637
638 return snprintf(buf, 40, "%s\n", enclosure_type[ecomp->type]);
639}
640
Dan Williams921ce7f2014-12-30 14:46:17 -0800641static ssize_t get_component_slot(struct device *cdev,
642 struct device_attribute *attr, char *buf)
643{
644 struct enclosure_component *ecomp = to_enclosure_component(cdev);
645 int slot;
646
647 /* if the enclosure does not override then use 'number' as a stand-in */
648 if (ecomp->slot >= 0)
649 slot = ecomp->slot;
650 else
651 slot = ecomp->number;
652
653 return snprintf(buf, 40, "%d\n", slot);
654}
James Bottomleyd569d5b2008-02-03 15:40:56 -0600655
James Bottomleycb6b7f42008-03-15 13:01:40 -0500656static DEVICE_ATTR(fault, S_IRUGO | S_IWUSR, get_component_fault,
657 set_component_fault);
658static DEVICE_ATTR(status, S_IRUGO | S_IWUSR, get_component_status,
659 set_component_status);
660static DEVICE_ATTR(active, S_IRUGO | S_IWUSR, get_component_active,
661 set_component_active);
662static DEVICE_ATTR(locate, S_IRUGO | S_IWUSR, get_component_locate,
663 set_component_locate);
Song Liu08024882014-12-30 14:46:18 -0800664static DEVICE_ATTR(power_status, S_IRUGO | S_IWUSR, get_component_power_status,
665 set_component_power_status);
James Bottomleycb6b7f42008-03-15 13:01:40 -0500666static DEVICE_ATTR(type, S_IRUGO, get_component_type, NULL);
Dan Williams921ce7f2014-12-30 14:46:17 -0800667static DEVICE_ATTR(slot, S_IRUGO, get_component_slot, NULL);
James Bottomleycb6b7f42008-03-15 13:01:40 -0500668
669static struct attribute *enclosure_component_attrs[] = {
670 &dev_attr_fault.attr,
671 &dev_attr_status.attr,
672 &dev_attr_active.attr,
673 &dev_attr_locate.attr,
Song Liu08024882014-12-30 14:46:18 -0800674 &dev_attr_power_status.attr,
James Bottomleycb6b7f42008-03-15 13:01:40 -0500675 &dev_attr_type.attr,
Dan Williams921ce7f2014-12-30 14:46:17 -0800676 &dev_attr_slot.attr,
James Bottomleycb6b7f42008-03-15 13:01:40 -0500677 NULL
James Bottomleyd569d5b2008-02-03 15:40:56 -0600678};
Greg Kroah-Hartman899826f2013-07-24 15:05:16 -0700679ATTRIBUTE_GROUPS(enclosure_component);
James Bottomleyd569d5b2008-02-03 15:40:56 -0600680
681static int __init enclosure_init(void)
682{
683 int err;
684
685 err = class_register(&enclosure_class);
686 if (err)
687 return err;
James Bottomleyd569d5b2008-02-03 15:40:56 -0600688
689 return 0;
James Bottomleyd569d5b2008-02-03 15:40:56 -0600690}
691
692static void __exit enclosure_exit(void)
693{
James Bottomleyd569d5b2008-02-03 15:40:56 -0600694 class_unregister(&enclosure_class);
695}
696
697module_init(enclosure_init);
698module_exit(enclosure_exit);
699
700MODULE_AUTHOR("James Bottomley");
701MODULE_DESCRIPTION("Enclosure Services");
702MODULE_LICENSE("GPL v2");