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