Linux 5.1.15
[linux/fpc-iii.git] / drivers / s390 / cio / ccwgroup.c
blob4ebf6d4fc66cbed6d7493892620e3a78a55040cb
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * bus driver for ccwgroup
5 * Copyright IBM Corp. 2002, 2012
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>
19 #include <asm/cio.h>
20 #include <asm/ccwdev.h>
21 #include <asm/ccwgroup.h>
23 #include "device.h"
25 #define CCW_BUS_ID_SIZE 10
27 /* In Linux 2.4, we had a channel device layer called "chandev"
28 * that did all sorts of obscure stuff for networking devices.
29 * This is another driver that serves as a replacement for just
30 * one of its functions, namely the translation of single subchannels
31 * to devices that use multiple subchannels.
34 static struct bus_type ccwgroup_bus_type;
36 static void __ccwgroup_remove_symlinks(struct ccwgroup_device *gdev)
38 int i;
39 char str[16];
41 for (i = 0; i < gdev->count; i++) {
42 sprintf(str, "cdev%d", i);
43 sysfs_remove_link(&gdev->dev.kobj, str);
44 sysfs_remove_link(&gdev->cdev[i]->dev.kobj, "group_device");
49 * Remove references from ccw devices to ccw group device and from
50 * ccw group device to ccw devices.
52 static void __ccwgroup_remove_cdev_refs(struct ccwgroup_device *gdev)
54 struct ccw_device *cdev;
55 int i;
57 for (i = 0; i < gdev->count; i++) {
58 cdev = gdev->cdev[i];
59 if (!cdev)
60 continue;
61 spin_lock_irq(cdev->ccwlock);
62 dev_set_drvdata(&cdev->dev, NULL);
63 spin_unlock_irq(cdev->ccwlock);
64 gdev->cdev[i] = NULL;
65 put_device(&cdev->dev);
69 /**
70 * ccwgroup_set_online() - enable a ccwgroup device
71 * @gdev: target ccwgroup device
73 * This function attempts to put the ccwgroup device into the online state.
74 * Returns:
75 * %0 on success and a negative error value on failure.
77 int ccwgroup_set_online(struct ccwgroup_device *gdev)
79 struct ccwgroup_driver *gdrv = to_ccwgroupdrv(gdev->dev.driver);
80 int ret = -EINVAL;
82 if (atomic_cmpxchg(&gdev->onoff, 0, 1) != 0)
83 return -EAGAIN;
84 if (gdev->state == CCWGROUP_ONLINE)
85 goto out;
86 if (gdrv->set_online)
87 ret = gdrv->set_online(gdev);
88 if (ret)
89 goto out;
91 gdev->state = CCWGROUP_ONLINE;
92 out:
93 atomic_set(&gdev->onoff, 0);
94 return ret;
96 EXPORT_SYMBOL(ccwgroup_set_online);
98 /**
99 * ccwgroup_set_offline() - disable a ccwgroup device
100 * @gdev: target ccwgroup device
102 * This function attempts to put the ccwgroup device into the offline state.
103 * Returns:
104 * %0 on success and a negative error value on failure.
106 int ccwgroup_set_offline(struct ccwgroup_device *gdev)
108 struct ccwgroup_driver *gdrv = to_ccwgroupdrv(gdev->dev.driver);
109 int ret = -EINVAL;
111 if (atomic_cmpxchg(&gdev->onoff, 0, 1) != 0)
112 return -EAGAIN;
113 if (gdev->state == CCWGROUP_OFFLINE)
114 goto out;
115 if (gdrv->set_offline)
116 ret = gdrv->set_offline(gdev);
117 if (ret)
118 goto out;
120 gdev->state = CCWGROUP_OFFLINE;
121 out:
122 atomic_set(&gdev->onoff, 0);
123 return ret;
125 EXPORT_SYMBOL(ccwgroup_set_offline);
127 static ssize_t ccwgroup_online_store(struct device *dev,
128 struct device_attribute *attr,
129 const char *buf, size_t count)
131 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
132 unsigned long value;
133 int ret;
135 device_lock(dev);
136 if (!dev->driver) {
137 ret = -EINVAL;
138 goto out;
141 ret = kstrtoul(buf, 0, &value);
142 if (ret)
143 goto out;
145 if (value == 1)
146 ret = ccwgroup_set_online(gdev);
147 else if (value == 0)
148 ret = ccwgroup_set_offline(gdev);
149 else
150 ret = -EINVAL;
151 out:
152 device_unlock(dev);
153 return (ret == 0) ? count : ret;
156 static ssize_t ccwgroup_online_show(struct device *dev,
157 struct device_attribute *attr,
158 char *buf)
160 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
161 int online;
163 online = (gdev->state == CCWGROUP_ONLINE) ? 1 : 0;
165 return scnprintf(buf, PAGE_SIZE, "%d\n", online);
169 * Provide an 'ungroup' attribute so the user can remove group devices no
170 * longer needed or accidentially created. Saves memory :)
172 static void ccwgroup_ungroup(struct ccwgroup_device *gdev)
174 mutex_lock(&gdev->reg_mutex);
175 if (device_is_registered(&gdev->dev)) {
176 __ccwgroup_remove_symlinks(gdev);
177 device_unregister(&gdev->dev);
178 __ccwgroup_remove_cdev_refs(gdev);
180 mutex_unlock(&gdev->reg_mutex);
183 static ssize_t ccwgroup_ungroup_store(struct device *dev,
184 struct device_attribute *attr,
185 const char *buf, size_t count)
187 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
188 int rc = 0;
190 /* Prevent concurrent online/offline processing and ungrouping. */
191 if (atomic_cmpxchg(&gdev->onoff, 0, 1) != 0)
192 return -EAGAIN;
193 if (gdev->state != CCWGROUP_OFFLINE) {
194 rc = -EINVAL;
195 goto out;
198 if (device_remove_file_self(dev, attr))
199 ccwgroup_ungroup(gdev);
200 else
201 rc = -ENODEV;
202 out:
203 if (rc) {
204 /* Release onoff "lock" when ungrouping failed. */
205 atomic_set(&gdev->onoff, 0);
206 return rc;
208 return count;
210 static DEVICE_ATTR(ungroup, 0200, NULL, ccwgroup_ungroup_store);
211 static DEVICE_ATTR(online, 0644, ccwgroup_online_show, ccwgroup_online_store);
213 static struct attribute *ccwgroup_attrs[] = {
214 &dev_attr_online.attr,
215 &dev_attr_ungroup.attr,
216 NULL,
218 static struct attribute_group ccwgroup_attr_group = {
219 .attrs = ccwgroup_attrs,
221 static const struct attribute_group *ccwgroup_attr_groups[] = {
222 &ccwgroup_attr_group,
223 NULL,
226 static void ccwgroup_ungroup_workfn(struct work_struct *work)
228 struct ccwgroup_device *gdev =
229 container_of(work, struct ccwgroup_device, ungroup_work);
231 ccwgroup_ungroup(gdev);
232 put_device(&gdev->dev);
235 static void ccwgroup_release(struct device *dev)
237 kfree(to_ccwgroupdev(dev));
240 static int __ccwgroup_create_symlinks(struct ccwgroup_device *gdev)
242 char str[16];
243 int i, rc;
245 for (i = 0; i < gdev->count; i++) {
246 rc = sysfs_create_link(&gdev->cdev[i]->dev.kobj,
247 &gdev->dev.kobj, "group_device");
248 if (rc) {
249 for (--i; i >= 0; i--)
250 sysfs_remove_link(&gdev->cdev[i]->dev.kobj,
251 "group_device");
252 return rc;
255 for (i = 0; i < gdev->count; i++) {
256 sprintf(str, "cdev%d", i);
257 rc = sysfs_create_link(&gdev->dev.kobj,
258 &gdev->cdev[i]->dev.kobj, str);
259 if (rc) {
260 for (--i; i >= 0; i--) {
261 sprintf(str, "cdev%d", i);
262 sysfs_remove_link(&gdev->dev.kobj, str);
264 for (i = 0; i < gdev->count; i++)
265 sysfs_remove_link(&gdev->cdev[i]->dev.kobj,
266 "group_device");
267 return rc;
270 return 0;
273 static int __get_next_id(const char **buf, struct ccw_dev_id *id)
275 unsigned int cssid, ssid, devno;
276 int ret = 0, len;
277 char *start, *end;
279 start = (char *)*buf;
280 end = strchr(start, ',');
281 if (!end) {
282 /* Last entry. Strip trailing newline, if applicable. */
283 end = strchr(start, '\n');
284 if (end)
285 *end = '\0';
286 len = strlen(start) + 1;
287 } else {
288 len = end - start + 1;
289 end++;
291 if (len <= CCW_BUS_ID_SIZE) {
292 if (sscanf(start, "%2x.%1x.%04x", &cssid, &ssid, &devno) != 3)
293 ret = -EINVAL;
294 } else
295 ret = -EINVAL;
297 if (!ret) {
298 id->ssid = ssid;
299 id->devno = devno;
301 *buf = end;
302 return ret;
306 * ccwgroup_create_dev() - create and register a ccw group device
307 * @parent: parent device for the new device
308 * @gdrv: driver for the new group device
309 * @num_devices: number of slave devices
310 * @buf: buffer containing comma separated bus ids of slave devices
312 * Create and register a new ccw group device as a child of @parent. Slave
313 * devices are obtained from the list of bus ids given in @buf.
314 * Returns:
315 * %0 on success and an error code on failure.
316 * Context:
317 * non-atomic
319 int ccwgroup_create_dev(struct device *parent, struct ccwgroup_driver *gdrv,
320 int num_devices, const char *buf)
322 struct ccwgroup_device *gdev;
323 struct ccw_dev_id dev_id;
324 int rc, i;
326 if (num_devices < 1)
327 return -EINVAL;
329 gdev = kzalloc(struct_size(gdev, cdev, num_devices), GFP_KERNEL);
330 if (!gdev)
331 return -ENOMEM;
333 atomic_set(&gdev->onoff, 0);
334 mutex_init(&gdev->reg_mutex);
335 mutex_lock(&gdev->reg_mutex);
336 INIT_WORK(&gdev->ungroup_work, ccwgroup_ungroup_workfn);
337 gdev->count = num_devices;
338 gdev->dev.bus = &ccwgroup_bus_type;
339 gdev->dev.parent = parent;
340 gdev->dev.release = ccwgroup_release;
341 device_initialize(&gdev->dev);
343 for (i = 0; i < num_devices && buf; i++) {
344 rc = __get_next_id(&buf, &dev_id);
345 if (rc != 0)
346 goto error;
347 gdev->cdev[i] = get_ccwdev_by_dev_id(&dev_id);
349 * All devices have to be of the same type in
350 * order to be grouped.
352 if (!gdev->cdev[i] || !gdev->cdev[i]->drv ||
353 gdev->cdev[i]->drv != gdev->cdev[0]->drv ||
354 gdev->cdev[i]->id.driver_info !=
355 gdev->cdev[0]->id.driver_info) {
356 rc = -EINVAL;
357 goto error;
359 /* Don't allow a device to belong to more than one group. */
360 spin_lock_irq(gdev->cdev[i]->ccwlock);
361 if (dev_get_drvdata(&gdev->cdev[i]->dev)) {
362 spin_unlock_irq(gdev->cdev[i]->ccwlock);
363 rc = -EINVAL;
364 goto error;
366 dev_set_drvdata(&gdev->cdev[i]->dev, gdev);
367 spin_unlock_irq(gdev->cdev[i]->ccwlock);
369 /* Check for sufficient number of bus ids. */
370 if (i < num_devices) {
371 rc = -EINVAL;
372 goto error;
374 /* Check for trailing stuff. */
375 if (i == num_devices && strlen(buf) > 0) {
376 rc = -EINVAL;
377 goto error;
379 /* Check if the devices are bound to the required ccw driver. */
380 if (gdrv && gdrv->ccw_driver &&
381 gdev->cdev[0]->drv != gdrv->ccw_driver) {
382 rc = -EINVAL;
383 goto error;
386 dev_set_name(&gdev->dev, "%s", dev_name(&gdev->cdev[0]->dev));
387 gdev->dev.groups = ccwgroup_attr_groups;
389 if (gdrv) {
390 gdev->dev.driver = &gdrv->driver;
391 rc = gdrv->setup ? gdrv->setup(gdev) : 0;
392 if (rc)
393 goto error;
395 rc = device_add(&gdev->dev);
396 if (rc)
397 goto error;
398 rc = __ccwgroup_create_symlinks(gdev);
399 if (rc) {
400 device_del(&gdev->dev);
401 goto error;
403 mutex_unlock(&gdev->reg_mutex);
404 return 0;
405 error:
406 for (i = 0; i < num_devices; i++)
407 if (gdev->cdev[i]) {
408 spin_lock_irq(gdev->cdev[i]->ccwlock);
409 if (dev_get_drvdata(&gdev->cdev[i]->dev) == gdev)
410 dev_set_drvdata(&gdev->cdev[i]->dev, NULL);
411 spin_unlock_irq(gdev->cdev[i]->ccwlock);
412 put_device(&gdev->cdev[i]->dev);
413 gdev->cdev[i] = NULL;
415 mutex_unlock(&gdev->reg_mutex);
416 put_device(&gdev->dev);
417 return rc;
419 EXPORT_SYMBOL(ccwgroup_create_dev);
421 static int ccwgroup_notifier(struct notifier_block *nb, unsigned long action,
422 void *data)
424 struct ccwgroup_device *gdev = to_ccwgroupdev(data);
426 if (action == BUS_NOTIFY_UNBIND_DRIVER) {
427 get_device(&gdev->dev);
428 schedule_work(&gdev->ungroup_work);
431 return NOTIFY_OK;
434 static struct notifier_block ccwgroup_nb = {
435 .notifier_call = ccwgroup_notifier
438 static int __init init_ccwgroup(void)
440 int ret;
442 ret = bus_register(&ccwgroup_bus_type);
443 if (ret)
444 return ret;
446 ret = bus_register_notifier(&ccwgroup_bus_type, &ccwgroup_nb);
447 if (ret)
448 bus_unregister(&ccwgroup_bus_type);
450 return ret;
453 static void __exit cleanup_ccwgroup(void)
455 bus_unregister_notifier(&ccwgroup_bus_type, &ccwgroup_nb);
456 bus_unregister(&ccwgroup_bus_type);
459 module_init(init_ccwgroup);
460 module_exit(cleanup_ccwgroup);
462 /************************** driver stuff ******************************/
464 static int ccwgroup_remove(struct device *dev)
466 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
467 struct ccwgroup_driver *gdrv = to_ccwgroupdrv(dev->driver);
469 if (!dev->driver)
470 return 0;
471 if (gdrv->remove)
472 gdrv->remove(gdev);
474 return 0;
477 static void ccwgroup_shutdown(struct device *dev)
479 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
480 struct ccwgroup_driver *gdrv = to_ccwgroupdrv(dev->driver);
482 if (!dev->driver)
483 return;
484 if (gdrv->shutdown)
485 gdrv->shutdown(gdev);
488 static int ccwgroup_pm_prepare(struct device *dev)
490 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
491 struct ccwgroup_driver *gdrv = to_ccwgroupdrv(gdev->dev.driver);
493 /* Fail while device is being set online/offline. */
494 if (atomic_read(&gdev->onoff))
495 return -EAGAIN;
497 if (!gdev->dev.driver || gdev->state != CCWGROUP_ONLINE)
498 return 0;
500 return gdrv->prepare ? gdrv->prepare(gdev) : 0;
503 static void ccwgroup_pm_complete(struct device *dev)
505 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
506 struct ccwgroup_driver *gdrv = to_ccwgroupdrv(dev->driver);
508 if (!gdev->dev.driver || gdev->state != CCWGROUP_ONLINE)
509 return;
511 if (gdrv->complete)
512 gdrv->complete(gdev);
515 static int ccwgroup_pm_freeze(struct device *dev)
517 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
518 struct ccwgroup_driver *gdrv = to_ccwgroupdrv(gdev->dev.driver);
520 if (!gdev->dev.driver || gdev->state != CCWGROUP_ONLINE)
521 return 0;
523 return gdrv->freeze ? gdrv->freeze(gdev) : 0;
526 static int ccwgroup_pm_thaw(struct device *dev)
528 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
529 struct ccwgroup_driver *gdrv = to_ccwgroupdrv(gdev->dev.driver);
531 if (!gdev->dev.driver || gdev->state != CCWGROUP_ONLINE)
532 return 0;
534 return gdrv->thaw ? gdrv->thaw(gdev) : 0;
537 static int ccwgroup_pm_restore(struct device *dev)
539 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
540 struct ccwgroup_driver *gdrv = to_ccwgroupdrv(gdev->dev.driver);
542 if (!gdev->dev.driver || gdev->state != CCWGROUP_ONLINE)
543 return 0;
545 return gdrv->restore ? gdrv->restore(gdev) : 0;
548 static const struct dev_pm_ops ccwgroup_pm_ops = {
549 .prepare = ccwgroup_pm_prepare,
550 .complete = ccwgroup_pm_complete,
551 .freeze = ccwgroup_pm_freeze,
552 .thaw = ccwgroup_pm_thaw,
553 .restore = ccwgroup_pm_restore,
556 static struct bus_type ccwgroup_bus_type = {
557 .name = "ccwgroup",
558 .remove = ccwgroup_remove,
559 .shutdown = ccwgroup_shutdown,
560 .pm = &ccwgroup_pm_ops,
563 bool dev_is_ccwgroup(struct device *dev)
565 return dev->bus == &ccwgroup_bus_type;
567 EXPORT_SYMBOL(dev_is_ccwgroup);
570 * ccwgroup_driver_register() - register a ccw group driver
571 * @cdriver: driver to be registered
573 * This function is mainly a wrapper around driver_register().
575 int ccwgroup_driver_register(struct ccwgroup_driver *cdriver)
577 /* register our new driver with the core */
578 cdriver->driver.bus = &ccwgroup_bus_type;
580 return driver_register(&cdriver->driver);
582 EXPORT_SYMBOL(ccwgroup_driver_register);
584 static int __ccwgroup_match_all(struct device *dev, void *data)
586 return 1;
590 * ccwgroup_driver_unregister() - deregister a ccw group driver
591 * @cdriver: driver to be deregistered
593 * This function is mainly a wrapper around driver_unregister().
595 void ccwgroup_driver_unregister(struct ccwgroup_driver *cdriver)
597 struct device *dev;
599 /* We don't want ccwgroup devices to live longer than their driver. */
600 while ((dev = driver_find_device(&cdriver->driver, NULL, NULL,
601 __ccwgroup_match_all))) {
602 struct ccwgroup_device *gdev = to_ccwgroupdev(dev);
604 ccwgroup_ungroup(gdev);
605 put_device(dev);
607 driver_unregister(&cdriver->driver);
609 EXPORT_SYMBOL(ccwgroup_driver_unregister);
611 static int __ccwgroupdev_check_busid(struct device *dev, void *id)
613 char *bus_id = id;
615 return (strcmp(bus_id, dev_name(dev)) == 0);
619 * get_ccwgroupdev_by_busid() - obtain device from a bus id
620 * @gdrv: driver the device is owned by
621 * @bus_id: bus id of the device to be searched
623 * This function searches all devices owned by @gdrv for a device with a bus
624 * id matching @bus_id.
625 * Returns:
626 * If a match is found, its reference count of the found device is increased
627 * and it is returned; else %NULL is returned.
629 struct ccwgroup_device *get_ccwgroupdev_by_busid(struct ccwgroup_driver *gdrv,
630 char *bus_id)
632 struct device *dev;
634 dev = driver_find_device(&gdrv->driver, NULL, bus_id,
635 __ccwgroupdev_check_busid);
637 return dev ? to_ccwgroupdev(dev) : NULL;
639 EXPORT_SYMBOL_GPL(get_ccwgroupdev_by_busid);
642 * ccwgroup_probe_ccwdev() - probe function for slave devices
643 * @cdev: ccw device to be probed
645 * This is a dummy probe function for ccw devices that are slave devices in
646 * a ccw group device.
647 * Returns:
648 * always %0
650 int ccwgroup_probe_ccwdev(struct ccw_device *cdev)
652 return 0;
654 EXPORT_SYMBOL(ccwgroup_probe_ccwdev);
657 * ccwgroup_remove_ccwdev() - remove function for slave devices
658 * @cdev: ccw device to be removed
660 * This is a remove function for ccw devices that are slave devices in a ccw
661 * group device. It sets the ccw device offline and also deregisters the
662 * embedding ccw group device.
664 void ccwgroup_remove_ccwdev(struct ccw_device *cdev)
666 struct ccwgroup_device *gdev;
668 /* Ignore offlining errors, device is gone anyway. */
669 ccw_device_set_offline(cdev);
670 /* If one of its devices is gone, the whole group is done for. */
671 spin_lock_irq(cdev->ccwlock);
672 gdev = dev_get_drvdata(&cdev->dev);
673 if (!gdev) {
674 spin_unlock_irq(cdev->ccwlock);
675 return;
677 /* Get ccwgroup device reference for local processing. */
678 get_device(&gdev->dev);
679 spin_unlock_irq(cdev->ccwlock);
680 /* Unregister group device. */
681 ccwgroup_ungroup(gdev);
682 /* Release ccwgroup device reference for local processing. */
683 put_device(&gdev->dev);
685 EXPORT_SYMBOL(ccwgroup_remove_ccwdev);
686 MODULE_LICENSE("GPL");