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