[deliverable/linux.git] / drivers / usb / storage / freecom.c

/* Driver for Freecom USB/IDE adaptor
 *
 * Freecom v0.1:
 *
 * First release
 *
 * Current development and maintenance by:
 *   (C) 2000 David Brown <usb-storage@davidb.org>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * This driver was developed with information provided in FREECOM's USB
 * Programmers Reference Guide.  For further information contact Freecom
 * (http://www.freecom.de/)
 */

#include <linux/module.h>
#include <scsi/scsi.h>
#include <scsi/scsi_cmnd.h>

#include "usb.h"
#include "transport.h"
#include "protocol.h"
#include "debug.h"

MODULE_DESCRIPTION("Driver for Freecom USB/IDE adaptor");
MODULE_AUTHOR("David Brown <usb-storage@davidb.org>");
MODULE_LICENSE("GPL");

#ifdef CONFIG_USB_STORAGE_DEBUG
static void pdump(struct us_data *us, void *ibuffer, int length);
#endif

/* Bits of HD_STATUS */
#define ERR_STAT		0x01
#define DRQ_STAT		0x08

/* All of the outgoing packets are 64 bytes long. */
struct freecom_cb_wrap {
	u8    Type;		/* Command type. */
	u8    Timeout;		/* Timeout in seconds. */
	u8    Atapi[12];	/* An ATAPI packet. */
	u8    Filler[50];	/* Padding Data. */
};

struct freecom_xfer_wrap {
	u8    Type;		/* Command type. */
	u8    Timeout;		/* Timeout in seconds. */
	__le32   Count;		/* Number of bytes to transfer. */
	u8    Pad[58];
} __attribute__ ((packed));

struct freecom_ide_out {
	u8    Type;		/* Type + IDE register. */
	u8    Pad;
	__le16   Value;		/* Value to write. */
	u8    Pad2[60];
};

struct freecom_ide_in {
	u8    Type;		/* Type | IDE register. */
	u8    Pad[63];
};

struct freecom_status {
	u8    Status;
	u8    Reason;
	__le16   Count;
	u8    Pad[60];
};

/* Freecom stuffs the interrupt status in the INDEX_STAT bit of the ide
 * register. */
#define FCM_INT_STATUS		0x02 /* INDEX_STAT */
#define FCM_STATUS_BUSY		0x80

/* These are the packet types.  The low bit indicates that this command
 * should wait for an interrupt. */
#define FCM_PACKET_ATAPI	0x21
#define FCM_PACKET_STATUS	0x20

/* Receive data from the IDE interface.  The ATAPI packet has already
 * waited, so the data should be immediately available. */
#define FCM_PACKET_INPUT	0x81

/* Send data to the IDE interface. */
#define FCM_PACKET_OUTPUT	0x01

/* Write a value to an ide register.  Or the ide register to write after
 * munging the address a bit. */
#define FCM_PACKET_IDE_WRITE	0x40
#define FCM_PACKET_IDE_READ	0xC0

/* All packets (except for status) are 64 bytes long. */
#define FCM_PACKET_LENGTH		64
#define FCM_STATUS_PACKET_LENGTH	4

static int init_freecom(struct us_data *us);


/*
 * The table of devices
 */
#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
		    vendorName, productName, useProtocol, useTransport, \
		    initFunction, flags) \
{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
  .driver_info = (flags) }

static struct usb_device_id freecom_usb_ids[] = {
#	include "unusual_freecom.h"
	{ }		/* Terminating entry */
};
MODULE_DEVICE_TABLE(usb, freecom_usb_ids);

#undef UNUSUAL_DEV

/*
 * The flags table
 */
#define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
		    vendor_name, product_name, use_protocol, use_transport, \
		    init_function, Flags) \
{ \
	.vendorName = vendor_name,	\
	.productName = product_name,	\
	.useProtocol = use_protocol,	\
	.useTransport = use_transport,	\
	.initFunction = init_function,	\
}

static struct us_unusual_dev freecom_unusual_dev_list[] = {
#	include "unusual_freecom.h"
	{ }		/* Terminating entry */
};

#undef UNUSUAL_DEV

static int
freecom_readdata (struct scsi_cmnd *srb, struct us_data *us,
		unsigned int ipipe, unsigned int opipe, int count)
{
	struct freecom_xfer_wrap *fxfr =
		(struct freecom_xfer_wrap *) us->iobuf;
	int result;

	fxfr->Type = FCM_PACKET_INPUT | 0x00;
	fxfr->Timeout = 0;    /* Short timeout for debugging. */
	fxfr->Count = cpu_to_le32 (count);
	memset (fxfr->Pad, 0, sizeof (fxfr->Pad));

	usb_stor_dbg(us, "Read data Freecom! (c=%d)\n", count);

	/* Issue the transfer command. */
	result = usb_stor_bulk_transfer_buf (us, opipe, fxfr,
			FCM_PACKET_LENGTH, NULL);
	if (result != USB_STOR_XFER_GOOD) {
		usb_stor_dbg(us, "Freecom readdata transport error\n");
		return USB_STOR_TRANSPORT_ERROR;
	}

	/* Now transfer all of our blocks. */
	usb_stor_dbg(us, "Start of read\n");
	result = usb_stor_bulk_srb(us, ipipe, srb);
	usb_stor_dbg(us, "freecom_readdata done!\n");

	if (result > USB_STOR_XFER_SHORT)
		return USB_STOR_TRANSPORT_ERROR;
	return USB_STOR_TRANSPORT_GOOD;
}

