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