[linux.git] / drivers / block / cciss_cmd.h

#ifndef CCISS_CMD_H
#define CCISS_CMD_H

#include <linux/cciss_defs.h>

/* DEFINES */
#define CISS_VERSION "1.00"

/* general boundary definitions */
#define MAXSGENTRIES            32
#define CCISS_SG_CHAIN          0x80000000
#define MAXREPLYQS              256

/* Unit Attentions ASC's as defined for the MSA2012sa */
#define POWER_OR_RESET			0x29
#define STATE_CHANGED			0x2a
#define UNIT_ATTENTION_CLEARED		0x2f
#define LUN_FAILED			0x3e
#define REPORT_LUNS_CHANGED		0x3f

/* Unit Attentions ASCQ's as defined for the MSA2012sa */

	/* These ASCQ's defined for ASC = POWER_OR_RESET */
#define POWER_ON_RESET			0x00
#define POWER_ON_REBOOT			0x01
#define SCSI_BUS_RESET			0x02
#define MSA_TARGET_RESET		0x03
#define CONTROLLER_FAILOVER		0x04
#define TRANSCEIVER_SE			0x05
#define TRANSCEIVER_LVD			0x06

	/* These ASCQ's defined for ASC = STATE_CHANGED */
#define RESERVATION_PREEMPTED		0x03
#define ASYM_ACCESS_CHANGED		0x06
#define LUN_CAPACITY_CHANGED		0x09

/* config space register offsets */
#define CFG_VENDORID            0x00
#define CFG_DEVICEID            0x02
#define CFG_I2OBAR              0x10
#define CFG_MEM1BAR             0x14

/* i2o space register offsets */
#define I2O_IBDB_SET            0x20
#define I2O_IBDB_CLEAR          0x70
#define I2O_INT_STATUS          0x30
#define I2O_INT_MASK            0x34
#define I2O_IBPOST_Q            0x40
#define I2O_OBPOST_Q            0x44
#define I2O_DMA1_CFG		0x214

/* Configuration Table */
#define CFGTBL_ChangeReq        0x00000001l
#define CFGTBL_AccCmds          0x00000001l
#define DOORBELL_CTLR_RESET     0x00000004l

#define CFGTBL_Trans_Simple     0x00000002l
#define CFGTBL_Trans_Performant 0x00000004l

#define CFGTBL_BusType_Ultra2   0x00000001l
#define CFGTBL_BusType_Ultra3   0x00000002l
#define CFGTBL_BusType_Fibre1G  0x00000100l
#define CFGTBL_BusType_Fibre2G  0x00000200l
typedef struct _vals32
{
        __u32   lower;
        __u32   upper;
} vals32;

typedef union _u64bit
{
   vals32	val32;
   __u64	val;
} u64bit;

/* Type defs used in the following structs */
#define QWORD vals32 

/* STRUCTURES */
#define CISS_MAX_PHYS_LUN	1024
/* SCSI-3 Cmmands */

#pragma pack(1)	

#define CISS_INQUIRY 0x12
/* Date returned */
typedef struct _InquiryData_struct
{
  BYTE data_byte[36];
} InquiryData_struct;

#define CISS_REPORT_LOG 0xc2    /* Report Logical LUNs */
#define CISS_REPORT_PHYS 0xc3   /* Report Physical LUNs */
/* Data returned */
typedef struct _ReportLUNdata_struct
{
  BYTE LUNListLength[4];
  DWORD reserved;
  BYTE LUN[CISS_MAX_LUN][8];
} ReportLunData_struct;

#define CCISS_READ_CAPACITY 0x25 /* Read Capacity */ 
typedef struct _ReadCapdata_struct
{
  BYTE total_size[4];	/* Total size in blocks */
  BYTE block_size[4];	/* Size of blocks in bytes */
} ReadCapdata_struct;

#define CCISS_READ_CAPACITY_16 0x9e /* Read Capacity 16 */

/* service action to differentiate a 16 byte read capacity from
   other commands that use the 0x9e SCSI op code */

#define CCISS_READ_CAPACITY_16_SERVICE_ACT 0x10

typedef struct _ReadCapdata_struct_16
{
	BYTE total_size[8];   /* Total size in blocks */
	BYTE block_size[4];   /* Size of blocks in bytes */
	BYTE prot_en:1;       /* protection enable bit */
	BYTE rto_en:1;        /* reference tag own enable bit */
	BYTE reserved:6;      /* reserved bits */
	BYTE reserved2[18];   /* reserved bytes per spec */
} ReadCapdata_struct_16;