static int
freecom_writedata (struct scsi_cmnd *srb, struct us_data *us,
		int unsigned ipipe, unsigned int opipe, int count)
{
	struct freecom_xfer_wrap *fxfr =
		(struct freecom_xfer_wrap *) us->iobuf;
	int result;

	fxfr->Type = FCM_PACKET_OUTPUT | 0x00;
	fxfr->Timeout = 0;    /* Short timeout for debugging. */
	fxfr->Count = cpu_to_le32 (count);
	memset (fxfr->Pad, 0, sizeof (fxfr->Pad));

	usb_stor_dbg(us, "Write data Freecom! (c=%d)\n", count);

	/* Issue the transfer command. */
	result = usb_stor_bulk_transfer_buf (us, opipe, fxfr,
			FCM_PACKET_LENGTH, NULL);
	if (result != USB_STOR_XFER_GOOD) {
		usb_stor_dbg(us, "Freecom writedata transport error\n");
		return USB_STOR_TRANSPORT_ERROR;
	}

	/* Now transfer all of our blocks. */
	usb_stor_dbg(us, "Start of write\n");
	result = usb_stor_bulk_srb(us, opipe, srb);

	usb_stor_dbg(us, "freecom_writedata done!\n");
	if (result > USB_STOR_XFER_SHORT)
		return USB_STOR_TRANSPORT_ERROR;
	return USB_STOR_TRANSPORT_GOOD;
}

/*
 * Transport for the Freecom USB/IDE adaptor.
 *
 */
static int freecom_transport(struct scsi_cmnd *srb, struct us_data *us)
{
	struct freecom_cb_wrap *fcb;
	struct freecom_status  *fst;
	unsigned int ipipe, opipe;		/* We need both pipes. */
	int result;
	unsigned int partial;
	int length;

	fcb = (struct freecom_cb_wrap *) us->iobuf;
	fst = (struct freecom_status *) us->iobuf;

	usb_stor_dbg(us, "Freecom TRANSPORT STARTED\n");

	/* Get handles for both transports. */
	opipe = us->send_bulk_pipe;
	ipipe = us->recv_bulk_pipe;

	/* The ATAPI Command always goes out first. */
	fcb->Type = FCM_PACKET_ATAPI | 0x00;
	fcb->Timeout = 0;
	memcpy (fcb->Atapi, srb->cmnd, 12);
	memset (fcb->Filler, 0, sizeof (fcb->Filler));

	US_DEBUG(pdump(us, srb->cmnd, 12));

	/* Send it out. */
	result = usb_stor_bulk_transfer_buf (us, opipe, fcb,
			FCM_PACKET_LENGTH, NULL);

	/* The Freecom device will only fail if there is something wrong in
	 * USB land.  It returns the status in its own registers, which
	 * come back in the bulk pipe. */
	if (result != USB_STOR_XFER_GOOD) {
		usb_stor_dbg(us, "freecom transport error\n");
		return USB_STOR_TRANSPORT_ERROR;
	}

	/* There are times we can optimize out this status read, but it
	 * doesn't hurt us to always do it now. */
	result = usb_stor_bulk_transfer_buf (us, ipipe, fst,
			FCM_STATUS_PACKET_LENGTH, &partial);
	usb_stor_dbg(us, "foo Status result %d %u\n", result, partial);
	if (result != USB_STOR_XFER_GOOD)
		return USB_STOR_TRANSPORT_ERROR;

	US_DEBUG(pdump(us, (void *)fst, partial));

	/* The firmware will time-out commands after 20 seconds. Some commands
	 * can legitimately take longer than this, so we use a different
	 * command that only waits for the interrupt and then sends status,
	 * without having to send a new ATAPI command to the device.
	 *
	 * NOTE: There is some indication that a data transfer after a timeout
	 * may not work, but that is a condition that should never happen.
	 */
	while (fst->Status & FCM_STATUS_BUSY) {
		usb_stor_dbg(us, "20 second USB/ATAPI bridge TIMEOUT occurred!\n");
		usb_stor_dbg(us, "fst->Status is %x\n", fst->Status);

		/* Get the status again */
		fcb->Type = FCM_PACKET_STATUS;
		fcb->Timeout = 0;
		memset (fcb->Atapi, 0, sizeof(fcb->Atapi));
		memset (fcb->Filler, 0, sizeof (fcb->Filler));

		/* Send it out. */
		result = usb_stor_bulk_transfer_buf (us, opipe, fcb,
				FCM_PACKET_LENGTH, NULL);

		/* The Freecom device will only fail if there is something
		 * wrong in USB land.  It returns the status in its own
		 * registers, which come back in the bulk pipe.
		 */
		if (result != USB_STOR_XFER_GOOD) {
			usb_stor_dbg(us, "freecom transport error\n");
			return USB_STOR_TRANSPORT_ERROR;
		}

		/* get the data */
		result = usb_stor_bulk_transfer_buf (us, ipipe, fst,
				FCM_STATUS_PACKET_LENGTH, &partial);

		usb_stor_dbg(us, "bar Status result %d %u\n", result, partial);
		if (result != USB_STOR_XFER_GOOD)
			return USB_STOR_TRANSPORT_ERROR;

		US_DEBUG(pdump(us, (void *)fst, partial));
	}

	if (partial != 4)
		return USB_STOR_TRANSPORT_ERROR;
	if ((fst->Status & 1) != 0) {
		usb_stor_dbg(us, "operation failed\n");
		return USB_STOR_TRANSPORT_FAILED;
	}

	/* The device might not have as much data available as we
	 * requested.  If you ask for more than the device has, this reads
	 * and such will hang. */
	usb_stor_dbg(us, "Device indicates that it has %d bytes available\n",
		     le16_to_cpu(fst->Count));
	usb_stor_dbg(us, "SCSI requested %d\n", scsi_bufflen(srb));

	/* Find the length we desire to read. */
	switch (srb->cmnd[0]) {
	case INQUIRY:
	case REQUEST_SENSE:	/* 16 or 18 bytes? spec says 18, lots of devices only have 16 */
	case MODE_SENSE:
	case MODE_SENSE_10:
		length = le16_to_cpu(fst->Count);
		break;
	default:
		length = scsi_bufflen(srb);
	}

	/* verify that this amount is legal */
	if (length > scsi_bufflen(srb)) {
		length = scsi_bufflen(srb);
		usb_stor_dbg(us, "Truncating request to match buffer length: %d\n",
			     length);
	}

	/* What we do now depends on what direction the data is supposed to
	 * move in. */

	switch (us->srb->sc_data_direction) {
	case DMA_FROM_DEVICE:
		/* catch bogus "read 0 length" case */
		if (!length)
			break;
		/* Make sure that the status indicates that the device
		 * wants data as well. */
		if ((fst->Status & DRQ_STAT) == 0 || (fst->Reason & 3) != 2) {
			usb_stor_dbg(us, "SCSI wants data, drive doesn't have any\n");
			return USB_STOR_TRANSPORT_FAILED;
		}
		result = freecom_readdata (srb, us, ipipe, opipe, length);
		if (result != USB_STOR_TRANSPORT_GOOD)
			return result;

		usb_stor_dbg(us, "Waiting for status\n");
		result = usb_stor_bulk_transfer_buf (us, ipipe, fst,
				FCM_PACKET_LENGTH, &partial);
		US_DEBUG(pdump(us, (void *)fst, partial));

		if (partial != 4 || result > USB_STOR_XFER_SHORT)
			return USB_STOR_TRANSPORT_ERROR;
		if ((fst->Status & ERR_STAT) != 0) {
			usb_stor_dbg(us, "operation failed\n");
			return USB_STOR_TRANSPORT_FAILED;
		}
		if ((fst->Reason & 3) != 3) {
			usb_stor_dbg(us, "Drive seems still hungry\n");
			return USB_STOR_TRANSPORT_FAILED;
		}
		usb_stor_dbg(us, "Transfer happy\n");
		break;

	case DMA_TO_DEVICE:
		/* catch bogus "write 0 length" case */
		if (!length)
			break;
		/* Make sure the status indicates that the device wants to
		 * send us data. */
		/* !!IMPLEMENT!! */
		result = freecom_writedata (srb, us, ipipe, opipe, length);
		if (result != USB_STOR_TRANSPORT_GOOD)
			return result;

		usb_stor_dbg(us, "Waiting for status\n");
		result = usb_stor_bulk_transfer_buf (us, ipipe, fst,
				FCM_PACKET_LENGTH, &partial);

		if (partial != 4 || result > USB_STOR_XFER_SHORT)
			return USB_STOR_TRANSPORT_ERROR;
		if ((fst->Status & ERR_STAT) != 0) {
			usb_stor_dbg(us, "operation failed\n");
			return USB_STOR_TRANSPORT_FAILED;
		}
		if ((fst->Reason & 3) != 3) {
			usb_stor_dbg(us, "Drive seems still hungry\n");
			return USB_STOR_TRANSPORT_FAILED;
		}

		usb_stor_dbg(us, "Transfer happy\n");
		break;


	case DMA_NONE:
		/* Easy, do nothing. */
		break;

	default:
		/* should never hit here -- filtered in usb.c */
		usb_stor_dbg(us, "freecom unimplemented direction: %d\n",
			     us->srb->sc_data_direction);
		/* Return fail, SCSI seems to handle this better. */
		return USB_STOR_TRANSPORT_FAILED;
		break;
	}

	return USB_STOR_TRANSPORT_GOOD;
}

