2 * Author(s)......: Holger Smolinski <Holger.Smolinski@de.ibm.com>
3 * Based on.......: linux/drivers/s390/block/mdisk.c
4 * ...............: by Hartmunt Penner <hpenner@de.ibm.com>
5 * Bugreports.to..: <Linux390@de.ibm.com>
6 * Copyright IBM Corp. 1999, 2000
10 #define KMSG_COMPONENT "dasd"
12 #include <linux/kernel_stat.h>
13 #include <linux/stddef.h>
14 #include <linux/kernel.h>
15 #include <linux/slab.h>
16 #include <linux/hdreg.h>
17 #include <linux/bio.h>
18 #include <linux/module.h>
19 #include <linux/init.h>
20 #include <linux/jiffies.h>
23 #include <asm/debug.h>
25 #include <asm/ebcdic.h>
32 #include "dasd_diag.h"
34 #define PRINTK_HEADER "dasd(diag):"
36 MODULE_LICENSE("GPL");
38 /* The maximum number of blocks per request (max_blocks) is dependent on the
39 * amount of storage that is available in the static I/O buffer for each
40 * device. Currently each device gets 2 pages. We want to fit two requests
41 * into the available memory so that we can immediately start the next if one
43 #define DIAG_MAX_BLOCKS (((2 * PAGE_SIZE - sizeof(struct dasd_ccw_req) - \
44 sizeof(struct dasd_diag_req)) / \
45 sizeof(struct dasd_diag_bio)) / 2)
46 #define DIAG_MAX_RETRIES 32
47 #define DIAG_TIMEOUT 50
49 static struct dasd_discipline dasd_diag_discipline;
51 struct dasd_diag_private {
52 struct dasd_diag_characteristics rdc_data;
53 struct dasd_diag_rw_io iob;
54 struct dasd_diag_init_io iib;
56 struct ccw_dev_id dev_id;
59 struct dasd_diag_req {
60 unsigned int block_count;
61 struct dasd_diag_bio bio[0];
64 static const u8 DASD_DIAG_CMS1[] = { 0xc3, 0xd4, 0xe2, 0xf1 };/* EBCDIC CMS1 */
66 /* Perform DIAG250 call with block I/O parameter list iob (input and output)
67 * and function code cmd.
68 * In case of an exception return 3. Otherwise return result of bitwise OR of
69 * resulting condition code and DIAG return code. */
70 static inline int __dia250(void *iob, int cmd)
72 register unsigned long reg2 asm ("2") = (unsigned long) iob;
74 struct dasd_diag_init_io init_io;
75 struct dasd_diag_rw_io rw_io;
87 : "+d" (rc), "=m" (*(addr_type *) iob)
88 : "d" (cmd), "d" (reg2), "m" (*(addr_type *) iob)
93 static inline int dia250(void *iob, int cmd)
95 diag_stat_inc(DIAG_STAT_X250);
96 return __dia250(iob, cmd);
99 /* Initialize block I/O to DIAG device using the specified blocksize and
100 * block offset. On success, return zero and set end_block to contain the
101 * number of blocks on the device minus the specified offset. Return non-zero
104 mdsk_init_io(struct dasd_device *device, unsigned int blocksize,
105 blocknum_t offset, blocknum_t *end_block)
107 struct dasd_diag_private *private;
108 struct dasd_diag_init_io *iib;
111 private = (struct dasd_diag_private *) device->private;
113 memset(iib, 0, sizeof (struct dasd_diag_init_io));
115 iib->dev_nr = private->dev_id.devno;
116 iib->block_size = blocksize;
117 iib->offset = offset;
118 iib->flaga = DASD_DIAG_FLAGA_DEFAULT;
120 rc = dia250(iib, INIT_BIO);
122 if ((rc & 3) == 0 && end_block)
123 *end_block = iib->end_block;
128 /* Remove block I/O environment for device. Return zero on success, non-zero
131 mdsk_term_io(struct dasd_device * device)
133 struct dasd_diag_private *private;
134 struct dasd_diag_init_io *iib;
137 private = (struct dasd_diag_private *) device->private;
139 memset(iib, 0, sizeof (struct dasd_diag_init_io));
140 iib->dev_nr = private->dev_id.devno;
141 rc = dia250(iib, TERM_BIO);
145 /* Error recovery for failed DIAG requests - try to reestablish the DIAG
148 dasd_diag_erp(struct dasd_device *device)
152 mdsk_term_io(device);
153 rc = mdsk_init_io(device, device->block->bp_block, 0, NULL);
155 if (!(test_and_set_bit(DASD_FLAG_DEVICE_RO, &device->flags)))
156 pr_warning("%s: The access mode of a DIAG device "
157 "changed to read-only\n",
158 dev_name(&device->cdev->dev));
162 pr_warning("%s: DIAG ERP failed with "
163 "rc=%d\n", dev_name(&device->cdev->dev), rc);
166 /* Start a given request at the device. Return zero on success, non-zero
169 dasd_start_diag(struct dasd_ccw_req * cqr)
171 struct dasd_device *device;
172 struct dasd_diag_private *private;
173 struct dasd_diag_req *dreq;
176 device = cqr->startdev;
177 if (cqr->retries < 0) {
178 DBF_DEV_EVENT(DBF_ERR, device, "DIAG start_IO: request %p "
179 "- no retry left)", cqr);
180 cqr->status = DASD_CQR_ERROR;
183 private = (struct dasd_diag_private *) device->private;
184 dreq = (struct dasd_diag_req *) cqr->data;
186 private->iob.dev_nr = private->dev_id.devno;
187 private->iob.key = 0;
188 private->iob.flags = DASD_DIAG_RWFLAG_ASYNC;
189 private->iob.block_count = dreq->block_count;
190 private->iob.interrupt_params = (addr_t) cqr;
191 private->iob.bio_list = dreq->bio;
192 private->iob.flaga = DASD_DIAG_FLAGA_DEFAULT;
194 cqr->startclk = get_tod_clock();
195 cqr->starttime = jiffies;
198 rc = dia250(&private->iob, RW_BIO);
200 case 0: /* Synchronous I/O finished successfully */
201 cqr->stopclk = get_tod_clock();
202 cqr->status = DASD_CQR_SUCCESS;
203 /* Indicate to calling function that only a dasd_schedule_bh()
204 and no timer is needed */
207 case 8: /* Asynchronous I/O was started */
208 cqr->status = DASD_CQR_IN_IO;
211 default: /* Error condition */
212 cqr->status = DASD_CQR_QUEUED;
213 DBF_DEV_EVENT(DBF_WARNING, device, "dia250 returned rc=%d", rc);
214 dasd_diag_erp(device);
222 /* Terminate given request at the device. */
224 dasd_diag_term_IO(struct dasd_ccw_req * cqr)
226 struct dasd_device *device;
228 device = cqr->startdev;
229 mdsk_term_io(device);
230 mdsk_init_io(device, device->block->bp_block, 0, NULL);
231 cqr->status = DASD_CQR_CLEAR_PENDING;
232 cqr->stopclk = get_tod_clock();
233 dasd_schedule_device_bh(device);
237 /* Handle external interruption. */
238 static void dasd_ext_handler(struct ext_code ext_code,
239 unsigned int param32, unsigned long param64)
241 struct dasd_ccw_req *cqr, *next;
242 struct dasd_device *device;
243 unsigned long long expires;
248 switch (ext_code.subcode >> 8) {
249 case DASD_DIAG_CODE_31BIT:
250 ip = (addr_t) param32;
252 case DASD_DIAG_CODE_64BIT:
253 ip = (addr_t) param64;
258 inc_irq_stat(IRQEXT_DSD);
259 if (!ip) { /* no intparm: unsolicited interrupt */
260 DBF_EVENT(DBF_NOTICE, "%s", "caught unsolicited "
264 cqr = (struct dasd_ccw_req *) ip;
265 device = (struct dasd_device *) cqr->startdev;
266 if (strncmp(device->discipline->ebcname, (char *) &cqr->magic, 4)) {
267 DBF_DEV_EVENT(DBF_WARNING, device,
268 " magic number of dasd_ccw_req 0x%08X doesn't"
269 " match discipline 0x%08X",
270 cqr->magic, *(int *) (&device->discipline->name));
274 /* get irq lock to modify request queue */
275 spin_lock_irqsave(get_ccwdev_lock(device->cdev), flags);
277 /* Check for a pending clear operation */
278 if (cqr->status == DASD_CQR_CLEAR_PENDING) {
279 cqr->status = DASD_CQR_CLEARED;
280 dasd_device_clear_timer(device);
281 dasd_schedule_device_bh(device);
282 spin_unlock_irqrestore(get_ccwdev_lock(device->cdev), flags);
286 cqr->stopclk = get_tod_clock();
289 if ((ext_code.subcode & 0xff) == 0) {
290 cqr->status = DASD_CQR_SUCCESS;
291 /* Start first request on queue if possible -> fast_io. */
292 if (!list_empty(&device->ccw_queue)) {
293 next = list_entry(device->ccw_queue.next,
294 struct dasd_ccw_req, devlist);
295 if (next->status == DASD_CQR_QUEUED) {
296 rc = dasd_start_diag(next);
298 expires = next->expires;
302 cqr->status = DASD_CQR_QUEUED;
303 DBF_DEV_EVENT(DBF_DEBUG, device, "interrupt status for "
304 "request %p was %d (%d retries left)", cqr,
305 ext_code.subcode & 0xff, cqr->retries);
306 dasd_diag_erp(device);
310 dasd_device_set_timer(device, expires);
312 dasd_device_clear_timer(device);
313 dasd_schedule_device_bh(device);
315 spin_unlock_irqrestore(get_ccwdev_lock(device->cdev), flags);
318 /* Check whether device can be controlled by DIAG discipline. Return zero on
319 * success, non-zero otherwise. */
321 dasd_diag_check_device(struct dasd_device *device)
323 struct dasd_block *block;
324 struct dasd_diag_private *private;
325 struct dasd_diag_characteristics *rdc_data;
326 struct dasd_diag_bio bio;
327 struct vtoc_cms_label *label;
328 blocknum_t end_block;
329 unsigned int sb, bsize;
332 private = (struct dasd_diag_private *) device->private;
333 if (private == NULL) {
334 private = kzalloc(sizeof(struct dasd_diag_private),GFP_KERNEL);
335 if (private == NULL) {
336 DBF_DEV_EVENT(DBF_WARNING, device, "%s",
337 "Allocating memory for private DASD data "
341 ccw_device_get_id(device->cdev, &private->dev_id);
342 device->private = (void *) private;
344 block = dasd_alloc_block();
346 DBF_DEV_EVENT(DBF_WARNING, device, "%s",
347 "could not allocate dasd block structure");
348 device->private = NULL;
350 return PTR_ERR(block);
352 device->block = block;
353 block->base = device;
355 /* Read Device Characteristics */
356 rdc_data = (void *) &(private->rdc_data);
357 rdc_data->dev_nr = private->dev_id.devno;
358 rdc_data->rdc_len = sizeof (struct dasd_diag_characteristics);
360 rc = diag210((struct diag210 *) rdc_data);
362 DBF_DEV_EVENT(DBF_WARNING, device, "failed to retrieve device "
363 "information (rc=%d)", rc);
368 device->default_expires = DIAG_TIMEOUT;
369 device->default_retries = DIAG_MAX_RETRIES;
371 /* Figure out position of label block */
372 switch (private->rdc_data.vdev_class) {
374 private->pt_block = 1;
377 private->pt_block = 2;
380 pr_warning("%s: Device type %d is not supported "
381 "in DIAG mode\n", dev_name(&device->cdev->dev),
382 private->rdc_data.vdev_class);
387 DBF_DEV_EVENT(DBF_INFO, device,
388 "%04X: %04X on real %04X/%02X",
391 rdc_data->rdev_type, rdc_data->rdev_model);
393 /* terminate all outstanding operations */
394 mdsk_term_io(device);
396 /* figure out blocksize of device */
397 label = (struct vtoc_cms_label *) get_zeroed_page(GFP_KERNEL);
399 DBF_DEV_EVENT(DBF_WARNING, device, "%s",
400 "No memory to allocate initialization request");
406 /* try all sizes - needed for ECKD devices */
407 for (bsize = 512; bsize <= PAGE_SIZE; bsize <<= 1) {
408 mdsk_init_io(device, bsize, 0, &end_block);
409 memset(&bio, 0, sizeof (struct dasd_diag_bio));
410 bio.type = MDSK_READ_REQ;
411 bio.block_number = private->pt_block + 1;
413 memset(&private->iob, 0, sizeof (struct dasd_diag_rw_io));
414 private->iob.dev_nr = rdc_data->dev_nr;
415 private->iob.key = 0;
416 private->iob.flags = 0; /* do synchronous io */
417 private->iob.block_count = 1;
418 private->iob.interrupt_params = 0;
419 private->iob.bio_list = &bio;
420 private->iob.flaga = DASD_DIAG_FLAGA_DEFAULT;
421 rc = dia250(&private->iob, RW_BIO);
423 pr_warning("%s: A 64-bit DIAG call failed\n",
424 dev_name(&device->cdev->dev));
428 mdsk_term_io(device);
432 if (bsize > PAGE_SIZE) {
433 pr_warning("%s: Accessing the DASD failed because of an "
434 "incorrect format (rc=%d)\n",
435 dev_name(&device->cdev->dev), rc);
439 /* check for label block */
440 if (memcmp(label->label_id, DASD_DIAG_CMS1,
441 sizeof(DASD_DIAG_CMS1)) == 0) {
442 /* get formatted blocksize from label block */
443 bsize = (unsigned int) label->block_size;
444 block->blocks = (unsigned long) label->block_count;
446 block->blocks = end_block;
447 block->bp_block = bsize;
448 block->s2b_shift = 0; /* bits to shift 512 to get a block */
449 for (sb = 512; sb < bsize; sb = sb << 1)
451 rc = mdsk_init_io(device, block->bp_block, 0, NULL);
452 if (rc && (rc != 4)) {
453 pr_warning("%s: DIAG initialization failed with rc=%d\n",
454 dev_name(&device->cdev->dev), rc);
458 set_bit(DASD_FLAG_DEVICE_RO, &device->flags);
459 pr_info("%s: New DASD with %ld byte/block, total size %ld "
460 "KB%s\n", dev_name(&device->cdev->dev),
461 (unsigned long) block->bp_block,
462 (unsigned long) (block->blocks <<
463 block->s2b_shift) >> 1,
464 (rc == 4) ? ", read-only device" : "");
468 free_page((long) label);
471 device->block = NULL;
472 dasd_free_block(block);
473 device->private = NULL;
479 /* Fill in virtual disk geometry for device. Return zero on success, non-zero
482 dasd_diag_fill_geometry(struct dasd_block *block, struct hd_geometry *geo)
484 if (dasd_check_blocksize(block->bp_block) != 0)
486 geo->cylinders = (block->blocks << block->s2b_shift) >> 10;
488 geo->sectors = 128 >> block->s2b_shift;
493 dasd_diag_erp_action(struct dasd_ccw_req * cqr)
495 return dasd_default_erp_action;
499 dasd_diag_erp_postaction(struct dasd_ccw_req * cqr)
501 return dasd_default_erp_postaction;
504 /* Create DASD request from block device request. Return pointer to new
505 * request on success, ERR_PTR otherwise. */
506 static struct dasd_ccw_req *dasd_diag_build_cp(struct dasd_device *memdev,
507 struct dasd_block *block,
510 struct dasd_ccw_req *cqr;
511 struct dasd_diag_req *dreq;
512 struct dasd_diag_bio *dbio;
513 struct req_iterator iter;
516 unsigned int count, datasize;
517 sector_t recid, first_rec, last_rec;
518 unsigned int blksize, off;
519 unsigned char rw_cmd;
521 if (rq_data_dir(req) == READ)
522 rw_cmd = MDSK_READ_REQ;
523 else if (rq_data_dir(req) == WRITE)
524 rw_cmd = MDSK_WRITE_REQ;
526 return ERR_PTR(-EINVAL);
527 blksize = block->bp_block;
528 /* Calculate record id of first and last block. */
529 first_rec = blk_rq_pos(req) >> block->s2b_shift;
531 (blk_rq_pos(req) + blk_rq_sectors(req) - 1) >> block->s2b_shift;
532 /* Check struct bio and count the number of blocks for the request. */
534 rq_for_each_segment(bv, req, iter) {
535 if (bv.bv_len & (blksize - 1))
536 /* Fba can only do full blocks. */
537 return ERR_PTR(-EINVAL);
538 count += bv.bv_len >> (block->s2b_shift + 9);
541 if (count != last_rec - first_rec + 1)
542 return ERR_PTR(-EINVAL);
543 /* Build the request */
544 datasize = sizeof(struct dasd_diag_req) +
545 count*sizeof(struct dasd_diag_bio);
546 cqr = dasd_smalloc_request(DASD_DIAG_MAGIC, 0, datasize, memdev);
550 dreq = (struct dasd_diag_req *) cqr->data;
551 dreq->block_count = count;
554 rq_for_each_segment(bv, req, iter) {
555 dst = page_address(bv.bv_page) + bv.bv_offset;
556 for (off = 0; off < bv.bv_len; off += blksize) {
557 memset(dbio, 0, sizeof (struct dasd_diag_bio));
559 dbio->block_number = recid + 1;
566 cqr->retries = memdev->default_retries;
567 cqr->buildclk = get_tod_clock();
568 if (blk_noretry_request(req) ||
569 block->base->features & DASD_FEATURE_FAILFAST)
570 set_bit(DASD_CQR_FLAGS_FAILFAST, &cqr->flags);
571 cqr->startdev = memdev;
572 cqr->memdev = memdev;
574 cqr->expires = memdev->default_expires * HZ;
575 cqr->status = DASD_CQR_FILLED;
579 /* Release DASD request. Return non-zero if request was successful, zero
582 dasd_diag_free_cp(struct dasd_ccw_req *cqr, struct request *req)
586 status = cqr->status == DASD_CQR_DONE;
587 dasd_sfree_request(cqr, cqr->memdev);
591 static void dasd_diag_handle_terminated_request(struct dasd_ccw_req *cqr)
593 if (cqr->retries < 0)
594 cqr->status = DASD_CQR_FAILED;
596 cqr->status = DASD_CQR_FILLED;
599 /* Fill in IOCTL data for device. */
601 dasd_diag_fill_info(struct dasd_device * device,
602 struct dasd_information2_t * info)
604 struct dasd_diag_private *private;
606 private = (struct dasd_diag_private *) device->private;
607 info->label_block = (unsigned int) private->pt_block;
608 info->FBA_layout = 1;
609 info->format = DASD_FORMAT_LDL;
610 info->characteristics_size = sizeof (struct dasd_diag_characteristics);
611 memcpy(info->characteristics,
612 &((struct dasd_diag_private *) device->private)->rdc_data,
613 sizeof (struct dasd_diag_characteristics));
614 info->confdata_size = 0;
619 dasd_diag_dump_sense(struct dasd_device *device, struct dasd_ccw_req * req,
622 DBF_DEV_EVENT(DBF_WARNING, device, "%s",
623 "dump sense not available for DIAG data");
626 static struct dasd_discipline dasd_diag_discipline = {
627 .owner = THIS_MODULE,
630 .max_blocks = DIAG_MAX_BLOCKS,
631 .check_device = dasd_diag_check_device,
632 .verify_path = dasd_generic_verify_path,
633 .fill_geometry = dasd_diag_fill_geometry,
634 .start_IO = dasd_start_diag,
635 .term_IO = dasd_diag_term_IO,
636 .handle_terminated_request = dasd_diag_handle_terminated_request,
637 .erp_action = dasd_diag_erp_action,
638 .erp_postaction = dasd_diag_erp_postaction,
639 .build_cp = dasd_diag_build_cp,
640 .free_cp = dasd_diag_free_cp,
641 .dump_sense = dasd_diag_dump_sense,
642 .fill_info = dasd_diag_fill_info,
648 if (!MACHINE_IS_VM) {
649 pr_info("Discipline %s cannot be used without z/VM\n",
650 dasd_diag_discipline.name);
653 ASCEBC(dasd_diag_discipline.ebcname, 4);
655 irq_subclass_register(IRQ_SUBCLASS_SERVICE_SIGNAL);
656 register_external_irq(EXT_IRQ_CP_SERVICE, dasd_ext_handler);
657 dasd_diag_discipline_pointer = &dasd_diag_discipline;
662 dasd_diag_cleanup(void)
664 unregister_external_irq(EXT_IRQ_CP_SERVICE, dasd_ext_handler);
665 irq_subclass_unregister(IRQ_SUBCLASS_SERVICE_SIGNAL);
666 dasd_diag_discipline_pointer = NULL;
669 module_init(dasd_diag_init);
670 module_exit(dasd_diag_cleanup);