drivers/s390/char/vmur.c

   1 /*
   2  * Linux driver for System z and s390 unit record devices
   3  * (z/VM virtual punch, reader, printer)
   4  *
   5  * Copyright IBM Corp. 2001, 2007
   6  * Authors: Malcolm Beattie <beattiem@uk.ibm.com>
   7  *          Michael Holzheu <holzheu@de.ibm.com>
   8  *          Frank Munzert <munzert@de.ibm.com>
   9  */
  10
  11 #include <linux/cdev.h>
  12
  13 #include <asm/uaccess.h>
  14 #include <asm/cio.h>
  15 #include <asm/ccwdev.h>
  16 #include <asm/debug.h>
  17 #include <asm/diag.h>
  18
  19 #include "vmur.h"
  20
  21 /*
  22  * Driver overview
  23  *
  24  * Unit record device support is implemented as a character device driver.
  25  * We can fit at least 16 bits into a device minor number and use the
  26  * simple method of mapping a character device number with minor abcd
  27  * to the unit record device with devno abcd.
  28  * I/O to virtual unit record devices is handled as follows:
  29  * Reads: Diagnose code 0x14 (input spool file manipulation)
  30  * is used to read spool data page-wise.
  31  * Writes: The CCW used is WRITE_CCW_CMD (0x01). The device's record length
  32  * is available by reading sysfs attr reclen. Each write() to the device
  33  * must specify an integral multiple (maximal 511) of reclen.
  34  */
  35
  36 static char ur_banner[] = "z/VM virtual unit record device driver";
  37
  38 MODULE_AUTHOR("IBM Corporation");
  39 MODULE_DESCRIPTION("s390 z/VM virtual unit record device driver");
  40 MODULE_LICENSE("GPL");
  41
  42 #define PRINTK_HEADER "vmur: "
  43
  44 static dev_t ur_first_dev_maj_min;
  45 static struct class *vmur_class;
  46 static struct debug_info *vmur_dbf;
  47
  48 /* We put the device's record length (for writes) in the driver_info field */
  49 static struct ccw_device_id ur_ids[] = {
  50         { CCWDEV_CU_DI(READER_PUNCH_DEVTYPE, 80) },
  51         { CCWDEV_CU_DI(PRINTER_DEVTYPE, 132) },
  52         { /* end of list */ }
  53 };
  54
  55 MODULE_DEVICE_TABLE(ccw, ur_ids);
  56
  57 static int ur_probe(struct ccw_device *cdev);
  58 static void ur_remove(struct ccw_device *cdev);
  59 static int ur_set_online(struct ccw_device *cdev);
  60 static int ur_set_offline(struct ccw_device *cdev);
  61
  62 static struct ccw_driver ur_driver = {
  63         .name           = "vmur",
  64         .owner          = THIS_MODULE,
  65         .ids            = ur_ids,
  66         .probe          = ur_probe,
  67         .remove         = ur_remove,
  68         .set_online     = ur_set_online,
  69         .set_offline    = ur_set_offline,
  70 };
  71
  72 static DEFINE_MUTEX(vmur_mutex);
  73
  74 /*
  75  * Allocation, freeing, getting and putting of urdev structures
  76  *
  77  * Each ur device (urd) contains a reference to its corresponding ccw device
  78  * (cdev) using the urd->cdev pointer. Each ccw device has a reference to the
  79  * ur device using the cdev->dev.driver_data pointer.
  80  *
  81  * urd references:
  82  * - ur_probe gets a urd reference, ur_remove drops the reference
  83  *   (cdev->dev.driver_data)
  84  * - ur_open gets a urd reference, ur_relase drops the reference
  85  *   (urf->urd)
  86  *
  87  * cdev references:
  88  * - urdev_alloc get a cdev reference (urd->cdev)
  89  * - urdev_free drops the cdev reference (urd->cdev)
  90  *
  91  * Setting and clearing of cdev->dev.driver_data is protected by the ccwdev lock
  92  */
  93 static struct urdev *urdev_alloc(struct ccw_device *cdev)
  94 {
  95         struct urdev *urd;
  96
  97         urd = kzalloc(sizeof(struct urdev), GFP_KERNEL);
  98         if (!urd)
  99                 return NULL;
 100         urd->reclen = cdev->id.driver_info;
 101         ccw_device_get_id(cdev, &urd->dev_id);
 102         mutex_init(&urd->io_mutex);
 103         init_waitqueue_head(&urd->wait);
 104         spin_lock_init(&urd->open_lock);
 105         atomic_set(&urd->ref_count,  1);
 106         urd->cdev = cdev;
 107         get_device(&cdev->dev);
 108         return urd;
 109 }
 110
 111 static void urdev_free(struct urdev *urd)
 112 {
 113         TRACE("urdev_free: %p\n", urd);
 114         if (urd->cdev)
 115                 put_device(&urd->cdev->dev);
 116         kfree(urd);
 117 }
 118
 119 static void urdev_get(struct urdev *urd)
 120 {
 121         atomic_inc(&urd->ref_count);
 122 }
 123
 124 static struct urdev *urdev_get_from_cdev(struct ccw_device *cdev)
 125 {
 126         struct urdev *urd;
 127         unsigned long flags;
 128
 129         spin_lock_irqsave(get_ccwdev_lock(cdev), flags);
 130         urd = cdev->dev.driver_data;
 131         if (urd)
 132                 urdev_get(urd);
 133         spin_unlock_irqrestore(get_ccwdev_lock(cdev), flags);
 134         return urd;
 135 }
 136
 137 static struct urdev *urdev_get_from_devno(u16 devno)
 138 {
 139         char bus_id[16];
 140         struct ccw_device *cdev;
 141         struct urdev *urd;
 142
 143         sprintf(bus_id, "0.0.%04x", devno);
 144         cdev = get_ccwdev_by_busid(&ur_driver, bus_id);
 145         if (!cdev)
 146                 return NULL;
 147         urd = urdev_get_from_cdev(cdev);
 148         put_device(&cdev->dev);
 149         return urd;
 150 }
 151
 152 static void urdev_put(struct urdev *urd)
 153 {
 154         if (atomic_dec_and_test(&urd->ref_count))
 155                 urdev_free(urd);
 156 }
 157
 158 /*
 159  * Low-level functions to do I/O to a ur device.
 160  *     alloc_chan_prog
 161  *     free_chan_prog
 162  *     do_ur_io
 163  *     ur_int_handler
 164  *
 165  * alloc_chan_prog allocates and builds the channel program
 166  * free_chan_prog frees memory of the channel program
 167  *
 168  * do_ur_io issues the channel program to the device and blocks waiting
 169  * on a completion event it publishes at urd->io_done. The function
 170  * serialises itself on the device's mutex so that only one I/O
 171  * is issued at a time (and that I/O is synchronous).
 172  *
 173  * ur_int_handler catches the "I/O done" interrupt, writes the
 174  * subchannel status word into the scsw member of the urdev structure
 175  * and complete()s the io_done to wake the waiting do_ur_io.
 176  *
 177  * The caller of do_ur_io is responsible for kfree()ing the channel program
 178  * address pointer that alloc_chan_prog returned.
 179  */
 180
 181 static void free_chan_prog(struct ccw1 *cpa)
 182 {
 183         struct ccw1 *ptr = cpa;
 184
 185         while (ptr->cda) {
 186                 kfree((void *)(addr_t) ptr->cda);
 187                 ptr++;
 188         }
 189         kfree(cpa);
 190 }
 191
 192 /*
 193  * alloc_chan_prog
 194  * The channel program we use is write commands chained together
 195  * with a final NOP CCW command-chained on (which ensures that CE and DE
 196  * are presented together in a single interrupt instead of as separate
 197  * interrupts unless an incorrect length indication kicks in first). The
 198  * data length in each CCW is reclen.
 199  */
 200 static struct ccw1 *alloc_chan_prog(const char __user *ubuf, int rec_count,
 201                                     int reclen)
 202 {
 203         struct ccw1 *cpa;
 204         void *kbuf;
 205         int i;
 206
 207         TRACE("alloc_chan_prog(%p, %i, %i)\n", ubuf, rec_count, reclen);
 208
 209         /*
 210          * We chain a NOP onto the writes to force CE+DE together.
 211          * That means we allocate room for CCWs to cover count/reclen
 212          * records plus a NOP.
 213          */
 214         cpa = kzalloc((rec_count + 1) * sizeof(struct ccw1),
 215                       GFP_KERNEL | GFP_DMA);
 216         if (!cpa)
 217                 return ERR_PTR(-ENOMEM);
 218
 219         for (i = 0; i < rec_count; i++) {
 220                 cpa[i].cmd_code = WRITE_CCW_CMD;
 221                 cpa[i].flags = CCW_FLAG_CC | CCW_FLAG_SLI;
 222                 cpa[i].count = reclen;
 223                 kbuf = kmalloc(reclen, GFP_KERNEL | GFP_DMA);
 224                 if (!kbuf) {
 225                         free_chan_prog(cpa);
 226                         return ERR_PTR(-ENOMEM);
 227                 }
 228                 cpa[i].cda = (u32)(addr_t) kbuf;
 229                 if (copy_from_user(kbuf, ubuf, reclen)) {
 230                         free_chan_prog(cpa);
 231                         return ERR_PTR(-EFAULT);
 232                 }
 233                 ubuf += reclen;
 234         }
 235         /* The following NOP CCW forces CE+DE to be presented together */
 236         cpa[i].cmd_code = CCW_CMD_NOOP;
 237         return cpa;
 238 }
 239
 240 static int do_ur_io(struct urdev *urd, struct ccw1 *cpa)
 241 {
 242         int rc;
 243         struct ccw_device *cdev = urd->cdev;
 244         DECLARE_COMPLETION_ONSTACK(event);
 245
 246         TRACE("do_ur_io: cpa=%p\n", cpa);
 247
 248         rc = mutex_lock_interruptible(&urd->io_mutex);
 249         if (rc)
 250                 return rc;
 251
 252         urd->io_done = &event;
 253
 254         spin_lock_irq(get_ccwdev_lock(cdev));
 255         rc = ccw_device_start(cdev, cpa, 1, 0, 0);
 256         spin_unlock_irq(get_ccwdev_lock(cdev));
 257
 258         TRACE("do_ur_io: ccw_device_start returned %d\n", rc);
 259         if (rc)
 260                 goto out;
 261
 262         wait_for_completion(&event);
 263         TRACE("do_ur_io: I/O complete\n");
 264         rc = 0;
 265
 266 out:
 267         mutex_unlock(&urd->io_mutex);
 268         return rc;
 269 }
 270
 271 /*
 272  * ur interrupt handler, called from the ccw_device layer
 273  */
 274 static void ur_int_handler(struct ccw_device *cdev, unsigned long intparm,
 275                            struct irb *irb)
 276 {
 277         struct urdev *urd;
 278
 279         TRACE("ur_int_handler: intparm=0x%lx cstat=%02x dstat=%02x res=%u\n",
 280               intparm, irb->scsw.cmd.cstat, irb->scsw.cmd.dstat,
 281               irb->scsw.cmd.count);
 282
 283         if (!intparm) {
 284                 TRACE("ur_int_handler: unsolicited interrupt\n");
 285                 return;
 286         }
 287         urd = cdev->dev.driver_data;
 288         BUG_ON(!urd);
 289         /* On special conditions irb is an error pointer */
 290         if (IS_ERR(irb))
 291                 urd->io_request_rc = PTR_ERR(irb);
 292         else if (irb->scsw.cmd.dstat == (DEV_STAT_CHN_END | DEV_STAT_DEV_END))
 293                 urd->io_request_rc = 0;
 294         else
 295                 urd->io_request_rc = -EIO;
 296
 297         complete(urd->io_done);
 298 }
 299
 300 /*
 301  * reclen sysfs attribute - The record length to be used for write CCWs
 302  */
 303 static ssize_t ur_attr_reclen_show(struct device *dev,
 304                                    struct device_attribute *attr, char *buf)
 305 {
 306         struct urdev *urd;
 307         int rc;
 308
 309         urd = urdev_get_from_cdev(to_ccwdev(dev));
 310         if (!urd)
 311                 return -ENODEV;
 312         rc = sprintf(buf, "%zu\n", urd->reclen);
 313         urdev_put(urd);
 314         return rc;
 315 }
 316
 317 static DEVICE_ATTR(reclen, 0444, ur_attr_reclen_show, NULL);
 318
 319 static int ur_create_attributes(struct device *dev)
 320 {
 321         return device_create_file(dev, &dev_attr_reclen);
 322 }
 323
 324 static void ur_remove_attributes(struct device *dev)
 325 {
 326         device_remove_file(dev, &dev_attr_reclen);
 327 }
 328
 329 /*
 330  * diagnose code 0x210 - retrieve device information
 331  * cc=0  normal completion, we have a real device
 332  * cc=1  CP paging error
 333  * cc=2  The virtual device exists, but is not associated with a real device
 334  * cc=3  Invalid device address, or the virtual device does not exist
 335  */
 336 static int get_urd_class(struct urdev *urd)
 337 {
 338         static struct diag210 ur_diag210;
 339         int cc;
 340
 341         ur_diag210.vrdcdvno = urd->dev_id.devno;
 342         ur_diag210.vrdclen = sizeof(struct diag210);
 343
 344         cc = diag210(&ur_diag210);
 345         switch (cc) {
 346         case 0:
 347                 return -ENOTSUPP;
 348         case 2:
 349                 return ur_diag210.vrdcvcla; /* virtual device class */
 350         case 3:
 351                 return -ENODEV;
 352         default:
 353                 return -EIO;
 354         }
 355 }
 356
 357 /*
 358  * Allocation and freeing of urfile structures
 359  */
 360 static struct urfile *urfile_alloc(struct urdev *urd)
 361 {
 362         struct urfile *urf;
 363
 364         urf = kzalloc(sizeof(struct urfile), GFP_KERNEL);
 365         if (!urf)
 366                 return NULL;
 367         urf->urd = urd;
 368
 369         TRACE("urfile_alloc: urd=%p urf=%p rl=%zu\n", urd, urf,
 370               urf->dev_reclen);
 371
 372         return urf;
 373 }
 374
 375 static void urfile_free(struct urfile *urf)
 376 {
 377         TRACE("urfile_free: urf=%p urd=%p\n", urf, urf->urd);
 378         kfree(urf);
 379 }
 380
 381 /*
 382  * The fops implementation of the character device driver
 383  */
 384 static ssize_t do_write(struct urdev *urd, const char __user *udata,
 385                         size_t count, size_t reclen, loff_t *ppos)
 386 {
 387         struct ccw1 *cpa;
 388         int rc;
 389
 390         cpa = alloc_chan_prog(udata, count / reclen, reclen);
 391         if (IS_ERR(cpa))
 392                 return PTR_ERR(cpa);
 393
 394         rc = do_ur_io(urd, cpa);
 395         if (rc)
 396                 goto fail_kfree_cpa;
 397
 398         if (urd->io_request_rc) {
 399                 rc = urd->io_request_rc;
 400                 goto fail_kfree_cpa;
 401         }
 402         *ppos += count;
 403         rc = count;
 404
 405 fail_kfree_cpa:
 406         free_chan_prog(cpa);
 407         return rc;
 408 }
 409
 410 static ssize_t ur_write(struct file *file, const char __user *udata,
 411                         size_t count, loff_t *ppos)
 412 {
 413         struct urfile *urf = file->private_data;
 414
 415         TRACE("ur_write: count=%zu\n", count);
 416
 417         if (count == 0)
 418                 return 0;
 419
 420         if (count % urf->dev_reclen)
 421                 return -EINVAL; /* count must be a multiple of reclen */
 422
 423         if (count > urf->dev_reclen * MAX_RECS_PER_IO)
 424                 count = urf->dev_reclen * MAX_RECS_PER_IO;
 425
 426         return do_write(urf->urd, udata, count, urf->dev_reclen, ppos);
 427 }
 428
 429 /*
 430  * diagnose code 0x14 subcode 0x0028 - position spool file to designated
 431  *                                     record
 432  * cc=0  normal completion
 433  * cc=2  no file active on the virtual reader or device not ready
 434  * cc=3  record specified is beyond EOF
 435  */
 436 static int diag_position_to_record(int devno, int record)
 437 {
 438         int cc;
 439
 440         cc = diag14(record, devno, 0x28);
 441         switch (cc) {
 442         case 0:
 443                 return 0;
 444         case 2:
 445                 return -ENOMEDIUM;
 446         case 3:
 447                 return -ENODATA; /* position beyond end of file */
 448         default:
 449                 return -EIO;
 450         }
 451 }
 452
 453 /*
 454  * diagnose code 0x14 subcode 0x0000 - read next spool file buffer
 455  * cc=0  normal completion
 456  * cc=1  EOF reached
 457  * cc=2  no file active on the virtual reader, and no file eligible
 458  * cc=3  file already active on the virtual reader or specified virtual
 459  *       reader does not exist or is not a reader
 460  */
 461 static int diag_read_file(int devno, char *buf)
 462 {
 463         int cc;
 464
 465         cc = diag14((unsigned long) buf, devno, 0x00);
 466         switch (cc) {
 467         case 0:
 468                 return 0;
 469         case 1:
 470                 return -ENODATA;
 471         case 2:
 472                 return -ENOMEDIUM;
 473         default:
 474                 return -EIO;
 475         }
 476 }
 477
 478 static ssize_t diag14_read(struct file *file, char __user *ubuf, size_t count,
 479                            loff_t *offs)
 480 {
 481         size_t len, copied, res;
 482         char *buf;
 483         int rc;
 484         u16 reclen;
 485         struct urdev *urd;
 486
 487         urd = ((struct urfile *) file->private_data)->urd;
 488         reclen = ((struct urfile *) file->private_data)->file_reclen;
 489
 490         rc = diag_position_to_record(urd->dev_id.devno, *offs / PAGE_SIZE + 1);
 491         if (rc == -ENODATA)
 492                 return 0;
 493         if (rc)
 494                 return rc;
 495
 496         len = min((size_t) PAGE_SIZE, count);
 497         buf = (char *) __get_free_page(GFP_KERNEL | GFP_DMA);
 498         if (!buf)
 499                 return -ENOMEM;
 500
 501         copied = 0;
 502         res = (size_t) (*offs % PAGE_SIZE);
 503         do {
 504                 rc = diag_read_file(urd->dev_id.devno, buf);
 505                 if (rc == -ENODATA) {
 506                         break;
 507                 }
 508                 if (rc)
 509                         goto fail;
 510                 if (reclen && (copied == 0) && (*offs < PAGE_SIZE))
 511                         *((u16 *) &buf[FILE_RECLEN_OFFSET]) = reclen;
 512                 len = min(count - copied, PAGE_SIZE - res);
 513                 if (copy_to_user(ubuf + copied, buf + res, len)) {
 514                         rc = -EFAULT;
 515                         goto fail;
 516                 }
 517                 res = 0;
 518                 copied += len;
 519         } while (copied != count);
 520
 521         *offs += copied;
 522         rc = copied;
 523 fail:
 524         free_page((unsigned long) buf);
 525         return rc;
 526 }
 527
 528 static ssize_t ur_read(struct file *file, char __user *ubuf, size_t count,
 529                        loff_t *offs)
 530 {
 531         struct urdev *urd;
 532         int rc;
 533
 534         TRACE("ur_read: count=%zu ppos=%li\n", count, (unsigned long) *offs);
 535
 536         if (count == 0)
 537                 return 0;
 538
 539         urd = ((struct urfile *) file->private_data)->urd;
 540         rc = mutex_lock_interruptible(&urd->io_mutex);
 541         if (rc)
 542                 return rc;
 543         rc = diag14_read(file, ubuf, count, offs);
 544         mutex_unlock(&urd->io_mutex);
 545         return rc;
 546 }
 547
 548 /*
 549  * diagnose code 0x14 subcode 0x0fff - retrieve next file descriptor
 550  * cc=0  normal completion
 551  * cc=1  no files on reader queue or no subsequent file
 552  * cc=2  spid specified is invalid
 553  */
 554 static int diag_read_next_file_info(struct file_control_block *buf, int spid)
 555 {
 556         int cc;
 557
 558         cc = diag14((unsigned long) buf, spid, 0xfff);
 559         switch (cc) {
 560         case 0:
 561                 return 0;
 562         default:
 563                 return -ENODATA;
 564         }
 565 }
 566
 567 static int verify_uri_device(struct urdev *urd)
 568 {
 569         struct file_control_block *fcb;
 570         char *buf;
 571         int rc;
 572
 573         fcb = kmalloc(sizeof(*fcb), GFP_KERNEL | GFP_DMA);
 574         if (!fcb)
 575                 return -ENOMEM;
 576
 577         /* check for empty reader device (beginning of chain) */
 578         rc = diag_read_next_file_info(fcb, 0);
 579         if (rc)
 580                 goto fail_free_fcb;
 581
 582         /* if file is in hold status, we do not read it */
 583         if (fcb->file_stat & (FLG_SYSTEM_HOLD | FLG_USER_HOLD)) {
 584                 rc = -EPERM;
 585                 goto fail_free_fcb;
 586         }
 587
 588         /* open file on virtual reader  */
 589         buf = (char *) __get_free_page(GFP_KERNEL | GFP_DMA);
 590         if (!buf) {
 591                 rc = -ENOMEM;
 592                 goto fail_free_fcb;
 593         }
 594         rc = diag_read_file(urd->dev_id.devno, buf);
 595         if ((rc != 0) && (rc != -ENODATA)) /* EOF does not hurt */
 596                 goto fail_free_buf;
 597
 598         /* check if the file on top of the queue is open now */
 599         rc = diag_read_next_file_info(fcb, 0);
 600         if (rc)
 601                 goto fail_free_buf;
 602         if (!(fcb->file_stat & FLG_IN_USE)) {
 603                 rc = -EMFILE;
 604                 goto fail_free_buf;
 605         }
 606         rc = 0;
 607
 608 fail_free_buf:
 609         free_page((unsigned long) buf);
 610 fail_free_fcb:
 611         kfree(fcb);
 612         return rc;
 613 }
 614
 615 static int verify_device(struct urdev *urd)
 616 {
 617         switch (urd->class) {
 618         case DEV_CLASS_UR_O:
 619                 return 0; /* no check needed here */
 620         case DEV_CLASS_UR_I:
 621                 return verify_uri_device(urd);
 622         default:
 623                 return -ENOTSUPP;
 624         }
 625 }
 626
 627 static int get_uri_file_reclen(struct urdev *urd)
 628 {
 629         struct file_control_block *fcb;
 630         int rc;
 631
 632         fcb = kmalloc(sizeof(*fcb), GFP_KERNEL | GFP_DMA);
 633         if (!fcb)
 634                 return -ENOMEM;
 635         rc = diag_read_next_file_info(fcb, 0);
 636         if (rc)
 637                 goto fail_free;
 638         if (fcb->file_stat & FLG_CP_DUMP)
 639                 rc = 0;
 640         else
 641                 rc = fcb->rec_len;
 642
 643 fail_free:
 644         kfree(fcb);
 645         return rc;
 646 }
 647
 648 static int get_file_reclen(struct urdev *urd)
 649 {
 650         switch (urd->class) {
 651         case DEV_CLASS_UR_O:
 652                 return 0;
 653         case DEV_CLASS_UR_I:
 654                 return get_uri_file_reclen(urd);
 655         default:
 656                 return -ENOTSUPP;
 657         }
 658 }
 659
 660 static int ur_open(struct inode *inode, struct file *file)
 661 {
 662         u16 devno;
 663         struct urdev *urd;
 664         struct urfile *urf;
 665         unsigned short accmode;
 666         int rc;
 667
 668         accmode = file->f_flags & O_ACCMODE;
 669
 670         if (accmode == O_RDWR)
 671                 return -EACCES;
 672
 673         /*
 674          * We treat the minor number as the devno of the ur device
 675          * to find in the driver tree.
 676          */
 677         devno = MINOR(file->f_dentry->d_inode->i_rdev);
 678
 679         urd = urdev_get_from_devno(devno);
 680         if (!urd)
 681                 return -ENXIO;
 682
 683         spin_lock(&urd->open_lock);
 684         while (urd->open_flag) {
 685                 spin_unlock(&urd->open_lock);
 686                 if (file->f_flags & O_NONBLOCK) {
 687                         rc = -EBUSY;
 688                         goto fail_put;
 689                 }
 690                 if (wait_event_interruptible(urd->wait, urd->open_flag == 0)) {
 691                         rc = -ERESTARTSYS;
 692                         goto fail_put;
 693                 }
 694                 spin_lock(&urd->open_lock);
 695         }
 696         urd->open_flag++;
 697         spin_unlock(&urd->open_lock);
 698
 699         TRACE("ur_open\n");
 700
 701         if (((accmode == O_RDONLY) && (urd->class != DEV_CLASS_UR_I)) ||
 702             ((accmode == O_WRONLY) && (urd->class != DEV_CLASS_UR_O))) {
 703                 TRACE("ur_open: unsupported dev class (%d)\n", urd->class);
 704                 rc = -EACCES;
 705                 goto fail_unlock;
 706         }
 707
 708         rc = verify_device(urd);
 709         if (rc)
 710                 goto fail_unlock;
 711
 712         urf = urfile_alloc(urd);
 713         if (!urf) {
 714                 rc = -ENOMEM;
 715                 goto fail_unlock;
 716         }
 717
 718         urf->dev_reclen = urd->reclen;
 719         rc = get_file_reclen(urd);
 720         if (rc < 0)
 721                 goto fail_urfile_free;
 722         urf->file_reclen = rc;
 723         file->private_data = urf;
 724         return 0;
 725
 726 fail_urfile_free:
 727         urfile_free(urf);
 728 fail_unlock:
 729         spin_lock(&urd->open_lock);
 730         urd->open_flag--;
 731         spin_unlock(&urd->open_lock);
 732 fail_put:
 733         urdev_put(urd);
 734         return rc;
 735 }
 736
 737 static int ur_release(struct inode *inode, struct file *file)
 738 {
 739         struct urfile *urf = file->private_data;
 740
 741         TRACE("ur_release\n");
 742         spin_lock(&urf->urd->open_lock);
 743         urf->urd->open_flag--;
 744         spin_unlock(&urf->urd->open_lock);
 745         wake_up_interruptible(&urf->urd->wait);
 746         urdev_put(urf->urd);
 747         urfile_free(urf);
 748         return 0;
 749 }
 750
 751 static loff_t ur_llseek(struct file *file, loff_t offset, int whence)
 752 {
 753         loff_t newpos;
 754
 755         if ((file->f_flags & O_ACCMODE) != O_RDONLY)
 756                 return -ESPIPE; /* seek allowed only for reader */
 757         if (offset % PAGE_SIZE)
 758                 return -ESPIPE; /* only multiples of 4K allowed */
 759         switch (whence) {
 760         case 0: /* SEEK_SET */
 761                 newpos = offset;
 762                 break;
 763         case 1: /* SEEK_CUR */
 764                 newpos = file->f_pos + offset;
 765                 break;
 766         default:
 767                 return -EINVAL;
 768         }
 769         file->f_pos = newpos;
 770         return newpos;
 771 }
 772
 773 static const struct file_operations ur_fops = {
 774         .owner   = THIS_MODULE,
 775         .open    = ur_open,
 776         .release = ur_release,
 777         .read    = ur_read,
 778         .write   = ur_write,
 779         .llseek  = ur_llseek,
 780 };
 781
 782 /*
 783  * ccw_device infrastructure:
 784  *     ur_probe creates the struct urdev (with refcount = 1), the device
 785  *     attributes, sets up the interrupt handler and validates the virtual
 786  *     unit record device.
 787  *     ur_remove removes the device attributes and drops the reference to
 788  *     struct urdev.
 789  *
 790  *     ur_probe, ur_remove, ur_set_online and ur_set_offline are serialized
 791  *     by the vmur_mutex lock.
 792  *
 793  *     urd->char_device is used as indication that the online function has
 794  *     been completed successfully.
 795  */
 796 static int ur_probe(struct ccw_device *cdev)
 797 {
 798         struct urdev *urd;
 799         int rc;
 800
 801         TRACE("ur_probe: cdev=%p\n", cdev);
 802
 803         mutex_lock(&vmur_mutex);
 804         urd = urdev_alloc(cdev);
 805         if (!urd) {
 806                 rc = -ENOMEM;
 807                 goto fail_unlock;
 808         }
 809
 810         rc = ur_create_attributes(&cdev->dev);
 811         if (rc) {
 812                 rc = -ENOMEM;
 813                 goto fail_urdev_put;
 814         }
 815         cdev->handler = ur_int_handler;
 816
 817         /* validate virtual unit record device */
 818         urd->class = get_urd_class(urd);
 819         if (urd->class < 0) {
 820                 rc = urd->class;
 821                 goto fail_remove_attr;
 822         }
 823         if ((urd->class != DEV_CLASS_UR_I) && (urd->class != DEV_CLASS_UR_O)) {
 824                 rc = -ENOTSUPP;
 825                 goto fail_remove_attr;
 826         }
 827         spin_lock_irq(get_ccwdev_lock(cdev));
 828         cdev->dev.driver_data = urd;
 829         spin_unlock_irq(get_ccwdev_lock(cdev));
 830
 831         mutex_unlock(&vmur_mutex);
 832         return 0;
 833
 834 fail_remove_attr:
 835         ur_remove_attributes(&cdev->dev);
 836 fail_urdev_put:
 837         urdev_put(urd);
 838 fail_unlock:
 839         mutex_unlock(&vmur_mutex);
 840         return rc;
 841 }
 842
 843 static int ur_set_online(struct ccw_device *cdev)
 844 {
 845         struct urdev *urd;
 846         int minor, major, rc;
 847         char node_id[16];
 848
 849         TRACE("ur_set_online: cdev=%p\n", cdev);
 850
 851         mutex_lock(&vmur_mutex);
 852         urd = urdev_get_from_cdev(cdev);
 853         if (!urd) {
 854                 /* ur_remove already deleted our urd */
 855                 rc = -ENODEV;
 856                 goto fail_unlock;
 857         }
 858
 859         if (urd->char_device) {
 860                 /* Another ur_set_online was faster */
 861                 rc = -EBUSY;
 862                 goto fail_urdev_put;
 863         }
 864
 865         minor = urd->dev_id.devno;
 866         major = MAJOR(ur_first_dev_maj_min);
 867
 868         urd->char_device = cdev_alloc();
 869         if (!urd->char_device) {
 870                 rc = -ENOMEM;
 871                 goto fail_urdev_put;
 872         }
 873
 874         cdev_init(urd->char_device, &ur_fops);
 875         urd->char_device->dev = MKDEV(major, minor);
 876         urd->char_device->owner = ur_fops.owner;
 877
 878         rc = cdev_add(urd->char_device, urd->char_device->dev, 1);
 879         if (rc)
 880                 goto fail_free_cdev;
 881         if (urd->cdev->id.cu_type == READER_PUNCH_DEVTYPE) {
 882                 if (urd->class == DEV_CLASS_UR_I)
 883                         sprintf(node_id, "vmrdr-%s", cdev->dev.bus_id);
 884                 if (urd->class == DEV_CLASS_UR_O)
 885                         sprintf(node_id, "vmpun-%s", cdev->dev.bus_id);
 886         } else if (urd->cdev->id.cu_type == PRINTER_DEVTYPE) {
 887                 sprintf(node_id, "vmprt-%s", cdev->dev.bus_id);
 888         } else {
 889                 rc = -ENOTSUPP;
 890                 goto fail_free_cdev;
 891         }
 892
 893         urd->device = device_create(vmur_class, NULL, urd->char_device->dev,
 894                                         "%s", node_id);
 895         if (IS_ERR(urd->device)) {
 896                 rc = PTR_ERR(urd->device);
 897                 TRACE("ur_set_online: device_create rc=%d\n", rc);
 898                 goto fail_free_cdev;
 899         }
 900         urdev_put(urd);
 901         mutex_unlock(&vmur_mutex);
 902         return 0;
 903
 904 fail_free_cdev:
 905         cdev_del(urd->char_device);
 906         urd->char_device = NULL;
 907 fail_urdev_put:
 908         urdev_put(urd);
 909 fail_unlock:
 910         mutex_unlock(&vmur_mutex);
 911         return rc;
 912 }
 913
 914 static int ur_set_offline_force(struct ccw_device *cdev, int force)
 915 {
 916         struct urdev *urd;
 917         int rc;
 918
 919         TRACE("ur_set_offline: cdev=%p\n", cdev);
 920         urd = urdev_get_from_cdev(cdev);
 921         if (!urd)
 922                 /* ur_remove already deleted our urd */
 923                 return -ENODEV;
 924         if (!urd->char_device) {
 925                 /* Another ur_set_offline was faster */
 926                 rc = -EBUSY;
 927                 goto fail_urdev_put;
 928         }
 929         if (!force && (atomic_read(&urd->ref_count) > 2)) {
 930                 /* There is still a user of urd (e.g. ur_open) */
 931                 TRACE("ur_set_offline: BUSY\n");
 932                 rc = -EBUSY;
 933                 goto fail_urdev_put;
 934         }
 935         device_destroy(vmur_class, urd->char_device->dev);
 936         cdev_del(urd->char_device);
 937         urd->char_device = NULL;
 938         rc = 0;
 939
 940 fail_urdev_put:
 941         urdev_put(urd);
 942         return rc;
 943 }
 944
 945 static int ur_set_offline(struct ccw_device *cdev)
 946 {
 947         int rc;
 948
 949         mutex_lock(&vmur_mutex);
 950         rc = ur_set_offline_force(cdev, 0);
 951         mutex_unlock(&vmur_mutex);
 952         return rc;
 953 }
 954
 955 static void ur_remove(struct ccw_device *cdev)
 956 {
 957         unsigned long flags;
 958
 959         TRACE("ur_remove\n");
 960
 961         mutex_lock(&vmur_mutex);
 962
 963         if (cdev->online)
 964                 ur_set_offline_force(cdev, 1);
 965         ur_remove_attributes(&cdev->dev);
 966
 967         spin_lock_irqsave(get_ccwdev_lock(cdev), flags);
 968         urdev_put(cdev->dev.driver_data);
 969         cdev->dev.driver_data = NULL;
 970         spin_unlock_irqrestore(get_ccwdev_lock(cdev), flags);
 971
 972         mutex_unlock(&vmur_mutex);
 973 }
 974
 975 /*
 976  * Module initialisation and cleanup
 977  */
 978 static int __init ur_init(void)
 979 {
 980         int rc;
 981         dev_t dev;
 982
 983         if (!MACHINE_IS_VM) {
 984                 PRINT_ERR("%s is only available under z/VM.\n", ur_banner);
 985                 return -ENODEV;
 986         }
 987
 988         vmur_dbf = debug_register("vmur", 4, 1, 4 * sizeof(long));
 989         if (!vmur_dbf)
 990                 return -ENOMEM;
 991         rc = debug_register_view(vmur_dbf, &debug_sprintf_view);
 992         if (rc)
 993                 goto fail_free_dbf;
 994
 995         debug_set_level(vmur_dbf, 6);
 996
 997         rc = ccw_driver_register(&ur_driver);
 998         if (rc)
 999                 goto fail_free_dbf;
1000
1001         rc = alloc_chrdev_region(&dev, 0, NUM_MINORS, "vmur");
1002         if (rc) {
1003                 PRINT_ERR("alloc_chrdev_region failed: err = %d\n", rc);
1004                 goto fail_unregister_driver;
1005         }
1006         ur_first_dev_maj_min = MKDEV(MAJOR(dev), 0);
1007
1008         vmur_class = class_create(THIS_MODULE, "vmur");
1009         if (IS_ERR(vmur_class)) {
1010                 rc = PTR_ERR(vmur_class);
1011                 goto fail_unregister_region;
1012         }
1013         PRINT_INFO("%s loaded.\n", ur_banner);
1014         return 0;
1015
1016 fail_unregister_region:
1017         unregister_chrdev_region(ur_first_dev_maj_min, NUM_MINORS);
1018 fail_unregister_driver:
1019         ccw_driver_unregister(&ur_driver);
1020 fail_free_dbf:
1021         debug_unregister(vmur_dbf);
1022         return rc;
1023 }
1024
1025 static void __exit ur_exit(void)
1026 {
1027         class_destroy(vmur_class);
1028         unregister_chrdev_region(ur_first_dev_maj_min, NUM_MINORS);
1029         ccw_driver_unregister(&ur_driver);
1030         debug_unregister(vmur_dbf);
1031         PRINT_INFO("%s unloaded.\n", ur_banner);
1032 }
1033
1034 module_init(ur_init);
1035 module_exit(ur_exit);