static int init_freecom(struct us_data *us)
{
	int result;
	char *buffer = us->iobuf;

	/* The DMA-mapped I/O buffer is 64 bytes long, just right for
	 * all our packets.  No need to allocate any extra buffer space.
	 */

	result = usb_stor_control_msg(us, us->recv_ctrl_pipe,
			0x4c, 0xc0, 0x4346, 0x0, buffer, 0x20, 3*HZ);
	buffer[32] = '\0';
	usb_stor_dbg(us, "String returned from FC init is: %s\n", buffer);

	/* Special thanks to the people at Freecom for providing me with
	 * this "magic sequence", which they use in their Windows and MacOS
	 * drivers to make sure that all the attached perhiperals are
	 * properly reset.
	 */

	/* send reset */
	result = usb_stor_control_msg(us, us->send_ctrl_pipe,
			0x4d, 0x40, 0x24d8, 0x0, NULL, 0x0, 3*HZ);
	usb_stor_dbg(us, "result from activate reset is %d\n", result);

	/* wait 250ms */
	mdelay(250);

	/* clear reset */
	result = usb_stor_control_msg(us, us->send_ctrl_pipe,
			0x4d, 0x40, 0x24f8, 0x0, NULL, 0x0, 3*HZ);
	usb_stor_dbg(us, "result from clear reset is %d\n", result);

	/* wait 3 seconds */
	mdelay(3 * 1000);

	return USB_STOR_TRANSPORT_GOOD;
}

