Linux Audio

Check our new training course

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