1 // SPDX-License-Identifier: GPL-2.0
3 * Author(s)......: Holger Smolinski <Holger.Smolinski@de.ibm.com>
4 * Based on.......: linux/drivers/s390/block/mdisk.c
5 * ...............: by Hartmunt Penner <hpenner@de.ibm.com>
6 * Bugreports.to..: <Linux390@de.ibm.com>
7 * Copyright IBM Corp. 1999, 2000
11 #include <linux/kernel_stat.h>
12 #include <linux/stddef.h>
13 #include <linux/kernel.h>
14 #include <linux/slab.h>
15 #include <linux/hdreg.h>
16 #include <linux/bio.h>
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/jiffies.h>
20 #include <asm/asm-extable.h>
22 #include <asm/debug.h>
24 #include <asm/ebcdic.h>
30 #include "dasd_diag.h"
32 MODULE_LICENSE("GPL");
34 /* The maximum number of blocks per request (max_blocks) is dependent on the
35 * amount of storage that is available in the static I/O buffer for each
36 * device. Currently each device gets 2 pages. We want to fit two requests
37 * into the available memory so that we can immediately start the next if one
39 #define DIAG_MAX_BLOCKS (((2 * PAGE_SIZE - sizeof(struct dasd_ccw_req) - \
40 sizeof(struct dasd_diag_req)) / \
41 sizeof(struct dasd_diag_bio)) / 2)
42 #define DIAG_MAX_RETRIES 32
43 #define DIAG_TIMEOUT 50
45 static struct dasd_discipline dasd_diag_discipline;
47 struct dasd_diag_private {
48 struct dasd_diag_characteristics rdc_data;
49 struct dasd_diag_rw_io iob;
50 struct dasd_diag_init_io iib;
52 struct ccw_dev_id dev_id;
55 struct dasd_diag_req {
56 unsigned int block_count;
57 struct dasd_diag_bio bio[];
60 static const u8 DASD_DIAG_CMS1[] = { 0xc3, 0xd4, 0xe2, 0xf1 };/* EBCDIC CMS1 */
62 /* Perform DIAG250 call with block I/O parameter list iob (input and output)
63 * and function code cmd.
64 * In case of an exception return 3. Otherwise return result of bitwise OR of
65 * resulting condition code and DIAG return code. */
66 static inline int __dia250(void *iob, int cmd)
68 union register_pair rx = { .even = (unsigned long)iob, };
70 struct dasd_diag_init_io init_io;
71 struct dasd_diag_rw_io rw_io;
77 " diag %[rx],%[cmd],0x250\n"
82 : [cc] "+&d" (cc), [rx] "+&d" (rx.pair), "+m" (*(addr_type *)iob)
88 static inline int dia250(void *iob, int cmd)
90 diag_stat_inc(DIAG_STAT_X250);
91 return __dia250(iob, cmd);
94 /* Initialize block I/O to DIAG device using the specified blocksize and
95 * block offset. On success, return zero and set end_block to contain the
96 * number of blocks on the device minus the specified offset. Return non-zero
99 mdsk_init_io(struct dasd_device *device, unsigned int blocksize,
100 blocknum_t offset, blocknum_t *end_block)
102 struct dasd_diag_private *private = device->private;
103 struct dasd_diag_init_io *iib = &private->iib;
106 memset(iib, 0, sizeof (struct dasd_diag_init_io));
108 iib->dev_nr = private->dev_id.devno;
109 iib->block_size = blocksize;
110 iib->offset = offset;
111 iib->flaga = DASD_DIAG_FLAGA_DEFAULT;
113 rc = dia250(iib, INIT_BIO);
115 if ((rc & 3) == 0 && end_block)
116 *end_block = iib->end_block;
121 /* Remove block I/O environment for device. Return zero on success, non-zero
124 mdsk_term_io(struct dasd_device * device)
126 struct dasd_diag_private *private = device->private;
127 struct dasd_diag_init_io *iib = &private->iib;
130 memset(iib, 0, sizeof (struct dasd_diag_init_io));
131 iib->dev_nr = private->dev_id.devno;
132 rc = dia250(iib, TERM_BIO);
136 /* Error recovery for failed DIAG requests - try to reestablish the DIAG
139 dasd_diag_erp(struct dasd_device *device)
143 mdsk_term_io(device);
144 rc = mdsk_init_io(device, device->block->bp_block, 0, NULL);
146 if (!(test_and_set_bit(DASD_FLAG_DEVICE_RO, &device->flags)))
147 pr_warn("%s: The access mode of a DIAG device changed to read-only\n",
148 dev_name(&device->cdev->dev));
152 pr_warn("%s: DIAG ERP failed with rc=%d\n",
153 dev_name(&device->cdev->dev), rc);
156 /* Start a given request at the device. Return zero on success, non-zero
159 dasd_start_diag(struct dasd_ccw_req * cqr)
161 struct dasd_device *device;
162 struct dasd_diag_private *private;
163 struct dasd_diag_req *dreq;
166 device = cqr->startdev;
167 if (cqr->retries < 0) {
168 DBF_DEV_EVENT(DBF_ERR, device, "DIAG start_IO: request %p "
169 "- no retry left)", cqr);
170 cqr->status = DASD_CQR_ERROR;
173 private = device->private;
176 private->iob.dev_nr = private->dev_id.devno;
177 private->iob.key = 0;
178 private->iob.flags = DASD_DIAG_RWFLAG_ASYNC;
179 private->iob.block_count = dreq->block_count;
180 private->iob.interrupt_params = (addr_t) cqr;
181 private->iob.bio_list = dreq->bio;
182 private->iob.flaga = DASD_DIAG_FLAGA_DEFAULT;
184 cqr->startclk = get_tod_clock();
185 cqr->starttime = jiffies;
188 rc = dia250(&private->iob, RW_BIO);
190 case 0: /* Synchronous I/O finished successfully */
191 cqr->stopclk = get_tod_clock();
192 cqr->status = DASD_CQR_SUCCESS;
193 /* Indicate to calling function that only a dasd_schedule_bh()
194 and no timer is needed */
197 case 8: /* Asynchronous I/O was started */
198 cqr->status = DASD_CQR_IN_IO;
201 default: /* Error condition */
202 cqr->status = DASD_CQR_QUEUED;
203 DBF_DEV_EVENT(DBF_WARNING, device, "dia250 returned rc=%d", rc);
204 dasd_diag_erp(device);
212 /* Terminate given request at the device. */
214 dasd_diag_term_IO(struct dasd_ccw_req * cqr)
216 struct dasd_device *device;
218 device = cqr->startdev;
219 mdsk_term_io(device);
220 mdsk_init_io(device, device->block->bp_block, 0, NULL);
221 cqr->status = DASD_CQR_CLEAR_PENDING;
222 cqr->stopclk = get_tod_clock();
223 dasd_schedule_device_bh(device);
227 /* Handle external interruption. */
228 static void dasd_ext_handler(struct ext_code ext_code,
229 unsigned int param32, unsigned long param64)
231 struct dasd_ccw_req *cqr, *next;
232 struct dasd_device *device;
233 unsigned long expires;
238 switch (ext_code.subcode >> 8) {
239 case DASD_DIAG_CODE_31BIT:
240 ip = (addr_t) param32;
242 case DASD_DIAG_CODE_64BIT:
243 ip = (addr_t) param64;
248 inc_irq_stat(IRQEXT_DSD);
249 if (!ip) { /* no intparm: unsolicited interrupt */
250 DBF_EVENT(DBF_NOTICE, "%s", "caught unsolicited "
254 cqr = (struct dasd_ccw_req *) ip;
255 device = (struct dasd_device *) cqr->startdev;
256 if (strncmp(device->discipline->ebcname, (char *) &cqr->magic, 4)) {
257 DBF_DEV_EVENT(DBF_WARNING, device,
258 " magic number of dasd_ccw_req 0x%08X doesn't"
259 " match discipline 0x%08X",
260 cqr->magic, *(int *) (&device->discipline->name));
264 /* get irq lock to modify request queue */
265 spin_lock_irqsave(get_ccwdev_lock(device->cdev), flags);
267 /* Check for a pending clear operation */
268 if (cqr->status == DASD_CQR_CLEAR_PENDING) {
269 cqr->status = DASD_CQR_CLEARED;
270 dasd_device_clear_timer(device);
271 dasd_schedule_device_bh(device);
272 spin_unlock_irqrestore(get_ccwdev_lock(device->cdev), flags);
276 cqr->stopclk = get_tod_clock();
279 if ((ext_code.subcode & 0xff) == 0) {
280 cqr->status = DASD_CQR_SUCCESS;
281 /* Start first request on queue if possible -> fast_io. */
282 if (!list_empty(&device->ccw_queue)) {
283 next = list_entry(device->ccw_queue.next,
284 struct dasd_ccw_req, devlist);
285 if (next->status == DASD_CQR_QUEUED) {
286 rc = dasd_start_diag(next);
288 expires = next->expires;
292 cqr->status = DASD_CQR_QUEUED;
293 DBF_DEV_EVENT(DBF_DEBUG, device, "interrupt status for "
294 "request %p was %d (%d retries left)", cqr,
295 ext_code.subcode & 0xff, cqr->retries);
296 dasd_diag_erp(device);
300 dasd_device_set_timer(device, expires);
302 dasd_device_clear_timer(device);
303 dasd_schedule_device_bh(device);
305 spin_unlock_irqrestore(get_ccwdev_lock(device->cdev), flags);
308 /* Check whether device can be controlled by DIAG discipline. Return zero on
309 * success, non-zero otherwise. */
311 dasd_diag_check_device(struct dasd_device *device)
313 struct dasd_diag_private *private = device->private;
314 struct dasd_diag_characteristics *rdc_data;
315 struct vtoc_cms_label *label;
316 struct dasd_block *block;
317 struct dasd_diag_bio *bio;
318 unsigned int sb, bsize;
319 blocknum_t end_block;
322 if (private == NULL) {
323 private = kzalloc(sizeof(*private), GFP_KERNEL);
324 if (private == NULL) {
325 DBF_DEV_EVENT(DBF_WARNING, device, "%s",
326 "Allocating memory for private DASD data "
330 ccw_device_get_id(device->cdev, &private->dev_id);
331 device->private = private;
333 block = dasd_alloc_block();
335 DBF_DEV_EVENT(DBF_WARNING, device, "%s",
336 "could not allocate dasd block structure");
337 device->private = NULL;
339 return PTR_ERR(block);
341 device->block = block;
342 block->base = device;
344 /* Read Device Characteristics */
345 rdc_data = &private->rdc_data;
346 rdc_data->dev_nr = private->dev_id.devno;
347 rdc_data->rdc_len = sizeof (struct dasd_diag_characteristics);
349 rc = diag210((struct diag210 *) rdc_data);
351 DBF_DEV_EVENT(DBF_WARNING, device, "failed to retrieve device "
352 "information (rc=%d)", rc);
357 device->default_expires = DIAG_TIMEOUT;
358 device->default_retries = DIAG_MAX_RETRIES;
360 /* Figure out position of label block */
361 switch (private->rdc_data.vdev_class) {
363 private->pt_block = 1;
366 private->pt_block = 2;
369 pr_warn("%s: Device type %d is not supported in DIAG mode\n",
370 dev_name(&device->cdev->dev),
371 private->rdc_data.vdev_class);
376 DBF_DEV_EVENT(DBF_INFO, device,
377 "%04X: %04X on real %04X/%02X",
380 rdc_data->rdev_type, rdc_data->rdev_model);
382 /* terminate all outstanding operations */
383 mdsk_term_io(device);
385 /* figure out blocksize of device */
386 label = (struct vtoc_cms_label *) get_zeroed_page(GFP_KERNEL);
388 DBF_DEV_EVENT(DBF_WARNING, device, "%s",
389 "No memory to allocate initialization request");
393 bio = kzalloc(sizeof(*bio), GFP_KERNEL);
395 DBF_DEV_EVENT(DBF_WARNING, device, "%s",
396 "No memory to allocate initialization bio");
402 /* try all sizes - needed for ECKD devices */
403 for (bsize = 512; bsize <= PAGE_SIZE; bsize <<= 1) {
404 mdsk_init_io(device, bsize, 0, &end_block);
405 memset(bio, 0, sizeof(*bio));
406 bio->type = MDSK_READ_REQ;
407 bio->block_number = private->pt_block + 1;
409 memset(&private->iob, 0, sizeof (struct dasd_diag_rw_io));
410 private->iob.dev_nr = rdc_data->dev_nr;
411 private->iob.key = 0;
412 private->iob.flags = 0; /* do synchronous io */
413 private->iob.block_count = 1;
414 private->iob.interrupt_params = 0;
415 private->iob.bio_list = bio;
416 private->iob.flaga = DASD_DIAG_FLAGA_DEFAULT;
417 rc = dia250(&private->iob, RW_BIO);
419 pr_warn("%s: A 64-bit DIAG call failed\n",
420 dev_name(&device->cdev->dev));
424 mdsk_term_io(device);
428 if (bsize > PAGE_SIZE) {
429 pr_warn("%s: Accessing the DASD failed because of an incorrect format (rc=%d)\n",
430 dev_name(&device->cdev->dev), rc);
434 /* check for label block */
435 if (memcmp(label->label_id, DASD_DIAG_CMS1,
436 sizeof(DASD_DIAG_CMS1)) == 0) {
437 /* get formatted blocksize from label block */
438 bsize = (unsigned int) label->block_size;
439 block->blocks = (unsigned long) label->block_count;
441 block->blocks = end_block;
442 block->bp_block = bsize;
443 block->s2b_shift = 0; /* bits to shift 512 to get a block */
444 for (sb = 512; sb < bsize; sb = sb << 1)
446 rc = mdsk_init_io(device, block->bp_block, 0, NULL);
447 if (rc && (rc != 4)) {
448 pr_warn("%s: DIAG initialization failed with rc=%d\n",
449 dev_name(&device->cdev->dev), rc);
453 set_bit(DASD_FLAG_DEVICE_RO, &device->flags);
454 pr_info("%s: New DASD with %ld byte/block, total size %ld "
455 "KB%s\n", dev_name(&device->cdev->dev),
456 (unsigned long) block->bp_block,
457 (unsigned long) (block->blocks <<
458 block->s2b_shift) >> 1,
459 (rc == 4) ? ", read-only device" : "");
465 free_page((long) label);
468 device->block = NULL;
469 dasd_free_block(block);
470 device->private = NULL;
476 /* Fill in virtual disk geometry for device. Return zero on success, non-zero
479 dasd_diag_fill_geometry(struct dasd_block *block, struct hd_geometry *geo)
481 if (dasd_check_blocksize(block->bp_block) != 0)
483 geo->cylinders = (block->blocks << block->s2b_shift) >> 10;
485 geo->sectors = 128 >> block->s2b_shift;
490 dasd_diag_erp_action(struct dasd_ccw_req * cqr)
492 return dasd_default_erp_action;
496 dasd_diag_erp_postaction(struct dasd_ccw_req * cqr)
498 return dasd_default_erp_postaction;
501 /* Create DASD request from block device request. Return pointer to new
502 * request on success, ERR_PTR otherwise. */
503 static struct dasd_ccw_req *dasd_diag_build_cp(struct dasd_device *memdev,
504 struct dasd_block *block,
507 struct dasd_ccw_req *cqr;
508 struct dasd_diag_req *dreq;
509 struct dasd_diag_bio *dbio;
510 struct req_iterator iter;
514 sector_t recid, first_rec, last_rec;
515 unsigned int blksize, off;
516 unsigned char rw_cmd;
518 if (rq_data_dir(req) == READ)
519 rw_cmd = MDSK_READ_REQ;
520 else if (rq_data_dir(req) == WRITE)
521 rw_cmd = MDSK_WRITE_REQ;
523 return ERR_PTR(-EINVAL);
524 blksize = block->bp_block;
525 /* Calculate record id of first and last block. */
526 first_rec = blk_rq_pos(req) >> block->s2b_shift;
528 (blk_rq_pos(req) + blk_rq_sectors(req) - 1) >> block->s2b_shift;
529 /* Check struct bio and count the number of blocks for the request. */
531 rq_for_each_segment(bv, req, iter) {
532 if (bv.bv_len & (blksize - 1))
533 /* Fba can only do full blocks. */
534 return ERR_PTR(-EINVAL);
535 count += bv.bv_len >> (block->s2b_shift + 9);
538 if (count != last_rec - first_rec + 1)
539 return ERR_PTR(-EINVAL);
540 /* Build the request */
541 cqr = dasd_smalloc_request(DASD_DIAG_MAGIC, 0, struct_size(dreq, bio, count),
542 memdev, blk_mq_rq_to_pdu(req));
546 dreq = (struct dasd_diag_req *) cqr->data;
547 dreq->block_count = count;
550 rq_for_each_segment(bv, req, iter) {
551 dst = bvec_virt(&bv);
552 for (off = 0; off < bv.bv_len; off += blksize) {
553 memset(dbio, 0, sizeof (struct dasd_diag_bio));
555 dbio->block_number = recid + 1;
562 cqr->retries = memdev->default_retries;
563 cqr->buildclk = get_tod_clock();
564 if (blk_noretry_request(req) ||
565 block->base->features & DASD_FEATURE_FAILFAST)
566 set_bit(DASD_CQR_FLAGS_FAILFAST, &cqr->flags);
567 cqr->startdev = memdev;
568 cqr->memdev = memdev;
570 cqr->expires = memdev->default_expires * HZ;
571 cqr->status = DASD_CQR_FILLED;
575 /* Release DASD request. Return non-zero if request was successful, zero
578 dasd_diag_free_cp(struct dasd_ccw_req *cqr, struct request *req)
582 status = cqr->status == DASD_CQR_DONE;
583 dasd_sfree_request(cqr, cqr->memdev);
587 static void dasd_diag_handle_terminated_request(struct dasd_ccw_req *cqr)
589 if (cqr->retries < 0)
590 cqr->status = DASD_CQR_FAILED;
592 cqr->status = DASD_CQR_FILLED;
595 /* Fill in IOCTL data for device. */
597 dasd_diag_fill_info(struct dasd_device * device,
598 struct dasd_information2_t * info)
600 struct dasd_diag_private *private = device->private;
602 info->label_block = (unsigned int) private->pt_block;
603 info->FBA_layout = 1;
604 info->format = DASD_FORMAT_LDL;
605 info->characteristics_size = sizeof(private->rdc_data);
606 memcpy(info->characteristics, &private->rdc_data,
607 sizeof(private->rdc_data));
608 info->confdata_size = 0;
613 dasd_diag_dump_sense(struct dasd_device *device, struct dasd_ccw_req * req,
616 DBF_DEV_EVENT(DBF_WARNING, device, "%s",
617 "dump sense not available for DIAG data");
620 static unsigned int dasd_diag_max_sectors(struct dasd_block *block)
622 return DIAG_MAX_BLOCKS << block->s2b_shift;
625 static int dasd_diag_pe_handler(struct dasd_device *device,
626 __u8 tbvpm, __u8 fcsecpm)
628 return dasd_generic_verify_path(device, tbvpm);
631 static struct dasd_discipline dasd_diag_discipline = {
632 .owner = THIS_MODULE,
635 .max_sectors = dasd_diag_max_sectors,
636 .check_device = dasd_diag_check_device,
637 .pe_handler = dasd_diag_pe_handler,
638 .fill_geometry = dasd_diag_fill_geometry,
639 .start_IO = dasd_start_diag,
640 .term_IO = dasd_diag_term_IO,
641 .handle_terminated_request = dasd_diag_handle_terminated_request,
642 .erp_action = dasd_diag_erp_action,
643 .erp_postaction = dasd_diag_erp_postaction,
644 .build_cp = dasd_diag_build_cp,
645 .free_cp = dasd_diag_free_cp,
646 .dump_sense = dasd_diag_dump_sense,
647 .fill_info = dasd_diag_fill_info,
653 if (!MACHINE_IS_VM) {
654 pr_info("Discipline %s cannot be used without z/VM\n",
655 dasd_diag_discipline.name);
658 ASCEBC(dasd_diag_discipline.ebcname, 4);
660 irq_subclass_register(IRQ_SUBCLASS_SERVICE_SIGNAL);
661 register_external_irq(EXT_IRQ_CP_SERVICE, dasd_ext_handler);
662 dasd_diag_discipline_pointer = &dasd_diag_discipline;
667 dasd_diag_cleanup(void)
669 unregister_external_irq(EXT_IRQ_CP_SERVICE, dasd_ext_handler);
670 irq_subclass_unregister(IRQ_SUBCLASS_SERVICE_SIGNAL);
671 dasd_diag_discipline_pointer = NULL;
674 module_init(dasd_diag_init);
675 module_exit(dasd_diag_cleanup);