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