/*    3w-xxxx.h -- 3ware Storage Controller device driver for Linux.      Written By: Adam Radford <linux@3ware.com>   Modifications By: Joel Jacobson <linux@3ware.com>   		     Arnaldo Carvalho de Melo <acme@conectiva.com.br>                     Brad Strand <linux@3ware.com>   Copyright (C) 1999-2002 3ware Inc.   Kernel compatablity By:	Andre Hedrick <andre@suse.com>   Non-Copyright (C) 2000	Andre Hedrick <andre@suse.com>   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; version 2 of the License.   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.                                 NO WARRANTY                                                                  THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR           CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT         LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,         MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is       solely responsible for determining the appropriateness of using and          distributing the Program and assumes all risks associated with its           exercise of rights under this Agreement, including but not limited to        the risks and costs of program errors, damage to or loss of data,            programs or equipment, and unavailability or interruption of operations.     DISCLAIMER OF LIABILITY                                                      NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY      DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL           DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND      ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR        TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE       USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED     HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES                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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA    Bugs/Comments/Suggestions should be mailed to:                               linux@3ware.com      For more information, goto:   http://www.3ware.com*/#ifndef _3W_XXXX_H#define _3W_XXXX_H#include <linux/version.h>#include <linux/types.h>#include <linux/kdev_t.h>/* AEN strings */static char *tw_aen_string[] = {	"AEN queue empty",                      // 0x000	"Soft reset occurred",                  // 0x001	"Unit degraded: Unit #",                // 0x002	"Controller error",                     // 0x003 	"Rebuild failed: Unit #",               // 0x004	"Rebuild complete: Unit #",             // 0x005	"Incomplete unit detected: Unit #",     // 0x006	"Initialization complete: Unit #",      // 0x007	"Unclean shutdown detected: Unit #",    // 0x008	"ATA port timeout: Port #",             // 0x009	"Drive error: Port #",                  // 0x00A	"Rebuild started: Unit #",              // 0x00B 	"Initialization started: Unit #",       // 0x00C	"Logical unit deleted: Unit #",         // 0x00D	NULL,                                   // 0x00E unused	"SMART threshold exceeded: Port #",     // 0x00F	NULL, NULL, NULL, NULL, NULL,	NULL, NULL, NULL, NULL, NULL,	NULL, NULL, NULL, NULL, NULL,	NULL, NULL,                             // 0x010-0x020 unused	"ATA UDMA downgrade: Port #",           // 0x021	"ATA UDMA upgrade: Port #",             // 0x022	"Sector repair occurred: Port #",       // 0x023	"SBUF integrity check failure",         // 0x024	"Lost cached write: Port #",            // 0x025	"Drive ECC error detected: Port #",     // 0x026	"DCB checksum error: Port #",           // 0x027	"DCB unsupported version: Port #",      // 0x028	"Verify started: Unit #",               // 0x029	"Verify failed: Port #",                // 0x02A	"Verify complete: Unit #",              // 0x02B	"Overwrote bad sector during rebuild: Port #",  //0x2C	"Encountered bad sector during rebuild: Port #" //0x2D};#define TW_AEN_STRING_MAX                      0x02E/* Control register bit definitions */#define TW_CONTROL_CLEAR_HOST_INTERRUPT	       0x00080000#define TW_CONTROL_CLEAR_ATTENTION_INTERRUPT   0x00040000#define TW_CONTROL_MASK_COMMAND_INTERRUPT      0x00020000#define TW_CONTROL_MASK_RESPONSE_INTERRUPT     0x00010000#define TW_CONTROL_UNMASK_COMMAND_INTERRUPT    0x00008000#define TW_CONTROL_UNMASK_RESPONSE_INTERRUPT   0x00004000#define TW_CONTROL_CLEAR_ERROR_STATUS	       0x00000200#define TW_CONTROL_ISSUE_SOFT_RESET	       0x00000100#define TW_CONTROL_ENABLE_INTERRUPTS	       0x00000080#define TW_CONTROL_DISABLE_INTERRUPTS	       0x00000040#define TW_CONTROL_ISSUE_HOST_INTERRUPT	       0x00000020#define TW_CONTROL_CLEAR_PARITY_ERROR          0x00800000#define TW_CONTROL_CLEAR_PCI_ABORT             0x00100000/* Status register bit definitions */#define TW_STATUS_MAJOR_VERSION_MASK	       0xF0000000#define TW_STATUS_MINOR_VERSION_MASK	       0x0F000000#define TW_STATUS_PCI_PARITY_ERROR	       0x00800000#define TW_STATUS_QUEUE_ERROR		       0x00400000#define TW_STATUS_MICROCONTROLLER_ERROR	       0x00200000#define TW_STATUS_PCI_ABORT		       0x00100000#define TW_STATUS_HOST_INTERRUPT	       0x00080000#define TW_STATUS_ATTENTION_INTERRUPT	       0x00040000#define TW_STATUS_COMMAND_INTERRUPT	       0x00020000#define TW_STATUS_RESPONSE_INTERRUPT	       0x00010000#define TW_STATUS_COMMAND_QUEUE_FULL	       0x00008000#define TW_STATUS_RESPONSE_QUEUE_EMPTY	       0x00004000#define TW_STATUS_MICROCONTROLLER_READY	       0x00002000#define TW_STATUS_COMMAND_QUEUE_EMPTY	       0x00001000#define TW_STATUS_ALL_INTERRUPTS	       0x000F0000#define TW_STATUS_CLEARABLE_BITS	       0x00D00000#define TW_STATUS_EXPECTED_BITS		       0x00002000#define TW_STATUS_UNEXPECTED_BITS	       0x00F80000/* RESPONSE QUEUE BIT DEFINITIONS */#define TW_RESPONSE_ID_MASK		       0x00000FF0/* PCI related defines */#define TW_IO_ADDRESS_RANGE		       0xD#define TW_DEVICE_NAME			       "3ware Storage Controller"#define TW_VENDOR_ID (0x13C1)	/* 3ware */#define TW_DEVICE_ID (0x1000)	/* Storage Controller */#define TW_DEVICE_ID2 (0x1001)  /* 7000 series controller */#define TW_NUMDEVICES 2#define TW_PCI_CLEAR_PARITY_ERRORS 0xc100#define TW_PCI_CLEAR_PCI_ABORT     0x2000/* Command packet opcodes */#define TW_OP_NOP	      0x0#define TW_OP_INIT_CONNECTION 0x1#define TW_OP_READ	      0x2#define TW_OP_WRITE	      0x3#define TW_OP_VERIFY	      0x4#define TW_OP_GET_PARAM	      0x12#define TW_OP_SET_PARAM	      0x13#define TW_OP_SECTOR_INFO     0x1a#define TW_OP_AEN_LISTEN      0x1c#define TW_CMD_PACKET         0x1d#define TW_ATA_PASSTHRU       0x1e#define TW_CMD_PACKET_WITH_DATA 0x1f/* Asynchronous Event Notification (AEN) Codes */#define TW_AEN_QUEUE_EMPTY       0x0000#define TW_AEN_SOFT_RESET        0x0001#define TW_AEN_DEGRADED_MIRROR   0x0002#define TW_AEN_CONTROLLER_ERROR  0x0003#define TW_AEN_REBUILD_FAIL      0x0004#define TW_AEN_REBUILD_DONE      0x0005#define TW_AEN_QUEUE_FULL        0x00ff#define TW_AEN_TABLE_UNDEFINED   0x15#define TW_AEN_APORT_TIMEOUT     0x0009#define TW_AEN_DRIVE_ERROR       0x000A#define TW_AEN_SMART_FAIL        0x000F#define TW_AEN_SBUF_FAIL         0x0024/* Misc defines */#define TW_ALIGNMENT			      0x200 /* 16 D-WORDS */#define TW_MAX_UNITS			      16#define TW_COMMAND_ALIGNMENT_MASK	      0x1ff#define TW_INIT_MESSAGE_CREDITS		      0x100#define TW_INIT_COMMAND_PACKET_SIZE	      0x3#define TW_POLL_MAX_RETRIES        	      20000#define TW_MAX_SGL_LENGTH		      62#define TW_ATA_PASS_SGL_MAX                   60#define TW_MAX_PASSTHRU_BYTES                 4096#define TW_Q_LENGTH			      256#define TW_MAX_BOUNCEBUF                      16#define TW_Q_START			      0#define TW_MAX_SLOT			      32#define TW_MAX_PCI_BUSES		      255#define TW_MAX_RESET_TRIES		      3#define TW_UNIT_INFORMATION_TABLE_BASE	      0x300#define TW_MAX_CMDS_PER_LUN		      (TW_Q_LENGTH-2)/TW_MAX_UNITS#define TW_BLOCK_SIZE			      0x200 /* 512-byte blocks */#define TW_IOCTL                              0x80#define TW_MAX_AEN_TRIES                      100#define TW_UNIT_ONLINE                        1#define TW_IN_INTR                            1#define TW_MAX_SECTORS                        256#define TW_MAX_BOUNCE_SECTORS                 128#define TW_AEN_WAIT_TIME                      1000#define TW_IOCTL_WAIT_TIME                    (1 * HZ) /* 1 second */#define TW_MAX_CDB_LEN                        16/* Macros */#define TW_STATUS_ERRORS(x) \	(((x & TW_STATUS_PCI_ABORT) || \	(x & TW_STATUS_PCI_PARITY_ERROR) || \	(x & TW_STATUS_QUEUE_ERROR) || \	(x & TW_STATUS_MICROCONTROLLER_ERROR)) && \	(x & TW_STATUS_MICROCONTROLLER_READY))#ifdef TW_DEBUG#define dprintk(msg...) printk(msg)#else#define dprintk(msg...) do { } while(0);#endif/* Scatter Gather List Entry */typedef struct TAG_TW_SG_Entry {	unsigned long address;	unsigned long length;} TW_SG_Entry;typedef unsigned char TW_Sector[512];/* Command Packet */typedef struct TW_Command {	/* First DWORD */	struct {		unsigned char opcode:5;		unsigned char sgl_offset:3;	} byte0;	unsigned char size;	unsigned char request_id;	struct {		unsigned char unit:4;		unsigned char host_id:4;