drivers/usb/storage/isd200.c

   1 /* Transport & Protocol Driver for In-System Design, Inc. ISD200 ASIC
   2  *
   3  * Current development and maintenance:
   4  *   (C) 2001-2002 Björn Stenberg (bjorn@haxx.se)
   5  *
   6  * Developed with the assistance of:
   7  *   (C) 2002 Alan Stern <stern@rowland.org>
   8  *
   9  * Initial work:
  10  *   (C) 2000 In-System Design, Inc. (support@in-system.com)
  11  *
  12  * The ISD200 ASIC does not natively support ATA devices.  The chip
  13  * does implement an interface, the ATA Command Block (ATACB) which provides
  14  * a means of passing ATA commands and ATA register accesses to a device.
  15  *
  16  * This program is free software; you can redistribute it and/or modify it
  17  * under the terms of the GNU General Public License as published by the
  18  * Free Software Foundation; either version 2, or (at your option) any
  19  * later version.
  20  *
  21  * This program is distributed in the hope that it will be useful, but
  22  * WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24  * General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License along
  27  * with this program; if not, write to the Free Software Foundation, Inc.,
  28  * 675 Mass Ave, Cambridge, MA 02139, USA.
  29  *
  30  * History:
  31  *
  32  *  2002-10-19: Removed the specialized transfer routines.
  33  *              (Alan Stern <stern@rowland.harvard.edu>)
  34  *  2001-02-24: Removed lots of duplicate code and simplified the structure.
  35  *            (bjorn@haxx.se)
  36  *  2002-01-16: Fixed endianness bug so it works on the ppc arch.
  37  *            (Luc Saillard <luc@saillard.org>)
  38  *  2002-01-17: All bitfields removed.
  39  *            (bjorn@haxx.se)
  40  */
  41
  42
  43 /* Include files */
  44
  45 #include <linux/jiffies.h>
  46 #include <linux/errno.h>
  47 #include <linux/module.h>
  48 #include <linux/slab.h>
  49 #include <linux/ata.h>
  50 #include <linux/hdreg.h>
  51 #include <linux/scatterlist.h>
  52
  53 #include <scsi/scsi.h>
  54 #include <scsi/scsi_cmnd.h>
  55 #include <scsi/scsi_device.h>
  56
  57 #include "usb.h"
  58 #include "transport.h"
  59 #include "protocol.h"
  60 #include "debug.h"
  61 #include "scsiglue.h"
  62
  63 MODULE_DESCRIPTION("Driver for In-System Design, Inc. ISD200 ASIC");
  64 MODULE_AUTHOR("Björn Stenberg <bjorn@haxx.se>");
  65 MODULE_LICENSE("GPL");
  66
  67 static int isd200_Initialization(struct us_data *us);
  68
  69
  70 /*
  71  * The table of devices
  72  */
  73 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
  74                     vendorName, productName, useProtocol, useTransport, \
  75                     initFunction, flags) \
  76 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
  77   .driver_info = (flags)|(USB_US_TYPE_STOR<<24) }
  78
  79 struct usb_device_id isd200_usb_ids[] = {
  80 #       include "unusual_isd200.h"
  81         { }             /* Terminating entry */
  82 };
  83 MODULE_DEVICE_TABLE(usb, isd200_usb_ids);
  84
  85 #undef UNUSUAL_DEV
  86 #undef USUAL_DEV
  87
  88 /*
  89  * The flags table
  90  */
  91 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
  92                     vendor_name, product_name, use_protocol, use_transport, \
  93                     init_function, Flags) \
  94 { \
  95         .vendorName = vendor_name,      \
  96         .productName = product_name,    \
  97         .useProtocol = use_protocol,    \
  98         .useTransport = use_transport,  \
  99         .initFunction = init_function,  \
 100 }
 101
 102 static struct us_unusual_dev isd200_unusual_dev_list[] = {
 103 #       include "unusual_isd200.h"
 104         { }             /* Terminating entry */
 105 };
 106
 107 #undef UNUSUAL_DEV
 108 #undef USUAL_DEV
 109
 110
 111 /* Timeout defines (in Seconds) */
 112
 113 #define ISD200_ENUM_BSY_TIMEOUT         35
 114 #define ISD200_ENUM_DETECT_TIMEOUT      30
 115 #define ISD200_DEFAULT_TIMEOUT          30
 116
 117 /* device flags */
 118 #define DF_ATA_DEVICE           0x0001
 119 #define DF_MEDIA_STATUS_ENABLED 0x0002
 120 #define DF_REMOVABLE_MEDIA      0x0004
 121
 122 /* capability bit definitions */
 123 #define CAPABILITY_DMA          0x01
 124 #define CAPABILITY_LBA          0x02
 125
 126 /* command_setX bit definitions */
 127 #define COMMANDSET_REMOVABLE    0x02
 128 #define COMMANDSET_MEDIA_STATUS 0x10
 129
 130 /* ATA Vendor Specific defines */
 131 #define ATA_ADDRESS_DEVHEAD_STD      0xa0
 132 #define ATA_ADDRESS_DEVHEAD_LBA_MODE 0x40
 133 #define ATA_ADDRESS_DEVHEAD_SLAVE    0x10
 134
 135 /* Action Select bits */
 136 #define ACTION_SELECT_0      0x01
 137 #define ACTION_SELECT_1      0x02
 138 #define ACTION_SELECT_2      0x04
 139 #define ACTION_SELECT_3      0x08
 140 #define ACTION_SELECT_4      0x10
 141 #define ACTION_SELECT_5      0x20
 142 #define ACTION_SELECT_6      0x40
 143 #define ACTION_SELECT_7      0x80
 144
 145 /* Register Select bits */
 146 #define REG_ALTERNATE_STATUS    0x01
 147 #define REG_DEVICE_CONTROL      0x01
 148 #define REG_ERROR               0x02
 149 #define REG_FEATURES            0x02
 150 #define REG_SECTOR_COUNT        0x04
 151 #define REG_SECTOR_NUMBER       0x08
 152 #define REG_CYLINDER_LOW        0x10
 153 #define REG_CYLINDER_HIGH       0x20
 154 #define REG_DEVICE_HEAD         0x40
 155 #define REG_STATUS              0x80
 156 #define REG_COMMAND             0x80
 157
 158 /* ATA registers offset definitions */
 159 #define ATA_REG_ERROR_OFFSET            1
 160 #define ATA_REG_LCYL_OFFSET             4
 161 #define ATA_REG_HCYL_OFFSET             5
 162 #define ATA_REG_STATUS_OFFSET           7
 163
 164 /* ATA error definitions not in <linux/hdreg.h> */
 165 #define ATA_ERROR_MEDIA_CHANGE          0x20
 166
 167 /* ATA command definitions not in <linux/hdreg.h> */
 168 #define ATA_COMMAND_GET_MEDIA_STATUS    0xDA
 169 #define ATA_COMMAND_MEDIA_EJECT         0xED
 170
 171 /* ATA drive control definitions */
 172 #define ATA_DC_DISABLE_INTERRUPTS       0x02
 173 #define ATA_DC_RESET_CONTROLLER         0x04
 174 #define ATA_DC_REENABLE_CONTROLLER      0x00
 175
 176 /*
 177  *  General purpose return codes
 178  */
 179
 180 #define ISD200_ERROR            -1
 181 #define ISD200_GOOD              0
 182
 183 /*
 184  * Transport return codes
 185  */
 186
 187 #define ISD200_TRANSPORT_GOOD       0   /* Transport good, command good     */
 188 #define ISD200_TRANSPORT_FAILED     1   /* Transport good, command failed   */
 189 #define ISD200_TRANSPORT_ERROR      2   /* Transport bad (i.e. device dead) */
 190
 191 /* driver action codes */
 192 #define ACTION_READ_STATUS      0
 193 #define ACTION_RESET            1
 194 #define ACTION_REENABLE         2
 195 #define ACTION_SOFT_RESET       3
 196 #define ACTION_ENUM             4
 197 #define ACTION_IDENTIFY         5
 198
 199
 200 /*
 201  * ata_cdb struct
 202  */
 203
 204
 205 union ata_cdb {
 206         struct {
 207                 unsigned char SignatureByte0;
 208                 unsigned char SignatureByte1;
 209                 unsigned char ActionSelect;
 210                 unsigned char RegisterSelect;
 211                 unsigned char TransferBlockSize;
 212                 unsigned char WriteData3F6;
 213                 unsigned char WriteData1F1;
 214                 unsigned char WriteData1F2;
 215                 unsigned char WriteData1F3;
 216                 unsigned char WriteData1F4;
 217                 unsigned char WriteData1F5;
 218                 unsigned char WriteData1F6;
 219                 unsigned char WriteData1F7;
 220                 unsigned char Reserved[3];
 221         } generic;
 222
 223         struct {
 224                 unsigned char SignatureByte0;
 225                 unsigned char SignatureByte1;
 226                 unsigned char ActionSelect;
 227                 unsigned char RegisterSelect;
 228                 unsigned char TransferBlockSize;
 229                 unsigned char AlternateStatusByte;
 230                 unsigned char ErrorByte;
 231                 unsigned char SectorCountByte;
 232                 unsigned char SectorNumberByte;
 233                 unsigned char CylinderLowByte;
 234                 unsigned char CylinderHighByte;
 235                 unsigned char DeviceHeadByte;
 236                 unsigned char StatusByte;
 237                 unsigned char Reserved[3];
 238         } read;
 239
 240         struct {
 241                 unsigned char SignatureByte0;
 242                 unsigned char SignatureByte1;
 243                 unsigned char ActionSelect;
 244                 unsigned char RegisterSelect;
 245                 unsigned char TransferBlockSize;
 246                 unsigned char DeviceControlByte;
 247                 unsigned char FeaturesByte;
 248                 unsigned char SectorCountByte;
 249                 unsigned char SectorNumberByte;
 250                 unsigned char CylinderLowByte;
 251                 unsigned char CylinderHighByte;
 252                 unsigned char DeviceHeadByte;
 253                 unsigned char CommandByte;
 254                 unsigned char Reserved[3];
 255         } write;
 256 };
 257
 258
 259 /*
 260  * Inquiry data structure. This is the data returned from the target
 261  * after it receives an inquiry.
 262  *
 263  * This structure may be extended by the number of bytes specified
 264  * in the field AdditionalLength. The defined size constant only
 265  * includes fields through ProductRevisionLevel.
 266  */
 267
 268 /*
 269  * DeviceType field
 270  */
 271 #define DIRECT_ACCESS_DEVICE        0x00    /* disks */
 272 #define DEVICE_REMOVABLE                0x80
 273
 274 struct inquiry_data {
 275         unsigned char DeviceType;
 276         unsigned char DeviceTypeModifier;
 277         unsigned char Versions;
 278         unsigned char Format;
 279         unsigned char AdditionalLength;
 280         unsigned char Reserved[2];
 281         unsigned char Capability;
 282         unsigned char VendorId[8];
 283         unsigned char ProductId[16];
 284         unsigned char ProductRevisionLevel[4];
 285         unsigned char VendorSpecific[20];
 286         unsigned char Reserved3[40];
 287 } __attribute__ ((packed));
 288
 289 /*
 290  * INQUIRY data buffer size
 291  */
 292
 293 #define INQUIRYDATABUFFERSIZE 36
 294
 295
 296 /*
 297  * ISD200 CONFIG data struct
 298  */
 299
 300 #define ATACFG_TIMING     0x0f
 301 #define ATACFG_ATAPI_RESET     0x10
 302 #define ATACFG_MASTER     0x20
 303 #define ATACFG_BLOCKSIZE       0xa0
 304
 305 #define ATACFGE_LAST_LUN       0x07
 306 #define ATACFGE_DESC_OVERRIDE  0x08
 307 #define ATACFGE_STATE_SUSPEND  0x10
 308 #define ATACFGE_SKIP_BOOT      0x20
 309 #define ATACFGE_CONF_DESC2     0x40
 310 #define ATACFGE_INIT_STATUS    0x80
 311
 312 #define CFG_CAPABILITY_SRST    0x01
 313
 314 struct isd200_config {
 315         unsigned char EventNotification;
 316         unsigned char ExternalClock;
 317         unsigned char ATAInitTimeout;
 318         unsigned char ATAConfig;
 319         unsigned char ATAMajorCommand;
 320         unsigned char ATAMinorCommand;
 321         unsigned char ATAExtraConfig;
 322         unsigned char Capability;
 323 }__attribute__ ((packed));
 324
 325
 326 /*
 327  * ISD200 driver information struct
 328  */
 329
 330 struct isd200_info {
 331         struct inquiry_data InquiryData;
 332         u16 *id;
 333         struct isd200_config ConfigData;
 334         unsigned char *RegsBuf;
 335         unsigned char ATARegs[8];
 336         unsigned char DeviceHead;
 337         unsigned char DeviceFlags;
 338
 339         /* maximum number of LUNs supported */
 340         unsigned char MaxLUNs;
 341         unsigned char cmnd[BLK_MAX_CDB];
 342         struct scsi_cmnd srb;
 343         struct scatterlist sg;
 344 };
 345
 346
 347 /*
 348  * Read Capacity Data - returned in Big Endian format
 349  */
 350
 351 struct read_capacity_data {
 352         __be32 LogicalBlockAddress;
 353         __be32 BytesPerBlock;
 354 };
 355
 356 /*
 357  * Read Block Limits Data - returned in Big Endian format
 358  * This structure returns the maximum and minimum block
 359  * size for a TAPE device.
 360  */
 361
 362 struct read_block_limits {
 363         unsigned char Reserved;
 364         unsigned char BlockMaximumSize[3];
 365         unsigned char BlockMinimumSize[2];
 366 };
 367
 368
 369 /*
 370  * Sense Data Format
 371  */
 372
 373 #define SENSE_ERRCODE      0x7f
 374 #define SENSE_ERRCODE_VALID     0x80
 375 #define SENSE_FLAG_SENSE_KEY    0x0f
 376 #define SENSE_FLAG_BAD_LENGTH   0x20
 377 #define SENSE_FLAG_END_OF_MEDIA 0x40
 378 #define SENSE_FLAG_FILE_MARK    0x80
 379 struct sense_data {
 380         unsigned char ErrorCode;
 381         unsigned char SegmentNumber;
 382         unsigned char Flags;
 383         unsigned char Information[4];
 384         unsigned char AdditionalSenseLength;
 385         unsigned char CommandSpecificInformation[4];
 386         unsigned char AdditionalSenseCode;
 387         unsigned char AdditionalSenseCodeQualifier;
 388         unsigned char FieldReplaceableUnitCode;
 389         unsigned char SenseKeySpecific[3];
 390 } __attribute__ ((packed));
 391
 392 /*
 393  * Default request sense buffer size
 394  */
 395
 396 #define SENSE_BUFFER_SIZE 18
 397
 398 /***********************************************************************
 399  * Helper routines
 400  ***********************************************************************/
 401
 402 /**************************************************************************
 403  * isd200_build_sense
 404  *
 405  *  Builds an artificial sense buffer to report the results of a
 406  *  failed command.
 407  *
 408  * RETURNS:
 409  *    void
 410  */
 411 static void isd200_build_sense(struct us_data *us, struct scsi_cmnd *srb)
 412 {
 413         struct isd200_info *info = (struct isd200_info *)us->extra;
 414         struct sense_data *buf = (struct sense_data *) &srb->sense_buffer[0];
 415         unsigned char error = info->ATARegs[ATA_REG_ERROR_OFFSET];
 416
 417         if(error & ATA_ERROR_MEDIA_CHANGE) {
 418                 buf->ErrorCode = 0x70 | SENSE_ERRCODE_VALID;
 419                 buf->AdditionalSenseLength = 0xb;
 420                 buf->Flags = UNIT_ATTENTION;
 421                 buf->AdditionalSenseCode = 0;
 422                 buf->AdditionalSenseCodeQualifier = 0;
 423         } else if (error & ATA_MCR) {
 424                 buf->ErrorCode = 0x70 | SENSE_ERRCODE_VALID;
 425                 buf->AdditionalSenseLength = 0xb;
 426                 buf->Flags =  UNIT_ATTENTION;
 427                 buf->AdditionalSenseCode = 0;
 428                 buf->AdditionalSenseCodeQualifier = 0;
 429         } else if (error & ATA_TRK0NF) {
 430                 buf->ErrorCode = 0x70 | SENSE_ERRCODE_VALID;
 431                 buf->AdditionalSenseLength = 0xb;
 432                 buf->Flags =  NOT_READY;
 433                 buf->AdditionalSenseCode = 0;
 434                 buf->AdditionalSenseCodeQualifier = 0;
 435         } else if (error & ATA_UNC) {
 436                 buf->ErrorCode = 0x70 | SENSE_ERRCODE_VALID;
 437                 buf->AdditionalSenseLength = 0xb;
 438                 buf->Flags =  DATA_PROTECT;
 439                 buf->AdditionalSenseCode = 0;
 440                 buf->AdditionalSenseCodeQualifier = 0;
 441         } else {
 442                 buf->ErrorCode = 0;
 443                 buf->AdditionalSenseLength = 0;
 444                 buf->Flags =  0;
 445                 buf->AdditionalSenseCode = 0;
 446                 buf->AdditionalSenseCodeQualifier = 0;
 447         }
 448 }
 449
 450
 451 /***********************************************************************
 452  * Transport routines
 453  ***********************************************************************/
 454
 455 /**************************************************************************
 456  *  isd200_set_srb(), isd200_srb_set_bufflen()
 457  *
 458  * Two helpers to facilitate in initialization of scsi_cmnd structure
 459  * Will need to change when struct scsi_cmnd changes
 460  */
 461 static void isd200_set_srb(struct isd200_info *info,
 462         enum dma_data_direction dir, void* buff, unsigned bufflen)
 463 {
 464         struct scsi_cmnd *srb = &info->srb;
 465
 466         if (buff)
 467                 sg_init_one(&info->sg, buff, bufflen);
 468
 469         srb->sc_data_direction = dir;
 470         srb->sdb.table.sgl = buff ? &info->sg : NULL;
 471         srb->sdb.length = bufflen;
 472         srb->sdb.table.nents = buff ? 1 : 0;
 473 }
 474
 475 static void isd200_srb_set_bufflen(struct scsi_cmnd *srb, unsigned bufflen)
 476 {
 477         srb->sdb.length = bufflen;
 478 }
 479
 480
 481 /**************************************************************************
 482  *  isd200_action
 483  *
 484  * Routine for sending commands to the isd200
 485  *
 486  * RETURNS:
 487  *    ISD status code
 488  */
 489 static int isd200_action( struct us_data *us, int action,
 490                           void* pointer, int value )
 491 {
 492         union ata_cdb ata;
 493         /* static to prevent this large struct being placed on the valuable stack */
 494         static struct scsi_device srb_dev;
 495         struct isd200_info *info = (struct isd200_info *)us->extra;
 496         struct scsi_cmnd *srb = &info->srb;
 497         int status;
 498
 499         memset(&ata, 0, sizeof(ata));
 500         srb->cmnd = info->cmnd;
 501         srb->device = &srb_dev;
 502         ++srb->serial_number;
 503
 504         ata.generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
 505         ata.generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
 506         ata.generic.TransferBlockSize = 1;
 507
 508         switch ( action ) {
 509         case ACTION_READ_STATUS:
 510                 US_DEBUGP("   isd200_action(READ_STATUS)\n");
 511                 ata.generic.ActionSelect = ACTION_SELECT_0|ACTION_SELECT_2;
 512                 ata.generic.RegisterSelect =
 513                   REG_CYLINDER_LOW | REG_CYLINDER_HIGH |
 514                   REG_STATUS | REG_ERROR;
 515                 isd200_set_srb(info, DMA_FROM_DEVICE, pointer, value);
 516                 break;
 517
 518         case ACTION_ENUM:
 519                 US_DEBUGP("   isd200_action(ENUM,0x%02x)\n",value);
 520                 ata.generic.ActionSelect = ACTION_SELECT_1|ACTION_SELECT_2|
 521                                            ACTION_SELECT_3|ACTION_SELECT_4|
 522                                            ACTION_SELECT_5;
 523                 ata.generic.RegisterSelect = REG_DEVICE_HEAD;
 524                 ata.write.DeviceHeadByte = value;
 525                 isd200_set_srb(info, DMA_NONE, NULL, 0);
 526                 break;
 527
 528         case ACTION_RESET:
 529                 US_DEBUGP("   isd200_action(RESET)\n");
 530                 ata.generic.ActionSelect = ACTION_SELECT_1|ACTION_SELECT_2|
 531                                            ACTION_SELECT_3|ACTION_SELECT_4;
 532                 ata.generic.RegisterSelect = REG_DEVICE_CONTROL;
 533                 ata.write.DeviceControlByte = ATA_DC_RESET_CONTROLLER;
 534                 isd200_set_srb(info, DMA_NONE, NULL, 0);
 535                 break;
 536
 537         case ACTION_REENABLE:
 538                 US_DEBUGP("   isd200_action(REENABLE)\n");
 539                 ata.generic.ActionSelect = ACTION_SELECT_1|ACTION_SELECT_2|
 540                                            ACTION_SELECT_3|ACTION_SELECT_4;
 541                 ata.generic.RegisterSelect = REG_DEVICE_CONTROL;
 542                 ata.write.DeviceControlByte = ATA_DC_REENABLE_CONTROLLER;
 543                 isd200_set_srb(info, DMA_NONE, NULL, 0);
 544                 break;
 545
 546         case ACTION_SOFT_RESET:
 547                 US_DEBUGP("   isd200_action(SOFT_RESET)\n");
 548                 ata.generic.ActionSelect = ACTION_SELECT_1|ACTION_SELECT_5;
 549                 ata.generic.RegisterSelect = REG_DEVICE_HEAD | REG_COMMAND;
 550                 ata.write.DeviceHeadByte = info->DeviceHead;
 551                 ata.write.CommandByte = ATA_CMD_DEV_RESET;
 552                 isd200_set_srb(info, DMA_NONE, NULL, 0);
 553                 break;
 554
 555         case ACTION_IDENTIFY:
 556                 US_DEBUGP("   isd200_action(IDENTIFY)\n");
 557                 ata.generic.RegisterSelect = REG_COMMAND;
 558                 ata.write.CommandByte = ATA_CMD_ID_ATA;
 559                 isd200_set_srb(info, DMA_FROM_DEVICE, info->id,
 560                                 ATA_ID_WORDS * 2);
 561                 break;
 562
 563         default:
 564                 US_DEBUGP("Error: Undefined action %d\n",action);
 565                 return ISD200_ERROR;
 566         }
 567
 568         memcpy(srb->cmnd, &ata, sizeof(ata.generic));
 569         srb->cmd_len = sizeof(ata.generic);
 570         status = usb_stor_Bulk_transport(srb, us);
 571         if (status == USB_STOR_TRANSPORT_GOOD)
 572                 status = ISD200_GOOD;
 573         else {
 574                 US_DEBUGP("   isd200_action(0x%02x) error: %d\n",action,status);
 575                 status = ISD200_ERROR;
 576                 /* need to reset device here */
 577         }
 578
 579         return status;
 580 }
 581
 582 /**************************************************************************
 583  * isd200_read_regs
 584  *
 585  * Read ATA Registers
 586  *
 587  * RETURNS:
 588  *    ISD status code
 589  */
 590 static int isd200_read_regs( struct us_data *us )
 591 {
 592         struct isd200_info *info = (struct isd200_info *)us->extra;
 593         int retStatus = ISD200_GOOD;
 594         int transferStatus;
 595
 596         US_DEBUGP("Entering isd200_IssueATAReadRegs\n");
 597
 598         transferStatus = isd200_action( us, ACTION_READ_STATUS,
 599                                     info->RegsBuf, sizeof(info->ATARegs) );
 600         if (transferStatus != ISD200_TRANSPORT_GOOD) {
 601                 US_DEBUGP("   Error reading ATA registers\n");
 602                 retStatus = ISD200_ERROR;
 603         } else {
 604                 memcpy(info->ATARegs, info->RegsBuf, sizeof(info->ATARegs));
 605                 US_DEBUGP("   Got ATA Register[ATA_REG_ERROR_OFFSET] = 0x%x\n",
 606                           info->ATARegs[ATA_REG_ERROR_OFFSET]);
 607         }
 608
 609         return retStatus;
 610 }
 611
 612
 613 /**************************************************************************
 614  * Invoke the transport and basic error-handling/recovery methods
 615  *
 616  * This is used by the protocol layers to actually send the message to
 617  * the device and receive the response.
 618  */
 619 static void isd200_invoke_transport( struct us_data *us,
 620                               struct scsi_cmnd *srb,
 621                               union ata_cdb *ataCdb )
 622 {
 623         int need_auto_sense = 0;
 624         int transferStatus;
 625         int result;
 626
 627         /* send the command to the transport layer */
 628         memcpy(srb->cmnd, ataCdb, sizeof(ataCdb->generic));
 629         srb->cmd_len = sizeof(ataCdb->generic);
 630         transferStatus = usb_stor_Bulk_transport(srb, us);
 631
 632         /* if the command gets aborted by the higher layers, we need to
 633          * short-circuit all other processing
 634          */
 635         if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
 636                 US_DEBUGP("-- command was aborted\n");
 637                 goto Handle_Abort;
 638         }
 639
 640         switch (transferStatus) {
 641
 642         case USB_STOR_TRANSPORT_GOOD:
 643                 /* Indicate a good result */
 644                 srb->result = SAM_STAT_GOOD;
 645                 break;
 646
 647         case USB_STOR_TRANSPORT_NO_SENSE:
 648                 US_DEBUGP("-- transport indicates protocol failure\n");
 649                 srb->result = SAM_STAT_CHECK_CONDITION;
 650                 return;
 651
 652         case USB_STOR_TRANSPORT_FAILED:
 653                 US_DEBUGP("-- transport indicates command failure\n");
 654                 need_auto_sense = 1;
 655                 break;
 656
 657         case USB_STOR_TRANSPORT_ERROR:
 658                 US_DEBUGP("-- transport indicates transport error\n");
 659                 srb->result = DID_ERROR << 16;
 660                 /* Need reset here */
 661                 return;
 662
 663         default:
 664                 US_DEBUGP("-- transport indicates unknown error\n");
 665                 srb->result = DID_ERROR << 16;
 666                 /* Need reset here */
 667                 return;
 668         }
 669
 670         if ((scsi_get_resid(srb) > 0) &&
 671             !((srb->cmnd[0] == REQUEST_SENSE) ||
 672               (srb->cmnd[0] == INQUIRY) ||
 673               (srb->cmnd[0] == MODE_SENSE) ||
 674               (srb->cmnd[0] == LOG_SENSE) ||
 675               (srb->cmnd[0] == MODE_SENSE_10))) {
 676                 US_DEBUGP("-- unexpectedly short transfer\n");
 677                 need_auto_sense = 1;
 678         }
 679
 680         if (need_auto_sense) {
 681                 result = isd200_read_regs(us);
 682                 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
 683                         US_DEBUGP("-- auto-sense aborted\n");
 684                         goto Handle_Abort;
 685                 }
 686                 if (result == ISD200_GOOD) {
 687                         isd200_build_sense(us, srb);
 688                         srb->result = SAM_STAT_CHECK_CONDITION;
 689
 690                         /* If things are really okay, then let's show that */
 691                         if ((srb->sense_buffer[2] & 0xf) == 0x0)
 692                                 srb->result = SAM_STAT_GOOD;
 693                 } else {
 694                         srb->result = DID_ERROR << 16;
 695                         /* Need reset here */
 696                 }
 697         }
 698
 699         /* Regardless of auto-sense, if we _know_ we have an error
 700          * condition, show that in the result code
 701          */
 702         if (transferStatus == USB_STOR_TRANSPORT_FAILED)
 703                 srb->result = SAM_STAT_CHECK_CONDITION;
 704         return;
 705
 706         /* abort processing: the bulk-only transport requires a reset
 707          * following an abort */
 708         Handle_Abort:
 709         srb->result = DID_ABORT << 16;
 710
 711         /* permit the reset transfer to take place */
 712         clear_bit(US_FLIDX_ABORTING, &us->dflags);
 713         /* Need reset here */
 714 }
 715
 716 #ifdef CONFIG_USB_STORAGE_DEBUG
 717 static void isd200_log_config( struct isd200_info* info )
 718 {
 719         US_DEBUGP("      Event Notification: 0x%x\n",
 720                   info->ConfigData.EventNotification);
 721         US_DEBUGP("      External Clock: 0x%x\n",
 722                   info->ConfigData.ExternalClock);
 723         US_DEBUGP("      ATA Init Timeout: 0x%x\n",
 724                   info->ConfigData.ATAInitTimeout);
 725         US_DEBUGP("      ATAPI Command Block Size: 0x%x\n",
 726                   (info->ConfigData.ATAConfig & ATACFG_BLOCKSIZE) >> 6);
 727         US_DEBUGP("      Master/Slave Selection: 0x%x\n",
 728                   info->ConfigData.ATAConfig & ATACFG_MASTER);
 729         US_DEBUGP("      ATAPI Reset: 0x%x\n",
 730                   info->ConfigData.ATAConfig & ATACFG_ATAPI_RESET);
 731         US_DEBUGP("      ATA Timing: 0x%x\n",
 732                   info->ConfigData.ATAConfig & ATACFG_TIMING);
 733         US_DEBUGP("      ATA Major Command: 0x%x\n",
 734                   info->ConfigData.ATAMajorCommand);
 735         US_DEBUGP("      ATA Minor Command: 0x%x\n",
 736                   info->ConfigData.ATAMinorCommand);
 737         US_DEBUGP("      Init Status: 0x%x\n",
 738                   info->ConfigData.ATAExtraConfig & ATACFGE_INIT_STATUS);
 739         US_DEBUGP("      Config Descriptor 2: 0x%x\n",
 740                   info->ConfigData.ATAExtraConfig & ATACFGE_CONF_DESC2);
 741         US_DEBUGP("      Skip Device Boot: 0x%x\n",
 742                   info->ConfigData.ATAExtraConfig & ATACFGE_SKIP_BOOT);
 743         US_DEBUGP("      ATA 3 State Supsend: 0x%x\n",
 744                   info->ConfigData.ATAExtraConfig & ATACFGE_STATE_SUSPEND);
 745         US_DEBUGP("      Descriptor Override: 0x%x\n",
 746                   info->ConfigData.ATAExtraConfig & ATACFGE_DESC_OVERRIDE);
 747         US_DEBUGP("      Last LUN Identifier: 0x%x\n",
 748                   info->ConfigData.ATAExtraConfig & ATACFGE_LAST_LUN);
 749         US_DEBUGP("      SRST Enable: 0x%x\n",
 750                   info->ConfigData.ATAExtraConfig & CFG_CAPABILITY_SRST);
 751 }
 752 #endif
 753
 754 /**************************************************************************
 755  * isd200_write_config
 756  *
 757  * Write the ISD200 Configuration data
 758  *
 759  * RETURNS:
 760  *    ISD status code
 761  */
 762 static int isd200_write_config( struct us_data *us )
 763 {
 764         struct isd200_info *info = (struct isd200_info *)us->extra;
 765         int retStatus = ISD200_GOOD;
 766         int result;
 767
 768 #ifdef CONFIG_USB_STORAGE_DEBUG
 769         US_DEBUGP("Entering isd200_write_config\n");
 770         US_DEBUGP("   Writing the following ISD200 Config Data:\n");
 771         isd200_log_config(info);
 772 #endif
 773
 774         /* let's send the command via the control pipe */
 775         result = usb_stor_ctrl_transfer(
 776                 us,
 777                 us->send_ctrl_pipe,
 778                 0x01,
 779                 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
 780                 0x0000,
 781                 0x0002,
 782                 (void *) &info->ConfigData,
 783                 sizeof(info->ConfigData));
 784
 785         if (result >= 0) {
 786                 US_DEBUGP("   ISD200 Config Data was written successfully\n");
 787         } else {
 788                 US_DEBUGP("   Request to write ISD200 Config Data failed!\n");
 789                 retStatus = ISD200_ERROR;
 790         }
 791
 792         US_DEBUGP("Leaving isd200_write_config %08X\n", retStatus);
 793         return retStatus;
 794 }
 795
 796
 797 /**************************************************************************
 798  * isd200_read_config
 799  *
 800  * Reads the ISD200 Configuration data
 801  *
 802  * RETURNS:
 803  *    ISD status code
 804  */
 805 static int isd200_read_config( struct us_data *us )
 806 {
 807         struct isd200_info *info = (struct isd200_info *)us->extra;
 808         int retStatus = ISD200_GOOD;
 809         int result;
 810
 811         US_DEBUGP("Entering isd200_read_config\n");
 812
 813         /* read the configuration information from ISD200.  Use this to */
 814         /* determine what the special ATA CDB bytes are.                */
 815
 816         result = usb_stor_ctrl_transfer(
 817                 us,
 818                 us->recv_ctrl_pipe,
 819                 0x02,
 820                 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
 821                 0x0000,
 822                 0x0002,
 823                 (void *) &info->ConfigData,
 824                 sizeof(info->ConfigData));
 825
 826
 827         if (result >= 0) {
 828                 US_DEBUGP("   Retrieved the following ISD200 Config Data:\n");
 829 #ifdef CONFIG_USB_STORAGE_DEBUG
 830                 isd200_log_config(info);
 831 #endif
 832         } else {
 833                 US_DEBUGP("   Request to get ISD200 Config Data failed!\n");
 834                 retStatus = ISD200_ERROR;
 835         }
 836
 837         US_DEBUGP("Leaving isd200_read_config %08X\n", retStatus);
 838         return retStatus;
 839 }
 840
 841
 842 /**************************************************************************
 843  * isd200_atapi_soft_reset
 844  *
 845  * Perform an Atapi Soft Reset on the device
 846  *
 847  * RETURNS:
 848  *    NT status code
 849  */
 850 static int isd200_atapi_soft_reset( struct us_data *us )
 851 {
 852         int retStatus = ISD200_GOOD;
 853         int transferStatus;
 854
 855         US_DEBUGP("Entering isd200_atapi_soft_reset\n");
 856
 857         transferStatus = isd200_action( us, ACTION_SOFT_RESET, NULL, 0 );
 858         if (transferStatus != ISD200_TRANSPORT_GOOD) {
 859                 US_DEBUGP("   Error issuing Atapi Soft Reset\n");
 860                 retStatus = ISD200_ERROR;
 861         }
 862
 863         US_DEBUGP("Leaving isd200_atapi_soft_reset %08X\n", retStatus);
 864         return retStatus;
 865 }
 866
 867
 868 /**************************************************************************
 869  * isd200_srst
 870  *
 871  * Perform an SRST on the device
 872  *
 873  * RETURNS:
 874  *    ISD status code
 875  */
 876 static int isd200_srst( struct us_data *us )
 877 {
 878         int retStatus = ISD200_GOOD;
 879         int transferStatus;
 880
 881         US_DEBUGP("Entering isd200_SRST\n");
 882
 883         transferStatus = isd200_action( us, ACTION_RESET, NULL, 0 );
 884
 885         /* check to see if this request failed */
 886         if (transferStatus != ISD200_TRANSPORT_GOOD) {
 887                 US_DEBUGP("   Error issuing SRST\n");
 888                 retStatus = ISD200_ERROR;
 889         } else {
 890                 /* delay 10ms to give the drive a chance to see it */
 891                 msleep(10);
 892
 893                 transferStatus = isd200_action( us, ACTION_REENABLE, NULL, 0 );
 894                 if (transferStatus != ISD200_TRANSPORT_GOOD) {
 895                         US_DEBUGP("   Error taking drive out of reset\n");
 896                         retStatus = ISD200_ERROR;
 897                 } else {
 898                         /* delay 50ms to give the drive a chance to recover after SRST */
 899                         msleep(50);
 900                 }
 901         }
 902
 903         US_DEBUGP("Leaving isd200_srst %08X\n", retStatus);
 904         return retStatus;
 905 }
 906
 907
 908 /**************************************************************************
 909  * isd200_try_enum
 910  *
 911  * Helper function for isd200_manual_enum(). Does ENUM and READ_STATUS
 912  * and tries to analyze the status registers
 913  *
 914  * RETURNS:
 915  *    ISD status code
 916  */
 917 static int isd200_try_enum(struct us_data *us, unsigned char master_slave,
 918                            int detect )
 919 {
 920         int status = ISD200_GOOD;
 921         unsigned long endTime;
 922         struct isd200_info *info = (struct isd200_info *)us->extra;
 923         unsigned char *regs = info->RegsBuf;
 924         int recheckAsMaster = 0;
 925
 926         if ( detect )
 927                 endTime = jiffies + ISD200_ENUM_DETECT_TIMEOUT * HZ;
 928         else
 929                 endTime = jiffies + ISD200_ENUM_BSY_TIMEOUT * HZ;
 930
 931         /* loop until we detect !BSY or timeout */
 932         while(1) {
 933 #ifdef CONFIG_USB_STORAGE_DEBUG
 934                 char* mstr = master_slave == ATA_ADDRESS_DEVHEAD_STD ?
 935                         "Master" : "Slave";
 936 #endif
 937
 938                 status = isd200_action( us, ACTION_ENUM, NULL, master_slave );
 939                 if ( status != ISD200_GOOD )
 940                         break;
 941
 942                 status = isd200_action( us, ACTION_READ_STATUS,
 943                                         regs, 8 );
 944                 if ( status != ISD200_GOOD )
 945                         break;
 946
 947                 if (!detect) {
 948                         if (regs[ATA_REG_STATUS_OFFSET] & ATA_BUSY) {
 949                                 US_DEBUGP("   %s status is still BSY, try again...\n",mstr);
 950                         } else {
 951                                 US_DEBUGP("   %s status !BSY, continue with next operation\n",mstr);
 952                                 break;
 953                         }
 954                 }
 955                 /* check for ATA_BUSY and */
 956                 /* ATA_DF (workaround ATA Zip drive) and */
 957                 /* ATA_ERR (workaround for Archos CD-ROM) */
 958                 else if (regs[ATA_REG_STATUS_OFFSET] &
 959                          (ATA_BUSY | ATA_DF | ATA_ERR)) {
 960                         US_DEBUGP("   Status indicates it is not ready, try again...\n");
 961                 }
 962                 /* check for DRDY, ATA devices set DRDY after SRST */
 963                 else if (regs[ATA_REG_STATUS_OFFSET] & ATA_DRDY) {
 964                         US_DEBUGP("   Identified ATA device\n");
 965                         info->DeviceFlags |= DF_ATA_DEVICE;
 966                         info->DeviceHead = master_slave;
 967                         break;
 968                 }
 969                 /* check Cylinder High/Low to
 970                    determine if it is an ATAPI device
 971                 */
 972                 else if (regs[ATA_REG_HCYL_OFFSET] == 0xEB &&
 973                          regs[ATA_REG_LCYL_OFFSET] == 0x14) {
 974                         /* It seems that the RICOH
 975                            MP6200A CD/RW drive will
 976                            report itself okay as a
 977                            slave when it is really a
 978                            master. So this check again
 979                            as a master device just to
 980                            make sure it doesn't report
 981                            itself okay as a master also
 982                         */
 983                         if ((master_slave & ATA_ADDRESS_DEVHEAD_SLAVE) &&
 984                             !recheckAsMaster) {
 985                                 US_DEBUGP("   Identified ATAPI device as slave.  Rechecking again as master\n");
 986                                 recheckAsMaster = 1;
 987                                 master_slave = ATA_ADDRESS_DEVHEAD_STD;
 988                         } else {
 989                                 US_DEBUGP("   Identified ATAPI device\n");
 990                                 info->DeviceHead = master_slave;
 991
 992                                 status = isd200_atapi_soft_reset(us);
 993                                 break;
 994                         }
 995                 } else {
 996                         US_DEBUGP("   Not ATA, not ATAPI. Weird.\n");
 997                         break;
 998                 }
 999
1000                 /* check for timeout on this request */
1001                 if (time_after_eq(jiffies, endTime)) {
1002                         if (!detect)
1003                                 US_DEBUGP("   BSY check timeout, just continue with next operation...\n");
1004                         else
1005                                 US_DEBUGP("   Device detect timeout!\n");
1006                         break;
1007                 }
1008         }
1009
1010         return status;
1011 }
1012
1013 /**************************************************************************
1014  * isd200_manual_enum
1015  *
1016  * Determines if the drive attached is an ATA or ATAPI and if it is a
1017  * master or slave.
1018  *
1019  * RETURNS:
1020  *    ISD status code
1021  */
1022 static int isd200_manual_enum(struct us_data *us)
1023 {
1024         struct isd200_info *info = (struct isd200_info *)us->extra;
1025         int retStatus = ISD200_GOOD;
1026
1027         US_DEBUGP("Entering isd200_manual_enum\n");
1028
1029         retStatus = isd200_read_config(us);
1030         if (retStatus == ISD200_GOOD) {
1031                 int isslave;
1032                 /* master or slave? */
1033                 retStatus = isd200_try_enum( us, ATA_ADDRESS_DEVHEAD_STD, 0);
1034                 if (retStatus == ISD200_GOOD)
1035                         retStatus = isd200_try_enum( us, ATA_ADDRESS_DEVHEAD_SLAVE, 0);
1036
1037                 if (retStatus == ISD200_GOOD) {
1038                         retStatus = isd200_srst(us);
1039                         if (retStatus == ISD200_GOOD)
1040                                 /* ata or atapi? */
1041                                 retStatus = isd200_try_enum( us, ATA_ADDRESS_DEVHEAD_STD, 1);
1042                 }
1043
1044                 isslave = (info->DeviceHead & ATA_ADDRESS_DEVHEAD_SLAVE) ? 1 : 0;
1045                 if (!(info->ConfigData.ATAConfig & ATACFG_MASTER)) {
1046                         US_DEBUGP("   Setting Master/Slave selection to %d\n", isslave);
1047                         info->ConfigData.ATAConfig &= 0x3f;
1048                         info->ConfigData.ATAConfig |= (isslave<<6);
1049                         retStatus = isd200_write_config(us);
1050                 }
1051         }
1052
1053         US_DEBUGP("Leaving isd200_manual_enum %08X\n", retStatus);
1054         return(retStatus);
1055 }
1056
1057 static void isd200_fix_driveid(u16 *id)
1058 {
1059 #ifndef __LITTLE_ENDIAN
1060 # ifdef __BIG_ENDIAN
1061         int i;
1062
1063         for (i = 0; i < ATA_ID_WORDS; i++)
1064                 id[i] = __le16_to_cpu(id[i]);
1065 # else
1066 #  error "Please fix <asm/byteorder.h>"
1067 # endif
1068 #endif
1069 }
1070
1071 static void isd200_dump_driveid(u16 *id)
1072 {
1073         US_DEBUGP("   Identify Data Structure:\n");
1074         US_DEBUGP("      config = 0x%x\n",        id[ATA_ID_CONFIG]);
1075         US_DEBUGP("      cyls = 0x%x\n",          id[ATA_ID_CYLS]);
1076         US_DEBUGP("      heads = 0x%x\n",         id[ATA_ID_HEADS]);
1077         US_DEBUGP("      track_bytes = 0x%x\n",   id[4]);
1078         US_DEBUGP("      sector_bytes = 0x%x\n",  id[5]);
1079         US_DEBUGP("      sectors = 0x%x\n",       id[ATA_ID_SECTORS]);
1080         US_DEBUGP("      serial_no[0] = 0x%x\n",  *(char *)&id[ATA_ID_SERNO]);
1081         US_DEBUGP("      buf_type = 0x%x\n",      id[20]);
1082         US_DEBUGP("      buf_size = 0x%x\n",      id[ATA_ID_BUF_SIZE]);
1083         US_DEBUGP("      ecc_bytes = 0x%x\n",     id[22]);
1084         US_DEBUGP("      fw_rev[0] = 0x%x\n",     *(char *)&id[ATA_ID_FW_REV]);
1085         US_DEBUGP("      model[0] = 0x%x\n",      *(char *)&id[ATA_ID_PROD]);
1086         US_DEBUGP("      max_multsect = 0x%x\n",  id[ATA_ID_MAX_MULTSECT] & 0xff);
1087         US_DEBUGP("      dword_io = 0x%x\n",      id[ATA_ID_DWORD_IO]);
1088         US_DEBUGP("      capability = 0x%x\n",    id[ATA_ID_CAPABILITY] >> 8);
1089         US_DEBUGP("      tPIO = 0x%x\n",          id[ATA_ID_OLD_PIO_MODES] >> 8);
1090         US_DEBUGP("      tDMA = 0x%x\n",          id[ATA_ID_OLD_DMA_MODES] >> 8);
1091         US_DEBUGP("      field_valid = 0x%x\n",   id[ATA_ID_FIELD_VALID]);
1092         US_DEBUGP("      cur_cyls = 0x%x\n",      id[ATA_ID_CUR_CYLS]);
1093         US_DEBUGP("      cur_heads = 0x%x\n",     id[ATA_ID_CUR_HEADS]);
1094         US_DEBUGP("      cur_sectors = 0x%x\n",   id[ATA_ID_CUR_SECTORS]);
1095         US_DEBUGP("      cur_capacity = 0x%x\n",  ata_id_u32(id, 57));
1096         US_DEBUGP("      multsect = 0x%x\n",      id[ATA_ID_MULTSECT] & 0xff);
1097         US_DEBUGP("      lba_capacity = 0x%x\n",  ata_id_u32(id, ATA_ID_LBA_CAPACITY));
1098         US_DEBUGP("      command_set_1 = 0x%x\n", id[ATA_ID_COMMAND_SET_1]);
1099         US_DEBUGP("      command_set_2 = 0x%x\n", id[ATA_ID_COMMAND_SET_2]);
1100 }
1101
1102 /**************************************************************************
1103  * isd200_get_inquiry_data
1104  *
1105  * Get inquiry data
1106  *
1107  * RETURNS:
1108  *    ISD status code
1109  */
1110 static int isd200_get_inquiry_data( struct us_data *us )
1111 {
1112         struct isd200_info *info = (struct isd200_info *)us->extra;
1113         int retStatus = ISD200_GOOD;
1114         u16 *id = info->id;
1115
1116         US_DEBUGP("Entering isd200_get_inquiry_data\n");
1117
1118         /* set default to Master */
1119         info->DeviceHead = ATA_ADDRESS_DEVHEAD_STD;
1120
1121         /* attempt to manually enumerate this device */
1122         retStatus = isd200_manual_enum(us);
1123         if (retStatus == ISD200_GOOD) {
1124                 int transferStatus;
1125
1126                 /* check for an ATA device */
1127                 if (info->DeviceFlags & DF_ATA_DEVICE) {
1128                         /* this must be an ATA device */
1129                         /* perform an ATA Command Identify */
1130                         transferStatus = isd200_action( us, ACTION_IDENTIFY,
1131                                                         id, ATA_ID_WORDS * 2);
1132                         if (transferStatus != ISD200_TRANSPORT_GOOD) {
1133                                 /* Error issuing ATA Command Identify */
1134                                 US_DEBUGP("   Error issuing ATA Command Identify\n");
1135                                 retStatus = ISD200_ERROR;
1136                         } else {
1137                                 /* ATA Command Identify successful */
1138                                 int i;
1139                                 __be16 *src;
1140                                 __u16 *dest;
1141
1142                                 isd200_fix_driveid(id);
1143                                 isd200_dump_driveid(id);
1144
1145                                 memset(&info->InquiryData, 0, sizeof(info->InquiryData));
1146
1147                                 /* Standard IDE interface only supports disks */
1148                                 info->InquiryData.DeviceType = DIRECT_ACCESS_DEVICE;
1149
1150                                 /* The length must be at least 36 (5 + 31) */
1151                                 info->InquiryData.AdditionalLength = 0x1F;
1152
1153                                 if (id[ATA_ID_COMMAND_SET_1] & COMMANDSET_MEDIA_STATUS) {
1154                                         /* set the removable bit */
1155                                         info->InquiryData.DeviceTypeModifier = DEVICE_REMOVABLE;
1156                                         info->DeviceFlags |= DF_REMOVABLE_MEDIA;
1157                                 }
1158
1159                                 /* Fill in vendor identification fields */
1160                                 src = (__be16 *)&id[ATA_ID_PROD];
1161                                 dest = (__u16*)info->InquiryData.VendorId;
1162                                 for (i=0;i<4;i++)
1163                                         dest[i] = be16_to_cpu(src[i]);
1164
1165                                 src = (__be16 *)&id[ATA_ID_PROD + 8/2];
1166                                 dest = (__u16*)info->InquiryData.ProductId;
1167                                 for (i=0;i<8;i++)
1168                                         dest[i] = be16_to_cpu(src[i]);
1169
1170                                 src = (__be16 *)&id[ATA_ID_FW_REV];
1171                                 dest = (__u16*)info->InquiryData.ProductRevisionLevel;
1172                                 for (i=0;i<2;i++)
1173                                         dest[i] = be16_to_cpu(src[i]);
1174
1175                                 /* determine if it supports Media Status Notification */
1176                                 if (id[ATA_ID_COMMAND_SET_2] & COMMANDSET_MEDIA_STATUS) {
1177                                         US_DEBUGP("   Device supports Media Status Notification\n");
1178
1179                                         /* Indicate that it is enabled, even though it is not
1180                                          * This allows the lock/unlock of the media to work
1181                                          * correctly.
1182                                          */
1183                                         info->DeviceFlags |= DF_MEDIA_STATUS_ENABLED;
1184                                 }
1185                                 else
1186                                         info->DeviceFlags &= ~DF_MEDIA_STATUS_ENABLED;
1187
1188                         }
1189                 } else {
1190                         /*
1191                          * this must be an ATAPI device
1192                          * use an ATAPI protocol (Transparent SCSI)
1193                          */
1194                         us->protocol_name = "Transparent SCSI";
1195                         us->proto_handler = usb_stor_transparent_scsi_command;
1196
1197                         US_DEBUGP("Protocol changed to: %s\n", us->protocol_name);
1198
1199                         /* Free driver structure */
1200                         us->extra_destructor(info);
1201                         kfree(info);
1202                         us->extra = NULL;
1203                         us->extra_destructor = NULL;
1204                 }
1205         }
1206
1207         US_DEBUGP("Leaving isd200_get_inquiry_data %08X\n", retStatus);
1208
1209         return(retStatus);
1210 }
1211
1212 /**************************************************************************
1213  * isd200_scsi_to_ata
1214  *
1215  * Translate SCSI commands to ATA commands.
1216  *
1217  * RETURNS:
1218  *    1 if the command needs to be sent to the transport layer
1219  *    0 otherwise
1220  */
1221 static int isd200_scsi_to_ata(struct scsi_cmnd *srb, struct us_data *us,
1222                               union ata_cdb * ataCdb)
1223 {
1224         struct isd200_info *info = (struct isd200_info *)us->extra;
1225         u16 *id = info->id;
1226         int sendToTransport = 1;
1227         unsigned char sectnum, head;
1228         unsigned short cylinder;
1229         unsigned long lba;
1230         unsigned long blockCount;
1231         unsigned char senseData[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
1232
1233         memset(ataCdb, 0, sizeof(union ata_cdb));
1234
1235         /* SCSI Command */
1236         switch (srb->cmnd[0]) {
1237         case INQUIRY:
1238                 US_DEBUGP("   ATA OUT - INQUIRY\n");
1239
1240                 /* copy InquiryData */
1241                 usb_stor_set_xfer_buf((unsigned char *) &info->InquiryData,
1242                                 sizeof(info->InquiryData), srb);
1243                 srb->result = SAM_STAT_GOOD;
1244                 sendToTransport = 0;
1245                 break;
1246
1247         case MODE_SENSE:
1248                 US_DEBUGP("   ATA OUT - SCSIOP_MODE_SENSE\n");
1249
1250                 /* Initialize the return buffer */
1251                 usb_stor_set_xfer_buf(senseData, sizeof(senseData), srb);
1252
1253                 if (info->DeviceFlags & DF_MEDIA_STATUS_ENABLED)
1254                 {
1255                         ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1256                         ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1257                         ataCdb->generic.TransferBlockSize = 1;
1258                         ataCdb->generic.RegisterSelect = REG_COMMAND;
1259                         ataCdb->write.CommandByte = ATA_COMMAND_GET_MEDIA_STATUS;
1260                         isd200_srb_set_bufflen(srb, 0);
1261                 } else {
1262                         US_DEBUGP("   Media Status not supported, just report okay\n");
1263                         srb->result = SAM_STAT_GOOD;
1264                         sendToTransport = 0;
1265                 }
1266                 break;
1267
1268         case TEST_UNIT_READY:
1269                 US_DEBUGP("   ATA OUT - SCSIOP_TEST_UNIT_READY\n");
1270
1271                 if (info->DeviceFlags & DF_MEDIA_STATUS_ENABLED)
1272                 {
1273                         ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1274                         ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1275                         ataCdb->generic.TransferBlockSize = 1;
1276                         ataCdb->generic.RegisterSelect = REG_COMMAND;
1277                         ataCdb->write.CommandByte = ATA_COMMAND_GET_MEDIA_STATUS;
1278                         isd200_srb_set_bufflen(srb, 0);
1279                 } else {
1280                         US_DEBUGP("   Media Status not supported, just report okay\n");
1281                         srb->result = SAM_STAT_GOOD;
1282                         sendToTransport = 0;
1283                 }
1284                 break;
1285
1286         case READ_CAPACITY:
1287         {
1288                 unsigned long capacity;
1289                 struct read_capacity_data readCapacityData;
1290
1291                 US_DEBUGP("   ATA OUT - SCSIOP_READ_CAPACITY\n");
1292
1293                 if (ata_id_has_lba(id))
1294                         capacity = ata_id_u32(id, ATA_ID_LBA_CAPACITY) - 1;
1295                 else
1296                         capacity = (id[ATA_ID_HEADS] * id[ATA_ID_CYLS] *
1297                                     id[ATA_ID_SECTORS]) - 1;
1298
1299                 readCapacityData.LogicalBlockAddress = cpu_to_be32(capacity);
1300                 readCapacityData.BytesPerBlock = cpu_to_be32(0x200);
1301
1302                 usb_stor_set_xfer_buf((unsigned char *) &readCapacityData,
1303                                 sizeof(readCapacityData), srb);
1304                 srb->result = SAM_STAT_GOOD;
1305                 sendToTransport = 0;
1306         }
1307         break;
1308
1309         case READ_10:
1310                 US_DEBUGP("   ATA OUT - SCSIOP_READ\n");
1311
1312                 lba = be32_to_cpu(*(__be32 *)&srb->cmnd[2]);
1313                 blockCount = (unsigned long)srb->cmnd[7]<<8 | (unsigned long)srb->cmnd[8];
1314
1315                 if (ata_id_has_lba(id)) {
1316                         sectnum = (unsigned char)(lba);
1317                         cylinder = (unsigned short)(lba>>8);
1318                         head = ATA_ADDRESS_DEVHEAD_LBA_MODE | (unsigned char)(lba>>24 & 0x0F);
1319                 } else {
1320                         sectnum = (u8)((lba % id[ATA_ID_SECTORS]) + 1);
1321                         cylinder = (u16)(lba / (id[ATA_ID_SECTORS] *
1322                                         id[ATA_ID_HEADS]));
1323                         head = (u8)((lba / id[ATA_ID_SECTORS]) %
1324                                         id[ATA_ID_HEADS]);
1325                 }
1326                 ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1327                 ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1328                 ataCdb->generic.TransferBlockSize = 1;
1329                 ataCdb->generic.RegisterSelect =
1330                   REG_SECTOR_COUNT | REG_SECTOR_NUMBER |
1331                   REG_CYLINDER_LOW | REG_CYLINDER_HIGH |
1332                   REG_DEVICE_HEAD  | REG_COMMAND;
1333                 ataCdb->write.SectorCountByte = (unsigned char)blockCount;
1334                 ataCdb->write.SectorNumberByte = sectnum;
1335                 ataCdb->write.CylinderHighByte = (unsigned char)(cylinder>>8);
1336                 ataCdb->write.CylinderLowByte = (unsigned char)cylinder;
1337                 ataCdb->write.DeviceHeadByte = (head | ATA_ADDRESS_DEVHEAD_STD);
1338                 ataCdb->write.CommandByte = ATA_CMD_PIO_READ;
1339                 break;
1340
1341         case WRITE_10:
1342                 US_DEBUGP("   ATA OUT - SCSIOP_WRITE\n");
1343
1344                 lba = be32_to_cpu(*(__be32 *)&srb->cmnd[2]);
1345                 blockCount = (unsigned long)srb->cmnd[7]<<8 | (unsigned long)srb->cmnd[8];
1346
1347                 if (ata_id_has_lba(id)) {
1348                         sectnum = (unsigned char)(lba);
1349                         cylinder = (unsigned short)(lba>>8);
1350                         head = ATA_ADDRESS_DEVHEAD_LBA_MODE | (unsigned char)(lba>>24 & 0x0F);
1351                 } else {
1352                         sectnum = (u8)((lba % id[ATA_ID_SECTORS]) + 1);
1353                         cylinder = (u16)(lba / (id[ATA_ID_SECTORS] *
1354                                         id[ATA_ID_HEADS]));
1355                         head = (u8)((lba / id[ATA_ID_SECTORS]) %
1356                                         id[ATA_ID_HEADS]);
1357                 }
1358                 ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1359                 ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1360                 ataCdb->generic.TransferBlockSize = 1;
1361                 ataCdb->generic.RegisterSelect =
1362                   REG_SECTOR_COUNT | REG_SECTOR_NUMBER |
1363                   REG_CYLINDER_LOW | REG_CYLINDER_HIGH |
1364                   REG_DEVICE_HEAD  | REG_COMMAND;
1365                 ataCdb->write.SectorCountByte = (unsigned char)blockCount;
1366                 ataCdb->write.SectorNumberByte = sectnum;
1367                 ataCdb->write.CylinderHighByte = (unsigned char)(cylinder>>8);
1368                 ataCdb->write.CylinderLowByte = (unsigned char)cylinder;
1369                 ataCdb->write.DeviceHeadByte = (head | ATA_ADDRESS_DEVHEAD_STD);
1370                 ataCdb->write.CommandByte = ATA_CMD_PIO_WRITE;
1371                 break;
1372
1373         case ALLOW_MEDIUM_REMOVAL:
1374                 US_DEBUGP("   ATA OUT - SCSIOP_MEDIUM_REMOVAL\n");
1375
1376                 if (info->DeviceFlags & DF_REMOVABLE_MEDIA) {
1377                         US_DEBUGP("   srb->cmnd[4] = 0x%X\n", srb->cmnd[4]);
1378
1379                         ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1380                         ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1381                         ataCdb->generic.TransferBlockSize = 1;
1382                         ataCdb->generic.RegisterSelect = REG_COMMAND;
1383                         ataCdb->write.CommandByte = (srb->cmnd[4] & 0x1) ?
1384                                 ATA_CMD_MEDIA_LOCK : ATA_CMD_MEDIA_UNLOCK;
1385                         isd200_srb_set_bufflen(srb, 0);
1386                 } else {
1387                         US_DEBUGP("   Not removeable media, just report okay\n");
1388                         srb->result = SAM_STAT_GOOD;
1389                         sendToTransport = 0;
1390                 }
1391                 break;
1392
1393         case START_STOP:
1394                 US_DEBUGP("   ATA OUT - SCSIOP_START_STOP_UNIT\n");
1395                 US_DEBUGP("   srb->cmnd[4] = 0x%X\n", srb->cmnd[4]);
1396
1397                 if ((srb->cmnd[4] & 0x3) == 0x2) {
1398                         US_DEBUGP("   Media Eject\n");
1399                         ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1400                         ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1401                         ataCdb->generic.TransferBlockSize = 0;
1402                         ataCdb->generic.RegisterSelect = REG_COMMAND;
1403                         ataCdb->write.CommandByte = ATA_COMMAND_MEDIA_EJECT;
1404                 } else if ((srb->cmnd[4] & 0x3) == 0x1) {
1405                         US_DEBUGP("   Get Media Status\n");
1406                         ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1407                         ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1408                         ataCdb->generic.TransferBlockSize = 1;
1409                         ataCdb->generic.RegisterSelect = REG_COMMAND;
1410                         ataCdb->write.CommandByte = ATA_COMMAND_GET_MEDIA_STATUS;
1411                         isd200_srb_set_bufflen(srb, 0);
1412                 } else {
1413                         US_DEBUGP("   Nothing to do, just report okay\n");
1414                         srb->result = SAM_STAT_GOOD;
1415                         sendToTransport = 0;
1416                 }
1417                 break;
1418
1419         default:
1420                 US_DEBUGP("Unsupported SCSI command - 0x%X\n", srb->cmnd[0]);
1421                 srb->result = DID_ERROR << 16;
1422                 sendToTransport = 0;
1423                 break;
1424         }
1425
1426         return(sendToTransport);
1427 }
1428
1429
1430 /**************************************************************************
1431  * isd200_free_info
1432  *
1433  * Frees the driver structure.
1434  */
1435 static void isd200_free_info_ptrs(void *info_)
1436 {
1437         struct isd200_info *info = (struct isd200_info *) info_;
1438
1439         if (info) {
1440                 kfree(info->id);
1441                 kfree(info->RegsBuf);
1442                 kfree(info->srb.sense_buffer);
1443         }
1444 }
1445
1446 /**************************************************************************
1447  * isd200_init_info
1448  *
1449  * Allocates (if necessary) and initializes the driver structure.
1450  *
1451  * RETURNS:
1452  *    ISD status code
1453  */
1454 static int isd200_init_info(struct us_data *us)
1455 {
1456         int retStatus = ISD200_GOOD;
1457         struct isd200_info *info;
1458
1459         info = kzalloc(sizeof(struct isd200_info), GFP_KERNEL);
1460         if (!info)
1461                 retStatus = ISD200_ERROR;
1462         else {
1463                 info->id = kzalloc(ATA_ID_WORDS * 2, GFP_KERNEL);
1464                 info->RegsBuf = (unsigned char *)
1465                                 kmalloc(sizeof(info->ATARegs), GFP_KERNEL);
1466                 info->srb.sense_buffer =
1467                                 kmalloc(SCSI_SENSE_BUFFERSIZE, GFP_KERNEL);
1468                 if (!info->id || !info->RegsBuf || !info->srb.sense_buffer) {
1469                         isd200_free_info_ptrs(info);
1470                         kfree(info);
1471                         retStatus = ISD200_ERROR;
1472                 }
1473         }
1474
1475         if (retStatus == ISD200_GOOD) {
1476                 us->extra = info;
1477                 us->extra_destructor = isd200_free_info_ptrs;
1478         } else
1479                 US_DEBUGP("ERROR - kmalloc failure\n");
1480
1481         return retStatus;
1482 }
1483
1484 /**************************************************************************
1485  * Initialization for the ISD200
1486  */
1487
1488 static int isd200_Initialization(struct us_data *us)
1489 {
1490         US_DEBUGP("ISD200 Initialization...\n");
1491
1492         /* Initialize ISD200 info struct */
1493
1494         if (isd200_init_info(us) == ISD200_ERROR) {
1495                 US_DEBUGP("ERROR Initializing ISD200 Info struct\n");
1496         } else {
1497                 /* Get device specific data */
1498
1499                 if (isd200_get_inquiry_data(us) != ISD200_GOOD)
1500                         US_DEBUGP("ISD200 Initialization Failure\n");
1501                 else
1502                         US_DEBUGP("ISD200 Initialization complete\n");
1503         }
1504
1505         return 0;
1506 }
1507
1508
1509 /**************************************************************************
1510  * Protocol and Transport for the ISD200 ASIC
1511  *
1512  * This protocol and transport are for ATA devices connected to an ISD200
1513  * ASIC.  An ATAPI device that is connected as a slave device will be
1514  * detected in the driver initialization function and the protocol will
1515  * be changed to an ATAPI protocol (Transparent SCSI).
1516  *
1517  */
1518
1519 static void isd200_ata_command(struct scsi_cmnd *srb, struct us_data *us)
1520 {
1521         int sendToTransport = 1, orig_bufflen;
1522         union ata_cdb ataCdb;
1523
1524         /* Make sure driver was initialized */
1525
1526         if (us->extra == NULL)
1527                 US_DEBUGP("ERROR Driver not initialized\n");
1528
1529         scsi_set_resid(srb, 0);
1530         /* scsi_bufflen might change in protocol translation to ata */
1531         orig_bufflen = scsi_bufflen(srb);
1532         sendToTransport = isd200_scsi_to_ata(srb, us, &ataCdb);
1533
1534         /* send the command to the transport layer */
1535         if (sendToTransport)
1536                 isd200_invoke_transport(us, srb, &ataCdb);
1537
1538         isd200_srb_set_bufflen(srb, orig_bufflen);
1539 }
1540
1541 static int isd200_probe(struct usb_interface *intf,
1542                          const struct usb_device_id *id)
1543 {
1544         struct us_data *us;
1545         int result;
1546
1547         result = usb_stor_probe1(&us, intf, id,
1548                         (id - isd200_usb_ids) + isd200_unusual_dev_list);
1549         if (result)
1550                 return result;
1551
1552         us->protocol_name = "ISD200 ATA/ATAPI";
1553         us->proto_handler = isd200_ata_command;
1554
1555         result = usb_stor_probe2(us);
1556         return result;
1557 }
1558
1559 static struct usb_driver isd200_driver = {
1560         .name =         "ums-isd200",
1561         .probe =        isd200_probe,
1562         .disconnect =   usb_stor_disconnect,
1563         .suspend =      usb_stor_suspend,
1564         .resume =       usb_stor_resume,
1565         .reset_resume = usb_stor_reset_resume,
1566         .pre_reset =    usb_stor_pre_reset,
1567         .post_reset =   usb_stor_post_reset,
1568         .id_table =     isd200_usb_ids,
1569         .soft_unbind =  1,
1570 };
1571
1572 static int __init isd200_init(void)
1573 {
1574         return usb_register(&isd200_driver);
1575 }
1576
1577 static void __exit isd200_exit(void)
1578 {
1579         usb_deregister(&isd200_driver);
1580 }
1581
1582 module_init(isd200_init);
1583 module_exit(isd200_exit);