]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/scsi/sr.c
Merge remote-tracking branches 'asoc/topic/adsp', 'asoc/topic/ak4613', 'asoc/topic...
[mirror_ubuntu-bionic-kernel.git] / drivers / scsi / sr.c
CommitLineData
1da177e4
LT
1/*
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>
1da177e4
LT
38#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>
0b950672 46#include <linux/mutex.h>
5a0e3ad6 47#include <linux/slab.h>
6c7f1e2f 48#include <linux/pm_runtime.h>
7c0f6ba6 49#include <linux/uaccess.h>
1da177e4
LT
50
51#include <scsi/scsi.h>
52#include <scsi/scsi_dbg.h>
53#include <scsi/scsi_device.h>
54#include <scsi/scsi_driver.h>
820732b5 55#include <scsi/scsi_cmnd.h>
1da177e4
LT
56#include <scsi/scsi_eh.h>
57#include <scsi/scsi_host.h>
58#include <scsi/scsi_ioctl.h> /* For the door lock/unlock commands */
1da177e4
LT
59
60#include "scsi_logging.h"
61#include "sr.h"
62
63
f018fa55
RH
64MODULE_DESCRIPTION("SCSI cdrom (sr) driver");
65MODULE_LICENSE("GPL");
66MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_CDROM_MAJOR);
d7b8bcb0
MT
67MODULE_ALIAS_SCSI_DEVICE(TYPE_ROM);
68MODULE_ALIAS_SCSI_DEVICE(TYPE_WORM);
f018fa55 69
1da177e4
LT
70#define SR_DISKS 256
71
1da177e4
LT
72#define SR_CAPABILITIES \
73 (CDC_CLOSE_TRAY|CDC_OPEN_TRAY|CDC_LOCK|CDC_SELECT_SPEED| \
74 CDC_SELECT_DISC|CDC_MULTI_SESSION|CDC_MCN|CDC_MEDIA_CHANGED| \
6a2900b6 75 CDC_PLAY_AUDIO|CDC_RESET|CDC_DRIVE_STATUS| \
1da177e4
LT
76 CDC_CD_R|CDC_CD_RW|CDC_DVD|CDC_DVD_R|CDC_DVD_RAM|CDC_GENERIC_PACKET| \
77 CDC_MRW|CDC_MRW_W|CDC_RAM)
78
2a48fc0a 79static DEFINE_MUTEX(sr_mutex);
1da177e4
LT
80static int sr_probe(struct device *);
81static int sr_remove(struct device *);
a1b73fc1 82static int sr_init_command(struct scsi_cmnd *SCpnt);
7b3d9545 83static int sr_done(struct scsi_cmnd *);
6c7f1e2f
AL
84static int sr_runtime_suspend(struct device *dev);
85
a816b4c6 86static const struct dev_pm_ops sr_pm_ops = {
6c7f1e2f
AL
87 .runtime_suspend = sr_runtime_suspend,
88};
1da177e4
LT
89
90static struct scsi_driver sr_template = {
1da177e4
LT
91 .gendrv = {
92 .name = "sr",
3af6b352 93 .owner = THIS_MODULE,
1da177e4
LT
94 .probe = sr_probe,
95 .remove = sr_remove,
6c7f1e2f 96 .pm = &sr_pm_ops,
1da177e4 97 },
a1b73fc1 98 .init_command = sr_init_command,
7b3d9545 99 .done = sr_done,
1da177e4
LT
100};
101
102static unsigned long sr_index_bits[SR_DISKS / BITS_PER_LONG];
103static DEFINE_SPINLOCK(sr_index_lock);
104
105/* This semaphore is used to mediate the 0->1 reference get in the
106 * face of object destruction (i.e. we can't allow a get on an
107 * object after last put) */
0b950672 108static DEFINE_MUTEX(sr_ref_mutex);
1da177e4
LT
109
110static int sr_open(struct cdrom_device_info *, int);
111static void sr_release(struct cdrom_device_info *);
112
113static void get_sectorsize(struct scsi_cd *);
114static void get_capabilities(struct scsi_cd *);
115
93aae17a
TH
116static unsigned int sr_check_events(struct cdrom_device_info *cdi,
117 unsigned int clearing, int slot);
1da177e4
LT
118static int sr_packet(struct cdrom_device_info *, struct packet_command *);
119
853fe1bf 120static const struct cdrom_device_ops sr_dops = {
1da177e4
LT
121 .open = sr_open,
122 .release = sr_release,
123 .drive_status = sr_drive_status,
93aae17a 124 .check_events = sr_check_events,
1da177e4
LT
125 .tray_move = sr_tray_move,
126 .lock_door = sr_lock_door,
127 .select_speed = sr_select_speed,
128 .get_last_session = sr_get_last_session,
129 .get_mcn = sr_get_mcn,
130 .reset = sr_reset,
131 .audio_ioctl = sr_audio_ioctl,
1da177e4
LT
132 .capability = SR_CAPABILITIES,
133 .generic_packet = sr_packet,
134};
135
136static void sr_kref_release(struct kref *kref);
137
138static inline struct scsi_cd *scsi_cd(struct gendisk *disk)
139{
140 return container_of(disk->private_data, struct scsi_cd, driver);
141}
142
6c7f1e2f
AL
143static int sr_runtime_suspend(struct device *dev)
144{
145 struct scsi_cd *cd = dev_get_drvdata(dev);
146
13b43891
AS
147 if (!cd) /* E.g.: runtime suspend following sr_remove() */
148 return 0;
149
6c7f1e2f
AL
150 if (cd->media_present)
151 return -EBUSY;
152 else
153 return 0;
154}
155
1da177e4
LT
156/*
157 * The get and put routines for the struct scsi_cd. Note this entity
158 * has a scsi_device pointer and owns a reference to this.
159 */
160static inline struct scsi_cd *scsi_cd_get(struct gendisk *disk)
161{
162 struct scsi_cd *cd = NULL;
163
0b950672 164 mutex_lock(&sr_ref_mutex);
1da177e4
LT
165 if (disk->private_data == NULL)
166 goto out;
167 cd = scsi_cd(disk);
168 kref_get(&cd->kref);
6627b38f
AL
169 if (scsi_device_get(cd->device)) {
170 kref_put(&cd->kref, sr_kref_release);
171 cd = NULL;
172 }
1da177e4 173 out:
0b950672 174 mutex_unlock(&sr_ref_mutex);
1da177e4
LT
175 return cd;
176}
177
858119e1 178static void scsi_cd_put(struct scsi_cd *cd)
1da177e4
LT
179{
180 struct scsi_device *sdev = cd->device;
181
0b950672 182 mutex_lock(&sr_ref_mutex);
1da177e4
LT
183 kref_put(&cd->kref, sr_kref_release);
184 scsi_device_put(sdev);
0b950672 185 mutex_unlock(&sr_ref_mutex);
1da177e4
LT
186}
187
93aae17a
TH
188static unsigned int sr_get_events(struct scsi_device *sdev)
189{
190 u8 buf[8];
191 u8 cmd[] = { GET_EVENT_STATUS_NOTIFICATION,
192 1, /* polled */
193 0, 0, /* reserved */
194 1 << 4, /* notification class: media */
195 0, 0, /* reserved */
196 0, sizeof(buf), /* allocation length */
197 0, /* control */
198 };
199 struct event_header *eh = (void *)buf;
200 struct media_event_desc *med = (void *)(buf + 4);
201 struct scsi_sense_hdr sshdr;
202 int result;
203
204 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, sizeof(buf),
205 &sshdr, SR_TIMEOUT, MAX_RETRIES, NULL);
206 if (scsi_sense_valid(&sshdr) && sshdr.sense_key == UNIT_ATTENTION)
207 return DISK_EVENT_MEDIA_CHANGE;
208
209 if (result || be16_to_cpu(eh->data_len) < sizeof(*med))
210 return 0;
211
212 if (eh->nea || eh->notification_class != 0x4)
213 return 0;
214
215 if (med->media_event_code == 1)
216 return DISK_EVENT_EJECT_REQUEST;
217 else if (med->media_event_code == 2)
218 return DISK_EVENT_MEDIA_CHANGE;
219 return 0;
220}
221
1da177e4 222/*
93aae17a
TH
223 * This function checks to see if the media has been changed or eject
224 * button has been pressed. It is possible that we have already
225 * sensed a change, or the drive may have sensed one and not yet
226 * reported it. The past events are accumulated in sdev->changed and
227 * returned together with the current state.
1da177e4 228 */
93aae17a
TH
229static unsigned int sr_check_events(struct cdrom_device_info *cdi,
230 unsigned int clearing, int slot)
1da177e4
LT
231{
232 struct scsi_cd *cd = cdi->handle;
93aae17a
TH
233 bool last_present;
234 struct scsi_sense_hdr sshdr;
235 unsigned int events;
236 int ret;
1da177e4 237
93aae17a
TH
238 /* no changer support */
239 if (CDSL_CURRENT != slot)
240 return 0;
241
242 events = sr_get_events(cd->device);
79b9677d
KS
243 cd->get_event_changed |= events & DISK_EVENT_MEDIA_CHANGE;
244
245 /*
246 * If earlier GET_EVENT_STATUS_NOTIFICATION and TUR did not agree
247 * for several times in a row. We rely on TUR only for this likely
248 * broken device, to prevent generating incorrect media changed
249 * events for every open().
250 */
251 if (cd->ignore_get_event) {
252 events &= ~DISK_EVENT_MEDIA_CHANGE;
253 goto do_tur;
254 }
255
93aae17a
TH
256 /*
257 * GET_EVENT_STATUS_NOTIFICATION is enough unless MEDIA_CHANGE
258 * is being cleared. Note that there are devices which hang
259 * if asked to execute TUR repeatedly.
260 */
79b9677d
KS
261 if (cd->device->changed) {
262 events |= DISK_EVENT_MEDIA_CHANGE;
263 cd->device->changed = 0;
264 cd->tur_changed = true;
265 }
93aae17a 266
79b9677d
KS
267 if (!(clearing & DISK_EVENT_MEDIA_CHANGE))
268 return events;
269do_tur:
93aae17a
TH
270 /* let's see whether the media is there with TUR */
271 last_present = cd->media_present;
272 ret = scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr);
1da177e4 273
638428ec
TH
274 /*
275 * Media is considered to be present if TUR succeeds or fails with
276 * sense data indicating something other than media-not-present
277 * (ASC 0x3a).
278 */
93aae17a
TH
279 cd->media_present = scsi_status_is_good(ret) ||
280 (scsi_sense_valid(&sshdr) && sshdr.asc != 0x3a);
1da177e4 281
93aae17a 282 if (last_present != cd->media_present)
79b9677d
KS
283 cd->device->changed = 1;
284
93aae17a
TH
285 if (cd->device->changed) {
286 events |= DISK_EVENT_MEDIA_CHANGE;
287 cd->device->changed = 0;
79b9677d
KS
288 cd->tur_changed = true;
289 }
290
291 if (cd->ignore_get_event)
292 return events;
293
294 /* check whether GET_EVENT is reporting spurious MEDIA_CHANGE */
295 if (!cd->tur_changed) {
296 if (cd->get_event_changed) {
297 if (cd->tur_mismatch++ > 8) {
96eefad2
HR
298 sr_printk(KERN_WARNING, cd,
299 "GET_EVENT and TUR disagree continuously, suppress GET_EVENT events\n");
79b9677d
KS
300 cd->ignore_get_event = true;
301 }
302 } else {
303 cd->tur_mismatch = 0;
304 }
1da177e4 305 }
79b9677d
KS
306 cd->tur_changed = false;
307 cd->get_event_changed = false;
285e9670 308
93aae17a 309 return events;
1da177e4 310}
93aae17a 311
1da177e4 312/*
7b3d9545 313 * sr_done is the interrupt routine for the device driver.
1da177e4 314 *
7b3d9545 315 * It will be notified on the end of a SCSI read / write, and will take one
1da177e4
LT
316 * of several actions based on success or failure.
317 */
7b3d9545 318static int sr_done(struct scsi_cmnd *SCpnt)
1da177e4
LT
319{
320 int result = SCpnt->result;
30b0c37b 321 int this_count = scsi_bufflen(SCpnt);
1da177e4
LT
322 int good_bytes = (result == 0 ? this_count : 0);
323 int block_sectors = 0;
324 long error_sector;
325 struct scsi_cd *cd = scsi_cd(SCpnt->request->rq_disk);
326
327#ifdef DEBUG
96eefad2 328 scmd_printk(KERN_INFO, SCpnt, "done: %x\n", result);
1da177e4
LT
329#endif
330
331 /*
332 * Handle MEDIUM ERRORs or VOLUME OVERFLOWs that indicate partial
333 * success. Since this is a relatively rare error condition, no
334 * care is taken to avoid unnecessary additional work such as
335 * memcpy's that could be avoided.
336 */
337 if (driver_byte(result) != 0 && /* An error occurred */
338 (SCpnt->sense_buffer[0] & 0x7f) == 0x70) { /* Sense current */
339 switch (SCpnt->sense_buffer[2]) {
340 case MEDIUM_ERROR:
341 case VOLUME_OVERFLOW:
342 case ILLEGAL_REQUEST:
343 if (!(SCpnt->sense_buffer[0] & 0x90))
344 break;
1da177e4
LT
345 error_sector = (SCpnt->sense_buffer[3] << 24) |
346 (SCpnt->sense_buffer[4] << 16) |
347 (SCpnt->sense_buffer[5] << 8) |
348 SCpnt->sense_buffer[6];
349 if (SCpnt->request->bio != NULL)
350 block_sectors =
351 bio_sectors(SCpnt->request->bio);
352 if (block_sectors < 4)
353 block_sectors = 4;
354 if (cd->device->sector_size == 2048)
355 error_sector <<= 2;
356 error_sector &= ~(block_sectors - 1);
83096ebf
TH
357 good_bytes = (error_sector -
358 blk_rq_pos(SCpnt->request)) << 9;
1da177e4
LT
359 if (good_bytes < 0 || good_bytes >= this_count)
360 good_bytes = 0;
361 /*
362 * The SCSI specification allows for the value
363 * returned by READ CAPACITY to be up to 75 2K
364 * sectors past the last readable block.
365 * Therefore, if we hit a medium error within the
366 * last 75 2K sectors, we decrease the saved size
367 * value.
368 */
369 if (error_sector < get_capacity(cd->disk) &&
370 cd->capacity - error_sector < 4 * 75)
371 set_capacity(cd->disk, error_sector);
372 break;
373
374 case RECOVERED_ERROR:
1da177e4
LT
375 good_bytes = this_count;
376 break;
377
378 default:
379 break;
380 }
381 }
382
7b3d9545 383 return good_bytes;
1da177e4
LT
384}
385
a1b73fc1 386static int sr_init_command(struct scsi_cmnd *SCpnt)
1da177e4 387{
242f9dcb 388 int block = 0, this_count, s_size;
7f9a6bc4 389 struct scsi_cd *cd;
a1b73fc1 390 struct request *rq = SCpnt->request;
7f9a6bc4
JB
391 int ret;
392
3c356bde 393 ret = scsi_init_io(SCpnt);
7f9a6bc4
JB
394 if (ret != BLKPREP_OK)
395 goto out;
396 SCpnt = rq->special;
397 cd = scsi_cd(rq->rq_disk);
398
399 /* from here on until we're complete, any goto out
400 * is used for a killable error condition */
401 ret = BLKPREP_KILL;
1da177e4 402
96eefad2
HR
403 SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
404 "Doing sr request, block = %d\n", block));
1da177e4
LT
405
406 if (!cd->device || !scsi_device_online(cd->device)) {
96eefad2
HR
407 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
408 "Finishing %u sectors\n", blk_rq_sectors(rq)));
409 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
410 "Retry with 0x%p\n", SCpnt));
7f9a6bc4 411 goto out;
1da177e4
LT
412 }
413
414 if (cd->device->changed) {
415 /*
416 * quietly refuse to do anything to a changed disc until the
417 * changed bit has been reset
418 */
7f9a6bc4 419 goto out;
1da177e4
LT
420 }
421
1da177e4
LT
422 /*
423 * we do lazy blocksize switching (when reading XA sectors,
424 * see CDROMREADMODE2 ioctl)
425 */
426 s_size = cd->device->sector_size;
427 if (s_size > 2048) {
428 if (!in_interrupt())
429 sr_set_blocklength(cd, 2048);
430 else
96eefad2
HR
431 scmd_printk(KERN_INFO, SCpnt,
432 "can't switch blocksize: in interrupt\n");
1da177e4
LT
433 }
434
435 if (s_size != 512 && s_size != 1024 && s_size != 2048) {
3bf743e7 436 scmd_printk(KERN_ERR, SCpnt, "bad sector size %d\n", s_size);
7f9a6bc4 437 goto out;
1da177e4
LT
438 }
439
aebf526b
CH
440 switch (req_op(rq)) {
441 case REQ_OP_WRITE:
fd2eb903 442 if (!cd->writeable)
7f9a6bc4 443 goto out;
1da177e4 444 SCpnt->cmnd[0] = WRITE_10;
96eefad2 445 cd->cdi.media_written = 1;
aebf526b
CH
446 break;
447 case REQ_OP_READ:
1da177e4 448 SCpnt->cmnd[0] = READ_10;
aebf526b
CH
449 break;
450 default:
7f9a6bc4
JB
451 blk_dump_rq_flags(rq, "Unknown sr command");
452 goto out;
1da177e4
LT
453 }
454
455 {
30b0c37b
BH
456 struct scatterlist *sg;
457 int i, size = 0, sg_count = scsi_sg_count(SCpnt);
1da177e4 458
30b0c37b
BH
459 scsi_for_each_sg(SCpnt, sg, sg_count, i)
460 size += sg->length;
461
462 if (size != scsi_bufflen(SCpnt)) {
3bf743e7
JG
463 scmd_printk(KERN_ERR, SCpnt,
464 "mismatch count %d, bytes %d\n",
30b0c37b
BH
465 size, scsi_bufflen(SCpnt));
466 if (scsi_bufflen(SCpnt) > size)
467 SCpnt->sdb.length = size;
1da177e4
LT
468 }
469 }
470
471 /*
472 * request doesn't start on hw block boundary, add scatter pads
473 */
83096ebf 474 if (((unsigned int)blk_rq_pos(rq) % (s_size >> 9)) ||
30b0c37b 475 (scsi_bufflen(SCpnt) % s_size)) {
3bf743e7 476 scmd_printk(KERN_NOTICE, SCpnt, "unaligned transfer\n");
7f9a6bc4 477 goto out;
1da177e4
LT
478 }
479
30b0c37b 480 this_count = (scsi_bufflen(SCpnt) >> 9) / (s_size >> 9);
1da177e4
LT
481
482
96eefad2
HR
483 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
484 "%s %d/%u 512 byte blocks.\n",
485 (rq_data_dir(rq) == WRITE) ?
1da177e4 486 "writing" : "reading",
96eefad2 487 this_count, blk_rq_sectors(rq)));
1da177e4
LT
488
489 SCpnt->cmnd[1] = 0;
83096ebf 490 block = (unsigned int)blk_rq_pos(rq) / (s_size >> 9);
1da177e4
LT
491
492 if (this_count > 0xffff) {
493 this_count = 0xffff;
30b0c37b 494 SCpnt->sdb.length = this_count * s_size;
1da177e4
LT
495 }
496
497 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
498 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
499 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
500 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
501 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
502 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
503 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
504
505 /*
506 * We shouldn't disconnect in the middle of a sector, so with a dumb
507 * host adapter, it's safe to assume that we can at least transfer
508 * this many bytes between each connect / disconnect.
509 */
510 SCpnt->transfersize = cd->device->sector_size;
511 SCpnt->underflow = this_count << 9;
1da177e4 512 SCpnt->allowed = MAX_RETRIES;
1da177e4 513
1da177e4
LT
514 /*
515 * This indicates that the command is ready from our end to be
516 * queued.
517 */
7f9a6bc4
JB
518 ret = BLKPREP_OK;
519 out:
a1b73fc1 520 return ret;
1da177e4
LT
521}
522
40cc51be 523static int sr_block_open(struct block_device *bdev, fmode_t mode)
1da177e4 524{
6e9624b8 525 struct scsi_cd *cd;
40cc51be 526 int ret = -ENXIO;
1da177e4 527
2a48fc0a 528 mutex_lock(&sr_mutex);
6e9624b8 529 cd = scsi_cd_get(bdev->bd_disk);
40cc51be
AV
530 if (cd) {
531 ret = cdrom_open(&cd->cdi, bdev, mode);
532 if (ret)
533 scsi_cd_put(cd);
534 }
2a48fc0a 535 mutex_unlock(&sr_mutex);
1da177e4
LT
536 return ret;
537}
538
db2a144b 539static void sr_block_release(struct gendisk *disk, fmode_t mode)
1da177e4 540{
40cc51be 541 struct scsi_cd *cd = scsi_cd(disk);
2a48fc0a 542 mutex_lock(&sr_mutex);
40cc51be 543 cdrom_release(&cd->cdi, mode);
1da177e4 544 scsi_cd_put(cd);
2a48fc0a 545 mutex_unlock(&sr_mutex);
1da177e4
LT
546}
547
40cc51be 548static int sr_block_ioctl(struct block_device *bdev, fmode_t mode, unsigned cmd,
1da177e4
LT
549 unsigned long arg)
550{
40cc51be 551 struct scsi_cd *cd = scsi_cd(bdev->bd_disk);
1da177e4 552 struct scsi_device *sdev = cd->device;
6a2900b6
CH
553 void __user *argp = (void __user *)arg;
554 int ret;
1da177e4 555
2a48fc0a 556 mutex_lock(&sr_mutex);
8a6cfeb6 557
906d15fb
CH
558 ret = scsi_ioctl_block_when_processing_errors(sdev, cmd,
559 (mode & FMODE_NDELAY) != 0);
560 if (ret)
561 goto out;
562
6a2900b6
CH
563 /*
564 * Send SCSI addressing ioctls directly to mid level, send other
565 * ioctls to cdrom/block level.
566 */
567 switch (cmd) {
568 case SCSI_IOCTL_GET_IDLUN:
569 case SCSI_IOCTL_GET_BUS_NUMBER:
8a6cfeb6
AB
570 ret = scsi_ioctl(sdev, cmd, argp);
571 goto out;
1da177e4 572 }
6a2900b6 573
40cc51be 574 ret = cdrom_ioctl(&cd->cdi, bdev, mode, cmd, arg);
6397256b 575 if (ret != -ENOSYS)
8a6cfeb6 576 goto out;
6a2900b6 577
8a6cfeb6
AB
578 ret = scsi_ioctl(sdev, cmd, argp);
579
580out:
2a48fc0a 581 mutex_unlock(&sr_mutex);
8a6cfeb6 582 return ret;
1da177e4
LT
583}
584
93aae17a
TH
585static unsigned int sr_block_check_events(struct gendisk *disk,
586 unsigned int clearing)
1da177e4
LT
587{
588 struct scsi_cd *cd = scsi_cd(disk);
6c7f1e2f 589
6627b38f
AL
590 if (atomic_read(&cd->device->disk_events_disable_depth))
591 return 0;
6c7f1e2f 592
6627b38f 593 return cdrom_check_events(&cd->cdi, clearing);
93aae17a
TH
594}
595
596static int sr_block_revalidate_disk(struct gendisk *disk)
597{
598 struct scsi_cd *cd = scsi_cd(disk);
599 struct scsi_sense_hdr sshdr;
600
601 /* if the unit is not ready, nothing more to do */
602 if (scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr))
6c7f1e2f 603 goto out;
93aae17a
TH
604
605 sr_cd_check(&cd->cdi);
606 get_sectorsize(cd);
6c7f1e2f 607out:
93aae17a 608 return 0;
1da177e4
LT
609}
610
83d5cde4 611static const struct block_device_operations sr_bdops =
1da177e4
LT
612{
613 .owner = THIS_MODULE,
40cc51be
AV
614 .open = sr_block_open,
615 .release = sr_block_release,
8a6cfeb6 616 .ioctl = sr_block_ioctl,
93aae17a
TH
617 .check_events = sr_block_check_events,
618 .revalidate_disk = sr_block_revalidate_disk,
1da177e4
LT
619 /*
620 * No compat_ioctl for now because sr_block_ioctl never
25985edc 621 * seems to pass arbitrary ioctls down to host drivers.
1da177e4
LT
622 */
623};
624
625static int sr_open(struct cdrom_device_info *cdi, int purpose)
626{
627 struct scsi_cd *cd = cdi->handle;
628 struct scsi_device *sdev = cd->device;
629 int retval;
630
631 /*
632 * If the device is in error recovery, wait until it is done.
633 * If the device is offline, then disallow any access to it.
634 */
635 retval = -ENXIO;
636 if (!scsi_block_when_processing_errors(sdev))
637 goto error_out;
638
1da177e4
LT
639 return 0;
640
641error_out:
642 return retval;
643}
644
645static void sr_release(struct cdrom_device_info *cdi)
646{
647 struct scsi_cd *cd = cdi->handle;
648
649 if (cd->device->sector_size > 2048)
650 sr_set_blocklength(cd, 2048);
651
652}
653
654static int sr_probe(struct device *dev)
655{
656 struct scsi_device *sdev = to_scsi_device(dev);
657 struct gendisk *disk;
658 struct scsi_cd *cd;
659 int minor, error;
660
6fe8c1db 661 scsi_autopm_get_device(sdev);
1da177e4
LT
662 error = -ENODEV;
663 if (sdev->type != TYPE_ROM && sdev->type != TYPE_WORM)
664 goto fail;
665
666 error = -ENOMEM;
24669f75 667 cd = kzalloc(sizeof(*cd), GFP_KERNEL);
1da177e4
LT
668 if (!cd)
669 goto fail;
1da177e4
LT
670
671 kref_init(&cd->kref);
672
673 disk = alloc_disk(1);
674 if (!disk)
675 goto fail_free;
676
677 spin_lock(&sr_index_lock);
678 minor = find_first_zero_bit(sr_index_bits, SR_DISKS);
679 if (minor == SR_DISKS) {
680 spin_unlock(&sr_index_lock);
681 error = -EBUSY;
682 goto fail_put;
683 }
684 __set_bit(minor, sr_index_bits);
685 spin_unlock(&sr_index_lock);
686
687 disk->major = SCSI_CDROM_MAJOR;
688 disk->first_minor = minor;
689 sprintf(disk->disk_name, "sr%d", minor);
690 disk->fops = &sr_bdops;
d4dc210f 691 disk->flags = GENHD_FL_CD | GENHD_FL_BLOCK_EVENTS_ON_EXCL_WRITE;
93aae17a 692 disk->events = DISK_EVENT_MEDIA_CHANGE | DISK_EVENT_EJECT_REQUEST;
1da177e4 693
242f9dcb
JA
694 blk_queue_rq_timeout(sdev->request_queue, SR_TIMEOUT);
695
1da177e4
LT
696 cd->device = sdev;
697 cd->disk = disk;
698 cd->driver = &sr_template;
699 cd->disk = disk;
700 cd->capacity = 0x1fffff;
1da177e4 701 cd->device->changed = 1; /* force recheck CD type */
93aae17a 702 cd->media_present = 1;
1da177e4
LT
703 cd->use = 1;
704 cd->readcd_known = 0;
705 cd->readcd_cdda = 0;
706
707 cd->cdi.ops = &sr_dops;
708 cd->cdi.handle = cd;
709 cd->cdi.mask = 0;
710 cd->cdi.capacity = 1;
711 sprintf(cd->cdi.name, "sr%d", minor);
712
713 sdev->sector_size = 2048; /* A guess, just in case */
714
715 /* FIXME: need to handle a get_capabilities failure properly ?? */
716 get_capabilities(cd);
717 sr_vendor_init(cd);
718
1da177e4
LT
719 set_capacity(disk, cd->capacity);
720 disk->private_data = &cd->driver;
721 disk->queue = sdev->request_queue;
722 cd->cdi.disk = disk;
723
724 if (register_cdrom(&cd->cdi))
725 goto fail_put;
726
6627b38f
AL
727 /*
728 * Initialize block layer runtime PM stuffs before the
729 * periodic event checking request gets started in add_disk.
730 */
731 blk_pm_runtime_init(sdev->request_queue, dev);
732
1da177e4
LT
733 dev_set_drvdata(dev, cd);
734 disk->flags |= GENHD_FL_REMOVABLE;
0d52c756 735 device_add_disk(&sdev->sdev_gendev, disk);
1da177e4 736
9ccfc756
JB
737 sdev_printk(KERN_DEBUG, sdev,
738 "Attached scsi CD-ROM %s\n", cd->cdi.name);
6c7f1e2f
AL
739 scsi_autopm_put_device(cd->device);
740
1da177e4
LT
741 return 0;
742
743fail_put:
744 put_disk(disk);
745fail_free:
746 kfree(cd);
747fail:
6fe8c1db 748 scsi_autopm_put_device(sdev);
1da177e4
LT
749 return error;
750}
751
752
753static void get_sectorsize(struct scsi_cd *cd)
754{
755 unsigned char cmd[10];
62858dac 756 unsigned char buffer[8];
1da177e4
LT
757 int the_result, retries = 3;
758 int sector_size;
165125e1 759 struct request_queue *queue;
1da177e4 760
1da177e4
LT
761 do {
762 cmd[0] = READ_CAPACITY;
763 memset((void *) &cmd[1], 0, 9);
62858dac 764 memset(buffer, 0, sizeof(buffer));
1da177e4
LT
765
766 /* Do the command and wait.. */
820732b5 767 the_result = scsi_execute_req(cd->device, cmd, DMA_FROM_DEVICE,
62858dac 768 buffer, sizeof(buffer), NULL,
f4f4e47e 769 SR_TIMEOUT, MAX_RETRIES, NULL);
1da177e4 770
1da177e4
LT
771 retries--;
772
773 } while (the_result && retries);
774
775
1da177e4
LT
776 if (the_result) {
777 cd->capacity = 0x1fffff;
778 sector_size = 2048; /* A guess, just in case */
1da177e4 779 } else {
5915136d
TH
780 long last_written;
781
782 cd->capacity = 1 + ((buffer[0] << 24) | (buffer[1] << 16) |
783 (buffer[2] << 8) | buffer[3]);
784 /*
785 * READ_CAPACITY doesn't return the correct size on
786 * certain UDF media. If last_written is larger, use
787 * it instead.
788 *
789 * http://bugzilla.kernel.org/show_bug.cgi?id=9668
790 */
791 if (!cdrom_get_last_written(&cd->cdi, &last_written))
792 cd->capacity = max_t(long, cd->capacity, last_written);
793
1da177e4
LT
794 sector_size = (buffer[4] << 24) |
795 (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
796 switch (sector_size) {
797 /*
798 * HP 4020i CD-Recorder reports 2340 byte sectors
799 * Philips CD-Writers report 2352 byte sectors
800 *
801 * Use 2k sectors for them..
802 */
803 case 0:
804 case 2340:
805 case 2352:
806 sector_size = 2048;
807 /* fall through */
808 case 2048:
809 cd->capacity *= 4;
810 /* fall through */
811 case 512:
812 break;
813 default:
96eefad2
HR
814 sr_printk(KERN_INFO, cd,
815 "unsupported sector size %d.", sector_size);
1da177e4 816 cd->capacity = 0;
1da177e4
LT
817 }
818
819 cd->device->sector_size = sector_size;
820
821 /*
822 * Add this so that we have the ability to correctly gauge
823 * what the device is capable of.
824 */
1da177e4
LT
825 set_capacity(cd->disk, cd->capacity);
826 }
827
828 queue = cd->device->request_queue;
e1defc4f 829 blk_queue_logical_block_size(queue, sector_size);
1da177e4 830
62858dac 831 return;
1da177e4
LT
832}
833
834static void get_capabilities(struct scsi_cd *cd)
835{
836 unsigned char *buffer;
837 struct scsi_mode_data data;
820732b5 838 struct scsi_sense_hdr sshdr;
a00a7862 839 unsigned int ms_len = 128;
38582a62 840 int rc, n;
1da177e4 841
0ad78200 842 static const char *loadmech[] =
1da177e4
LT
843 {
844 "caddy",
845 "tray",
846 "pop-up",
847 "",
848 "changer",
849 "cartridge changer",
850 "",
851 ""
852 };
853
1da177e4
LT
854
855 /* allocate transfer buffer */
856 buffer = kmalloc(512, GFP_KERNEL | GFP_DMA);
857 if (!buffer) {
96eefad2 858 sr_printk(KERN_ERR, cd, "out of memory.\n");
1da177e4
LT
859 return;
860 }
861
38582a62 862 /* eat unit attentions */
9f8a2c23 863 scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr);
1da177e4
LT
864
865 /* ask for mode page 0x2a */
a00a7862 866 rc = scsi_mode_sense(cd->device, 0, 0x2a, buffer, ms_len,
1cf72699 867 SR_TIMEOUT, 3, &data, NULL);
1da177e4 868
a00a7862
MP
869 if (!scsi_status_is_good(rc) || data.length > ms_len ||
870 data.header_length + data.block_descriptor_length > data.length) {
1da177e4
LT
871 /* failed, drive doesn't have capabilities mode page */
872 cd->cdi.speed = 1;
873 cd->cdi.mask |= (CDC_CD_R | CDC_CD_RW | CDC_DVD_R |
bcc1e382
CE
874 CDC_DVD | CDC_DVD_RAM |
875 CDC_SELECT_DISC | CDC_SELECT_SPEED |
876 CDC_MRW | CDC_MRW_W | CDC_RAM);
1da177e4 877 kfree(buffer);
96eefad2 878 sr_printk(KERN_INFO, cd, "scsi-1 drive");
1da177e4
LT
879 return;
880 }
881
882 n = data.header_length + data.block_descriptor_length;
883 cd->cdi.speed = ((buffer[n + 8] << 8) + buffer[n + 9]) / 176;
884 cd->readcd_known = 1;
885 cd->readcd_cdda = buffer[n + 5] & 0x01;
886 /* print some capability bits */
96eefad2
HR
887 sr_printk(KERN_INFO, cd,
888 "scsi3-mmc drive: %dx/%dx %s%s%s%s%s%s\n",
889 ((buffer[n + 14] << 8) + buffer[n + 15]) / 176,
890 cd->cdi.speed,
891 buffer[n + 3] & 0x01 ? "writer " : "", /* CD Writer */
892 buffer[n + 3] & 0x20 ? "dvd-ram " : "",
893 buffer[n + 2] & 0x02 ? "cd/rw " : "", /* can read rewriteable */
894 buffer[n + 4] & 0x20 ? "xa/form2 " : "", /* can read xa/from2 */
895 buffer[n + 5] & 0x01 ? "cdda " : "", /* can read audio data */
896 loadmech[buffer[n + 6] >> 5]);
1da177e4
LT
897 if ((buffer[n + 6] >> 5) == 0)
898 /* caddy drives can't close tray... */
899 cd->cdi.mask |= CDC_CLOSE_TRAY;
900 if ((buffer[n + 2] & 0x8) == 0)
901 /* not a DVD drive */
902 cd->cdi.mask |= CDC_DVD;
96eefad2 903 if ((buffer[n + 3] & 0x20) == 0)
1da177e4
LT
904 /* can't write DVD-RAM media */
905 cd->cdi.mask |= CDC_DVD_RAM;
906 if ((buffer[n + 3] & 0x10) == 0)
907 /* can't write DVD-R media */
908 cd->cdi.mask |= CDC_DVD_R;
909 if ((buffer[n + 3] & 0x2) == 0)
910 /* can't write CD-RW media */
911 cd->cdi.mask |= CDC_CD_RW;
912 if ((buffer[n + 3] & 0x1) == 0)
913 /* can't write CD-R media */
914 cd->cdi.mask |= CDC_CD_R;
915 if ((buffer[n + 6] & 0x8) == 0)
916 /* can't eject */
917 cd->cdi.mask |= CDC_OPEN_TRAY;
918
919 if ((buffer[n + 6] >> 5) == mechtype_individual_changer ||
920 (buffer[n + 6] >> 5) == mechtype_cartridge_changer)
921 cd->cdi.capacity =
922 cdrom_number_of_slots(&cd->cdi);
923 if (cd->cdi.capacity <= 1)
924 /* not a changer */
925 cd->cdi.mask |= CDC_SELECT_DISC;
926 /*else I don't think it can close its tray
927 cd->cdi.mask |= CDC_CLOSE_TRAY; */
928
929 /*
930 * if DVD-RAM, MRW-W or CD-RW, we are randomly writable
931 */
932 if ((cd->cdi.mask & (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) !=
933 (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) {
fd2eb903 934 cd->writeable = 1;
1da177e4
LT
935 }
936
1da177e4
LT
937 kfree(buffer);
938}
939
940/*
941 * sr_packet() is the entry point for the generic commands generated
96eefad2 942 * by the Uniform CD-ROM layer.
1da177e4
LT
943 */
944static int sr_packet(struct cdrom_device_info *cdi,
945 struct packet_command *cgc)
946{
8e04d805
HG
947 struct scsi_cd *cd = cdi->handle;
948 struct scsi_device *sdev = cd->device;
949
950 if (cgc->cmd[0] == GPCMD_READ_DISC_INFO && sdev->no_read_disc_info)
951 return -EDRIVE_CANT_DO_THIS;
952
1da177e4
LT
953 if (cgc->timeout <= 0)
954 cgc->timeout = IOCTL_TIMEOUT;
955
8e04d805 956 sr_do_ioctl(cd, cgc);
1da177e4
LT
957
958 return cgc->stat;
959}
960
961/**
962 * sr_kref_release - Called to free the scsi_cd structure
963 * @kref: pointer to embedded kref
964 *
0b950672 965 * sr_ref_mutex must be held entering this routine. Because it is
1da177e4
LT
966 * called on last put, you should always use the scsi_cd_get()
967 * scsi_cd_put() helpers which manipulate the semaphore directly
968 * and never do a direct kref_put().
969 **/
970static void sr_kref_release(struct kref *kref)
971{
972 struct scsi_cd *cd = container_of(kref, struct scsi_cd, kref);
973 struct gendisk *disk = cd->disk;
974
975 spin_lock(&sr_index_lock);
f331c029 976 clear_bit(MINOR(disk_devt(disk)), sr_index_bits);
1da177e4
LT
977 spin_unlock(&sr_index_lock);
978
979 unregister_cdrom(&cd->cdi);
980
981 disk->private_data = NULL;
982
983 put_disk(disk);
984
985 kfree(cd);
986}
987
988static int sr_remove(struct device *dev)
989{
990 struct scsi_cd *cd = dev_get_drvdata(dev);
991
6c7f1e2f
AL
992 scsi_autopm_get_device(cd->device);
993
1da177e4 994 del_gendisk(cd->disk);
13b43891 995 dev_set_drvdata(dev, NULL);
1da177e4 996
0b950672 997 mutex_lock(&sr_ref_mutex);
1da177e4 998 kref_put(&cd->kref, sr_kref_release);
0b950672 999 mutex_unlock(&sr_ref_mutex);
1da177e4
LT
1000
1001 return 0;
1002}
1003
1004static int __init init_sr(void)
1005{
1006 int rc;
1007
1008 rc = register_blkdev(SCSI_CDROM_MAJOR, "sr");
1009 if (rc)
1010 return rc;
da3962fe
AM
1011 rc = scsi_register_driver(&sr_template.gendrv);
1012 if (rc)
1013 unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
1014
1015 return rc;
1da177e4
LT
1016}
1017
1018static void __exit exit_sr(void)
1019{
1020 scsi_unregister_driver(&sr_template.gendrv);
1021 unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
1022}
1023
1024module_init(init_sr);
1025module_exit(exit_sr);
1026MODULE_LICENSE("GPL");