Merge tag 'mips_fixes_4.18_2' of git://git.kernel.org/pub/scm/linux/kernel/git/mips...
[linux-2.6-block.git] / drivers / scsi / sr_ioctl.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
1da177e4 2#include <linux/kernel.h>
1da177e4
LT
3#include <linux/mm.h>
4#include <linux/fs.h>
5#include <linux/errno.h>
6#include <linux/string.h>
7#include <linux/blkdev.h>
acf3368f 8#include <linux/module.h>
1da177e4
LT
9#include <linux/blkpg.h>
10#include <linux/cdrom.h>
11#include <linux/delay.h>
5a0e3ad6 12#include <linux/slab.h>
1da177e4 13#include <asm/io.h>
7c0f6ba6 14#include <linux/uaccess.h>
1da177e4
LT
15
16#include <scsi/scsi.h>
17#include <scsi/scsi_dbg.h>
18#include <scsi/scsi_device.h>
19#include <scsi/scsi_eh.h>
20#include <scsi/scsi_host.h>
21#include <scsi/scsi_ioctl.h>
820732b5 22#include <scsi/scsi_cmnd.h>
1da177e4
LT
23
24#include "sr.h"
25
26#if 0
27#define DEBUG
28#endif
29
30/* The sr_is_xa() seems to trigger firmware bugs with some drives :-(
31 * It is off by default and can be turned on with this module parameter */
32static int xa_test = 0;
33
34module_param(xa_test, int, S_IRUGO | S_IWUSR);
35
a09c6311
CH
36/* primitive to determine whether we need to have GFP_DMA set based on
37 * the status of the unchecked_isa_dma flag in the host structure */
38#define SR_GFP_DMA(cd) (((cd)->device->host->unchecked_isa_dma) ? GFP_DMA : 0)
39
a09c6311
CH
40static int sr_read_tochdr(struct cdrom_device_info *cdi,
41 struct cdrom_tochdr *tochdr)
42{
43 struct scsi_cd *cd = cdi->handle;
44 struct packet_command cgc;
45 int result;
46 unsigned char *buffer;
47
48 buffer = kmalloc(32, GFP_KERNEL | SR_GFP_DMA(cd));
49 if (!buffer)
50 return -ENOMEM;
51
52 memset(&cgc, 0, sizeof(struct packet_command));
53 cgc.timeout = IOCTL_TIMEOUT;
54 cgc.cmd[0] = GPCMD_READ_TOC_PMA_ATIP;
55 cgc.cmd[8] = 12; /* LSB of length */
56 cgc.buffer = buffer;
57 cgc.buflen = 12;
58 cgc.quiet = 1;
59 cgc.data_direction = DMA_FROM_DEVICE;
60
61 result = sr_do_ioctl(cd, &cgc);
62
63 tochdr->cdth_trk0 = buffer[2];
64 tochdr->cdth_trk1 = buffer[3];
65
66 kfree(buffer);
67 return result;
68}
69
70static int sr_read_tocentry(struct cdrom_device_info *cdi,
71 struct cdrom_tocentry *tocentry)
72{
73 struct scsi_cd *cd = cdi->handle;
74 struct packet_command cgc;
75 int result;
76 unsigned char *buffer;
77
78 buffer = kmalloc(32, GFP_KERNEL | SR_GFP_DMA(cd));
79 if (!buffer)
80 return -ENOMEM;
81
82 memset(&cgc, 0, sizeof(struct packet_command));
83 cgc.timeout = IOCTL_TIMEOUT;
84 cgc.cmd[0] = GPCMD_READ_TOC_PMA_ATIP;
85 cgc.cmd[1] |= (tocentry->cdte_format == CDROM_MSF) ? 0x02 : 0;
86 cgc.cmd[6] = tocentry->cdte_track;
87 cgc.cmd[8] = 12; /* LSB of length */
88 cgc.buffer = buffer;
89 cgc.buflen = 12;
90 cgc.data_direction = DMA_FROM_DEVICE;
91
92 result = sr_do_ioctl(cd, &cgc);
93
94 tocentry->cdte_ctrl = buffer[5] & 0xf;
95 tocentry->cdte_adr = buffer[5] >> 4;
96 tocentry->cdte_datamode = (tocentry->cdte_ctrl & 0x04) ? 1 : 0;
97 if (tocentry->cdte_format == CDROM_MSF) {
98 tocentry->cdte_addr.msf.minute = buffer[9];
99 tocentry->cdte_addr.msf.second = buffer[10];
100 tocentry->cdte_addr.msf.frame = buffer[11];
101 } else
102 tocentry->cdte_addr.lba = (((((buffer[8] << 8) + buffer[9]) << 8)
103 + buffer[10]) << 8) + buffer[11];
104
105 kfree(buffer);
106 return result;
107}
1da177e4
LT
108
109#define IOCTL_RETRIES 3
110
111/* ATAPI drives don't have a SCMD_PLAYAUDIO_TI command. When these drives
112 are emulating a SCSI device via the idescsi module, they need to have
113 CDROMPLAYTRKIND commands translated into CDROMPLAYMSF commands for them */
114
115static int sr_fake_playtrkind(struct cdrom_device_info *cdi, struct cdrom_ti *ti)
116{
117 struct cdrom_tocentry trk0_te, trk1_te;
118 struct cdrom_tochdr tochdr;
119 struct packet_command cgc;
120 int ntracks, ret;
121
a09c6311
CH
122 ret = sr_read_tochdr(cdi, &tochdr);
123 if (ret)
1da177e4
LT
124 return ret;
125
126 ntracks = tochdr.cdth_trk1 - tochdr.cdth_trk0 + 1;
127
128 if (ti->cdti_trk1 == ntracks)
129 ti->cdti_trk1 = CDROM_LEADOUT;
130 else if (ti->cdti_trk1 != CDROM_LEADOUT)
131 ti->cdti_trk1 ++;
132
133 trk0_te.cdte_track = ti->cdti_trk0;
134 trk0_te.cdte_format = CDROM_MSF;
135 trk1_te.cdte_track = ti->cdti_trk1;
136 trk1_te.cdte_format = CDROM_MSF;
137
a09c6311
CH
138 ret = sr_read_tocentry(cdi, &trk0_te);
139 if (ret)
1da177e4 140 return ret;
a09c6311
CH
141 ret = sr_read_tocentry(cdi, &trk1_te);
142 if (ret)
1da177e4
LT
143 return ret;
144
145 memset(&cgc, 0, sizeof(struct packet_command));
146 cgc.cmd[0] = GPCMD_PLAY_AUDIO_MSF;
147 cgc.cmd[3] = trk0_te.cdte_addr.msf.minute;
148 cgc.cmd[4] = trk0_te.cdte_addr.msf.second;
149 cgc.cmd[5] = trk0_te.cdte_addr.msf.frame;
150 cgc.cmd[6] = trk1_te.cdte_addr.msf.minute;
151 cgc.cmd[7] = trk1_te.cdte_addr.msf.second;
152 cgc.cmd[8] = trk1_te.cdte_addr.msf.frame;
153 cgc.data_direction = DMA_NONE;
154 cgc.timeout = IOCTL_TIMEOUT;
155 return sr_do_ioctl(cdi->handle, &cgc);
156}
157
a09c6311
CH
158static int sr_play_trkind(struct cdrom_device_info *cdi,
159 struct cdrom_ti *ti)
160
161{
162 struct scsi_cd *cd = cdi->handle;
163 struct packet_command cgc;
164 int result;
165
166 memset(&cgc, 0, sizeof(struct packet_command));
167 cgc.timeout = IOCTL_TIMEOUT;
168 cgc.cmd[0] = GPCMD_PLAYAUDIO_TI;
169 cgc.cmd[4] = ti->cdti_trk0;
170 cgc.cmd[5] = ti->cdti_ind0;
171 cgc.cmd[7] = ti->cdti_trk1;
172 cgc.cmd[8] = ti->cdti_ind1;
173 cgc.data_direction = DMA_NONE;
174
175 result = sr_do_ioctl(cd, &cgc);
176 if (result == -EDRIVE_CANT_DO_THIS)
177 result = sr_fake_playtrkind(cdi, ti);
178
179 return result;
180}
181
1da177e4
LT
182/* We do our own retries because we want to know what the specific
183 error code is. Normally the UNIT_ATTENTION code will automatically
184 clear after one error */
185
186int sr_do_ioctl(Scsi_CD *cd, struct packet_command *cgc)
187{
1da177e4 188 struct scsi_device *SDev;
820732b5 189 struct scsi_sense_hdr sshdr;
1da177e4 190 int result, err = 0, retries = 0;
f7068114 191 unsigned char sense_buffer[SCSI_SENSE_BUFFERSIZE], *senseptr = NULL;
1da177e4
LT
192
193 SDev = cd->device;
820732b5 194
f7068114
JA
195 if (cgc->sense)
196 senseptr = sense_buffer;
197
1da177e4
LT
198 retry:
199 if (!scsi_block_when_processing_errors(SDev)) {
200 err = -ENODEV;
820732b5 201 goto out;
1da177e4
LT
202 }
203
820732b5 204 result = scsi_execute(SDev, cgc->cmd, cgc->data_direction,
f7068114 205 cgc->buffer, cgc->buflen, senseptr, &sshdr,
76aaf87b 206 cgc->timeout, IOCTL_RETRIES, 0, 0, NULL);
1da177e4 207
f7068114
JA
208 if (cgc->sense)
209 memcpy(cgc->sense, sense_buffer, sizeof(*cgc->sense));
210
1da177e4
LT
211 /* Minimal error checking. Ignore cases we know about, and report the rest. */
212 if (driver_byte(result) != 0) {
820732b5 213 switch (sshdr.sense_key) {
1da177e4
LT
214 case UNIT_ATTENTION:
215 SDev->changed = 1;
216 if (!cgc->quiet)
96eefad2
HR
217 sr_printk(KERN_INFO, cd,
218 "disc change detected.\n");
1da177e4
LT
219 if (retries++ < 10)
220 goto retry;
221 err = -ENOMEDIUM;
222 break;
223 case NOT_READY: /* This happens if there is no disc in drive */
820732b5
JB
224 if (sshdr.asc == 0x04 &&
225 sshdr.ascq == 0x01) {
1da177e4
LT
226 /* sense: Logical unit is in process of becoming ready */
227 if (!cgc->quiet)
96eefad2
HR
228 sr_printk(KERN_INFO, cd,
229 "CDROM not ready yet.\n");
1da177e4
LT
230 if (retries++ < 10) {
231 /* sleep 2 sec and try again */
232 ssleep(2);
233 goto retry;
234 } else {
235 /* 20 secs are enough? */
236 err = -ENOMEDIUM;
237 break;
238 }
239 }
240 if (!cgc->quiet)
96eefad2
HR
241 sr_printk(KERN_INFO, cd,
242 "CDROM not ready. Make sure there "
243 "is a disc in the drive.\n");
1da177e4
LT
244 err = -ENOMEDIUM;
245 break;
246 case ILLEGAL_REQUEST:
247 err = -EIO;
820732b5
JB
248 if (sshdr.asc == 0x20 &&
249 sshdr.ascq == 0x00)
1da177e4
LT
250 /* sense: Invalid command operation code */
251 err = -EDRIVE_CANT_DO_THIS;
1da177e4
LT
252 break;
253 default:
1da177e4
LT
254 err = -EIO;
255 }
256 }
257
1da177e4 258 /* Wake up a process waiting for device */
1da177e4
LT
259 out:
260 cgc->stat = err;
261 return err;
262}
263
264/* ---------------------------------------------------------------------- */
265/* interface to cdrom.c */
266
1da177e4
LT
267int sr_tray_move(struct cdrom_device_info *cdi, int pos)
268{
269 Scsi_CD *cd = cdi->handle;
270 struct packet_command cgc;
271
272 memset(&cgc, 0, sizeof(struct packet_command));
273 cgc.cmd[0] = GPCMD_START_STOP_UNIT;
274 cgc.cmd[4] = (pos == 0) ? 0x03 /* close */ : 0x02 /* eject */ ;
275 cgc.data_direction = DMA_NONE;
276 cgc.timeout = IOCTL_TIMEOUT;
277 return sr_do_ioctl(cd, &cgc);
278}
279
280int sr_lock_door(struct cdrom_device_info *cdi, int lock)
281{
282 Scsi_CD *cd = cdi->handle;
283
284 return scsi_set_medium_removal(cd->device, lock ?
285 SCSI_REMOVAL_PREVENT : SCSI_REMOVAL_ALLOW);
286}
287
288int sr_drive_status(struct cdrom_device_info *cdi, int slot)
289{
210ba1d1
JB
290 struct scsi_cd *cd = cdi->handle;
291 struct scsi_sense_hdr sshdr;
292 struct media_event_desc med;
293
1da177e4
LT
294 if (CDSL_CURRENT != slot) {
295 /* we have no changer support */
296 return -EINVAL;
297 }
9f8a2c23 298 if (!scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr))
1da177e4
LT
299 return CDS_DISC_OK;
300
96bcc722
PJ
301 /* SK/ASC/ASCQ of 2/4/1 means "unit is becoming ready" */
302 if (scsi_sense_valid(&sshdr) && sshdr.sense_key == NOT_READY
303 && sshdr.asc == 0x04 && sshdr.ascq == 0x01)
304 return CDS_DRIVE_NOT_READY;
305
210ba1d1
JB
306 if (!cdrom_get_media_event(cdi, &med)) {
307 if (med.media_present)
308 return CDS_DISC_OK;
309 else if (med.door_open)
310 return CDS_TRAY_OPEN;
311 else
312 return CDS_NO_DISC;
313 }
314
b8479178
RJ
315 /*
316 * SK/ASC/ASCQ of 2/4/2 means "initialization required"
317 * Using CD_TRAY_OPEN results in an START_STOP_UNIT to close
318 * the tray, which resolves the initialization requirement.
319 */
320 if (scsi_sense_valid(&sshdr) && sshdr.sense_key == NOT_READY
321 && sshdr.asc == 0x04 && sshdr.ascq == 0x02)
322 return CDS_TRAY_OPEN;
323
210ba1d1
JB
324 /*
325 * 0x04 is format in progress .. but there must be a disc present!
326 */
327 if (sshdr.sense_key == NOT_READY && sshdr.asc == 0x04)
328 return CDS_DISC_OK;
329
330 /*
331 * If not using Mt Fuji extended media tray reports,
332 * just return TRAY_OPEN since ATAPI doesn't provide
333 * any other way to detect this...
334 */
335 if (scsi_sense_valid(&sshdr) &&
336 /* 0x3a is medium not present */
337 sshdr.asc == 0x3a)
338 return CDS_NO_DISC;
339 else
340 return CDS_TRAY_OPEN;
341
342 return CDS_DRIVE_NOT_READY;
1da177e4
LT
343}
344
345int sr_disk_status(struct cdrom_device_info *cdi)
346{
347 Scsi_CD *cd = cdi->handle;
348 struct cdrom_tochdr toc_h;
349 struct cdrom_tocentry toc_e;
350 int i, rc, have_datatracks = 0;
351
352 /* look for data tracks */
a09c6311
CH
353 rc = sr_read_tochdr(cdi, &toc_h);
354 if (rc)
1da177e4
LT
355 return (rc == -ENOMEDIUM) ? CDS_NO_DISC : CDS_NO_INFO;
356
357 for (i = toc_h.cdth_trk0; i <= toc_h.cdth_trk1; i++) {
358 toc_e.cdte_track = i;
359 toc_e.cdte_format = CDROM_LBA;
a09c6311 360 if (sr_read_tocentry(cdi, &toc_e))
1da177e4
LT
361 return CDS_NO_INFO;
362 if (toc_e.cdte_ctrl & CDROM_DATA_TRACK) {
363 have_datatracks = 1;
364 break;
365 }
366 }
367 if (!have_datatracks)
368 return CDS_AUDIO;
369
370 if (cd->xa_flag)
371 return CDS_XA_2_1;
372 else
373 return CDS_DATA_1;
374}
375
376int sr_get_last_session(struct cdrom_device_info *cdi,
377 struct cdrom_multisession *ms_info)
378{
379 Scsi_CD *cd = cdi->handle;
380
381 ms_info->addr.lba = cd->ms_offset;
382 ms_info->xa_flag = cd->xa_flag || cd->ms_offset > 0;
383
384 return 0;
385}
386
1da177e4
LT
387int sr_get_mcn(struct cdrom_device_info *cdi, struct cdrom_mcn *mcn)
388{
389 Scsi_CD *cd = cdi->handle;
390 struct packet_command cgc;
391 char *buffer = kmalloc(32, GFP_KERNEL | SR_GFP_DMA(cd));
392 int result;
393
3a73e8c7
ND
394 if (!buffer)
395 return -ENOMEM;
396
1da177e4
LT
397 memset(&cgc, 0, sizeof(struct packet_command));
398 cgc.cmd[0] = GPCMD_READ_SUBCHANNEL;
399 cgc.cmd[2] = 0x40; /* I do want the subchannel info */
400 cgc.cmd[3] = 0x02; /* Give me medium catalog number info */
401 cgc.cmd[8] = 24;
402 cgc.buffer = buffer;
403 cgc.buflen = 24;
404 cgc.data_direction = DMA_FROM_DEVICE;
405 cgc.timeout = IOCTL_TIMEOUT;
406 result = sr_do_ioctl(cd, &cgc);
407
408 memcpy(mcn->medium_catalog_number, buffer + 9, 13);
409 mcn->medium_catalog_number[13] = 0;
410
411 kfree(buffer);
412 return result;
413}
414
415int sr_reset(struct cdrom_device_info *cdi)
416{
417 return 0;
418}
419
420int sr_select_speed(struct cdrom_device_info *cdi, int speed)
421{
422 Scsi_CD *cd = cdi->handle;
423 struct packet_command cgc;
424
425 if (speed == 0)
426 speed = 0xffff; /* set to max */
427 else
428 speed *= 177; /* Nx to kbyte/s */
429
430 memset(&cgc, 0, sizeof(struct packet_command));
431 cgc.cmd[0] = GPCMD_SET_SPEED; /* SET CD SPEED */
432 cgc.cmd[2] = (speed >> 8) & 0xff; /* MSB for speed (in kbytes/sec) */
433 cgc.cmd[3] = speed & 0xff; /* LSB */
434 cgc.data_direction = DMA_NONE;
435 cgc.timeout = IOCTL_TIMEOUT;
436
437 if (sr_do_ioctl(cd, &cgc))
438 return -EIO;
439 return 0;
440}
441
442/* ----------------------------------------------------------------------- */
443/* this is called by the generic cdrom driver. arg is a _kernel_ pointer, */
444/* because the generic cdrom driver does the user access stuff for us. */
445/* only cdromreadtochdr and cdromreadtocentry are left - for use with the */
446/* sr_disk_status interface for the generic cdrom driver. */
447
448int sr_audio_ioctl(struct cdrom_device_info *cdi, unsigned int cmd, void *arg)
449{
1da177e4
LT
450 switch (cmd) {
451 case CDROMREADTOCHDR:
a09c6311 452 return sr_read_tochdr(cdi, arg);
1da177e4 453 case CDROMREADTOCENTRY:
a09c6311
CH
454 return sr_read_tocentry(cdi, arg);
455 case CDROMPLAYTRKIND:
456 return sr_play_trkind(cdi, arg);
1da177e4 457 default:
a09c6311 458 return -EINVAL;
1da177e4 459 }
1da177e4
LT
460}
461
462/* -----------------------------------------------------------------------
463 * a function to read all sorts of funny cdrom sectors using the READ_CD
464 * scsi-3 mmc command
465 *
466 * lba: linear block address
467 * format: 0 = data (anything)
468 * 1 = audio
469 * 2 = data (mode 1)
470 * 3 = data (mode 2)
471 * 4 = data (mode 2 form1)
472 * 5 = data (mode 2 form2)
473 * blksize: 2048 | 2336 | 2340 | 2352
474 */
475
476static int sr_read_cd(Scsi_CD *cd, unsigned char *dest, int lba, int format, int blksize)
477{
478 struct packet_command cgc;
479
480#ifdef DEBUG
96eefad2
HR
481 sr_printk(KERN_INFO, cd, "sr_read_cd lba=%d format=%d blksize=%d\n",
482 lba, format, blksize);
1da177e4
LT
483#endif
484
485 memset(&cgc, 0, sizeof(struct packet_command));
486 cgc.cmd[0] = GPCMD_READ_CD; /* READ_CD */
487 cgc.cmd[1] = ((format & 7) << 2);
488 cgc.cmd[2] = (unsigned char) (lba >> 24) & 0xff;
489 cgc.cmd[3] = (unsigned char) (lba >> 16) & 0xff;
490 cgc.cmd[4] = (unsigned char) (lba >> 8) & 0xff;
491 cgc.cmd[5] = (unsigned char) lba & 0xff;
492 cgc.cmd[8] = 1;
493 switch (blksize) {
494 case 2336:
495 cgc.cmd[9] = 0x58;
496 break;
497 case 2340:
498 cgc.cmd[9] = 0x78;
499 break;
500 case 2352:
501 cgc.cmd[9] = 0xf8;
502 break;
503 default:
504 cgc.cmd[9] = 0x10;
505 break;
506 }
507 cgc.buffer = dest;
508 cgc.buflen = blksize;
509 cgc.data_direction = DMA_FROM_DEVICE;
510 cgc.timeout = IOCTL_TIMEOUT;
511 return sr_do_ioctl(cd, &cgc);
512}
513
514/*
515 * read sectors with blocksizes other than 2048
516 */
517
518static int sr_read_sector(Scsi_CD *cd, int lba, int blksize, unsigned char *dest)
519{
520 struct packet_command cgc;
521 int rc;
522
523 /* we try the READ CD command first... */
524 if (cd->readcd_known) {
525 rc = sr_read_cd(cd, dest, lba, 0, blksize);
526 if (-EDRIVE_CANT_DO_THIS != rc)
527 return rc;
528 cd->readcd_known = 0;
96eefad2
HR
529 sr_printk(KERN_INFO, cd,
530 "CDROM does'nt support READ CD (0xbe) command\n");
1da177e4
LT
531 /* fall & retry the other way */
532 }
533 /* ... if this fails, we switch the blocksize using MODE SELECT */
534 if (blksize != cd->device->sector_size) {
535 if (0 != (rc = sr_set_blocklength(cd, blksize)))
536 return rc;
537 }
538#ifdef DEBUG
96eefad2
HR
539 sr_printk(KERN_INFO, cd, "sr_read_sector lba=%d blksize=%d\n",
540 lba, blksize);
1da177e4
LT
541#endif
542
543 memset(&cgc, 0, sizeof(struct packet_command));
544 cgc.cmd[0] = GPCMD_READ_10;
545 cgc.cmd[2] = (unsigned char) (lba >> 24) & 0xff;
546 cgc.cmd[3] = (unsigned char) (lba >> 16) & 0xff;
547 cgc.cmd[4] = (unsigned char) (lba >> 8) & 0xff;
548 cgc.cmd[5] = (unsigned char) lba & 0xff;
549 cgc.cmd[8] = 1;
550 cgc.buffer = dest;
551 cgc.buflen = blksize;
552 cgc.data_direction = DMA_FROM_DEVICE;
553 cgc.timeout = IOCTL_TIMEOUT;
554 rc = sr_do_ioctl(cd, &cgc);
555
556 return rc;
557}
558
559/*
560 * read a sector in raw mode to check the sector format
561 * ret: 1 == mode2 (XA), 0 == mode1, <0 == error
562 */
563
564int sr_is_xa(Scsi_CD *cd)
565{
566 unsigned char *raw_sector;
567 int is_xa;
568
569 if (!xa_test)
570 return 0;
571
5cbded58 572 raw_sector = kmalloc(2048, GFP_KERNEL | SR_GFP_DMA(cd));
1da177e4
LT
573 if (!raw_sector)
574 return -ENOMEM;
575 if (0 == sr_read_sector(cd, cd->ms_offset + 16,
576 CD_FRAMESIZE_RAW1, raw_sector)) {
577 is_xa = (raw_sector[3] == 0x02) ? 1 : 0;
578 } else {
579 /* read a raw sector failed for some reason. */
580 is_xa = -1;
581 }
582 kfree(raw_sector);
583#ifdef DEBUG
96eefad2 584 sr_printk(KERN_INFO, cd, "sr_is_xa: %d\n", is_xa);
1da177e4
LT
585#endif
586 return is_xa;
587}