linux/drivers/usb/storage/isd200.c
<<
>>
Prefs
   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
  63MODULE_DESCRIPTION("Driver for In-System Design, Inc. ISD200 ASIC");
  64MODULE_AUTHOR("Björn Stenberg <bjorn@haxx.se>");
  65MODULE_LICENSE("GPL");
  66
  67static 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
  79static struct usb_device_id isd200_usb_ids[] = {
  80#       include "unusual_isd200.h"
  81        { }             /* Terminating entry */
  82};
  83MODULE_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
 102static 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
 205union 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
 274struct 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
 314struct 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
 330struct 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
 351struct 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
 362struct 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
 379struct 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 */
 411static 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 */
 461static 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
 475static 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 */
 489static 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
 503        ata.generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
 504        ata.generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
 505        ata.generic.TransferBlockSize = 1;
 506
 507        switch ( action ) {
 508        case ACTION_READ_STATUS:
 509                US_DEBUGP("   isd200_action(READ_STATUS)\n");
 510                ata.generic.ActionSelect = ACTION_SELECT_0|ACTION_SELECT_2;
 511                ata.generic.RegisterSelect =
 512                  REG_CYLINDER_LOW | REG_CYLINDER_HIGH |
 513                  REG_STATUS | REG_ERROR;
 514                isd200_set_srb(info, DMA_FROM_DEVICE, pointer, value);
 515                break;
 516
 517        case ACTION_ENUM:
 518                US_DEBUGP("   isd200_action(ENUM,0x%02x)\n",value);
 519                ata.generic.ActionSelect = ACTION_SELECT_1|ACTION_SELECT_2|
 520                                           ACTION_SELECT_3|ACTION_SELECT_4|
 521                                           ACTION_SELECT_5;
 522                ata.generic.RegisterSelect = REG_DEVICE_HEAD;
 523                ata.write.DeviceHeadByte = value;
 524                isd200_set_srb(info, DMA_NONE, NULL, 0);
 525                break;
 526
 527        case ACTION_RESET:
 528                US_DEBUGP("   isd200_action(RESET)\n");
 529                ata.generic.ActionSelect = ACTION_SELECT_1|ACTION_SELECT_2|
 530                                           ACTION_SELECT_3|ACTION_SELECT_4;
 531                ata.generic.RegisterSelect = REG_DEVICE_CONTROL;
 532                ata.write.DeviceControlByte = ATA_DC_RESET_CONTROLLER;
 533                isd200_set_srb(info, DMA_NONE, NULL, 0);
 534                break;
 535
 536        case ACTION_REENABLE:
 537                US_DEBUGP("   isd200_action(REENABLE)\n");
 538                ata.generic.ActionSelect = ACTION_SELECT_1|ACTION_SELECT_2|
 539                                           ACTION_SELECT_3|ACTION_SELECT_4;
 540                ata.generic.RegisterSelect = REG_DEVICE_CONTROL;
 541                ata.write.DeviceControlByte = ATA_DC_REENABLE_CONTROLLER;
 542                isd200_set_srb(info, DMA_NONE, NULL, 0);
 543                break;
 544
 545        case ACTION_SOFT_RESET:
 546                US_DEBUGP("   isd200_action(SOFT_RESET)\n");
 547                ata.generic.ActionSelect = ACTION_SELECT_1|ACTION_SELECT_5;
 548                ata.generic.RegisterSelect = REG_DEVICE_HEAD | REG_COMMAND;
 549                ata.write.DeviceHeadByte = info->DeviceHead;
 550                ata.write.CommandByte = ATA_CMD_DEV_RESET;
 551                isd200_set_srb(info, DMA_NONE, NULL, 0);
 552                break;
 553
 554        case ACTION_IDENTIFY:
 555                US_DEBUGP("   isd200_action(IDENTIFY)\n");
 556                ata.generic.RegisterSelect = REG_COMMAND;
 557                ata.write.CommandByte = ATA_CMD_ID_ATA;
 558                isd200_set_srb(info, DMA_FROM_DEVICE, info->id,
 559                                ATA_ID_WORDS * 2);
 560                break;
 561
 562        default:
 563                US_DEBUGP("Error: Undefined action %d\n",action);
 564                return ISD200_ERROR;
 565        }
 566
 567        memcpy(srb->cmnd, &ata, sizeof(ata.generic));
 568        srb->cmd_len = sizeof(ata.generic);
 569        status = usb_stor_Bulk_transport(srb, us);
 570        if (status == USB_STOR_TRANSPORT_GOOD)
 571                status = ISD200_GOOD;
 572        else {
 573                US_DEBUGP("   isd200_action(0x%02x) error: %d\n",action,status);
 574                status = ISD200_ERROR;
 575                /* need to reset device here */
 576        }
 577
 578        return status;
 579}
 580
 581/**************************************************************************
 582 * isd200_read_regs
 583 *                                                                       
 584 * Read ATA Registers
 585 *
 586 * RETURNS:
 587 *    ISD status code
 588 */
 589static int isd200_read_regs( struct us_data *us )
 590{
 591        struct isd200_info *info = (struct isd200_info *)us->extra;
 592        int retStatus = ISD200_GOOD;
 593        int transferStatus;
 594
 595        US_DEBUGP("Entering isd200_IssueATAReadRegs\n");
 596
 597        transferStatus = isd200_action( us, ACTION_READ_STATUS,
 598                                    info->RegsBuf, sizeof(info->ATARegs) );
 599        if (transferStatus != ISD200_TRANSPORT_GOOD) {
 600                US_DEBUGP("   Error reading ATA registers\n");
 601                retStatus = ISD200_ERROR;
 602        } else {
 603                memcpy(info->ATARegs, info->RegsBuf, sizeof(info->ATARegs));
 604                US_DEBUGP("   Got ATA Register[ATA_REG_ERROR_OFFSET] = 0x%x\n",
 605                          info->ATARegs[ATA_REG_ERROR_OFFSET]);
 606        }
 607
 608        return retStatus;
 609}
 610
 611
 612/**************************************************************************
 613 * Invoke the transport and basic error-handling/recovery methods
 614 *
 615 * This is used by the protocol layers to actually send the message to
 616 * the device and receive the response.
 617 */
 618static void isd200_invoke_transport( struct us_data *us, 
 619                              struct scsi_cmnd *srb, 
 620                              union ata_cdb *ataCdb )
 621{
 622        int need_auto_sense = 0;
 623        int transferStatus;
 624        int result;
 625
 626        /* send the command to the transport layer */
 627        memcpy(srb->cmnd, ataCdb, sizeof(ataCdb->generic));
 628        srb->cmd_len = sizeof(ataCdb->generic);
 629        transferStatus = usb_stor_Bulk_transport(srb, us);
 630
 631        /* if the command gets aborted by the higher layers, we need to
 632         * short-circuit all other processing
 633         */
 634        if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
 635                US_DEBUGP("-- command was aborted\n");
 636                goto Handle_Abort;
 637        }
 638
 639        switch (transferStatus) {
 640
 641        case USB_STOR_TRANSPORT_GOOD:
 642                /* Indicate a good result */
 643                srb->result = SAM_STAT_GOOD;
 644                break;
 645
 646        case USB_STOR_TRANSPORT_NO_SENSE:
 647                US_DEBUGP("-- transport indicates protocol failure\n");
 648                srb->result = SAM_STAT_CHECK_CONDITION;
 649                return;
 650
 651        case USB_STOR_TRANSPORT_FAILED:
 652                US_DEBUGP("-- transport indicates command failure\n");
 653                need_auto_sense = 1;
 654                break;
 655
 656        case USB_STOR_TRANSPORT_ERROR:
 657                US_DEBUGP("-- transport indicates transport error\n");
 658                srb->result = DID_ERROR << 16;
 659                /* Need reset here */
 660                return;
 661    
 662        default:
 663                US_DEBUGP("-- transport indicates unknown error\n");   
 664                srb->result = DID_ERROR << 16;
 665                /* Need reset here */
 666                return;
 667        }
 668
 669        if ((scsi_get_resid(srb) > 0) &&
 670            !((srb->cmnd[0] == REQUEST_SENSE) ||
 671              (srb->cmnd[0] == INQUIRY) ||
 672              (srb->cmnd[0] == MODE_SENSE) ||
 673              (srb->cmnd[0] == LOG_SENSE) ||
 674              (srb->cmnd[0] == MODE_SENSE_10))) {
 675                US_DEBUGP("-- unexpectedly short transfer\n");
 676                need_auto_sense = 1;
 677        }
 678
 679        if (need_auto_sense) {
 680                result = isd200_read_regs(us);
 681                if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
 682                        US_DEBUGP("-- auto-sense aborted\n");
 683                        goto Handle_Abort;
 684                }
 685                if (result == ISD200_GOOD) {
 686                        isd200_build_sense(us, srb);
 687                        srb->result = SAM_STAT_CHECK_CONDITION;
 688
 689                        /* If things are really okay, then let's show that */
 690                        if ((srb->sense_buffer[2] & 0xf) == 0x0)
 691                                srb->result = SAM_STAT_GOOD;
 692                } else {
 693                        srb->result = DID_ERROR << 16;
 694                        /* Need reset here */
 695                }
 696        }
 697
 698        /* Regardless of auto-sense, if we _know_ we have an error
 699         * condition, show that in the result code
 700         */
 701        if (transferStatus == USB_STOR_TRANSPORT_FAILED)
 702                srb->result = SAM_STAT_CHECK_CONDITION;
 703        return;
 704
 705        /* abort processing: the bulk-only transport requires a reset
 706         * following an abort */
 707        Handle_Abort:
 708        srb->result = DID_ABORT << 16;
 709
 710        /* permit the reset transfer to take place */
 711        clear_bit(US_FLIDX_ABORTING, &us->dflags);
 712        /* Need reset here */
 713}
 714
 715#ifdef CONFIG_USB_STORAGE_DEBUG
 716static void isd200_log_config( struct isd200_info* info )
 717{
 718        US_DEBUGP("      Event Notification: 0x%x\n", 
 719                  info->ConfigData.EventNotification);
 720        US_DEBUGP("      External Clock: 0x%x\n", 
 721                  info->ConfigData.ExternalClock);
 722        US_DEBUGP("      ATA Init Timeout: 0x%x\n", 
 723                  info->ConfigData.ATAInitTimeout);
 724        US_DEBUGP("      ATAPI Command Block Size: 0x%x\n", 
 725                  (info->ConfigData.ATAConfig & ATACFG_BLOCKSIZE) >> 6);
 726        US_DEBUGP("      Master/Slave Selection: 0x%x\n", 
 727                  info->ConfigData.ATAConfig & ATACFG_MASTER);
 728        US_DEBUGP("      ATAPI Reset: 0x%x\n",
 729                  info->ConfigData.ATAConfig & ATACFG_ATAPI_RESET);
 730        US_DEBUGP("      ATA Timing: 0x%x\n",
 731                  info->ConfigData.ATAConfig & ATACFG_TIMING);
 732        US_DEBUGP("      ATA Major Command: 0x%x\n", 
 733                  info->ConfigData.ATAMajorCommand);
 734        US_DEBUGP("      ATA Minor Command: 0x%x\n", 
 735                  info->ConfigData.ATAMinorCommand);
 736        US_DEBUGP("      Init Status: 0x%x\n", 
 737                  info->ConfigData.ATAExtraConfig & ATACFGE_INIT_STATUS);
 738        US_DEBUGP("      Config Descriptor 2: 0x%x\n", 
 739                  info->ConfigData.ATAExtraConfig & ATACFGE_CONF_DESC2);
 740        US_DEBUGP("      Skip Device Boot: 0x%x\n",
 741                  info->ConfigData.ATAExtraConfig & ATACFGE_SKIP_BOOT);
 742        US_DEBUGP("      ATA 3 State Supsend: 0x%x\n",
 743                  info->ConfigData.ATAExtraConfig & ATACFGE_STATE_SUSPEND);
 744        US_DEBUGP("      Descriptor Override: 0x%x\n", 
 745                  info->ConfigData.ATAExtraConfig & ATACFGE_DESC_OVERRIDE);
 746        US_DEBUGP("      Last LUN Identifier: 0x%x\n",
 747                  info->ConfigData.ATAExtraConfig & ATACFGE_LAST_LUN);
 748        US_DEBUGP("      SRST Enable: 0x%x\n", 
 749                  info->ConfigData.ATAExtraConfig & CFG_CAPABILITY_SRST);
 750}
 751#endif
 752
 753/**************************************************************************
 754 * isd200_write_config
 755 *                                                                       
 756 * Write the ISD200 Configuration data
 757 *
 758 * RETURNS:
 759 *    ISD status code
 760 */
 761static int isd200_write_config( struct us_data *us ) 
 762{
 763        struct isd200_info *info = (struct isd200_info *)us->extra;
 764        int retStatus = ISD200_GOOD;
 765        int result;
 766
 767#ifdef CONFIG_USB_STORAGE_DEBUG
 768        US_DEBUGP("Entering isd200_write_config\n");
 769        US_DEBUGP("   Writing the following ISD200 Config Data:\n");
 770        isd200_log_config(info);
 771#endif
 772
 773        /* let's send the command via the control pipe */
 774        result = usb_stor_ctrl_transfer(
 775                us, 
 776                us->send_ctrl_pipe,
 777                0x01, 
 778                USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
 779                0x0000, 
 780                0x0002, 
 781                (void *) &info->ConfigData, 
 782                sizeof(info->ConfigData));
 783
 784        if (result >= 0) {
 785                US_DEBUGP("   ISD200 Config Data was written successfully\n");
 786        } else {
 787                US_DEBUGP("   Request to write ISD200 Config Data failed!\n");
 788                retStatus = ISD200_ERROR;
 789        }
 790
 791        US_DEBUGP("Leaving isd200_write_config %08X\n", retStatus);
 792        return retStatus;
 793}
 794
 795
 796/**************************************************************************
 797 * isd200_read_config
 798 *                                                                       
 799 * Reads the ISD200 Configuration data
 800 *
 801 * RETURNS:
 802 *    ISD status code
 803 */
 804static int isd200_read_config( struct us_data *us ) 
 805{
 806        struct isd200_info *info = (struct isd200_info *)us->extra;
 807        int retStatus = ISD200_GOOD;
 808        int result;
 809
 810        US_DEBUGP("Entering isd200_read_config\n");
 811
 812        /* read the configuration information from ISD200.  Use this to */
 813        /* determine what the special ATA CDB bytes are.                */
 814
 815        result = usb_stor_ctrl_transfer(
 816                us, 
 817                us->recv_ctrl_pipe,
 818                0x02, 
 819                USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
 820                0x0000, 
 821                0x0002, 
 822                (void *) &info->ConfigData, 
 823                sizeof(info->ConfigData));
 824
 825
 826        if (result >= 0) {
 827                US_DEBUGP("   Retrieved the following ISD200 Config Data:\n");
 828#ifdef CONFIG_USB_STORAGE_DEBUG
 829                isd200_log_config(info);
 830#endif
 831        } else {
 832                US_DEBUGP("   Request to get ISD200 Config Data failed!\n");
 833                retStatus = ISD200_ERROR;
 834        }
 835
 836        US_DEBUGP("Leaving isd200_read_config %08X\n", retStatus);
 837        return retStatus;
 838}
 839
 840
 841/**************************************************************************
 842 * isd200_atapi_soft_reset
 843 *                                                                       
 844 * Perform an Atapi Soft Reset on the device
 845 *
 846 * RETURNS:
 847 *    NT status code
 848 */
 849static int isd200_atapi_soft_reset( struct us_data *us ) 
 850{
 851        int retStatus = ISD200_GOOD;
 852        int transferStatus;
 853
 854        US_DEBUGP("Entering isd200_atapi_soft_reset\n");
 855
 856        transferStatus = isd200_action( us, ACTION_SOFT_RESET, NULL, 0 );
 857        if (transferStatus != ISD200_TRANSPORT_GOOD) {
 858                US_DEBUGP("   Error issuing Atapi Soft Reset\n");
 859                retStatus = ISD200_ERROR;
 860        }
 861
 862        US_DEBUGP("Leaving isd200_atapi_soft_reset %08X\n", retStatus);
 863        return retStatus;
 864}
 865
 866
 867/**************************************************************************
 868 * isd200_srst
 869 *                                                                       
 870 * Perform an SRST on the device
 871 *
 872 * RETURNS:
 873 *    ISD status code
 874 */
 875static int isd200_srst( struct us_data *us ) 
 876{
 877        int retStatus = ISD200_GOOD;
 878        int transferStatus;
 879
 880        US_DEBUGP("Entering isd200_SRST\n");
 881
 882        transferStatus = isd200_action( us, ACTION_RESET, NULL, 0 );
 883
 884        /* check to see if this request failed */
 885        if (transferStatus != ISD200_TRANSPORT_GOOD) {
 886                US_DEBUGP("   Error issuing SRST\n");
 887                retStatus = ISD200_ERROR;
 888        } else {
 889                /* delay 10ms to give the drive a chance to see it */
 890                msleep(10);
 891
 892                transferStatus = isd200_action( us, ACTION_REENABLE, NULL, 0 );
 893                if (transferStatus != ISD200_TRANSPORT_GOOD) {
 894                        US_DEBUGP("   Error taking drive out of reset\n");
 895                        retStatus = ISD200_ERROR;
 896                } else {
 897                        /* delay 50ms to give the drive a chance to recover after SRST */
 898                        msleep(50);
 899                }
 900        }
 901
 902        US_DEBUGP("Leaving isd200_srst %08X\n", retStatus);
 903        return retStatus;
 904}
 905
 906
 907/**************************************************************************
 908 * isd200_try_enum
 909 *                                                                       
 910 * Helper function for isd200_manual_enum(). Does ENUM and READ_STATUS
 911 * and tries to analyze the status registers
 912 *
 913 * RETURNS:
 914 *    ISD status code
 915 */
 916static int isd200_try_enum(struct us_data *us, unsigned char master_slave,
 917                           int detect )
 918{
 919        int status = ISD200_GOOD;
 920        unsigned long endTime;
 921        struct isd200_info *info = (struct isd200_info *)us->extra;
 922        unsigned char *regs = info->RegsBuf;
 923        int recheckAsMaster = 0;
 924
 925        if ( detect )
 926                endTime = jiffies + ISD200_ENUM_DETECT_TIMEOUT * HZ;
 927        else
 928                endTime = jiffies + ISD200_ENUM_BSY_TIMEOUT * HZ;
 929
 930        /* loop until we detect !BSY or timeout */
 931        while(1) {
 932#ifdef CONFIG_USB_STORAGE_DEBUG
 933                char* mstr = master_slave == ATA_ADDRESS_DEVHEAD_STD ?
 934                        "Master" : "Slave";
 935#endif
 936
 937                status = isd200_action( us, ACTION_ENUM, NULL, master_slave );
 938                if ( status != ISD200_GOOD )
 939                        break;
 940
 941                status = isd200_action( us, ACTION_READ_STATUS, 
 942                                        regs, 8 );
 943                if ( status != ISD200_GOOD )
 944                        break;
 945
 946                if (!detect) {
 947                        if (regs[ATA_REG_STATUS_OFFSET] & ATA_BUSY) {
 948                                US_DEBUGP("   %s status is still BSY, try again...\n",mstr);
 949                        } else {
 950                                US_DEBUGP("   %s status !BSY, continue with next operation\n",mstr);
 951                                break;
 952                        }
 953                }
 954                /* check for ATA_BUSY and */
 955                /* ATA_DF (workaround ATA Zip drive) and */
 956                /* ATA_ERR (workaround for Archos CD-ROM) */
 957                else if (regs[ATA_REG_STATUS_OFFSET] &
 958                         (ATA_BUSY | ATA_DF | ATA_ERR)) {
 959                        US_DEBUGP("   Status indicates it is not ready, try again...\n");
 960                }
 961                /* check for DRDY, ATA devices set DRDY after SRST */
 962                else if (regs[ATA_REG_STATUS_OFFSET] & ATA_DRDY) {
 963                        US_DEBUGP("   Identified ATA device\n");
 964                        info->DeviceFlags |= DF_ATA_DEVICE;
 965                        info->DeviceHead = master_slave;
 966                        break;
 967                } 
 968                /* check Cylinder High/Low to
 969                   determine if it is an ATAPI device
 970                */
 971                else if (regs[ATA_REG_HCYL_OFFSET] == 0xEB &&
 972                         regs[ATA_REG_LCYL_OFFSET] == 0x14) {
 973                        /* It seems that the RICOH 
 974                           MP6200A CD/RW drive will 
 975                           report itself okay as a
 976                           slave when it is really a
 977                           master. So this check again
 978                           as a master device just to
 979                           make sure it doesn't report
 980                           itself okay as a master also
 981                        */
 982                        if ((master_slave & ATA_ADDRESS_DEVHEAD_SLAVE) &&
 983                            !recheckAsMaster) {
 984                                US_DEBUGP("   Identified ATAPI device as slave.  Rechecking again as master\n");
 985                                recheckAsMaster = 1;
 986                                master_slave = ATA_ADDRESS_DEVHEAD_STD;
 987                        } else {
 988                                US_DEBUGP("   Identified ATAPI device\n");
 989                                info->DeviceHead = master_slave;
 990                              
 991                                status = isd200_atapi_soft_reset(us);
 992                                break;
 993                        }
 994                } else {
 995                        US_DEBUGP("   Not ATA, not ATAPI. Weird.\n");
 996                        break;
 997                }
 998
 999                /* check for timeout on this request */
1000                if (time_after_eq(jiffies, endTime)) {
1001                        if (!detect)
1002                                US_DEBUGP("   BSY check timeout, just continue with next operation...\n");
1003                        else
1004                                US_DEBUGP("   Device detect timeout!\n");
1005                        break;
1006                }
1007        }
1008
1009        return status;
1010}
1011
1012/**************************************************************************
1013 * isd200_manual_enum
1014 *                                                                       
1015 * Determines if the drive attached is an ATA or ATAPI and if it is a
1016 * master or slave.
1017 *
1018 * RETURNS:
1019 *    ISD status code
1020 */
1021static int isd200_manual_enum(struct us_data *us)
1022{
1023        struct isd200_info *info = (struct isd200_info *)us->extra;
1024        int retStatus = ISD200_GOOD;
1025
1026        US_DEBUGP("Entering isd200_manual_enum\n");
1027
1028        retStatus = isd200_read_config(us);
1029        if (retStatus == ISD200_GOOD) {
1030                int isslave;
1031                /* master or slave? */
1032                retStatus = isd200_try_enum( us, ATA_ADDRESS_DEVHEAD_STD, 0);
1033                if (retStatus == ISD200_GOOD)
1034                        retStatus = isd200_try_enum( us, ATA_ADDRESS_DEVHEAD_SLAVE, 0);
1035
1036                if (retStatus == ISD200_GOOD) {
1037                        retStatus = isd200_srst(us);
1038                        if (retStatus == ISD200_GOOD)
1039                                /* ata or atapi? */
1040                                retStatus = isd200_try_enum( us, ATA_ADDRESS_DEVHEAD_STD, 1);
1041                }
1042
1043                isslave = (info->DeviceHead & ATA_ADDRESS_DEVHEAD_SLAVE) ? 1 : 0;
1044                if (!(info->ConfigData.ATAConfig & ATACFG_MASTER)) {
1045                        US_DEBUGP("   Setting Master/Slave selection to %d\n", isslave);
1046                        info->ConfigData.ATAConfig &= 0x3f;
1047                        info->ConfigData.ATAConfig |= (isslave<<6);
1048                        retStatus = isd200_write_config(us);
1049                }
1050        }
1051
1052        US_DEBUGP("Leaving isd200_manual_enum %08X\n", retStatus);
1053        return(retStatus);
1054}
1055
1056static void isd200_fix_driveid(u16 *id)
1057{
1058#ifndef __LITTLE_ENDIAN
1059# ifdef __BIG_ENDIAN
1060        int i;
1061
1062        for (i = 0; i < ATA_ID_WORDS; i++)
1063                id[i] = __le16_to_cpu(id[i]);
1064# else
1065#  error "Please fix <asm/byteorder.h>"
1066# endif
1067#endif
1068}
1069
1070static void isd200_dump_driveid(u16 *id)
1071{
1072        US_DEBUGP("   Identify Data Structure:\n");
1073        US_DEBUGP("      config = 0x%x\n",        id[ATA_ID_CONFIG]);
1074        US_DEBUGP("      cyls = 0x%x\n",          id[ATA_ID_CYLS]);
1075        US_DEBUGP("      heads = 0x%x\n",         id[ATA_ID_HEADS]);
1076        US_DEBUGP("      track_bytes = 0x%x\n",   id[4]);
1077        US_DEBUGP("      sector_bytes = 0x%x\n",  id[5]);
1078        US_DEBUGP("      sectors = 0x%x\n",       id[ATA_ID_SECTORS]);
1079        US_DEBUGP("      serial_no[0] = 0x%x\n",  *(char *)&id[ATA_ID_SERNO]);
1080        US_DEBUGP("      buf_type = 0x%x\n",      id[20]);
1081        US_DEBUGP("      buf_size = 0x%x\n",      id[ATA_ID_BUF_SIZE]);
1082        US_DEBUGP("      ecc_bytes = 0x%x\n",     id[22]);
1083        US_DEBUGP("      fw_rev[0] = 0x%x\n",     *(char *)&id[ATA_ID_FW_REV]);
1084        US_DEBUGP("      model[0] = 0x%x\n",      *(char *)&id[ATA_ID_PROD]);
1085        US_DEBUGP("      max_multsect = 0x%x\n",  id[ATA_ID_MAX_MULTSECT] & 0xff);
1086        US_DEBUGP("      dword_io = 0x%x\n",      id[ATA_ID_DWORD_IO]);
1087        US_DEBUGP("      capability = 0x%x\n",    id[ATA_ID_CAPABILITY] >> 8);
1088        US_DEBUGP("      tPIO = 0x%x\n",          id[ATA_ID_OLD_PIO_MODES] >> 8);
1089        US_DEBUGP("      tDMA = 0x%x\n",          id[ATA_ID_OLD_DMA_MODES] >> 8);
1090        US_DEBUGP("      field_valid = 0x%x\n",   id[ATA_ID_FIELD_VALID]);
1091        US_DEBUGP("      cur_cyls = 0x%x\n",      id[ATA_ID_CUR_CYLS]);
1092        US_DEBUGP("      cur_heads = 0x%x\n",     id[ATA_ID_CUR_HEADS]);
1093        US_DEBUGP("      cur_sectors = 0x%x\n",   id[ATA_ID_CUR_SECTORS]);
1094        US_DEBUGP("      cur_capacity = 0x%x\n",  ata_id_u32(id, 57));
1095        US_DEBUGP("      multsect = 0x%x\n",      id[ATA_ID_MULTSECT] & 0xff);
1096        US_DEBUGP("      lba_capacity = 0x%x\n",  ata_id_u32(id, ATA_ID_LBA_CAPACITY));
1097        US_DEBUGP("      command_set_1 = 0x%x\n", id[ATA_ID_COMMAND_SET_1]);
1098        US_DEBUGP("      command_set_2 = 0x%x\n", id[ATA_ID_COMMAND_SET_2]);
1099}
1100
1101/**************************************************************************
1102 * isd200_get_inquiry_data
1103 *
1104 * Get inquiry data
1105 *
1106 * RETURNS:
1107 *    ISD status code
1108 */
1109static int isd200_get_inquiry_data( struct us_data *us )
1110{
1111        struct isd200_info *info = (struct isd200_info *)us->extra;
1112        int retStatus = ISD200_GOOD;
1113        u16 *id = info->id;
1114
1115        US_DEBUGP("Entering isd200_get_inquiry_data\n");
1116
1117        /* set default to Master */
1118        info->DeviceHead = ATA_ADDRESS_DEVHEAD_STD;
1119
1120        /* attempt to manually enumerate this device */
1121        retStatus = isd200_manual_enum(us);
1122        if (retStatus == ISD200_GOOD) {
1123                int transferStatus;
1124
1125                /* check for an ATA device */
1126                if (info->DeviceFlags & DF_ATA_DEVICE) {
1127                        /* this must be an ATA device */
1128                        /* perform an ATA Command Identify */
1129                        transferStatus = isd200_action( us, ACTION_IDENTIFY,
1130                                                        id, ATA_ID_WORDS * 2);
1131                        if (transferStatus != ISD200_TRANSPORT_GOOD) {
1132                                /* Error issuing ATA Command Identify */
1133                                US_DEBUGP("   Error issuing ATA Command Identify\n");
1134                                retStatus = ISD200_ERROR;
1135                        } else {
1136                                /* ATA Command Identify successful */
1137                                int i;
1138                                __be16 *src;
1139                                __u16 *dest;
1140
1141                                isd200_fix_driveid(id);
1142                                isd200_dump_driveid(id);
1143
1144                                memset(&info->InquiryData, 0, sizeof(info->InquiryData));
1145
1146                                /* Standard IDE interface only supports disks */
1147                                info->InquiryData.DeviceType = DIRECT_ACCESS_DEVICE;
1148
1149                                /* The length must be at least 36 (5 + 31) */
1150                                info->InquiryData.AdditionalLength = 0x1F;
1151
1152                                if (id[ATA_ID_COMMAND_SET_1] & COMMANDSET_MEDIA_STATUS) {
1153                                        /* set the removable bit */
1154                                        info->InquiryData.DeviceTypeModifier = DEVICE_REMOVABLE;
1155                                        info->DeviceFlags |= DF_REMOVABLE_MEDIA;
1156                                }
1157
1158                                /* Fill in vendor identification fields */
1159                                src = (__be16 *)&id[ATA_ID_PROD];
1160                                dest = (__u16*)info->InquiryData.VendorId;
1161                                for (i=0;i<4;i++)
1162                                        dest[i] = be16_to_cpu(src[i]);
1163
1164                                src = (__be16 *)&id[ATA_ID_PROD + 8/2];
1165                                dest = (__u16*)info->InquiryData.ProductId;
1166                                for (i=0;i<8;i++)
1167                                        dest[i] = be16_to_cpu(src[i]);
1168
1169                                src = (__be16 *)&id[ATA_ID_FW_REV];
1170                                dest = (__u16*)info->InquiryData.ProductRevisionLevel;
1171                                for (i=0;i<2;i++)
1172                                        dest[i] = be16_to_cpu(src[i]);
1173
1174                                /* determine if it supports Media Status Notification */
1175                                if (id[ATA_ID_COMMAND_SET_2] & COMMANDSET_MEDIA_STATUS) {
1176                                        US_DEBUGP("   Device supports Media Status Notification\n");
1177
1178                                        /* Indicate that it is enabled, even though it is not
1179                                         * This allows the lock/unlock of the media to work
1180                                         * correctly.
1181                                         */
1182                                        info->DeviceFlags |= DF_MEDIA_STATUS_ENABLED;
1183                                }
1184                                else
1185                                        info->DeviceFlags &= ~DF_MEDIA_STATUS_ENABLED;
1186
1187                        }
1188                } else {
1189                        /* 
1190                         * this must be an ATAPI device 
1191                         * use an ATAPI protocol (Transparent SCSI)
1192                         */
1193                        us->protocol_name = "Transparent SCSI";
1194                        us->proto_handler = usb_stor_transparent_scsi_command;
1195
1196                        US_DEBUGP("Protocol changed to: %s\n", us->protocol_name);
1197            
1198                        /* Free driver structure */         
1199                        us->extra_destructor(info);
1200                        kfree(info);
1201                        us->extra = NULL;
1202                        us->extra_destructor = NULL;
1203                }
1204        }
1205
1206        US_DEBUGP("Leaving isd200_get_inquiry_data %08X\n", retStatus);
1207
1208        return(retStatus);
1209}
1210
1211/**************************************************************************
1212 * isd200_scsi_to_ata
1213 *                                                                       
1214 * Translate SCSI commands to ATA commands.
1215 *
1216 * RETURNS:
1217 *    1 if the command needs to be sent to the transport layer
1218 *    0 otherwise
1219 */
1220static int isd200_scsi_to_ata(struct scsi_cmnd *srb, struct us_data *us,
1221                              union ata_cdb * ataCdb)
1222{
1223        struct isd200_info *info = (struct isd200_info *)us->extra;
1224        u16 *id = info->id;
1225        int sendToTransport = 1;
1226        unsigned char sectnum, head;
1227        unsigned short cylinder;
1228        unsigned long lba;
1229        unsigned long blockCount;
1230        unsigned char senseData[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
1231
1232        memset(ataCdb, 0, sizeof(union ata_cdb));
1233
1234        /* SCSI Command */
1235        switch (srb->cmnd[0]) {
1236        case INQUIRY:
1237                US_DEBUGP("   ATA OUT - INQUIRY\n");
1238
1239                /* copy InquiryData */
1240                usb_stor_set_xfer_buf((unsigned char *) &info->InquiryData,
1241                                sizeof(info->InquiryData), srb);
1242                srb->result = SAM_STAT_GOOD;
1243                sendToTransport = 0;
1244                break;
1245
1246        case MODE_SENSE:
1247                US_DEBUGP("   ATA OUT - SCSIOP_MODE_SENSE\n");
1248
1249                /* Initialize the return buffer */
1250                usb_stor_set_xfer_buf(senseData, sizeof(senseData), srb);
1251
1252                if (info->DeviceFlags & DF_MEDIA_STATUS_ENABLED)
1253                {
1254                        ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1255                        ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1256                        ataCdb->generic.TransferBlockSize = 1;
1257                        ataCdb->generic.RegisterSelect = REG_COMMAND;
1258                        ataCdb->write.CommandByte = ATA_COMMAND_GET_MEDIA_STATUS;
1259                        isd200_srb_set_bufflen(srb, 0);
1260                } else {
1261                        US_DEBUGP("   Media Status not supported, just report okay\n");
1262                        srb->result = SAM_STAT_GOOD;
1263                        sendToTransport = 0;
1264                }
1265                break;
1266
1267        case TEST_UNIT_READY:
1268                US_DEBUGP("   ATA OUT - SCSIOP_TEST_UNIT_READY\n");
1269
1270                if (info->DeviceFlags & DF_MEDIA_STATUS_ENABLED)
1271                {
1272                        ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1273                        ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1274                        ataCdb->generic.TransferBlockSize = 1;
1275                        ataCdb->generic.RegisterSelect = REG_COMMAND;
1276                        ataCdb->write.CommandByte = ATA_COMMAND_GET_MEDIA_STATUS;
1277                        isd200_srb_set_bufflen(srb, 0);
1278                } else {
1279                        US_DEBUGP("   Media Status not supported, just report okay\n");
1280                        srb->result = SAM_STAT_GOOD;
1281                        sendToTransport = 0;
1282                }
1283                break;
1284
1285        case READ_CAPACITY:
1286        {
1287                unsigned long capacity;
1288                struct read_capacity_data readCapacityData;
1289
1290                US_DEBUGP("   ATA OUT - SCSIOP_READ_CAPACITY\n");
1291
1292                if (ata_id_has_lba(id))
1293                        capacity = ata_id_u32(id, ATA_ID_LBA_CAPACITY) - 1;
1294                else
1295                        capacity = (id[ATA_ID_HEADS] * id[ATA_ID_CYLS] *
1296                                    id[ATA_ID_SECTORS]) - 1;
1297
1298                readCapacityData.LogicalBlockAddress = cpu_to_be32(capacity);
1299                readCapacityData.BytesPerBlock = cpu_to_be32(0x200);
1300
1301                usb_stor_set_xfer_buf((unsigned char *) &readCapacityData,
1302                                sizeof(readCapacityData), srb);
1303                srb->result = SAM_STAT_GOOD;
1304                sendToTransport = 0;
1305        }
1306        break;
1307
1308        case READ_10:
1309                US_DEBUGP("   ATA OUT - SCSIOP_READ\n");
1310
1311                lba = be32_to_cpu(*(__be32 *)&srb->cmnd[2]);
1312                blockCount = (unsigned long)srb->cmnd[7]<<8 | (unsigned long)srb->cmnd[8];
1313
1314                if (ata_id_has_lba(id)) {
1315                        sectnum = (unsigned char)(lba);
1316                        cylinder = (unsigned short)(lba>>8);
1317                        head = ATA_ADDRESS_DEVHEAD_LBA_MODE | (unsigned char)(lba>>24 & 0x0F);
1318                } else {
1319                        sectnum = (u8)((lba % id[ATA_ID_SECTORS]) + 1);
1320                        cylinder = (u16)(lba / (id[ATA_ID_SECTORS] *
1321                                        id[ATA_ID_HEADS]));
1322                        head = (u8)((lba / id[ATA_ID_SECTORS]) %
1323                                        id[ATA_ID_HEADS]);
1324                }
1325                ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1326                ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1327                ataCdb->generic.TransferBlockSize = 1;
1328                ataCdb->generic.RegisterSelect =
1329                  REG_SECTOR_COUNT | REG_SECTOR_NUMBER |
1330                  REG_CYLINDER_LOW | REG_CYLINDER_HIGH |
1331                  REG_DEVICE_HEAD  | REG_COMMAND;
1332                ataCdb->write.SectorCountByte = (unsigned char)blockCount;
1333                ataCdb->write.SectorNumberByte = sectnum;
1334                ataCdb->write.CylinderHighByte = (unsigned char)(cylinder>>8);
1335                ataCdb->write.CylinderLowByte = (unsigned char)cylinder;
1336                ataCdb->write.DeviceHeadByte = (head | ATA_ADDRESS_DEVHEAD_STD);
1337                ataCdb->write.CommandByte = ATA_CMD_PIO_READ;
1338                break;
1339
1340        case WRITE_10:
1341                US_DEBUGP("   ATA OUT - SCSIOP_WRITE\n");
1342
1343                lba = be32_to_cpu(*(__be32 *)&srb->cmnd[2]);
1344                blockCount = (unsigned long)srb->cmnd[7]<<8 | (unsigned long)srb->cmnd[8];
1345
1346                if (ata_id_has_lba(id)) {
1347                        sectnum = (unsigned char)(lba);
1348                        cylinder = (unsigned short)(lba>>8);
1349                        head = ATA_ADDRESS_DEVHEAD_LBA_MODE | (unsigned char)(lba>>24 & 0x0F);
1350                } else {
1351                        sectnum = (u8)((lba % id[ATA_ID_SECTORS]) + 1);
1352                        cylinder = (u16)(lba / (id[ATA_ID_SECTORS] *
1353                                        id[ATA_ID_HEADS]));
1354                        head = (u8)((lba / id[ATA_ID_SECTORS]) %
1355                                        id[ATA_ID_HEADS]);
1356                }
1357                ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1358                ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1359                ataCdb->generic.TransferBlockSize = 1;
1360                ataCdb->generic.RegisterSelect =
1361                  REG_SECTOR_COUNT | REG_SECTOR_NUMBER |
1362                  REG_CYLINDER_LOW | REG_CYLINDER_HIGH |
1363                  REG_DEVICE_HEAD  | REG_COMMAND;
1364                ataCdb->write.SectorCountByte = (unsigned char)blockCount;
1365                ataCdb->write.SectorNumberByte = sectnum;
1366                ataCdb->write.CylinderHighByte = (unsigned char)(cylinder>>8);
1367                ataCdb->write.CylinderLowByte = (unsigned char)cylinder;
1368                ataCdb->write.DeviceHeadByte = (head | ATA_ADDRESS_DEVHEAD_STD);
1369                ataCdb->write.CommandByte = ATA_CMD_PIO_WRITE;
1370                break;
1371
1372        case ALLOW_MEDIUM_REMOVAL:
1373                US_DEBUGP("   ATA OUT - SCSIOP_MEDIUM_REMOVAL\n");
1374
1375                if (info->DeviceFlags & DF_REMOVABLE_MEDIA) {
1376                        US_DEBUGP("   srb->cmnd[4] = 0x%X\n", srb->cmnd[4]);
1377            
1378                        ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1379                        ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1380                        ataCdb->generic.TransferBlockSize = 1;
1381                        ataCdb->generic.RegisterSelect = REG_COMMAND;
1382                        ataCdb->write.CommandByte = (srb->cmnd[4] & 0x1) ?
1383                                ATA_CMD_MEDIA_LOCK : ATA_CMD_MEDIA_UNLOCK;
1384                        isd200_srb_set_bufflen(srb, 0);
1385                } else {
1386                        US_DEBUGP("   Not removeable media, just report okay\n");
1387                        srb->result = SAM_STAT_GOOD;
1388                        sendToTransport = 0;
1389                }
1390                break;
1391
1392        case START_STOP:    
1393                US_DEBUGP("   ATA OUT - SCSIOP_START_STOP_UNIT\n");
1394                US_DEBUGP("   srb->cmnd[4] = 0x%X\n", srb->cmnd[4]);
1395
1396                if ((srb->cmnd[4] & 0x3) == 0x2) {
1397                        US_DEBUGP("   Media Eject\n");
1398                        ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1399                        ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1400                        ataCdb->generic.TransferBlockSize = 0;
1401                        ataCdb->generic.RegisterSelect = REG_COMMAND;
1402                        ataCdb->write.CommandByte = ATA_COMMAND_MEDIA_EJECT;
1403                } else if ((srb->cmnd[4] & 0x3) == 0x1) {
1404                        US_DEBUGP("   Get Media Status\n");
1405                        ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
1406                        ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
1407                        ataCdb->generic.TransferBlockSize = 1;
1408                        ataCdb->generic.RegisterSelect = REG_COMMAND;
1409                        ataCdb->write.CommandByte = ATA_COMMAND_GET_MEDIA_STATUS;
1410                        isd200_srb_set_bufflen(srb, 0);
1411                } else {
1412                        US_DEBUGP("   Nothing to do, just report okay\n");
1413                        srb->result = SAM_STAT_GOOD;
1414                        sendToTransport = 0;
1415                }
1416                break;
1417
1418        default:
1419                US_DEBUGP("Unsupported SCSI command - 0x%X\n", srb->cmnd[0]);
1420                srb->result = DID_ERROR << 16;
1421                sendToTransport = 0;
1422                break;
1423        }
1424
1425        return(sendToTransport);
1426}
1427
1428
1429/**************************************************************************
1430 * isd200_free_info
1431 *
1432 * Frees the driver structure.
1433 */
1434static void isd200_free_info_ptrs(void *info_)
1435{
1436        struct isd200_info *info = (struct isd200_info *) info_;
1437
1438        if (info) {
1439                kfree(info->id);
1440                kfree(info->RegsBuf);
1441                kfree(info->srb.sense_buffer);
1442        }
1443}
1444
1445/**************************************************************************
1446 * isd200_init_info
1447 *                                                                       
1448 * Allocates (if necessary) and initializes the driver structure.
1449 *
1450 * RETURNS:
1451 *    ISD status code
1452 */
1453static int isd200_init_info(struct us_data *us)
1454{
1455        int retStatus = ISD200_GOOD;
1456        struct isd200_info *info;
1457
1458        info = kzalloc(sizeof(struct isd200_info), GFP_KERNEL);
1459        if (!info)
1460                retStatus = ISD200_ERROR;
1461        else {
1462                info->id = kzalloc(ATA_ID_WORDS * 2, GFP_KERNEL);
1463                info->RegsBuf = (unsigned char *)
1464                                kmalloc(sizeof(info->ATARegs), GFP_KERNEL);
1465                info->srb.sense_buffer =
1466                                kmalloc(SCSI_SENSE_BUFFERSIZE, GFP_KERNEL);
1467                if (!info->id || !info->RegsBuf || !info->srb.sense_buffer) {
1468                        isd200_free_info_ptrs(info);
1469                        kfree(info);
1470                        retStatus = ISD200_ERROR;
1471                }
1472        }
1473
1474        if (retStatus == ISD200_GOOD) {
1475                us->extra = info;
1476                us->extra_destructor = isd200_free_info_ptrs;
1477        } else
1478                US_DEBUGP("ERROR - kmalloc failure\n");
1479
1480        return retStatus;
1481}
1482
1483/**************************************************************************
1484 * Initialization for the ISD200 
1485 */
1486
1487static int isd200_Initialization(struct us_data *us)
1488{
1489        US_DEBUGP("ISD200 Initialization...\n");
1490
1491        /* Initialize ISD200 info struct */
1492
1493        if (isd200_init_info(us) == ISD200_ERROR) {
1494                US_DEBUGP("ERROR Initializing ISD200 Info struct\n");
1495        } else {
1496                /* Get device specific data */
1497
1498                if (isd200_get_inquiry_data(us) != ISD200_GOOD)
1499                        US_DEBUGP("ISD200 Initialization Failure\n");
1500                else
1501                        US_DEBUGP("ISD200 Initialization complete\n");
1502        }
1503
1504        return 0;
1505}
1506
1507
1508/**************************************************************************
1509 * Protocol and Transport for the ISD200 ASIC
1510 *
1511 * This protocol and transport are for ATA devices connected to an ISD200
1512 * ASIC.  An ATAPI device that is connected as a slave device will be
1513 * detected in the driver initialization function and the protocol will
1514 * be changed to an ATAPI protocol (Transparent SCSI).
1515 *
1516 */
1517
1518static void isd200_ata_command(struct scsi_cmnd *srb, struct us_data *us)
1519{
1520        int sendToTransport = 1, orig_bufflen;
1521        union ata_cdb ataCdb;
1522
1523        /* Make sure driver was initialized */
1524
1525        if (us->extra == NULL)
1526                US_DEBUGP("ERROR Driver not initialized\n");
1527
1528        scsi_set_resid(srb, 0);
1529        /* scsi_bufflen might change in protocol translation to ata */
1530        orig_bufflen = scsi_bufflen(srb);
1531        sendToTransport = isd200_scsi_to_ata(srb, us, &ataCdb);
1532
1533        /* send the command to the transport layer */
1534        if (sendToTransport)
1535                isd200_invoke_transport(us, srb, &ataCdb);
1536
1537        isd200_srb_set_bufflen(srb, orig_bufflen);
1538}
1539
1540static int isd200_probe(struct usb_interface *intf,
1541                         const struct usb_device_id *id)
1542{
1543        struct us_data *us;
1544        int result;
1545
1546        result = usb_stor_probe1(&us, intf, id,
1547                        (id - isd200_usb_ids) + isd200_unusual_dev_list);
1548        if (result)
1549                return result;
1550
1551        us->protocol_name = "ISD200 ATA/ATAPI";
1552        us->proto_handler = isd200_ata_command;
1553
1554        result = usb_stor_probe2(us);
1555        return result;
1556}
1557
1558static struct usb_driver isd200_driver = {
1559        .name =         "ums-isd200",
1560        .probe =        isd200_probe,
1561        .disconnect =   usb_stor_disconnect,
1562        .suspend =      usb_stor_suspend,
1563        .resume =       usb_stor_resume,
1564        .reset_resume = usb_stor_reset_resume,
1565        .pre_reset =    usb_stor_pre_reset,
1566        .post_reset =   usb_stor_post_reset,
1567        .id_table =     isd200_usb_ids,
1568        .soft_unbind =  1,
1569};
1570
1571module_usb_driver(isd200_driver);
1572