static int usb_stor_freecom_reset(struct us_data *us)
{
	printk (KERN_CRIT "freecom reset called\n");

	/* We don't really have this feature. */
	return FAILED;
}

#ifdef CONFIG_USB_STORAGE_DEBUG
static void pdump(struct us_data *us, void *ibuffer, int length)
{
	static char line[80];
	int offset = 0;
	unsigned char *buffer = (unsigned char *) ibuffer;
	int i, j;
	int from, base;

	offset = 0;
	for (i = 0; i < length; i++) {
		if ((i & 15) == 0) {
			if (i > 0) {
				offset += sprintf (line+offset, " - ");
				for (j = i - 16; j < i; j++) {
					if (buffer[j] >= 32 && buffer[j] <= 126)
						line[offset++] = buffer[j];
					else
						line[offset++] = '.';
				}
				line[offset] = 0;
				usb_stor_dbg(us, "%s\n", line);
				offset = 0;
			}
			offset += sprintf (line+offset, "%08x:", i);
		} else if ((i & 7) == 0) {
			offset += sprintf (line+offset, " -");
		}
		offset += sprintf (line+offset, " %02x", buffer[i] & 0xff);
	}

	/* Add the last "chunk" of data. */
	from = (length - 1) % 16;
	base = ((length - 1) / 16) * 16;

	for (i = from + 1; i < 16; i++)
		offset += sprintf (line+offset, "   ");
	if (from < 8)
		offset += sprintf (line+offset, "  ");
	offset += sprintf (line+offset, " - ");

	for (i = 0; i <= from; i++) {
		if (buffer[base+i] >= 32 && buffer[base+i] <= 126)
			line[offset++] = buffer[base+i];
		else
			line[offset++] = '.';
	}
	line[offset] = 0;
	usb_stor_dbg(us, "%s\n", line);
	offset = 0;
}
#endif

static int freecom_probe(struct usb_interface *intf,
			 const struct usb_device_id *id)
{
	struct us_data *us;
	int result;

	result = usb_stor_probe1(&us, intf, id,
			(id - freecom_usb_ids) + freecom_unusual_dev_list);
	if (result)
		return result;

	us->transport_name = "Freecom";
	us->transport = freecom_transport;
	us->transport_reset = usb_stor_freecom_reset;
	us->max_lun = 0;

	result = usb_stor_probe2(us);
	return result;
}

static struct usb_driver freecom_driver = {
	.name =		"ums-freecom",
	.probe =	freecom_probe,
	.disconnect =	usb_stor_disconnect,
	.suspend =	usb_stor_suspend,
	.resume =	usb_stor_resume,
	.reset_resume =	usb_stor_reset_resume,
	.pre_reset =	usb_stor_pre_reset,
	.post_reset =	usb_stor_post_reset,
	.id_table =	freecom_usb_ids,
	.soft_unbind =	1,
	.no_dynamic_id = 1,
};

module_usb_driver(freecom_driver);
Commit	Line	Data
1da177e4	1	/* Driver for Freecom USB/IDE adaptor
1da177e4 LT	2	*
	3	* Freecom v0.1:
	4	*
	5	* First release
	6	*
	7	* Current development and maintenance by:
	8	* (C) 2000 David Brown <usb-storage@davidb.org>
	9	*
	10	* This program is free software; you can redistribute it and/or modify it
	11	* under the terms of the GNU General Public License as published by the
	12	* Free Software Foundation; either version 2, or (at your option) any
	13	* later version.
	14	*
	15	* This program is distributed in the hope that it will be useful, but
	16	* WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	18	* General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License along
	21	* with this program; if not, write to the Free Software Foundation, Inc.,
	22	* 675 Mass Ave, Cambridge, MA 02139, USA.
	23	*
	24	* This driver was developed with information provided in FREECOM's USB
	25	* Programmers Reference Guide. For further information contact Freecom
	26	* (http://www.freecom.de/)
	27	*/
	28
0d62939f	29	#include <linux/module.h>
1da177e4 LT	30	#include <scsi/scsi.h>
	31	#include <scsi/scsi_cmnd.h>
	32
	33	#include "usb.h"
	34	#include "transport.h"
	35	#include "protocol.h"
	36	#include "debug.h"
1da177e4	37
4246b06a MG	38	MODULE_DESCRIPTION("Driver for Freecom USB/IDE adaptor");
	39	MODULE_AUTHOR("David Brown <usb-storage@davidb.org>");
	40	MODULE_LICENSE("GPL");
	41
