drivers/ide/ide-atapi.c

   1 /*
   2  * ATAPI support.
   3  */
   4
   5 #include <linux/kernel.h>
   6 #include <linux/delay.h>
   7 #include <linux/ide.h>
   8 #include <scsi/scsi.h>
   9
  10 #ifdef DEBUG
  11 #define debug_log(fmt, args...) \
  12         printk(KERN_INFO "ide: " fmt, ## args)
  13 #else
  14 #define debug_log(fmt, args...) do {} while (0)
  15 #endif
  16
  17 /*
  18  * Check whether we can support a device,
  19  * based on the ATAPI IDENTIFY command results.
  20  */
  21 int ide_check_atapi_device(ide_drive_t *drive, const char *s)
  22 {
  23         u16 *id = drive->id;
  24         u8 gcw[2], protocol, device_type, removable, drq_type, packet_size;
  25
  26         *((u16 *)&gcw) = id[ATA_ID_CONFIG];
  27
  28         protocol    = (gcw[1] & 0xC0) >> 6;
  29         device_type =  gcw[1] & 0x1F;
  30         removable   = (gcw[0] & 0x80) >> 7;
  31         drq_type    = (gcw[0] & 0x60) >> 5;
  32         packet_size =  gcw[0] & 0x03;
  33
  34 #ifdef CONFIG_PPC
  35         /* kludge for Apple PowerBook internal zip */
  36         if (drive->media == ide_floppy && device_type == 5 &&
  37             !strstr((char *)&id[ATA_ID_PROD], "CD-ROM") &&
  38             strstr((char *)&id[ATA_ID_PROD], "ZIP"))
  39                 device_type = 0;
  40 #endif
  41
  42         if (protocol != 2)
  43                 printk(KERN_ERR "%s: %s: protocol (0x%02x) is not ATAPI\n",
  44                         s, drive->name, protocol);
  45         else if ((drive->media == ide_floppy && device_type != 0) ||
  46                  (drive->media == ide_tape && device_type != 1))
  47                 printk(KERN_ERR "%s: %s: invalid device type (0x%02x)\n",
  48                         s, drive->name, device_type);
  49         else if (removable == 0)
  50                 printk(KERN_ERR "%s: %s: the removable flag is not set\n",
  51                         s, drive->name);
  52         else if (drive->media == ide_floppy && drq_type == 3)
  53                 printk(KERN_ERR "%s: %s: sorry, DRQ type (0x%02x) not "
  54                         "supported\n", s, drive->name, drq_type);
  55         else if (packet_size != 0)
  56                 printk(KERN_ERR "%s: %s: packet size (0x%02x) is not 12 "
  57                         "bytes\n", s, drive->name, packet_size);
  58         else
  59                 return 1;
  60         return 0;
  61 }
  62 EXPORT_SYMBOL_GPL(ide_check_atapi_device);
  63
  64 /* PIO data transfer routine using the scatter gather table. */
  65 int ide_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
  66                     unsigned int bcount, int write)
  67 {
  68         ide_hwif_t *hwif = drive->hwif;
  69         const struct ide_tp_ops *tp_ops = hwif->tp_ops;
  70         xfer_func_t *xf = write ? tp_ops->output_data : tp_ops->input_data;
  71         struct scatterlist *sg = pc->sg;
  72         char *buf;
  73         int count, done = 0;
  74
  75         while (bcount) {
  76                 count = min(sg->length - pc->b_count, bcount);
  77
  78                 if (PageHighMem(sg_page(sg))) {
  79                         unsigned long flags;
  80
  81                         local_irq_save(flags);
  82                         buf = kmap_atomic(sg_page(sg), KM_IRQ0) + sg->offset;
  83                         xf(drive, NULL, buf + pc->b_count, count);
  84                         kunmap_atomic(buf - sg->offset, KM_IRQ0);
  85                         local_irq_restore(flags);
  86                 } else {
  87                         buf = sg_virt(sg);
  88                         xf(drive, NULL, buf + pc->b_count, count);
  89                 }
  90
  91                 bcount -= count;
  92                 pc->b_count += count;
  93                 done += count;
  94
  95                 if (pc->b_count == sg->length) {
  96                         if (!--pc->sg_cnt)
  97                                 break;
  98                         pc->sg = sg = sg_next(sg);
  99                         pc->b_count = 0;
 100                 }
 101         }
 102
 103         if (bcount) {
 104                 printk(KERN_ERR "%s: %d leftover bytes, %s\n", drive->name,
 105                         bcount, write ? "padding with zeros"
 106                                       : "discarding data");
 107                 ide_pad_transfer(drive, write, bcount);
 108         }
 109
 110         return done;
 111 }
 112 EXPORT_SYMBOL_GPL(ide_io_buffers);
 113
 114 void ide_init_pc(struct ide_atapi_pc *pc)
 115 {
 116         memset(pc, 0, sizeof(*pc));
 117         pc->buf = pc->pc_buf;
 118         pc->buf_size = IDE_PC_BUFFER_SIZE;
 119 }
 120 EXPORT_SYMBOL_GPL(ide_init_pc);
 121
 122 /*
 123  * Generate a new packet command request in front of the request queue, before
 124  * the current request, so that it will be processed immediately, on the next
 125  * pass through the driver.
 126  */
 127 void ide_queue_pc_head(ide_drive_t *drive, struct gendisk *disk,
 128                        struct ide_atapi_pc *pc, struct request *rq)
 129 {
 130         blk_rq_init(NULL, rq);
 131         rq->cmd_type = REQ_TYPE_SPECIAL;
 132         rq->cmd_flags |= REQ_PREEMPT;
 133         rq->buffer = (char *)pc;
 134         rq->rq_disk = disk;
 135         memcpy(rq->cmd, pc->c, 12);
 136         if (drive->media == ide_tape)
 137                 rq->cmd[13] = REQ_IDETAPE_PC1;
 138         ide_do_drive_cmd(drive, rq);
 139 }
 140 EXPORT_SYMBOL_GPL(ide_queue_pc_head);
 141
 142 /*
 143  * Add a special packet command request to the tail of the request queue,
 144  * and wait for it to be serviced.
 145  */
 146 int ide_queue_pc_tail(ide_drive_t *drive, struct gendisk *disk,
 147                       struct ide_atapi_pc *pc)
 148 {
 149         struct request *rq;
 150         int error;
 151
 152         rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
 153         rq->cmd_type = REQ_TYPE_SPECIAL;
 154         rq->buffer = (char *)pc;
 155         memcpy(rq->cmd, pc->c, 12);
 156         if (drive->media == ide_tape)
 157                 rq->cmd[13] = REQ_IDETAPE_PC1;
 158         error = blk_execute_rq(drive->queue, disk, rq, 0);
 159         blk_put_request(rq);
 160
 161         return error;
 162 }
 163 EXPORT_SYMBOL_GPL(ide_queue_pc_tail);
 164
 165 int ide_do_test_unit_ready(ide_drive_t *drive, struct gendisk *disk)
 166 {
 167         struct ide_atapi_pc pc;
 168
 169         ide_init_pc(&pc);
 170         pc.c[0] = TEST_UNIT_READY;
 171
 172         return ide_queue_pc_tail(drive, disk, &pc);
 173 }
 174 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready);
 175
 176 int ide_do_start_stop(ide_drive_t *drive, struct gendisk *disk, int start)
 177 {
 178         struct ide_atapi_pc pc;
 179
 180         ide_init_pc(&pc);
 181         pc.c[0] = START_STOP;
 182         pc.c[4] = start;
 183
 184         if (drive->media == ide_tape)
 185                 pc.flags |= PC_FLAG_WAIT_FOR_DSC;
 186
 187         return ide_queue_pc_tail(drive, disk, &pc);
 188 }
 189 EXPORT_SYMBOL_GPL(ide_do_start_stop);
 190
 191 int ide_set_media_lock(ide_drive_t *drive, struct gendisk *disk, int on)
 192 {
 193         struct ide_atapi_pc pc;
 194
 195         if (drive->atapi_flags & IDE_AFLAG_NO_DOORLOCK)
 196                 return 0;
 197
 198         ide_init_pc(&pc);
 199         pc.c[0] = ALLOW_MEDIUM_REMOVAL;
 200         pc.c[4] = on;
 201
 202         return ide_queue_pc_tail(drive, disk, &pc);
 203 }
 204 EXPORT_SYMBOL_GPL(ide_set_media_lock);
 205
 206 /* TODO: unify the code thus making some arguments go away */
 207 ide_startstop_t ide_pc_intr(ide_drive_t *drive, struct ide_atapi_pc *pc,
 208         ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry,
 209         void (*update_buffers)(ide_drive_t *, struct ide_atapi_pc *),
 210         void (*retry_pc)(ide_drive_t *),
 211         int (*io_buffers)(ide_drive_t *, struct ide_atapi_pc *, unsigned, int))
 212 {
 213         ide_hwif_t *hwif = drive->hwif;
 214         struct request *rq = hwif->hwgroup->rq;
 215         const struct ide_tp_ops *tp_ops = hwif->tp_ops;
 216         xfer_func_t *xferfunc;
 217         unsigned int temp;
 218         u16 bcount;
 219         u8 stat, ireason, scsi = drive->scsi, dsc = 0;
 220
 221         debug_log("Enter %s - interrupt handler\n", __func__);
 222
 223         if (pc->flags & PC_FLAG_TIMEDOUT) {
 224                 drive->pc_callback(drive, 0);
 225                 return ide_stopped;
 226         }
 227
 228         /* Clear the interrupt */
 229         stat = tp_ops->read_status(hwif);
 230
 231         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
 232                 if (hwif->dma_ops->dma_end(drive) ||
 233                     (drive->media == ide_tape && !scsi && (stat & ATA_ERR))) {
 234                         if (drive->media == ide_floppy && !scsi)
 235                                 printk(KERN_ERR "%s: DMA %s error\n",
 236                                         drive->name, rq_data_dir(pc->rq)
 237                                                      ? "write" : "read");
 238                         pc->flags |= PC_FLAG_DMA_ERROR;
 239                 } else {
 240                         pc->xferred = pc->req_xfer;
 241                         if (update_buffers)
 242                                 update_buffers(drive, pc);
 243                 }
 244                 debug_log("%s: DMA finished\n", drive->name);
 245         }
 246
 247         /* No more interrupts */
 248         if ((stat & ATA_DRQ) == 0) {
 249                 debug_log("Packet command completed, %d bytes transferred\n",
 250                           pc->xferred);
 251
 252                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
 253
 254                 local_irq_enable_in_hardirq();
 255
 256                 if (drive->media == ide_tape && !scsi &&
 257                     (stat & ATA_ERR) && rq->cmd[0] == REQUEST_SENSE)
 258                         stat &= ~ATA_ERR;
 259
 260                 if ((stat & ATA_ERR) || (pc->flags & PC_FLAG_DMA_ERROR)) {
 261                         /* Error detected */
 262                         debug_log("%s: I/O error\n", drive->name);
 263
 264                         if (drive->media != ide_tape || scsi) {
 265                                 pc->rq->errors++;
 266                                 if (scsi)
 267                                         goto cmd_finished;
 268                         }
 269
 270                         if (rq->cmd[0] == REQUEST_SENSE) {
 271                                 printk(KERN_ERR "%s: I/O error in request sense"
 272                                                 " command\n", drive->name);
 273                                 return ide_do_reset(drive);
 274                         }
 275
 276                         debug_log("[cmd %x]: check condition\n", rq->cmd[0]);
 277
 278                         /* Retry operation */
 279                         retry_pc(drive);
 280
 281                         /* queued, but not started */
 282                         return ide_stopped;
 283                 }
 284 cmd_finished:
 285                 pc->error = 0;
 286
 287                 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) && (stat & ATA_DSC) == 0)
 288                         dsc = 1;
 289
 290                 /* Command finished - Call the callback function */
 291                 drive->pc_callback(drive, dsc);
 292
 293                 return ide_stopped;
 294         }
 295
 296         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
 297                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
 298                 printk(KERN_ERR "%s: The device wants to issue more interrupts "
 299                                 "in DMA mode\n", drive->name);
 300                 ide_dma_off(drive);
 301                 return ide_do_reset(drive);
 302         }
 303
 304         /* Get the number of bytes to transfer on this interrupt. */
 305         ide_read_bcount_and_ireason(drive, &bcount, &ireason);
 306
 307         if (ireason & ATAPI_COD) {
 308                 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
 309                 return ide_do_reset(drive);
 310         }
 311
 312         if (((ireason & ATAPI_IO) == ATAPI_IO) ==
 313                 !!(pc->flags & PC_FLAG_WRITING)) {
 314                 /* Hopefully, we will never get here */
 315                 printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
 316                                 "to %s!\n", drive->name,
 317                                 (ireason & ATAPI_IO) ? "Write" : "Read",
 318                                 (ireason & ATAPI_IO) ? "Read" : "Write");
 319                 return ide_do_reset(drive);
 320         }
 321
 322         if (!(pc->flags & PC_FLAG_WRITING)) {
 323                 /* Reading - Check that we have enough space */
 324                 temp = pc->xferred + bcount;
 325                 if (temp > pc->req_xfer) {
 326                         if (temp > pc->buf_size) {
 327                                 printk(KERN_ERR "%s: The device wants to send "
 328                                                 "us more data than expected - "
 329                                                 "discarding data\n",
 330                                                 drive->name);
 331                                 if (scsi)
 332                                         temp = pc->buf_size - pc->xferred;
 333                                 else
 334                                         temp = 0;
 335                                 if (temp) {
 336                                         if (pc->sg)
 337                                                 io_buffers(drive, pc, temp, 0);
 338                                         else
 339                                                 tp_ops->input_data(drive, NULL,
 340                                                         pc->cur_pos, temp);
 341                                         printk(KERN_ERR "%s: transferred %d of "
 342                                                         "%d bytes\n",
 343                                                         drive->name,
 344                                                         temp, bcount);
 345                                 }
 346                                 pc->xferred += temp;
 347                                 pc->cur_pos += temp;
 348                                 ide_pad_transfer(drive, 0, bcount - temp);
 349                                 ide_set_handler(drive, handler, timeout,
 350                                                 expiry);
 351                                 return ide_started;
 352                         }
 353                         debug_log("The device wants to send us more data than "
 354                                   "expected - allowing transfer\n");
 355                 }
 356                 xferfunc = tp_ops->input_data;
 357         } else
 358                 xferfunc = tp_ops->output_data;
 359
 360         if ((drive->media == ide_floppy && !scsi && !pc->buf) ||
 361             (drive->media == ide_tape && !scsi && pc->bh) ||
 362             (scsi && pc->sg)) {
 363                 int done = io_buffers(drive, pc, bcount,
 364                                   !!(pc->flags & PC_FLAG_WRITING));
 365
 366                 /* FIXME: don't do partial completions */
 367                 if (drive->media == ide_floppy && !scsi)
 368                         ide_end_request(drive, 1, done >> 9);
 369         } else
 370                 xferfunc(drive, NULL, pc->cur_pos, bcount);
 371
 372         /* Update the current position */
 373         pc->xferred += bcount;
 374         pc->cur_pos += bcount;
 375
 376         debug_log("[cmd %x] transferred %d bytes on that intr.\n",
 377                   rq->cmd[0], bcount);
 378
 379         /* And set the interrupt handler again */
 380         ide_set_handler(drive, handler, timeout, expiry);
 381         return ide_started;
 382 }
 383 EXPORT_SYMBOL_GPL(ide_pc_intr);
 384
 385 static u8 ide_read_ireason(ide_drive_t *drive)
 386 {
 387         ide_task_t task;
 388
 389         memset(&task, 0, sizeof(task));
 390         task.tf_flags = IDE_TFLAG_IN_NSECT;
 391
 392         drive->hwif->tp_ops->tf_read(drive, &task);
 393
 394         return task.tf.nsect & 3;
 395 }
 396
 397 static u8 ide_wait_ireason(ide_drive_t *drive, u8 ireason)
 398 {
 399         int retries = 100;
 400
 401         while (retries-- && ((ireason & ATAPI_COD) == 0 ||
 402                 (ireason & ATAPI_IO))) {
 403                 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
 404                                 "a packet command, retrying\n", drive->name);
 405                 udelay(100);
 406                 ireason = ide_read_ireason(drive);
 407                 if (retries == 0) {
 408                         printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
 409                                         "a packet command, ignoring\n",
 410                                         drive->name);
 411                         ireason |= ATAPI_COD;
 412                         ireason &= ~ATAPI_IO;
 413                 }
 414         }
 415
 416         return ireason;
 417 }
 418
 419 ide_startstop_t ide_transfer_pc(ide_drive_t *drive, struct ide_atapi_pc *pc,
 420                                 ide_handler_t *handler, unsigned int timeout,
 421                                 ide_expiry_t *expiry)
 422 {
 423         ide_hwif_t *hwif = drive->hwif;
 424         struct request *rq = hwif->hwgroup->rq;
 425         ide_startstop_t startstop;
 426         u8 ireason;
 427
 428         if (ide_wait_stat(&startstop, drive, ATA_DRQ, ATA_BUSY, WAIT_READY)) {
 429                 printk(KERN_ERR "%s: Strange, packet command initiated yet "
 430                                 "DRQ isn't asserted\n", drive->name);
 431                 return startstop;
 432         }
 433
 434         ireason = ide_read_ireason(drive);
 435         if (drive->media == ide_tape && !drive->scsi)
 436                 ireason = ide_wait_ireason(drive, ireason);
 437
 438         if ((ireason & ATAPI_COD) == 0 || (ireason & ATAPI_IO)) {
 439                 printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
 440                                 "a packet command\n", drive->name);
 441                 return ide_do_reset(drive);
 442         }
 443
 444         /* Set the interrupt routine */
 445         ide_set_handler(drive, handler, timeout, expiry);
 446
 447         /* Begin DMA, if necessary */
 448         if (pc->flags & PC_FLAG_DMA_OK) {
 449                 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
 450                 hwif->dma_ops->dma_start(drive);
 451         }
 452
 453         /* Send the actual packet */
 454         if ((drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) == 0)
 455                 hwif->tp_ops->output_data(drive, NULL, rq->cmd, 12);
 456
 457         return ide_started;
 458 }
 459 EXPORT_SYMBOL_GPL(ide_transfer_pc);
 460
 461 ide_startstop_t ide_issue_pc(ide_drive_t *drive, struct ide_atapi_pc *pc,
 462                              ide_handler_t *handler, unsigned int timeout,
 463                              ide_expiry_t *expiry)
 464 {
 465         ide_hwif_t *hwif = drive->hwif;
 466         u16 bcount;
 467         u8 dma = 0;
 468
 469         /* We haven't transferred any data yet */
 470         pc->xferred = 0;
 471         pc->cur_pos = pc->buf;
 472
 473         /* Request to transfer the entire buffer at once */
 474         if (drive->media == ide_tape && !drive->scsi)
 475                 bcount = pc->req_xfer;
 476         else
 477                 bcount = min(pc->req_xfer, 63 * 1024);
 478
 479         if (pc->flags & PC_FLAG_DMA_ERROR) {
 480                 pc->flags &= ~PC_FLAG_DMA_ERROR;
 481                 ide_dma_off(drive);
 482         }
 483
 484         if ((pc->flags & PC_FLAG_DMA_OK) && drive->using_dma) {
 485                 if (drive->scsi)
 486                         hwif->sg_mapped = 1;
 487                 dma = !hwif->dma_ops->dma_setup(drive);
 488                 if (drive->scsi)
 489                         hwif->sg_mapped = 0;
 490         }
 491
 492         if (!dma)
 493                 pc->flags &= ~PC_FLAG_DMA_OK;
 494
 495         ide_pktcmd_tf_load(drive, drive->scsi ? 0 : IDE_TFLAG_OUT_DEVICE,
 496                            bcount, dma);
 497
 498         /* Issue the packet command */
 499         if (drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT) {
 500                 ide_execute_command(drive, ATA_CMD_PACKET, handler,
 501                                     timeout, NULL);
 502                 return ide_started;
 503         } else {
 504                 ide_execute_pkt_cmd(drive);
 505                 return (*handler)(drive);
 506         }
 507 }
 508 EXPORT_SYMBOL_GPL(ide_issue_pc);