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 #define KMSG_COMPONENT "vmur"
12 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
14 #include <linux/cdev.h>
15 #include <linux/smp_lock.h>
17 #include <asm/uaccess.h>
19 #include <asm/ccwdev.h>
20 #include <asm/debug.h>
28 * Unit record device support is implemented as a character device driver.
29 * We can fit at least 16 bits into a device minor number and use the
30 * simple method of mapping a character device number with minor abcd
31 * to the unit record device with devno abcd.
32 * I/O to virtual unit record devices is handled as follows:
33 * Reads: Diagnose code 0x14 (input spool file manipulation)
34 * is used to read spool data page-wise.
35 * Writes: The CCW used is WRITE_CCW_CMD (0x01). The device's record length
36 * is available by reading sysfs attr reclen. Each write() to the device
37 * must specify an integral multiple (maximal 511) of reclen.
40 static char ur_banner[] = "z/VM virtual unit record device driver";
42 MODULE_AUTHOR("IBM Corporation");
43 MODULE_DESCRIPTION("s390 z/VM virtual unit record device driver");
44 MODULE_LICENSE("GPL");
46 static dev_t ur_first_dev_maj_min;
47 static struct class *vmur_class;
48 static struct debug_info *vmur_dbf;
50 /* We put the device's record length (for writes) in the driver_info field */
51 static struct ccw_device_id ur_ids[] = {
52 { CCWDEV_CU_DI(READER_PUNCH_DEVTYPE, 80) },
53 { CCWDEV_CU_DI(PRINTER_DEVTYPE, 132) },
57 MODULE_DEVICE_TABLE(ccw, ur_ids);
59 static int ur_probe(struct ccw_device *cdev);
60 static void ur_remove(struct ccw_device *cdev);
61 static int ur_set_online(struct ccw_device *cdev);
62 static int ur_set_offline(struct ccw_device *cdev);
64 static struct ccw_driver ur_driver = {
70 .set_online = ur_set_online,
71 .set_offline = ur_set_offline,
74 static DEFINE_MUTEX(vmur_mutex);
77 * Allocation, freeing, getting and putting of urdev structures
79 * Each ur device (urd) contains a reference to its corresponding ccw device
80 * (cdev) using the urd->cdev pointer. Each ccw device has a reference to the
81 * ur device using the cdev->dev.driver_data pointer.
84 * - ur_probe gets a urd reference, ur_remove drops the reference
85 * (cdev->dev.driver_data)
86 * - ur_open gets a urd reference, ur_relase drops the reference
90 * - urdev_alloc get a cdev reference (urd->cdev)
91 * - urdev_free drops the cdev reference (urd->cdev)
93 * Setting and clearing of cdev->dev.driver_data is protected by the ccwdev lock
95 static struct urdev *urdev_alloc(struct ccw_device *cdev)
99 urd = kzalloc(sizeof(struct urdev), GFP_KERNEL);
102 urd->reclen = cdev->id.driver_info;
103 ccw_device_get_id(cdev, &urd->dev_id);
104 mutex_init(&urd->io_mutex);
105 init_waitqueue_head(&urd->wait);
106 spin_lock_init(&urd->open_lock);
107 atomic_set(&urd->ref_count, 1);
109 get_device(&cdev->dev);
113 static void urdev_free(struct urdev *urd)
115 TRACE("urdev_free: %p\n", urd);
117 put_device(&urd->cdev->dev);
121 static void urdev_get(struct urdev *urd)
123 atomic_inc(&urd->ref_count);
126 static struct urdev *urdev_get_from_cdev(struct ccw_device *cdev)
131 spin_lock_irqsave(get_ccwdev_lock(cdev), flags);
132 urd = cdev->dev.driver_data;
135 spin_unlock_irqrestore(get_ccwdev_lock(cdev), flags);
139 static struct urdev *urdev_get_from_devno(u16 devno)
142 struct ccw_device *cdev;
145 sprintf(bus_id, "0.0.%04x", devno);
146 cdev = get_ccwdev_by_busid(&ur_driver, bus_id);
149 urd = urdev_get_from_cdev(cdev);
150 put_device(&cdev->dev);
154 static void urdev_put(struct urdev *urd)
156 if (atomic_dec_and_test(&urd->ref_count))
161 * Low-level functions to do I/O to a ur device.
167 * alloc_chan_prog allocates and builds the channel program
168 * free_chan_prog frees memory of the channel program
170 * do_ur_io issues the channel program to the device and blocks waiting
171 * on a completion event it publishes at urd->io_done. The function
172 * serialises itself on the device's mutex so that only one I/O
173 * is issued at a time (and that I/O is synchronous).
175 * ur_int_handler catches the "I/O done" interrupt, writes the
176 * subchannel status word into the scsw member of the urdev structure
177 * and complete()s the io_done to wake the waiting do_ur_io.
179 * The caller of do_ur_io is responsible for kfree()ing the channel program
180 * address pointer that alloc_chan_prog returned.
183 static void free_chan_prog(struct ccw1 *cpa)
185 struct ccw1 *ptr = cpa;
188 kfree((void *)(addr_t) ptr->cda);
196 * The channel program we use is write commands chained together
197 * with a final NOP CCW command-chained on (which ensures that CE and DE
198 * are presented together in a single interrupt instead of as separate
199 * interrupts unless an incorrect length indication kicks in first). The
200 * data length in each CCW is reclen.
202 static struct ccw1 *alloc_chan_prog(const char __user *ubuf, int rec_count,
209 TRACE("alloc_chan_prog(%p, %i, %i)\n", ubuf, rec_count, reclen);
212 * We chain a NOP onto the writes to force CE+DE together.
213 * That means we allocate room for CCWs to cover count/reclen
214 * records plus a NOP.
216 cpa = kzalloc((rec_count + 1) * sizeof(struct ccw1),
217 GFP_KERNEL | GFP_DMA);
219 return ERR_PTR(-ENOMEM);
221 for (i = 0; i < rec_count; i++) {
222 cpa[i].cmd_code = WRITE_CCW_CMD;
223 cpa[i].flags = CCW_FLAG_CC | CCW_FLAG_SLI;
224 cpa[i].count = reclen;
225 kbuf = kmalloc(reclen, GFP_KERNEL | GFP_DMA);
228 return ERR_PTR(-ENOMEM);
230 cpa[i].cda = (u32)(addr_t) kbuf;
231 if (copy_from_user(kbuf, ubuf, reclen)) {
233 return ERR_PTR(-EFAULT);
237 /* The following NOP CCW forces CE+DE to be presented together */
238 cpa[i].cmd_code = CCW_CMD_NOOP;
242 static int do_ur_io(struct urdev *urd, struct ccw1 *cpa)
245 struct ccw_device *cdev = urd->cdev;
246 DECLARE_COMPLETION_ONSTACK(event);
248 TRACE("do_ur_io: cpa=%p\n", cpa);
250 rc = mutex_lock_interruptible(&urd->io_mutex);
254 urd->io_done = &event;
256 spin_lock_irq(get_ccwdev_lock(cdev));
257 rc = ccw_device_start(cdev, cpa, 1, 0, 0);
258 spin_unlock_irq(get_ccwdev_lock(cdev));
260 TRACE("do_ur_io: ccw_device_start returned %d\n", rc);
264 wait_for_completion(&event);
265 TRACE("do_ur_io: I/O complete\n");
269 mutex_unlock(&urd->io_mutex);
274 * ur interrupt handler, called from the ccw_device layer
276 static void ur_int_handler(struct ccw_device *cdev, unsigned long intparm,
281 TRACE("ur_int_handler: intparm=0x%lx cstat=%02x dstat=%02x res=%u\n",
282 intparm, irb->scsw.cmd.cstat, irb->scsw.cmd.dstat,
283 irb->scsw.cmd.count);
286 TRACE("ur_int_handler: unsolicited interrupt\n");
289 urd = cdev->dev.driver_data;
291 /* On special conditions irb is an error pointer */
293 urd->io_request_rc = PTR_ERR(irb);
294 else if (irb->scsw.cmd.dstat == (DEV_STAT_CHN_END | DEV_STAT_DEV_END))
295 urd->io_request_rc = 0;
297 urd->io_request_rc = -EIO;
299 complete(urd->io_done);
303 * reclen sysfs attribute - The record length to be used for write CCWs
305 static ssize_t ur_attr_reclen_show(struct device *dev,
306 struct device_attribute *attr, char *buf)
311 urd = urdev_get_from_cdev(to_ccwdev(dev));
314 rc = sprintf(buf, "%zu\n", urd->reclen);
319 static DEVICE_ATTR(reclen, 0444, ur_attr_reclen_show, NULL);
321 static int ur_create_attributes(struct device *dev)
323 return device_create_file(dev, &dev_attr_reclen);
326 static void ur_remove_attributes(struct device *dev)
328 device_remove_file(dev, &dev_attr_reclen);
332 * diagnose code 0x210 - retrieve device information
333 * cc=0 normal completion, we have a real device
334 * cc=1 CP paging error
335 * cc=2 The virtual device exists, but is not associated with a real device
336 * cc=3 Invalid device address, or the virtual device does not exist
338 static int get_urd_class(struct urdev *urd)
340 static struct diag210 ur_diag210;
343 ur_diag210.vrdcdvno = urd->dev_id.devno;
344 ur_diag210.vrdclen = sizeof(struct diag210);
346 cc = diag210(&ur_diag210);
351 return ur_diag210.vrdcvcla; /* virtual device class */
360 * Allocation and freeing of urfile structures
362 static struct urfile *urfile_alloc(struct urdev *urd)
366 urf = kzalloc(sizeof(struct urfile), GFP_KERNEL);
371 TRACE("urfile_alloc: urd=%p urf=%p rl=%zu\n", urd, urf,
377 static void urfile_free(struct urfile *urf)
379 TRACE("urfile_free: urf=%p urd=%p\n", urf, urf->urd);
384 * The fops implementation of the character device driver
386 static ssize_t do_write(struct urdev *urd, const char __user *udata,
387 size_t count, size_t reclen, loff_t *ppos)
392 cpa = alloc_chan_prog(udata, count / reclen, reclen);
396 rc = do_ur_io(urd, cpa);
400 if (urd->io_request_rc) {
401 rc = urd->io_request_rc;
412 static ssize_t ur_write(struct file *file, const char __user *udata,
413 size_t count, loff_t *ppos)
415 struct urfile *urf = file->private_data;
417 TRACE("ur_write: count=%zu\n", count);
422 if (count % urf->dev_reclen)
423 return -EINVAL; /* count must be a multiple of reclen */
425 if (count > urf->dev_reclen * MAX_RECS_PER_IO)
426 count = urf->dev_reclen * MAX_RECS_PER_IO;
428 return do_write(urf->urd, udata, count, urf->dev_reclen, ppos);
432 * diagnose code 0x14 subcode 0x0028 - position spool file to designated
434 * cc=0 normal completion
435 * cc=2 no file active on the virtual reader or device not ready
436 * cc=3 record specified is beyond EOF
438 static int diag_position_to_record(int devno, int record)
442 cc = diag14(record, devno, 0x28);
449 return -ENODATA; /* position beyond end of file */
456 * diagnose code 0x14 subcode 0x0000 - read next spool file buffer
457 * cc=0 normal completion
459 * cc=2 no file active on the virtual reader, and no file eligible
460 * cc=3 file already active on the virtual reader or specified virtual
461 * reader does not exist or is not a reader
463 static int diag_read_file(int devno, char *buf)
467 cc = diag14((unsigned long) buf, devno, 0x00);
480 static ssize_t diag14_read(struct file *file, char __user *ubuf, size_t count,
483 size_t len, copied, res;
489 urd = ((struct urfile *) file->private_data)->urd;
490 reclen = ((struct urfile *) file->private_data)->file_reclen;
492 rc = diag_position_to_record(urd->dev_id.devno, *offs / PAGE_SIZE + 1);
498 len = min((size_t) PAGE_SIZE, count);
499 buf = (char *) __get_free_page(GFP_KERNEL | GFP_DMA);
504 res = (size_t) (*offs % PAGE_SIZE);
506 rc = diag_read_file(urd->dev_id.devno, buf);
507 if (rc == -ENODATA) {
512 if (reclen && (copied == 0) && (*offs < PAGE_SIZE))
513 *((u16 *) &buf[FILE_RECLEN_OFFSET]) = reclen;
514 len = min(count - copied, PAGE_SIZE - res);
515 if (copy_to_user(ubuf + copied, buf + res, len)) {
521 } while (copied != count);
526 free_page((unsigned long) buf);
530 static ssize_t ur_read(struct file *file, char __user *ubuf, size_t count,
536 TRACE("ur_read: count=%zu ppos=%li\n", count, (unsigned long) *offs);
541 urd = ((struct urfile *) file->private_data)->urd;
542 rc = mutex_lock_interruptible(&urd->io_mutex);
545 rc = diag14_read(file, ubuf, count, offs);
546 mutex_unlock(&urd->io_mutex);
551 * diagnose code 0x14 subcode 0x0fff - retrieve next file descriptor
552 * cc=0 normal completion
553 * cc=1 no files on reader queue or no subsequent file
554 * cc=2 spid specified is invalid
556 static int diag_read_next_file_info(struct file_control_block *buf, int spid)
560 cc = diag14((unsigned long) buf, spid, 0xfff);
569 static int verify_uri_device(struct urdev *urd)
571 struct file_control_block *fcb;
575 fcb = kmalloc(sizeof(*fcb), GFP_KERNEL | GFP_DMA);
579 /* check for empty reader device (beginning of chain) */
580 rc = diag_read_next_file_info(fcb, 0);
584 /* if file is in hold status, we do not read it */
585 if (fcb->file_stat & (FLG_SYSTEM_HOLD | FLG_USER_HOLD)) {
590 /* open file on virtual reader */
591 buf = (char *) __get_free_page(GFP_KERNEL | GFP_DMA);
596 rc = diag_read_file(urd->dev_id.devno, buf);
597 if ((rc != 0) && (rc != -ENODATA)) /* EOF does not hurt */
600 /* check if the file on top of the queue is open now */
601 rc = diag_read_next_file_info(fcb, 0);
604 if (!(fcb->file_stat & FLG_IN_USE)) {
611 free_page((unsigned long) buf);
617 static int verify_device(struct urdev *urd)
619 switch (urd->class) {
621 return 0; /* no check needed here */
623 return verify_uri_device(urd);
629 static int get_uri_file_reclen(struct urdev *urd)
631 struct file_control_block *fcb;
634 fcb = kmalloc(sizeof(*fcb), GFP_KERNEL | GFP_DMA);
637 rc = diag_read_next_file_info(fcb, 0);
640 if (fcb->file_stat & FLG_CP_DUMP)
650 static int get_file_reclen(struct urdev *urd)
652 switch (urd->class) {
656 return get_uri_file_reclen(urd);
662 static int ur_open(struct inode *inode, struct file *file)
667 unsigned short accmode;
670 accmode = file->f_flags & O_ACCMODE;
672 if (accmode == O_RDWR)
676 * We treat the minor number as the devno of the ur device
677 * to find in the driver tree.
679 devno = MINOR(file->f_dentry->d_inode->i_rdev);
681 urd = urdev_get_from_devno(devno);
687 spin_lock(&urd->open_lock);
688 while (urd->open_flag) {
689 spin_unlock(&urd->open_lock);
690 if (file->f_flags & O_NONBLOCK) {
694 if (wait_event_interruptible(urd->wait, urd->open_flag == 0)) {
698 spin_lock(&urd->open_lock);
701 spin_unlock(&urd->open_lock);
705 if (((accmode == O_RDONLY) && (urd->class != DEV_CLASS_UR_I)) ||
706 ((accmode == O_WRONLY) && (urd->class != DEV_CLASS_UR_O))) {
707 TRACE("ur_open: unsupported dev class (%d)\n", urd->class);
712 rc = verify_device(urd);
716 urf = urfile_alloc(urd);
722 urf->dev_reclen = urd->reclen;
723 rc = get_file_reclen(urd);
725 goto fail_urfile_free;
726 urf->file_reclen = rc;
727 file->private_data = urf;
734 spin_lock(&urd->open_lock);
736 spin_unlock(&urd->open_lock);
744 static int ur_release(struct inode *inode, struct file *file)
746 struct urfile *urf = file->private_data;
748 TRACE("ur_release\n");
749 spin_lock(&urf->urd->open_lock);
750 urf->urd->open_flag--;
751 spin_unlock(&urf->urd->open_lock);
752 wake_up_interruptible(&urf->urd->wait);
758 static loff_t ur_llseek(struct file *file, loff_t offset, int whence)
762 if ((file->f_flags & O_ACCMODE) != O_RDONLY)
763 return -ESPIPE; /* seek allowed only for reader */
764 if (offset % PAGE_SIZE)
765 return -ESPIPE; /* only multiples of 4K allowed */
767 case 0: /* SEEK_SET */
770 case 1: /* SEEK_CUR */
771 newpos = file->f_pos + offset;
776 file->f_pos = newpos;
780 static const struct file_operations ur_fops = {
781 .owner = THIS_MODULE,
783 .release = ur_release,
790 * ccw_device infrastructure:
791 * ur_probe creates the struct urdev (with refcount = 1), the device
792 * attributes, sets up the interrupt handler and validates the virtual
793 * unit record device.
794 * ur_remove removes the device attributes and drops the reference to
797 * ur_probe, ur_remove, ur_set_online and ur_set_offline are serialized
798 * by the vmur_mutex lock.
800 * urd->char_device is used as indication that the online function has
801 * been completed successfully.
803 static int ur_probe(struct ccw_device *cdev)
808 TRACE("ur_probe: cdev=%p\n", cdev);
810 mutex_lock(&vmur_mutex);
811 urd = urdev_alloc(cdev);
817 rc = ur_create_attributes(&cdev->dev);
822 cdev->handler = ur_int_handler;
824 /* validate virtual unit record device */
825 urd->class = get_urd_class(urd);
826 if (urd->class < 0) {
828 goto fail_remove_attr;
830 if ((urd->class != DEV_CLASS_UR_I) && (urd->class != DEV_CLASS_UR_O)) {
832 goto fail_remove_attr;
834 spin_lock_irq(get_ccwdev_lock(cdev));
835 cdev->dev.driver_data = urd;
836 spin_unlock_irq(get_ccwdev_lock(cdev));
838 mutex_unlock(&vmur_mutex);
842 ur_remove_attributes(&cdev->dev);
846 mutex_unlock(&vmur_mutex);
850 static int ur_set_online(struct ccw_device *cdev)
853 int minor, major, rc;
856 TRACE("ur_set_online: cdev=%p\n", cdev);
858 mutex_lock(&vmur_mutex);
859 urd = urdev_get_from_cdev(cdev);
861 /* ur_remove already deleted our urd */
866 if (urd->char_device) {
867 /* Another ur_set_online was faster */
872 minor = urd->dev_id.devno;
873 major = MAJOR(ur_first_dev_maj_min);
875 urd->char_device = cdev_alloc();
876 if (!urd->char_device) {
881 cdev_init(urd->char_device, &ur_fops);
882 urd->char_device->dev = MKDEV(major, minor);
883 urd->char_device->owner = ur_fops.owner;
885 rc = cdev_add(urd->char_device, urd->char_device->dev, 1);
888 if (urd->cdev->id.cu_type == READER_PUNCH_DEVTYPE) {
889 if (urd->class == DEV_CLASS_UR_I)
890 sprintf(node_id, "vmrdr-%s", dev_name(&cdev->dev));
891 if (urd->class == DEV_CLASS_UR_O)
892 sprintf(node_id, "vmpun-%s", dev_name(&cdev->dev));
893 } else if (urd->cdev->id.cu_type == PRINTER_DEVTYPE) {
894 sprintf(node_id, "vmprt-%s", dev_name(&cdev->dev));
900 urd->device = device_create(vmur_class, NULL, urd->char_device->dev,
901 NULL, "%s", node_id);
902 if (IS_ERR(urd->device)) {
903 rc = PTR_ERR(urd->device);
904 TRACE("ur_set_online: device_create rc=%d\n", rc);
908 mutex_unlock(&vmur_mutex);
912 cdev_del(urd->char_device);
913 urd->char_device = NULL;
917 mutex_unlock(&vmur_mutex);
921 static int ur_set_offline_force(struct ccw_device *cdev, int force)
926 TRACE("ur_set_offline: cdev=%p\n", cdev);
927 urd = urdev_get_from_cdev(cdev);
929 /* ur_remove already deleted our urd */
931 if (!urd->char_device) {
932 /* Another ur_set_offline was faster */
936 if (!force && (atomic_read(&urd->ref_count) > 2)) {
937 /* There is still a user of urd (e.g. ur_open) */
938 TRACE("ur_set_offline: BUSY\n");
942 device_destroy(vmur_class, urd->char_device->dev);
943 cdev_del(urd->char_device);
944 urd->char_device = NULL;
952 static int ur_set_offline(struct ccw_device *cdev)
956 mutex_lock(&vmur_mutex);
957 rc = ur_set_offline_force(cdev, 0);
958 mutex_unlock(&vmur_mutex);
962 static void ur_remove(struct ccw_device *cdev)
966 TRACE("ur_remove\n");
968 mutex_lock(&vmur_mutex);
971 ur_set_offline_force(cdev, 1);
972 ur_remove_attributes(&cdev->dev);
974 spin_lock_irqsave(get_ccwdev_lock(cdev), flags);
975 urdev_put(cdev->dev.driver_data);
976 cdev->dev.driver_data = NULL;
977 spin_unlock_irqrestore(get_ccwdev_lock(cdev), flags);
979 mutex_unlock(&vmur_mutex);
983 * Module initialisation and cleanup
985 static int __init ur_init(void)
990 if (!MACHINE_IS_VM) {
991 pr_err("The %s cannot be loaded without z/VM\n",
996 vmur_dbf = debug_register("vmur", 4, 1, 4 * sizeof(long));
999 rc = debug_register_view(vmur_dbf, &debug_sprintf_view);
1003 debug_set_level(vmur_dbf, 6);
1005 rc = ccw_driver_register(&ur_driver);
1009 rc = alloc_chrdev_region(&dev, 0, NUM_MINORS, "vmur");
1011 pr_err("Kernel function alloc_chrdev_region failed with "
1012 "error code %d\n", rc);
1013 goto fail_unregister_driver;
1015 ur_first_dev_maj_min = MKDEV(MAJOR(dev), 0);
1017 vmur_class = class_create(THIS_MODULE, "vmur");
1018 if (IS_ERR(vmur_class)) {
1019 rc = PTR_ERR(vmur_class);
1020 goto fail_unregister_region;
1022 pr_info("%s loaded.\n", ur_banner);
1025 fail_unregister_region:
1026 unregister_chrdev_region(ur_first_dev_maj_min, NUM_MINORS);
1027 fail_unregister_driver:
1028 ccw_driver_unregister(&ur_driver);
1030 debug_unregister(vmur_dbf);
1034 static void __exit ur_exit(void)
1036 class_destroy(vmur_class);
1037 unregister_chrdev_region(ur_first_dev_maj_min, NUM_MINORS);
1038 ccw_driver_unregister(&ur_driver);
1039 debug_unregister(vmur_dbf);
1040 pr_info("%s unloaded.\n", ur_banner);
1043 module_init(ur_init);
1044 module_exit(ur_exit);