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