1da177e4	42	#ifdef CONFIG_USB_STORAGE_DEBUG
191648d0	43	static void pdump(struct us_data us, void ibuffer, int length);
1da177e4 LT	44	#endif
	45
	46	/* Bits of HD_STATUS */
	47	#define ERR_STAT 0x01
	48	#define DRQ_STAT 0x08
	49
	50	/* All of the outgoing packets are 64 bytes long. */
	51	struct freecom_cb_wrap {
	52	u8 Type; /* Command type. */
	53	u8 Timeout; /* Timeout in seconds. */
	54	u8 Atapi[12]; /* An ATAPI packet. */
	55	u8 Filler[50]; /* Padding Data. */
	56	};
	57
	58	struct freecom_xfer_wrap {
	59	u8 Type; /* Command type. */
	60	u8 Timeout; /* Timeout in seconds. */
	61	__le32 Count; /* Number of bytes to transfer. */
	62	u8 Pad[58];
	63	} __attribute__ ((packed));
	64
	65	struct freecom_ide_out {
	66	u8 Type; /* Type + IDE register. */
	67	u8 Pad;
	68	__le16 Value; /* Value to write. */
	69	u8 Pad2[60];
	70	};
	71
	72	struct freecom_ide_in {
	73	u8 Type; /* Type \| IDE register. */
	74	u8 Pad[63];
	75	};
	76
	77	struct freecom_status {
	78	u8 Status;
	79	u8 Reason;
	80	__le16 Count;
	81	u8 Pad[60];
	82	};
	83
	84	/* Freecom stuffs the interrupt status in the INDEX_STAT bit of the ide
	85	* register. */
	86	#define FCM_INT_STATUS 0x02 /* INDEX_STAT */
	87	#define FCM_STATUS_BUSY 0x80
	88
	89	/* These are the packet types. The low bit indicates that this command
	90	* should wait for an interrupt. */
	91	#define FCM_PACKET_ATAPI 0x21
	92	#define FCM_PACKET_STATUS 0x20
	93
	94	/* Receive data from the IDE interface. The ATAPI packet has already
	95	* waited, so the data should be immediately available. */
	96	#define FCM_PACKET_INPUT 0x81
	97
	98	/* Send data to the IDE interface. */
	99	#define FCM_PACKET_OUTPUT 0x01
	100
	101	/* Write a value to an ide register. Or the ide register to write after
	102	* munging the address a bit. */
	103	#define FCM_PACKET_IDE_WRITE 0x40
	104	#define FCM_PACKET_IDE_READ 0xC0
	105
	106	/* All packets (except for status) are 64 bytes long. */
	107	#define FCM_PACKET_LENGTH 64
108	#define FCM_STATUS_PACKET_LENGTH 4
109
0d62939f AS	110	static int init_freecom(struct us_data *us);
	111
	112
	113	/*
	114	* The table of devices
	115	*/
	116	#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
	117	vendorName, productName, useProtocol, useTransport, \
	118	initFunction, flags) \
	119	{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
f61870ee	120	.driver_info = (flags) }
0d62939f	121
2053f075	122	static struct usb_device_id freecom_usb_ids[] = {
0d62939f AS	123	# include "unusual_freecom.h"
	124	{ } /* Terminating entry */
	125	};
	126	MODULE_DEVICE_TABLE(usb, freecom_usb_ids);
	127
	128	#undef UNUSUAL_DEV
	129
	130	/*
	131	* The flags table
	132	*/
	133	#define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
	134	vendor_name, product_name, use_protocol, use_transport, \
	135	init_function, Flags) \
	136	{ \
	137	.vendorName = vendor_name, \
	138	.productName = product_name, \
	139	.useProtocol = use_protocol, \
	140	.useTransport = use_transport, \
	141	.initFunction = init_function, \
	142	}
	143
	144	static struct us_unusual_dev freecom_unusual_dev_list[] = {
	145	# include "unusual_freecom.h"
	146	{ } /* Terminating entry */
	147	};
	148
	149	#undef UNUSUAL_DEV
	150
1da177e4 LT	151	static int
	152	freecom_readdata (struct scsi_cmnd srb, struct us_data us,
	153	unsigned int ipipe, unsigned int opipe, int count)
	154	{
	155	struct freecom_xfer_wrap *fxfr =
	156	(struct freecom_xfer_wrap *) us->iobuf;
	157	int result;
	158
	159	fxfr->Type = FCM_PACKET_INPUT \| 0x00;
	160	fxfr->Timeout = 0; /* Short timeout for debugging. */
	161	fxfr->Count = cpu_to_le32 (count);
	162	memset (fxfr->Pad, 0, sizeof (fxfr->Pad));
	163
191648d0	164	usb_stor_dbg(us, "Read data Freecom! (c=%d)\n", count);
1da177e4 LT	165
	166	/* Issue the transfer command. */
	167	result = usb_stor_bulk_transfer_buf (us, opipe, fxfr,
	168	FCM_PACKET_LENGTH, NULL);
	169	if (result != USB_STOR_XFER_GOOD) {
191648d0	170	usb_stor_dbg(us, "Freecom readdata transport error\n");
1da177e4 LT	171	return USB_STOR_TRANSPORT_ERROR;
	172	}
	173
	174	/* Now transfer all of our blocks. */
191648d0	175	usb_stor_dbg(us, "Start of read\n");
41c2497b	176	result = usb_stor_bulk_srb(us, ipipe, srb);
191648d0	177	usb_stor_dbg(us, "freecom_readdata done!\n");
1da177e4 LT	178
	179	if (result > USB_STOR_XFER_SHORT)
	180	return USB_STOR_TRANSPORT_ERROR;
	181	return USB_STOR_TRANSPORT_GOOD;
	182	}
	183
	184	static int
	185	freecom_writedata (struct scsi_cmnd srb, struct us_data us,
	186	int unsigned ipipe, unsigned int opipe, int count)
	187	{
	188	struct freecom_xfer_wrap *fxfr =
	189	(struct freecom_xfer_wrap *) us->iobuf;
	190	int result;
	191
	192	fxfr->Type = FCM_PACKET_OUTPUT \| 0x00;
	193	fxfr->Timeout = 0; /* Short timeout for debugging. */
	194	fxfr->Count = cpu_to_le32 (count);
	195	memset (fxfr->Pad, 0, sizeof (fxfr->Pad));
	196
191648d0	197	usb_stor_dbg(us, "Write data Freecom! (c=%d)\n", count);
1da177e4 LT	198
	199	/* Issue the transfer command. */
	200	result = usb_stor_bulk_transfer_buf (us, opipe, fxfr,
	201	FCM_PACKET_LENGTH, NULL);
	202	if (result != USB_STOR_XFER_GOOD) {
191648d0	203	usb_stor_dbg(us, "Freecom writedata transport error\n");
1da177e4 LT	204	return USB_STOR_TRANSPORT_ERROR;
	205	}
	206
	207	/* Now transfer all of our blocks. */
191648d0	208	usb_stor_dbg(us, "Start of write\n");
41c2497b	209	result = usb_stor_bulk_srb(us, opipe, srb);
1da177e4	210
191648d0	211	usb_stor_dbg(us, "freecom_writedata done!\n");
1da177e4 LT	212	if (result > USB_STOR_XFER_SHORT)
	213	return USB_STOR_TRANSPORT_ERROR;
	214	return USB_STOR_TRANSPORT_GOOD;
	215	}
	216
	217	/*
	218	* Transport for the Freecom USB/IDE adaptor.
	219	*
	220	*/
