[S390] cio: ccw group online store - report rcs to the caller.
[linux-2.6] / drivers / s390 / cio / ccwgroup.c
1 /*
2  *  drivers/s390/cio/ccwgroup.c
3  *  bus driver for ccwgroup
4  *
5  *    Copyright (C) 2002 IBM Deutschland Entwicklung GmbH,
6  *                       IBM Corporation
7  *    Author(s): Arnd Bergmann (arndb@de.ibm.com)
8  *               Cornelia Huck (cornelia.huck@de.ibm.com)
9  */
10 #include <linux/module.h>
11 #include <linux/errno.h>
12 #include <linux/slab.h>
13 #include <linux/list.h>
14 #include <linux/device.h>
15 #include <linux/init.h>
16 #include <linux/ctype.h>
17 #include <linux/dcache.h>
18
19 #include <asm/ccwdev.h>
20 #include <asm/ccwgroup.h>
21
22 #define CCW_BUS_ID_SIZE         20
23
24 /* In Linux 2.4, we had a channel device layer called "chandev"
25  * that did all sorts of obscure stuff for networking devices.
26  * This is another driver that serves as a replacement for just
27  * one of its functions, namely the translation of single subchannels
28  * to devices that use multiple subchannels.
29  */
30
31 /* a device matches a driver if all its slave devices match the same
32  * entry of the driver */
33 static int
34 ccwgroup_bus_match (struct device * dev, struct device_driver * drv)
35 {
36         struct ccwgroup_device *gdev;
37         struct ccwgroup_driver *gdrv;
38
39         gdev = to_ccwgroupdev(dev);
40         gdrv = to_ccwgroupdrv(drv);
41
42         if (gdev->creator_id == gdrv->driver_id)
43                 return 1;
44
45         return 0;
46 }
47 static int
48 ccwgroup_uevent (struct device *dev, struct kobj_uevent_env *env)
49 {
50         /* TODO */
51         return 0;
52 }
53
54 static struct bus_type ccwgroup_bus_type;
55
56 static void
57 __ccwgroup_remove_symlinks(struct ccwgroup_device *gdev)
58 {
59         int i;
60         char str[8];
61
62         for (i = 0; i < gdev->count; i++) {
63                 sprintf(str, "cdev%d", i);
64                 sysfs_remove_link(&gdev->dev.kobj, str);
65                 sysfs_remove_link(&gdev->cdev[i]->dev.kobj, "group_device");
66         }
67         
68 }
69
70 /*
71  * Provide an 'ungroup' attribute so the user can remove group devices no
72  * longer needed or accidentially created. Saves memory :)
73  */
74 static void ccwgroup_ungroup_callback(struct device *dev)
75 {
76         struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
77
78         mutex_lock(&gdev->reg_mutex);
79         if (device_is_registered(&gdev->dev)) {
80                 __ccwgroup_remove_symlinks(gdev);
81                 device_unregister(dev);
82         }
83         mutex_unlock(&gdev->reg_mutex);
84 }
85
86 static ssize_t
87 ccwgroup_ungroup_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
88 {
89         struct ccwgroup_device *gdev;
90         int rc;
91
92         gdev = to_ccwgroupdev(dev);
93
94         /* Prevent concurrent online/offline processing and ungrouping. */
95         if (atomic_cmpxchg(&gdev->onoff, 0, 1) != 0)
96                 return -EAGAIN;
97         if (gdev->state != CCWGROUP_OFFLINE) {
98                 rc = -EINVAL;
99                 goto out;
100         }
101         /* Note that we cannot unregister the device from one of its
102          * attribute methods, so we have to use this roundabout approach.
103          */
104         rc = device_schedule_callback(dev, ccwgroup_ungroup_callback);
105 out:
106         if (rc) {
107                 /* Release onoff "lock" when ungrouping failed. */
108                 atomic_set(&gdev->onoff, 0);
109                 return rc;
110         }
111         return count;
112 }
113
114 static DEVICE_ATTR(ungroup, 0200, NULL, ccwgroup_ungroup_store);
115
116 static void
117 ccwgroup_release (struct device *dev)
118 {
119         struct ccwgroup_device *gdev;
120         int i;
121
122         gdev = to_ccwgroupdev(dev);
123
124         for (i = 0; i < gdev->count; i++) {
125                 if (gdev->cdev[i]) {
126                         if (dev_get_drvdata(&gdev->cdev[i]->dev) == gdev)
127                                 dev_set_drvdata(&gdev->cdev[i]->dev, NULL);
128                         put_device(&gdev->cdev[i]->dev);
129                 }
130         }
131         kfree(gdev);
132 }
133
134 static int
135 __ccwgroup_create_symlinks(struct ccwgroup_device *gdev)
136 {
137         char str[8];
138         int i, rc;
139
140         for (i = 0; i < gdev->count; i++) {
141                 rc = sysfs_create_link(&gdev->cdev[i]->dev.kobj, &gdev->dev.kobj,
142                                        "group_device");
143                 if (rc) {
144                         for (--i; i >= 0; i--)
145                                 sysfs_remove_link(&gdev->cdev[i]->dev.kobj,
146                                                   "group_device");
147                         return rc;
148                 }
149         }
150         for (i = 0; i < gdev->count; i++) {
151                 sprintf(str, "cdev%d", i);
152                 rc = sysfs_create_link(&gdev->dev.kobj, &gdev->cdev[i]->dev.kobj,
153                                        str);
154                 if (rc) {
155                         for (--i; i >= 0; i--) {
156                                 sprintf(str, "cdev%d", i);
157                                 sysfs_remove_link(&gdev->dev.kobj, str);
158                         }
159                         for (i = 0; i < gdev->count; i++)
160                                 sysfs_remove_link(&gdev->cdev[i]->dev.kobj,
161                                                   "group_device");
162                         return rc;
163                 }
164         }
165         return 0;
166 }
167
168 static int __get_next_bus_id(const char **buf, char *bus_id)
169 {
170         int rc, len;
171         char *start, *end;
172
173         start = (char *)*buf;
174         end = strchr(start, ',');
175         if (!end) {
176                 /* Last entry. Strip trailing newline, if applicable. */
177                 end = strchr(start, '\n');
178                 if (end)
179                         *end = '\0';
180                 len = strlen(start) + 1;
181         } else {
182                 len = end - start + 1;
183                 end++;
184         }
185         if (len < CCW_BUS_ID_SIZE) {
186                 strlcpy(bus_id, start, len);
187                 rc = 0;
188         } else
189                 rc = -EINVAL;
190         *buf = end;
191         return rc;
192 }
193
194 static int __is_valid_bus_id(char bus_id[CCW_BUS_ID_SIZE])
195 {
196         int cssid, ssid, devno;
197
198         /* Must be of form %x.%x.%04x */
199         if (sscanf(bus_id, "%x.%1x.%04x", &cssid, &ssid, &devno) != 3)
200                 return 0;
201         return 1;
202 }
203
204 /**
205  * ccwgroup_create_from_string() - create and register a ccw group device
206  * @root: parent device for the new device
207  * @creator_id: identifier of creating driver
208  * @cdrv: ccw driver of slave devices
209  * @num_devices: number of slave devices
210  * @buf: buffer containing comma separated bus ids of slave devices
211  *
212  * Create and register a new ccw group device as a child of @root. Slave
213  * devices are obtained from the list of bus ids given in @buf and must all
214  * belong to @cdrv.
215  * Returns:
216  *  %0 on success and an error code on failure.
217  * Context:
218  *  non-atomic
219  */
220 int ccwgroup_create_from_string(struct device *root, unsigned int creator_id,
221                                 struct ccw_driver *cdrv, int num_devices,
222                                 const char *buf)
223 {
224         struct ccwgroup_device *gdev;
225         int rc, i;
226         char tmp_bus_id[CCW_BUS_ID_SIZE];
227         const char *curr_buf;
228
229         gdev = kzalloc(sizeof(*gdev) + num_devices * sizeof(gdev->cdev[0]),
230                        GFP_KERNEL);
231         if (!gdev)
232                 return -ENOMEM;
233
234         atomic_set(&gdev->onoff, 0);
235         mutex_init(&gdev->reg_mutex);
236         mutex_lock(&gdev->reg_mutex);
237         gdev->creator_id = creator_id;
238         gdev->count = num_devices;
239         gdev->dev.bus = &ccwgroup_bus_type;
240         gdev->dev.parent = root;
241         gdev->dev.release = ccwgroup_release;
242         device_initialize(&gdev->dev);
243
244         curr_buf = buf;
245         for (i = 0; i < num_devices && curr_buf; i++) {
246                 rc = __get_next_bus_id(&curr_buf, tmp_bus_id);
247                 if (rc != 0)
248                         goto error;
249                 if (!__is_valid_bus_id(tmp_bus_id)) {
250                         rc = -EINVAL;
251                         goto error;
252                 }
253                 gdev->cdev[i] = get_ccwdev_by_busid(cdrv, tmp_bus_id);
254                 /*
255                  * All devices have to be of the same type in
256                  * order to be grouped.
257                  */
258                 if (!gdev->cdev[i]
259                     || gdev->cdev[i]->id.driver_info !=
260                     gdev->cdev[0]->id.driver_info) {
261                         rc = -EINVAL;
262                         goto error;
263                 }
264                 /* Don't allow a device to belong to more than one group. */
265                 if (dev_get_drvdata(&gdev->cdev[i]->dev)) {
266                         rc = -EINVAL;
267                         goto error;
268                 }
269                 dev_set_drvdata(&gdev->cdev[i]->dev, gdev);
270         }
271         /* Check for sufficient number of bus ids. */
272         if (i < num_devices && !curr_buf) {
273                 rc = -EINVAL;
274                 goto error;
275         }
276         /* Check for trailing stuff. */
277         if (i == num_devices && strlen(curr_buf) > 0) {
278                 rc = -EINVAL;
279                 goto error;
280         }
281
282         dev_set_name(&gdev->dev, "%s", dev_name(&gdev->cdev[0]->dev));
283
284         rc = device_add(&gdev->dev);
285         if (rc)
286                 goto error;
287         get_device(&gdev->dev);
288         rc = device_create_file(&gdev->dev, &dev_attr_ungroup);
289
290         if (rc) {
291                 device_unregister(&gdev->dev);
292                 goto error;
293         }
294
295         rc = __ccwgroup_create_symlinks(gdev);
296         if (!rc) {
297                 mutex_unlock(&gdev->reg_mutex);
298                 put_device(&gdev->dev);
299                 return 0;
300         }
301         device_remove_file(&gdev->dev, &dev_attr_ungroup);
302         device_unregister(&gdev->dev);
303 error:
304         for (i = 0; i < num_devices; i++)
305                 if (gdev->cdev[i]) {
306                         if (dev_get_drvdata(&gdev->cdev[i]->dev) == gdev)
307                                 dev_set_drvdata(&gdev->cdev[i]->dev, NULL);
308                         put_device(&gdev->cdev[i]->dev);
309                         gdev->cdev[i] = NULL;
310                 }
311         mutex_unlock(&gdev->reg_mutex);
312         put_device(&gdev->dev);
313         return rc;
314 }
315 EXPORT_SYMBOL(ccwgroup_create_from_string);
316
317 static int __init
318 init_ccwgroup (void)
319 {
320         return bus_register (&ccwgroup_bus_type);
321 }
322
323 static void __exit
324 cleanup_ccwgroup (void)
325 {
326         bus_unregister (&ccwgroup_bus_type);
327 }
328
329 module_init(init_ccwgroup);
330 module_exit(cleanup_ccwgroup);
331
332 /************************** driver stuff ******************************/
333
334 static int
335 ccwgroup_set_online(struct ccwgroup_device *gdev)
336 {
337         struct ccwgroup_driver *gdrv;
338         int ret;
339
340         if (atomic_cmpxchg(&gdev->onoff, 0, 1) != 0)
341                 return -EAGAIN;
342         if (gdev->state == CCWGROUP_ONLINE) {
343                 ret = 0;
344                 goto out;
345         }
346         if (!gdev->dev.driver) {
347                 ret = -EINVAL;
348                 goto out;
349         }
350         gdrv = to_ccwgroupdrv (gdev->dev.driver);
351         if ((ret = gdrv->set_online ? gdrv->set_online(gdev) : 0))
352                 goto out;
353
354         gdev->state = CCWGROUP_ONLINE;
355  out:
356         atomic_set(&gdev->onoff, 0);
357         return ret;
358 }
359
360 static int
361 ccwgroup_set_offline(struct ccwgroup_device *gdev)
362 {
363         struct ccwgroup_driver *gdrv;
364         int ret;
365
366         if (atomic_cmpxchg(&gdev->onoff, 0, 1) != 0)
367                 return -EAGAIN;
368         if (gdev->state == CCWGROUP_OFFLINE) {
369                 ret = 0;
370                 goto out;
371         }
372         if (!gdev->dev.driver) {
373                 ret = -EINVAL;
374                 goto out;
375         }
376         gdrv = to_ccwgroupdrv (gdev->dev.driver);
377         if ((ret = gdrv->set_offline ? gdrv->set_offline(gdev) : 0))
378                 goto out;
379
380         gdev->state = CCWGROUP_OFFLINE;
381  out:
382         atomic_set(&gdev->onoff, 0);
383         return ret;
384 }
385
386 static ssize_t
387 ccwgroup_online_store (struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
388 {
389         struct ccwgroup_device *gdev;
390         struct ccwgroup_driver *gdrv;
391         unsigned long value;
392         int ret;
393
394         if (!dev->driver)
395                 return -ENODEV;
396
397         gdev = to_ccwgroupdev(dev);
398         gdrv = to_ccwgroupdrv(dev->driver);
399
400         if (!try_module_get(gdrv->owner))
401                 return -EINVAL;
402
403         ret = strict_strtoul(buf, 0, &value);
404         if (ret)
405                 goto out;
406
407         if (value == 1)
408                 ret = ccwgroup_set_online(gdev);
409         else if (value == 0)
410                 ret = ccwgroup_set_offline(gdev);
411         else
412                 ret = -EINVAL;
413 out:
414         module_put(gdrv->owner);
415         return (ret == 0) ? count : ret;
416 }
417
418 static ssize_t
419 ccwgroup_online_show (struct device *dev, struct device_attribute *attr, char *buf)
420 {
421         int online;
422
423         online = (to_ccwgroupdev(dev)->state == CCWGROUP_ONLINE);
424
425         return sprintf(buf, online ? "1\n" : "0\n");
426 }
427
428 static DEVICE_ATTR(online, 0644, ccwgroup_online_show, ccwgroup_online_store);
429
430 static int
431 ccwgroup_probe (struct device *dev)
432 {
433         struct ccwgroup_device *gdev;
434         struct ccwgroup_driver *gdrv;
435
436         int ret;
437
438         gdev = to_ccwgroupdev(dev);
439         gdrv = to_ccwgroupdrv(dev->driver);
440
441         if ((ret = device_create_file(dev, &dev_attr_online)))
442                 return ret;
443
444         ret = gdrv->probe ? gdrv->probe(gdev) : -ENODEV;
445         if (ret)
446                 device_remove_file(dev, &dev_attr_online);
447
448         return ret;
449 }
450
451 static int
452 ccwgroup_remove (struct device *dev)
453 {
454         struct ccwgroup_device *gdev;
455         struct ccwgroup_driver *gdrv;
456
457         gdev = to_ccwgroupdev(dev);
458         gdrv = to_ccwgroupdrv(dev->driver);
459
460         device_remove_file(dev, &dev_attr_online);
461
462         if (gdrv && gdrv->remove)
463                 gdrv->remove(gdev);
464         return 0;
465 }
466
467 static void ccwgroup_shutdown(struct device *dev)
468 {
469         struct ccwgroup_device *gdev;
470         struct ccwgroup_driver *gdrv;
471
472         gdev = to_ccwgroupdev(dev);
473         gdrv = to_ccwgroupdrv(dev->driver);
474         if (gdrv && gdrv->shutdown)
475                 gdrv->shutdown(gdev);
476 }
477
478 static struct bus_type ccwgroup_bus_type = {
479         .name   = "ccwgroup",
480         .match  = ccwgroup_bus_match,
481         .uevent = ccwgroup_uevent,
482         .probe  = ccwgroup_probe,
483         .remove = ccwgroup_remove,
484         .shutdown = ccwgroup_shutdown,
485 };
486
487 /**
488  * ccwgroup_driver_register() - register a ccw group driver
489  * @cdriver: driver to be registered
490  *
491  * This function is mainly a wrapper around driver_register().
492  */
493 int ccwgroup_driver_register(struct ccwgroup_driver *cdriver)
494 {
495         /* register our new driver with the core */
496         cdriver->driver.bus = &ccwgroup_bus_type;
497         cdriver->driver.name = cdriver->name;
498         cdriver->driver.owner = cdriver->owner;
499
500         return driver_register(&cdriver->driver);
501 }
502
503 static int
504 __ccwgroup_match_all(struct device *dev, void *data)
505 {
506         return 1;
507 }
508
509 /**
510  * ccwgroup_driver_unregister() - deregister a ccw group driver
511  * @cdriver: driver to be deregistered
512  *
513  * This function is mainly a wrapper around driver_unregister().
514  */
515 void ccwgroup_driver_unregister(struct ccwgroup_driver *cdriver)
516 {
517         struct device *dev;
518
519         /* We don't want ccwgroup devices to live longer than their driver. */
520         get_driver(&cdriver->driver);
521         while ((dev = driver_find_device(&cdriver->driver, NULL, NULL,
522                                          __ccwgroup_match_all))) {
523                 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
524
525                 mutex_lock(&gdev->reg_mutex);
526                 __ccwgroup_remove_symlinks(gdev);
527                 device_unregister(dev);
528                 mutex_unlock(&gdev->reg_mutex);
529                 put_device(dev);
530         }
531         put_driver(&cdriver->driver);
532         driver_unregister(&cdriver->driver);
533 }
534
535 /**
536  * ccwgroup_probe_ccwdev() - probe function for slave devices
537  * @cdev: ccw device to be probed
538  *
539  * This is a dummy probe function for ccw devices that are slave devices in
540  * a ccw group device.
541  * Returns:
542  *  always %0
543  */
544 int ccwgroup_probe_ccwdev(struct ccw_device *cdev)
545 {
546         return 0;
547 }
548
549 static struct ccwgroup_device *
550 __ccwgroup_get_gdev_by_cdev(struct ccw_device *cdev)
551 {
552         struct ccwgroup_device *gdev;
553
554         gdev = dev_get_drvdata(&cdev->dev);
555         if (gdev) {
556                 if (get_device(&gdev->dev)) {
557                         mutex_lock(&gdev->reg_mutex);
558                         if (device_is_registered(&gdev->dev))
559                                 return gdev;
560                         mutex_unlock(&gdev->reg_mutex);
561                         put_device(&gdev->dev);
562                 }
563                 return NULL;
564         }
565         return NULL;
566 }
567
568 /**
569  * ccwgroup_remove_ccwdev() - remove function for slave devices
570  * @cdev: ccw device to be removed
571  *
572  * This is a remove function for ccw devices that are slave devices in a ccw
573  * group device. It sets the ccw device offline and also deregisters the
574  * embedding ccw group device.
575  */
576 void ccwgroup_remove_ccwdev(struct ccw_device *cdev)
577 {
578         struct ccwgroup_device *gdev;
579
580         /* Ignore offlining errors, device is gone anyway. */
581         ccw_device_set_offline(cdev);
582         /* If one of its devices is gone, the whole group is done for. */
583         gdev = __ccwgroup_get_gdev_by_cdev(cdev);
584         if (gdev) {
585                 __ccwgroup_remove_symlinks(gdev);
586                 device_unregister(&gdev->dev);
587                 mutex_unlock(&gdev->reg_mutex);
588                 put_device(&gdev->dev);
589         }
590 }
591
592 MODULE_LICENSE("GPL");
593 EXPORT_SYMBOL(ccwgroup_driver_register);
594 EXPORT_SYMBOL(ccwgroup_driver_unregister);
595 EXPORT_SYMBOL(ccwgroup_probe_ccwdev);
596 EXPORT_SYMBOL(ccwgroup_remove_ccwdev);