2 * bus driver for ccwgroup
4 * Copyright IBM Corp. 2002, 2009
6 * Author(s): Arnd Bergmann (arndb@de.ibm.com)
7 * Cornelia Huck (cornelia.huck@de.ibm.com)
9 #include <linux/module.h>
10 #include <linux/errno.h>
11 #include <linux/slab.h>
12 #include <linux/list.h>
13 #include <linux/device.h>
14 #include <linux/init.h>
15 #include <linux/ctype.h>
16 #include <linux/dcache.h>
18 #include <asm/ccwdev.h>
19 #include <asm/ccwgroup.h>
21 #define CCW_BUS_ID_SIZE 20
23 /* In Linux 2.4, we had a channel device layer called "chandev"
24 * that did all sorts of obscure stuff for networking devices.
25 * This is another driver that serves as a replacement for just
26 * one of its functions, namely the translation of single subchannels
27 * to devices that use multiple subchannels.
30 /* a device matches a driver if all its slave devices match the same
31 * entry of the driver */
33 ccwgroup_bus_match (struct device
* dev
, struct device_driver
* drv
)
35 struct ccwgroup_device
*gdev
;
36 struct ccwgroup_driver
*gdrv
;
38 gdev
= to_ccwgroupdev(dev
);
39 gdrv
= to_ccwgroupdrv(drv
);
41 if (gdev
->creator_id
== gdrv
->driver_id
)
47 ccwgroup_uevent (struct device
*dev
, struct kobj_uevent_env
*env
)
53 static struct bus_type ccwgroup_bus_type
;
56 __ccwgroup_remove_symlinks(struct ccwgroup_device
*gdev
)
61 for (i
= 0; i
< gdev
->count
; i
++) {
62 sprintf(str
, "cdev%d", i
);
63 sysfs_remove_link(&gdev
->dev
.kobj
, str
);
64 sysfs_remove_link(&gdev
->cdev
[i
]->dev
.kobj
, "group_device");
70 * Provide an 'ungroup' attribute so the user can remove group devices no
71 * longer needed or accidentially created. Saves memory :)
73 static void ccwgroup_ungroup_callback(struct device
*dev
)
75 struct ccwgroup_device
*gdev
= to_ccwgroupdev(dev
);
77 mutex_lock(&gdev
->reg_mutex
);
78 if (device_is_registered(&gdev
->dev
)) {
79 __ccwgroup_remove_symlinks(gdev
);
80 device_unregister(dev
);
82 mutex_unlock(&gdev
->reg_mutex
);
86 ccwgroup_ungroup_store(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
88 struct ccwgroup_device
*gdev
;
91 gdev
= to_ccwgroupdev(dev
);
93 /* Prevent concurrent online/offline processing and ungrouping. */
94 if (atomic_cmpxchg(&gdev
->onoff
, 0, 1) != 0)
96 if (gdev
->state
!= CCWGROUP_OFFLINE
) {
100 /* Note that we cannot unregister the device from one of its
101 * attribute methods, so we have to use this roundabout approach.
103 rc
= device_schedule_callback(dev
, ccwgroup_ungroup_callback
);
107 /* Release onoff "lock" when ungrouping failed. */
108 atomic_set(&gdev
->onoff
, 0);
114 static DEVICE_ATTR(ungroup
, 0200, NULL
, ccwgroup_ungroup_store
);
117 ccwgroup_release (struct device
*dev
)
119 struct ccwgroup_device
*gdev
;
122 gdev
= to_ccwgroupdev(dev
);
124 for (i
= 0; i
< gdev
->count
; 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
);
135 __ccwgroup_create_symlinks(struct ccwgroup_device
*gdev
)
140 for (i
= 0; i
< gdev
->count
; i
++) {
141 rc
= sysfs_create_link(&gdev
->cdev
[i
]->dev
.kobj
, &gdev
->dev
.kobj
,
144 for (--i
; i
>= 0; i
--)
145 sysfs_remove_link(&gdev
->cdev
[i
]->dev
.kobj
,
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
,
155 for (--i
; i
>= 0; i
--) {
156 sprintf(str
, "cdev%d", i
);
157 sysfs_remove_link(&gdev
->dev
.kobj
, str
);
159 for (i
= 0; i
< gdev
->count
; i
++)
160 sysfs_remove_link(&gdev
->cdev
[i
]->dev
.kobj
,
168 static int __get_next_bus_id(const char **buf
, char *bus_id
)
173 start
= (char *)*buf
;
174 end
= strchr(start
, ',');
176 /* Last entry. Strip trailing newline, if applicable. */
177 end
= strchr(start
, '\n');
180 len
= strlen(start
) + 1;
182 len
= end
- start
+ 1;
185 if (len
< CCW_BUS_ID_SIZE
) {
186 strlcpy(bus_id
, start
, len
);
194 static int __is_valid_bus_id(char bus_id
[CCW_BUS_ID_SIZE
])
196 int cssid
, ssid
, devno
;
198 /* Must be of form %x.%x.%04x */
199 if (sscanf(bus_id
, "%x.%1x.%04x", &cssid
, &ssid
, &devno
) != 3)
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
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
216 * %0 on success and an error code on failure.
220 int ccwgroup_create_from_string(struct device
*root
, unsigned int creator_id
,
221 struct ccw_driver
*cdrv
, int num_devices
,
224 struct ccwgroup_device
*gdev
;
226 char tmp_bus_id
[CCW_BUS_ID_SIZE
];
227 const char *curr_buf
;
229 gdev
= kzalloc(sizeof(*gdev
) + num_devices
* sizeof(gdev
->cdev
[0]),
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
);
245 for (i
= 0; i
< num_devices
&& curr_buf
; i
++) {
246 rc
= __get_next_bus_id(&curr_buf
, tmp_bus_id
);
249 if (!__is_valid_bus_id(tmp_bus_id
)) {
253 gdev
->cdev
[i
] = get_ccwdev_by_busid(cdrv
, tmp_bus_id
);
255 * All devices have to be of the same type in
256 * order to be grouped.
259 || gdev
->cdev
[i
]->id
.driver_info
!=
260 gdev
->cdev
[0]->id
.driver_info
) {
264 /* Don't allow a device to belong to more than one group. */
265 if (dev_get_drvdata(&gdev
->cdev
[i
]->dev
)) {
269 dev_set_drvdata(&gdev
->cdev
[i
]->dev
, gdev
);
271 /* Check for sufficient number of bus ids. */
272 if (i
< num_devices
&& !curr_buf
) {
276 /* Check for trailing stuff. */
277 if (i
== num_devices
&& strlen(curr_buf
) > 0) {
282 dev_set_name(&gdev
->dev
, "%s", dev_name(&gdev
->cdev
[0]->dev
));
284 rc
= device_add(&gdev
->dev
);
287 get_device(&gdev
->dev
);
288 rc
= device_create_file(&gdev
->dev
, &dev_attr_ungroup
);
291 device_unregister(&gdev
->dev
);
295 rc
= __ccwgroup_create_symlinks(gdev
);
297 mutex_unlock(&gdev
->reg_mutex
);
298 put_device(&gdev
->dev
);
301 device_remove_file(&gdev
->dev
, &dev_attr_ungroup
);
302 device_unregister(&gdev
->dev
);
304 for (i
= 0; i
< num_devices
; 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
;
311 mutex_unlock(&gdev
->reg_mutex
);
312 put_device(&gdev
->dev
);
315 EXPORT_SYMBOL(ccwgroup_create_from_string
);
317 static int ccwgroup_notifier(struct notifier_block
*nb
, unsigned long action
,
320 static struct notifier_block ccwgroup_nb
= {
321 .notifier_call
= ccwgroup_notifier
324 static int __init
init_ccwgroup(void)
328 ret
= bus_register(&ccwgroup_bus_type
);
332 ret
= bus_register_notifier(&ccwgroup_bus_type
, &ccwgroup_nb
);
334 bus_unregister(&ccwgroup_bus_type
);
339 static void __exit
cleanup_ccwgroup(void)
341 bus_unregister_notifier(&ccwgroup_bus_type
, &ccwgroup_nb
);
342 bus_unregister(&ccwgroup_bus_type
);
345 module_init(init_ccwgroup
);
346 module_exit(cleanup_ccwgroup
);
348 /************************** driver stuff ******************************/
351 ccwgroup_set_online(struct ccwgroup_device
*gdev
)
353 struct ccwgroup_driver
*gdrv
;
356 if (atomic_cmpxchg(&gdev
->onoff
, 0, 1) != 0)
358 if (gdev
->state
== CCWGROUP_ONLINE
) {
362 if (!gdev
->dev
.driver
) {
366 gdrv
= to_ccwgroupdrv (gdev
->dev
.driver
);
367 if ((ret
= gdrv
->set_online
? gdrv
->set_online(gdev
) : 0))
370 gdev
->state
= CCWGROUP_ONLINE
;
372 atomic_set(&gdev
->onoff
, 0);
377 ccwgroup_set_offline(struct ccwgroup_device
*gdev
)
379 struct ccwgroup_driver
*gdrv
;
382 if (atomic_cmpxchg(&gdev
->onoff
, 0, 1) != 0)
384 if (gdev
->state
== CCWGROUP_OFFLINE
) {
388 if (!gdev
->dev
.driver
) {
392 gdrv
= to_ccwgroupdrv (gdev
->dev
.driver
);
393 if ((ret
= gdrv
->set_offline
? gdrv
->set_offline(gdev
) : 0))
396 gdev
->state
= CCWGROUP_OFFLINE
;
398 atomic_set(&gdev
->onoff
, 0);
403 ccwgroup_online_store (struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
405 struct ccwgroup_device
*gdev
;
406 struct ccwgroup_driver
*gdrv
;
413 gdev
= to_ccwgroupdev(dev
);
414 gdrv
= to_ccwgroupdrv(dev
->driver
);
416 if (!try_module_get(gdrv
->owner
))
419 ret
= strict_strtoul(buf
, 0, &value
);
424 ret
= ccwgroup_set_online(gdev
);
426 ret
= ccwgroup_set_offline(gdev
);
430 module_put(gdrv
->owner
);
431 return (ret
== 0) ? count
: ret
;
435 ccwgroup_online_show (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
439 online
= (to_ccwgroupdev(dev
)->state
== CCWGROUP_ONLINE
);
441 return sprintf(buf
, online
? "1\n" : "0\n");
444 static DEVICE_ATTR(online
, 0644, ccwgroup_online_show
, ccwgroup_online_store
);
447 ccwgroup_probe (struct device
*dev
)
449 struct ccwgroup_device
*gdev
;
450 struct ccwgroup_driver
*gdrv
;
454 gdev
= to_ccwgroupdev(dev
);
455 gdrv
= to_ccwgroupdrv(dev
->driver
);
457 if ((ret
= device_create_file(dev
, &dev_attr_online
)))
460 ret
= gdrv
->probe
? gdrv
->probe(gdev
) : -ENODEV
;
462 device_remove_file(dev
, &dev_attr_online
);
468 ccwgroup_remove (struct device
*dev
)
470 struct ccwgroup_device
*gdev
;
471 struct ccwgroup_driver
*gdrv
;
473 device_remove_file(dev
, &dev_attr_online
);
474 device_remove_file(dev
, &dev_attr_ungroup
);
479 gdev
= to_ccwgroupdev(dev
);
480 gdrv
= to_ccwgroupdrv(dev
->driver
);
488 static void ccwgroup_shutdown(struct device
*dev
)
490 struct ccwgroup_device
*gdev
;
491 struct ccwgroup_driver
*gdrv
;
496 gdev
= to_ccwgroupdev(dev
);
497 gdrv
= to_ccwgroupdrv(dev
->driver
);
500 gdrv
->shutdown(gdev
);
503 static int ccwgroup_pm_prepare(struct device
*dev
)
505 struct ccwgroup_device
*gdev
= to_ccwgroupdev(dev
);
506 struct ccwgroup_driver
*gdrv
= to_ccwgroupdrv(gdev
->dev
.driver
);
508 /* Fail while device is being set online/offline. */
509 if (atomic_read(&gdev
->onoff
))
512 if (!gdev
->dev
.driver
|| gdev
->state
!= CCWGROUP_ONLINE
)
515 return gdrv
->prepare
? gdrv
->prepare(gdev
) : 0;
518 static void ccwgroup_pm_complete(struct device
*dev
)
520 struct ccwgroup_device
*gdev
= to_ccwgroupdev(dev
);
521 struct ccwgroup_driver
*gdrv
= to_ccwgroupdrv(dev
->driver
);
523 if (!gdev
->dev
.driver
|| gdev
->state
!= CCWGROUP_ONLINE
)
527 gdrv
->complete(gdev
);
530 static int ccwgroup_pm_freeze(struct device
*dev
)
532 struct ccwgroup_device
*gdev
= to_ccwgroupdev(dev
);
533 struct ccwgroup_driver
*gdrv
= to_ccwgroupdrv(gdev
->dev
.driver
);
535 if (!gdev
->dev
.driver
|| gdev
->state
!= CCWGROUP_ONLINE
)
538 return gdrv
->freeze
? gdrv
->freeze(gdev
) : 0;
541 static int ccwgroup_pm_thaw(struct device
*dev
)
543 struct ccwgroup_device
*gdev
= to_ccwgroupdev(dev
);
544 struct ccwgroup_driver
*gdrv
= to_ccwgroupdrv(gdev
->dev
.driver
);
546 if (!gdev
->dev
.driver
|| gdev
->state
!= CCWGROUP_ONLINE
)
549 return gdrv
->thaw
? gdrv
->thaw(gdev
) : 0;
552 static int ccwgroup_pm_restore(struct device
*dev
)
554 struct ccwgroup_device
*gdev
= to_ccwgroupdev(dev
);
555 struct ccwgroup_driver
*gdrv
= to_ccwgroupdrv(gdev
->dev
.driver
);
557 if (!gdev
->dev
.driver
|| gdev
->state
!= CCWGROUP_ONLINE
)
560 return gdrv
->restore
? gdrv
->restore(gdev
) : 0;
563 static const struct dev_pm_ops ccwgroup_pm_ops
= {
564 .prepare
= ccwgroup_pm_prepare
,
565 .complete
= ccwgroup_pm_complete
,
566 .freeze
= ccwgroup_pm_freeze
,
567 .thaw
= ccwgroup_pm_thaw
,
568 .restore
= ccwgroup_pm_restore
,
571 static struct bus_type ccwgroup_bus_type
= {
573 .match
= ccwgroup_bus_match
,
574 .uevent
= ccwgroup_uevent
,
575 .probe
= ccwgroup_probe
,
576 .remove
= ccwgroup_remove
,
577 .shutdown
= ccwgroup_shutdown
,
578 .pm
= &ccwgroup_pm_ops
,
582 static int ccwgroup_notifier(struct notifier_block
*nb
, unsigned long action
,
585 struct device
*dev
= data
;
587 if (action
== BUS_NOTIFY_UNBIND_DRIVER
)
588 device_schedule_callback(dev
, ccwgroup_ungroup_callback
);
595 * ccwgroup_driver_register() - register a ccw group driver
596 * @cdriver: driver to be registered
598 * This function is mainly a wrapper around driver_register().
600 int ccwgroup_driver_register(struct ccwgroup_driver
*cdriver
)
602 /* register our new driver with the core */
603 cdriver
->driver
.bus
= &ccwgroup_bus_type
;
604 cdriver
->driver
.name
= cdriver
->name
;
605 cdriver
->driver
.owner
= cdriver
->owner
;
607 return driver_register(&cdriver
->driver
);
611 __ccwgroup_match_all(struct device
*dev
, void *data
)
617 * ccwgroup_driver_unregister() - deregister a ccw group driver
618 * @cdriver: driver to be deregistered
620 * This function is mainly a wrapper around driver_unregister().
622 void ccwgroup_driver_unregister(struct ccwgroup_driver
*cdriver
)
626 /* We don't want ccwgroup devices to live longer than their driver. */
627 get_driver(&cdriver
->driver
);
628 while ((dev
= driver_find_device(&cdriver
->driver
, NULL
, NULL
,
629 __ccwgroup_match_all
))) {
630 struct ccwgroup_device
*gdev
= to_ccwgroupdev(dev
);
632 mutex_lock(&gdev
->reg_mutex
);
633 __ccwgroup_remove_symlinks(gdev
);
634 device_unregister(dev
);
635 mutex_unlock(&gdev
->reg_mutex
);
638 put_driver(&cdriver
->driver
);
639 driver_unregister(&cdriver
->driver
);
643 * ccwgroup_probe_ccwdev() - probe function for slave devices
644 * @cdev: ccw device to be probed
646 * This is a dummy probe function for ccw devices that are slave devices in
647 * a ccw group device.
651 int ccwgroup_probe_ccwdev(struct ccw_device
*cdev
)
656 static struct ccwgroup_device
*
657 __ccwgroup_get_gdev_by_cdev(struct ccw_device
*cdev
)
659 struct ccwgroup_device
*gdev
;
661 gdev
= dev_get_drvdata(&cdev
->dev
);
663 if (get_device(&gdev
->dev
)) {
664 mutex_lock(&gdev
->reg_mutex
);
665 if (device_is_registered(&gdev
->dev
))
667 mutex_unlock(&gdev
->reg_mutex
);
668 put_device(&gdev
->dev
);
676 * ccwgroup_remove_ccwdev() - remove function for slave devices
677 * @cdev: ccw device to be removed
679 * This is a remove function for ccw devices that are slave devices in a ccw
680 * group device. It sets the ccw device offline and also deregisters the
681 * embedding ccw group device.
683 void ccwgroup_remove_ccwdev(struct ccw_device
*cdev
)
685 struct ccwgroup_device
*gdev
;
687 /* Ignore offlining errors, device is gone anyway. */
688 ccw_device_set_offline(cdev
);
689 /* If one of its devices is gone, the whole group is done for. */
690 gdev
= __ccwgroup_get_gdev_by_cdev(cdev
);
692 __ccwgroup_remove_symlinks(gdev
);
693 device_unregister(&gdev
->dev
);
694 mutex_unlock(&gdev
->reg_mutex
);
695 put_device(&gdev
->dev
);
699 MODULE_LICENSE("GPL");
700 EXPORT_SYMBOL(ccwgroup_driver_register
);
701 EXPORT_SYMBOL(ccwgroup_driver_unregister
);
702 EXPORT_SYMBOL(ccwgroup_probe_ccwdev
);
703 EXPORT_SYMBOL(ccwgroup_remove_ccwdev
);