LXR linux/drivers/scsi/sr

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