[net-next-2.6.git] / include / linux / cciss_ioctl.h

#ifndef CCISS_IOCTLH
#define CCISS_IOCTLH

#include <linux/types.h>
#include <linux/ioctl.h>

#define CCISS_IOC_MAGIC 'B'


typedef struct _cciss_pci_info_struct
{
	unsigned char 	bus;
	unsigned char 	dev_fn;
	unsigned short	domain;
	__u32 		board_id;
} cciss_pci_info_struct; 

typedef struct _cciss_coalint_struct
{
	__u32  delay;
	__u32  count;
} cciss_coalint_struct;

typedef char NodeName_type[16];

typedef __u32 Heartbeat_type;

#define CISS_PARSCSIU2 	0x0001
#define CISS_PARCSCIU3 	0x0002
#define CISS_FIBRE1G	0x0100
#define CISS_FIBRE2G	0x0200
typedef __u32 BusTypes_type;

typedef char FirmwareVer_type[4];
typedef __u32 DriverVer_type;

#define MAX_KMALLOC_SIZE 128000

#ifndef CCISS_CMD_H
// This defines are duplicated in cciss_cmd.h in the driver directory 

//general boundary defintions
#define SENSEINFOBYTES          32//note that this value may vary between host implementations

//Command Status value
#define CMD_SUCCESS             0x0000
#define CMD_TARGET_STATUS       0x0001
#define CMD_DATA_UNDERRUN       0x0002
#define CMD_DATA_OVERRUN        0x0003
#define CMD_INVALID             0x0004
#define CMD_PROTOCOL_ERR        0x0005
#define CMD_HARDWARE_ERR        0x0006
#define CMD_CONNECTION_LOST     0x0007
#define CMD_ABORTED             0x0008
#define CMD_ABORT_FAILED        0x0009
#define CMD_UNSOLICITED_ABORT   0x000A
#define CMD_TIMEOUT             0x000B
#define CMD_UNABORTABLE		0x000C

//transfer direction
#define XFER_NONE               0x00
#define XFER_WRITE              0x01
#define XFER_READ               0x02
#define XFER_RSVD               0x03

//task attribute
#define ATTR_UNTAGGED           0x00
#define ATTR_SIMPLE             0x04
#define ATTR_HEADOFQUEUE        0x05
#define ATTR_ORDERED            0x06
#define ATTR_ACA                0x07

//cdb type
#define TYPE_CMD				0x00
#define TYPE_MSG				0x01

// Type defs used in the following structs
#define BYTE __u8
#define WORD __u16
#define HWORD __u16
#define DWORD __u32

#define CISS_MAX_LUN	16	

#define LEVEL2LUN   1   // index into Target(x) structure, due to byte swapping
#define LEVEL3LUN   0

#pragma pack(1)

//Command List Structure
typedef union _SCSI3Addr_struct {
   struct {
    BYTE Dev;
    BYTE Bus:6;
    BYTE Mode:2;        // b00
  } PeripDev;
   struct {
    BYTE DevLSB;
    BYTE DevMSB:6;
    BYTE Mode:2;        // b01
  } LogDev;
   struct {
    BYTE Dev:5;
    BYTE Bus:3;
    BYTE Targ:6;
    BYTE Mode:2;        // b10
  } LogUnit;
} SCSI3Addr_struct;

typedef struct _PhysDevAddr_struct {
  DWORD             TargetId:24;
  DWORD             Bus:6;
  DWORD             Mode:2;
  SCSI3Addr_struct  Target[2]; //2 level target device addr
} PhysDevAddr_struct;
  
typedef struct _LogDevAddr_struct {
  DWORD            VolId:30;
  DWORD            Mode:2;
  BYTE             reserved[4];
} LogDevAddr_struct;

typedef union _LUNAddr_struct {
  BYTE               LunAddrBytes[8];
  SCSI3Addr_struct   SCSI3Lun[4];
  PhysDevAddr_struct PhysDev;
  LogDevAddr_struct  LogDev;
} LUNAddr_struct;

