2 * drivers/cdrom/viocd.c
4 * iSeries Virtual CD Rom
6 * Authors: Dave Boutcher <boutcher@us.ibm.com>
7 * Ryan Arnold <ryanarn@us.ibm.com>
8 * Colin Devilbiss <devilbis@us.ibm.com>
9 * Stephen Rothwell <sfr@au1.ibm.com>
11 * (C) Copyright 2000-2004 IBM Corporation
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License as
15 * published by the Free Software Foundation; either version 2 of the
16 * License, or (at your option) anyu later version.
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software Foundation,
25 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 * This routine provides access to CD ROM drives owned and managed by an
28 * OS/400 partition running on the same box as this Linux partition.
30 * All operations are performed by sending messages back and forth to
31 * the OS/400 partition.
34 #include <linux/major.h>
35 #include <linux/blkdev.h>
36 #include <linux/cdrom.h>
37 #include <linux/errno.h>
38 #include <linux/init.h>
39 #include <linux/dma-mapping.h>
40 #include <linux/module.h>
41 #include <linux/completion.h>
42 #include <linux/proc_fs.h>
43 #include <linux/seq_file.h>
44 #include <linux/scatterlist.h>
47 #include <asm/iseries/hv_types.h>
48 #include <asm/iseries/hv_lp_event.h>
49 #include <asm/iseries/vio.h>
50 #include <asm/firmware.h>
52 #define VIOCD_DEVICE "iseries/vcd"
54 #define VIOCD_VERS "1.06"
56 #define VIOCD_KERN_WARNING KERN_WARNING "viocd: "
57 #define VIOCD_KERN_INFO KERN_INFO "viocd: "
60 * Should probably make this a module parameter....sigh
62 #define VIOCD_MAX_CD HVMAXARCHITECTEDVIRTUALCDROMS
64 static const struct vio_error_entry viocd_err_table[] = {
65 {0x0201, EINVAL, "Invalid Range"},
66 {0x0202, EINVAL, "Invalid Token"},
67 {0x0203, EIO, "DMA Error"},
68 {0x0204, EIO, "Use Error"},
69 {0x0205, EIO, "Release Error"},
70 {0x0206, EINVAL, "Invalid CD"},
71 {0x020C, EROFS, "Read Only Device"},
72 {0x020D, ENOMEDIUM, "Changed or Missing Volume (or Varied Off?)"},
73 {0x020E, EIO, "Optical System Error (Varied Off?)"},
74 {0x02FF, EIO, "Internal Error"},
75 {0x3010, EIO, "Changed Volume"},
76 {0xC100, EIO, "Optical System Error"},
81 * This is the structure we use to exchange info between driver and interrupt
84 struct viocd_waitevent {
85 struct completion com;
91 /* this is a lookup table for the true capabilities of a device */
92 struct capability_entry {
97 static struct capability_entry capability_table[] __initdata = {
98 { "6330", CDC_LOCK | CDC_DVD_RAM | CDC_RAM },
99 { "6331", CDC_LOCK | CDC_DVD_RAM | CDC_RAM },
100 { "6333", CDC_LOCK | CDC_DVD_RAM | CDC_RAM },
101 { "632A", CDC_LOCK | CDC_DVD_RAM | CDC_RAM },
102 { "6321", CDC_LOCK },
107 /* These are our internal structures for keeping track of devices */
108 static int viocd_numdev;
111 struct gendisk *viocd_disk;
112 struct cdrom_device_info viocd_info;
114 const char *rsrcname;
118 static struct disk_info viocd_diskinfo[VIOCD_MAX_CD];
120 #define DEVICE_NR(di) ((di) - &viocd_diskinfo[0])
122 static spinlock_t viocd_reqlock;
127 static int proc_viocd_show(struct seq_file *m, void *v)
131 for (i = 0; i < viocd_numdev; i++) {
132 seq_printf(m, "viocd device %d is iSeries resource %10.10s"
133 "type %4.4s, model %3.3s\n",
134 i, viocd_diskinfo[i].rsrcname,
135 viocd_diskinfo[i].type,
136 viocd_diskinfo[i].model);
141 static int proc_viocd_open(struct inode *inode, struct file *file)
143 return single_open(file, proc_viocd_show, NULL);
146 static const struct file_operations proc_viocd_operations = {
147 .owner = THIS_MODULE,
148 .open = proc_viocd_open,
151 .release = single_release,
154 static int viocd_blk_open(struct inode *inode, struct file *file)
156 struct disk_info *di = inode->i_bdev->bd_disk->private_data;
157 return cdrom_open(&di->viocd_info, inode, file);
160 static int viocd_blk_release(struct inode *inode, struct file *file)
162 struct disk_info *di = inode->i_bdev->bd_disk->private_data;
163 return cdrom_release(&di->viocd_info, file);
166 static int viocd_blk_ioctl(struct inode *inode, struct file *file,
167 unsigned cmd, unsigned long arg)
169 struct disk_info *di = inode->i_bdev->bd_disk->private_data;
170 return cdrom_ioctl(file, &di->viocd_info, inode, cmd, arg);
173 static int viocd_blk_media_changed(struct gendisk *disk)
175 struct disk_info *di = disk->private_data;
176 return cdrom_media_changed(&di->viocd_info);
179 struct block_device_operations viocd_fops = {
180 .owner = THIS_MODULE,
181 .open = viocd_blk_open,
182 .release = viocd_blk_release,
183 .ioctl = viocd_blk_ioctl,
184 .media_changed = viocd_blk_media_changed,
187 static int viocd_open(struct cdrom_device_info *cdi, int purpose)
189 struct disk_info *diskinfo = cdi->handle;
190 int device_no = DEVICE_NR(diskinfo);
192 struct viocd_waitevent we;
194 init_completion(&we.com);
195 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
196 HvLpEvent_Type_VirtualIo,
197 viomajorsubtype_cdio | viocdopen,
198 HvLpEvent_AckInd_DoAck, HvLpEvent_AckType_ImmediateAck,
199 viopath_sourceinst(viopath_hostLp),
200 viopath_targetinst(viopath_hostLp),
201 (u64)&we, VIOVERSION << 16, ((u64)device_no << 48),
204 printk(VIOCD_KERN_WARNING
205 "bad rc on HvCallEvent_signalLpEventFast %d\n",
210 wait_for_completion(&we.com);
213 const struct vio_error_entry *err =
214 vio_lookup_rc(viocd_err_table, we.sub_result);
215 printk(VIOCD_KERN_WARNING "bad rc %d:0x%04X on open: %s\n",
216 we.rc, we.sub_result, err->msg);
223 static void viocd_release(struct cdrom_device_info *cdi)
225 int device_no = DEVICE_NR((struct disk_info *)cdi->handle);
228 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
229 HvLpEvent_Type_VirtualIo,
230 viomajorsubtype_cdio | viocdclose,
231 HvLpEvent_AckInd_NoAck, HvLpEvent_AckType_ImmediateAck,
232 viopath_sourceinst(viopath_hostLp),
233 viopath_targetinst(viopath_hostLp), 0,
234 VIOVERSION << 16, ((u64)device_no << 48), 0, 0, 0);
236 printk(VIOCD_KERN_WARNING
237 "bad rc on HvCallEvent_signalLpEventFast %d\n",
241 /* Send a read or write request to OS/400 */
242 static int send_request(struct request *req)
245 struct disk_info *diskinfo = req->rq_disk->private_data;
250 struct scatterlist sg;
252 BUG_ON(req->nr_phys_segments > 1);
254 if (rq_data_dir(req) == READ) {
255 direction = DMA_FROM_DEVICE;
256 cmd = viomajorsubtype_cdio | viocdread;
258 direction = DMA_TO_DEVICE;
259 cmd = viomajorsubtype_cdio | viocdwrite;
262 sg_init_table(&sg, 1);
263 if (blk_rq_map_sg(req->q, req, &sg) == 0) {
264 printk(VIOCD_KERN_WARNING
265 "error setting up scatter/gather list\n");
269 if (dma_map_sg(diskinfo->dev, &sg, 1, direction) == 0) {
270 printk(VIOCD_KERN_WARNING "error allocating sg tce\n");
273 dmaaddr = sg_dma_address(&sg);
274 len = sg_dma_len(&sg);
276 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
277 HvLpEvent_Type_VirtualIo, cmd,
278 HvLpEvent_AckInd_DoAck,
279 HvLpEvent_AckType_ImmediateAck,
280 viopath_sourceinst(viopath_hostLp),
281 viopath_targetinst(viopath_hostLp),
282 (u64)req, VIOVERSION << 16,
283 ((u64)DEVICE_NR(diskinfo) << 48) | dmaaddr,
284 (u64)req->sector * 512, len, 0);
285 if (hvrc != HvLpEvent_Rc_Good) {
286 printk(VIOCD_KERN_WARNING "hv error on op %d\n", (int)hvrc);
293 static void viocd_end_request(struct request *req, int error)
295 int nsectors = req->hard_nr_sectors;
298 * Make sure it's fully ended, and ensure that we process
299 * at least one sector.
301 if (blk_pc_request(req))
302 nsectors = (req->data_len + 511) >> 9;
306 if (__blk_end_request(req, error, nsectors << 9))
312 static void do_viocd_request(struct request_queue *q)
316 while ((rwreq == 0) && ((req = elv_next_request(q)) != NULL)) {
317 if (!blk_fs_request(req))
318 viocd_end_request(req, -EIO);
319 else if (send_request(req) < 0) {
320 printk(VIOCD_KERN_WARNING
321 "unable to send message to OS/400!");
322 viocd_end_request(req, -EIO);
328 static int viocd_media_changed(struct cdrom_device_info *cdi, int disc_nr)
330 struct viocd_waitevent we;
332 int device_no = DEVICE_NR((struct disk_info *)cdi->handle);
334 init_completion(&we.com);
336 /* Send the open event to OS/400 */
337 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
338 HvLpEvent_Type_VirtualIo,
339 viomajorsubtype_cdio | viocdcheck,
340 HvLpEvent_AckInd_DoAck, HvLpEvent_AckType_ImmediateAck,
341 viopath_sourceinst(viopath_hostLp),
342 viopath_targetinst(viopath_hostLp),
343 (u64)&we, VIOVERSION << 16, ((u64)device_no << 48),
346 printk(VIOCD_KERN_WARNING "bad rc on HvCallEvent_signalLpEventFast %d\n",
351 wait_for_completion(&we.com);
353 /* Check the return code. If bad, assume no change */
355 const struct vio_error_entry *err =
356 vio_lookup_rc(viocd_err_table, we.sub_result);
357 printk(VIOCD_KERN_WARNING
358 "bad rc %d:0x%04X on check_change: %s; Assuming no change\n",
359 we.rc, we.sub_result, err->msg);
366 static int viocd_lock_door(struct cdrom_device_info *cdi, int locking)
369 u64 device_no = DEVICE_NR((struct disk_info *)cdi->handle);
370 /* NOTE: flags is 1 or 0 so it won't overwrite the device_no */
371 u64 flags = !!locking;
372 struct viocd_waitevent we;
374 init_completion(&we.com);
376 /* Send the lockdoor event to OS/400 */
377 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
378 HvLpEvent_Type_VirtualIo,
379 viomajorsubtype_cdio | viocdlockdoor,
380 HvLpEvent_AckInd_DoAck, HvLpEvent_AckType_ImmediateAck,
381 viopath_sourceinst(viopath_hostLp),
382 viopath_targetinst(viopath_hostLp),
383 (u64)&we, VIOVERSION << 16,
384 (device_no << 48) | (flags << 32), 0, 0, 0);
386 printk(VIOCD_KERN_WARNING "bad rc on HvCallEvent_signalLpEventFast %d\n",
391 wait_for_completion(&we.com);
398 static int viocd_packet(struct cdrom_device_info *cdi,
399 struct packet_command *cgc)
401 unsigned int buflen = cgc->buflen;
404 switch (cgc->cmd[0]) {
405 case GPCMD_READ_DISC_INFO:
407 disc_information *di = (disc_information *)cgc->buffer;
410 di->disc_information_length = cpu_to_be16(1);
415 (cdi->ops->capability & ~cdi->mask
416 & (CDC_DVD_RAM | CDC_RAM)) != 0;
419 case GPCMD_GET_CONFIGURATION:
420 if (cgc->cmd[3] == CDF_RWRT) {
421 struct rwrt_feature_desc *rfd = (struct rwrt_feature_desc *)(cgc->buffer + sizeof(struct feature_header));
424 (sizeof(struct feature_header) + sizeof(*rfd))) &&
425 (cdi->ops->capability & ~cdi->mask
426 & (CDC_DVD_RAM | CDC_RAM))) {
427 rfd->feature_code = cpu_to_be16(CDF_RWRT);
435 /* indicate Unknown code */
436 cgc->sense->sense_key = 0x05;
437 cgc->sense->asc = 0x20;
438 cgc->sense->ascq = 0x00;
447 static void restart_all_queues(int first_index)
451 for (i = first_index + 1; i < viocd_numdev; i++)
452 if (viocd_diskinfo[i].viocd_disk)
453 blk_run_queue(viocd_diskinfo[i].viocd_disk->queue);
454 for (i = 0; i <= first_index; i++)
455 if (viocd_diskinfo[i].viocd_disk)
456 blk_run_queue(viocd_diskinfo[i].viocd_disk->queue);
459 /* This routine handles incoming CD LP events */
460 static void vio_handle_cd_event(struct HvLpEvent *event)
462 struct viocdlpevent *bevent;
463 struct viocd_waitevent *pwe;
464 struct disk_info *di;
470 /* Notification that a partition went away! */
472 /* First, we should NEVER get an int here...only acks */
473 if (hvlpevent_is_int(event)) {
474 printk(VIOCD_KERN_WARNING
475 "Yikes! got an int in viocd event handler!\n");
476 if (hvlpevent_need_ack(event)) {
477 event->xRc = HvLpEvent_Rc_InvalidSubtype;
478 HvCallEvent_ackLpEvent(event);
482 bevent = (struct viocdlpevent *)event;
484 switch (event->xSubtype & VIOMINOR_SUBTYPE_MASK) {
486 if (event->xRc == 0) {
487 di = &viocd_diskinfo[bevent->disk];
488 blk_queue_hardsect_size(di->viocd_disk->queue,
490 set_capacity(di->viocd_disk,
492 bevent->block_size / 512);
496 pwe = (struct viocd_waitevent *)event->xCorrelationToken;
498 pwe->rc = event->xRc;
499 pwe->sub_result = bevent->sub_result;
504 pwe = (struct viocd_waitevent *)event->xCorrelationToken;
505 pwe->changed = bevent->flags;
506 goto return_complete;
514 * Since this is running in interrupt mode, we need to
515 * make sure we're not stepping on any global I/O operations
517 di = &viocd_diskinfo[bevent->disk];
518 spin_lock_irqsave(&viocd_reqlock, flags);
519 dma_unmap_single(di->dev, bevent->token, bevent->len,
520 ((event->xSubtype & VIOMINOR_SUBTYPE_MASK) == viocdread)
521 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
522 req = (struct request *)bevent->event.xCorrelationToken;
525 if (event->xRc != HvLpEvent_Rc_Good) {
526 const struct vio_error_entry *err =
527 vio_lookup_rc(viocd_err_table,
529 printk(VIOCD_KERN_WARNING "request %p failed "
530 "with rc %d:0x%04X: %s\n",
532 bevent->sub_result, err->msg);
533 viocd_end_request(req, -EIO);
535 viocd_end_request(req, 0);
537 /* restart handling of incoming requests */
538 spin_unlock_irqrestore(&viocd_reqlock, flags);
539 restart_all_queues(bevent->disk);
543 printk(VIOCD_KERN_WARNING
544 "message with invalid subtype %0x04X!\n",
545 event->xSubtype & VIOMINOR_SUBTYPE_MASK);
546 if (hvlpevent_need_ack(event)) {
547 event->xRc = HvLpEvent_Rc_InvalidSubtype;
548 HvCallEvent_ackLpEvent(event);
553 static struct cdrom_device_ops viocd_dops = {
555 .release = viocd_release,
556 .media_changed = viocd_media_changed,
557 .lock_door = viocd_lock_door,
558 .generic_packet = viocd_packet,
559 .capability = CDC_CLOSE_TRAY | CDC_OPEN_TRAY | CDC_LOCK | CDC_SELECT_SPEED | CDC_SELECT_DISC | CDC_MULTI_SESSION | CDC_MCN | CDC_MEDIA_CHANGED | CDC_PLAY_AUDIO | CDC_RESET | CDC_DRIVE_STATUS | CDC_GENERIC_PACKET | CDC_CD_R | CDC_CD_RW | CDC_DVD | CDC_DVD_R | CDC_DVD_RAM | CDC_RAM
562 static int find_capability(const char *type)
564 struct capability_entry *entry;
566 for(entry = capability_table; entry->type; ++entry)
567 if(!strncmp(entry->type, type, 4))
569 return entry->capability;
572 static int viocd_probe(struct vio_dev *vdev, const struct vio_device_id *id)
574 struct gendisk *gendisk;
577 struct cdrom_device_info *c;
578 struct request_queue *q;
579 struct device_node *node = vdev->dev.archdata.of_node;
581 deviceno = vdev->unit_address;
582 if (deviceno > VIOCD_MAX_CD)
587 if (deviceno >= viocd_numdev)
588 viocd_numdev = deviceno + 1;
590 d = &viocd_diskinfo[deviceno];
591 d->rsrcname = of_get_property(node, "linux,vio_rsrcname", NULL);
592 d->type = of_get_property(node, "linux,vio_type", NULL);
593 d->model = of_get_property(node, "linux,vio_model", NULL);
597 c->ops = &viocd_dops;
601 c->mask = ~find_capability(d->type);
602 sprintf(c->name, VIOCD_DEVICE "%c", 'a' + deviceno);
604 if (register_cdrom(c) != 0) {
605 printk(VIOCD_KERN_WARNING "Cannot register viocd CD-ROM %s!\n",
609 printk(VIOCD_KERN_INFO "cd %s is iSeries resource %10.10s "
610 "type %4.4s, model %3.3s\n",
611 c->name, d->rsrcname, d->type, d->model);
612 q = blk_init_queue(do_viocd_request, &viocd_reqlock);
614 printk(VIOCD_KERN_WARNING "Cannot allocate queue for %s!\n",
616 goto out_unregister_cdrom;
618 gendisk = alloc_disk(1);
619 if (gendisk == NULL) {
620 printk(VIOCD_KERN_WARNING "Cannot create gendisk for %s!\n",
622 goto out_cleanup_queue;
624 gendisk->major = VIOCD_MAJOR;
625 gendisk->first_minor = deviceno;
626 strncpy(gendisk->disk_name, c->name,
627 sizeof(gendisk->disk_name));
628 blk_queue_max_hw_segments(q, 1);
629 blk_queue_max_phys_segments(q, 1);
630 blk_queue_max_sectors(q, 4096 / 512);
632 gendisk->fops = &viocd_fops;
633 gendisk->flags = GENHD_FL_CD|GENHD_FL_REMOVABLE;
634 set_capacity(gendisk, 0);
635 gendisk->private_data = d;
636 d->viocd_disk = gendisk;
638 gendisk->driverfs_dev = d->dev;
643 blk_cleanup_queue(q);
644 out_unregister_cdrom:
650 static int viocd_remove(struct vio_dev *vdev)
652 struct disk_info *d = &viocd_diskinfo[vdev->unit_address];
654 unregister_cdrom(&d->viocd_info);
655 del_gendisk(d->viocd_disk);
656 blk_cleanup_queue(d->viocd_disk->queue);
657 put_disk(d->viocd_disk);
662 * viocd_device_table: Used by vio.c to match devices that we
665 static struct vio_device_id viocd_device_table[] __devinitdata = {
666 { "block", "IBM,iSeries-viocd" },
669 MODULE_DEVICE_TABLE(vio, viocd_device_table);
671 static struct vio_driver viocd_driver = {
672 .id_table = viocd_device_table,
673 .probe = viocd_probe,
674 .remove = viocd_remove,
677 .owner = THIS_MODULE,
681 static int __init viocd_init(void)
685 if (!firmware_has_feature(FW_FEATURE_ISERIES))
688 if (viopath_hostLp == HvLpIndexInvalid) {
690 /* If we don't have a host, bail out */
691 if (viopath_hostLp == HvLpIndexInvalid)
695 printk(VIOCD_KERN_INFO "vers " VIOCD_VERS ", hosting partition %d\n",
698 if (register_blkdev(VIOCD_MAJOR, VIOCD_DEVICE) != 0) {
699 printk(VIOCD_KERN_WARNING "Unable to get major %d for %s\n",
700 VIOCD_MAJOR, VIOCD_DEVICE);
704 ret = viopath_open(viopath_hostLp, viomajorsubtype_cdio,
707 printk(VIOCD_KERN_WARNING
708 "error opening path to host partition %d\n",
713 /* Initialize our request handler */
714 vio_setHandler(viomajorsubtype_cdio, vio_handle_cd_event);
716 spin_lock_init(&viocd_reqlock);
718 ret = vio_register_driver(&viocd_driver);
722 proc_create("iSeries/viocd", S_IFREG|S_IRUGO, NULL,
723 &proc_viocd_operations);
727 vio_clearHandler(viomajorsubtype_cdio);
728 viopath_close(viopath_hostLp, viomajorsubtype_cdio, MAX_CD_REQ + 2);
730 unregister_blkdev(VIOCD_MAJOR, VIOCD_DEVICE);
734 static void __exit viocd_exit(void)
736 remove_proc_entry("iSeries/viocd", NULL);
737 vio_unregister_driver(&viocd_driver);
738 viopath_close(viopath_hostLp, viomajorsubtype_cdio, MAX_CD_REQ + 2);
739 vio_clearHandler(viomajorsubtype_cdio);
740 unregister_blkdev(VIOCD_MAJOR, VIOCD_DEVICE);
743 module_init(viocd_init);
744 module_exit(viocd_exit);
745 MODULE_LICENSE("GPL");