blob: 0f17009c99d2f75581ea96b30e3927f89beaa408 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * sr.c Copyright (C) 1992 David Giller
3 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
4 *
5 * adapted from:
6 * sd.c Copyright (C) 1992 Drew Eckhardt
7 * Linux scsi disk driver by
8 * Drew Eckhardt <drew@colorado.edu>
9 *
10 * Modified by Eric Youngdale ericy@andante.org to
11 * add scatter-gather, multiple outstanding request, and other
12 * enhancements.
13 *
14 * Modified by Eric Youngdale eric@andante.org to support loadable
15 * low-level scsi drivers.
16 *
17 * Modified by Thomas Quinot thomas@melchior.cuivre.fdn.fr to
18 * provide auto-eject.
19 *
20 * Modified by Gerd Knorr <kraxel@cs.tu-berlin.de> to support the
21 * generic cdrom interface
22 *
23 * Modified by Jens Axboe <axboe@suse.de> - Uniform sr_packet()
24 * interface, capabilities probe additions, ioctl cleanups, etc.
25 *
26 * Modified by Richard Gooch <rgooch@atnf.csiro.au> to support devfs
27 *
28 * Modified by Jens Axboe <axboe@suse.de> - support DVD-RAM
29 * transparently and lose the GHOST hack
30 *
31 * Modified by Arnaldo Carvalho de Melo <acme@conectiva.com.br>
32 * check resource allocation in sr_init and some cleanups
33 */
34
35#include <linux/module.h>
36#include <linux/fs.h>
37#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/mm.h>
39#include <linux/bio.h>
40#include <linux/string.h>
41#include <linux/errno.h>
42#include <linux/cdrom.h>
43#include <linux/interrupt.h>
44#include <linux/init.h>
45#include <linux/blkdev.h>
Arjan van de Ven0b950672006-01-11 13:16:10 +010046#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <asm/uaccess.h>
48
49#include <scsi/scsi.h>
50#include <scsi/scsi_dbg.h>
51#include <scsi/scsi_device.h>
52#include <scsi/scsi_driver.h>
James Bottomley820732b2005-06-12 22:21:29 -050053#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include <scsi/scsi_eh.h>
55#include <scsi/scsi_host.h>
56#include <scsi/scsi_ioctl.h> /* For the door lock/unlock commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58#include "scsi_logging.h"
59#include "sr.h"
60
61
Rene Hermanf018fa52006-03-08 00:14:20 -080062MODULE_DESCRIPTION("SCSI cdrom (sr) driver");
63MODULE_LICENSE("GPL");
64MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_CDROM_MAJOR);
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +040065MODULE_ALIAS_SCSI_DEVICE(TYPE_ROM);
66MODULE_ALIAS_SCSI_DEVICE(TYPE_WORM);
Rene Hermanf018fa52006-03-08 00:14:20 -080067
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#define SR_DISKS 256
69
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#define SR_CAPABILITIES \
71 (CDC_CLOSE_TRAY|CDC_OPEN_TRAY|CDC_LOCK|CDC_SELECT_SPEED| \
72 CDC_SELECT_DISC|CDC_MULTI_SESSION|CDC_MCN|CDC_MEDIA_CHANGED| \
Christoph Hellwig6a2900b2006-03-23 03:00:15 -080073 CDC_PLAY_AUDIO|CDC_RESET|CDC_DRIVE_STATUS| \
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 CDC_CD_R|CDC_CD_RW|CDC_DVD|CDC_DVD_R|CDC_DVD_RAM|CDC_GENERIC_PACKET| \
75 CDC_MRW|CDC_MRW_W|CDC_RAM)
76
77static int sr_probe(struct device *);
78static int sr_remove(struct device *);
Linus Torvalds7b3d9542008-01-06 10:17:12 -080079static int sr_done(struct scsi_cmnd *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81static struct scsi_driver sr_template = {
82 .owner = THIS_MODULE,
83 .gendrv = {
84 .name = "sr",
85 .probe = sr_probe,
86 .remove = sr_remove,
87 },
Linus Torvalds7b3d9542008-01-06 10:17:12 -080088 .done = sr_done,
Linus Torvalds1da177e2005-04-16 15:20:36 -070089};
90
91static unsigned long sr_index_bits[SR_DISKS / BITS_PER_LONG];
92static DEFINE_SPINLOCK(sr_index_lock);
93
94/* This semaphore is used to mediate the 0->1 reference get in the
95 * face of object destruction (i.e. we can't allow a get on an
96 * object after last put) */
Arjan van de Ven0b950672006-01-11 13:16:10 +010097static DEFINE_MUTEX(sr_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99static int sr_open(struct cdrom_device_info *, int);
100static void sr_release(struct cdrom_device_info *);
101
102static void get_sectorsize(struct scsi_cd *);
103static void get_capabilities(struct scsi_cd *);
104
105static int sr_media_change(struct cdrom_device_info *, int);
106static int sr_packet(struct cdrom_device_info *, struct packet_command *);
107
108static struct cdrom_device_ops sr_dops = {
109 .open = sr_open,
110 .release = sr_release,
111 .drive_status = sr_drive_status,
112 .media_changed = sr_media_change,
113 .tray_move = sr_tray_move,
114 .lock_door = sr_lock_door,
115 .select_speed = sr_select_speed,
116 .get_last_session = sr_get_last_session,
117 .get_mcn = sr_get_mcn,
118 .reset = sr_reset,
119 .audio_ioctl = sr_audio_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 .capability = SR_CAPABILITIES,
121 .generic_packet = sr_packet,
122};
123
124static void sr_kref_release(struct kref *kref);
125
126static inline struct scsi_cd *scsi_cd(struct gendisk *disk)
127{
128 return container_of(disk->private_data, struct scsi_cd, driver);
129}
130
131/*
132 * The get and put routines for the struct scsi_cd. Note this entity
133 * has a scsi_device pointer and owns a reference to this.
134 */
135static inline struct scsi_cd *scsi_cd_get(struct gendisk *disk)
136{
137 struct scsi_cd *cd = NULL;
138
Arjan van de Ven0b950672006-01-11 13:16:10 +0100139 mutex_lock(&sr_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 if (disk->private_data == NULL)
141 goto out;
142 cd = scsi_cd(disk);
143 kref_get(&cd->kref);
144 if (scsi_device_get(cd->device))
145 goto out_put;
146 goto out;
147
148 out_put:
149 kref_put(&cd->kref, sr_kref_release);
150 cd = NULL;
151 out:
Arjan van de Ven0b950672006-01-11 13:16:10 +0100152 mutex_unlock(&sr_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 return cd;
154}
155
Arjan van de Ven858119e2006-01-14 13:20:43 -0800156static void scsi_cd_put(struct scsi_cd *cd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157{
158 struct scsi_device *sdev = cd->device;
159
Arjan van de Ven0b950672006-01-11 13:16:10 +0100160 mutex_lock(&sr_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 kref_put(&cd->kref, sr_kref_release);
162 scsi_device_put(sdev);
Arjan van de Ven0b950672006-01-11 13:16:10 +0100163 mutex_unlock(&sr_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164}
165
James Bottomley38582a62008-02-06 13:01:58 -0600166/* identical to scsi_test_unit_ready except that it doesn't
167 * eat the NOT_READY returns for removable media */
168int sr_test_unit_ready(struct scsi_device *sdev, struct scsi_sense_hdr *sshdr)
169{
170 int retries = MAX_RETRIES;
171 int the_result;
172 u8 cmd[] = {TEST_UNIT_READY, 0, 0, 0, 0, 0 };
173
174 /* issue TEST_UNIT_READY until the initial startup UNIT_ATTENTION
175 * conditions are gone, or a timeout happens
176 */
177 do {
178 the_result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL,
179 0, sshdr, SR_TIMEOUT,
180 retries--);
James Bottomleyd1daeab2008-06-10 10:20:53 -0500181 if (scsi_sense_valid(sshdr) &&
182 sshdr->sense_key == UNIT_ATTENTION)
183 sdev->changed = 1;
James Bottomley38582a62008-02-06 13:01:58 -0600184
185 } while (retries > 0 &&
186 (!scsi_status_is_good(the_result) ||
187 (scsi_sense_valid(sshdr) &&
188 sshdr->sense_key == UNIT_ATTENTION)));
189 return the_result;
190}
191
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192/*
193 * This function checks to see if the media has been changed in the
194 * CDROM drive. It is possible that we have already sensed a change,
195 * or the drive may have sensed one and not yet reported it. We must
196 * be ready for either case. This function always reports the current
197 * value of the changed bit. If flag is 0, then the changed bit is reset.
198 * This function could be done as an ioctl, but we would need to have
199 * an inode for that to work, and we do not always have one.
200 */
201
Adrian Bunk44818ef2007-07-09 11:59:59 -0700202static int sr_media_change(struct cdrom_device_info *cdi, int slot)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
204 struct scsi_cd *cd = cdi->handle;
205 int retval;
James Bottomley001aac22007-12-02 19:10:40 +0200206 struct scsi_sense_hdr *sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208 if (CDSL_CURRENT != slot) {
209 /* no changer support */
210 return -EINVAL;
211 }
212
James Bottomley001aac22007-12-02 19:10:40 +0200213 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
James Bottomley38582a62008-02-06 13:01:58 -0600214 retval = sr_test_unit_ready(cd->device, sshdr);
James Bottomley001aac22007-12-02 19:10:40 +0200215 if (retval || (scsi_sense_valid(sshdr) &&
216 /* 0x3a is medium not present */
217 sshdr->asc == 0x3a)) {
218 /* Media not present or unable to test, unit probably not
219 * ready. This usually means there is no disc in the drive.
220 * Mark as changed, and we will figure it out later once
221 * the drive is available again.
222 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 cd->device->changed = 1;
Kay Sievers285e9672007-08-14 14:10:39 +0200224 /* This will force a flush, if called from check_disk_change */
225 retval = 1;
226 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 };
228
229 retval = cd->device->changed;
230 cd->device->changed = 0;
231 /* If the disk changed, the capacity will now be different,
232 * so we force a re-read of this information */
233 if (retval) {
234 /* check multisession offset etc */
235 sr_cd_check(cdi);
Pete Zaitcev51490c82005-07-05 18:18:08 -0700236 get_sectorsize(cd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 }
Kay Sievers285e9672007-08-14 14:10:39 +0200238
239out:
240 /* Notify userspace, that media has changed. */
241 if (retval != cd->previous_state)
242 sdev_evt_send_simple(cd->device, SDEV_EVT_MEDIA_CHANGE,
243 GFP_KERNEL);
244 cd->previous_state = retval;
James Bottomley001aac22007-12-02 19:10:40 +0200245 kfree(sshdr);
Kay Sievers285e9672007-08-14 14:10:39 +0200246
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 return retval;
248}
249
250/*
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800251 * sr_done is the interrupt routine for the device driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 *
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800253 * It will be notified on the end of a SCSI read / write, and will take one
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 * of several actions based on success or failure.
255 */
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800256static int sr_done(struct scsi_cmnd *SCpnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257{
258 int result = SCpnt->result;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200259 int this_count = scsi_bufflen(SCpnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 int good_bytes = (result == 0 ? this_count : 0);
261 int block_sectors = 0;
262 long error_sector;
263 struct scsi_cd *cd = scsi_cd(SCpnt->request->rq_disk);
264
265#ifdef DEBUG
266 printk("sr.c done: %x\n", result);
267#endif
268
269 /*
270 * Handle MEDIUM ERRORs or VOLUME OVERFLOWs that indicate partial
271 * success. Since this is a relatively rare error condition, no
272 * care is taken to avoid unnecessary additional work such as
273 * memcpy's that could be avoided.
274 */
275 if (driver_byte(result) != 0 && /* An error occurred */
276 (SCpnt->sense_buffer[0] & 0x7f) == 0x70) { /* Sense current */
277 switch (SCpnt->sense_buffer[2]) {
278 case MEDIUM_ERROR:
279 case VOLUME_OVERFLOW:
280 case ILLEGAL_REQUEST:
281 if (!(SCpnt->sense_buffer[0] & 0x90))
282 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 error_sector = (SCpnt->sense_buffer[3] << 24) |
284 (SCpnt->sense_buffer[4] << 16) |
285 (SCpnt->sense_buffer[5] << 8) |
286 SCpnt->sense_buffer[6];
287 if (SCpnt->request->bio != NULL)
288 block_sectors =
289 bio_sectors(SCpnt->request->bio);
290 if (block_sectors < 4)
291 block_sectors = 4;
292 if (cd->device->sector_size == 2048)
293 error_sector <<= 2;
294 error_sector &= ~(block_sectors - 1);
295 good_bytes = (error_sector - SCpnt->request->sector) << 9;
296 if (good_bytes < 0 || good_bytes >= this_count)
297 good_bytes = 0;
298 /*
299 * The SCSI specification allows for the value
300 * returned by READ CAPACITY to be up to 75 2K
301 * sectors past the last readable block.
302 * Therefore, if we hit a medium error within the
303 * last 75 2K sectors, we decrease the saved size
304 * value.
305 */
306 if (error_sector < get_capacity(cd->disk) &&
307 cd->capacity - error_sector < 4 * 75)
308 set_capacity(cd->disk, error_sector);
309 break;
310
311 case RECOVERED_ERROR:
312
313 /*
314 * An error occured, but it recovered. Inform the
315 * user, but make sure that it's not treated as a
316 * hard error.
317 */
318 scsi_print_sense("sr", SCpnt);
319 SCpnt->result = 0;
320 SCpnt->sense_buffer[0] = 0x0;
321 good_bytes = this_count;
322 break;
323
324 default:
325 break;
326 }
327 }
328
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800329 return good_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330}
331
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500332static int sr_prep_fn(struct request_queue *q, struct request *rq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333{
Jens Axboe242f9dc2008-09-14 05:55:09 -0700334 int block = 0, this_count, s_size;
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500335 struct scsi_cd *cd;
336 struct scsi_cmnd *SCpnt;
337 struct scsi_device *sdp = q->queuedata;
338 int ret;
339
340 if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
341 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
342 goto out;
343 } else if (rq->cmd_type != REQ_TYPE_FS) {
344 ret = BLKPREP_KILL;
345 goto out;
346 }
347 ret = scsi_setup_fs_cmnd(sdp, rq);
348 if (ret != BLKPREP_OK)
349 goto out;
350 SCpnt = rq->special;
351 cd = scsi_cd(rq->rq_disk);
352
353 /* from here on until we're complete, any goto out
354 * is used for a killable error condition */
355 ret = BLKPREP_KILL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
357 SCSI_LOG_HLQUEUE(1, printk("Doing sr request, dev = %s, block = %d\n",
358 cd->disk->disk_name, block));
359
360 if (!cd->device || !scsi_device_online(cd->device)) {
361 SCSI_LOG_HLQUEUE(2, printk("Finishing %ld sectors\n",
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500362 rq->nr_sectors));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 SCSI_LOG_HLQUEUE(2, printk("Retry with 0x%p\n", SCpnt));
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500364 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 }
366
367 if (cd->device->changed) {
368 /*
369 * quietly refuse to do anything to a changed disc until the
370 * changed bit has been reset
371 */
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500372 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 }
374
375 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 * we do lazy blocksize switching (when reading XA sectors,
377 * see CDROMREADMODE2 ioctl)
378 */
379 s_size = cd->device->sector_size;
380 if (s_size > 2048) {
381 if (!in_interrupt())
382 sr_set_blocklength(cd, 2048);
383 else
384 printk("sr: can't switch blocksize: in interrupt\n");
385 }
386
387 if (s_size != 512 && s_size != 1024 && s_size != 2048) {
Jeff Garzik3bf743e2005-10-24 18:04:06 -0400388 scmd_printk(KERN_ERR, SCpnt, "bad sector size %d\n", s_size);
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500389 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 }
391
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500392 if (rq_data_dir(rq) == WRITE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 if (!cd->device->writeable)
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500394 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 SCpnt->cmnd[0] = WRITE_10;
396 SCpnt->sc_data_direction = DMA_TO_DEVICE;
397 cd->cdi.media_written = 1;
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500398 } else if (rq_data_dir(rq) == READ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 SCpnt->cmnd[0] = READ_10;
400 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
401 } else {
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500402 blk_dump_rq_flags(rq, "Unknown sr command");
403 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 }
405
406 {
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200407 struct scatterlist *sg;
408 int i, size = 0, sg_count = scsi_sg_count(SCpnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200410 scsi_for_each_sg(SCpnt, sg, sg_count, i)
411 size += sg->length;
412
413 if (size != scsi_bufflen(SCpnt)) {
Jeff Garzik3bf743e2005-10-24 18:04:06 -0400414 scmd_printk(KERN_ERR, SCpnt,
415 "mismatch count %d, bytes %d\n",
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200416 size, scsi_bufflen(SCpnt));
417 if (scsi_bufflen(SCpnt) > size)
418 SCpnt->sdb.length = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 }
420 }
421
422 /*
423 * request doesn't start on hw block boundary, add scatter pads
424 */
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500425 if (((unsigned int)rq->sector % (s_size >> 9)) ||
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200426 (scsi_bufflen(SCpnt) % s_size)) {
Jeff Garzik3bf743e2005-10-24 18:04:06 -0400427 scmd_printk(KERN_NOTICE, SCpnt, "unaligned transfer\n");
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500428 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 }
430
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200431 this_count = (scsi_bufflen(SCpnt) >> 9) / (s_size >> 9);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
433
434 SCSI_LOG_HLQUEUE(2, printk("%s : %s %d/%ld 512 byte blocks.\n",
435 cd->cdi.name,
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500436 (rq_data_dir(rq) == WRITE) ?
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 "writing" : "reading",
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500438 this_count, rq->nr_sectors));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
440 SCpnt->cmnd[1] = 0;
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500441 block = (unsigned int)rq->sector / (s_size >> 9);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
443 if (this_count > 0xffff) {
444 this_count = 0xffff;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200445 SCpnt->sdb.length = this_count * s_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 }
447
448 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
449 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
450 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
451 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
452 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
453 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
454 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
455
456 /*
457 * We shouldn't disconnect in the middle of a sector, so with a dumb
458 * host adapter, it's safe to assume that we can at least transfer
459 * this many bytes between each connect / disconnect.
460 */
461 SCpnt->transfersize = cd->device->sector_size;
462 SCpnt->underflow = this_count << 9;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 SCpnt->allowed = MAX_RETRIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
465 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 * This indicates that the command is ready from our end to be
467 * queued.
468 */
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500469 ret = BLKPREP_OK;
470 out:
471 return scsi_prep_return(q, rq, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472}
473
474static int sr_block_open(struct inode *inode, struct file *file)
475{
476 struct gendisk *disk = inode->i_bdev->bd_disk;
Jayachandran C80d904c2005-10-18 17:11:16 -0700477 struct scsi_cd *cd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 int ret = 0;
479
480 if(!(cd = scsi_cd_get(disk)))
481 return -ENXIO;
482
483 if((ret = cdrom_open(&cd->cdi, inode, file)) != 0)
484 scsi_cd_put(cd);
485
486 return ret;
487}
488
489static int sr_block_release(struct inode *inode, struct file *file)
490{
491 int ret;
492 struct scsi_cd *cd = scsi_cd(inode->i_bdev->bd_disk);
493 ret = cdrom_release(&cd->cdi, file);
494 if(ret)
495 return ret;
496
497 scsi_cd_put(cd);
498
499 return 0;
500}
501
502static int sr_block_ioctl(struct inode *inode, struct file *file, unsigned cmd,
503 unsigned long arg)
504{
505 struct scsi_cd *cd = scsi_cd(inode->i_bdev->bd_disk);
506 struct scsi_device *sdev = cd->device;
Christoph Hellwig6a2900b2006-03-23 03:00:15 -0800507 void __user *argp = (void __user *)arg;
508 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Christoph Hellwig6a2900b2006-03-23 03:00:15 -0800510 /*
511 * Send SCSI addressing ioctls directly to mid level, send other
512 * ioctls to cdrom/block level.
513 */
514 switch (cmd) {
515 case SCSI_IOCTL_GET_IDLUN:
516 case SCSI_IOCTL_GET_BUS_NUMBER:
517 return scsi_ioctl(sdev, cmd, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 }
Christoph Hellwig6a2900b2006-03-23 03:00:15 -0800519
520 ret = cdrom_ioctl(file, &cd->cdi, inode, cmd, arg);
Tejun Heo63972562007-01-02 17:41:04 +0900521 if (ret != -ENOSYS)
Christoph Hellwig6a2900b2006-03-23 03:00:15 -0800522 return ret;
523
524 /*
525 * ENODEV means that we didn't recognise the ioctl, or that we
526 * cannot execute it in the current device state. In either
527 * case fall through to scsi_ioctl, which will return ENDOEV again
528 * if it doesn't recognise the ioctl
529 */
530 ret = scsi_nonblockable_ioctl(sdev, cmd, argp, NULL);
531 if (ret != -ENODEV)
532 return ret;
533 return scsi_ioctl(sdev, cmd, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534}
535
536static int sr_block_media_changed(struct gendisk *disk)
537{
538 struct scsi_cd *cd = scsi_cd(disk);
539 return cdrom_media_changed(&cd->cdi);
540}
541
542static struct block_device_operations sr_bdops =
543{
544 .owner = THIS_MODULE,
545 .open = sr_block_open,
546 .release = sr_block_release,
547 .ioctl = sr_block_ioctl,
548 .media_changed = sr_block_media_changed,
549 /*
550 * No compat_ioctl for now because sr_block_ioctl never
551 * seems to pass arbitary ioctls down to host drivers.
552 */
553};
554
555static int sr_open(struct cdrom_device_info *cdi, int purpose)
556{
557 struct scsi_cd *cd = cdi->handle;
558 struct scsi_device *sdev = cd->device;
559 int retval;
560
561 /*
562 * If the device is in error recovery, wait until it is done.
563 * If the device is offline, then disallow any access to it.
564 */
565 retval = -ENXIO;
566 if (!scsi_block_when_processing_errors(sdev))
567 goto error_out;
568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 return 0;
570
571error_out:
572 return retval;
573}
574
575static void sr_release(struct cdrom_device_info *cdi)
576{
577 struct scsi_cd *cd = cdi->handle;
578
579 if (cd->device->sector_size > 2048)
580 sr_set_blocklength(cd, 2048);
581
582}
583
584static int sr_probe(struct device *dev)
585{
586 struct scsi_device *sdev = to_scsi_device(dev);
587 struct gendisk *disk;
588 struct scsi_cd *cd;
589 int minor, error;
590
591 error = -ENODEV;
592 if (sdev->type != TYPE_ROM && sdev->type != TYPE_WORM)
593 goto fail;
594
595 error = -ENOMEM;
Jes Sorensen24669f752006-01-16 10:31:18 -0500596 cd = kzalloc(sizeof(*cd), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 if (!cd)
598 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
600 kref_init(&cd->kref);
601
602 disk = alloc_disk(1);
603 if (!disk)
604 goto fail_free;
605
606 spin_lock(&sr_index_lock);
607 minor = find_first_zero_bit(sr_index_bits, SR_DISKS);
608 if (minor == SR_DISKS) {
609 spin_unlock(&sr_index_lock);
610 error = -EBUSY;
611 goto fail_put;
612 }
613 __set_bit(minor, sr_index_bits);
614 spin_unlock(&sr_index_lock);
615
616 disk->major = SCSI_CDROM_MAJOR;
617 disk->first_minor = minor;
618 sprintf(disk->disk_name, "sr%d", minor);
619 disk->fops = &sr_bdops;
620 disk->flags = GENHD_FL_CD;
621
Jens Axboe242f9dc2008-09-14 05:55:09 -0700622 blk_queue_rq_timeout(sdev->request_queue, SR_TIMEOUT);
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 cd->device = sdev;
625 cd->disk = disk;
626 cd->driver = &sr_template;
627 cd->disk = disk;
628 cd->capacity = 0x1fffff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 cd->device->changed = 1; /* force recheck CD type */
Kay Sieversc02e6002008-03-19 13:09:56 +0100630 cd->previous_state = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 cd->use = 1;
632 cd->readcd_known = 0;
633 cd->readcd_cdda = 0;
634
635 cd->cdi.ops = &sr_dops;
636 cd->cdi.handle = cd;
637 cd->cdi.mask = 0;
638 cd->cdi.capacity = 1;
639 sprintf(cd->cdi.name, "sr%d", minor);
640
641 sdev->sector_size = 2048; /* A guess, just in case */
642
643 /* FIXME: need to handle a get_capabilities failure properly ?? */
644 get_capabilities(cd);
James Bottomley7f9a6bc2007-08-04 10:06:25 -0500645 blk_queue_prep_rq(sdev->request_queue, sr_prep_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 sr_vendor_init(cd);
647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 disk->driverfs_dev = &sdev->sdev_gendev;
649 set_capacity(disk, cd->capacity);
650 disk->private_data = &cd->driver;
651 disk->queue = sdev->request_queue;
652 cd->cdi.disk = disk;
653
654 if (register_cdrom(&cd->cdi))
655 goto fail_put;
656
657 dev_set_drvdata(dev, cd);
658 disk->flags |= GENHD_FL_REMOVABLE;
659 add_disk(disk);
660
James Bottomley9ccfc752005-10-02 11:45:08 -0500661 sdev_printk(KERN_DEBUG, sdev,
662 "Attached scsi CD-ROM %s\n", cd->cdi.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 return 0;
664
665fail_put:
666 put_disk(disk);
667fail_free:
668 kfree(cd);
669fail:
670 return error;
671}
672
673
674static void get_sectorsize(struct scsi_cd *cd)
675{
676 unsigned char cmd[10];
FUJITA Tomonori62858da2008-07-04 09:31:50 +0200677 unsigned char buffer[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 int the_result, retries = 3;
679 int sector_size;
Jens Axboe165125e2007-07-24 09:28:11 +0200680 struct request_queue *queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 do {
683 cmd[0] = READ_CAPACITY;
684 memset((void *) &cmd[1], 0, 9);
FUJITA Tomonori62858da2008-07-04 09:31:50 +0200685 memset(buffer, 0, sizeof(buffer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
687 /* Do the command and wait.. */
James Bottomley820732b2005-06-12 22:21:29 -0500688 the_result = scsi_execute_req(cd->device, cmd, DMA_FROM_DEVICE,
FUJITA Tomonori62858da2008-07-04 09:31:50 +0200689 buffer, sizeof(buffer), NULL,
690 SR_TIMEOUT, MAX_RETRIES);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 retries--;
693
694 } while (the_result && retries);
695
696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 if (the_result) {
698 cd->capacity = 0x1fffff;
699 sector_size = 2048; /* A guess, just in case */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 } else {
701#if 0
702 if (cdrom_get_last_written(&cd->cdi,
703 &cd->capacity))
704#endif
705 cd->capacity = 1 + ((buffer[0] << 24) |
706 (buffer[1] << 16) |
707 (buffer[2] << 8) |
708 buffer[3]);
709 sector_size = (buffer[4] << 24) |
710 (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
711 switch (sector_size) {
712 /*
713 * HP 4020i CD-Recorder reports 2340 byte sectors
714 * Philips CD-Writers report 2352 byte sectors
715 *
716 * Use 2k sectors for them..
717 */
718 case 0:
719 case 2340:
720 case 2352:
721 sector_size = 2048;
722 /* fall through */
723 case 2048:
724 cd->capacity *= 4;
725 /* fall through */
726 case 512:
727 break;
728 default:
729 printk("%s: unsupported sector size %d.\n",
730 cd->cdi.name, sector_size);
731 cd->capacity = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 }
733
734 cd->device->sector_size = sector_size;
735
736 /*
737 * Add this so that we have the ability to correctly gauge
738 * what the device is capable of.
739 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 set_capacity(cd->disk, cd->capacity);
741 }
742
743 queue = cd->device->request_queue;
744 blk_queue_hardsect_size(queue, sector_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
FUJITA Tomonori62858da2008-07-04 09:31:50 +0200746 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747}
748
749static void get_capabilities(struct scsi_cd *cd)
750{
751 unsigned char *buffer;
752 struct scsi_mode_data data;
James Bottomley820732b2005-06-12 22:21:29 -0500753 struct scsi_sense_hdr sshdr;
James Bottomley38582a62008-02-06 13:01:58 -0600754 int rc, n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Arjan van de Ven0ad78202005-11-28 16:22:25 +0100756 static const char *loadmech[] =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 {
758 "caddy",
759 "tray",
760 "pop-up",
761 "",
762 "changer",
763 "cartridge changer",
764 "",
765 ""
766 };
767
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
769 /* allocate transfer buffer */
770 buffer = kmalloc(512, GFP_KERNEL | GFP_DMA);
771 if (!buffer) {
772 printk(KERN_ERR "sr: out of memory.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 return;
774 }
775
James Bottomley38582a62008-02-06 13:01:58 -0600776 /* eat unit attentions */
777 sr_test_unit_ready(cd->device, &sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
779 /* ask for mode page 0x2a */
780 rc = scsi_mode_sense(cd->device, 0, 0x2a, buffer, 128,
James Bottomley1cf72692005-08-28 11:27:01 -0500781 SR_TIMEOUT, 3, &data, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
783 if (!scsi_status_is_good(rc)) {
784 /* failed, drive doesn't have capabilities mode page */
785 cd->cdi.speed = 1;
786 cd->cdi.mask |= (CDC_CD_R | CDC_CD_RW | CDC_DVD_R |
Chuck Ebbertbcc1e382006-01-11 23:58:40 -0500787 CDC_DVD | CDC_DVD_RAM |
788 CDC_SELECT_DISC | CDC_SELECT_SPEED |
789 CDC_MRW | CDC_MRW_W | CDC_RAM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 kfree(buffer);
791 printk("%s: scsi-1 drive\n", cd->cdi.name);
792 return;
793 }
794
795 n = data.header_length + data.block_descriptor_length;
796 cd->cdi.speed = ((buffer[n + 8] << 8) + buffer[n + 9]) / 176;
797 cd->readcd_known = 1;
798 cd->readcd_cdda = buffer[n + 5] & 0x01;
799 /* print some capability bits */
800 printk("%s: scsi3-mmc drive: %dx/%dx %s%s%s%s%s%s\n", cd->cdi.name,
801 ((buffer[n + 14] << 8) + buffer[n + 15]) / 176,
802 cd->cdi.speed,
803 buffer[n + 3] & 0x01 ? "writer " : "", /* CD Writer */
804 buffer[n + 3] & 0x20 ? "dvd-ram " : "",
805 buffer[n + 2] & 0x02 ? "cd/rw " : "", /* can read rewriteable */
806 buffer[n + 4] & 0x20 ? "xa/form2 " : "", /* can read xa/from2 */
807 buffer[n + 5] & 0x01 ? "cdda " : "", /* can read audio data */
808 loadmech[buffer[n + 6] >> 5]);
809 if ((buffer[n + 6] >> 5) == 0)
810 /* caddy drives can't close tray... */
811 cd->cdi.mask |= CDC_CLOSE_TRAY;
812 if ((buffer[n + 2] & 0x8) == 0)
813 /* not a DVD drive */
814 cd->cdi.mask |= CDC_DVD;
815 if ((buffer[n + 3] & 0x20) == 0)
816 /* can't write DVD-RAM media */
817 cd->cdi.mask |= CDC_DVD_RAM;
818 if ((buffer[n + 3] & 0x10) == 0)
819 /* can't write DVD-R media */
820 cd->cdi.mask |= CDC_DVD_R;
821 if ((buffer[n + 3] & 0x2) == 0)
822 /* can't write CD-RW media */
823 cd->cdi.mask |= CDC_CD_RW;
824 if ((buffer[n + 3] & 0x1) == 0)
825 /* can't write CD-R media */
826 cd->cdi.mask |= CDC_CD_R;
827 if ((buffer[n + 6] & 0x8) == 0)
828 /* can't eject */
829 cd->cdi.mask |= CDC_OPEN_TRAY;
830
831 if ((buffer[n + 6] >> 5) == mechtype_individual_changer ||
832 (buffer[n + 6] >> 5) == mechtype_cartridge_changer)
833 cd->cdi.capacity =
834 cdrom_number_of_slots(&cd->cdi);
835 if (cd->cdi.capacity <= 1)
836 /* not a changer */
837 cd->cdi.mask |= CDC_SELECT_DISC;
838 /*else I don't think it can close its tray
839 cd->cdi.mask |= CDC_CLOSE_TRAY; */
840
841 /*
842 * if DVD-RAM, MRW-W or CD-RW, we are randomly writable
843 */
844 if ((cd->cdi.mask & (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) !=
845 (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) {
846 cd->device->writeable = 1;
847 }
848
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 kfree(buffer);
850}
851
852/*
853 * sr_packet() is the entry point for the generic commands generated
854 * by the Uniform CD-ROM layer.
855 */
856static int sr_packet(struct cdrom_device_info *cdi,
857 struct packet_command *cgc)
858{
859 if (cgc->timeout <= 0)
860 cgc->timeout = IOCTL_TIMEOUT;
861
862 sr_do_ioctl(cdi->handle, cgc);
863
864 return cgc->stat;
865}
866
867/**
868 * sr_kref_release - Called to free the scsi_cd structure
869 * @kref: pointer to embedded kref
870 *
Arjan van de Ven0b950672006-01-11 13:16:10 +0100871 * sr_ref_mutex must be held entering this routine. Because it is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 * called on last put, you should always use the scsi_cd_get()
873 * scsi_cd_put() helpers which manipulate the semaphore directly
874 * and never do a direct kref_put().
875 **/
876static void sr_kref_release(struct kref *kref)
877{
878 struct scsi_cd *cd = container_of(kref, struct scsi_cd, kref);
879 struct gendisk *disk = cd->disk;
880
881 spin_lock(&sr_index_lock);
Tejun Heof331c022008-09-03 09:01:48 +0200882 clear_bit(MINOR(disk_devt(disk)), sr_index_bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 spin_unlock(&sr_index_lock);
884
885 unregister_cdrom(&cd->cdi);
886
887 disk->private_data = NULL;
888
889 put_disk(disk);
890
891 kfree(cd);
892}
893
894static int sr_remove(struct device *dev)
895{
896 struct scsi_cd *cd = dev_get_drvdata(dev);
897
898 del_gendisk(cd->disk);
899
Arjan van de Ven0b950672006-01-11 13:16:10 +0100900 mutex_lock(&sr_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 kref_put(&cd->kref, sr_kref_release);
Arjan van de Ven0b950672006-01-11 13:16:10 +0100902 mutex_unlock(&sr_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
904 return 0;
905}
906
907static int __init init_sr(void)
908{
909 int rc;
910
911 rc = register_blkdev(SCSI_CDROM_MAJOR, "sr");
912 if (rc)
913 return rc;
Akinobu Mitada3962f2007-06-26 00:39:33 +0900914 rc = scsi_register_driver(&sr_template.gendrv);
915 if (rc)
916 unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
917
918 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919}
920
921static void __exit exit_sr(void)
922{
923 scsi_unregister_driver(&sr_template.gendrv);
924 unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
925}
926
927module_init(init_sr);
928module_exit(exit_sr);
929MODULE_LICENSE("GPL");