0d62939f	221	static int freecom_transport(struct scsi_cmnd srb, struct us_data us)
1da177e4 LT	222	{
	223	struct freecom_cb_wrap *fcb;
	224	struct freecom_status *fst;
	225	unsigned int ipipe, opipe; /* We need both pipes. */
	226	int result;
	227	unsigned int partial;
	228	int length;
	229
	230	fcb = (struct freecom_cb_wrap *) us->iobuf;
	231	fst = (struct freecom_status *) us->iobuf;
	232
191648d0	233	usb_stor_dbg(us, "Freecom TRANSPORT STARTED\n");
1da177e4 LT	234
	235	/* Get handles for both transports. */
	236	opipe = us->send_bulk_pipe;
	237	ipipe = us->recv_bulk_pipe;
	238
	239	/* The ATAPI Command always goes out first. */
	240	fcb->Type = FCM_PACKET_ATAPI \| 0x00;
	241	fcb->Timeout = 0;
	242	memcpy (fcb->Atapi, srb->cmnd, 12);
	243	memset (fcb->Filler, 0, sizeof (fcb->Filler));
	244
191648d0	245	US_DEBUG(pdump(us, srb->cmnd, 12));
1da177e4 LT	246
	247	/* Send it out. */
	248	result = usb_stor_bulk_transfer_buf (us, opipe, fcb,
	249	FCM_PACKET_LENGTH, NULL);
	250
	251	/* The Freecom device will only fail if there is something wrong in
	252	* USB land. It returns the status in its own registers, which
	253	* come back in the bulk pipe. */
	254	if (result != USB_STOR_XFER_GOOD) {
191648d0	255	usb_stor_dbg(us, "freecom transport error\n");
1da177e4 LT	256	return USB_STOR_TRANSPORT_ERROR;
	257	}
	258
	259	/* There are times we can optimize out this status read, but it
	260	* doesn't hurt us to always do it now. */
	261	result = usb_stor_bulk_transfer_buf (us, ipipe, fst,
	262	FCM_STATUS_PACKET_LENGTH, &partial);
191648d0	263	usb_stor_dbg(us, "foo Status result %d %u\n", result, partial);
1da177e4 LT	264	if (result != USB_STOR_XFER_GOOD)
	265	return USB_STOR_TRANSPORT_ERROR;
	266
191648d0	267	US_DEBUG(pdump(us, (void *)fst, partial));
1da177e4 LT	268
	269	/* The firmware will time-out commands after 20 seconds. Some commands
	270	* can legitimately take longer than this, so we use a different
	271	* command that only waits for the interrupt and then sends status,
7c7e2d00	272	* without having to send a new ATAPI command to the device.
1da177e4 LT	273	*
	274	* NOTE: There is some indication that a data transfer after a timeout
	275	* may not work, but that is a condition that should never happen.
	276	*/
	277	while (fst->Status & FCM_STATUS_BUSY) {
191648d0 JP	278	usb_stor_dbg(us, "20 second USB/ATAPI bridge TIMEOUT occurred!\n");
191648d0 JP	279	usb_stor_dbg(us, "fst->Status is %x\n", fst->Status);
1da177e4 LT	280
	281	/* Get the status again */
	282	fcb->Type = FCM_PACKET_STATUS;
	283	fcb->Timeout = 0;
	284	memset (fcb->Atapi, 0, sizeof(fcb->Atapi));
	285	memset (fcb->Filler, 0, sizeof (fcb->Filler));
	286
	287	/* Send it out. */
	288	result = usb_stor_bulk_transfer_buf (us, opipe, fcb,
	289	FCM_PACKET_LENGTH, NULL);
	290
	291	/* The Freecom device will only fail if there is something
	292	* wrong in USB land. It returns the status in its own
	293	* registers, which come back in the bulk pipe.
	294	*/
	295	if (result != USB_STOR_XFER_GOOD) {
191648d0	296	usb_stor_dbg(us, "freecom transport error\n");
1da177e4 LT	297	return USB_STOR_TRANSPORT_ERROR;
	298	}
	299
	300	/* get the data */
	301	result = usb_stor_bulk_transfer_buf (us, ipipe, fst,
	302	FCM_STATUS_PACKET_LENGTH, &partial);
	303
191648d0	304	usb_stor_dbg(us, "bar Status result %d %u\n", result, partial);
1da177e4 LT	305	if (result != USB_STOR_XFER_GOOD)
	306	return USB_STOR_TRANSPORT_ERROR;
	307
191648d0	308	US_DEBUG(pdump(us, (void *)fst, partial));
1da177e4 LT	309	}
	310
	311	if (partial != 4)
	312	return USB_STOR_TRANSPORT_ERROR;
	313	if ((fst->Status & 1) != 0) {
191648d0	314	usb_stor_dbg(us, "operation failed\n");
1da177e4 LT	315	return USB_STOR_TRANSPORT_FAILED;
	316	}
	317
	318	/* The device might not have as much data available as we
	319	* requested. If you ask for more than the device has, this reads
	320	* and such will hang. */
191648d0 JP	321	usb_stor_dbg(us, "Device indicates that it has %d bytes available\n",
	322	le16_to_cpu(fst->Count));
	323	usb_stor_dbg(us, "SCSI requested %d\n", scsi_bufflen(srb));
1da177e4 LT	324
	325	/* Find the length we desire to read. */
	326	switch (srb->cmnd[0]) {
7c7e2d00 ME	327	case INQUIRY:
	328	case REQUEST_SENSE: /* 16 or 18 bytes? spec says 18, lots of devices only have 16 */
	329	case MODE_SENSE:
	330	case MODE_SENSE_10:
	331	length = le16_to_cpu(fst->Count);
	332	break;
	333	default:
	334	length = scsi_bufflen(srb);
1da177e4 LT	335	}
	336
	337	/* verify that this amount is legal */
41c2497b BH	338	if (length > scsi_bufflen(srb)) {
41c2497b BH	339	length = scsi_bufflen(srb);
191648d0 JP	340	usb_stor_dbg(us, "Truncating request to match buffer length: %d\n",
191648d0 JP	341	length);
1da177e4 LT	342	}
	343
	344	/* What we do now depends on what direction the data is supposed to
	345	* move in. */
	346
	347	switch (us->srb->sc_data_direction) {
	348	case DMA_FROM_DEVICE:
	349	/* catch bogus "read 0 length" case */
	350	if (!length)
	351	break;
	352	/* Make sure that the status indicates that the device
	353	* wants data as well. */
	354	if ((fst->Status & DRQ_STAT) == 0 \|\| (fst->Reason & 3) != 2) {
191648d0	355	usb_stor_dbg(us, "SCSI wants data, drive doesn't have any\n");
1da177e4 LT	356	return USB_STOR_TRANSPORT_FAILED;
	357	}
	358	result = freecom_readdata (srb, us, ipipe, opipe, length);
	359	if (result != USB_STOR_TRANSPORT_GOOD)
	360	return result;
	361
191648d0	362	usb_stor_dbg(us, "Waiting for status\n");
1da177e4 LT	363	result = usb_stor_bulk_transfer_buf (us, ipipe, fst,
1da177e4 LT	364	FCM_PACKET_LENGTH, &partial);
191648d0	365	US_DEBUG(pdump(us, (void *)fst, partial));
1da177e4 LT	366
	367	if (partial != 4 \|\| result > USB_STOR_XFER_SHORT)
	368	return USB_STOR_TRANSPORT_ERROR;
	369	if ((fst->Status & ERR_STAT) != 0) {
191648d0	370	usb_stor_dbg(us, "operation failed\n");
1da177e4 LT	371	return USB_STOR_TRANSPORT_FAILED;
	372	}
	373	if ((fst->Reason & 3) != 3) {
191648d0	374	usb_stor_dbg(us, "Drive seems still hungry\n");
1da177e4 LT	375	return USB_STOR_TRANSPORT_FAILED;
1da177e4 LT	376	}
191648d0	377	usb_stor_dbg(us, "Transfer happy\n");
1da177e4 LT	378	break;
	379
	380	case DMA_TO_DEVICE:
	381	/* catch bogus "write 0 length" case */
	382	if (!length)
	383	break;
	384	/* Make sure the status indicates that the device wants to
	385	* send us data. */
	386	/* !!IMPLEMENT!! */
	387	result = freecom_writedata (srb, us, ipipe, opipe, length);
	388	if (result != USB_STOR_TRANSPORT_GOOD)
	389	return result;
	390
191648d0	391	usb_stor_dbg(us, "Waiting for status\n");
1da177e4 LT	392	result = usb_stor_bulk_transfer_buf (us, ipipe, fst,
	393	FCM_PACKET_LENGTH, &partial);
	394
	395	if (partial != 4 \|\| result > USB_STOR_XFER_SHORT)
	396	return USB_STOR_TRANSPORT_ERROR;
	397	if ((fst->Status & ERR_STAT) != 0) {
191648d0	398	usb_stor_dbg(us, "operation failed\n");
1da177e4 LT	399	return USB_STOR_TRANSPORT_FAILED;
	400	}
	401	if ((fst->Reason & 3) != 3) {
191648d0	402	usb_stor_dbg(us, "Drive seems still hungry\n");
1da177e4 LT	403	return USB_STOR_TRANSPORT_FAILED;
	404	}
	405
191648d0	406	usb_stor_dbg(us, "Transfer happy\n");
1da177e4 LT	407	break;
	408
	409
	410	case DMA_NONE:
	411	/* Easy, do nothing. */
	412	break;
	413
	414	default:
	415	/* should never hit here -- filtered in usb.c */
191648d0 JP	416	usb_stor_dbg(us, "freecom unimplemented direction: %d\n",
191648d0 JP	417	us->srb->sc_data_direction);
7c7e2d00	418	/* Return fail, SCSI seems to handle this better. */
1da177e4 LT	419	return USB_STOR_TRANSPORT_FAILED;
	420	break;
	421	}
	422
	423	return USB_STOR_TRANSPORT_GOOD;
	424	}
	425
