/* Driver for USB Mass Storage compliant devices * Transport Functions Header File * * $Id: transport.h,v 1.17 2002/02/25 00:43:41 mdharm Exp $ * * Current development and maintenance by: *   (c) 1999, 2000 Matthew Dharm (mdharm-usb@one-eyed-alien.net) * * This driver is based on the 'USB Mass Storage Class' document. This * describes in detail the protocol used to communicate with such * devices.  Clearly, the designers had SCSI and ATAPI commands in * mind when they created this document.  The commands are all very * similar to commands in the SCSI-II and ATAPI specifications. * * It is important to note that in a number of cases this class * exhibits class-specific exemptions from the USB specification. * Notably the usage of NAK, STALL and ACK differs from the norm, in * that they are used to communicate wait, failed and OK on commands. * * Also, for certain devices, the interrupt endpoint is used to convey * status of a command. * * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more * information about this driver. * * 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. */#ifndef _TRANSPORT_H_#define _TRANSPORT_H_#include <linux/config.h>#include <linux/blk.h>#include "usb.h"#include "scsi.h"/* Protocols */#define US_PR_CBI	0x00		/* Control/Bulk/Interrupt */#define US_PR_CB	0x01		/* Control/Bulk w/o interrupt */#define US_PR_BULK	0x50		/* bulk only */#ifdef CONFIG_USB_STORAGE_HP8200e#define US_PR_SCM_ATAPI	0x80		/* SCM-ATAPI bridge */#endif#ifdef CONFIG_USB_STORAGE_SDDR09#define US_PR_EUSB_SDDR09	0x81	/* SCM-SCSI bridge for						SDDR-09 */#endif#ifdef CONFIG_USB_STORAGE_SDDR55#define US_PR_SDDR55	0x82		/* SDDR-55 (made up) */#endif#define US_PR_DPCM_USB  0xf0		/* Combination CB/SDDR09 */#ifdef CONFIG_USB_STORAGE_FREECOM#define US_PR_FREECOM   0xf1            /* Freecom */#endif#ifdef CONFIG_USB_STORAGE_DATAFAB#define US_PR_DATAFAB   0xf2            /* Datafab chipsets */#endif#ifdef CONFIG_USB_STORAGE_JUMPSHOT#define US_PR_JUMPSHOT  0xf3            /* Lexar Jumpshot */#endif/* * Bulk only data structures *//* command block wrapper */struct bulk_cb_wrap {	__u32	Signature;		/* contains 'USBC' */	__u32	Tag;			/* unique per command id */	__u32	DataTransferLength;	/* size of data */	__u8	Flags;			/* direction in bit 0 */	__u8	Lun;			/* LUN normally 0 */	__u8	Length;			/* of of the CDB */	__u8	CDB[16];		/* max command */};#define US_BULK_CB_WRAP_LEN	31#define US_BULK_CB_SIGN		0x43425355	/*spells out USBC */#define US_BULK_FLAG_IN		1#define US_BULK_FLAG_OUT	0/* command status wrapper */struct bulk_cs_wrap {	__u32	Signature;		/* should = 'USBS' */	__u32	Tag;			/* same as original command */	__u32	Residue;		/* amount not transferred */	__u8	Status;			/* see below */	__u8	Filler[18];};#define US_BULK_CS_WRAP_LEN	13#define US_BULK_CS_SIGN		0x53425355	/* spells out 'USBS' */#define US_BULK_STAT_OK		0#define US_BULK_STAT_FAIL	1#define US_BULK_STAT_PHASE	2/* bulk-only class specific requests */#define US_BULK_RESET_REQUEST	0xff#define US_BULK_GET_MAX_LUN	0xfe/* * usb_stor_transfer() return codes */#define US_BULK_TRANSFER_GOOD		0  /* good transfer                 */#define US_BULK_TRANSFER_SHORT		1  /* transfered less than expected */#define US_BULK_TRANSFER_FAILED		2  /* transfer died in the middle   */#define US_BULK_TRANSFER_ABORTED	3  /* transfer canceled             *//* * Transport return codes */#define USB_STOR_TRANSPORT_GOOD	   0   /* Transport good, command good	   */#define USB_STOR_TRANSPORT_FAILED  1   /* Transport good, command failed   */#define USB_STOR_TRANSPORT_ERROR   2   /* Transport bad (i.e. device dead) */#define USB_STOR_TRANSPORT_ABORTED 3   /* Transport aborted                *//* * CBI accept device specific command */#define US_CBI_ADSC		0extern void usb_stor_CBI_irq(struct urb*);extern int usb_stor_CBI_transport(Scsi_Cmnd*, struct us_data*);extern int usb_stor_CB_transport(Scsi_Cmnd*, struct us_data*);extern int usb_stor_CB_reset(struct us_data*);extern int usb_stor_Bulk_transport(Scsi_Cmnd*, struct us_data*);extern int usb_stor_Bulk_max_lun(struct us_data*);extern int usb_stor_Bulk_reset(struct us_data*);extern unsigned int usb_stor_transfer_length(Scsi_Cmnd*);extern void usb_stor_invoke_transport(Scsi_Cmnd*, struct us_data*);extern int usb_stor_transfer_partial(struct us_data*, char*, int);extern int usb_stor_bulk_msg(struct us_data*, void*, int, unsigned int,		unsigned int*);extern int usb_stor_control_msg(struct us_data*, unsigned int, u8, u8,		u16, u16, void*, u16);extern int usb_stor_clear_halt(struct us_data*, int );extern void usb_stor_transfer(Scsi_Cmnd*, struct us_data*);#endif