drivers/scsi/sr_ioctl.c

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