cachepc-linux

Fork of AMDESE/linux with modifications for CachePC side-channel attack
git clone https://git.sinitax.com/sinitax/cachepc-linux
Log | Files | Refs | README | LICENSE | sfeed.txt

isd200.c (45767B)


      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 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 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 = ISD200_GOOD;
   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				memset(&info->InquiryData, 0, sizeof(info->InquiryData));
   1141
   1142				/* Standard IDE interface only supports disks */
   1143				info->InquiryData.DeviceType = DIRECT_ACCESS_DEVICE;
   1144
   1145				/* The length must be at least 36 (5 + 31) */
   1146				info->InquiryData.AdditionalLength = 0x1F;
   1147
   1148				if (id[ATA_ID_COMMAND_SET_1] & COMMANDSET_MEDIA_STATUS) {
   1149					/* set the removable bit */
   1150					info->InquiryData.DeviceTypeModifier = DEVICE_REMOVABLE;
   1151					info->DeviceFlags |= DF_REMOVABLE_MEDIA;
   1152				}
   1153
   1154				/* Fill in vendor identification fields */
   1155				src = (__be16 *)&id[ATA_ID_PROD];
   1156				dest = (__u16*)info->InquiryData.VendorId;
   1157				for (i = 0; i < 4; i++)
   1158					dest[i] = be16_to_cpu(src[i]);
   1159
   1160				src = (__be16 *)&id[ATA_ID_PROD + 8/2];
   1161				dest = (__u16*)info->InquiryData.ProductId;
   1162				for (i=0;i<8;i++)
   1163					dest[i] = be16_to_cpu(src[i]);
   1164
   1165				src = (__be16 *)&id[ATA_ID_FW_REV];
   1166				dest = (__u16*)info->InquiryData.ProductRevisionLevel;
   1167				for (i=0;i<2;i++)
   1168					dest[i] = be16_to_cpu(src[i]);
   1169
   1170				/* determine if it supports Media Status Notification */
   1171				if (id[ATA_ID_COMMAND_SET_2] & COMMANDSET_MEDIA_STATUS) {
   1172					usb_stor_dbg(us, "   Device supports Media Status Notification\n");
   1173
   1174					/*
   1175					 * Indicate that it is enabled, even
   1176					 * though it is not.
   1177					 * This allows the lock/unlock of the
   1178					 * media to work correctly.
   1179					 */
   1180					info->DeviceFlags |= DF_MEDIA_STATUS_ENABLED;
   1181				}
   1182				else
   1183					info->DeviceFlags &= ~DF_MEDIA_STATUS_ENABLED;
   1184
   1185			}
   1186		} else {
   1187			/* 
   1188			 * this must be an ATAPI device 
   1189			 * use an ATAPI protocol (Transparent SCSI)
   1190			 */
   1191			us->protocol_name = "Transparent SCSI";
   1192			us->proto_handler = usb_stor_transparent_scsi_command;
   1193
   1194			usb_stor_dbg(us, "Protocol changed to: %s\n",
   1195				     us->protocol_name);
   1196	    
   1197			/* Free driver structure */
   1198			us->extra_destructor(info);
   1199			kfree(info);
   1200			us->extra = NULL;
   1201			us->extra_destructor = NULL;
   1202		}
   1203	}
   1204
   1205	usb_stor_dbg(us, "Leaving isd200_get_inquiry_data %08X\n", retStatus);
   1206
   1207	return(retStatus);
   1208}
   1209
   1210/**************************************************************************
   1211 * isd200_scsi_to_ata
   1212 *									 
   1213 * Translate SCSI commands to ATA commands.
   1214 *
   1215 * RETURNS:
   1216 *    1 if the command needs to be sent to the transport layer
   1217 *    0 otherwise
   1218 */
   1219static int isd200_scsi_to_ata(struct scsi_cmnd *srb, struct us_data *us,
   1220			      union ata_cdb * ataCdb)
   1221{
   1222	struct isd200_info *info = (struct isd200_info *)us->extra;
   1223	u16 *id = info->id;
   1224	int sendToTransport = 1;
   1225	unsigned char sectnum, head;
   1226	unsigned short cylinder;
   1227	unsigned long lba;
   1228	unsigned long blockCount;
   1229	unsigned char senseData[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
   1230
   1231	memset(ataCdb, 0, sizeof(union ata_cdb));
   1232
   1233	/* SCSI Command */
   1234	switch (srb->cmnd[0]) {
   1235	case INQUIRY:
   1236		usb_stor_dbg(us, "   ATA OUT - INQUIRY\n");
   1237
   1238		/* copy InquiryData */
   1239		usb_stor_set_xfer_buf((unsigned char *) &info->InquiryData,
   1240				sizeof(info->InquiryData), srb);
   1241		srb->result = SAM_STAT_GOOD;
   1242		sendToTransport = 0;
   1243		break;
   1244
   1245	case MODE_SENSE:
   1246		usb_stor_dbg(us, "   ATA OUT - SCSIOP_MODE_SENSE\n");
   1247
   1248		/* Initialize the return buffer */
   1249		usb_stor_set_xfer_buf(senseData, sizeof(senseData), srb);
   1250
   1251		if (info->DeviceFlags & DF_MEDIA_STATUS_ENABLED)
   1252		{
   1253			ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
   1254			ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
   1255			ataCdb->generic.TransferBlockSize = 1;
   1256			ataCdb->generic.RegisterSelect = REG_COMMAND;
   1257			ataCdb->write.CommandByte = ATA_COMMAND_GET_MEDIA_STATUS;
   1258			isd200_srb_set_bufflen(srb, 0);
   1259		} else {
   1260			usb_stor_dbg(us, "   Media Status not supported, just report okay\n");
   1261			srb->result = SAM_STAT_GOOD;
   1262			sendToTransport = 0;
   1263		}
   1264		break;
   1265
   1266	case TEST_UNIT_READY:
   1267		usb_stor_dbg(us, "   ATA OUT - SCSIOP_TEST_UNIT_READY\n");
   1268
   1269		if (info->DeviceFlags & DF_MEDIA_STATUS_ENABLED)
   1270		{
   1271			ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
   1272			ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
   1273			ataCdb->generic.TransferBlockSize = 1;
   1274			ataCdb->generic.RegisterSelect = REG_COMMAND;
   1275			ataCdb->write.CommandByte = ATA_COMMAND_GET_MEDIA_STATUS;
   1276			isd200_srb_set_bufflen(srb, 0);
   1277		} else {
   1278			usb_stor_dbg(us, "   Media Status not supported, just report okay\n");
   1279			srb->result = SAM_STAT_GOOD;
   1280			sendToTransport = 0;
   1281		}
   1282		break;
   1283
   1284	case READ_CAPACITY:
   1285	{
   1286		unsigned long capacity;
   1287		struct read_capacity_data readCapacityData;
   1288
   1289		usb_stor_dbg(us, "   ATA OUT - SCSIOP_READ_CAPACITY\n");
   1290
   1291		if (ata_id_has_lba(id))
   1292			capacity = ata_id_u32(id, ATA_ID_LBA_CAPACITY) - 1;
   1293		else
   1294			capacity = (id[ATA_ID_HEADS] * id[ATA_ID_CYLS] *
   1295				    id[ATA_ID_SECTORS]) - 1;
   1296
   1297		readCapacityData.LogicalBlockAddress = cpu_to_be32(capacity);
   1298		readCapacityData.BytesPerBlock = cpu_to_be32(0x200);
   1299
   1300		usb_stor_set_xfer_buf((unsigned char *) &readCapacityData,
   1301				sizeof(readCapacityData), srb);
   1302		srb->result = SAM_STAT_GOOD;
   1303		sendToTransport = 0;
   1304	}
   1305	break;
   1306
   1307	case READ_10:
   1308		usb_stor_dbg(us, "   ATA OUT - SCSIOP_READ\n");
   1309
   1310		lba = be32_to_cpu(*(__be32 *)&srb->cmnd[2]);
   1311		blockCount = (unsigned long)srb->cmnd[7]<<8 | (unsigned long)srb->cmnd[8];
   1312
   1313		if (ata_id_has_lba(id)) {
   1314			sectnum = (unsigned char)(lba);
   1315			cylinder = (unsigned short)(lba>>8);
   1316			head = ATA_ADDRESS_DEVHEAD_LBA_MODE | (unsigned char)(lba>>24 & 0x0F);
   1317		} else {
   1318			sectnum = (u8)((lba % id[ATA_ID_SECTORS]) + 1);
   1319			cylinder = (u16)(lba / (id[ATA_ID_SECTORS] *
   1320					id[ATA_ID_HEADS]));
   1321			head = (u8)((lba / id[ATA_ID_SECTORS]) %
   1322					id[ATA_ID_HEADS]);
   1323		}
   1324		ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
   1325		ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
   1326		ataCdb->generic.TransferBlockSize = 1;
   1327		ataCdb->generic.RegisterSelect =
   1328		  REG_SECTOR_COUNT | REG_SECTOR_NUMBER |
   1329		  REG_CYLINDER_LOW | REG_CYLINDER_HIGH |
   1330		  REG_DEVICE_HEAD  | REG_COMMAND;
   1331		ataCdb->write.SectorCountByte = (unsigned char)blockCount;
   1332		ataCdb->write.SectorNumberByte = sectnum;
   1333		ataCdb->write.CylinderHighByte = (unsigned char)(cylinder>>8);
   1334		ataCdb->write.CylinderLowByte = (unsigned char)cylinder;
   1335		ataCdb->write.DeviceHeadByte = (head | ATA_ADDRESS_DEVHEAD_STD);
   1336		ataCdb->write.CommandByte = ATA_CMD_PIO_READ;
   1337		break;
   1338
   1339	case WRITE_10:
   1340		usb_stor_dbg(us, "   ATA OUT - SCSIOP_WRITE\n");
   1341
   1342		lba = be32_to_cpu(*(__be32 *)&srb->cmnd[2]);
   1343		blockCount = (unsigned long)srb->cmnd[7]<<8 | (unsigned long)srb->cmnd[8];
   1344
   1345		if (ata_id_has_lba(id)) {
   1346			sectnum = (unsigned char)(lba);
   1347			cylinder = (unsigned short)(lba>>8);
   1348			head = ATA_ADDRESS_DEVHEAD_LBA_MODE | (unsigned char)(lba>>24 & 0x0F);
   1349		} else {
   1350			sectnum = (u8)((lba % id[ATA_ID_SECTORS]) + 1);
   1351			cylinder = (u16)(lba / (id[ATA_ID_SECTORS] *
   1352					id[ATA_ID_HEADS]));
   1353			head = (u8)((lba / id[ATA_ID_SECTORS]) %
   1354					id[ATA_ID_HEADS]);
   1355		}
   1356		ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
   1357		ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
   1358		ataCdb->generic.TransferBlockSize = 1;
   1359		ataCdb->generic.RegisterSelect =
   1360		  REG_SECTOR_COUNT | REG_SECTOR_NUMBER |
   1361		  REG_CYLINDER_LOW | REG_CYLINDER_HIGH |
   1362		  REG_DEVICE_HEAD  | REG_COMMAND;
   1363		ataCdb->write.SectorCountByte = (unsigned char)blockCount;
   1364		ataCdb->write.SectorNumberByte = sectnum;
   1365		ataCdb->write.CylinderHighByte = (unsigned char)(cylinder>>8);
   1366		ataCdb->write.CylinderLowByte = (unsigned char)cylinder;
   1367		ataCdb->write.DeviceHeadByte = (head | ATA_ADDRESS_DEVHEAD_STD);
   1368		ataCdb->write.CommandByte = ATA_CMD_PIO_WRITE;
   1369		break;
   1370
   1371	case ALLOW_MEDIUM_REMOVAL:
   1372		usb_stor_dbg(us, "   ATA OUT - SCSIOP_MEDIUM_REMOVAL\n");
   1373
   1374		if (info->DeviceFlags & DF_REMOVABLE_MEDIA) {
   1375			usb_stor_dbg(us, "   srb->cmnd[4] = 0x%X\n",
   1376				     srb->cmnd[4]);
   1377	    
   1378			ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
   1379			ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
   1380			ataCdb->generic.TransferBlockSize = 1;
   1381			ataCdb->generic.RegisterSelect = REG_COMMAND;
   1382			ataCdb->write.CommandByte = (srb->cmnd[4] & 0x1) ?
   1383				ATA_CMD_MEDIA_LOCK : ATA_CMD_MEDIA_UNLOCK;
   1384			isd200_srb_set_bufflen(srb, 0);
   1385		} else {
   1386			usb_stor_dbg(us, "   Not removable media, just report okay\n");
   1387			srb->result = SAM_STAT_GOOD;
   1388			sendToTransport = 0;
   1389		}
   1390		break;
   1391
   1392	case START_STOP:    
   1393		usb_stor_dbg(us, "   ATA OUT - SCSIOP_START_STOP_UNIT\n");
   1394		usb_stor_dbg(us, "   srb->cmnd[4] = 0x%X\n", srb->cmnd[4]);
   1395
   1396		if ((srb->cmnd[4] & 0x3) == 0x2) {
   1397			usb_stor_dbg(us, "   Media Eject\n");
   1398			ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
   1399			ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
   1400			ataCdb->generic.TransferBlockSize = 0;
   1401			ataCdb->generic.RegisterSelect = REG_COMMAND;
   1402			ataCdb->write.CommandByte = ATA_COMMAND_MEDIA_EJECT;
   1403		} else if ((srb->cmnd[4] & 0x3) == 0x1) {
   1404			usb_stor_dbg(us, "   Get Media Status\n");
   1405			ataCdb->generic.SignatureByte0 = info->ConfigData.ATAMajorCommand;
   1406			ataCdb->generic.SignatureByte1 = info->ConfigData.ATAMinorCommand;
   1407			ataCdb->generic.TransferBlockSize = 1;
   1408			ataCdb->generic.RegisterSelect = REG_COMMAND;
   1409			ataCdb->write.CommandByte = ATA_COMMAND_GET_MEDIA_STATUS;
   1410			isd200_srb_set_bufflen(srb, 0);
   1411		} else {
   1412			usb_stor_dbg(us, "   Nothing to do, just report okay\n");
   1413			srb->result = SAM_STAT_GOOD;
   1414			sendToTransport = 0;
   1415		}
   1416		break;
   1417
   1418	default:
   1419		usb_stor_dbg(us, "Unsupported SCSI command - 0x%X\n",
   1420			     srb->cmnd[0]);
   1421		srb->result = DID_ERROR << 16;
   1422		sendToTransport = 0;
   1423		break;
   1424	}
   1425
   1426	return(sendToTransport);
   1427}
   1428
   1429
   1430/**************************************************************************
   1431 * isd200_free_info
   1432 *
   1433 * Frees the driver structure.
   1434 */
   1435static void isd200_free_info_ptrs(void *info_)
   1436{
   1437	struct isd200_info *info = (struct isd200_info *) info_;
   1438
   1439	if (info) {
   1440		kfree(info->id);
   1441		kfree(info->RegsBuf);
   1442		kfree(info->srb.sense_buffer);
   1443	}
   1444}
   1445
   1446/**************************************************************************
   1447 * isd200_init_info
   1448 *									 
   1449 * Allocates (if necessary) and initializes the driver structure.
   1450 *
   1451 * RETURNS:
   1452 *    error status code
   1453 */
   1454static int isd200_init_info(struct us_data *us)
   1455{
   1456	struct isd200_info *info;
   1457
   1458	info = kzalloc(sizeof(struct isd200_info), GFP_KERNEL);
   1459	if (!info)
   1460		return -ENOMEM;
   1461
   1462	info->id = kzalloc(ATA_ID_WORDS * 2, GFP_KERNEL);
   1463	info->RegsBuf = kmalloc(sizeof(info->ATARegs), GFP_KERNEL);
   1464	info->srb.sense_buffer = kmalloc(SCSI_SENSE_BUFFERSIZE, GFP_KERNEL);
   1465
   1466	if (!info->id || !info->RegsBuf || !info->srb.sense_buffer) {
   1467		isd200_free_info_ptrs(info);
   1468		kfree(info);
   1469		return -ENOMEM;
   1470	}
   1471
   1472	us->extra = info;
   1473	us->extra_destructor = isd200_free_info_ptrs;
   1474
   1475	return 0;
   1476}
   1477
   1478/**************************************************************************
   1479 * Initialization for the ISD200 
   1480 */
   1481
   1482static int isd200_Initialization(struct us_data *us)
   1483{
   1484	usb_stor_dbg(us, "ISD200 Initialization...\n");
   1485
   1486	/* Initialize ISD200 info struct */
   1487
   1488	if (isd200_init_info(us) == ISD200_ERROR) {
   1489		usb_stor_dbg(us, "ERROR Initializing ISD200 Info struct\n");
   1490	} else {
   1491		/* Get device specific data */
   1492
   1493		if (isd200_get_inquiry_data(us) != ISD200_GOOD)
   1494			usb_stor_dbg(us, "ISD200 Initialization Failure\n");
   1495		else
   1496			usb_stor_dbg(us, "ISD200 Initialization complete\n");
   1497	}
   1498
   1499	return 0;
   1500}
   1501
   1502
   1503/**************************************************************************
   1504 * Protocol and Transport for the ISD200 ASIC
   1505 *
   1506 * This protocol and transport are for ATA devices connected to an ISD200
   1507 * ASIC.  An ATAPI device that is connected as a slave device will be
   1508 * detected in the driver initialization function and the protocol will
   1509 * be changed to an ATAPI protocol (Transparent SCSI).
   1510 *
   1511 */
   1512
   1513static void isd200_ata_command(struct scsi_cmnd *srb, struct us_data *us)
   1514{
   1515	int sendToTransport, orig_bufflen;
   1516	union ata_cdb ataCdb;
   1517
   1518	/* Make sure driver was initialized */
   1519
   1520	if (us->extra == NULL) {
   1521		usb_stor_dbg(us, "ERROR Driver not initialized\n");
   1522		srb->result = DID_ERROR << 16;
   1523		return;
   1524	}
   1525
   1526	scsi_set_resid(srb, 0);
   1527	/* scsi_bufflen might change in protocol translation to ata */
   1528	orig_bufflen = scsi_bufflen(srb);
   1529	sendToTransport = isd200_scsi_to_ata(srb, us, &ataCdb);
   1530
   1531	/* send the command to the transport layer */
   1532	if (sendToTransport)
   1533		isd200_invoke_transport(us, srb, &ataCdb);
   1534
   1535	isd200_srb_set_bufflen(srb, orig_bufflen);
   1536}
   1537
   1538static struct scsi_host_template isd200_host_template;
   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			&isd200_host_template);
   1549	if (result)
   1550		return result;
   1551
   1552	us->protocol_name = "ISD200 ATA/ATAPI";
   1553	us->proto_handler = isd200_ata_command;
   1554
   1555	result = usb_stor_probe2(us);
   1556	return result;
   1557}
   1558
   1559static struct usb_driver isd200_driver = {
   1560	.name =		DRV_NAME,
   1561	.probe =	isd200_probe,
   1562	.disconnect =	usb_stor_disconnect,
   1563	.suspend =	usb_stor_suspend,
   1564	.resume =	usb_stor_resume,
   1565	.reset_resume =	usb_stor_reset_resume,
   1566	.pre_reset =	usb_stor_pre_reset,
   1567	.post_reset =	usb_stor_post_reset,
   1568	.id_table =	isd200_usb_ids,
   1569	.soft_unbind =	1,
   1570	.no_dynamic_id = 1,
   1571};
   1572
   1573module_usb_stor_driver(isd200_driver, isd200_host_template, DRV_NAME);