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>
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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
36 #include <linux/major.h>
37 #include <linux/blkdev.h>
38 #include <linux/cdrom.h>
39 #include <linux/errno.h>
40 #include <linux/init.h>
41 #include <linux/dma-mapping.h>
42 #include <linux/module.h>
43 #include <linux/completion.h>
44 #include <linux/proc_fs.h>
45 #include <linux/seq_file.h>
46 #include <linux/scatterlist.h>
49 #include <asm/iseries/hv_types.h>
50 #include <asm/iseries/hv_lp_event.h>
51 #include <asm/iseries/vio.h>
52 #include <asm/firmware.h>
54 #define VIOCD_DEVICE "iseries/vcd"
56 #define VIOCD_VERS "1.06"
59 * Should probably make this a module parameter....sigh
61 #define VIOCD_MAX_CD HVMAXARCHITECTEDVIRTUALCDROMS
63 static const struct vio_error_entry viocd_err_table[] = {
64 {0x0201, EINVAL, "Invalid Range"},
65 {0x0202, EINVAL, "Invalid Token"},
66 {0x0203, EIO, "DMA Error"},
67 {0x0204, EIO, "Use Error"},
68 {0x0205, EIO, "Release Error"},
69 {0x0206, EINVAL, "Invalid CD"},
70 {0x020C, EROFS, "Read Only Device"},
71 {0x020D, ENOMEDIUM, "Changed or Missing Volume (or Varied Off?)"},
72 {0x020E, EIO, "Optical System Error (Varied Off?)"},
73 {0x02FF, EIO, "Internal Error"},
74 {0x3010, EIO, "Changed Volume"},
75 {0xC100, EIO, "Optical System Error"},
80 * This is the structure we use to exchange info between driver and interrupt
83 struct viocd_waitevent {
84 struct completion com;
90 /* this is a lookup table for the true capabilities of a device */
91 struct capability_entry {
96 static struct capability_entry capability_table[] __initdata = {
97 { "6330", CDC_LOCK | CDC_DVD_RAM | CDC_RAM },
98 { "6331", CDC_LOCK | CDC_DVD_RAM | CDC_RAM },
99 { "6333", CDC_LOCK | CDC_DVD_RAM | CDC_RAM },
100 { "632A", CDC_LOCK | CDC_DVD_RAM | CDC_RAM },
101 { "6321", CDC_LOCK },
106 /* These are our internal structures for keeping track of devices */
107 static int viocd_numdev;
110 struct gendisk *viocd_disk;
111 struct cdrom_device_info viocd_info;
113 const char *rsrcname;
117 static struct disk_info viocd_diskinfo[VIOCD_MAX_CD];
119 #define DEVICE_NR(di) ((di) - &viocd_diskinfo[0])
121 static spinlock_t viocd_reqlock;
126 static int proc_viocd_show(struct seq_file *m, void *v)
130 for (i = 0; i < viocd_numdev; i++) {
131 seq_printf(m, "viocd device %d is iSeries resource %10.10s"
132 "type %4.4s, model %3.3s\n",
133 i, viocd_diskinfo[i].rsrcname,
134 viocd_diskinfo[i].type,
135 viocd_diskinfo[i].model);
140 static int proc_viocd_open(struct inode *inode, struct file *file)
142 return single_open(file, proc_viocd_show, NULL);
145 static const struct file_operations proc_viocd_operations = {
146 .owner = THIS_MODULE,
147 .open = proc_viocd_open,
150 .release = single_release,
153 static int viocd_blk_open(struct block_device *bdev, fmode_t mode)
155 struct disk_info *di = bdev->bd_disk->private_data;
156 return cdrom_open(&di->viocd_info, bdev, mode);
159 static int viocd_blk_release(struct gendisk *disk, fmode_t mode)
161 struct disk_info *di = disk->private_data;
162 cdrom_release(&di->viocd_info, mode);
166 static int viocd_blk_ioctl(struct block_device *bdev, fmode_t mode,
167 unsigned cmd, unsigned long arg)
169 struct disk_info *di = bdev->bd_disk->private_data;
170 return cdrom_ioctl(&di->viocd_info, bdev, mode, 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 static const struct block_device_operations viocd_fops = {
180 .owner = THIS_MODULE,
181 .open = viocd_blk_open,
182 .release = viocd_blk_release,
183 .locked_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 pr_warning("bad rc on HvCallEvent_signalLpEventFast %d\n",
209 wait_for_completion(&we.com);
212 const struct vio_error_entry *err =
213 vio_lookup_rc(viocd_err_table, we.sub_result);
214 pr_warning("bad rc %d:0x%04X on open: %s\n",
215 we.rc, we.sub_result, err->msg);
222 static void viocd_release(struct cdrom_device_info *cdi)
224 int device_no = DEVICE_NR((struct disk_info *)cdi->handle);
227 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
228 HvLpEvent_Type_VirtualIo,
229 viomajorsubtype_cdio | viocdclose,
230 HvLpEvent_AckInd_NoAck, HvLpEvent_AckType_ImmediateAck,
231 viopath_sourceinst(viopath_hostLp),
232 viopath_targetinst(viopath_hostLp), 0,
233 VIOVERSION << 16, ((u64)device_no << 48), 0, 0, 0);
235 pr_warning("bad rc on HvCallEvent_signalLpEventFast %d\n",
239 /* Send a read or write request to OS/400 */
240 static int send_request(struct request *req)
243 struct disk_info *diskinfo = req->rq_disk->private_data;
248 struct scatterlist sg;
250 BUG_ON(req->nr_phys_segments > 1);
252 if (rq_data_dir(req) == READ) {
253 direction = DMA_FROM_DEVICE;
254 cmd = viomajorsubtype_cdio | viocdread;
256 direction = DMA_TO_DEVICE;
257 cmd = viomajorsubtype_cdio | viocdwrite;
260 sg_init_table(&sg, 1);
261 if (blk_rq_map_sg(req->q, req, &sg) == 0) {
262 pr_warning("error setting up scatter/gather list\n");
266 if (dma_map_sg(diskinfo->dev, &sg, 1, direction) == 0) {
267 pr_warning("error allocating sg tce\n");
270 dmaaddr = sg_dma_address(&sg);
271 len = sg_dma_len(&sg);
273 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
274 HvLpEvent_Type_VirtualIo, cmd,
275 HvLpEvent_AckInd_DoAck,
276 HvLpEvent_AckType_ImmediateAck,
277 viopath_sourceinst(viopath_hostLp),
278 viopath_targetinst(viopath_hostLp),
279 (u64)req, VIOVERSION << 16,
280 ((u64)DEVICE_NR(diskinfo) << 48) | dmaaddr,
281 (u64)blk_rq_pos(req) * 512, len, 0);
282 if (hvrc != HvLpEvent_Rc_Good) {
283 pr_warning("hv error on op %d\n", (int)hvrc);
292 static void do_viocd_request(struct request_queue *q)
296 while ((rwreq == 0) && ((req = blk_fetch_request(q)) != NULL)) {
297 if (req->cmd_type != REQ_TYPE_FS)
298 __blk_end_request_all(req, -EIO);
299 else if (send_request(req) < 0) {
300 pr_warning("unable to send message to OS/400!\n");
301 __blk_end_request_all(req, -EIO);
307 static int viocd_media_changed(struct cdrom_device_info *cdi, int disc_nr)
309 struct viocd_waitevent we;
311 int device_no = DEVICE_NR((struct disk_info *)cdi->handle);
313 init_completion(&we.com);
315 /* Send the open event to OS/400 */
316 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
317 HvLpEvent_Type_VirtualIo,
318 viomajorsubtype_cdio | viocdcheck,
319 HvLpEvent_AckInd_DoAck, HvLpEvent_AckType_ImmediateAck,
320 viopath_sourceinst(viopath_hostLp),
321 viopath_targetinst(viopath_hostLp),
322 (u64)&we, VIOVERSION << 16, ((u64)device_no << 48),
325 pr_warning("bad rc on HvCallEvent_signalLpEventFast %d\n",
330 wait_for_completion(&we.com);
332 /* Check the return code. If bad, assume no change */
334 const struct vio_error_entry *err =
335 vio_lookup_rc(viocd_err_table, we.sub_result);
336 pr_warning("bad rc %d:0x%04X on check_change: %s; Assuming no change\n",
337 we.rc, we.sub_result, err->msg);
344 static int viocd_lock_door(struct cdrom_device_info *cdi, int locking)
347 u64 device_no = DEVICE_NR((struct disk_info *)cdi->handle);
348 /* NOTE: flags is 1 or 0 so it won't overwrite the device_no */
349 u64 flags = !!locking;
350 struct viocd_waitevent we;
352 init_completion(&we.com);
354 /* Send the lockdoor event to OS/400 */
355 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
356 HvLpEvent_Type_VirtualIo,
357 viomajorsubtype_cdio | viocdlockdoor,
358 HvLpEvent_AckInd_DoAck, HvLpEvent_AckType_ImmediateAck,
359 viopath_sourceinst(viopath_hostLp),
360 viopath_targetinst(viopath_hostLp),
361 (u64)&we, VIOVERSION << 16,
362 (device_no << 48) | (flags << 32), 0, 0, 0);
364 pr_warning("bad rc on HvCallEvent_signalLpEventFast %d\n",
369 wait_for_completion(&we.com);
376 static int viocd_packet(struct cdrom_device_info *cdi,
377 struct packet_command *cgc)
379 unsigned int buflen = cgc->buflen;
382 switch (cgc->cmd[0]) {
383 case GPCMD_READ_DISC_INFO:
385 disc_information *di = (disc_information *)cgc->buffer;
388 di->disc_information_length = cpu_to_be16(1);
393 (cdi->ops->capability & ~cdi->mask
394 & (CDC_DVD_RAM | CDC_RAM)) != 0;
397 case GPCMD_GET_CONFIGURATION:
398 if (cgc->cmd[3] == CDF_RWRT) {
399 struct rwrt_feature_desc *rfd = (struct rwrt_feature_desc *)(cgc->buffer + sizeof(struct feature_header));
402 (sizeof(struct feature_header) + sizeof(*rfd))) &&
403 (cdi->ops->capability & ~cdi->mask
404 & (CDC_DVD_RAM | CDC_RAM))) {
405 rfd->feature_code = cpu_to_be16(CDF_RWRT);
413 /* indicate Unknown code */
414 cgc->sense->sense_key = 0x05;
415 cgc->sense->asc = 0x20;
416 cgc->sense->ascq = 0x00;
425 static void restart_all_queues(int first_index)
429 for (i = first_index + 1; i < viocd_numdev; i++)
430 if (viocd_diskinfo[i].viocd_disk)
431 blk_run_queue(viocd_diskinfo[i].viocd_disk->queue);
432 for (i = 0; i <= first_index; i++)
433 if (viocd_diskinfo[i].viocd_disk)
434 blk_run_queue(viocd_diskinfo[i].viocd_disk->queue);
437 /* This routine handles incoming CD LP events */
438 static void vio_handle_cd_event(struct HvLpEvent *event)
440 struct viocdlpevent *bevent;
441 struct viocd_waitevent *pwe;
442 struct disk_info *di;
448 /* Notification that a partition went away! */
450 /* First, we should NEVER get an int here...only acks */
451 if (hvlpevent_is_int(event)) {
452 pr_warning("Yikes! got an int in viocd event handler!\n");
453 if (hvlpevent_need_ack(event)) {
454 event->xRc = HvLpEvent_Rc_InvalidSubtype;
455 HvCallEvent_ackLpEvent(event);
459 bevent = (struct viocdlpevent *)event;
461 switch (event->xSubtype & VIOMINOR_SUBTYPE_MASK) {
463 if (event->xRc == 0) {
464 di = &viocd_diskinfo[bevent->disk];
465 blk_queue_logical_block_size(di->viocd_disk->queue,
467 set_capacity(di->viocd_disk,
469 bevent->block_size / 512);
473 pwe = (struct viocd_waitevent *)event->xCorrelationToken;
475 pwe->rc = event->xRc;
476 pwe->sub_result = bevent->sub_result;
481 pwe = (struct viocd_waitevent *)event->xCorrelationToken;
482 pwe->changed = bevent->flags;
483 goto return_complete;
491 * Since this is running in interrupt mode, we need to
492 * make sure we're not stepping on any global I/O operations
494 di = &viocd_diskinfo[bevent->disk];
495 spin_lock_irqsave(&viocd_reqlock, flags);
496 dma_unmap_single(di->dev, bevent->token, bevent->len,
497 ((event->xSubtype & VIOMINOR_SUBTYPE_MASK) == viocdread)
498 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
499 req = (struct request *)bevent->event.xCorrelationToken;
502 if (event->xRc != HvLpEvent_Rc_Good) {
503 const struct vio_error_entry *err =
504 vio_lookup_rc(viocd_err_table,
506 pr_warning("request %p failed with rc %d:0x%04X: %s\n",
508 bevent->sub_result, err->msg);
509 __blk_end_request_all(req, -EIO);
511 __blk_end_request_all(req, 0);
513 /* restart handling of incoming requests */
514 spin_unlock_irqrestore(&viocd_reqlock, flags);
515 restart_all_queues(bevent->disk);
519 pr_warning("message with invalid subtype %0x04X!\n",
520 event->xSubtype & VIOMINOR_SUBTYPE_MASK);
521 if (hvlpevent_need_ack(event)) {
522 event->xRc = HvLpEvent_Rc_InvalidSubtype;
523 HvCallEvent_ackLpEvent(event);
528 static int viocd_audio_ioctl(struct cdrom_device_info *cdi, unsigned int cmd,
534 static struct cdrom_device_ops viocd_dops = {
536 .release = viocd_release,
537 .media_changed = viocd_media_changed,
538 .lock_door = viocd_lock_door,
539 .generic_packet = viocd_packet,
540 .audio_ioctl = viocd_audio_ioctl,
541 .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
544 static int find_capability(const char *type)
546 struct capability_entry *entry;
548 for(entry = capability_table; entry->type; ++entry)
549 if(!strncmp(entry->type, type, 4))
551 return entry->capability;
554 static int viocd_probe(struct vio_dev *vdev, const struct vio_device_id *id)
556 struct gendisk *gendisk;
559 struct cdrom_device_info *c;
560 struct request_queue *q;
561 struct device_node *node = vdev->dev.of_node;
563 deviceno = vdev->unit_address;
564 if (deviceno >= VIOCD_MAX_CD)
569 if (deviceno >= viocd_numdev)
570 viocd_numdev = deviceno + 1;
572 d = &viocd_diskinfo[deviceno];
573 d->rsrcname = of_get_property(node, "linux,vio_rsrcname", NULL);
574 d->type = of_get_property(node, "linux,vio_type", NULL);
575 d->model = of_get_property(node, "linux,vio_model", NULL);
579 c->ops = &viocd_dops;
583 c->mask = ~find_capability(d->type);
584 sprintf(c->name, VIOCD_DEVICE "%c", 'a' + deviceno);
586 if (register_cdrom(c) != 0) {
587 pr_warning("Cannot register viocd CD-ROM %s!\n", c->name);
590 pr_info("cd %s is iSeries resource %10.10s type %4.4s, model %3.3s\n",
591 c->name, d->rsrcname, d->type, d->model);
592 q = blk_init_queue(do_viocd_request, &viocd_reqlock);
594 pr_warning("Cannot allocate queue for %s!\n", c->name);
595 goto out_unregister_cdrom;
597 gendisk = alloc_disk(1);
598 if (gendisk == NULL) {
599 pr_warning("Cannot create gendisk for %s!\n", c->name);
600 goto out_cleanup_queue;
602 gendisk->major = VIOCD_MAJOR;
603 gendisk->first_minor = deviceno;
604 strncpy(gendisk->disk_name, c->name,
605 sizeof(gendisk->disk_name));
606 blk_queue_max_segments(q, 1);
607 blk_queue_max_hw_sectors(q, 4096 / 512);
609 gendisk->fops = &viocd_fops;
610 gendisk->flags = GENHD_FL_CD|GENHD_FL_REMOVABLE;
611 set_capacity(gendisk, 0);
612 gendisk->private_data = d;
613 d->viocd_disk = gendisk;
615 gendisk->driverfs_dev = d->dev;
620 blk_cleanup_queue(q);
621 out_unregister_cdrom:
627 static int viocd_remove(struct vio_dev *vdev)
629 struct disk_info *d = &viocd_diskinfo[vdev->unit_address];
631 unregister_cdrom(&d->viocd_info);
632 del_gendisk(d->viocd_disk);
633 blk_cleanup_queue(d->viocd_disk->queue);
634 put_disk(d->viocd_disk);
639 * viocd_device_table: Used by vio.c to match devices that we
642 static struct vio_device_id viocd_device_table[] __devinitdata = {
643 { "block", "IBM,iSeries-viocd" },
646 MODULE_DEVICE_TABLE(vio, viocd_device_table);
648 static struct vio_driver viocd_driver = {
649 .id_table = viocd_device_table,
650 .probe = viocd_probe,
651 .remove = viocd_remove,
654 .owner = THIS_MODULE,
658 static int __init viocd_init(void)
662 if (!firmware_has_feature(FW_FEATURE_ISERIES))
665 if (viopath_hostLp == HvLpIndexInvalid) {
667 /* If we don't have a host, bail out */
668 if (viopath_hostLp == HvLpIndexInvalid)
672 pr_info("vers " VIOCD_VERS ", hosting partition %d\n", viopath_hostLp);
674 if (register_blkdev(VIOCD_MAJOR, VIOCD_DEVICE) != 0) {
675 pr_warning("Unable to get major %d for %s\n",
676 VIOCD_MAJOR, VIOCD_DEVICE);
680 ret = viopath_open(viopath_hostLp, viomajorsubtype_cdio,
683 pr_warning("error opening path to host partition %d\n",
688 /* Initialize our request handler */
689 vio_setHandler(viomajorsubtype_cdio, vio_handle_cd_event);
691 spin_lock_init(&viocd_reqlock);
693 ret = vio_register_driver(&viocd_driver);
697 proc_create("iSeries/viocd", S_IFREG|S_IRUGO, NULL,
698 &proc_viocd_operations);
702 vio_clearHandler(viomajorsubtype_cdio);
703 viopath_close(viopath_hostLp, viomajorsubtype_cdio, MAX_CD_REQ + 2);
705 unregister_blkdev(VIOCD_MAJOR, VIOCD_DEVICE);
709 static void __exit viocd_exit(void)
711 remove_proc_entry("iSeries/viocd", NULL);
712 vio_unregister_driver(&viocd_driver);
713 viopath_close(viopath_hostLp, viomajorsubtype_cdio, MAX_CD_REQ + 2);
714 vio_clearHandler(viomajorsubtype_cdio);
715 unregister_blkdev(VIOCD_MAJOR, VIOCD_DEVICE);
718 module_init(viocd_init);
719 module_exit(viocd_exit);
720 MODULE_LICENSE("GPL");