0d62939f	426	static int init_freecom(struct us_data *us)
1da177e4 LT	427	{
	428	int result;
	429	char *buffer = us->iobuf;
	430
	431	/* The DMA-mapped I/O buffer is 64 bytes long, just right for
	432	* all our packets. No need to allocate any extra buffer space.
	433	*/
	434
	435	result = usb_stor_control_msg(us, us->recv_ctrl_pipe,
	436	0x4c, 0xc0, 0x4346, 0x0, buffer, 0x20, 3*HZ);
	437	buffer[32] = '\0';
191648d0	438	usb_stor_dbg(us, "String returned from FC init is: %s\n", buffer);
1da177e4 LT	439
	440	/* Special thanks to the people at Freecom for providing me with
	441	* this "magic sequence", which they use in their Windows and MacOS
	442	* drivers to make sure that all the attached perhiperals are
	443	* properly reset.
	444	*/
	445
	446	/* send reset */
	447	result = usb_stor_control_msg(us, us->send_ctrl_pipe,
	448	0x4d, 0x40, 0x24d8, 0x0, NULL, 0x0, 3*HZ);
191648d0	449	usb_stor_dbg(us, "result from activate reset is %d\n", result);
1da177e4 LT	450
	451	/* wait 250ms */
	452	mdelay(250);
	453
	454	/* clear reset */
	455	result = usb_stor_control_msg(us, us->send_ctrl_pipe,
	456	0x4d, 0x40, 0x24f8, 0x0, NULL, 0x0, 3*HZ);
191648d0	457	usb_stor_dbg(us, "result from clear reset is %d\n", result);
1da177e4 LT	458
	459	/* wait 3 seconds */
	460	mdelay(3 * 1000);
	461
	462	return USB_STOR_TRANSPORT_GOOD;
	463	}
	464
