xref: /openbmc/linux/drivers/scsi/raid_class.c (revision 61a7afa2)
161a7afa2SJames Bottomley /*
261a7afa2SJames Bottomley  * RAID Attributes
361a7afa2SJames Bottomley  */
461a7afa2SJames Bottomley #include <linux/init.h>
561a7afa2SJames Bottomley #include <linux/module.h>
661a7afa2SJames Bottomley #include <linux/list.h>
761a7afa2SJames Bottomley #include <linux/raid_class.h>
861a7afa2SJames Bottomley #include <scsi/scsi_device.h>
961a7afa2SJames Bottomley #include <scsi/scsi_host.h>
1061a7afa2SJames Bottomley 
1161a7afa2SJames Bottomley #define RAID_NUM_ATTRS	3
1261a7afa2SJames Bottomley 
1361a7afa2SJames Bottomley struct raid_internal {
1461a7afa2SJames Bottomley 	struct raid_template r;
1561a7afa2SJames Bottomley 	struct raid_function_template *f;
1661a7afa2SJames Bottomley 	/* The actual attributes */
1761a7afa2SJames Bottomley 	struct class_device_attribute private_attrs[RAID_NUM_ATTRS];
1861a7afa2SJames Bottomley 	/* The array of null terminated pointers to attributes
1961a7afa2SJames Bottomley 	 * needed by scsi_sysfs.c */
2061a7afa2SJames Bottomley 	struct class_device_attribute *attrs[RAID_NUM_ATTRS + 1];
2161a7afa2SJames Bottomley };
2261a7afa2SJames Bottomley 
2361a7afa2SJames Bottomley struct raid_component {
2461a7afa2SJames Bottomley 	struct list_head node;
2561a7afa2SJames Bottomley 	struct device *dev;
2661a7afa2SJames Bottomley 	int num;
2761a7afa2SJames Bottomley };
2861a7afa2SJames Bottomley 
2961a7afa2SJames Bottomley #define to_raid_internal(tmpl)	container_of(tmpl, struct raid_internal, r)
3061a7afa2SJames Bottomley 
3161a7afa2SJames Bottomley #define tc_to_raid_internal(tcont) ({					\
3261a7afa2SJames Bottomley 	struct raid_template *r =					\
3361a7afa2SJames Bottomley 		container_of(tcont, struct raid_template, raid_attrs);	\
3461a7afa2SJames Bottomley 	to_raid_internal(r);						\
3561a7afa2SJames Bottomley })
3661a7afa2SJames Bottomley 
3761a7afa2SJames Bottomley #define ac_to_raid_internal(acont) ({					\
3861a7afa2SJames Bottomley 	struct transport_container *tc =				\
3961a7afa2SJames Bottomley 		container_of(acont, struct transport_container, ac);	\
4061a7afa2SJames Bottomley 	tc_to_raid_internal(tc);					\
4161a7afa2SJames Bottomley })
4261a7afa2SJames Bottomley 
4361a7afa2SJames Bottomley #define class_device_to_raid_internal(cdev) ({				\
4461a7afa2SJames Bottomley 	struct attribute_container *ac =				\
4561a7afa2SJames Bottomley 		attribute_container_classdev_to_container(cdev);	\
4661a7afa2SJames Bottomley 	ac_to_raid_internal(ac);					\
4761a7afa2SJames Bottomley })
4861a7afa2SJames Bottomley 
4961a7afa2SJames Bottomley 
5061a7afa2SJames Bottomley static int raid_match(struct attribute_container *cont, struct device *dev)
5161a7afa2SJames Bottomley {
5261a7afa2SJames Bottomley 	/* We have to look for every subsystem that could house
5361a7afa2SJames Bottomley 	 * emulated RAID devices, so start with SCSI */
5461a7afa2SJames Bottomley 	struct raid_internal *i = ac_to_raid_internal(cont);
5561a7afa2SJames Bottomley 
5661a7afa2SJames Bottomley 	if (scsi_is_sdev_device(dev)) {
5761a7afa2SJames Bottomley 		struct scsi_device *sdev = to_scsi_device(dev);
5861a7afa2SJames Bottomley 
5961a7afa2SJames Bottomley 		if (i->f->cookie != sdev->host->hostt)
6061a7afa2SJames Bottomley 			return 0;
6161a7afa2SJames Bottomley 
6261a7afa2SJames Bottomley 		return i->f->is_raid(dev);
6361a7afa2SJames Bottomley 	}
6461a7afa2SJames Bottomley 	/* FIXME: look at other subsystems too */
6561a7afa2SJames Bottomley 	return 0;
6661a7afa2SJames Bottomley }
6761a7afa2SJames Bottomley 
6861a7afa2SJames Bottomley static int raid_setup(struct transport_container *tc, struct device *dev,
6961a7afa2SJames Bottomley 		       struct class_device *cdev)
7061a7afa2SJames Bottomley {
7161a7afa2SJames Bottomley 	struct raid_data *rd;
7261a7afa2SJames Bottomley 
7361a7afa2SJames Bottomley 	BUG_ON(class_get_devdata(cdev));
7461a7afa2SJames Bottomley 
7561a7afa2SJames Bottomley 	rd = kmalloc(sizeof(*rd), GFP_KERNEL);
7661a7afa2SJames Bottomley 	if (!rd)
7761a7afa2SJames Bottomley 		return -ENOMEM;
7861a7afa2SJames Bottomley 
7961a7afa2SJames Bottomley 	memset(rd, 0, sizeof(*rd));
8061a7afa2SJames Bottomley 	INIT_LIST_HEAD(&rd->component_list);
8161a7afa2SJames Bottomley 	class_set_devdata(cdev, rd);
8261a7afa2SJames Bottomley 
8361a7afa2SJames Bottomley 	return 0;
8461a7afa2SJames Bottomley }
8561a7afa2SJames Bottomley 
8661a7afa2SJames Bottomley static int raid_remove(struct transport_container *tc, struct device *dev,
8761a7afa2SJames Bottomley 		       struct class_device *cdev)
8861a7afa2SJames Bottomley {
8961a7afa2SJames Bottomley 	struct raid_data *rd = class_get_devdata(cdev);
9061a7afa2SJames Bottomley 	struct raid_component *rc, *next;
9161a7afa2SJames Bottomley 	class_set_devdata(cdev, NULL);
9261a7afa2SJames Bottomley 	list_for_each_entry_safe(rc, next, &rd->component_list, node) {
9361a7afa2SJames Bottomley 		char buf[40];
9461a7afa2SJames Bottomley 		snprintf(buf, sizeof(buf), "component-%d", rc->num);
9561a7afa2SJames Bottomley 		list_del(&rc->node);
9661a7afa2SJames Bottomley 		sysfs_remove_link(&cdev->kobj, buf);
9761a7afa2SJames Bottomley 		kfree(rc);
9861a7afa2SJames Bottomley 	}
9961a7afa2SJames Bottomley 	kfree(class_get_devdata(cdev));
10061a7afa2SJames Bottomley 	return 0;
10161a7afa2SJames Bottomley }
10261a7afa2SJames Bottomley 
10361a7afa2SJames Bottomley static DECLARE_TRANSPORT_CLASS(raid_class,
10461a7afa2SJames Bottomley 			       "raid_devices",
10561a7afa2SJames Bottomley 			       raid_setup,
10661a7afa2SJames Bottomley 			       raid_remove,
10761a7afa2SJames Bottomley 			       NULL);
10861a7afa2SJames Bottomley 
10961a7afa2SJames Bottomley static struct {
11061a7afa2SJames Bottomley 	enum raid_state	value;
11161a7afa2SJames Bottomley 	char		*name;
11261a7afa2SJames Bottomley } raid_states[] = {
11361a7afa2SJames Bottomley 	{ RAID_ACTIVE, "active" },
11461a7afa2SJames Bottomley 	{ RAID_DEGRADED, "degraded" },
11561a7afa2SJames Bottomley 	{ RAID_RESYNCING, "resyncing" },
11661a7afa2SJames Bottomley 	{ RAID_OFFLINE, "offline" },
11761a7afa2SJames Bottomley };
11861a7afa2SJames Bottomley 
11961a7afa2SJames Bottomley static const char *raid_state_name(enum raid_state state)
12061a7afa2SJames Bottomley {
12161a7afa2SJames Bottomley 	int i;
12261a7afa2SJames Bottomley 	char *name = NULL;
12361a7afa2SJames Bottomley 
12461a7afa2SJames Bottomley 	for (i = 0; i < sizeof(raid_states)/sizeof(raid_states[0]); i++) {
12561a7afa2SJames Bottomley 		if (raid_states[i].value == state) {
12661a7afa2SJames Bottomley 			name = raid_states[i].name;
12761a7afa2SJames Bottomley 			break;
12861a7afa2SJames Bottomley 		}
12961a7afa2SJames Bottomley 	}
13061a7afa2SJames Bottomley 	return name;
13161a7afa2SJames Bottomley }
13261a7afa2SJames Bottomley 
13361a7afa2SJames Bottomley 
13461a7afa2SJames Bottomley #define raid_attr_show_internal(attr, fmt, var, code)			\
13561a7afa2SJames Bottomley static ssize_t raid_show_##attr(struct class_device *cdev, char *buf)	\
13661a7afa2SJames Bottomley {									\
13761a7afa2SJames Bottomley 	struct raid_data *rd = class_get_devdata(cdev);			\
13861a7afa2SJames Bottomley 	code								\
13961a7afa2SJames Bottomley 	return snprintf(buf, 20, #fmt "\n", var);			\
14061a7afa2SJames Bottomley }
14161a7afa2SJames Bottomley 
14261a7afa2SJames Bottomley #define raid_attr_ro_states(attr, states, code)				\
14361a7afa2SJames Bottomley raid_attr_show_internal(attr, %s, name,					\
14461a7afa2SJames Bottomley 	const char *name;						\
14561a7afa2SJames Bottomley 	code								\
14661a7afa2SJames Bottomley 	name = raid_##states##_name(rd->attr);				\
14761a7afa2SJames Bottomley )									\
14861a7afa2SJames Bottomley static CLASS_DEVICE_ATTR(attr, S_IRUGO, raid_show_##attr, NULL)
14961a7afa2SJames Bottomley 
15061a7afa2SJames Bottomley 
15161a7afa2SJames Bottomley #define raid_attr_ro_internal(attr, code)				\
15261a7afa2SJames Bottomley raid_attr_show_internal(attr, %d, rd->attr, code)			\
15361a7afa2SJames Bottomley static CLASS_DEVICE_ATTR(attr, S_IRUGO, raid_show_##attr, NULL)
15461a7afa2SJames Bottomley 
15561a7afa2SJames Bottomley #define ATTR_CODE(attr)							\
15661a7afa2SJames Bottomley 	struct raid_internal *i = class_device_to_raid_internal(cdev);	\
15761a7afa2SJames Bottomley 	if (i->f->get_##attr)						\
15861a7afa2SJames Bottomley 		i->f->get_##attr(cdev->dev);
15961a7afa2SJames Bottomley 
16061a7afa2SJames Bottomley #define raid_attr_ro(attr)	raid_attr_ro_internal(attr, )
16161a7afa2SJames Bottomley #define raid_attr_ro_fn(attr)	raid_attr_ro_internal(attr, ATTR_CODE(attr))
16261a7afa2SJames Bottomley #define raid_attr_ro_state(attr)	raid_attr_ro_states(attr, attr, ATTR_CODE(attr))
16361a7afa2SJames Bottomley 
16461a7afa2SJames Bottomley raid_attr_ro(level);
16561a7afa2SJames Bottomley raid_attr_ro_fn(resync);
16661a7afa2SJames Bottomley raid_attr_ro_state(state);
16761a7afa2SJames Bottomley 
16861a7afa2SJames Bottomley void raid_component_add(struct raid_template *r,struct device *raid_dev,
16961a7afa2SJames Bottomley 			struct device *component_dev)
17061a7afa2SJames Bottomley {
17161a7afa2SJames Bottomley 	struct class_device *cdev =
17261a7afa2SJames Bottomley 		attribute_container_find_class_device(&r->raid_attrs.ac,
17361a7afa2SJames Bottomley 						      raid_dev);
17461a7afa2SJames Bottomley 	struct raid_component *rc;
17561a7afa2SJames Bottomley 	struct raid_data *rd = class_get_devdata(cdev);
17661a7afa2SJames Bottomley 	char buf[40];
17761a7afa2SJames Bottomley 
17861a7afa2SJames Bottomley 	rc = kmalloc(sizeof(*rc), GFP_KERNEL);
17961a7afa2SJames Bottomley 	if (!rc)
18061a7afa2SJames Bottomley 		return;
18161a7afa2SJames Bottomley 
18261a7afa2SJames Bottomley 	INIT_LIST_HEAD(&rc->node);
18361a7afa2SJames Bottomley 	rc->dev = component_dev;
18461a7afa2SJames Bottomley 	rc->num = rd->component_count++;
18561a7afa2SJames Bottomley 
18661a7afa2SJames Bottomley 	snprintf(buf, sizeof(buf), "component-%d", rc->num);
18761a7afa2SJames Bottomley 	list_add_tail(&rc->node, &rd->component_list);
18861a7afa2SJames Bottomley 	sysfs_create_link(&cdev->kobj, &component_dev->kobj, buf);
18961a7afa2SJames Bottomley }
19061a7afa2SJames Bottomley EXPORT_SYMBOL(raid_component_add);
19161a7afa2SJames Bottomley 
19261a7afa2SJames Bottomley struct raid_template *
19361a7afa2SJames Bottomley raid_class_attach(struct raid_function_template *ft)
19461a7afa2SJames Bottomley {
19561a7afa2SJames Bottomley 	struct raid_internal *i = kmalloc(sizeof(struct raid_internal),
19661a7afa2SJames Bottomley 					  GFP_KERNEL);
19761a7afa2SJames Bottomley 	int count = 0;
19861a7afa2SJames Bottomley 
19961a7afa2SJames Bottomley 	if (unlikely(!i))
20061a7afa2SJames Bottomley 		return NULL;
20161a7afa2SJames Bottomley 
20261a7afa2SJames Bottomley 	memset(i, 0, sizeof(*i));
20361a7afa2SJames Bottomley 
20461a7afa2SJames Bottomley 	i->f = ft;
20561a7afa2SJames Bottomley 
20661a7afa2SJames Bottomley 	i->r.raid_attrs.ac.class = &raid_class.class;
20761a7afa2SJames Bottomley 	i->r.raid_attrs.ac.match = raid_match;
20861a7afa2SJames Bottomley 	i->r.raid_attrs.ac.attrs = &i->attrs[0];
20961a7afa2SJames Bottomley 
21061a7afa2SJames Bottomley 	attribute_container_register(&i->r.raid_attrs.ac);
21161a7afa2SJames Bottomley 
21261a7afa2SJames Bottomley 	i->attrs[count++] = &class_device_attr_level;
21361a7afa2SJames Bottomley 	i->attrs[count++] = &class_device_attr_resync;
21461a7afa2SJames Bottomley 	i->attrs[count++] = &class_device_attr_state;
21561a7afa2SJames Bottomley 
21661a7afa2SJames Bottomley 	i->attrs[count] = NULL;
21761a7afa2SJames Bottomley 	BUG_ON(count > RAID_NUM_ATTRS);
21861a7afa2SJames Bottomley 
21961a7afa2SJames Bottomley 	return &i->r;
22061a7afa2SJames Bottomley }
22161a7afa2SJames Bottomley EXPORT_SYMBOL(raid_class_attach);
22261a7afa2SJames Bottomley 
22361a7afa2SJames Bottomley void
22461a7afa2SJames Bottomley raid_class_release(struct raid_template *r)
22561a7afa2SJames Bottomley {
22661a7afa2SJames Bottomley 	struct raid_internal *i = to_raid_internal(r);
22761a7afa2SJames Bottomley 
22861a7afa2SJames Bottomley 	attribute_container_unregister(&i->r.raid_attrs.ac);
22961a7afa2SJames Bottomley 
23061a7afa2SJames Bottomley 	kfree(i);
23161a7afa2SJames Bottomley }
23261a7afa2SJames Bottomley EXPORT_SYMBOL(raid_class_release);
23361a7afa2SJames Bottomley 
23461a7afa2SJames Bottomley static __init int raid_init(void)
23561a7afa2SJames Bottomley {
23661a7afa2SJames Bottomley 	return transport_class_register(&raid_class);
23761a7afa2SJames Bottomley }
23861a7afa2SJames Bottomley 
23961a7afa2SJames Bottomley static __exit void raid_exit(void)
24061a7afa2SJames Bottomley {
24161a7afa2SJames Bottomley 	transport_class_unregister(&raid_class);
24261a7afa2SJames Bottomley }
24361a7afa2SJames Bottomley 
24461a7afa2SJames Bottomley MODULE_AUTHOR("James Bottomley");
24561a7afa2SJames Bottomley MODULE_DESCRIPTION("RAID device class");
24661a7afa2SJames Bottomley MODULE_LICENSE("GPL");
24761a7afa2SJames Bottomley 
24861a7afa2SJames Bottomley module_init(raid_init);
24961a7afa2SJames Bottomley module_exit(raid_exit);
25061a7afa2SJames Bottomley 
251