4005c44a404c47efbb33d8e177389ca4a0b01a28
[linux-2.6.git] / drivers / s390 / char / tape_3590.c
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  */
25 debug_info_t *TAPE_DBF_AREA = NULL;
26 EXPORT_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
41 static 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
98 static int crypt_supported(struct tape_device *device)
99 {
100         return TAPE390_CRYPT_SUPPORTED(TAPE_3590_CRYPT_INFO(device));
101 }
102
103 static int crypt_enabled(struct tape_device *device)
104 {
105         return TAPE390_CRYPT_ON(TAPE_3590_CRYPT_INFO(device));
106 }
107
108 static 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
124 static 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
141 static 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
162 static 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;
177 invalid:
178         return -EINVAL;
179 }
180
181 static 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;
189 invalid:
190         return -EINVAL;
191 }
192
193 /*
194  * Query KEKLs
195  */
196 static 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;
227 fail_request:
228         tape_free_request(request);
229 fail_malloc:
230         kfree(int_kekls);
231         return rc;
232 }
233
234 /*
235  * IOCTL: Query KEKLs
236  */
237 static 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;
259 fail:
260         kfree(ext_kekls);
261         return rc;
262 }
263
264 static int tape_3590_mttell(struct tape_device *device, int mt_count);
265
266 /*
267  * Set KEKLs
268  */
269 static 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  */
300 static 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);
319 out:
320         kfree(ext_kekls);
321         return rc;
322 }
323
324 /*
325  * Enable encryption
326  */
327 static 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  */
358 static 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  */
387 static 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
405 static int tape_3590_sense_medium(struct tape_device *device);
406
407 /*
408  * IOCTL: Query enryption status
409  */
410 static 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  */
427 static int
428 tape_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  */
455 static int
456 tape_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  */
471 static int
472 tape_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  */
486 static int
487 tape_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  */
507 static void
508 tape_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  */
544 static int
545 tape_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  */
567 struct work_handler_data {
568         struct tape_device *device;
569         enum tape_op        op;
570         struct work_struct  work;
571 };
572
573 static void
574 tape_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
600 static int
601 tape_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  */
621 static struct tape_request *
622 tape_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; off += TAPEBLOCK_HSEC_SIZE) {
657                         ccw->flags = CCW_FLAG_CC;
658                         ccw->cmd_code = READ_FORWARD;
659                         ccw->count = TAPEBLOCK_HSEC_SIZE;
660                         set_normalized_cda(ccw, (void *) __pa(dst));
661                         ccw++;
662                         dst += TAPEBLOCK_HSEC_SIZE;
663                 }
664                 if (off > bv->bv_len)
665                         BUG();
666         }
667         ccw = tape_ccw_end(ccw, NOP, 0, NULL);
668         DBF_EVENT(6, "xBREDccwg\n");
669         return request;
670 }
671
672 static void
673 tape_3590_free_bread(struct tape_request *request)
674 {
675         struct ccw1 *ccw;
676
677         /* Last ccw is a nop and doesn't need clear_normalized_cda */
678         for (ccw = request->cpaddr; ccw->flags & CCW_FLAG_CC; ccw++)
679                 if (ccw->cmd_code == READ_FORWARD)
680                         clear_normalized_cda(ccw);
681         tape_free_request(request);
682 }
683
684 /*
685  * check_locate is called just before the tape request is passed to
686  * the common io layer for execution. It has to check the current
687  * tape position and insert a locate ccw if it doesn't match the
688  * start block for the request.
689  */
690 static void
691 tape_3590_check_locate(struct tape_device *device, struct tape_request *request)
692 {
693         __u32 *start_block;
694
695         start_block = (__u32 *) request->cpdata;
696         if (*start_block != device->blk_data.block_position) {
697                 /* Add the start offset of the file to get the real block. */
698                 *start_block += device->bof;
699                 tape_ccw_cc(request->cpaddr + 1, LOCATE, 4, request->cpdata);
700         }
701 }
702 #endif
703
704 static void tape_3590_med_state_set(struct tape_device *device,
705                                     struct tape_3590_med_sense *sense)
706 {
707         struct tape390_crypt_info *c_info;
708
709         c_info = &TAPE_3590_CRYPT_INFO(device);
710
711         DBF_EVENT(6, "medium state: %x:%x\n", sense->macst, sense->masst);
712         switch (sense->macst) {
713         case 0x04:
714         case 0x05:
715         case 0x06:
716                 tape_med_state_set(device, MS_UNLOADED);
717                 TAPE_3590_CRYPT_INFO(device).medium_status = 0;
718                 return;
719         case 0x08:
720         case 0x09:
721                 tape_med_state_set(device, MS_LOADED);
722                 break;
723         default:
724                 tape_med_state_set(device, MS_UNKNOWN);
725                 return;
726         }
727         c_info->medium_status |= TAPE390_MEDIUM_LOADED_MASK;
728         if (sense->flags & MSENSE_CRYPT_MASK) {
729                 PRINT_INFO("Medium is encrypted (%04x)\n", sense->flags);
730                 c_info->medium_status |= TAPE390_MEDIUM_ENCRYPTED_MASK;
731         } else  {
732                 DBF_EVENT(6, "Medium is not encrypted %04x\n", sense->flags);
733                 c_info->medium_status &= ~TAPE390_MEDIUM_ENCRYPTED_MASK;
734         }
735 }
736
737 /*
738  * The done handler is called at device/channel end and wakes up the sleeping
739  * process
740  */
741 static int
742 tape_3590_done(struct tape_device *device, struct tape_request *request)
743 {
744         struct tape_3590_disc_data *disc_data;
745
746         DBF_EVENT(6, "%s done\n", tape_op_verbose[request->op]);
747         disc_data = device->discdata;
748
749         switch (request->op) {
750         case TO_BSB:
751         case TO_BSF:
752         case TO_DSE:
753         case TO_FSB:
754         case TO_FSF:
755         case TO_LBL:
756         case TO_RFO:
757         case TO_RBA:
758         case TO_REW:
759         case TO_WRI:
760         case TO_WTM:
761         case TO_BLOCK:
762         case TO_LOAD:
763                 tape_med_state_set(device, MS_LOADED);
764                 break;
765         case TO_RUN:
766                 tape_med_state_set(device, MS_UNLOADED);
767                 tape_3590_schedule_work(device, TO_CRYPT_OFF);
768                 break;
769         case TO_MSEN:
770                 tape_3590_med_state_set(device, request->cpdata);
771                 break;
772         case TO_CRYPT_ON:
773                 TAPE_3590_CRYPT_INFO(device).status
774                         |= TAPE390_CRYPT_ON_MASK;
775                 *(device->modeset_byte) |= 0x03;
776                 break;
777         case TO_CRYPT_OFF:
778                 TAPE_3590_CRYPT_INFO(device).status
779                         &= ~TAPE390_CRYPT_ON_MASK;
780                 *(device->modeset_byte) &= ~0x03;
781                 break;
782         case TO_RBI:    /* RBI seems to succeed even without medium loaded. */
783         case TO_NOP:    /* Same to NOP. */
784         case TO_READ_CONFIG:
785         case TO_READ_ATTMSG:
786         case TO_DIS:
787         case TO_ASSIGN:
788         case TO_UNASSIGN:
789         case TO_SIZE:
790         case TO_KEKL_SET:
791         case TO_KEKL_QUERY:
792         case TO_RDC:
793                 break;
794         }
795         return TAPE_IO_SUCCESS;
796 }
797
798 /*
799  * This fuction is called, when error recovery was successfull
800  */
801 static inline int
802 tape_3590_erp_succeded(struct tape_device *device, struct tape_request *request)
803 {
804         DBF_EVENT(3, "Error Recovery successfull for %s\n",
805                   tape_op_verbose[request->op]);
806         return tape_3590_done(device, request);
807 }
808
809 /*
810  * This fuction is called, when error recovery was not successfull
811  */
812 static inline int
813 tape_3590_erp_failed(struct tape_device *device, struct tape_request *request,
814                      struct irb *irb, int rc)
815 {
816         DBF_EVENT(3, "Error Recovery failed for %s\n",
817                   tape_op_verbose[request->op]);
818         tape_dump_sense_dbf(device, request, irb);
819         return rc;
820 }
821
822 /*
823  * Error Recovery do retry
824  */
825 static inline int
826 tape_3590_erp_retry(struct tape_device *device, struct tape_request *request,
827                     struct irb *irb)
828 {
829         DBF_EVENT(2, "Retry: %s\n", tape_op_verbose[request->op]);
830         tape_dump_sense_dbf(device, request, irb);
831         return TAPE_IO_RETRY;
832 }
833
834 /*
835  * Handle unsolicited interrupts
836  */
837 static int
838 tape_3590_unsolicited_irq(struct tape_device *device, struct irb *irb)
839 {
840         if (irb->scsw.cmd.dstat == DEV_STAT_CHN_END)
841                 /* Probably result of halt ssch */
842                 return TAPE_IO_PENDING;
843         else if (irb->scsw.cmd.dstat == 0x85)
844                 /* Device Ready */
845                 DBF_EVENT(3, "unsol.irq! tape ready: %08x\n", device->cdev_id);
846         else if (irb->scsw.cmd.dstat & DEV_STAT_ATTENTION) {
847                 tape_3590_schedule_work(device, TO_READ_ATTMSG);
848         } else {
849                 DBF_EVENT(3, "unsol.irq! dev end: %08x\n", device->cdev_id);
850                 PRINT_WARN("Unsolicited IRQ (Device End) caught.\n");
851                 tape_dump_sense(device, NULL, irb);
852         }
853         /* check medium state */
854         tape_3590_schedule_work(device, TO_MSEN);
855         return TAPE_IO_SUCCESS;
856 }
857
858 /*
859  * Basic Recovery routine
860  */
861 static int
862 tape_3590_erp_basic(struct tape_device *device, struct tape_request *request,
863                     struct irb *irb, int rc)
864 {
865         struct tape_3590_sense *sense;
866
867         sense = (struct tape_3590_sense *) irb->ecw;
868
869         switch (sense->bra) {
870         case SENSE_BRA_PER:
871                 return tape_3590_erp_failed(device, request, irb, rc);
872         case SENSE_BRA_CONT:
873                 return tape_3590_erp_succeded(device, request);
874         case SENSE_BRA_RE:
875                 return tape_3590_erp_retry(device, request, irb);
876         case SENSE_BRA_DRE:
877                 return tape_3590_erp_failed(device, request, irb, rc);
878         default:
879                 PRINT_ERR("Unknown BRA %x - This should not happen!\n",
880                           sense->bra);
881                 BUG();
882                 return TAPE_IO_STOP;
883         }
884 }
885
886 /*
887  *  RDL: Read Device (buffered) log
888  */
889 static int
890 tape_3590_erp_read_buf_log(struct tape_device *device,
891                            struct tape_request *request, struct irb *irb)
892 {
893         /*
894          * We just do the basic error recovery at the moment (retry).
895          * Perhaps in the future, we read the log and dump it somewhere...
896          */
897         return tape_3590_erp_basic(device, request, irb, -EIO);
898 }
899
900 /*
901  *  SWAP: Swap Devices
902  */
903 static int
904 tape_3590_erp_swap(struct tape_device *device, struct tape_request *request,
905                    struct irb *irb)
906 {
907         /*
908          * This error recovery should swap the tapes
909          * if the original has a problem. The operation
910          * should proceed with the new tape... this
911          * should probably be done in user space!
912          */
913         PRINT_WARN("(%s): Swap Tape Device!\n", dev_name(&device->cdev->dev));
914         return tape_3590_erp_basic(device, request, irb, -EIO);
915 }
916
917 /*
918  *  LBY: Long Busy
919  */
920 static int
921 tape_3590_erp_long_busy(struct tape_device *device,
922                         struct tape_request *request, struct irb *irb)
923 {
924         DBF_EVENT(6, "Device is busy\n");
925         return TAPE_IO_LONG_BUSY;
926 }
927
928 /*
929  *  SPI: Special Intercept
930  */
931 static int
932 tape_3590_erp_special_interrupt(struct tape_device *device,
933                                 struct tape_request *request, struct irb *irb)
934 {
935         return tape_3590_erp_basic(device, request, irb, -EIO);
936 }
937
938 /*
939  *  RDA: Read Alternate
940  */
941 static int
942 tape_3590_erp_read_alternate(struct tape_device *device,
943                              struct tape_request *request, struct irb *irb)
944 {
945         struct tape_3590_disc_data *data;
946
947         /*
948          * The issued Read Backward or Read Previous command is not
949          * supported by the device
950          * The recovery action should be to issue another command:
951          * Read Revious: if Read Backward is not supported
952          * Read Backward: if Read Previous is not supported
953          */
954         data = device->discdata;
955         if (data->read_back_op == READ_PREVIOUS) {
956                 DBF_EVENT(2, "(%08x): No support for READ_PREVIOUS command\n",
957                           device->cdev_id);
958                 data->read_back_op = READ_BACKWARD;
959         } else {
960                 DBF_EVENT(2, "(%08x): No support for READ_BACKWARD command\n",
961                           device->cdev_id);
962                 data->read_back_op = READ_PREVIOUS;
963         }
964         tape_3590_read_opposite(device, request);
965         return tape_3590_erp_retry(device, request, irb);
966 }
967
968 /*
969  * Error Recovery read opposite
970  */
971 static int
972 tape_3590_erp_read_opposite(struct tape_device *device,
973                             struct tape_request *request, struct irb *irb)
974 {
975         switch (request->op) {
976         case TO_RFO:
977                 /*
978                  * We did read forward, but the data could not be read.
979                  * We will read backward and then skip forward again.
980                  */
981                 tape_3590_read_opposite(device, request);
982                 return tape_3590_erp_retry(device, request, irb);
983         case TO_RBA:
984                 /* We tried to read forward and backward, but hat no success */
985                 return tape_3590_erp_failed(device, request, irb, -EIO);
986                 break;
987         default:
988                 PRINT_WARN("read_opposite_recovery_called_with_op: %s\n",
989                            tape_op_verbose[request->op]);
990                 return tape_3590_erp_failed(device, request, irb, -EIO);
991         }
992 }
993
994 /*
995  * Print an MIM (Media Information  Message) (message code f0)
996  */
997 static void
998 tape_3590_print_mim_msg_f0(struct tape_device *device, struct irb *irb)
999 {
1000         struct tape_3590_sense *sense;
1001
1002         sense = (struct tape_3590_sense *) irb->ecw;
1003         /* Exception Message */
1004         switch (sense->fmt.f70.emc) {
1005         case 0x02:
1006                 PRINT_WARN("(%s): Data degraded\n",
1007                            dev_name(&device->cdev->dev));
1008                 break;
1009         case 0x03:
1010                 PRINT_WARN("(%s): Data degraded in partion %i\n",
1011                            dev_name(&device->cdev->dev), sense->fmt.f70.mp);
1012                 break;
1013         case 0x04:
1014                 PRINT_WARN("(%s): Medium degraded\n",
1015                            dev_name(&device->cdev->dev));
1016                 break;
1017         case 0x05:
1018                 PRINT_WARN("(%s): Medium degraded in partition %i\n",
1019                            dev_name(&device->cdev->dev), sense->fmt.f70.mp);
1020                 break;
1021         case 0x06:
1022                 PRINT_WARN("(%s): Block 0 Error\n",
1023                            dev_name(&device->cdev->dev));
1024                 break;
1025         case 0x07:
1026                 PRINT_WARN("(%s): Medium Exception 0x%02x\n",
1027                            dev_name(&device->cdev->dev), sense->fmt.f70.md);
1028                 break;
1029         default:
1030                 PRINT_WARN("(%s): MIM ExMsg: 0x%02x\n",
1031                            dev_name(&device->cdev->dev), sense->fmt.f70.emc);
1032                 break;
1033         }
1034         /* Service Message */
1035         switch (sense->fmt.f70.smc) {
1036         case 0x02:
1037                 PRINT_WARN("(%s): Reference Media maintenance procedure %i\n",
1038                            dev_name(&device->cdev->dev), sense->fmt.f70.md);
1039                 break;
1040         default:
1041                 PRINT_WARN("(%s): MIM ServiceMsg: 0x%02x\n",
1042                            dev_name(&device->cdev->dev), sense->fmt.f70.smc);
1043                 break;
1044         }
1045 }
1046
1047 /*
1048  * Print an I/O Subsystem Service Information Message (message code f1)
1049  */
1050 static void
1051 tape_3590_print_io_sim_msg_f1(struct tape_device *device, struct irb *irb)
1052 {
1053         struct tape_3590_sense *sense;
1054
1055         sense = (struct tape_3590_sense *) irb->ecw;
1056         /* Exception Message */
1057         switch (sense->fmt.f71.emc) {
1058         case 0x01:
1059                 PRINT_WARN("(%s): Effect of failure is unknown\n",
1060                            dev_name(&device->cdev->dev));
1061                 break;
1062         case 0x02:
1063                 PRINT_WARN("(%s): CU Exception - no performance impact\n",
1064                            dev_name(&device->cdev->dev));
1065                 break;
1066         case 0x03:
1067                 PRINT_WARN("(%s): CU Exception on channel interface 0x%02x\n",
1068                            dev_name(&device->cdev->dev), sense->fmt.f71.md[0]);
1069                 break;
1070         case 0x04:
1071                 PRINT_WARN("(%s): CU Exception on device path 0x%02x\n",
1072                            dev_name(&device->cdev->dev), sense->fmt.f71.md[0]);
1073                 break;
1074         case 0x05:
1075                 PRINT_WARN("(%s): CU Exception on library path 0x%02x\n",
1076                            dev_name(&device->cdev->dev), sense->fmt.f71.md[0]);
1077                 break;
1078         case 0x06:
1079                 PRINT_WARN("(%s): CU Exception on node 0x%02x\n",
1080                            dev_name(&device->cdev->dev), sense->fmt.f71.md[0]);
1081                 break;
1082         case 0x07:
1083                 PRINT_WARN("(%s): CU Exception on partition 0x%02x\n",
1084                            dev_name(&device->cdev->dev), sense->fmt.f71.md[0]);
1085                 break;
1086         default:
1087                 PRINT_WARN("(%s): SIM ExMsg: 0x%02x\n",
1088                            dev_name(&device->cdev->dev), sense->fmt.f71.emc);
1089         }
1090         /* Service Message */
1091         switch (sense->fmt.f71.smc) {
1092         case 0x01:
1093                 PRINT_WARN("(%s): Repair impact is unknown\n",
1094                            dev_name(&device->cdev->dev));
1095                 break;
1096         case 0x02:
1097                 PRINT_WARN("(%s): Repair will not impact cu performance\n",
1098                            dev_name(&device->cdev->dev));
1099                 break;
1100         case 0x03:
1101                 if (sense->fmt.f71.mdf == 0)
1102                         PRINT_WARN("(%s): Repair will disable node "
1103                                    "0x%x on CU\n",
1104                                    dev_name(&device->cdev->dev),
1105                                    sense->fmt.f71.md[1]);
1106                 else
1107                         PRINT_WARN("(%s): Repair will disable nodes "
1108                                    "(0x%x-0x%x) on CU\n",
1109                                    dev_name(&device->cdev->dev),
1110                                    sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1111                 break;
1112         case 0x04:
1113                 if (sense->fmt.f71.mdf == 0)
1114                         PRINT_WARN("(%s): Repair will disable cannel path "
1115                                    "0x%x on CU\n",
1116                                    dev_name(&device->cdev->dev),
1117                                    sense->fmt.f71.md[1]);
1118                 else
1119                         PRINT_WARN("(%s): Repair will disable cannel paths "
1120                                    "(0x%x-0x%x) on CU\n",
1121                                    dev_name(&device->cdev->dev),
1122                                    sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1123                 break;
1124         case 0x05:
1125                 if (sense->fmt.f71.mdf == 0)
1126                         PRINT_WARN("(%s): Repair will disable device path "
1127                                    "0x%x on CU\n",
1128                                    dev_name(&device->cdev->dev),
1129                                    sense->fmt.f71.md[1]);
1130                 else
1131                         PRINT_WARN("(%s): Repair will disable device paths "
1132                                    "(0x%x-0x%x) on CU\n",
1133                                    dev_name(&device->cdev->dev),
1134                                    sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1135                 break;
1136         case 0x06:
1137                 if (sense->fmt.f71.mdf == 0)
1138                         PRINT_WARN("(%s): Repair will disable library path "
1139                                    "0x%x on CU\n",
1140                                    dev_name(&device->cdev->dev),
1141                                    sense->fmt.f71.md[1]);
1142                 else
1143                         PRINT_WARN("(%s): Repair will disable library paths "
1144                                    "(0x%x-0x%x) on CU\n",
1145                                    dev_name(&device->cdev->dev),
1146                                    sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1147                 break;
1148         case 0x07:
1149                 PRINT_WARN("(%s): Repair will disable access to CU\n",
1150                            dev_name(&device->cdev->dev));
1151                 break;
1152         default:
1153                 PRINT_WARN("(%s): SIM ServiceMsg: 0x%02x\n",
1154                            dev_name(&device->cdev->dev), sense->fmt.f71.smc);
1155         }
1156 }
1157
1158 /*
1159  * Print an Device Subsystem Service Information Message (message code f2)
1160  */
1161 static void
1162 tape_3590_print_dev_sim_msg_f2(struct tape_device *device, struct irb *irb)
1163 {
1164         struct tape_3590_sense *sense;
1165
1166         sense = (struct tape_3590_sense *) irb->ecw;
1167         /* Exception Message */
1168         switch (sense->fmt.f71.emc) {
1169         case 0x01:
1170                 PRINT_WARN("(%s): Effect of failure is unknown\n",
1171                            dev_name(&device->cdev->dev));
1172                 break;
1173         case 0x02:
1174                 PRINT_WARN("(%s): DV Exception - no performance impact\n",
1175                            dev_name(&device->cdev->dev));
1176                 break;
1177         case 0x03:
1178                 PRINT_WARN("(%s): DV Exception on channel interface 0x%02x\n",
1179                            dev_name(&device->cdev->dev), sense->fmt.f71.md[0]);
1180                 break;
1181         case 0x04:
1182                 PRINT_WARN("(%s): DV Exception on loader 0x%02x\n",
1183                            dev_name(&device->cdev->dev), sense->fmt.f71.md[0]);
1184                 break;
1185         case 0x05:
1186                 PRINT_WARN("(%s): DV Exception on message display 0x%02x\n",
1187                            dev_name(&device->cdev->dev), sense->fmt.f71.md[0]);
1188                 break;
1189         case 0x06:
1190                 PRINT_WARN("(%s): DV Exception in tape path\n",
1191                            dev_name(&device->cdev->dev));
1192                 break;
1193         case 0x07:
1194                 PRINT_WARN("(%s): DV Exception in drive\n",
1195                            dev_name(&device->cdev->dev));
1196                 break;
1197         default:
1198                 PRINT_WARN("(%s): DSIM ExMsg: 0x%02x\n",
1199                            dev_name(&device->cdev->dev), sense->fmt.f71.emc);
1200         }
1201         /* Service Message */
1202         switch (sense->fmt.f71.smc) {
1203         case 0x01:
1204                 PRINT_WARN("(%s): Repair impact is unknown\n",
1205                            dev_name(&device->cdev->dev));
1206                 break;
1207         case 0x02:
1208                 PRINT_WARN("(%s): Repair will not impact device performance\n",
1209                            dev_name(&device->cdev->dev));
1210                 break;
1211         case 0x03:
1212                 if (sense->fmt.f71.mdf == 0)
1213                         PRINT_WARN("(%s): Repair will disable channel path "
1214                                    "0x%x on DV\n",
1215                                    dev_name(&device->cdev->dev),
1216                                    sense->fmt.f71.md[1]);
1217                 else
1218                         PRINT_WARN("(%s): Repair will disable channel path "
1219                                    "(0x%x-0x%x) on DV\n",
1220                                    dev_name(&device->cdev->dev),
1221                                    sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1222                 break;
1223         case 0x04:
1224                 if (sense->fmt.f71.mdf == 0)
1225                         PRINT_WARN("(%s): Repair will disable interface 0x%x "
1226                                    "on DV\n",
1227                                    dev_name(&device->cdev->dev),
1228                                    sense->fmt.f71.md[1]);
1229                 else
1230                         PRINT_WARN("(%s): Repair will disable interfaces "
1231                                    "(0x%x-0x%x) on DV\n",
1232                                    dev_name(&device->cdev->dev),
1233                                    sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1234                 break;
1235         case 0x05:
1236                 if (sense->fmt.f71.mdf == 0)
1237                         PRINT_WARN("(%s): Repair will disable loader 0x%x "
1238                                    "on DV\n",
1239                                    dev_name(&device->cdev->dev),
1240                                    sense->fmt.f71.md[1]);
1241                 else
1242                         PRINT_WARN("(%s): Repair will disable loader "
1243                                    "(0x%x-0x%x) on DV\n",
1244                                    dev_name(&device->cdev->dev),
1245                                    sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1246                 break;
1247         case 0x07:
1248                 PRINT_WARN("(%s): Repair will disable access to DV\n",
1249                            dev_name(&device->cdev->dev));
1250                 break;
1251         case 0x08:
1252                 if (sense->fmt.f71.mdf == 0)
1253                         PRINT_WARN("(%s): Repair will disable message "
1254                                    "display 0x%x on DV\n",
1255                                    dev_name(&device->cdev->dev),
1256                                    sense->fmt.f71.md[1]);
1257                 else
1258                         PRINT_WARN("(%s): Repair will disable message "
1259                                    "displays (0x%x-0x%x) on DV\n",
1260                                    dev_name(&device->cdev->dev),
1261                                    sense->fmt.f71.md[1], sense->fmt.f71.md[2]);
1262                 break;
1263         case 0x09:
1264                 PRINT_WARN("(%s): Clean DV\n", dev_name(&device->cdev->dev));
1265                 break;
1266         default:
1267                 PRINT_WARN("(%s): DSIM ServiceMsg: 0x%02x\n",
1268                            dev_name(&device->cdev->dev), sense->fmt.f71.smc);
1269         }
1270 }
1271
1272 /*
1273  * Print standard ERA Message
1274  */
1275 static void
1276 tape_3590_print_era_msg(struct tape_device *device, struct irb *irb)
1277 {
1278         struct tape_3590_sense *sense;
1279
1280         sense = (struct tape_3590_sense *) irb->ecw;
1281         if (sense->mc == 0)
1282                 return;
1283         if ((sense->mc > 0) && (sense->mc < TAPE_3590_MAX_MSG)) {
1284                 if (tape_3590_msg[sense->mc] != NULL)
1285                         PRINT_WARN("(%s): %s\n", dev_name(&device->cdev->dev),
1286                                    tape_3590_msg[sense->mc]);
1287                 else {
1288                         PRINT_WARN("(%s): Message Code 0x%x\n",
1289                                    dev_name(&device->cdev->dev), sense->mc);
1290                 }
1291                 return;
1292         }
1293         if (sense->mc == 0xf0) {
1294                 /* Standard Media Information Message */
1295                 PRINT_WARN("(%s): MIM SEV=%i, MC=%02x, ES=%x/%x, "
1296                            "RC=%02x-%04x-%02x\n", dev_name(&device->cdev->dev),
1297                            sense->fmt.f70.sev, sense->mc,
1298                            sense->fmt.f70.emc, sense->fmt.f70.smc,
1299                            sense->fmt.f70.refcode, sense->fmt.f70.mid,
1300                            sense->fmt.f70.fid);
1301                 tape_3590_print_mim_msg_f0(device, irb);
1302                 return;
1303         }
1304         if (sense->mc == 0xf1) {
1305                 /* Standard I/O Subsystem Service Information Message */
1306                 PRINT_WARN("(%s): IOSIM SEV=%i, DEVTYPE=3590/%02x, "
1307                            "MC=%02x, ES=%x/%x, REF=0x%04x-0x%04x-0x%04x\n",
1308                            dev_name(&device->cdev->dev), sense->fmt.f71.sev,
1309                            device->cdev->id.dev_model,
1310                            sense->mc, sense->fmt.f71.emc,
1311                            sense->fmt.f71.smc, sense->fmt.f71.refcode1,
1312                            sense->fmt.f71.refcode2, sense->fmt.f71.refcode3);
1313                 tape_3590_print_io_sim_msg_f1(device, irb);
1314                 return;
1315         }
1316         if (sense->mc == 0xf2) {
1317                 /* Standard Device Service Information Message */
1318                 PRINT_WARN("(%s): DEVSIM SEV=%i, DEVTYPE=3590/%02x, "
1319                            "MC=%02x, ES=%x/%x, REF=0x%04x-0x%04x-0x%04x\n",
1320                            dev_name(&device->cdev->dev), sense->fmt.f71.sev,
1321                            device->cdev->id.dev_model,
1322                            sense->mc, sense->fmt.f71.emc,
1323                            sense->fmt.f71.smc, sense->fmt.f71.refcode1,
1324                            sense->fmt.f71.refcode2, sense->fmt.f71.refcode3);
1325                 tape_3590_print_dev_sim_msg_f2(device, irb);
1326                 return;
1327         }
1328         if (sense->mc == 0xf3) {
1329                 /* Standard Library Service Information Message */
1330                 return;
1331         }
1332         PRINT_WARN("(%s): Device Message(%x)\n",
1333                    dev_name(&device->cdev->dev), sense->mc);
1334 }
1335
1336 static int tape_3590_crypt_error(struct tape_device *device,
1337                                  struct tape_request *request, struct irb *irb)
1338 {
1339         u8 cu_rc, ekm_rc1;
1340         u16 ekm_rc2;
1341         u32 drv_rc;
1342         const char *bus_id;
1343         char *sense;
1344
1345         sense = ((struct tape_3590_sense *) irb->ecw)->fmt.data;
1346         bus_id = dev_name(&device->cdev->dev);
1347         cu_rc = sense[0];
1348         drv_rc = *((u32*) &sense[5]) & 0xffffff;
1349         ekm_rc1 = sense[9];
1350         ekm_rc2 = *((u16*) &sense[10]);
1351         if ((cu_rc == 0) && (ekm_rc2 == 0xee31))
1352                 /* key not defined on EKM */
1353                 return tape_3590_erp_basic(device, request, irb, -EKEYREJECTED);
1354         if ((cu_rc == 1) || (cu_rc == 2))
1355                 /* No connection to EKM */
1356                 return tape_3590_erp_basic(device, request, irb, -ENOTCONN);
1357
1358         PRINT_ERR("(%s): Unable to get encryption key from EKM\n", bus_id);
1359         PRINT_ERR("(%s): CU=%02X DRIVE=%06X EKM=%02X:%04X\n", bus_id, cu_rc,
1360                 drv_rc, ekm_rc1, ekm_rc2);
1361
1362         return tape_3590_erp_basic(device, request, irb, -ENOKEY);
1363 }
1364
1365 /*
1366  *  3590 error Recovery routine:
1367  *  If possible, it tries to recover from the error. If this is not possible,
1368  *  inform the user about the problem.
1369  */
1370 static int
1371 tape_3590_unit_check(struct tape_device *device, struct tape_request *request,
1372                      struct irb *irb)
1373 {
1374         struct tape_3590_sense *sense;
1375         int rc;
1376
1377 #ifdef CONFIG_S390_TAPE_BLOCK
1378         if (request->op == TO_BLOCK) {
1379                 /*
1380                  * Recovery for block device requests. Set the block_position
1381                  * to something invalid and retry.
1382                  */
1383                 device->blk_data.block_position = -1;
1384                 if (request->retries-- <= 0)
1385                         return tape_3590_erp_failed(device, request, irb, -EIO);
1386                 else
1387                         return tape_3590_erp_retry(device, request, irb);
1388         }
1389 #endif
1390
1391         sense = (struct tape_3590_sense *) irb->ecw;
1392
1393         DBF_EVENT(6, "Unit Check: RQC = %x\n", sense->rc_rqc);
1394
1395         /*
1396          * First check all RC-QRCs where we want to do something special
1397          *   - "break":     basic error recovery is done
1398          *   - "goto out:": just print error message if available
1399          */
1400         rc = -EIO;
1401         switch (sense->rc_rqc) {
1402
1403         case 0x1110:
1404                 tape_3590_print_era_msg(device, irb);
1405                 return tape_3590_erp_read_buf_log(device, request, irb);
1406
1407         case 0x2011:
1408                 tape_3590_print_era_msg(device, irb);
1409                 return tape_3590_erp_read_alternate(device, request, irb);
1410
1411         case 0x2230:
1412         case 0x2231:
1413                 tape_3590_print_era_msg(device, irb);
1414                 return tape_3590_erp_special_interrupt(device, request, irb);
1415         case 0x2240:
1416                 return tape_3590_crypt_error(device, request, irb);
1417
1418         case 0x3010:
1419                 DBF_EVENT(2, "(%08x): Backward at Beginning of Partition\n",
1420                           device->cdev_id);
1421                 return tape_3590_erp_basic(device, request, irb, -ENOSPC);
1422         case 0x3012:
1423                 DBF_EVENT(2, "(%08x): Forward at End of Partition\n",
1424                           device->cdev_id);
1425                 return tape_3590_erp_basic(device, request, irb, -ENOSPC);
1426         case 0x3020:
1427                 DBF_EVENT(2, "(%08x): End of Data Mark\n", device->cdev_id);
1428                 return tape_3590_erp_basic(device, request, irb, -ENOSPC);
1429
1430         case 0x3122:
1431                 DBF_EVENT(2, "(%08x): Rewind Unload initiated\n",
1432                           device->cdev_id);
1433                 return tape_3590_erp_basic(device, request, irb, -EIO);
1434         case 0x3123:
1435                 DBF_EVENT(2, "(%08x): Rewind Unload complete\n",
1436                           device->cdev_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, 0);
1440
1441         case 0x4010:
1442                 /*
1443                  * print additional msg since default msg
1444                  * "device intervention" is not very meaningfull
1445                  */
1446                 PRINT_WARN("(%s): Tape operation when medium not loaded\n",
1447                            dev_name(&device->cdev->dev));
1448                 tape_med_state_set(device, MS_UNLOADED);
1449                 tape_3590_schedule_work(device, TO_CRYPT_OFF);
1450                 return tape_3590_erp_basic(device, request, irb, -ENOMEDIUM);
1451         case 0x4012:            /* Device Long Busy */
1452                 /* XXX: Also use long busy handling here? */
1453                 DBF_EVENT(6, "(%08x): LONG BUSY\n", device->cdev_id);
1454                 tape_3590_print_era_msg(device, irb);
1455                 return tape_3590_erp_basic(device, request, irb, -EBUSY);
1456         case 0x4014:
1457                 DBF_EVENT(6, "(%08x): Crypto LONG BUSY\n", device->cdev_id);
1458                 return tape_3590_erp_long_busy(device, request, irb);
1459
1460         case 0x5010:
1461                 if (sense->rac == 0xd0) {
1462                         /* Swap */
1463                         tape_3590_print_era_msg(device, irb);
1464                         return tape_3590_erp_swap(device, request, irb);
1465                 }
1466                 if (sense->rac == 0x26) {
1467                         /* Read Opposite */
1468                         tape_3590_print_era_msg(device, irb);
1469                         return tape_3590_erp_read_opposite(device, request,
1470                                                            irb);
1471                 }
1472                 return tape_3590_erp_basic(device, request, irb, -EIO);
1473         case 0x5020:
1474         case 0x5021:
1475         case 0x5022:
1476         case 0x5040:
1477         case 0x5041:
1478         case 0x5042:
1479                 tape_3590_print_era_msg(device, irb);
1480                 return tape_3590_erp_swap(device, request, irb);
1481
1482         case 0x5110:
1483         case 0x5111:
1484                 return tape_3590_erp_basic(device, request, irb, -EMEDIUMTYPE);
1485
1486         case 0x5120:
1487         case 0x1120:
1488                 tape_med_state_set(device, MS_UNLOADED);
1489                 tape_3590_schedule_work(device, TO_CRYPT_OFF);
1490                 return tape_3590_erp_basic(device, request, irb, -ENOMEDIUM);
1491
1492         case 0x6020:
1493                 PRINT_WARN("(%s): Cartridge of wrong type ?\n",
1494                            dev_name(&device->cdev->dev));
1495                 return tape_3590_erp_basic(device, request, irb, -EMEDIUMTYPE);
1496
1497         case 0x8011:
1498                 PRINT_WARN("(%s): Another host has reserved the tape device\n",
1499                            dev_name(&device->cdev->dev));
1500                 return tape_3590_erp_basic(device, request, irb, -EPERM);
1501         case 0x8013:
1502                 PRINT_WARN("(%s): Another host has privileged access to the "
1503                            "tape device\n", dev_name(&device->cdev->dev));
1504                 PRINT_WARN("(%s): To solve the problem unload the current "
1505                            "cartridge!\n", dev_name(&device->cdev->dev));
1506                 return tape_3590_erp_basic(device, request, irb, -EPERM);
1507         default:
1508                 return tape_3590_erp_basic(device, request, irb, -EIO);
1509         }
1510 }
1511
1512 /*
1513  * 3590 interrupt handler:
1514  */
1515 static int
1516 tape_3590_irq(struct tape_device *device, struct tape_request *request,
1517               struct irb *irb)
1518 {
1519         if (request == NULL)
1520                 return tape_3590_unsolicited_irq(device, irb);
1521
1522         if ((irb->scsw.cmd.dstat & DEV_STAT_UNIT_EXCEP) &&
1523             (irb->scsw.cmd.dstat & DEV_STAT_DEV_END) &&
1524             (request->op == TO_WRI)) {
1525                 /* Write at end of volume */
1526                 DBF_EVENT(2, "End of volume\n");
1527                 return tape_3590_erp_failed(device, request, irb, -ENOSPC);
1528         }
1529
1530         if (irb->scsw.cmd.dstat & DEV_STAT_UNIT_CHECK)
1531                 return tape_3590_unit_check(device, request, irb);
1532
1533         if (irb->scsw.cmd.dstat & DEV_STAT_DEV_END) {
1534                 if (irb->scsw.cmd.dstat == DEV_STAT_UNIT_EXCEP) {
1535                         if (request->op == TO_FSB || request->op == TO_BSB)
1536                                 request->rescnt++;
1537                         else
1538                                 DBF_EVENT(5, "Unit Exception!\n");
1539                 }
1540
1541                 return tape_3590_done(device, request);
1542         }
1543
1544         if (irb->scsw.cmd.dstat & DEV_STAT_CHN_END) {
1545                 DBF_EVENT(2, "cannel end\n");
1546                 return TAPE_IO_PENDING;
1547         }
1548
1549         if (irb->scsw.cmd.dstat & DEV_STAT_ATTENTION) {
1550                 DBF_EVENT(2, "Unit Attention when busy..\n");
1551                 return TAPE_IO_PENDING;
1552         }
1553
1554         DBF_EVENT(6, "xunknownirq\n");
1555         PRINT_ERR("Unexpected interrupt.\n");
1556         PRINT_ERR("Current op is: %s", tape_op_verbose[request->op]);
1557         tape_dump_sense(device, request, irb);
1558         return TAPE_IO_STOP;
1559 }
1560
1561
1562 static int tape_3590_read_dev_chars(struct tape_device *device,
1563                                     struct tape_3590_rdc_data *rdc_data)
1564 {
1565         int rc;
1566         struct tape_request *request;
1567
1568         request = tape_alloc_request(1, sizeof(*rdc_data));
1569         if (IS_ERR(request))
1570                 return PTR_ERR(request);
1571         request->op = TO_RDC;
1572         tape_ccw_end(request->cpaddr, CCW_CMD_RDC, sizeof(*rdc_data),
1573                      request->cpdata);
1574         rc = tape_do_io(device, request);
1575         if (rc == 0)
1576                 memcpy(rdc_data, request->cpdata, sizeof(*rdc_data));
1577         tape_free_request(request);
1578         return rc;
1579 }
1580
1581 /*
1582  * Setup device function
1583  */
1584 static int
1585 tape_3590_setup_device(struct tape_device *device)
1586 {
1587         int rc;
1588         struct tape_3590_disc_data *data;
1589         struct tape_3590_rdc_data *rdc_data;
1590
1591         DBF_EVENT(6, "3590 device setup\n");
1592         data = kzalloc(sizeof(struct tape_3590_disc_data), GFP_KERNEL | GFP_DMA);
1593         if (data == NULL)
1594                 return -ENOMEM;
1595         data->read_back_op = READ_PREVIOUS;
1596         device->discdata = data;
1597
1598         rdc_data = kmalloc(sizeof(*rdc_data), GFP_KERNEL | GFP_DMA);
1599         if (!rdc_data) {
1600                 rc = -ENOMEM;
1601                 goto fail_kmalloc;
1602         }
1603         rc = tape_3590_read_dev_chars(device, rdc_data);
1604         if (rc) {
1605                 DBF_LH(3, "Read device characteristics failed!\n");
1606                 goto fail_rdc_data;
1607         }
1608         rc = tape_std_assign(device);
1609         if (rc)
1610                 goto fail_rdc_data;
1611         if (rdc_data->data[31] == 0x13) {
1612                 PRINT_INFO("Device has crypto support\n");
1613                 data->crypt_info.capability |= TAPE390_CRYPT_SUPPORTED_MASK;
1614                 tape_3592_disable_crypt(device);
1615         } else {
1616                 DBF_EVENT(6, "Device has NO crypto support\n");
1617         }
1618         /* Try to find out if medium is loaded */
1619         rc = tape_3590_sense_medium(device);
1620         if (rc) {
1621                 DBF_LH(3, "3590 medium sense returned %d\n", rc);
1622                 goto fail_rdc_data;
1623         }
1624         return 0;
1625
1626 fail_rdc_data:
1627         kfree(rdc_data);
1628 fail_kmalloc:
1629         kfree(data);
1630         return rc;
1631 }
1632
1633 /*
1634  * Cleanup device function
1635  */
1636 static void
1637 tape_3590_cleanup_device(struct tape_device *device)
1638 {
1639         flush_scheduled_work();
1640         tape_std_unassign(device);
1641
1642         kfree(device->discdata);
1643         device->discdata = NULL;
1644 }
1645
1646 /*
1647  * List of 3590 magnetic tape commands.
1648  */
1649 static tape_mtop_fn tape_3590_mtop[TAPE_NR_MTOPS] = {
1650         [MTRESET]        = tape_std_mtreset,
1651         [MTFSF]          = tape_std_mtfsf,
1652         [MTBSF]          = tape_std_mtbsf,
1653         [MTFSR]          = tape_std_mtfsr,
1654         [MTBSR]          = tape_std_mtbsr,
1655         [MTWEOF]         = tape_std_mtweof,
1656         [MTREW]          = tape_std_mtrew,
1657         [MTOFFL]         = tape_std_mtoffl,
1658         [MTNOP]          = tape_std_mtnop,
1659         [MTRETEN]        = tape_std_mtreten,
1660         [MTBSFM]         = tape_std_mtbsfm,
1661         [MTFSFM]         = tape_std_mtfsfm,
1662         [MTEOM]          = tape_std_mteom,
1663         [MTERASE]        = tape_std_mterase,
1664         [MTRAS1]         = NULL,
1665         [MTRAS2]         = NULL,
1666         [MTRAS3]         = NULL,
1667         [MTSETBLK]       = tape_std_mtsetblk,
1668         [MTSETDENSITY]   = NULL,
1669         [MTSEEK]         = tape_3590_mtseek,
1670         [MTTELL]         = tape_3590_mttell,
1671         [MTSETDRVBUFFER] = NULL,
1672         [MTFSS]          = NULL,
1673         [MTBSS]          = NULL,
1674         [MTWSM]          = NULL,
1675         [MTLOCK]         = NULL,
1676         [MTUNLOCK]       = NULL,
1677         [MTLOAD]         = tape_std_mtload,
1678         [MTUNLOAD]       = tape_std_mtunload,
1679         [MTCOMPRESSION]  = tape_std_mtcompression,
1680         [MTSETPART]      = NULL,
1681         [MTMKPART]       = NULL
1682 };
1683
1684 /*
1685  * Tape discipline structure for 3590.
1686  */
1687 static struct tape_discipline tape_discipline_3590 = {
1688         .owner = THIS_MODULE,
1689         .setup_device = tape_3590_setup_device,
1690         .cleanup_device = tape_3590_cleanup_device,
1691         .process_eov = tape_std_process_eov,
1692         .irq = tape_3590_irq,
1693         .read_block = tape_std_read_block,
1694         .write_block = tape_std_write_block,
1695 #ifdef CONFIG_S390_TAPE_BLOCK
1696         .bread = tape_3590_bread,
1697         .free_bread = tape_3590_free_bread,
1698         .check_locate = tape_3590_check_locate,
1699 #endif
1700         .ioctl_fn = tape_3590_ioctl,
1701         .mtop_array = tape_3590_mtop
1702 };
1703
1704 static struct ccw_device_id tape_3590_ids[] = {
1705         {CCW_DEVICE_DEVTYPE(0x3590, 0, 0x3590, 0), .driver_info = tape_3590},
1706         {CCW_DEVICE_DEVTYPE(0x3592, 0, 0x3592, 0), .driver_info = tape_3592},
1707         { /* end of list */ }
1708 };
1709
1710 static int
1711 tape_3590_online(struct ccw_device *cdev)
1712 {
1713         return tape_generic_online(cdev->dev.driver_data,
1714                                    &tape_discipline_3590);
1715 }
1716
1717 static int
1718 tape_3590_offline(struct ccw_device *cdev)
1719 {
1720         return tape_generic_offline(cdev->dev.driver_data);
1721 }
1722
1723 static struct ccw_driver tape_3590_driver = {
1724         .name = "tape_3590",
1725         .owner = THIS_MODULE,
1726         .ids = tape_3590_ids,
1727         .probe = tape_generic_probe,
1728         .remove = tape_generic_remove,
1729         .set_offline = tape_3590_offline,
1730         .set_online = tape_3590_online,
1731 };
1732
1733 /*
1734  * Setup discipline structure.
1735  */
1736 static int
1737 tape_3590_init(void)
1738 {
1739         int rc;
1740
1741         TAPE_DBF_AREA = debug_register("tape_3590", 2, 2, 4 * sizeof(long));
1742         debug_register_view(TAPE_DBF_AREA, &debug_sprintf_view);
1743 #ifdef DBF_LIKE_HELL
1744         debug_set_level(TAPE_DBF_AREA, 6);
1745 #endif
1746
1747         DBF_EVENT(3, "3590 init\n");
1748         /* Register driver for 3590 tapes. */
1749         rc = ccw_driver_register(&tape_3590_driver);
1750         if (rc)
1751                 DBF_EVENT(3, "3590 init failed\n");
1752         else
1753                 DBF_EVENT(3, "3590 registered\n");
1754         return rc;
1755 }
1756
1757 static void
1758 tape_3590_exit(void)
1759 {
1760         ccw_driver_unregister(&tape_3590_driver);
1761
1762         debug_unregister(TAPE_DBF_AREA);
1763 }
1764
1765 MODULE_DEVICE_TABLE(ccw, tape_3590_ids);
1766 MODULE_AUTHOR("(C) 2001,2006 IBM Corporation");
1767 MODULE_DESCRIPTION("Linux on zSeries channel attached 3590 tape device driver");
1768 MODULE_LICENSE("GPL");
1769
1770 module_init(tape_3590_init);
1771 module_exit(tape_3590_exit);