tape_3590.c revision 5705f7021748a69d84d6567e68e8851dab551464
1/*
2 *  drivers/s390/char/tape_3590.c
3 *    tape device discipline for 3590 tapes.
4 *
5 *    Copyright IBM Corp. 2001,2006
6 *    Author(s): Stefan Bader <shbader@de.ibm.com>
7 *		 Michael Holzheu <holzheu@de.ibm.com>
8 *		 Martin Schwidefsky <schwidefsky@de.ibm.com>
9 */
10
11#include <linux/module.h>
12#include <linux/init.h>
13#include <linux/bio.h>
14#include <asm/ebcdic.h>
15
16#define TAPE_DBF_AREA	tape_3590_dbf
17
18#include "tape.h"
19#include "tape_std.h"
20#include "tape_3590.h"
21
22/*
23 * Pointer to debug area.
24 */
25debug_info_t *TAPE_DBF_AREA = NULL;
26EXPORT_SYMBOL(TAPE_DBF_AREA);
27
28/*******************************************************************
29 * Error Recovery fuctions:
30 * - Read Opposite:		 implemented
31 * - Read Device (buffered) log: BRA
32 * - Read Library log:		 BRA
33 * - Swap Devices:		 BRA
34 * - Long Busy:			 implemented
35 * - Special Intercept:		 BRA
36 * - Read Alternate:		 implemented
37 *******************************************************************/
38
39#define PRINTK_HEADER "TAPE_3590: "
40
41static const char *tape_3590_msg[TAPE_3590_MAX_MSG] = {
42	[0x00] = "",
43	[0x10] = "Lost Sense",
44	[0x11] = "Assigned Elsewhere",
45	[0x12] = "Allegiance Reset",
46	[0x13] = "Shared Access Violation",
47	[0x20] = "Command Reject",
48	[0x21] = "Configuration Error",
49	[0x22] = "Protection Exception",
50	[0x23] = "Write Protect",
51	[0x24] = "Write Length",
52	[0x25] = "Read-Only Format",
53	[0x31] = "Beginning of Partition",
54	[0x33] = "End of Partition",
55	[0x34] = "End of Data",
56	[0x35] = "Block not found",
57	[0x40] = "Device Intervention",
58	[0x41] = "Loader Intervention",
59	[0x42] = "Library Intervention",
60	[0x50] = "Write Error",
61	[0x51] = "Erase Error",
62	[0x52] = "Formatting Error",
63	[0x53] = "Read Error",
64	[0x54] = "Unsupported Format",
65	[0x55] = "No Formatting",
66	[0x56] = "Positioning lost",
67	[0x57] = "Read Length",
68	[0x60] = "Unsupported Medium",
69	[0x61] = "Medium Length Error",
70	[0x62] = "Medium removed",
71	[0x64] = "Load Check",
72	[0x65] = "Unload Check",
73	[0x70] = "Equipment Check",
74	[0x71] = "Bus out Check",
75	[0x72] = "Protocol Error",
76	[0x73] = "Interface Error",
77	[0x74] = "Overrun",
78	[0x75] = "Halt Signal",
79	[0x90] = "Device fenced",
80	[0x91] = "Device Path fenced",
81	[0xa0] = "Volume misplaced",
82	[0xa1] = "Volume inaccessible",
83	[0xa2] = "Volume in input",
84	[0xa3] = "Volume ejected",
85	[0xa4] = "All categories reserved",
86	[0xa5] = "Duplicate Volume",
87	[0xa6] = "Library Manager Offline",
88	[0xa7] = "Library Output Station full",
89	[0xa8] = "Vision System non-operational",
90	[0xa9] = "Library Manager Equipment Check",
91	[0xaa] = "Library Equipment Check",
92	[0xab] = "All Library Cells full",
93	[0xac] = "No Cleaner Volumes in Library",
94	[0xad] = "I/O Station door open",
95	[0xae] = "Subsystem environmental alert",
96};
97
98static int crypt_supported(struct tape_device *device)
99{
100	return TAPE390_CRYPT_SUPPORTED(TAPE_3590_CRYPT_INFO(device));
101}
102
103static int crypt_enabled(struct tape_device *device)
104{
105	return TAPE390_CRYPT_ON(TAPE_3590_CRYPT_INFO(device));
106}
107
108static void ext_to_int_kekl(struct tape390_kekl *in,
109			    struct tape3592_kekl *out)
110{
111	int i;
112
113	memset(out, 0, sizeof(*out));
114	if (in->type == TAPE390_KEKL_TYPE_HASH)
115		out->flags |= 0x40;
116	if (in->type_on_tape == TAPE390_KEKL_TYPE_HASH)
117		out->flags |= 0x80;
118	strncpy(out->label, in->label, 64);
119	for (i = strlen(in->label); i < sizeof(out->label); i++)
120		out->label[i] = ' ';
121	ASCEBC(out->label, sizeof(out->label));
122}
123
124static void int_to_ext_kekl(struct tape3592_kekl *in,
125			    struct tape390_kekl *out)
126{
127	memset(out, 0, sizeof(*out));
128	if(in->flags & 0x40)
129		out->type = TAPE390_KEKL_TYPE_HASH;
130	else
131		out->type = TAPE390_KEKL_TYPE_LABEL;
132	if(in->flags & 0x80)
133		out->type_on_tape = TAPE390_KEKL_TYPE_HASH;
134	else
135		out->type_on_tape = TAPE390_KEKL_TYPE_LABEL;
136	memcpy(out->label, in->label, sizeof(in->label));
137	EBCASC(out->label, sizeof(in->label));
138	strstrip(out->label);
139}
140
141static void int_to_ext_kekl_pair(struct tape3592_kekl_pair *in,
142				 struct tape390_kekl_pair *out)
143{
144	if (in->count == 0) {
145		out->kekl[0].type = TAPE390_KEKL_TYPE_NONE;
146		out->kekl[0].type_on_tape = TAPE390_KEKL_TYPE_NONE;
147		out->kekl[1].type = TAPE390_KEKL_TYPE_NONE;
148		out->kekl[1].type_on_tape = TAPE390_KEKL_TYPE_NONE;
149	} else if (in->count == 1) {
150		int_to_ext_kekl(&in->kekl[0], &out->kekl[0]);
151		out->kekl[1].type = TAPE390_KEKL_TYPE_NONE;
152		out->kekl[1].type_on_tape = TAPE390_KEKL_TYPE_NONE;
153	} else if (in->count == 2) {
154		int_to_ext_kekl(&in->kekl[0], &out->kekl[0]);
155		int_to_ext_kekl(&in->kekl[1], &out->kekl[1]);
156	} else {
157		printk("Invalid KEKL number: %d\n", in->count);
158		BUG();
159	}
160}
161
162static int check_ext_kekl(struct tape390_kekl *kekl)
163{
164	if (kekl->type == TAPE390_KEKL_TYPE_NONE)
165		goto invalid;
166	if (kekl->type > TAPE390_KEKL_TYPE_HASH)
167		goto invalid;
168	if (kekl->type_on_tape == TAPE390_KEKL_TYPE_NONE)
169		goto invalid;
170	if (kekl->type_on_tape > TAPE390_KEKL_TYPE_HASH)
171		goto invalid;
172	if ((kekl->type == TAPE390_KEKL_TYPE_HASH) &&
173	    (kekl->type_on_tape == TAPE390_KEKL_TYPE_LABEL))
174		goto invalid;
175
176	return 0;
177invalid:
178	return -EINVAL;
179}
180
181static int check_ext_kekl_pair(struct tape390_kekl_pair *kekls)
182{
183	if (check_ext_kekl(&kekls->kekl[0]))
184		goto invalid;
185	if (check_ext_kekl(&kekls->kekl[1]))
186		goto invalid;
187
188	return 0;
189invalid:
190	return -EINVAL;
191}
192
193/*
194 * Query KEKLs
195 */
196static int tape_3592_kekl_query(struct tape_device *device,
197				struct tape390_kekl_pair *ext_kekls)
198{
199	struct tape_request *request;
200	struct tape3592_kekl_query_order *order;
201	struct tape3592_kekl_query_data *int_kekls;
202	int rc;
203
204	DBF_EVENT(6, "tape3592_kekl_query\n");
205	int_kekls = kmalloc(sizeof(*int_kekls), GFP_KERNEL|GFP_DMA);
206	if (!int_kekls)
207		return -ENOMEM;
208	request = tape_alloc_request(2, sizeof(*order));
209	if (IS_ERR(request)) {
210		rc = PTR_ERR(request);
211		goto fail_malloc;
212	}
213	order = request->cpdata;
214	memset(order,0,sizeof(*order));
215	order->code = 0xe2;
216	order->max_count = 2;
217	request->op = TO_KEKL_QUERY;
218	tape_ccw_cc(request->cpaddr, PERF_SUBSYS_FUNC, sizeof(*order), order);
219	tape_ccw_end(request->cpaddr + 1, READ_SS_DATA, sizeof(*int_kekls),
220		     int_kekls);
221	rc = tape_do_io(device, request);
222	if (rc)
223		goto fail_request;
224	int_to_ext_kekl_pair(&int_kekls->kekls, ext_kekls);
225
226	rc = 0;
227fail_request:
228	tape_free_request(request);
229fail_malloc:
230	kfree(int_kekls);
231	return rc;
232}
233
234/*
235 * IOCTL: Query KEKLs
236 */
237static int tape_3592_ioctl_kekl_query(struct tape_device *device,
238				      unsigned long arg)
239{
240	int rc;
241	struct tape390_kekl_pair *ext_kekls;
242
243	DBF_EVENT(6, "tape_3592_ioctl_kekl_query\n");
244	if (!crypt_supported(device))
245		return -ENOSYS;
246	if (!crypt_enabled(device))
247		return -EUNATCH;
248	ext_kekls = kmalloc(sizeof(*ext_kekls), GFP_KERNEL);
249	if (!ext_kekls)
250		return -ENOMEM;
251	rc = tape_3592_kekl_query(device, ext_kekls);
252	if (rc != 0)
253		goto fail;
254	if (copy_to_user((char __user *) arg, ext_kekls, sizeof(*ext_kekls))) {
255		rc = -EFAULT;
256		goto fail;
257	}
258	rc = 0;
259fail:
260	kfree(ext_kekls);
261	return rc;
262}
263
264static int tape_3590_mttell(struct tape_device *device, int mt_count);
265
266/*
267 * Set KEKLs
268 */
269static int tape_3592_kekl_set(struct tape_device *device,
270			      struct tape390_kekl_pair *ext_kekls)
271{
272	struct tape_request *request;
273	struct tape3592_kekl_set_order *order;
274
275	DBF_EVENT(6, "tape3592_kekl_set\n");
276	if (check_ext_kekl_pair(ext_kekls)) {
277		DBF_EVENT(6, "invalid kekls\n");
278		return -EINVAL;
279	}
280	if (tape_3590_mttell(device, 0) != 0)
281		return -EBADSLT;
282	request = tape_alloc_request(1, sizeof(*order));
283	if (IS_ERR(request))
284		return PTR_ERR(request);
285	order = request->cpdata;
286	memset(order, 0, sizeof(*order));
287	order->code = 0xe3;
288	order->kekls.count = 2;
289	ext_to_int_kekl(&ext_kekls->kekl[0], &order->kekls.kekl[0]);
290	ext_to_int_kekl(&ext_kekls->kekl[1], &order->kekls.kekl[1]);
291	request->op = TO_KEKL_SET;
292	tape_ccw_end(request->cpaddr, PERF_SUBSYS_FUNC, sizeof(*order), order);
293
294	return tape_do_io_free(device, request);
295}
296
297/*
298 * IOCTL: Set KEKLs
299 */
300static int tape_3592_ioctl_kekl_set(struct tape_device *device,
301				    unsigned long arg)
302{
303	int rc;
304	struct tape390_kekl_pair *ext_kekls;
305
306	DBF_EVENT(6, "tape_3592_ioctl_kekl_set\n");
307	if (!crypt_supported(device))
308		return -ENOSYS;
309	if (!crypt_enabled(device))
310		return -EUNATCH;
311	ext_kekls = kmalloc(sizeof(*ext_kekls), GFP_KERNEL);
312	if (!ext_kekls)
313		return -ENOMEM;
314	if (copy_from_user(ext_kekls, (char __user *)arg, sizeof(*ext_kekls))) {
315		rc = -EFAULT;
316		goto out;
317	}
318	rc = tape_3592_kekl_set(device, ext_kekls);
319out:
320	kfree(ext_kekls);
321	return rc;
322}
323
324/*
325 * Enable encryption
326 */
327static int tape_3592_enable_crypt(struct tape_device *device)
328{
329	struct tape_request *request;
330	char *data;
331
332	DBF_EVENT(6, "tape_3592_enable_crypt\n");
333	if (!crypt_supported(device))
334		return -ENOSYS;
335	request = tape_alloc_request(2, 72);
336	if (IS_ERR(request))
337		return PTR_ERR(request);
338	data = request->cpdata;
339	memset(data,0,72);
340
341	data[0]       = 0x05;
342	data[36 + 0]  = 0x03;
343	data[36 + 1]  = 0x03;
344	data[36 + 4]  = 0x40;
345	data[36 + 6]  = 0x01;
346	data[36 + 14] = 0x2f;
347	data[36 + 18] = 0xc3;
348	data[36 + 35] = 0x72;
349	request->op = TO_CRYPT_ON;
350	tape_ccw_cc(request->cpaddr, MODE_SET_CB, 36, data);
351	tape_ccw_end(request->cpaddr + 1, MODE_SET_CB, 36, data + 36);
352	return tape_do_io_free(device, request);
353}
354
355/*
356 * Disable encryption
357 */
358static int tape_3592_disable_crypt(struct tape_device *device)
359{
360	struct tape_request *request;
361	char *data;
362
363	DBF_EVENT(6, "tape_3592_disable_crypt\n");
364	if (!crypt_supported(device))
365		return -ENOSYS;
366	request = tape_alloc_request(2, 72);
367	if (IS_ERR(request))
368		return PTR_ERR(request);
369	data = request->cpdata;
370	memset(data,0,72);
371
372	data[0]       = 0x05;
373	data[36 + 0]  = 0x03;
374	data[36 + 1]  = 0x03;
375	data[36 + 35] = 0x32;
376
377	request->op = TO_CRYPT_OFF;
378	tape_ccw_cc(request->cpaddr, MODE_SET_CB, 36, data);
379	tape_ccw_end(request->cpaddr + 1, MODE_SET_CB, 36, data + 36);
380
381	return tape_do_io_free(device, request);
382}
383
384/*
385 * IOCTL: Set encryption status
386 */
387static int tape_3592_ioctl_crypt_set(struct tape_device *device,
388				     unsigned long arg)
389{
390	struct tape390_crypt_info info;
391
392	DBF_EVENT(6, "tape_3592_ioctl_crypt_set\n");
393	if (!crypt_supported(device))
394		return -ENOSYS;
395	if (copy_from_user(&info, (char __user *)arg, sizeof(info)))
396		return -EFAULT;
397	if (info.status & ~TAPE390_CRYPT_ON_MASK)
398		return -EINVAL;
399	if (info.status & TAPE390_CRYPT_ON_MASK)
400		return tape_3592_enable_crypt(device);
401	else
402		return tape_3592_disable_crypt(device);
403}
404
405static int tape_3590_sense_medium(struct tape_device *device);
406
407/*
408 * IOCTL: Query enryption status
409 */
410static int tape_3592_ioctl_crypt_query(struct tape_device *device,
411				       unsigned long arg)
412{
413	DBF_EVENT(6, "tape_3592_ioctl_crypt_query\n");
414	if (!crypt_supported(device))
415		return -ENOSYS;
416	tape_3590_sense_medium(device);
417	if (copy_to_user((char __user *) arg, &TAPE_3590_CRYPT_INFO(device),
418		sizeof(TAPE_3590_CRYPT_INFO(device))))
419		return -EFAULT;
420	else
421		return 0;
422}
423
424/*
425 * 3590 IOCTL Overload
426 */
427static int
428tape_3590_ioctl(struct tape_device *device, unsigned int cmd, unsigned long arg)
429{
430	switch (cmd) {
431	case TAPE390_DISPLAY: {
432		struct display_struct disp;
433
434		if (copy_from_user(&disp, (char __user *) arg, sizeof(disp)))
435			return -EFAULT;
436
437		return tape_std_display(device, &disp);
438	}
439	case TAPE390_KEKL_SET:
440		return tape_3592_ioctl_kekl_set(device, arg);
441	case TAPE390_KEKL_QUERY:
442		return tape_3592_ioctl_kekl_query(device, arg);
443	case TAPE390_CRYPT_SET:
444		return tape_3592_ioctl_crypt_set(device, arg);
445	case TAPE390_CRYPT_QUERY:
446		return tape_3592_ioctl_crypt_query(device, arg);
447	default:
448		return -EINVAL;	/* no additional ioctls */
449	}
450}
451
452/*
453 * SENSE Medium: Get Sense data about medium state
454 */
455static int
456tape_3590_sense_medium(struct tape_device *device)
457{
458	struct tape_request *request;
459
460	request = tape_alloc_request(1, 128);
461	if (IS_ERR(request))
462		return PTR_ERR(request);
463	request->op = TO_MSEN;
464	tape_ccw_end(request->cpaddr, MEDIUM_SENSE, 128, request->cpdata);
465	return tape_do_io_free(device, request);
466}
467
468/*
469 * MTTELL: Tell block. Return the number of block relative to current file.
470 */
471static int
472tape_3590_mttell(struct tape_device *device, int mt_count)
473{
474	__u64 block_id;
475	int rc;
476
477	rc = tape_std_read_block_id(device, &block_id);
478	if (rc)
479		return rc;
480	return block_id >> 32;
481}
482
483/*
484 * MTSEEK: seek to the specified block.
485 */
486static int
487tape_3590_mtseek(struct tape_device *device, int count)
488{
489	struct tape_request *request;
490
491	DBF_EVENT(6, "xsee id: %x\n", count);
492	request = tape_alloc_request(3, 4);
493	if (IS_ERR(request))
494		return PTR_ERR(request);
495	request->op = TO_LBL;
496	tape_ccw_cc(request->cpaddr, MODE_SET_DB, 1, device->modeset_byte);
497	*(__u32 *) request->cpdata = count;
498	tape_ccw_cc(request->cpaddr + 1, LOCATE, 4, request->cpdata);
499	tape_ccw_end(request->cpaddr + 2, NOP, 0, NULL);
500	return tape_do_io_free(device, request);
501}
502
503/*
504 * Read Opposite Error Recovery Function:
505 * Used, when Read Forward does not work
506 */
507static void
508tape_3590_read_opposite(struct tape_device *device,
509			struct tape_request *request)
510{
511	struct tape_3590_disc_data *data;
512
513	/*
514	 * We have allocated 4 ccws in tape_std_read, so we can now
515	 * transform the request to a read backward, followed by a
516	 * forward space block.
517	 */
518	request->op = TO_RBA;
519	tape_ccw_cc(request->cpaddr, MODE_SET_DB, 1, device->modeset_byte);
520	data = device->discdata;
521	tape_ccw_cc_idal(request->cpaddr + 1, data->read_back_op,
522			 device->char_data.idal_buf);
523	tape_ccw_cc(request->cpaddr + 2, FORSPACEBLOCK, 0, NULL);
524	tape_ccw_end(request->cpaddr + 3, NOP, 0, NULL);
525	DBF_EVENT(6, "xrop ccwg\n");
526}
527
528/*
529 * Read Attention Msg
530 * This should be done after an interrupt with attention bit (0x80)
531 * in device state.
532 *
533 * After a "read attention message" request there are two possible
534 * results:
535 *
536 * 1. A unit check is presented, when attention sense is present (e.g. when
537 * a medium has been unloaded). The attention sense comes then
538 * together with the unit check. The recovery action is either "retry"
539 * (in case there is an attention message pending) or "permanent error".
540 *
541 * 2. The attention msg is written to the "read subsystem data" buffer.
542 * In this case we probably should print it to the console.
543 */
544static int
545tape_3590_read_attmsg(struct tape_device *device)
546{
547	struct tape_request *request;
548	char *buf;
549
550	request = tape_alloc_request(3, 4096);
551	if (IS_ERR(request))
552		return PTR_ERR(request);
553	request->op = TO_READ_ATTMSG;
554	buf = request->cpdata;
555	buf[0] = PREP_RD_SS_DATA;
556	buf[6] = RD_ATTMSG;	/* read att msg */
557	tape_ccw_cc(request->cpaddr, PERFORM_SS_FUNC, 12, buf);
558	tape_ccw_cc(request->cpaddr + 1, READ_SS_DATA, 4096 - 12, buf + 12);
559	tape_ccw_end(request->cpaddr + 2, NOP, 0, NULL);
560	return tape_do_io_free(device, request);
561}
562
563/*
564 * These functions are used to schedule follow-up actions from within an
565 * interrupt context (like unsolicited interrupts).
566 */
567struct work_handler_data {
568	struct tape_device *device;
569	enum tape_op        op;
570	struct work_struct  work;
571};
572
573static void
574tape_3590_work_handler(struct work_struct *work)
575{
576	struct work_handler_data *p =
577		container_of(work, struct work_handler_data, work);
578
579	switch (p->op) {
580	case TO_MSEN:
581		tape_3590_sense_medium(p->device);
582		break;
583	case TO_READ_ATTMSG:
584		tape_3590_read_attmsg(p->device);
585		break;
586	case TO_CRYPT_ON:
587		tape_3592_enable_crypt(p->device);
588		break;
589	case TO_CRYPT_OFF:
590		tape_3592_disable_crypt(p->device);
591		break;
592	default:
593		DBF_EVENT(3, "T3590: work handler undefined for "
594			  "operation 0x%02x\n", p->op);
595	}
596	tape_put_device(p->device);
597	kfree(p);
598}
599
600static int
601tape_3590_schedule_work(struct tape_device *device, enum tape_op op)
602{
603	struct work_handler_data *p;
604
605	if ((p = kzalloc(sizeof(*p), GFP_ATOMIC)) == NULL)
606		return -ENOMEM;
607
608	INIT_WORK(&p->work, tape_3590_work_handler);
609
610	p->device = tape_get_device_reference(device);
611	p->op = op;
612
613	schedule_work(&p->work);
614	return 0;
615}
616
617#ifdef CONFIG_S390_TAPE_BLOCK
618/*
619 * Tape Block READ
620 */
621static struct tape_request *
622tape_3590_bread(struct tape_device *device, struct request *req)
623{
624	struct tape_request *request;
625	struct ccw1 *ccw;
626	int count = 0, start_block;
627	unsigned off;
628	char *dst;
629	struct bio_vec *bv;
630	struct req_iterator iter;
631
632	DBF_EVENT(6, "xBREDid:");
633	start_block = req->sector >> TAPEBLOCK_HSEC_S2B;
634	DBF_EVENT(6, "start_block = %i\n", start_block);
635
636	rq_for_each_segment(bv, req, iter)
637		count += bv->bv_len >> (TAPEBLOCK_HSEC_S2B + 9);
638
639	request = tape_alloc_request(2 + count + 1, 4);
640	if (IS_ERR(request))
641		return request;
642	request->op = TO_BLOCK;
643	*(__u32 *) request->cpdata = start_block;
644	ccw = request->cpaddr;
645	ccw = tape_ccw_cc(ccw, MODE_SET_DB, 1, device->modeset_byte);
646
647	/*
648	 * We always setup a nop after the mode set ccw. This slot is
649	 * used in tape_std_check_locate to insert a locate ccw if the
650	 * current tape position doesn't match the start block to be read.
651	 */
652	ccw = tape_ccw_cc(ccw, NOP, 0, NULL);
653
654	rq_for_each_segment(bv, req, iter) {
655			dst = page_address(bv->bv_page) + bv->bv_offset;
656			for (off = 0; off < bv->bv_len;
657			     off += TAPEBLOCK_HSEC_SIZE) {
658				ccw->flags = CCW_FLAG_CC;
659				ccw->cmd_code = READ_FORWARD;
660				ccw->count = TAPEBLOCK_HSEC_SIZE;
661				set_normalized_cda(ccw, (void *) __pa(dst));
662				ccw++;
663				dst += TAPEBLOCK_HSEC_SIZE;
664			}
665			if (off > bv->bv_len)
666				BUG();
667	}
668	ccw = tape_ccw_end(ccw, NOP, 0, NULL);
669	DBF_EVENT(6, "xBREDccwg\n");
670	return request;
671}
672
673static void
674tape_3590_free_bread(struct tape_request *request)
675{
676	struct ccw1 *ccw;
677
678	/* Last ccw is a nop and doesn't need clear_normalized_cda */
679	for (ccw = request->cpaddr; ccw->flags & CCW_FLAG_CC; ccw++)
680		if (ccw->cmd_code == READ_FORWARD)
681			clear_normalized_cda(ccw);
682	tape_free_request(request);
683}
684
685/*
686 * check_locate is called just before the tape request is passed to
687 * the common io layer for execution. It has to check the current
688 * tape position and insert a locate ccw if it doesn't match the
689 * start block for the request.
690 */
691static void
692tape_3590_check_locate(struct tape_device *device, struct tape_request *request)
693{
694	__u32 *start_block;
695
696	start_block = (__u32 *) request->cpdata;
697	if (*start_block != device->blk_data.block_position) {
698		/* Add the start offset of the file to get the real block. */
699		*start_block += device->bof;
700		tape_ccw_cc(request->cpaddr + 1, LOCATE, 4, request->cpdata);
701	}
702}
703#endif
704
705static void tape_3590_med_state_set(struct tape_device *device,
706				    struct tape_3590_med_sense *sense)
707{
708	struct tape390_crypt_info *c_info;
709
710	c_info = &TAPE_3590_CRYPT_INFO(device);
711
712	if (sense->masst == MSENSE_UNASSOCIATED) {
713		tape_med_state_set(device, MS_UNLOADED);
714		TAPE_3590_CRYPT_INFO(device).medium_status = 0;
715		return;
716	}
717	if (sense->masst != MSENSE_ASSOCIATED_MOUNT) {
718		PRINT_ERR("Unknown medium state: %x\n", sense->masst);
719		return;
720	}
721	tape_med_state_set(device, MS_LOADED);
722	c_info->medium_status |= TAPE390_MEDIUM_LOADED_MASK;
723	if (sense->flags & MSENSE_CRYPT_MASK) {
724		PRINT_INFO("Medium is encrypted (%04x)\n", sense->flags);
725		c_info->medium_status |= TAPE390_MEDIUM_ENCRYPTED_MASK;
726	} else	{
727		DBF_EVENT(6, "Medium is not encrypted %04x\n", sense->flags);
728		c_info->medium_status &= ~TAPE390_MEDIUM_ENCRYPTED_MASK;
729	}
730}
731
732/*
733 * The done handler is called at device/channel end and wakes up the sleeping
734 * process
735 */
736static int
737tape_3590_done(struct tape_device *device, struct tape_request *request)
738{
739	struct tape_3590_disc_data *disc_data;
740
741	DBF_EVENT(6, "%s done\n", tape_op_verbose[request->op]);
742	disc_data = device->discdata;
743
744	switch (request->op) {
745	case TO_BSB:
746	case TO_BSF:
747	case TO_DSE:
748	case TO_FSB:
749	case TO_FSF:
750	case TO_LBL:
751	case TO_RFO:
752	case TO_RBA:
753	case TO_REW:
754	case TO_WRI:
755	case TO_WTM:
756	case TO_BLOCK:
757	case TO_LOAD:
758		tape_med_state_set(device, MS_LOADED);
759		break;
760	case TO_RUN:
761		tape_med_state_set(device, MS_UNLOADED);
762		tape_3590_schedule_work(device, TO_CRYPT_OFF);
763		break;
764	case TO_MSEN:
765		tape_3590_med_state_set(device, request->cpdata);
766		break;
767	case TO_CRYPT_ON:
768		TAPE_3590_CRYPT_INFO(device).status
769			|= TAPE390_CRYPT_ON_MASK;
770		*(device->modeset_byte) |= 0x03;
771		break;
772	case TO_CRYPT_OFF:
773		TAPE_3590_CRYPT_INFO(device).status
774			&= ~TAPE390_CRYPT_ON_MASK;
775		*(device->modeset_byte) &= ~0x03;
776		break;
777	case TO_RBI:	/* RBI seems to succeed even without medium loaded. */
778	case TO_NOP:	/* Same to NOP. */
779	case TO_READ_CONFIG:
780	case TO_READ_ATTMSG:
781	case TO_DIS:
782	case TO_ASSIGN:
783	case TO_UNASSIGN:
784	case TO_SIZE:
785	case TO_KEKL_SET:
786	case TO_KEKL_QUERY:
787	case TO_RDC:
788		break;
789	}
790	return TAPE_IO_SUCCESS;
791}
792
793/*
794 * This fuction is called, when error recovery was successfull
795 */
796static inline int
797tape_3590_erp_succeded(struct tape_device *device, struct tape_request *request)
798{
799	DBF_EVENT(3, "Error Recovery successfull for %s\n",
800		  tape_op_verbose[request->op]);
801	return tape_3590_done(device, request);
802}
803
804/*
805 * This fuction is called, when error recovery was not successfull
806 */
807static inline int
808tape_3590_erp_failed(struct tape_device *device, struct tape_request *request,
809		     struct irb *irb, int rc)
810{
811	DBF_EVENT(3, "Error Recovery failed for %s\n",
812		  tape_op_verbose[request->op]);
813	tape_dump_sense_dbf(device, request, irb);
814	return rc;
815}
816
817/*
818 * Error Recovery do retry
819 */
820static inline int
821tape_3590_erp_retry(struct tape_device *device, struct tape_request *request,
822		    struct irb *irb)
823{
824	DBF_EVENT(2, "Retry: %s\n", tape_op_verbose[request->op]);
825	tape_dump_sense_dbf(device, request, irb);
826	return TAPE_IO_RETRY;
827}
828
829/*
830 * Handle unsolicited interrupts
831 */
832static int
833tape_3590_unsolicited_irq(struct tape_device *device, struct irb *irb)
834{
835	if (irb->scsw.dstat == DEV_STAT_CHN_END)
836		/* Probably result of halt ssch */
837		return TAPE_IO_PENDING;
838	else if (irb->scsw.dstat == 0x85)
839		/* Device Ready -> check medium state */
840		tape_3590_schedule_work(device, TO_MSEN);
841	else if (irb->scsw.dstat & DEV_STAT_ATTENTION)
842		tape_3590_schedule_work(device, TO_READ_ATTMSG);
843	else {
844		DBF_EVENT(3, "unsol.irq! dev end: %08x\n", device->cdev_id);
845		PRINT_WARN("Unsolicited IRQ (Device End) caught.\n");
846		tape_dump_sense(device, NULL, irb);
847	}
848	return TAPE_IO_SUCCESS;
849}
850
851/*
852 * Basic Recovery routine
853 */
854static int
855tape_3590_erp_basic(struct tape_device *device, struct tape_request *request,
856		    struct irb *irb, int rc)
857{
858	struct tape_3590_sense *sense;
859
860	sense = (struct tape_3590_sense *) irb->ecw;
861
862	switch (sense->bra) {
863	case SENSE_BRA_PER:
864		return tape_3590_erp_failed(device, request, irb, rc);
865	case SENSE_BRA_CONT:
866		return tape_3590_erp_succeded(device, request);
867	case SENSE_BRA_RE:
868		return tape_3590_erp_retry(device, request, irb);
869	case SENSE_BRA_DRE:
870		return tape_3590_erp_failed(device, request, irb, rc);
871	default:
872		PRINT_ERR("Unknown BRA %x - This should not happen!\n",
873			  sense->bra);
874		BUG();
875		return TAPE_IO_STOP;
876	}
877}
878
879/*
880 *  RDL: Read Device (buffered) log
881 */
882static int
883tape_3590_erp_read_buf_log(struct tape_device *device,
884			   struct tape_request *request, struct irb *irb)
885{
886	/*
887	 * We just do the basic error recovery at the moment (retry).
888	 * Perhaps in the future, we read the log and dump it somewhere...
889	 */
890	return tape_3590_erp_basic(device, request, irb, -EIO);
891}
892
893/*
894 *  SWAP: Swap Devices
895 */
896static int
897tape_3590_erp_swap(struct tape_device *device, struct tape_request *request,
898		   struct irb *irb)
899{
900	/*
901	 * This error recovery should swap the tapes
902	 * if the original has a problem. The operation
903	 * should proceed with the new tape... this
904	 * should probably be done in user space!
905	 */
906	PRINT_WARN("(%s): Swap Tape Device!\n", device->cdev->dev.bus_id);
907	return tape_3590_erp_basic(device, request, irb, -EIO);
908}
909
910/*
911 *  LBY: Long Busy
912 */
913static int
914tape_3590_erp_long_busy(struct tape_device *device,
915			struct tape_request *request, struct irb *irb)
916{
917	DBF_EVENT(6, "Device is busy\n");
918	return TAPE_IO_LONG_BUSY;
919}
920
921/*
922 *  SPI: Special Intercept
923 */
924static int
925tape_3590_erp_special_interrupt(struct tape_device *device,
926				struct tape_request *request, struct irb *irb)
927{
928	return tape_3590_erp_basic(device, request, irb, -EIO);
929}
930
931/*
932 *  RDA: Read Alternate
933 */
934static int
935tape_3590_erp_read_alternate(struct tape_device *device,
936			     struct tape_request *request, struct irb *irb)
937{
938	struct tape_3590_disc_data *data;
939
940	/*
941	 * The issued Read Backward or Read Previous command is not
942	 * supported by the device
943	 * The recovery action should be to issue another command:
944	 * Read Revious: if Read Backward is not supported
945	 * Read Backward: if Read Previous is not supported
946	 */
947	data = device->discdata;
948	if (data->read_back_op == READ_PREVIOUS) {
949		DBF_EVENT(2, "(%08x): No support for READ_PREVIOUS command\n",
950			  device->cdev_id);
951		data->read_back_op = READ_BACKWARD;
952	} else {
953		DBF_EVENT(2, "(%08x): No support for READ_BACKWARD command\n",
954			  device->cdev_id);
955		data->read_back_op = READ_PREVIOUS;
956	}
957	tape_3590_read_opposite(device, request);
958	return tape_3590_erp_retry(device, request, irb);
959}
960
961/*
962 * Error Recovery read opposite
963 */
964static int
965tape_3590_erp_read_opposite(struct tape_device *device,
966			    struct tape_request *request, struct irb *irb)
967{
968	switch (request->op) {
969	case TO_RFO:
970		/*
971		 * We did read forward, but the data could not be read.
972		 * We will read backward and then skip forward again.
973		 */
974		tape_3590_read_opposite(device, request);
975		return tape_3590_erp_retry(device, request, irb);
976	case TO_RBA:
977		/* We tried to read forward and backward, but hat no success */
978		return tape_3590_erp_failed(device, request, irb, -EIO);
979		break;
980	default:
981		PRINT_WARN("read_opposite_recovery_called_with_op: %s\n",
982			   tape_op_verbose[request->op]);
983		return tape_3590_erp_failed(device, request, irb, -EIO);
984	}
985}
986
987/*
988 * Print an MIM (Media Information  Message) (message code f0)
989 */
990static void
991tape_3590_print_mim_msg_f0(struct tape_device *device, struct irb *irb)
992{
993	struct tape_3590_sense *sense;
994
995	sense = (struct tape_3590_sense *) irb->ecw;
996	/* Exception Message */
997	switch (sense->fmt.f70.emc) {
998	case 0x02:
999		PRINT_WARN("(%s): Data degraded\n", device->cdev->dev.bus_id);
1000		break;
1001	case 0x03:
1002		PRINT_WARN("(%s): Data degraded in partion %i\n",
1003			   device->cdev->dev.bus_id, sense->fmt.f70.mp);
1004		break;
1005	case 0x04:
1006		PRINT_WARN("(%s): Medium degraded\n", device->cdev->dev.bus_id);
1007		break;
1008	case 0x05:
1009		PRINT_WARN("(%s): Medium degraded in partition %i\n",
1010			   device->cdev->dev.bus_id, sense->fmt.f70.mp);
1011		break;
1012	case 0x06:
1013		PRINT_WARN("(%s): Block 0 Error\n", device->cdev->dev.bus_id);
1014		break;
1015	case 0x07:
1016		PRINT_WARN("(%s): Medium Exception 0x%02x\n",
1017			   device->cdev->dev.bus_id, sense->fmt.f70.md);
1018		break;
1019	default:
1020		PRINT_WARN("(%s): MIM ExMsg: 0x%02x\n",
1021			   device->cdev->dev.bus_id, sense->fmt.f70.emc);
1022		break;
1023	}
1024	/* Service Message */
1025	switch (sense->fmt.f70.smc) {
1026	case 0x02:
1027		PRINT_WARN("(%s): Reference Media maintenance procedure %i\n",
1028			   device->cdev->dev.bus_id, sense->fmt.f70.md);
1029		break;
1030	default:
1031		PRINT_WARN("(%s): MIM ServiceMsg: 0x%02x\n",
1032			   device->cdev->dev.bus_id, sense->fmt.f70.smc);
1033		break;
1034	}
1035}
1036
1037/*
1038 * Print an I/O Subsystem Service Information Message (message code f1)
1039 */
1040static void
1041tape_3590_print_io_sim_msg_f1(struct tape_device *device, struct irb *irb)
1042{
1043	struct tape_3590_sense *sense;
1044
1045	sense = (struct tape_3590_sense *) irb->ecw;
1046	/* Exception Message */
1047	switch (sense->fmt.f71.emc) {
1048	case 0x01:
1049		PRINT_WARN("(%s): Effect of failure is unknown\n",
1050			   device->cdev->dev.bus_id);
1051		break;
1052	case 0x02:
1053		PRINT_WARN("(%s): CU Exception - no performance impact\n",
1054			   device->cdev->dev.bus_id);
1055		break;
1056	case 0x03:
1057		PRINT_WARN("(%s): CU Exception on channel interface 0x%02x\n",
1058			   device->cdev->dev.bus_id, sense->fmt.f71.md[0]);
1059		break;
1060	case 0x04:
1061		PRINT_WARN("(%s): CU Exception on device path 0x%02x\n",
1062			   device->cdev->dev.bus_id, sense->fmt.f71.md[0]);
1063		break;
1064	case 0x05:
1065		PRINT_WARN("(%s): CU Exception on library path 0x%02x\n",
1066			   device->cdev->dev.bus_id, sense->fmt.f71.md[0]);
1067		break;
1068	case 0x06:
1069		PRINT_WARN("(%s): CU Exception on node 0x%02x\n",
1070			   device->cdev->dev.bus_id, sense->fmt.f71.md[0]);
1071		break;
1072	case 0x07:
1073		PRINT_WARN("(%s): CU Exception on partition 0x%02x\n",
1074			   device->cdev->dev.bus_id, sense->fmt.f71.md[0]);
1075		break;
1076	default:
1077		PRINT_WARN("(%s): SIM ExMsg: 0x%02x\n",
1078			   device->cdev->dev.bus_id, sense->fmt.f71.emc);
1079	}
1080	/* Service Message */
1081	switch (sense->fmt.f71.smc) {
1082	case 0x01:
1083		PRINT_WARN("(%s): Repair impact is unknown\n",
1084			   device->cdev->dev.bus_id);
1085		break;
1086	case 0x02:
1087		PRINT_WARN("(%s): Repair will not impact cu performance\n",
1088			   device->cdev->dev.bus_id);
1089		break;
1090	case 0x03:
1091		if (sense->fmt.f71.mdf == 0)
1092			PRINT_WARN("(%s): Repair will disable node "
1093				   "0x%x on CU\n",
1094				   device->cdev->dev.bus_id,
1095				   sense->fmt.f71.md[1]);
1096		else
1097			PRINT_WARN("(%s): Repair will disable nodes "
1098				   "(0x%x-0x%x) on CU\n",
1099				   device->cdev->dev.bus_id,
1100				   sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1101		break;
1102	case 0x04:
1103		if (sense->fmt.f71.mdf == 0)
1104			PRINT_WARN("(%s): Repair will disable cannel path "
1105				   "0x%x on CU\n",
1106				   device->cdev->dev.bus_id,
1107				   sense->fmt.f71.md[1]);
1108		else
1109			PRINT_WARN("(%s): Repair will disable cannel paths "
1110				   "(0x%x-0x%x) on CU\n",
1111				   device->cdev->dev.bus_id,
1112				   sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1113		break;
1114	case 0x05:
1115		if (sense->fmt.f71.mdf == 0)
1116			PRINT_WARN("(%s): Repair will disable device path "
1117				   "0x%x on CU\n",
1118				   device->cdev->dev.bus_id,
1119				   sense->fmt.f71.md[1]);
1120		else
1121			PRINT_WARN("(%s): Repair will disable device paths "
1122				   "(0x%x-0x%x) on CU\n",
1123				   device->cdev->dev.bus_id,
1124				   sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1125		break;
1126	case 0x06:
1127		if (sense->fmt.f71.mdf == 0)
1128			PRINT_WARN("(%s): Repair will disable library path "
1129				   "0x%x on CU\n",
1130				   device->cdev->dev.bus_id,
1131				   sense->fmt.f71.md[1]);
1132		else
1133			PRINT_WARN("(%s): Repair will disable library paths "
1134				   "(0x%x-0x%x) on CU\n",
1135				   device->cdev->dev.bus_id,
1136				   sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1137		break;
1138	case 0x07:
1139		PRINT_WARN("(%s): Repair will disable access to CU\n",
1140			   device->cdev->dev.bus_id);
1141		break;
1142	default:
1143		PRINT_WARN("(%s): SIM ServiceMsg: 0x%02x\n",
1144			   device->cdev->dev.bus_id, sense->fmt.f71.smc);
1145	}
1146}
1147
1148/*
1149 * Print an Device Subsystem Service Information Message (message code f2)
1150 */
1151static void
1152tape_3590_print_dev_sim_msg_f2(struct tape_device *device, struct irb *irb)
1153{
1154	struct tape_3590_sense *sense;
1155
1156	sense = (struct tape_3590_sense *) irb->ecw;
1157	/* Exception Message */
1158	switch (sense->fmt.f71.emc) {
1159	case 0x01:
1160		PRINT_WARN("(%s): Effect of failure is unknown\n",
1161			   device->cdev->dev.bus_id);
1162		break;
1163	case 0x02:
1164		PRINT_WARN("(%s): DV Exception - no performance impact\n",
1165			   device->cdev->dev.bus_id);
1166		break;
1167	case 0x03:
1168		PRINT_WARN("(%s): DV Exception on channel interface 0x%02x\n",
1169			   device->cdev->dev.bus_id, sense->fmt.f71.md[0]);
1170		break;
1171	case 0x04:
1172		PRINT_WARN("(%s): DV Exception on loader 0x%02x\n",
1173			   device->cdev->dev.bus_id, sense->fmt.f71.md[0]);
1174		break;
1175	case 0x05:
1176		PRINT_WARN("(%s): DV Exception on message display 0x%02x\n",
1177			   device->cdev->dev.bus_id, sense->fmt.f71.md[0]);
1178		break;
1179	case 0x06:
1180		PRINT_WARN("(%s): DV Exception in tape path\n",
1181			   device->cdev->dev.bus_id);
1182		break;
1183	case 0x07:
1184		PRINT_WARN("(%s): DV Exception in drive\n",
1185			   device->cdev->dev.bus_id);
1186		break;
1187	default:
1188		PRINT_WARN("(%s): DSIM ExMsg: 0x%02x\n",
1189			   device->cdev->dev.bus_id, sense->fmt.f71.emc);
1190	}
1191	/* Service Message */
1192	switch (sense->fmt.f71.smc) {
1193	case 0x01:
1194		PRINT_WARN("(%s): Repair impact is unknown\n",
1195			   device->cdev->dev.bus_id);
1196		break;
1197	case 0x02:
1198		PRINT_WARN("(%s): Repair will not impact device performance\n",
1199			   device->cdev->dev.bus_id);
1200		break;
1201	case 0x03:
1202		if (sense->fmt.f71.mdf == 0)
1203			PRINT_WARN("(%s): Repair will disable channel path "
1204				   "0x%x on DV\n",
1205				   device->cdev->dev.bus_id,
1206				   sense->fmt.f71.md[1]);
1207		else
1208			PRINT_WARN("(%s): Repair will disable channel path "
1209				   "(0x%x-0x%x) on DV\n",
1210				   device->cdev->dev.bus_id,
1211				   sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1212		break;
1213	case 0x04:
1214		if (sense->fmt.f71.mdf == 0)
1215			PRINT_WARN("(%s): Repair will disable interface 0x%x "
1216				   "on DV\n",
1217				   device->cdev->dev.bus_id,
1218				   sense->fmt.f71.md[1]);
1219		else
1220			PRINT_WARN("(%s): Repair will disable interfaces "
1221				   "(0x%x-0x%x) on DV\n",
1222				   device->cdev->dev.bus_id,
1223				   sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1224		break;
1225	case 0x05:
1226		if (sense->fmt.f71.mdf == 0)
1227			PRINT_WARN("(%s): Repair will disable loader 0x%x "
1228				   "on DV\n",
1229				   device->cdev->dev.bus_id,
1230				   sense->fmt.f71.md[1]);
1231		else
1232			PRINT_WARN("(%s): Repair will disable loader "
1233				   "(0x%x-0x%x) on DV\n",
1234				   device->cdev->dev.bus_id,
1235				   sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1236		break;
1237	case 0x07:
1238		PRINT_WARN("(%s): Repair will disable access to DV\n",
1239			   device->cdev->dev.bus_id);
1240		break;
1241	case 0x08:
1242		if (sense->fmt.f71.mdf == 0)
1243			PRINT_WARN("(%s): Repair will disable message "
1244				   "display 0x%x on DV\n",
1245				   device->cdev->dev.bus_id,
1246				   sense->fmt.f71.md[1]);
1247		else
1248			PRINT_WARN("(%s): Repair will disable message "
1249				   "displays (0x%x-0x%x) on DV\n",
1250				   device->cdev->dev.bus_id,
1251				   sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1252		break;
1253	case 0x09:
1254		PRINT_WARN("(%s): Clean DV\n", device->cdev->dev.bus_id);
1255		break;
1256	default:
1257		PRINT_WARN("(%s): DSIM ServiceMsg: 0x%02x\n",
1258			   device->cdev->dev.bus_id, sense->fmt.f71.smc);
1259	}
1260}
1261
1262/*
1263 * Print standard ERA Message
1264 */
1265static void
1266tape_3590_print_era_msg(struct tape_device *device, struct irb *irb)
1267{
1268	struct tape_3590_sense *sense;
1269
1270	sense = (struct tape_3590_sense *) irb->ecw;
1271	if (sense->mc == 0)
1272		return;
1273	if ((sense->mc > 0) && (sense->mc < TAPE_3590_MAX_MSG)) {
1274		if (tape_3590_msg[sense->mc] != NULL)
1275			PRINT_WARN("(%s): %s\n", device->cdev->dev.bus_id,
1276				   tape_3590_msg[sense->mc]);
1277		else {
1278			PRINT_WARN("(%s): Message Code 0x%x\n",
1279				   device->cdev->dev.bus_id, sense->mc);
1280		}
1281		return;
1282	}
1283	if (sense->mc == 0xf0) {
1284		/* Standard Media Information Message */
1285		PRINT_WARN("(%s): MIM SEV=%i, MC=%02x, ES=%x/%x, "
1286			   "RC=%02x-%04x-%02x\n", device->cdev->dev.bus_id,
1287			   sense->fmt.f70.sev, sense->mc,
1288			   sense->fmt.f70.emc, sense->fmt.f70.smc,
1289			   sense->fmt.f70.refcode, sense->fmt.f70.mid,
1290			   sense->fmt.f70.fid);
1291		tape_3590_print_mim_msg_f0(device, irb);
1292		return;
1293	}
1294	if (sense->mc == 0xf1) {
1295		/* Standard I/O Subsystem Service Information Message */
1296		PRINT_WARN("(%s): IOSIM SEV=%i, DEVTYPE=3590/%02x, "
1297			   "MC=%02x, ES=%x/%x, REF=0x%04x-0x%04x-0x%04x\n",
1298			   device->cdev->dev.bus_id, sense->fmt.f71.sev,
1299			   device->cdev->id.dev_model,
1300			   sense->mc, sense->fmt.f71.emc,
1301			   sense->fmt.f71.smc, sense->fmt.f71.refcode1,
1302			   sense->fmt.f71.refcode2, sense->fmt.f71.refcode3);
1303		tape_3590_print_io_sim_msg_f1(device, irb);
1304		return;
1305	}
1306	if (sense->mc == 0xf2) {
1307		/* Standard Device Service Information Message */
1308		PRINT_WARN("(%s): DEVSIM SEV=%i, DEVTYPE=3590/%02x, "
1309			   "MC=%02x, ES=%x/%x, REF=0x%04x-0x%04x-0x%04x\n",
1310			   device->cdev->dev.bus_id, sense->fmt.f71.sev,
1311			   device->cdev->id.dev_model,
1312			   sense->mc, sense->fmt.f71.emc,
1313			   sense->fmt.f71.smc, sense->fmt.f71.refcode1,
1314			   sense->fmt.f71.refcode2, sense->fmt.f71.refcode3);
1315		tape_3590_print_dev_sim_msg_f2(device, irb);
1316		return;
1317	}
1318	if (sense->mc == 0xf3) {
1319		/* Standard Library Service Information Message */
1320		return;
1321	}
1322	PRINT_WARN("(%s): Device Message(%x)\n",
1323		   device->cdev->dev.bus_id, sense->mc);
1324}
1325
1326static int tape_3590_crypt_error(struct tape_device *device,
1327				 struct tape_request *request, struct irb *irb)
1328{
1329	u8 cu_rc, ekm_rc1;
1330	u16 ekm_rc2;
1331	u32 drv_rc;
1332	char *bus_id, *sense;
1333
1334	sense = ((struct tape_3590_sense *) irb->ecw)->fmt.data;
1335	bus_id = device->cdev->dev.bus_id;
1336	cu_rc = sense[0];
1337	drv_rc = *((u32*) &sense[5]) & 0xffffff;
1338	ekm_rc1 = sense[9];
1339	ekm_rc2 = *((u16*) &sense[10]);
1340	if ((cu_rc == 0) && (ekm_rc2 == 0xee31))
1341		/* key not defined on EKM */
1342		return tape_3590_erp_basic(device, request, irb, -EKEYREJECTED);
1343	if ((cu_rc == 1) || (cu_rc == 2))
1344		/* No connection to EKM */
1345		return tape_3590_erp_basic(device, request, irb, -ENOTCONN);
1346
1347	PRINT_ERR("(%s): Unable to get encryption key from EKM\n", bus_id);
1348	PRINT_ERR("(%s): CU=%02X DRIVE=%06X EKM=%02X:%04X\n", bus_id, cu_rc,
1349		drv_rc, ekm_rc1, ekm_rc2);
1350
1351	return tape_3590_erp_basic(device, request, irb, -ENOKEY);
1352}
1353
1354/*
1355 *  3590 error Recovery routine:
1356 *  If possible, it tries to recover from the error. If this is not possible,
1357 *  inform the user about the problem.
1358 */
1359static int
1360tape_3590_unit_check(struct tape_device *device, struct tape_request *request,
1361		     struct irb *irb)
1362{
1363	struct tape_3590_sense *sense;
1364	int rc;
1365
1366#ifdef CONFIG_S390_TAPE_BLOCK
1367	if (request->op == TO_BLOCK) {
1368		/*
1369		 * Recovery for block device requests. Set the block_position
1370		 * to something invalid and retry.
1371		 */
1372		device->blk_data.block_position = -1;
1373		if (request->retries-- <= 0)
1374			return tape_3590_erp_failed(device, request, irb, -EIO);
1375		else
1376			return tape_3590_erp_retry(device, request, irb);
1377	}
1378#endif
1379
1380	sense = (struct tape_3590_sense *) irb->ecw;
1381
1382	DBF_EVENT(6, "Unit Check: RQC = %x\n", sense->rc_rqc);
1383
1384	/*
1385	 * First check all RC-QRCs where we want to do something special
1386	 *   - "break":     basic error recovery is done
1387	 *   - "goto out:": just print error message if available
1388	 */
1389	rc = -EIO;
1390	switch (sense->rc_rqc) {
1391
1392	case 0x1110:
1393		tape_3590_print_era_msg(device, irb);
1394		return tape_3590_erp_read_buf_log(device, request, irb);
1395
1396	case 0x2011:
1397		tape_3590_print_era_msg(device, irb);
1398		return tape_3590_erp_read_alternate(device, request, irb);
1399
1400	case 0x2230:
1401	case 0x2231:
1402		tape_3590_print_era_msg(device, irb);
1403		return tape_3590_erp_special_interrupt(device, request, irb);
1404	case 0x2240:
1405		return tape_3590_crypt_error(device, request, irb);
1406
1407	case 0x3010:
1408		DBF_EVENT(2, "(%08x): Backward at Beginning of Partition\n",
1409			  device->cdev_id);
1410		return tape_3590_erp_basic(device, request, irb, -ENOSPC);
1411	case 0x3012:
1412		DBF_EVENT(2, "(%08x): Forward at End of Partition\n",
1413			  device->cdev_id);
1414		return tape_3590_erp_basic(device, request, irb, -ENOSPC);
1415	case 0x3020:
1416		DBF_EVENT(2, "(%08x): End of Data Mark\n", device->cdev_id);
1417		return tape_3590_erp_basic(device, request, irb, -ENOSPC);
1418
1419	case 0x3122:
1420		DBF_EVENT(2, "(%08x): Rewind Unload initiated\n",
1421			  device->cdev_id);
1422		return tape_3590_erp_basic(device, request, irb, -EIO);
1423	case 0x3123:
1424		DBF_EVENT(2, "(%08x): Rewind Unload complete\n",
1425			  device->cdev_id);
1426		tape_med_state_set(device, MS_UNLOADED);
1427		tape_3590_schedule_work(device, TO_CRYPT_OFF);
1428		return tape_3590_erp_basic(device, request, irb, 0);
1429
1430	case 0x4010:
1431		/*
1432		 * print additional msg since default msg
1433		 * "device intervention" is not very meaningfull
1434		 */
1435		PRINT_WARN("(%s): Tape operation when medium not loaded\n",
1436			   device->cdev->dev.bus_id);
1437		tape_med_state_set(device, MS_UNLOADED);
1438		tape_3590_schedule_work(device, TO_CRYPT_OFF);
1439		return tape_3590_erp_basic(device, request, irb, -ENOMEDIUM);
1440	case 0x4012:		/* Device Long Busy */
1441		/* XXX: Also use long busy handling here? */
1442		DBF_EVENT(6, "(%08x): LONG BUSY\n", device->cdev_id);
1443		tape_3590_print_era_msg(device, irb);
1444		return tape_3590_erp_basic(device, request, irb, -EBUSY);
1445	case 0x4014:
1446		DBF_EVENT(6, "(%08x): Crypto LONG BUSY\n", device->cdev_id);
1447		return tape_3590_erp_long_busy(device, request, irb);
1448
1449	case 0x5010:
1450		if (sense->rac == 0xd0) {
1451			/* Swap */
1452			tape_3590_print_era_msg(device, irb);
1453			return tape_3590_erp_swap(device, request, irb);
1454		}
1455		if (sense->rac == 0x26) {
1456			/* Read Opposite */
1457			tape_3590_print_era_msg(device, irb);
1458			return tape_3590_erp_read_opposite(device, request,
1459							   irb);
1460		}
1461		return tape_3590_erp_basic(device, request, irb, -EIO);
1462	case 0x5020:
1463	case 0x5021:
1464	case 0x5022:
1465	case 0x5040:
1466	case 0x5041:
1467	case 0x5042:
1468		tape_3590_print_era_msg(device, irb);
1469		return tape_3590_erp_swap(device, request, irb);
1470
1471	case 0x5110:
1472	case 0x5111:
1473		return tape_3590_erp_basic(device, request, irb, -EMEDIUMTYPE);
1474
1475	case 0x5120:
1476	case 0x1120:
1477		tape_med_state_set(device, MS_UNLOADED);
1478		tape_3590_schedule_work(device, TO_CRYPT_OFF);
1479		return tape_3590_erp_basic(device, request, irb, -ENOMEDIUM);
1480
1481	case 0x6020:
1482		PRINT_WARN("(%s): Cartridge of wrong type ?\n",
1483			   device->cdev->dev.bus_id);
1484		return tape_3590_erp_basic(device, request, irb, -EMEDIUMTYPE);
1485
1486	case 0x8011:
1487		PRINT_WARN("(%s): Another host has reserved the tape device\n",
1488			   device->cdev->dev.bus_id);
1489		return tape_3590_erp_basic(device, request, irb, -EPERM);
1490	case 0x8013:
1491		PRINT_WARN("(%s): Another host has priviliged access to the "
1492			   "tape device\n", device->cdev->dev.bus_id);
1493		PRINT_WARN("(%s): To solve the problem unload the current "
1494			   "cartridge!\n", device->cdev->dev.bus_id);
1495		return tape_3590_erp_basic(device, request, irb, -EPERM);
1496	default:
1497		return tape_3590_erp_basic(device, request, irb, -EIO);
1498	}
1499}
1500
1501/*
1502 * 3590 interrupt handler:
1503 */
1504static int
1505tape_3590_irq(struct tape_device *device, struct tape_request *request,
1506	      struct irb *irb)
1507{
1508	if (request == NULL)
1509		return tape_3590_unsolicited_irq(device, irb);
1510
1511	if ((irb->scsw.dstat & DEV_STAT_UNIT_EXCEP) &&
1512	    (irb->scsw.dstat & DEV_STAT_DEV_END) && (request->op == TO_WRI)) {
1513		/* Write at end of volume */
1514		DBF_EVENT(2, "End of volume\n");
1515		return tape_3590_erp_failed(device, request, irb, -ENOSPC);
1516	}
1517
1518	if (irb->scsw.dstat & DEV_STAT_UNIT_CHECK)
1519		return tape_3590_unit_check(device, request, irb);
1520
1521	if (irb->scsw.dstat & DEV_STAT_DEV_END) {
1522		if (irb->scsw.dstat == DEV_STAT_UNIT_EXCEP) {
1523			if (request->op == TO_FSB || request->op == TO_BSB)
1524				request->rescnt++;
1525			else
1526				DBF_EVENT(5, "Unit Exception!\n");
1527		}
1528
1529		return tape_3590_done(device, request);
1530	}
1531
1532	if (irb->scsw.dstat & DEV_STAT_CHN_END) {
1533		DBF_EVENT(2, "cannel end\n");
1534		return TAPE_IO_PENDING;
1535	}
1536
1537	if (irb->scsw.dstat & DEV_STAT_ATTENTION) {
1538		DBF_EVENT(2, "Unit Attention when busy..\n");
1539		return TAPE_IO_PENDING;
1540	}
1541
1542	DBF_EVENT(6, "xunknownirq\n");
1543	PRINT_ERR("Unexpected interrupt.\n");
1544	PRINT_ERR("Current op is: %s", tape_op_verbose[request->op]);
1545	tape_dump_sense(device, request, irb);
1546	return TAPE_IO_STOP;
1547}
1548
1549
1550static int tape_3590_read_dev_chars(struct tape_device *device,
1551				    struct tape_3590_rdc_data *rdc_data)
1552{
1553	int rc;
1554	struct tape_request *request;
1555
1556	request = tape_alloc_request(1, sizeof(*rdc_data));
1557	if (IS_ERR(request))
1558		return PTR_ERR(request);
1559	request->op = TO_RDC;
1560	tape_ccw_end(request->cpaddr, CCW_CMD_RDC, sizeof(*rdc_data),
1561		     request->cpdata);
1562	rc = tape_do_io(device, request);
1563	if (rc == 0)
1564		memcpy(rdc_data, request->cpdata, sizeof(*rdc_data));
1565	tape_free_request(request);
1566	return rc;
1567}
1568
1569/*
1570 * Setup device function
1571 */
1572static int
1573tape_3590_setup_device(struct tape_device *device)
1574{
1575	int rc;
1576	struct tape_3590_disc_data *data;
1577	struct tape_3590_rdc_data *rdc_data;
1578
1579	DBF_EVENT(6, "3590 device setup\n");
1580	data = kzalloc(sizeof(struct tape_3590_disc_data), GFP_KERNEL | GFP_DMA);
1581	if (data == NULL)
1582		return -ENOMEM;
1583	data->read_back_op = READ_PREVIOUS;
1584	device->discdata = data;
1585
1586	rdc_data = kmalloc(sizeof(*rdc_data), GFP_KERNEL | GFP_DMA);
1587	if (!rdc_data) {
1588		rc = -ENOMEM;
1589		goto fail_kmalloc;
1590	}
1591	rc = tape_3590_read_dev_chars(device, rdc_data);
1592	if (rc) {
1593		DBF_LH(3, "Read device characteristics failed!\n");
1594		goto fail_kmalloc;
1595	}
1596	rc = tape_std_assign(device);
1597	if (rc)
1598		goto fail_rdc_data;
1599	if (rdc_data->data[31] == 0x13) {
1600		PRINT_INFO("Device has crypto support\n");
1601		data->crypt_info.capability |= TAPE390_CRYPT_SUPPORTED_MASK;
1602		tape_3592_disable_crypt(device);
1603	} else {
1604		DBF_EVENT(6, "Device has NO crypto support\n");
1605	}
1606	/* Try to find out if medium is loaded */
1607	rc = tape_3590_sense_medium(device);
1608	if (rc) {
1609		DBF_LH(3, "3590 medium sense returned %d\n", rc);
1610		goto fail_rdc_data;
1611	}
1612	return 0;
1613
1614fail_rdc_data:
1615	kfree(rdc_data);
1616fail_kmalloc:
1617	kfree(data);
1618	return rc;
1619}
1620
1621/*
1622 * Cleanup device function
1623 */
1624static void
1625tape_3590_cleanup_device(struct tape_device *device)
1626{
1627	flush_scheduled_work();
1628	tape_std_unassign(device);
1629
1630	kfree(device->discdata);
1631	device->discdata = NULL;
1632}
1633
1634/*
1635 * List of 3590 magnetic tape commands.
1636 */
1637static tape_mtop_fn tape_3590_mtop[TAPE_NR_MTOPS] = {
1638	[MTRESET]	 = tape_std_mtreset,
1639	[MTFSF]		 = tape_std_mtfsf,
1640	[MTBSF]		 = tape_std_mtbsf,
1641	[MTFSR]		 = tape_std_mtfsr,
1642	[MTBSR]		 = tape_std_mtbsr,
1643	[MTWEOF]	 = tape_std_mtweof,
1644	[MTREW]		 = tape_std_mtrew,
1645	[MTOFFL]	 = tape_std_mtoffl,
1646	[MTNOP]		 = tape_std_mtnop,
1647	[MTRETEN]	 = tape_std_mtreten,
1648	[MTBSFM]	 = tape_std_mtbsfm,
1649	[MTFSFM]	 = tape_std_mtfsfm,
1650	[MTEOM]		 = tape_std_mteom,
1651	[MTERASE]	 = tape_std_mterase,
1652	[MTRAS1]	 = NULL,
1653	[MTRAS2]	 = NULL,
1654	[MTRAS3]	 = NULL,
1655	[MTSETBLK]	 = tape_std_mtsetblk,
1656	[MTSETDENSITY]	 = NULL,
1657	[MTSEEK]	 = tape_3590_mtseek,
1658	[MTTELL]	 = tape_3590_mttell,
1659	[MTSETDRVBUFFER] = NULL,
1660	[MTFSS]		 = NULL,
1661	[MTBSS]		 = NULL,
1662	[MTWSM]		 = NULL,
1663	[MTLOCK]	 = NULL,
1664	[MTUNLOCK]	 = NULL,
1665	[MTLOAD]	 = tape_std_mtload,
1666	[MTUNLOAD]	 = tape_std_mtunload,
1667	[MTCOMPRESSION]	 = tape_std_mtcompression,
1668	[MTSETPART]	 = NULL,
1669	[MTMKPART]	 = NULL
1670};
1671
1672/*
1673 * Tape discipline structure for 3590.
1674 */
1675static struct tape_discipline tape_discipline_3590 = {
1676	.owner = THIS_MODULE,
1677	.setup_device = tape_3590_setup_device,
1678	.cleanup_device = tape_3590_cleanup_device,
1679	.process_eov = tape_std_process_eov,
1680	.irq = tape_3590_irq,
1681	.read_block = tape_std_read_block,
1682	.write_block = tape_std_write_block,
1683#ifdef CONFIG_S390_TAPE_BLOCK
1684	.bread = tape_3590_bread,
1685	.free_bread = tape_3590_free_bread,
1686	.check_locate = tape_3590_check_locate,
1687#endif
1688	.ioctl_fn = tape_3590_ioctl,
1689	.mtop_array = tape_3590_mtop
1690};
1691
1692static struct ccw_device_id tape_3590_ids[] = {
1693	{CCW_DEVICE_DEVTYPE(0x3590, 0, 0x3590, 0), .driver_info = tape_3590},
1694	{CCW_DEVICE_DEVTYPE(0x3592, 0, 0x3592, 0), .driver_info = tape_3592},
1695	{ /* end of list */ }
1696};
1697
1698static int
1699tape_3590_online(struct ccw_device *cdev)
1700{
1701	return tape_generic_online(cdev->dev.driver_data,
1702				   &tape_discipline_3590);
1703}
1704
1705static int
1706tape_3590_offline(struct ccw_device *cdev)
1707{
1708	return tape_generic_offline(cdev->dev.driver_data);
1709}
1710
1711static struct ccw_driver tape_3590_driver = {
1712	.name = "tape_3590",
1713	.owner = THIS_MODULE,
1714	.ids = tape_3590_ids,
1715	.probe = tape_generic_probe,
1716	.remove = tape_generic_remove,
1717	.set_offline = tape_3590_offline,
1718	.set_online = tape_3590_online,
1719};
1720
1721/*
1722 * Setup discipline structure.
1723 */
1724static int
1725tape_3590_init(void)
1726{
1727	int rc;
1728
1729	TAPE_DBF_AREA = debug_register("tape_3590", 2, 2, 4 * sizeof(long));
1730	debug_register_view(TAPE_DBF_AREA, &debug_sprintf_view);
1731#ifdef DBF_LIKE_HELL
1732	debug_set_level(TAPE_DBF_AREA, 6);
1733#endif
1734
1735	DBF_EVENT(3, "3590 init\n");
1736	/* Register driver for 3590 tapes. */
1737	rc = ccw_driver_register(&tape_3590_driver);
1738	if (rc)
1739		DBF_EVENT(3, "3590 init failed\n");
1740	else
1741		DBF_EVENT(3, "3590 registered\n");
1742	return rc;
1743}
1744
1745static void
1746tape_3590_exit(void)
1747{
1748	ccw_driver_unregister(&tape_3590_driver);
1749
1750	debug_unregister(TAPE_DBF_AREA);
1751}
1752
1753MODULE_DEVICE_TABLE(ccw, tape_3590_ids);
1754MODULE_AUTHOR("(C) 2001,2006 IBM Corporation");
1755MODULE_DESCRIPTION("Linux on zSeries channel attached 3590 tape device driver");
1756MODULE_LICENSE("GPL");
1757
1758module_init(tape_3590_init);
1759module_exit(tape_3590_exit);
1760