/* Define the supported read/write commands for cciss based controllers */

#define CCISS_READ_10   0x28    /* Read(10)  */
#define CCISS_WRITE_10  0x2a    /* Write(10) */
#define CCISS_READ_16   0x88    /* Read(16)  */
#define CCISS_WRITE_16  0x8a    /* Write(16) */

/* Define the CDB lengths supported by cciss based controllers */

#define CDB_LEN10	10
#define CDB_LEN16	16

/* BMIC commands */
#define BMIC_READ 0x26
#define BMIC_WRITE 0x27
#define BMIC_CACHE_FLUSH 0xc2
#define CCISS_CACHE_FLUSH 0x01	/* C2 was already being used by CCISS */

/* Command List Structure */
#define CTLR_LUNID "\0\0\0\0\0\0\0\0"

typedef struct _CommandListHeader_struct {
  BYTE              ReplyQueue;
  BYTE              SGList;
  HWORD             SGTotal;
  QWORD             Tag;
  LUNAddr_struct    LUN;
} CommandListHeader_struct;
typedef struct _ErrDescriptor_struct {
  QWORD  Addr;
  DWORD  Len;
} ErrDescriptor_struct;
typedef struct _SGDescriptor_struct {
  QWORD  Addr;
  DWORD  Len;
  DWORD  Ext;
} SGDescriptor_struct;

/* Command types */
#define CMD_RWREQ       0x00
#define CMD_IOCTL_PEND  0x01
#define CMD_SCSI	0x03
#define CMD_MSG_DONE	0x04
#define CMD_MSG_TIMEOUT 0x05
#define CMD_MSG_STALE	0xff

/* This structure needs to be divisible by COMMANDLIST_ALIGNMENT
 * because low bits of the address are used to to indicate that
 * whether the tag contains an index or an address.  PAD_32 and
 * PAD_64 can be adjusted independently as needed for 32-bit
 * and 64-bits systems.
 */
#define COMMANDLIST_ALIGNMENT (32)
#define IS_64_BIT ((sizeof(long) - 4)/4)
#define IS_32_BIT (!IS_64_BIT)
#define PAD_32 (0)
#define PAD_64 (4)
#define PADSIZE (IS_32_BIT * PAD_32 + IS_64_BIT * PAD_64)
#define DIRECT_LOOKUP_BIT 0x10
#define DIRECT_LOOKUP_SHIFT 5

typedef struct _CommandList_struct {
  CommandListHeader_struct Header;
  RequestBlock_struct      Request;
  ErrDescriptor_struct     ErrDesc;
  SGDescriptor_struct      SG[MAXSGENTRIES];
	/* information associated with the command */ 
  __u32			   busaddr; /* physical address of this record */
  ErrorInfo_struct * 	   err_info; /* pointer to the allocated mem */ 
  int			   ctlr;
  int			   cmd_type; 
  long			   cmdindex;
  struct list_head list;
  struct request *	   rq;
  struct completion *waiting;
  int	 retry_count;
  void * scsi_cmd;
  char pad[PADSIZE];
} CommandList_struct;

/* Configuration Table Structure */
typedef struct _HostWrite_struct {
  DWORD TransportRequest;
  DWORD Reserved;
  DWORD CoalIntDelay;
  DWORD CoalIntCount;
} HostWrite_struct;

typedef struct _CfgTable_struct {
  BYTE             Signature[4];
  DWORD            SpecValence;
#define SIMPLE_MODE	0x02
#define PERFORMANT_MODE	0x04
#define MEMQ_MODE	0x08
  DWORD            TransportSupport;
  DWORD            TransportActive;
  HostWrite_struct HostWrite;
  DWORD            CmdsOutMax;
  DWORD            BusTypes;
  DWORD            TransMethodOffset;
  BYTE             ServerName[16];
  DWORD            HeartBeat;
  DWORD            SCSI_Prefetch;
  DWORD            MaxSGElements;
  DWORD            MaxLogicalUnits;
  DWORD            MaxPhysicalDrives;
  DWORD            MaxPhysicalDrivesPerLogicalUnit;
  DWORD            MaxPerformantModeCommands;
  u8		   reserved[0x78 - 0x58];
  u32		   misc_fw_support; /* offset 0x78 */
#define MISC_FW_DOORBELL_RESET (0x02)
} CfgTable_struct;