0d62939f	465	static int usb_stor_freecom_reset(struct us_data *us)
1da177e4 LT	466	{
	467	printk (KERN_CRIT "freecom reset called\n");
	468
	469	/* We don't really have this feature. */
	470	return FAILED;
	471	}
	472
	473	#ifdef CONFIG_USB_STORAGE_DEBUG
191648d0	474	static void pdump(struct us_data us, void ibuffer, int length)
1da177e4 LT	475	{
	476	static char line[80];
	477	int offset = 0;
	478	unsigned char buffer = (unsigned char ) ibuffer;
	479	int i, j;
	480	int from, base;
	481
	482	offset = 0;
	483	for (i = 0; i < length; i++) {
	484	if ((i & 15) == 0) {
	485	if (i > 0) {
	486	offset += sprintf (line+offset, " - ");
	487	for (j = i - 16; j < i; j++) {
	488	if (buffer[j] >= 32 && buffer[j] <= 126)
	489	line[offset++] = buffer[j];
	490	else
	491	line[offset++] = '.';
	492	}
	493	line[offset] = 0;
191648d0	494	usb_stor_dbg(us, "%s\n", line);
1da177e4 LT	495	offset = 0;
	496	}
	497	offset += sprintf (line+offset, "%08x:", i);
7c7e2d00	498	} else if ((i & 7) == 0) {
1da177e4 LT	499	offset += sprintf (line+offset, " -");
	500	}
	501	offset += sprintf (line+offset, " %02x", buffer[i] & 0xff);
	502	}
	503
	504	/* Add the last "chunk" of data. */
	505	from = (length - 1) % 16;
	506	base = ((length - 1) / 16) * 16;
	507
	508	for (i = from + 1; i < 16; i++)
	509	offset += sprintf (line+offset, " ");
	510	if (from < 8)
	511	offset += sprintf (line+offset, " ");
	512	offset += sprintf (line+offset, " - ");
	513
	514	for (i = 0; i <= from; i++) {
	515	if (buffer[base+i] >= 32 && buffer[base+i] <= 126)
	516	line[offset++] = buffer[base+i];
	517	else
	518	line[offset++] = '.';
	519	}
	520	line[offset] = 0;
191648d0	521	usb_stor_dbg(us, "%s\n", line);
1da177e4 LT	522	offset = 0;
	523	}
	524	#endif
	525
0d62939f AS	526	static int freecom_probe(struct usb_interface *intf,
	527	const struct usb_device_id *id)
	528	{
	529	struct us_data *us;
	530	int result;
	531
	532	result = usb_stor_probe1(&us, intf, id,
	533	(id - freecom_usb_ids) + freecom_unusual_dev_list);
	534	if (result)
	535	return result;
	536
	537	us->transport_name = "Freecom";
	538	us->transport = freecom_transport;
	539	us->transport_reset = usb_stor_freecom_reset;
	540	us->max_lun = 0;
	541
	542	result = usb_stor_probe2(us);
	543	return result;
	544	}
	545
	546	static struct usb_driver freecom_driver = {
	547	.name = "ums-freecom",
	548	.probe = freecom_probe,
	549	.disconnect = usb_stor_disconnect,
	550	.suspend = usb_stor_suspend,
	551	.resume = usb_stor_resume,
	552	.reset_resume = usb_stor_reset_resume,
	553	.pre_reset = usb_stor_pre_reset,
	554	.post_reset = usb_stor_post_reset,
	555	.id_table = freecom_usb_ids,
	556	.soft_unbind = 1,
e73b2db6	557	.no_dynamic_id = 1,
0d62939f AS	558	};
0d62939f AS	559
65db4305	560	module_usb_driver(freecom_driver);