2 * Linux driver for System z and s390 unit record devices
3 * (z/VM virtual punch, reader, printer)
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>
11 #include <linux/cdev.h>
13 #include <asm/uaccess.h>
15 #include <asm/ccwdev.h>
16 #include <asm/debug.h>
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.
36 static char ur_banner[] = "z/VM virtual unit record device driver";
38 MODULE_AUTHOR("IBM Corporation");
39 MODULE_DESCRIPTION("s390 z/VM virtual unit record device driver");
40 MODULE_LICENSE("GPL");
42 #define PRINTK_HEADER "vmur: "
44 static dev_t ur_first_dev_maj_min;
45 static struct class *vmur_class;
46 static struct debug_info *vmur_dbf;
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) },
55 MODULE_DEVICE_TABLE(ccw, ur_ids);
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);
62 static struct ccw_driver ur_driver = {
68 .set_online = ur_set_online,
69 .set_offline = ur_set_offline,
72 static DEFINE_MUTEX(vmur_mutex);
75 * Allocation, freeing, getting and putting of urdev structures
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.
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
88 * - urdev_alloc get a cdev reference (urd->cdev)
89 * - urdev_free drops the cdev reference (urd->cdev)
91 * Setting and clearing of cdev->dev.driver_data is protected by the ccwdev lock
93 static struct urdev *urdev_alloc(struct ccw_device *cdev)
97 urd = kzalloc(sizeof(struct urdev), GFP_KERNEL);
100 urd->reclen = cdev->id.driver_info;
101 ccw_device_get_id(cdev, &urd->dev_id);
102 mutex_init(&urd->io_mutex);
103 mutex_init(&urd->open_mutex);
104 atomic_set(&urd->ref_count, 1);
106 get_device(&cdev->dev);
110 static void urdev_free(struct urdev *urd)
112 TRACE("urdev_free: %p\n", urd);
114 put_device(&urd->cdev->dev);
118 static void urdev_get(struct urdev *urd)
120 atomic_inc(&urd->ref_count);
123 static struct urdev *urdev_get_from_cdev(struct ccw_device *cdev)
128 spin_lock_irqsave(get_ccwdev_lock(cdev), flags);
129 urd = cdev->dev.driver_data;
132 spin_unlock_irqrestore(get_ccwdev_lock(cdev), flags);
136 static struct urdev *urdev_get_from_devno(u16 devno)
139 struct ccw_device *cdev;
142 sprintf(bus_id, "0.0.%04x", devno);
143 cdev = get_ccwdev_by_busid(&ur_driver, bus_id);
146 urd = urdev_get_from_cdev(cdev);
147 put_device(&cdev->dev);
151 static void urdev_put(struct urdev *urd)
153 if (atomic_dec_and_test(&urd->ref_count))
158 * Low-level functions to do I/O to a ur device.
164 * alloc_chan_prog allocates and builds the channel program
165 * free_chan_prog frees memory of the channel program
167 * do_ur_io issues the channel program to the device and blocks waiting
168 * on a completion event it publishes at urd->io_done. The function
169 * serialises itself on the device's mutex so that only one I/O
170 * is issued at a time (and that I/O is synchronous).
172 * ur_int_handler catches the "I/O done" interrupt, writes the
173 * subchannel status word into the scsw member of the urdev structure
174 * and complete()s the io_done to wake the waiting do_ur_io.
176 * The caller of do_ur_io is responsible for kfree()ing the channel program
177 * address pointer that alloc_chan_prog returned.
180 static void free_chan_prog(struct ccw1 *cpa)
182 struct ccw1 *ptr = cpa;
185 kfree((void *)(addr_t) ptr->cda);
193 * The channel program we use is write commands chained together
194 * with a final NOP CCW command-chained on (which ensures that CE and DE
195 * are presented together in a single interrupt instead of as separate
196 * interrupts unless an incorrect length indication kicks in first). The
197 * data length in each CCW is reclen.
199 static struct ccw1 *alloc_chan_prog(const char __user *ubuf, int rec_count,
206 TRACE("alloc_chan_prog(%p, %i, %i)\n", ubuf, rec_count, reclen);
209 * We chain a NOP onto the writes to force CE+DE together.
210 * That means we allocate room for CCWs to cover count/reclen
211 * records plus a NOP.
213 cpa = kzalloc((rec_count + 1) * sizeof(struct ccw1),
214 GFP_KERNEL | GFP_DMA);
216 return ERR_PTR(-ENOMEM);
218 for (i = 0; i < rec_count; i++) {
219 cpa[i].cmd_code = WRITE_CCW_CMD;
220 cpa[i].flags = CCW_FLAG_CC | CCW_FLAG_SLI;
221 cpa[i].count = reclen;
222 kbuf = kmalloc(reclen, GFP_KERNEL | GFP_DMA);
225 return ERR_PTR(-ENOMEM);
227 cpa[i].cda = (u32)(addr_t) kbuf;
228 if (copy_from_user(kbuf, ubuf, reclen)) {
230 return ERR_PTR(-EFAULT);
234 /* The following NOP CCW forces CE+DE to be presented together */
235 cpa[i].cmd_code = CCW_CMD_NOOP;
239 static int do_ur_io(struct urdev *urd, struct ccw1 *cpa)
242 struct ccw_device *cdev = urd->cdev;
243 DECLARE_COMPLETION_ONSTACK(event);
245 TRACE("do_ur_io: cpa=%p\n", cpa);
247 rc = mutex_lock_interruptible(&urd->io_mutex);
251 urd->io_done = &event;
253 spin_lock_irq(get_ccwdev_lock(cdev));
254 rc = ccw_device_start(cdev, cpa, 1, 0, 0);
255 spin_unlock_irq(get_ccwdev_lock(cdev));
257 TRACE("do_ur_io: ccw_device_start returned %d\n", rc);
261 wait_for_completion(&event);
262 TRACE("do_ur_io: I/O complete\n");
266 mutex_unlock(&urd->io_mutex);
271 * ur interrupt handler, called from the ccw_device layer
273 static void ur_int_handler(struct ccw_device *cdev, unsigned long intparm,
278 TRACE("ur_int_handler: intparm=0x%lx cstat=%02x dstat=%02x res=%u\n",
279 intparm, irb->scsw.cstat, irb->scsw.dstat, irb->scsw.count);
282 TRACE("ur_int_handler: unsolicited interrupt\n");
285 urd = cdev->dev.driver_data;
287 /* On special conditions irb is an error pointer */
289 urd->io_request_rc = PTR_ERR(irb);
290 else if (irb->scsw.dstat == (DEV_STAT_CHN_END | DEV_STAT_DEV_END))
291 urd->io_request_rc = 0;
293 urd->io_request_rc = -EIO;
295 complete(urd->io_done);
299 * reclen sysfs attribute - The record length to be used for write CCWs
301 static ssize_t ur_attr_reclen_show(struct device *dev,
302 struct device_attribute *attr, char *buf)
307 urd = urdev_get_from_cdev(to_ccwdev(dev));
310 rc = sprintf(buf, "%zu\n", urd->reclen);
315 static DEVICE_ATTR(reclen, 0444, ur_attr_reclen_show, NULL);
317 static int ur_create_attributes(struct device *dev)
319 return device_create_file(dev, &dev_attr_reclen);
322 static void ur_remove_attributes(struct device *dev)
324 device_remove_file(dev, &dev_attr_reclen);
328 * diagnose code 0x210 - retrieve device information
329 * cc=0 normal completion, we have a real device
330 * cc=1 CP paging error
331 * cc=2 The virtual device exists, but is not associated with a real device
332 * cc=3 Invalid device address, or the virtual device does not exist
334 static int get_urd_class(struct urdev *urd)
336 static struct diag210 ur_diag210;
339 ur_diag210.vrdcdvno = urd->dev_id.devno;
340 ur_diag210.vrdclen = sizeof(struct diag210);
342 cc = diag210(&ur_diag210);
347 return ur_diag210.vrdcvcla; /* virtual device class */
356 * Allocation and freeing of urfile structures
358 static struct urfile *urfile_alloc(struct urdev *urd)
362 urf = kzalloc(sizeof(struct urfile), GFP_KERNEL);
367 TRACE("urfile_alloc: urd=%p urf=%p rl=%zu\n", urd, urf,
373 static void urfile_free(struct urfile *urf)
375 TRACE("urfile_free: urf=%p urd=%p\n", urf, urf->urd);
380 * The fops implementation of the character device driver
382 static ssize_t do_write(struct urdev *urd, const char __user *udata,
383 size_t count, size_t reclen, loff_t *ppos)
388 cpa = alloc_chan_prog(udata, count / reclen, reclen);
392 rc = do_ur_io(urd, cpa);
396 if (urd->io_request_rc) {
397 rc = urd->io_request_rc;
408 static ssize_t ur_write(struct file *file, const char __user *udata,
409 size_t count, loff_t *ppos)
411 struct urfile *urf = file->private_data;
413 TRACE("ur_write: count=%zu\n", count);
418 if (count % urf->dev_reclen)
419 return -EINVAL; /* count must be a multiple of reclen */
421 if (count > urf->dev_reclen * MAX_RECS_PER_IO)
422 count = urf->dev_reclen * MAX_RECS_PER_IO;
424 return do_write(urf->urd, udata, count, urf->dev_reclen, ppos);
428 * diagnose code 0x14 subcode 0x0028 - position spool file to designated
430 * cc=0 normal completion
431 * cc=2 no file active on the virtual reader or device not ready
432 * cc=3 record specified is beyond EOF
434 static int diag_position_to_record(int devno, int record)
438 cc = diag14(record, devno, 0x28);
445 return -ENODATA; /* position beyond end of file */
452 * diagnose code 0x14 subcode 0x0000 - read next spool file buffer
453 * cc=0 normal completion
455 * cc=2 no file active on the virtual reader, and no file eligible
456 * cc=3 file already active on the virtual reader or specified virtual
457 * reader does not exist or is not a reader
459 static int diag_read_file(int devno, char *buf)
463 cc = diag14((unsigned long) buf, devno, 0x00);
476 static ssize_t diag14_read(struct file *file, char __user *ubuf, size_t count,
479 size_t len, copied, res;
485 urd = ((struct urfile *) file->private_data)->urd;
486 reclen = ((struct urfile *) file->private_data)->file_reclen;
488 rc = diag_position_to_record(urd->dev_id.devno, *offs / PAGE_SIZE + 1);
494 len = min((size_t) PAGE_SIZE, count);
495 buf = (char *) __get_free_page(GFP_KERNEL | GFP_DMA);
500 res = (size_t) (*offs % PAGE_SIZE);
502 rc = diag_read_file(urd->dev_id.devno, buf);
503 if (rc == -ENODATA) {
508 if (reclen && (copied == 0) && (*offs < PAGE_SIZE))
509 *((u16 *) &buf[FILE_RECLEN_OFFSET]) = reclen;
510 len = min(count - copied, PAGE_SIZE - res);
511 if (copy_to_user(ubuf + copied, buf + res, len)) {
517 } while (copied != count);
522 free_page((unsigned long) buf);
526 static ssize_t ur_read(struct file *file, char __user *ubuf, size_t count,
532 TRACE("ur_read: count=%zu ppos=%li\n", count, (unsigned long) *offs);
537 urd = ((struct urfile *) file->private_data)->urd;
538 rc = mutex_lock_interruptible(&urd->io_mutex);
541 rc = diag14_read(file, ubuf, count, offs);
542 mutex_unlock(&urd->io_mutex);
547 * diagnose code 0x14 subcode 0x0fff - retrieve next file descriptor
548 * cc=0 normal completion
549 * cc=1 no files on reader queue or no subsequent file
550 * cc=2 spid specified is invalid
552 static int diag_read_next_file_info(struct file_control_block *buf, int spid)
556 cc = diag14((unsigned long) buf, spid, 0xfff);
565 static int verify_uri_device(struct urdev *urd)
567 struct file_control_block *fcb;
571 fcb = kmalloc(sizeof(*fcb), GFP_KERNEL | GFP_DMA);
575 /* check for empty reader device (beginning of chain) */
576 rc = diag_read_next_file_info(fcb, 0);
580 /* if file is in hold status, we do not read it */
581 if (fcb->file_stat & (FLG_SYSTEM_HOLD | FLG_USER_HOLD)) {
586 /* open file on virtual reader */
587 buf = (char *) __get_free_page(GFP_KERNEL | GFP_DMA);
592 rc = diag_read_file(urd->dev_id.devno, buf);
593 if ((rc != 0) && (rc != -ENODATA)) /* EOF does not hurt */
596 /* check if the file on top of the queue is open now */
597 rc = diag_read_next_file_info(fcb, 0);
600 if (!(fcb->file_stat & FLG_IN_USE)) {
607 free_page((unsigned long) buf);
613 static int verify_device(struct urdev *urd)
615 switch (urd->class) {
617 return 0; /* no check needed here */
619 return verify_uri_device(urd);
625 static int get_uri_file_reclen(struct urdev *urd)
627 struct file_control_block *fcb;
630 fcb = kmalloc(sizeof(*fcb), GFP_KERNEL | GFP_DMA);
633 rc = diag_read_next_file_info(fcb, 0);
636 if (fcb->file_stat & FLG_CP_DUMP)
646 static int get_file_reclen(struct urdev *urd)
648 switch (urd->class) {
652 return get_uri_file_reclen(urd);
658 static int ur_open(struct inode *inode, struct file *file)
663 unsigned short accmode;
666 accmode = file->f_flags & O_ACCMODE;
668 if (accmode == O_RDWR)
672 * We treat the minor number as the devno of the ur device
673 * to find in the driver tree.
675 devno = MINOR(file->f_dentry->d_inode->i_rdev);
677 urd = urdev_get_from_devno(devno);
681 if (file->f_flags & O_NONBLOCK) {
682 if (!mutex_trylock(&urd->open_mutex)) {
687 if (mutex_lock_interruptible(&urd->open_mutex)) {
695 if (((accmode == O_RDONLY) && (urd->class != DEV_CLASS_UR_I)) ||
696 ((accmode == O_WRONLY) && (urd->class != DEV_CLASS_UR_O))) {
697 TRACE("ur_open: unsupported dev class (%d)\n", urd->class);
702 rc = verify_device(urd);
706 urf = urfile_alloc(urd);
712 urf->dev_reclen = urd->reclen;
713 rc = get_file_reclen(urd);
715 goto fail_urfile_free;
716 urf->file_reclen = rc;
717 file->private_data = urf;
723 mutex_unlock(&urd->open_mutex);
729 static int ur_release(struct inode *inode, struct file *file)
731 struct urfile *urf = file->private_data;
733 TRACE("ur_release\n");
734 mutex_unlock(&urf->urd->open_mutex);
740 static loff_t ur_llseek(struct file *file, loff_t offset, int whence)
744 if ((file->f_flags & O_ACCMODE) != O_RDONLY)
745 return -ESPIPE; /* seek allowed only for reader */
746 if (offset % PAGE_SIZE)
747 return -ESPIPE; /* only multiples of 4K allowed */
749 case 0: /* SEEK_SET */
752 case 1: /* SEEK_CUR */
753 newpos = file->f_pos + offset;
758 file->f_pos = newpos;
762 static const struct file_operations ur_fops = {
763 .owner = THIS_MODULE,
765 .release = ur_release,
772 * ccw_device infrastructure:
773 * ur_probe creates the struct urdev (with refcount = 1), the device
774 * attributes, sets up the interrupt handler and validates the virtual
775 * unit record device.
776 * ur_remove removes the device attributes and drops the reference to
779 * ur_probe, ur_remove, ur_set_online and ur_set_offline are serialized
780 * by the vmur_mutex lock.
782 * urd->char_device is used as indication that the online function has
783 * been completed successfully.
785 static int ur_probe(struct ccw_device *cdev)
790 TRACE("ur_probe: cdev=%p\n", cdev);
792 mutex_lock(&vmur_mutex);
793 urd = urdev_alloc(cdev);
799 rc = ur_create_attributes(&cdev->dev);
804 cdev->handler = ur_int_handler;
806 /* validate virtual unit record device */
807 urd->class = get_urd_class(urd);
808 if (urd->class < 0) {
810 goto fail_remove_attr;
812 if ((urd->class != DEV_CLASS_UR_I) && (urd->class != DEV_CLASS_UR_O)) {
814 goto fail_remove_attr;
816 spin_lock_irq(get_ccwdev_lock(cdev));
817 cdev->dev.driver_data = urd;
818 spin_unlock_irq(get_ccwdev_lock(cdev));
820 mutex_unlock(&vmur_mutex);
824 ur_remove_attributes(&cdev->dev);
828 mutex_unlock(&vmur_mutex);
832 static int ur_set_online(struct ccw_device *cdev)
835 int minor, major, rc;
838 TRACE("ur_set_online: cdev=%p\n", cdev);
840 mutex_lock(&vmur_mutex);
841 urd = urdev_get_from_cdev(cdev);
843 /* ur_remove already deleted our urd */
848 if (urd->char_device) {
849 /* Another ur_set_online was faster */
854 minor = urd->dev_id.devno;
855 major = MAJOR(ur_first_dev_maj_min);
857 urd->char_device = cdev_alloc();
858 if (!urd->char_device) {
863 cdev_init(urd->char_device, &ur_fops);
864 urd->char_device->dev = MKDEV(major, minor);
865 urd->char_device->owner = ur_fops.owner;
867 rc = cdev_add(urd->char_device, urd->char_device->dev, 1);
870 if (urd->cdev->id.cu_type == READER_PUNCH_DEVTYPE) {
871 if (urd->class == DEV_CLASS_UR_I)
872 sprintf(node_id, "vmrdr-%s", cdev->dev.bus_id);
873 if (urd->class == DEV_CLASS_UR_O)
874 sprintf(node_id, "vmpun-%s", cdev->dev.bus_id);
875 } else if (urd->cdev->id.cu_type == PRINTER_DEVTYPE) {
876 sprintf(node_id, "vmprt-%s", cdev->dev.bus_id);
882 urd->device = device_create(vmur_class, NULL, urd->char_device->dev,
884 if (IS_ERR(urd->device)) {
885 rc = PTR_ERR(urd->device);
886 TRACE("ur_set_online: device_create rc=%d\n", rc);
890 mutex_unlock(&vmur_mutex);
894 cdev_del(urd->char_device);
895 urd->char_device = NULL;
899 mutex_unlock(&vmur_mutex);
903 static int ur_set_offline_force(struct ccw_device *cdev, int force)
908 TRACE("ur_set_offline: cdev=%p\n", cdev);
909 urd = urdev_get_from_cdev(cdev);
911 /* ur_remove already deleted our urd */
913 if (!urd->char_device) {
914 /* Another ur_set_offline was faster */
918 if (!force && (atomic_read(&urd->ref_count) > 2)) {
919 /* There is still a user of urd (e.g. ur_open) */
920 TRACE("ur_set_offline: BUSY\n");
924 device_destroy(vmur_class, urd->char_device->dev);
925 cdev_del(urd->char_device);
926 urd->char_device = NULL;
934 static int ur_set_offline(struct ccw_device *cdev)
938 mutex_lock(&vmur_mutex);
939 rc = ur_set_offline_force(cdev, 0);
940 mutex_unlock(&vmur_mutex);
944 static void ur_remove(struct ccw_device *cdev)
948 TRACE("ur_remove\n");
950 mutex_lock(&vmur_mutex);
953 ur_set_offline_force(cdev, 1);
954 ur_remove_attributes(&cdev->dev);
956 spin_lock_irqsave(get_ccwdev_lock(cdev), flags);
957 urdev_put(cdev->dev.driver_data);
958 cdev->dev.driver_data = NULL;
959 spin_unlock_irqrestore(get_ccwdev_lock(cdev), flags);
961 mutex_unlock(&vmur_mutex);
965 * Module initialisation and cleanup
967 static int __init ur_init(void)
972 if (!MACHINE_IS_VM) {
973 PRINT_ERR("%s is only available under z/VM.\n", ur_banner);
977 vmur_dbf = debug_register("vmur", 4, 1, 4 * sizeof(long));
980 rc = debug_register_view(vmur_dbf, &debug_sprintf_view);
984 debug_set_level(vmur_dbf, 6);
986 rc = ccw_driver_register(&ur_driver);
990 rc = alloc_chrdev_region(&dev, 0, NUM_MINORS, "vmur");
992 PRINT_ERR("alloc_chrdev_region failed: err = %d\n", rc);
993 goto fail_unregister_driver;
995 ur_first_dev_maj_min = MKDEV(MAJOR(dev), 0);
997 vmur_class = class_create(THIS_MODULE, "vmur");
998 if (IS_ERR(vmur_class)) {
999 rc = PTR_ERR(vmur_class);
1000 goto fail_unregister_region;
1002 PRINT_INFO("%s loaded.\n", ur_banner);
1005 fail_unregister_region:
1006 unregister_chrdev_region(ur_first_dev_maj_min, NUM_MINORS);
1007 fail_unregister_driver:
1008 ccw_driver_unregister(&ur_driver);
1010 debug_unregister(vmur_dbf);
1014 static void __exit ur_exit(void)
1016 class_destroy(vmur_class);
1017 unregister_chrdev_region(ur_first_dev_maj_min, NUM_MINORS);
1018 ccw_driver_unregister(&ur_driver);
1019 debug_unregister(vmur_dbf);
1020 PRINT_INFO("%s unloaded.\n", ur_banner);
1023 module_init(ur_init);
1024 module_exit(ur_exit);