typedef struct _RequestBlock_struct {
  BYTE   CDBLen;
  struct {
    BYTE Type:3;
    BYTE Attribute:3;
    BYTE Direction:2;
  } Type;
  HWORD  Timeout;
  BYTE   CDB[16];
} RequestBlock_struct;

typedef union _MoreErrInfo_struct{
  struct {
    BYTE  Reserved[3];
    BYTE  Type;
    DWORD ErrorInfo;
  }Common_Info;
  struct{
    BYTE  Reserved[2];
    BYTE  offense_size;//size of offending entry
    BYTE  offense_num; //byte # of offense 0-base
    DWORD offense_value;
  }Invalid_Cmd;
}MoreErrInfo_struct;
typedef struct _ErrorInfo_struct {
  BYTE               ScsiStatus;
  BYTE               SenseLen;
  HWORD              CommandStatus;
  DWORD              ResidualCnt;
  MoreErrInfo_struct MoreErrInfo;
  BYTE               SenseInfo[SENSEINFOBYTES];
} ErrorInfo_struct;

#pragma pack()
#endif /* CCISS_CMD_H */ 

typedef struct _IOCTL_Command_struct {
  LUNAddr_struct	   LUN_info;
  RequestBlock_struct      Request;
  ErrorInfo_struct  	   error_info; 
  WORD			   buf_size;  /* size in bytes of the buf */
  BYTE			   __user *buf;
} IOCTL_Command_struct;

typedef struct _BIG_IOCTL_Command_struct {
  LUNAddr_struct	   LUN_info;
  RequestBlock_struct      Request;
  ErrorInfo_struct  	   error_info;
  DWORD			   malloc_size; /* < MAX_KMALLOC_SIZE in cciss.c */
  DWORD			   buf_size;    /* size in bytes of the buf */
  				        /* < malloc_size * MAXSGENTRIES */
  BYTE			   __user *buf;
} BIG_IOCTL_Command_struct;

typedef struct _LogvolInfo_struct{
	__u32	LunID;
	int	num_opens;  /* number of opens on the logical volume */
	int	num_parts;  /* number of partitions configured on logvol */
} LogvolInfo_struct;

#define CCISS_GETPCIINFO _IOR(CCISS_IOC_MAGIC, 1, cciss_pci_info_struct)

#define CCISS_GETINTINFO _IOR(CCISS_IOC_MAGIC, 2, cciss_coalint_struct)
#define CCISS_SETINTINFO _IOW(CCISS_IOC_MAGIC, 3, cciss_coalint_struct)

#define CCISS_GETNODENAME _IOR(CCISS_IOC_MAGIC, 4, NodeName_type)
#define CCISS_SETNODENAME _IOW(CCISS_IOC_MAGIC, 5, NodeName_type)

#define CCISS_GETHEARTBEAT _IOR(CCISS_IOC_MAGIC, 6, Heartbeat_type)
#define CCISS_GETBUSTYPES  _IOR(CCISS_IOC_MAGIC, 7, BusTypes_type)
#define CCISS_GETFIRMVER   _IOR(CCISS_IOC_MAGIC, 8, FirmwareVer_type)
#define CCISS_GETDRIVVER   _IOR(CCISS_IOC_MAGIC, 9, DriverVer_type)
#define CCISS_REVALIDVOLS  _IO(CCISS_IOC_MAGIC, 10)
#define CCISS_PASSTHRU	   _IOWR(CCISS_IOC_MAGIC, 11, IOCTL_Command_struct)
#define CCISS_DEREGDISK	   _IO(CCISS_IOC_MAGIC, 12)

/* no longer used... use REGNEWD instead */ 
#define CCISS_REGNEWDISK  _IOW(CCISS_IOC_MAGIC, 13, int)

#define CCISS_REGNEWD	   _IO(CCISS_IOC_MAGIC, 14)
#define CCISS_RESCANDISK   _IO(CCISS_IOC_MAGIC, 16)
#define CCISS_GETLUNINFO   _IOR(CCISS_IOC_MAGIC, 17, LogvolInfo_struct)
#define CCISS_BIG_PASSTHRU _IOWR(CCISS_IOC_MAGIC, 18, BIG_IOCTL_Command_struct)