struct TransTable_struct {
  u32 BlockFetch0;
  u32 BlockFetch1;
  u32 BlockFetch2;
  u32 BlockFetch3;
  u32 BlockFetch4;
  u32 BlockFetch5;
  u32 BlockFetch6;
  u32 BlockFetch7;
  u32 RepQSize;
  u32 RepQCount;
  u32 RepQCtrAddrLow32;
  u32 RepQCtrAddrHigh32;
  u32 RepQAddr0Low32;
  u32 RepQAddr0High32;
};

#pragma pack()	 
#endif /* CCISS_CMD_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef CCISS_CMD_H
1da177e4 LT	2	#define CCISS_CMD_H
429c42c9	3
	4	#include <linux/cciss_defs.h>
	5
b028461d	6	/* DEFINES */
1da177e4 LT	7	#define CISS_VERSION "1.00"
1da177e4 LT	8
b028461d	9	/* general boundary definitions */
5c07a311 DB	10	#define MAXSGENTRIES 32
5c07a311 DB	11	#define CCISS_SG_CHAIN 0x80000000
1da177e4 LT	12	#define MAXREPLYQS 256
1da177e4 LT	13
0a9279cc MM	14	/* Unit Attentions ASC's as defined for the MSA2012sa */
	15	#define POWER_OR_RESET 0x29
	16	#define STATE_CHANGED 0x2a
	17	#define UNIT_ATTENTION_CLEARED 0x2f
	18	#define LUN_FAILED 0x3e
	19	#define REPORT_LUNS_CHANGED 0x3f
	20
	21	/* Unit Attentions ASCQ's as defined for the MSA2012sa */
	22
	23	/* These ASCQ's defined for ASC = POWER_OR_RESET */
	24	#define POWER_ON_RESET 0x00
	25	#define POWER_ON_REBOOT 0x01
	26	#define SCSI_BUS_RESET 0x02
	27	#define MSA_TARGET_RESET 0x03
	28	#define CONTROLLER_FAILOVER 0x04
	29	#define TRANSCEIVER_SE 0x05
	30	#define TRANSCEIVER_LVD 0x06
	31
	32	/* These ASCQ's defined for ASC = STATE_CHANGED */
	33	#define RESERVATION_PREEMPTED 0x03
	34	#define ASYM_ACCESS_CHANGED 0x06
	35	#define LUN_CAPACITY_CHANGED 0x09
	36
b028461d	37	/* config space register offsets */
1da177e4 LT	38	#define CFG_VENDORID 0x00
	39	#define CFG_DEVICEID 0x02
	40	#define CFG_I2OBAR 0x10
	41	#define CFG_MEM1BAR 0x14
	42
b028461d	43	/* i2o space register offsets */
1da177e4 LT	44	#define I2O_IBDB_SET 0x20
	45	#define I2O_IBDB_CLEAR 0x70
	46	#define I2O_INT_STATUS 0x30
	47	#define I2O_INT_MASK 0x34
	48	#define I2O_IBPOST_Q 0x40
	49	#define I2O_OBPOST_Q 0x44
f92e2f5f	50	#define I2O_DMA1_CFG 0x214
1da177e4	51
b028461d	52	/* Configuration Table */
1da177e4 LT	53	#define CFGTBL_ChangeReq 0x00000001l
1da177e4 LT	54	#define CFGTBL_AccCmds 0x00000001l
a6528d01	55	#define DOORBELL_CTLR_RESET 0x00000004l
1da177e4 LT	56
1da177e4 LT	57	#define CFGTBL_Trans_Simple 0x00000002l
5e216153	58	#define CFGTBL_Trans_Performant 0x00000004l
1da177e4 LT	59
	60	#define CFGTBL_BusType_Ultra2 0x00000001l
	61	#define CFGTBL_BusType_Ultra3 0x00000002l
	62	#define CFGTBL_BusType_Fibre1G 0x00000100l
	63	#define CFGTBL_BusType_Fibre2G 0x00000200l
	64	typedef struct _vals32
	65	{
	66	__u32 lower;
	67	__u32 upper;
	68	} vals32;
	69
	70	typedef union _u64bit
	71	{
	72	vals32 val32;
	73	__u64 val;
	74	} u64bit;
	75
