3  *    basic function of the tape device driver
94 tape_medium_state_show(struct device *dev, struct device_attribute *attr, char *buf)  in tape_medium_state_show()
106 tape_first_minor_show(struct device *dev, struct device_attribute *attr, char *buf)  in tape_first_minor_show()
118 tape_state_show(struct device *dev, struct device_attribute *attr, char *buf)  in tape_state_show()
131 tape_operation_show(struct device *dev, struct device_attribute *attr, char *buf)  in tape_operation_show()
158 tape_blocksize_show(struct device *dev, struct device_attribute *attr, char *buf)  in tape_blocksize_show()
187 tape_state_set(struct tape_device *device, enum tape_state newstate)  in tape_state_set()  argument
191 	if (device->tape_state == TS_NOT_OPER) {  in tape_state_set()
195 	DBF_EVENT(4, "ts. dev:	%x\n", device->first_minor);  in tape_state_set()
197 	if (device->tape_state < TS_SIZE && device->tape_state >=0 )  in tape_state_set()
198 		str = tape_state_verbose[device->tape_state];  in tape_state_set()
208 	device->tape_state = newstate;  in tape_state_set()
209 	wake_up(&device->state_change_wq);  in tape_state_set()
213 	struct tape_device *device;  member
225 	struct tape_device *device = p->device;  in tape_med_state_work_handler()  local
231 			"unloaded\n", dev_name(&device->cdev->dev));  in tape_med_state_work_handler()
233 		kobject_uevent_env(&device->cdev->dev.kobj, KOBJ_CHANGE, envp);  in tape_med_state_work_handler()
237 			dev_name(&device->cdev->dev));  in tape_med_state_work_handler()
239 		kobject_uevent_env(&device->cdev->dev.kobj, KOBJ_CHANGE, envp);  in tape_med_state_work_handler()
244 	tape_put_device(device);  in tape_med_state_work_handler()
249 tape_med_state_work(struct tape_device *device, enum tape_medium_state state)  in tape_med_state_work()  argument
256 		p->device = tape_get_device(device);  in tape_med_state_work()
263 tape_med_state_set(struct tape_device *device, enum tape_medium_state newstate)  in tape_med_state_set()  argument
267 	oldstate = device->medium_state;  in tape_med_state_set()
270 	device->medium_state = newstate;  in tape_med_state_set()
273 		device->tape_generic_status |= GMT_DR_OPEN(~0);  in tape_med_state_set()
275 			tape_med_state_work(device, MS_UNLOADED);  in tape_med_state_set()
278 		device->tape_generic_status &= ~GMT_DR_OPEN(~0);  in tape_med_state_set()
280 			tape_med_state_work(device, MS_LOADED);  in tape_med_state_set()
285 	wake_up(&device->state_change_wq);  in tape_med_state_set()
289  * Stop running ccw. Has to be called with the device lock held.
292 __tape_cancel_io(struct tape_device *device, struct tape_request *request)  in __tape_cancel_io()  argument
303 		rc = ccw_device_clear(device->cdev, (long) request);  in __tape_cancel_io()
311 				schedule_delayed_work(&device->tape_dnr, 0);  in __tape_cancel_io()
314 				DBF_EXCEPTION(2, "device gone, retry\n");  in __tape_cancel_io()
328  * Add device into the sorted list, giving it the first
332 tape_assign_minor(struct tape_device *device)  in tape_assign_minor()  argument
348 	device->first_minor = minor;  in tape_assign_minor()
349 	list_add_tail(&device->node, &tmp->node);  in tape_assign_minor()
354 /* remove device from the list */
356 tape_remove_minor(struct tape_device *device)  in tape_remove_minor()  argument
359 	list_del_init(&device->node);  in tape_remove_minor()
360 	device->first_minor = -1;  in tape_remove_minor()
365  * Set a device online.
367  * This function is called by the common I/O layer to move a device from the
369  * If we return an error (RC < 0) the device remains in the offline state. This
370  * can happen if the device is assigned somewhere else, for example.
373 tape_generic_online(struct tape_device *device,  in tape_generic_online()  argument
378 	DBF_LH(6, "tape_enable_device(%p, %p)\n", device, discipline);  in tape_generic_online()
380 	if (device->tape_state != TS_INIT) {  in tape_generic_online()
381 		DBF_LH(3, "Tapestate not INIT (%d)\n", device->tape_state);  in tape_generic_online()
385 	timer_setup(&device->lb_timeout, tape_long_busy_timeout, 0);  in tape_generic_online()
387 	/* Let the discipline have a go at the device. */  in tape_generic_online()
388 	device->discipline = discipline;  in tape_generic_online()
393 	rc = discipline->setup_device(device);  in tape_generic_online()
396 	rc = tape_assign_minor(device);  in tape_generic_online()
400 	rc = tapechar_setup_device(device);  in tape_generic_online()
404 	tape_state_set(device, TS_UNUSED);  in tape_generic_online()
406 	DBF_LH(3, "(%08x): Drive set online\n", device->cdev_id);  in tape_generic_online()
411 	tape_remove_minor(device);  in tape_generic_online()
413 	device->discipline->cleanup_device(device);  in tape_generic_online()
414 	device->discipline = NULL;  in tape_generic_online()
421 tape_cleanup_device(struct tape_device *device)  in tape_cleanup_device()  argument
423 	tapechar_cleanup_device(device);  in tape_cleanup_device()
424 	device->discipline->cleanup_device(device);  in tape_cleanup_device()
425 	module_put(device->discipline->owner);  in tape_cleanup_device()
426 	tape_remove_minor(device);  in tape_cleanup_device()
427 	tape_med_state_set(device, MS_UNKNOWN);  in tape_cleanup_device()
431  * Suspend device.
434  * request. We refuse to suspend if the device is loaded or in use for the
438  * during DETACH processing (unless the tape device was attached with the
440  * resume the original state of the tape device, since we would need to
445 	struct tape_device *device;  in tape_generic_pm_suspend()  local
447 	device = dev_get_drvdata(&cdev->dev);  in tape_generic_pm_suspend()
448 	if (!device) {  in tape_generic_pm_suspend()
453 		device->cdev_id, device);  in tape_generic_pm_suspend()
455 	if (device->medium_state != MS_UNLOADED) {  in tape_generic_pm_suspend()
456 		pr_err("A cartridge is loaded in tape device %s, "  in tape_generic_pm_suspend()
461 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_pm_suspend()
462 	switch (device->tape_state) {  in tape_generic_pm_suspend()
466 			spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_pm_suspend()
469 			pr_err("Tape device %s is busy, refusing to "  in tape_generic_pm_suspend()
471 			spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_pm_suspend()
475 	DBF_LH(3, "(%08x): Drive suspended.\n", device->cdev_id);  in tape_generic_pm_suspend()
480  * Set device offline.
489 	struct tape_device *device;  in tape_generic_offline()  local
491 	device = dev_get_drvdata(&cdev->dev);  in tape_generic_offline()
492 	if (!device) {  in tape_generic_offline()
497 		device->cdev_id, device);  in tape_generic_offline()
499 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_offline()
500 	switch (device->tape_state) {  in tape_generic_offline()
503 			spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_offline()
506 			tape_state_set(device, TS_INIT);  in tape_generic_offline()
507 			spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_offline()
508 			tape_cleanup_device(device);  in tape_generic_offline()
513 				device->cdev_id);  in tape_generic_offline()
514 			spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_offline()
518 	DBF_LH(3, "(%08x): Drive set offline.\n", device->cdev_id);  in tape_generic_offline()
523  * Allocate memory for a new device structure.
528 	struct tape_device *device;  in tape_alloc_device()  local
530 	device = kzalloc(sizeof(struct tape_device), GFP_KERNEL);  in tape_alloc_device()
531 	if (device == NULL) {  in tape_alloc_device()
535 	device->modeset_byte = kmalloc(1, GFP_KERNEL | GFP_DMA);  in tape_alloc_device()
536 	if (device->modeset_byte == NULL) {  in tape_alloc_device()
538 		kfree(device);  in tape_alloc_device()
541 	mutex_init(&device->mutex);  in tape_alloc_device()
542 	INIT_LIST_HEAD(&device->req_queue);  in tape_alloc_device()
543 	INIT_LIST_HEAD(&device->node);  in tape_alloc_device()
544 	init_waitqueue_head(&device->state_change_wq);  in tape_alloc_device()
545 	init_waitqueue_head(&device->wait_queue);  in tape_alloc_device()
546 	device->tape_state = TS_INIT;  in tape_alloc_device()
547 	device->medium_state = MS_UNKNOWN;  in tape_alloc_device()
548 	*device->modeset_byte = 0;  in tape_alloc_device()
549 	device->first_minor = -1;  in tape_alloc_device()
550 	atomic_set(&device->ref_count, 1);  in tape_alloc_device()
551 	INIT_DELAYED_WORK(&device->tape_dnr, tape_delayed_next_request);  in tape_alloc_device()
553 	return device;  in tape_alloc_device()
557  * Get a reference to an existing device structure. This will automatically
561 tape_get_device(struct tape_device *device)  in tape_get_device()  argument
565 	count = atomic_inc_return(&device->ref_count);  in tape_get_device()
566 	DBF_EVENT(4, "tape_get_device(%p) = %i\n", device, count);  in tape_get_device()
567 	return device;  in tape_get_device()
572  * reference counter reaches zero free the device structure.
577 tape_put_device(struct tape_device *device)  in tape_put_device()  argument
581 	count = atomic_dec_return(&device->ref_count);  in tape_put_device()
582 	DBF_EVENT(4, "tape_put_device(%p) -> %i\n", device, count);  in tape_put_device()
585 		kfree(device->modeset_byte);  in tape_put_device()
586 		kfree(device);  in tape_put_device()
591  * Find tape device by a device index.
596 	struct tape_device *device, *tmp;  in tape_find_device()  local
598 	device = ERR_PTR(-ENODEV);  in tape_find_device()
602 			device = tape_get_device(tmp);  in tape_find_device()
607 	return device;  in tape_find_device()
616 	struct tape_device *device;  in tape_generic_probe()  local
620 	device = tape_alloc_device();  in tape_generic_probe()
621 	if (IS_ERR(device))  in tape_generic_probe()
627 		tape_put_device(device);  in tape_generic_probe()
630 	dev_set_drvdata(&cdev->dev, device);  in tape_generic_probe()
632 	device->cdev = cdev;  in tape_generic_probe()
634 	device->cdev_id = devid_to_int(&dev_id);  in tape_generic_probe()
639 __tape_discard_requests(struct tape_device *device)  in __tape_discard_requests()  argument
644 	list_for_each_safe(l, n, &device->req_queue) {  in __tape_discard_requests()
651 		request->device = NULL;  in __tape_discard_requests()
652 		tape_put_device(device);  in __tape_discard_requests()
662  * This function is called whenever the common I/O layer detects the device
668 	struct tape_device *	device;  in tape_generic_remove()  local
670 	device = dev_get_drvdata(&cdev->dev);  in tape_generic_remove()
671 	if (!device) {  in tape_generic_remove()
674 	DBF_LH(3, "(%08x): tape_generic_remove(%p)\n", device->cdev_id, cdev);  in tape_generic_remove()
676 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_remove()
677 	switch (device->tape_state) {  in tape_generic_remove()
679 			tape_state_set(device, TS_NOT_OPER);  in tape_generic_remove()
685 			spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_remove()
689 			 * Need only to release the device.  in tape_generic_remove()
691 			tape_state_set(device, TS_NOT_OPER);  in tape_generic_remove()
692 			spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_remove()
693 			tape_cleanup_device(device);  in tape_generic_remove()
702 				device->cdev_id);  in tape_generic_remove()
704 				dev_name(&device->cdev->dev));  in tape_generic_remove()
705 			tape_state_set(device, TS_NOT_OPER);  in tape_generic_remove()
706 			__tape_discard_requests(device);  in tape_generic_remove()
707 			spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_generic_remove()
708 			tape_cleanup_device(device);  in tape_generic_remove()
711 	device = dev_get_drvdata(&cdev->dev);  in tape_generic_remove()
712 	if (device) {  in tape_generic_remove()
715 		tape_put_device(device);  in tape_generic_remove()
770 	if (request->device)  in tape_free_request()
771 		tape_put_device(request->device);  in tape_free_request()
778 __tape_start_io(struct tape_device *device, struct tape_request *request)  in __tape_start_io()  argument
783 		device->cdev,  in __tape_start_io()
794 		schedule_delayed_work(&device->tape_dnr, 0);  in __tape_start_io()
804 __tape_start_next_request(struct tape_device *device)  in __tape_start_next_request()  argument
810 	DBF_LH(6, "__tape_start_next_request(%p)\n", device);  in __tape_start_next_request()
815 	list_for_each_safe(l, n, &device->req_queue) {  in __tape_start_next_request()
839 			rc = __tape_cancel_io(device, request);  in __tape_start_next_request()
841 			rc = __tape_start_io(device, request);  in __tape_start_next_request()
862 	struct tape_device *device =  in tape_delayed_next_request()  local
865 	DBF_LH(6, "tape_delayed_next_request(%p)\n", device);  in tape_delayed_next_request()
866 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_delayed_next_request()
867 	__tape_start_next_request(device);  in tape_delayed_next_request()
868 	spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_delayed_next_request()
873 	struct tape_device *device = from_timer(device, t, lb_timeout);  in tape_long_busy_timeout()  local
876 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_long_busy_timeout()
877 	request = list_entry(device->req_queue.next, struct tape_request, list);  in tape_long_busy_timeout()
879 	DBF_LH(6, "%08x: Long busy timeout.\n", device->cdev_id);  in tape_long_busy_timeout()
880 	__tape_start_next_request(device);  in tape_long_busy_timeout()
881 	tape_put_device(device);  in tape_long_busy_timeout()
882 	spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_long_busy_timeout()
887 	struct tape_device *	device,  in __tape_end_request()  argument
891 	DBF_LH(6, "__tape_end_request(%p, %p, %i)\n", device, request, rc);  in __tape_end_request()
905 	if (!list_empty(&device->req_queue))  in __tape_end_request()
906 		__tape_start_next_request(device);  in __tape_end_request()
913 tape_dump_sense_dbf(struct tape_device *device, struct tape_request *request,  in tape_dump_sense_dbf()  argument
925 	DBF_EVENT(3, "DEVICE: %08x OP\t: %s\n", device->cdev_id, op);  in tape_dump_sense_dbf()
936  * the device lock held.
939 __tape_start_request(struct tape_device *device, struct tape_request *request)  in __tape_start_request()  argument
949 			if (device->tape_state == TS_INIT)  in __tape_start_request()
951 			if (device->tape_state == TS_UNUSED)  in __tape_start_request()
955 			if (device->tape_state == TS_BLKUSE)  in __tape_start_request()
957 			if (device->tape_state != TS_IN_USE)  in __tape_start_request()
961 	/* Increase use count of device for the added request. */  in __tape_start_request()
962 	request->device = tape_get_device(device);  in __tape_start_request()
964 	if (list_empty(&device->req_queue)) {  in __tape_start_request()
966 		rc = __tape_start_io(device, request);  in __tape_start_request()
971 		list_add(&request->list, &device->req_queue);  in __tape_start_request()
975 		list_add_tail(&request->list, &device->req_queue);  in __tape_start_request()
985 tape_do_io_async(struct tape_device *device, struct tape_request *request)  in tape_do_io_async()  argument
989 	DBF_LH(6, "tape_do_io_async(%p, %p)\n", device, request);  in tape_do_io_async()
991 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_do_io_async()
993 	rc = __tape_start_request(device, request);  in tape_do_io_async()
994 	spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_do_io_async()
1011 tape_do_io(struct tape_device *device, struct tape_request *request)  in tape_do_io()  argument
1015 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_do_io()
1018 	request->callback_data = &device->wait_queue;  in tape_do_io()
1020 	rc = __tape_start_request(device, request);  in tape_do_io()
1021 	spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_do_io()
1025 	wait_event(device->wait_queue, (request->callback == NULL));  in tape_do_io()
1043 tape_do_io_interruptible(struct tape_device *device,  in tape_do_io_interruptible()  argument
1048 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_do_io_interruptible()
1051 	request->callback_data = &device->wait_queue;  in tape_do_io_interruptible()
1052 	rc = __tape_start_request(device, request);  in tape_do_io_interruptible()
1053 	spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_do_io_interruptible()
1057 	rc = wait_event_interruptible(device->wait_queue,  in tape_do_io_interruptible()
1064 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_do_io_interruptible()
1065 	rc = __tape_cancel_io(device, request);  in tape_do_io_interruptible()
1066 	spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_do_io_interruptible()
1071 				device->wait_queue,  in tape_do_io_interruptible()
1076 		DBF_EVENT(3, "IO stopped on %08x\n", device->cdev_id);  in tape_do_io_interruptible()
1086 tape_cancel_io(struct tape_device *device, struct tape_request *request)  in tape_cancel_io()  argument
1090 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_cancel_io()
1091 	rc = __tape_cancel_io(device, request);  in tape_cancel_io()
1092 	spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_cancel_io()
1102 	struct tape_device *device;  in __tape_do_irq()  local
1106 	device = dev_get_drvdata(&cdev->dev);  in __tape_do_irq()
1107 	if (device == NULL) {  in __tape_do_irq()
1112 	DBF_LH(6, "__tape_do_irq(device=%p, request=%p)\n", device, request);  in __tape_do_irq()
1120 				       device->cdev_id);  in __tape_do_irq()
1123 				__tape_end_request(device, request, -EIO);  in __tape_do_irq()
1127 				       device->cdev_id,	PTR_ERR(irb));  in __tape_do_irq()
1143 			device->cdev_id, irb->scsw.cmd.cc, irb->scsw.cmd.fctl);  in __tape_do_irq()
1145 		schedule_delayed_work(&device->tape_dnr, HZ);  in __tape_do_irq()
1153 		 !list_empty(&device->req_queue)) {  in __tape_do_irq()
1156 		req = list_entry(device->req_queue.next,  in __tape_do_irq()
1159 			DBF_EVENT(3, "(%08x): del timer\n", device->cdev_id);  in __tape_do_irq()
1160 			if (del_timer(&device->lb_timeout)) {  in __tape_do_irq()
1161 				tape_put_device(device);  in __tape_do_irq()
1162 				__tape_start_next_request(device);  in __tape_do_irq()
1170 			device->tape_generic_status |= GMT_ONLINE(~0);  in __tape_do_irq()
1172 			device->tape_generic_status &= ~GMT_ONLINE(~0);  in __tape_do_irq()
1176 		 * and device end is unusual. Log the sense data.  in __tape_do_irq()
1179 		tape_dump_sense_dbf(device, request, irb);  in __tape_do_irq()
1181 		/* Upon normal completion the device _is_ online */  in __tape_do_irq()
1182 		device->tape_generic_status |= GMT_ONLINE(~0);  in __tape_do_irq()
1184 	if (device->tape_state == TS_NOT_OPER) {  in __tape_do_irq()
1185 		DBF_EVENT(6, "tape:device is not operational\n");  in __tape_do_irq()
1194 		__tape_end_request(device, request, -EIO);  in __tape_do_irq()
1198 	rc = device->discipline->irq(device, request, irb);  in __tape_do_irq()
1208 			/* Upon normal completion the device _is_ online */  in __tape_do_irq()
1209 			device->tape_generic_status |= GMT_ONLINE(~0);  in __tape_do_irq()
1210 			__tape_end_request(device, request, rc);  in __tape_do_irq()
1215 			device->lb_timeout.expires = jiffies +  in __tape_do_irq()
1217 			DBF_EVENT(3, "(%08x): add timer\n", device->cdev_id);  in __tape_do_irq()
1218 			add_timer(&device->lb_timeout);  in __tape_do_irq()
1222 			rc = __tape_start_io(device, request);  in __tape_do_irq()
1224 				__tape_end_request(device, request, rc);  in __tape_do_irq()
1227 			rc = __tape_cancel_io(device, request);  in __tape_do_irq()
1229 				__tape_end_request(device, request, rc);  in __tape_do_irq()
1234 				__tape_end_request(device, request, -EIO);  in __tape_do_irq()
1236 				__tape_end_request(device, request, rc);  in __tape_do_irq()
1243  * Tape device open function used by tape_char frontend.
1246 tape_open(struct tape_device *device)  in tape_open()  argument
1250 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_open()
1251 	if (device->tape_state == TS_NOT_OPER) {  in tape_open()
1254 	} else if (device->tape_state == TS_IN_USE) {  in tape_open()
1257 	} else if (device->tape_state == TS_BLKUSE) {  in tape_open()
1260 	} else if (device->discipline != NULL &&  in tape_open()
1261 		   !try_module_get(device->discipline->owner)) {  in tape_open()
1265 		tape_state_set(device, TS_IN_USE);  in tape_open()
1268 	spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_open()
1273  * Tape device release function used by tape_char frontend.
1276 tape_release(struct tape_device *device)  in tape_release()  argument
1278 	spin_lock_irq(get_ccwdev_lock(device->cdev));  in tape_release()
1279 	if (device->tape_state == TS_IN_USE)  in tape_release()
1280 		tape_state_set(device, TS_UNUSED);  in tape_release()
1281 	module_put(device->discipline->owner);  in tape_release()
1282 	spin_unlock_irq(get_ccwdev_lock(device->cdev));  in tape_release()
1290 tape_mtop(struct tape_device *device, int mt_op, int mt_count)  in tape_mtop()  argument
1301 	fn = device->discipline->mtop_array[mt_op];  in tape_mtop()
1310 			if ((rc = fn(device, 500)) != 0)  in tape_mtop()
1313 			rc = fn(device, mt_count);  in tape_mtop()
1315 		rc = fn(device, mt_count);  in tape_mtop()
1353 MODULE_DESCRIPTION("Linux on zSeries channel attached tape device driver");