#ifdef __KERNEL__
#ifdef CONFIG_COMPAT

/* 32 bit compatible ioctl structs */
typedef struct _IOCTL32_Command_struct {
  LUNAddr_struct	   LUN_info;
  RequestBlock_struct      Request;
  ErrorInfo_struct  	   error_info;
  WORD			   buf_size;  /* size in bytes of the buf */
  __u32			   buf; /* 32 bit pointer to data buffer */
} IOCTL32_Command_struct;

typedef struct _BIG_IOCTL32_Command_struct {
  LUNAddr_struct	   LUN_info;
  RequestBlock_struct      Request;
  ErrorInfo_struct  	   error_info;
  DWORD			   malloc_size; /* < MAX_KMALLOC_SIZE in cciss.c */
  DWORD			   buf_size;    /* size in bytes of the buf */
  				        /* < malloc_size * MAXSGENTRIES */
  __u32 		buf;	/* 32 bit pointer to data buffer */
} BIG_IOCTL32_Command_struct;

#define CCISS_PASSTHRU32   _IOWR(CCISS_IOC_MAGIC, 11, IOCTL32_Command_struct)
#define CCISS_BIG_PASSTHRU32 _IOWR(CCISS_IOC_MAGIC, 18, BIG_IOCTL32_Command_struct)

#endif /* CONFIG_COMPAT */
#endif /* __KERNEL__ */
#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef CCISS_IOCTLH
	2	#define CCISS_IOCTLH
	3
	4	#include <linux/types.h>
	5	#include <linux/ioctl.h>
	6
	7	#define CCISS_IOC_MAGIC 'B'
	8
	9
	10	typedef struct _cciss_pci_info_struct
	11	{
	12	unsigned char bus;
	13	unsigned char dev_fn;
7f0d5039	14	unsigned short domain;
1da177e4 LT	15	__u32 board_id;
	16	} cciss_pci_info_struct;
	17
	18	typedef struct _cciss_coalint_struct
	19	{
	20	__u32 delay;
	21	__u32 count;
	22	} cciss_coalint_struct;
	23
	24	typedef char NodeName_type[16];
	25
	26	typedef __u32 Heartbeat_type;
	27
	28	#define CISS_PARSCSIU2 0x0001
	29	#define CISS_PARCSCIU3 0x0002
	30	#define CISS_FIBRE1G 0x0100
	31	#define CISS_FIBRE2G 0x0200
	32	typedef __u32 BusTypes_type;
	33
	34	typedef char FirmwareVer_type[4];
	35	typedef __u32 DriverVer_type;
	36
	37	#define MAX_KMALLOC_SIZE 128000
	38
	39	#ifndef CCISS_CMD_H
	40	// This defines are duplicated in cciss_cmd.h in the driver directory
	41
	42	//general boundary defintions
	43	#define SENSEINFOBYTES 32//note that this value may vary between host implementations
	44
	45	//Command Status value
	46	#define CMD_SUCCESS 0x0000
	47	#define CMD_TARGET_STATUS 0x0001
	48	#define CMD_DATA_UNDERRUN 0x0002
	49	#define CMD_DATA_OVERRUN 0x0003
	50	#define CMD_INVALID 0x0004
	51	#define CMD_PROTOCOL_ERR 0x0005
	52	#define CMD_HARDWARE_ERR 0x0006
	53	#define CMD_CONNECTION_LOST 0x0007
	54	#define CMD_ABORTED 0x0008
	55	#define CMD_ABORT_FAILED 0x0009
	56	#define CMD_UNSOLICITED_ABORT 0x000A
	57	#define CMD_TIMEOUT 0x000B
	58	#define CMD_UNABORTABLE 0x000C
	59
	60	//transfer direction
	61	#define XFER_NONE 0x00
	62	#define XFER_WRITE 0x01
	63	#define XFER_READ 0x02
	64	#define XFER_RSVD 0x03
	65
	66	//task attribute
	67	#define ATTR_UNTAGGED 0x00
	68	#define ATTR_SIMPLE 0x04
	69	#define ATTR_HEADOFQUEUE 0x05
	70	#define ATTR_ORDERED 0x06
	71	#define ATTR_ACA 0x07
	72
	73	//cdb type
	74	#define TYPE_CMD 0x00
	75	#define TYPE_MSG 0x01
	76
	77	// Type defs used in the following structs
	78	#define BYTE __u8
