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