b028461d	76	/* Type defs used in the following structs */
1da177e4 LT	77	#define QWORD vals32
1da177e4 LT	78
b028461d	79	/* STRUCTURES */
1da177e4	80	#define CISS_MAX_PHYS_LUN 1024
b028461d	81	/* SCSI-3 Cmmands */
1da177e4 LT	82
	83	#pragma pack(1)
	84
	85	#define CISS_INQUIRY 0x12
b028461d	86	/* Date returned */
1da177e4 LT	87	typedef struct _InquiryData_struct
	88	{
	89	BYTE data_byte[36];
	90	} InquiryData_struct;
	91
	92	#define CISS_REPORT_LOG 0xc2 /* Report Logical LUNs */
	93	#define CISS_REPORT_PHYS 0xc3 /* Report Physical LUNs */
b028461d	94	/* Data returned */
1da177e4 LT	95	typedef struct _ReportLUNdata_struct
	96	{
	97	BYTE LUNListLength[4];
	98	DWORD reserved;
	99	BYTE LUN[CISS_MAX_LUN][8];
	100	} ReportLunData_struct;
	101
	102	#define CCISS_READ_CAPACITY 0x25 /* Read Capacity */
	103	typedef struct _ReadCapdata_struct
	104	{
b028461d	105	BYTE total_size[4]; /* Total size in blocks */
b028461d	106	BYTE block_size[4]; /* Size of blocks in bytes */
1da177e4 LT	107	} ReadCapdata_struct;
1da177e4 LT	108
00988a35 MMOD	109	#define CCISS_READ_CAPACITY_16 0x9e /* Read Capacity 16 */
	110
	111	/* service action to differentiate a 16 byte read capacity from
	112	other commands that use the 0x9e SCSI op code */
	113
	114	#define CCISS_READ_CAPACITY_16_SERVICE_ACT 0x10
	115
	116	typedef struct _ReadCapdata_struct_16
	117	{
	118	BYTE total_size[8]; /* Total size in blocks */
	119	BYTE block_size[4]; /* Size of blocks in bytes */
	120	BYTE prot_en:1; /* protection enable bit */
	121	BYTE rto_en:1; /* reference tag own enable bit */
	122	BYTE reserved:6; /* reserved bits */
	123	BYTE reserved2[18]; /* reserved bytes per spec */
	124	} ReadCapdata_struct_16;
	125
	126	/* Define the supported read/write commands for cciss based controllers */
	127
	128	#define CCISS_READ_10 0x28 /* Read(10) */
	129	#define CCISS_WRITE_10 0x2a /* Write(10) */
	130	#define CCISS_READ_16 0x88 /* Read(16) */
	131	#define CCISS_WRITE_16 0x8a /* Write(16) */
	132
	133	/* Define the CDB lengths supported by cciss based controllers */
	134
	135	#define CDB_LEN10 10
	136	#define CDB_LEN16 16
1da177e4	137
b028461d	138	/* BMIC commands */
1da177e4 LT	139	#define BMIC_READ 0x26
	140	#define BMIC_WRITE 0x27
	141	#define BMIC_CACHE_FLUSH 0xc2
b028461d	142	#define CCISS_CACHE_FLUSH 0x01 /* C2 was already being used by CCISS */
1da177e4	143
b028461d	144	/* Command List Structure */
b57695fe	145	#define CTLR_LUNID "\0\0\0\0\0\0\0\0"
b57695fe	146
1da177e4 LT	147	typedef struct _CommandListHeader_struct {
	148	BYTE ReplyQueue;
	149	BYTE SGList;
	150	HWORD SGTotal;
	151	QWORD Tag;
	152	LUNAddr_struct LUN;
	153	} CommandListHeader_struct;
1da177e4 LT	154	typedef struct _ErrDescriptor_struct {
	155	QWORD Addr;
	156	DWORD Len;
	157	} ErrDescriptor_struct;
	158	typedef struct _SGDescriptor_struct {
	159	QWORD Addr;
	160	DWORD Len;
	161	DWORD Ext;
	162	} SGDescriptor_struct;
	163
1da177e4 LT	164	/* Command types */
	165	#define CMD_RWREQ 0x00
	166	#define CMD_IOCTL_PEND 0x01
	167	#define CMD_SCSI 0x03
	168	#define CMD_MSG_DONE 0x04
	169	#define CMD_MSG_TIMEOUT 0x05