79	#define WORD __u16
80	#define HWORD __u16
81	#define DWORD __u32
82
83	#define CISS_MAX_LUN 16
84
85	#define LEVEL2LUN 1 // index into Target(x) structure, due to byte swapping
86	#define LEVEL3LUN 0
87
88	#pragma pack(1)
89
90	//Command List Structure
91	typedef union _SCSI3Addr_struct {
92	struct {
93	BYTE Dev;
94	BYTE Bus:6;
95	BYTE Mode:2; // b00
96	} PeripDev;
97	struct {
98	BYTE DevLSB;
99	BYTE DevMSB:6;
100	BYTE Mode:2; // b01
101	} LogDev;
102	struct {
103	BYTE Dev:5;
104	BYTE Bus:3;
105	BYTE Targ:6;
106	BYTE Mode:2; // b10
107	} LogUnit;
108	} SCSI3Addr_struct;
109
110	typedef struct _PhysDevAddr_struct {
111	DWORD TargetId:24;
112	DWORD Bus:6;
113	DWORD Mode:2;
114	SCSI3Addr_struct Target[2]; //2 level target device addr
115	} PhysDevAddr_struct;
116
117	typedef struct _LogDevAddr_struct {
118	DWORD VolId:30;
119	DWORD Mode:2;
120	BYTE reserved[4];
121	} LogDevAddr_struct;
122
123	typedef union _LUNAddr_struct {
124	BYTE LunAddrBytes[8];
125	SCSI3Addr_struct SCSI3Lun[4];
126	PhysDevAddr_struct PhysDev;
127	LogDevAddr_struct LogDev;
128	} LUNAddr_struct;
129
130	typedef struct _RequestBlock_struct {
131	BYTE CDBLen;
132	struct {
133	BYTE Type:3;
134	BYTE Attribute:3;
135	BYTE Direction:2;
136	} Type;
137	HWORD Timeout;
138	BYTE CDB[16];
139	} RequestBlock_struct;
140
141	typedef union _MoreErrInfo_struct{
142	struct {
143	BYTE Reserved[3];
144	BYTE Type;
145	DWORD ErrorInfo;
146	}Common_Info;
147	struct{
148	BYTE Reserved[2];
149	BYTE offense_size;//size of offending entry
150	BYTE offense_num; //byte # of offense 0-base
151	DWORD offense_value;
152	}Invalid_Cmd;
153	}MoreErrInfo_struct;
154	typedef struct _ErrorInfo_struct {
155	BYTE ScsiStatus;
156	BYTE SenseLen;
157	HWORD CommandStatus;
158	DWORD ResidualCnt;
159	MoreErrInfo_struct MoreErrInfo;
160	BYTE SenseInfo[SENSEINFOBYTES];
161	} ErrorInfo_struct;
162
163	#pragma pack()
164	#endif /* CCISS_CMD_H */
165
166	typedef struct _IOCTL_Command_struct {
167	LUNAddr_struct LUN_info;
168	RequestBlock_struct Request;
169	ErrorInfo_struct error_info;
170	WORD buf_size; /* size in bytes of the buf */
171	BYTE __user *buf;
172	} IOCTL_Command_struct;
173
174	typedef struct _BIG_IOCTL_Command_struct {
175	LUNAddr_struct LUN_info;
176	RequestBlock_struct Request;
177	ErrorInfo_struct error_info;
178	DWORD malloc_size; /* < MAX_KMALLOC_SIZE in cciss.c */
179	DWORD buf_size; /* size in bytes of the buf */
180	/* < malloc_size * MAXSGENTRIES */
181	BYTE __user *buf;
182	} BIG_IOCTL_Command_struct;
183
184	typedef struct _LogvolInfo_struct{
185	__u32 LunID;
186	int num_opens; /* number of opens on the logical volume */
187	int num_parts; /* number of partitions configured on logvol */
188	} LogvolInfo_struct;
189
190	#define CCISS_GETPCIINFO _IOR(CCISS_IOC_MAGIC, 1, cciss_pci_info_struct)
191
192	#define CCISS_GETINTINFO _IOR(CCISS_IOC_MAGIC, 2, cciss_coalint_struct)
193	#define CCISS_SETINTINFO _IOW(CCISS_IOC_MAGIC, 3, cciss_coalint_struct)
194
195	#define CCISS_GETNODENAME _IOR(CCISS_IOC_MAGIC, 4, NodeName_type)
196	#define CCISS_SETNODENAME _IOW(CCISS_IOC_MAGIC, 5, NodeName_type)
197
198	#define CCISS_GETHEARTBEAT _IOR(CCISS_IOC_MAGIC, 6, Heartbeat_type)
199	#define CCISS_GETBUSTYPES _IOR(CCISS_IOC_MAGIC, 7, BusTypes_type)
200	#define CCISS_GETFIRMVER _IOR(CCISS_IOC_MAGIC, 8, FirmwareVer_type)
201	#define CCISS_GETDRIVVER _IOR(CCISS_IOC_MAGIC, 9, DriverVer_type)
202	#define CCISS_REVALIDVOLS _IO(CCISS_IOC_MAGIC, 10)
203	#define CCISS_PASSTHRU _IOWR(CCISS_IOC_MAGIC, 11, IOCTL_Command_struct)
204	#define CCISS_DEREGDISK _IO(CCISS_IOC_MAGIC, 12)
205
206	/* no longer used... use REGNEWD instead */
207	#define CCISS_REGNEWDISK _IOW(CCISS_IOC_MAGIC, 13, int)
208
209	#define CCISS_REGNEWD _IO(CCISS_IOC_MAGIC, 14)
210	#define CCISS_RESCANDISK _IO(CCISS_IOC_MAGIC, 16)
211	#define CCISS_GETLUNINFO _IOR(CCISS_IOC_MAGIC, 17, LogvolInfo_struct)
212	#define CCISS_BIG_PASSTHRU _IOWR(CCISS_IOC_MAGIC, 18, BIG_IOCTL_Command_struct)
213
214	#ifdef __KERNEL__
215	#ifdef CONFIG_COMPAT
216
217	/* 32 bit compatible ioctl structs */
218	typedef struct _IOCTL32_Command_struct {
219	LUNAddr_struct LUN_info;
220	RequestBlock_struct Request;
221	ErrorInfo_struct error_info;
222	WORD buf_size; /* size in bytes of the buf */
223	__u32 buf; /* 32 bit pointer to data buffer */
224	} IOCTL32_Command_struct;
225
226	typedef struct _BIG_IOCTL32_Command_struct {
227	LUNAddr_struct LUN_info;
228	RequestBlock_struct Request;
229	ErrorInfo_struct error_info;
230	DWORD malloc_size; /* < MAX_KMALLOC_SIZE in cciss.c */
231	DWORD buf_size; /* size in bytes of the buf */
232	/* < malloc_size * MAXSGENTRIES */
233	__u32 buf; /* 32 bit pointer to data buffer */
234	} BIG_IOCTL32_Command_struct;
235
236	#define CCISS_PASSTHRU32 _IOWR(CCISS_IOC_MAGIC, 11, IOCTL32_Command_struct)
237	#define CCISS_BIG_PASSTHRU32 _IOWR(CCISS_IOC_MAGIC, 18, BIG_IOCTL32_Command_struct)
238
239	#endif /* CONFIG_COMPAT */
240	#endif /* __KERNEL__ */
241	#endif