b59e64d0	170	#define CMD_MSG_STALE 0xff
1da177e4	171
1b7d0d28 SC	172	/* This structure needs to be divisible by COMMANDLIST_ALIGNMENT
	173	* because low bits of the address are used to to indicate that
	174	* whether the tag contains an index or an address. PAD_32 and
	175	* PAD_64 can be adjusted independently as needed for 32-bit
	176	* and 64-bits systems.
33079b21	177	*/
5e216153	178	#define COMMANDLIST_ALIGNMENT (32)
58daa9ce SC	179	#define IS_64_BIT ((sizeof(long) - 4)/4)
58daa9ce SC	180	#define IS_32_BIT (!IS_64_BIT)
f3bcb143	181	#define PAD_32 (0)
58daa9ce SC	182	#define PAD_64 (4)
58daa9ce SC	183	#define PADSIZE (IS_32_BIT * PAD_32 + IS_64_BIT * PAD_64)
5e216153 MM	184	#define DIRECT_LOOKUP_BIT 0x10
	185	#define DIRECT_LOOKUP_SHIFT 5
	186
1da177e4 LT	187	typedef struct _CommandList_struct {
	188	CommandListHeader_struct Header;
	189	RequestBlock_struct Request;
	190	ErrDescriptor_struct ErrDesc;
	191	SGDescriptor_struct SG[MAXSGENTRIES];
	192	/* information associated with the command */
	193	__u32 busaddr; /* physical address of this record */
	194	ErrorInfo_struct * err_info; /* pointer to the allocated mem */
	195	int ctlr;
	196	int cmd_type;
33079b21	197	long cmdindex;
e6e1ee93	198	struct list_head list;
1da177e4 LT	199	struct request * rq;
	200	struct completion *waiting;
	201	int retry_count;
1da177e4	202	void * scsi_cmd;
5e216153	203	char pad[PADSIZE];
1da177e4 LT	204	} CommandList_struct;
1da177e4 LT	205
b028461d	206	/* Configuration Table Structure */
1da177e4 LT	207	typedef struct _HostWrite_struct {
	208	DWORD TransportRequest;
	209	DWORD Reserved;
	210	DWORD CoalIntDelay;
	211	DWORD CoalIntCount;
	212	} HostWrite_struct;
	213
	214	typedef struct _CfgTable_struct {
	215	BYTE Signature[4];
	216	DWORD SpecValence;
5e216153 MM	217	#define SIMPLE_MODE 0x02
	218	#define PERFORMANT_MODE 0x04
	219	#define MEMQ_MODE 0x08
1da177e4 LT	220	DWORD TransportSupport;
	221	DWORD TransportActive;
	222	HostWrite_struct HostWrite;
	223	DWORD CmdsOutMax;
	224	DWORD BusTypes;
5e216153	225	DWORD TransMethodOffset;
1da177e4 LT	226	BYTE ServerName[16];
	227	DWORD HeartBeat;
	228	DWORD SCSI_Prefetch;
5c07a311 DB	229	DWORD MaxSGElements;
	230	DWORD MaxLogicalUnits;
	231	DWORD MaxPhysicalDrives;
	232	DWORD MaxPhysicalDrivesPerLogicalUnit;
5e216153	233	DWORD MaxPerformantModeCommands;
a6528d01 SC	234	u8 reserved[0x78 - 0x58];
	235	u32 misc_fw_support; /* offset 0x78 */
	236	#define MISC_FW_DOORBELL_RESET (0x02)
1da177e4	237	} CfgTable_struct;
5e216153 MM	238
	239	struct TransTable_struct {
	240	u32 BlockFetch0;
	241	u32 BlockFetch1;
	242	u32 BlockFetch2;
	243	u32 BlockFetch3;
	244	u32 BlockFetch4;
	245	u32 BlockFetch5;
	246	u32 BlockFetch6;
	247	u32 BlockFetch7;
	248	u32 RepQSize;
	249	u32 RepQCount;
	250	u32 RepQCtrAddrLow32;
	251	u32 RepQCtrAddrHigh32;
	252	u32 RepQAddr0Low32;
	253	u32 RepQAddr0High32;
	254	};
	255
1da177e4	256	#pragma pack()
b028461d	257	#endif /* CCISS_CMD_H */