[deliverable/linux.git] / drivers / message / fusion / mptctl.h

/*
 *  linux/drivers/message/fusion/mptioctl.h
 *      Fusion MPT misc device (ioctl) driver.
 *      For use with PCI chip/adapter(s):
 *          LSIFC9xx/LSI409xx Fibre Channel
 *      running LSI Logic Fusion MPT (Message Passing Technology) firmware.
 *
 *  Copyright (c) 1999-2005 LSI Logic Corporation
 *  (mailto:mpt_linux_developer@lsil.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
*/

#ifndef MPTCTL_H_INCLUDED
#define MPTCTL_H_INCLUDED
/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/


/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
/*
 *
 */
#define MPT_MISCDEV_BASENAME            "mptctl"
#define MPT_MISCDEV_PATHNAME            "/dev/" MPT_MISCDEV_BASENAME

#define MPT_PRODUCT_LENGTH              12

/*
 *  Generic MPT Control IOCTLs and structures
 */
#define MPT_MAGIC_NUMBER	'm'

#define MPTRWPERF		_IOWR(MPT_MAGIC_NUMBER,0,struct mpt_raw_r_w)

#define MPTFWDOWNLOAD		_IOWR(MPT_MAGIC_NUMBER,15,struct mpt_fw_xfer)
#define MPTCOMMAND		_IOWR(MPT_MAGIC_NUMBER,20,struct mpt_ioctl_command)

#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
#define MPTFWDOWNLOAD32		_IOWR(MPT_MAGIC_NUMBER,15,struct mpt_fw_xfer32)
#define MPTCOMMAND32		_IOWR(MPT_MAGIC_NUMBER,20,struct mpt_ioctl_command32)
#endif

#define MPTIOCINFO		_IOWR(MPT_MAGIC_NUMBER,17,struct mpt_ioctl_iocinfo)
#define MPTIOCINFO1		_IOWR(MPT_MAGIC_NUMBER,17,struct mpt_ioctl_iocinfo_rev0)
#define MPTIOCINFO2		_IOWR(MPT_MAGIC_NUMBER,17,struct mpt_ioctl_iocinfo_rev1)
#define MPTTARGETINFO		_IOWR(MPT_MAGIC_NUMBER,18,struct mpt_ioctl_targetinfo)
#define MPTTEST			_IOWR(MPT_MAGIC_NUMBER,19,struct mpt_ioctl_test)
#define MPTEVENTQUERY		_IOWR(MPT_MAGIC_NUMBER,21,struct mpt_ioctl_eventquery)
#define MPTEVENTENABLE		_IOWR(MPT_MAGIC_NUMBER,22,struct mpt_ioctl_eventenable)
#define MPTEVENTREPORT		_IOWR(MPT_MAGIC_NUMBER,23,struct mpt_ioctl_eventreport)
#define MPTHARDRESET		_IOWR(MPT_MAGIC_NUMBER,24,struct mpt_ioctl_diag_reset)
#define MPTFWREPLACE		_IOWR(MPT_MAGIC_NUMBER,25,struct mpt_ioctl_replace_fw)

/*
 * SPARC PLATFORM REMARKS:
 * IOCTL data structures that contain pointers
 * will have different sizes in the driver and applications
 * (as the app. will not use 8-byte pointers).
 * Apps should use MPTFWDOWNLOAD and MPTCOMMAND.
 * The driver will convert data from
 * mpt_fw_xfer32 (mpt_ioctl_command32) to mpt_fw_xfer (mpt_ioctl_command)
 * internally.
 *
 * If data structures change size, must handle as in IOCGETINFO.
 */
struct mpt_fw_xfer {
	unsigned int	 iocnum;	/* IOC unit number */
	unsigned int	 fwlen;
	void		__user *bufp;	/* Pointer to firmware buffer */
};

#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
struct mpt_fw_xfer32 {
	unsigned int iocnum;
	unsigned int fwlen;
	u32 bufp;
};
#endif	/*}*/

/*
 *  IOCTL header structure.
 *  iocnum - must be defined.
 *  port - must be defined for all IOCTL commands other than MPTIOCINFO
 *  maxDataSize - ignored on MPTCOMMAND commands
 *		- ignored on MPTFWREPLACE commands
 *		- on query commands, reports the maximum number of bytes to be returned
 *		  to the host driver (count includes the header).
 *		  That is, set to sizeof(struct mpt_ioctl_iocinfo) for fixed sized commands.
 *		  Set to sizeof(struct mpt_ioctl_targetinfo) + datasize for variable
 *			sized commands. (MPTTARGETINFO, MPTEVENTREPORT)
 */
typedef struct _mpt_ioctl_header {
	unsigned int	 iocnum;	/* IOC unit number */
	unsigned int	 port;		/* IOC port number */
	int		 maxDataSize;	/* Maximum Num. bytes to transfer on read */
} mpt_ioctl_header;

/*
 * Issue a diagnostic reset
 */
struct mpt_ioctl_diag_reset {
	mpt_ioctl_header hdr;
};


/*
 *  PCI bus/device/function information structure.
 */
struct mpt_ioctl_pci_info {
	union {
		struct {
			unsigned int  deviceNumber   :  5;
			unsigned int  functionNumber :  3;
			unsigned int  busNumber      : 24;
		} bits;
		unsigned int  asUlong;
	} u;
};

struct mpt_ioctl_pci_info2 {
	union {
		struct {
			unsigned int  deviceNumber   :  5;
			unsigned int  functionNumber :  3;
			unsigned int  busNumber      : 24;
		} bits;
		unsigned int  asUlong;
	} u;
  int segmentID;
};

/*
 *  Adapter Information Page
 *  Read only.
 *  Data starts at offset 0xC
 */
#define MPT_IOCTL_INTERFACE_SCSI	(0x00)
#define MPT_IOCTL_INTERFACE_FC		(0x01)
#define MPT_IOCTL_INTERFACE_FC_IP	(0x02)
#define MPT_IOCTL_INTERFACE_SAS		(0x03)
#define MPT_IOCTL_VERSION_LENGTH	(32)

struct mpt_ioctl_iocinfo {
	mpt_ioctl_header hdr;
	int		 adapterType;	/* SCSI or FCP */
	int		 port;		/* port number */
	int		 pciId;		/* PCI Id. */
	int		 hwRev;		/* hardware revision */
	int		 subSystemDevice;	/* PCI subsystem Device ID */
	int		 subSystemVendor;	/* PCI subsystem Vendor ID */
	int		 numDevices;		/* number of devices */
	int		 FWVersion;		/* FW Version (integer) */
	int		 BIOSVersion;		/* BIOS Version (integer) */
	char		 driverVersion[MPT_IOCTL_VERSION_LENGTH];	/* Driver Version (string) */
	char		 busChangeEvent;
	char		 hostId;
	char		 rsvd[2];
	struct mpt_ioctl_pci_info2  pciInfo; /* Added Rev 2 */
};

struct mpt_ioctl_iocinfo_rev1 {
	mpt_ioctl_header hdr;
	int		 adapterType;	/* SCSI or FCP */
	int		 port;		/* port number */
	int		 pciId;		/* PCI Id. */
	int		 hwRev;		/* hardware revision */
	int		 subSystemDevice;	/* PCI subsystem Device ID */
	int		 subSystemVendor;	/* PCI subsystem Vendor ID */
	int		 numDevices;		/* number of devices */
	int		 FWVersion;		/* FW Version (integer) */
	int		 BIOSVersion;		/* BIOS Version (integer) */
	char		 driverVersion[MPT_IOCTL_VERSION_LENGTH];	/* Driver Version (string) */
	char		 busChangeEvent;
	char		 hostId;
	char		 rsvd[2];
	struct mpt_ioctl_pci_info  pciInfo; /* Added Rev 1 */
};

/* Original structure, must always accept these
 * IOCTLs. 4 byte pads can occur based on arch with
 * above structure. Wish to re-align, but cannot.
 */
struct mpt_ioctl_iocinfo_rev0 {
	mpt_ioctl_header hdr;
	int		 adapterType;	/* SCSI or FCP */
	int		 port;		/* port number */
	int		 pciId;		/* PCI Id. */
	int		 hwRev;		/* hardware revision */
	int		 subSystemDevice;	/* PCI subsystem Device ID */
	int		 subSystemVendor;	/* PCI subsystem Vendor ID */
	int		 numDevices;		/* number of devices */
	int		 FWVersion;		/* FW Version (integer) */
	int		 BIOSVersion;		/* BIOS Version (integer) */
	char		 driverVersion[MPT_IOCTL_VERSION_LENGTH];	/* Driver Version (string) */
	char		 busChangeEvent;
	char		 hostId;
	char		 rsvd[2];
};

/*
 * Device Information Page
 * Report the number of, and ids of, all targets
 * on this IOC.  The ids array is a packed structure
 * of the known targetInfo.
 * bits 31-24: reserved
 *      23-16: LUN
 *      15- 8: Bus Number
 *       7- 0: Target ID
 */
struct mpt_ioctl_targetinfo {
	mpt_ioctl_header hdr;
	int		 numDevices;	/* Num targets on this ioc */
	int		 targetInfo[1];
};


/*
 * Event reporting IOCTL's.  These IOCTL's will
 * use the following defines:
 */
struct mpt_ioctl_eventquery {
	mpt_ioctl_header hdr;
	unsigned short	 eventEntries;
	unsigned short	 reserved;
	unsigned int	 eventTypes;
};

struct mpt_ioctl_eventenable {
	mpt_ioctl_header hdr;
	unsigned int	 eventTypes;
};

#ifndef __KERNEL__
typedef struct {
	uint	event;
	uint	eventContext;
	uint	data[2];
} MPT_IOCTL_EVENTS;
#endif

struct mpt_ioctl_eventreport {
	mpt_ioctl_header	hdr;
	MPT_IOCTL_EVENTS	eventData[1];
};

#define MPT_MAX_NAME	32
struct mpt_ioctl_test {
	mpt_ioctl_header hdr;
	u8		 name[MPT_MAX_NAME];
	int		 chip_type;
	u8		 product [MPT_PRODUCT_LENGTH];
};

/* Replace the FW image cached in host driver memory
 * newImageSize - image size in bytes
 * newImage - first byte of the new image
 */
typedef struct mpt_ioctl_replace_fw {
	mpt_ioctl_header hdr;
	int		 newImageSize;
	u8		 newImage[1];
} mpt_ioctl_replace_fw_t;

/* General MPT Pass through data strucutre
 *
 * iocnum
 * timeout - in seconds, command timeout. If 0, set by driver to
 *		default value.
 * replyFrameBufPtr - reply location
 * dataInBufPtr - destination for read
 * dataOutBufPtr - data source for write
 * senseDataPtr - sense data location
 * maxReplyBytes - maximum number of reply bytes to be sent to app.
 * dataInSize - num bytes for data transfer in (read)
 * dataOutSize - num bytes for data transfer out (write)
 * dataSgeOffset - offset in words from the start of the request message
 *		to the first SGL
 * MF[1];
 *
 * Remark:  Some config pages have bi-directional transfer,
 * both a read and a write. The basic structure allows for
 * a bidirectional set up. Normal messages will have one or
 * both of these buffers NULL.
 */
struct mpt_ioctl_command {
	mpt_ioctl_header hdr;
	int		timeout;	/* optional (seconds) */
	char		__user *replyFrameBufPtr;
	char		__user *dataInBufPtr;
	char		__user *dataOutBufPtr;
	char		__user *senseDataPtr;
	int		maxReplyBytes;
	int		dataInSize;
	int		dataOutSize;
	int		maxSenseBytes;
	int		dataSgeOffset;
	char		MF[1];
};

/*
 * SPARC PLATFORM: See earlier remark.
 */
#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
struct mpt_ioctl_command32 {
	mpt_ioctl_header hdr;
	int	timeout;
	u32	replyFrameBufPtr;
	u32	dataInBufPtr;
	u32	dataOutBufPtr;
	u32	senseDataPtr;
	int	maxReplyBytes;
	int	dataInSize;
	int	dataOutSize;
	int	maxSenseBytes;
	int	dataSgeOffset;
	char	MF[1];
};
#endif	/*}*/


/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
/*
 *	HP Specific IOCTL Defines and Structures
 */

#define CPQFCTS_IOC_MAGIC 'Z'
#define HP_IOC_MAGIC 'Z'
#define HP_GETHOSTINFO		_IOR(HP_IOC_MAGIC, 20, hp_host_info_t)
#define HP_GETHOSTINFO1		_IOR(HP_IOC_MAGIC, 20, hp_host_info_rev0_t)
#define HP_GETTARGETINFO	_IOR(HP_IOC_MAGIC, 21, hp_target_info_t)

/* All HP IOCTLs must include this header
 */
typedef struct _hp_header {
	unsigned int iocnum;
	unsigned int host;
	unsigned int channel;
	unsigned int id;
	unsigned int lun;
} hp_header_t;

/*
 *  Header:
 *  iocnum 	required (input)
 *  host 	ignored
 *  channe	ignored
 *  id		ignored
 *  lun		ignored
 */
typedef struct _hp_host_info {
	hp_header_t	 hdr;
	u16		 vendor;
	u16		 device;
	u16		 subsystem_vendor;
	u16		 subsystem_id;
	u8		 devfn;
	u8		 bus;
	ushort		 host_no;		/* SCSI Host number, if scsi driver not loaded*/
	u8		 fw_version[16];	/* string */
	u8		 serial_number[24];	/* string */
	u32		 ioc_status;
	u32		 bus_phys_width;
	u32		 base_io_addr;
	u32		 rsvd;
	unsigned int	 hard_resets;		/* driver initiated resets */
	unsigned int	 soft_resets;		/* ioc, external resets */
	unsigned int	 timeouts;		/* num timeouts */
} hp_host_info_t;

/* replace ulongs with uints, need to preserve backwards
 * compatibility.
 */
typedef struct _hp_host_info_rev0 {
	hp_header_t	 hdr;
	u16		 vendor;
	u16		 device;
	u16		 subsystem_vendor;
	u16		 subsystem_id;
	u8		 devfn;
	u8		 bus;
	ushort		 host_no;		/* SCSI Host number, if scsi driver not loaded*/
	u8		 fw_version[16];	/* string */
	u8		 serial_number[24];	/* string */
	u32		 ioc_status;
	u32		 bus_phys_width;
	u32		 base_io_addr;
	u32		 rsvd;
	unsigned long	 hard_resets;		/* driver initiated resets */
	unsigned long	 soft_resets;		/* ioc, external resets */
	unsigned long	 timeouts;		/* num timeouts */
} hp_host_info_rev0_t;

/*
 *  Header:
 *  iocnum 	required (input)
 *  host 	required
 *  channel	required	(bus number)
 *  id		required
 *  lun		ignored
 *
 *  All error values between 0 and 0xFFFF in size.
 */
typedef struct _hp_target_info {
	hp_header_t	 hdr;
	u32 parity_errors;
	u32 phase_errors;
	u32 select_timeouts;
	u32 message_rejects;
	u32 negotiated_speed;
	u8  negotiated_width;
	u8  rsvd[7];				/* 8 byte alignment */
} hp_target_info_t;

#define HP_STATUS_OTHER		1
#define HP_STATUS_OK		2
#define HP_STATUS_FAILED	3

#define HP_BUS_WIDTH_UNK	1
#define HP_BUS_WIDTH_8		2
#define HP_BUS_WIDTH_16		3
#define HP_BUS_WIDTH_32		4

#define HP_DEV_SPEED_ASYNC	2
#define HP_DEV_SPEED_FAST	3
#define HP_DEV_SPEED_ULTRA	4
#define HP_DEV_SPEED_ULTRA2	5
#define HP_DEV_SPEED_ULTRA160	6
#define HP_DEV_SPEED_SCSI1	7
#define HP_DEV_SPEED_ULTRA320	8

/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/


/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/drivers/message/fusion/mptioctl.h
	3	* Fusion MPT misc device (ioctl) driver.
	4	* For use with PCI chip/adapter(s):
	5	* LSIFC9xx/LSI409xx Fibre Channel
	6	* running LSI Logic Fusion MPT (Message Passing Technology) firmware.
	7	*
b6fe4ddc	8	* Copyright (c) 1999-2005 LSI Logic Corporation
1da177e4 LT	9	* (mailto:mpt_linux_developer@lsil.com)
1da177e4 LT	10	*
1da177e4 LT	11	*/
	12	/=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=/
	13	/*
	14	This program is free software; you can redistribute it and/or modify
	15	it under the terms of the GNU General Public License as published by
	16	the Free Software Foundation; version 2 of the License.
	17
	18	This program is distributed in the hope that it will be useful,
	19	but WITHOUT ANY WARRANTY; without even the implied warranty of
	20	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	21	GNU General Public License for more details.
	22
	23	NO WARRANTY
	24	THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
	25	CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
	26	LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
	27	MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
	28	solely responsible for determining the appropriateness of using and
	29	distributing the Program and assumes all risks associated with its
	30	exercise of rights under this Agreement, including but not limited to
	31	the risks and costs of program errors, damage to or loss of data,
	32	programs or equipment, and unavailability or interruption of operations.
	33
	34	DISCLAIMER OF LIABILITY
	35	NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
	36	DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	37	DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
	38	ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
	39	TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
	40	USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
	41	HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
	42
	43	You should have received a copy of the GNU General Public License
	44	along with this program; if not, write to the Free Software
	45	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	46	*/
	47
	48	#ifndef MPTCTL_H_INCLUDED
	49	#define MPTCTL_H_INCLUDED
	50	/=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=/
	51
1da177e4 LT	52
	53
	54	/=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=/
	55	/*
	56	*
	57	*/
	58	#define MPT_MISCDEV_BASENAME "mptctl"
	59	#define MPT_MISCDEV_PATHNAME "/dev/" MPT_MISCDEV_BASENAME
	60
	61	#define MPT_PRODUCT_LENGTH 12
	62
	63	/*
	64	* Generic MPT Control IOCTLs and structures
	65	*/
	66	#define MPT_MAGIC_NUMBER 'm'
	67
	68	#define MPTRWPERF _IOWR(MPT_MAGIC_NUMBER,0,struct mpt_raw_r_w)
	69
	70	#define MPTFWDOWNLOAD _IOWR(MPT_MAGIC_NUMBER,15,struct mpt_fw_xfer)
	71	#define MPTCOMMAND _IOWR(MPT_MAGIC_NUMBER,20,struct mpt_ioctl_command)
	72
	73	#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
	74	#define MPTFWDOWNLOAD32 _IOWR(MPT_MAGIC_NUMBER,15,struct mpt_fw_xfer32)
	75	#define MPTCOMMAND32 _IOWR(MPT_MAGIC_NUMBER,20,struct mpt_ioctl_command32)
	76	#endif
	77
	78	#define MPTIOCINFO _IOWR(MPT_MAGIC_NUMBER,17,struct mpt_ioctl_iocinfo)
	79	#define MPTIOCINFO1 _IOWR(MPT_MAGIC_NUMBER,17,struct mpt_ioctl_iocinfo_rev0)
	80	#define MPTIOCINFO2 _IOWR(MPT_MAGIC_NUMBER,17,struct mpt_ioctl_iocinfo_rev1)
	81	#define MPTTARGETINFO _IOWR(MPT_MAGIC_NUMBER,18,struct mpt_ioctl_targetinfo)
	82	#define MPTTEST _IOWR(MPT_MAGIC_NUMBER,19,struct mpt_ioctl_test)
	83	#define MPTEVENTQUERY _IOWR(MPT_MAGIC_NUMBER,21,struct mpt_ioctl_eventquery)
	84	#define MPTEVENTENABLE _IOWR(MPT_MAGIC_NUMBER,22,struct mpt_ioctl_eventenable)
	85	#define MPTEVENTREPORT _IOWR(MPT_MAGIC_NUMBER,23,struct mpt_ioctl_eventreport)
	86	#define MPTHARDRESET _IOWR(MPT_MAGIC_NUMBER,24,struct mpt_ioctl_diag_reset)
	87	#define MPTFWREPLACE _IOWR(MPT_MAGIC_NUMBER,25,struct mpt_ioctl_replace_fw)
	88
	89	/*
	90	* SPARC PLATFORM REMARKS:
	91	* IOCTL data structures that contain pointers
	92	* will have different sizes in the driver and applications
	93	* (as the app. will not use 8-byte pointers).
	94	* Apps should use MPTFWDOWNLOAD and MPTCOMMAND.
	95	* The driver will convert data from
	96	* mpt_fw_xfer32 (mpt_ioctl_command32) to mpt_fw_xfer (mpt_ioctl_command)
	97	* internally.
	98	*
	99	* If data structures change size, must handle as in IOCGETINFO.
	100	*/
	101	struct mpt_fw_xfer {
	102	unsigned int iocnum; /* IOC unit number */
	103	unsigned int fwlen;
	104	void __user bufp; / Pointer to firmware buffer */
	105	};
	106
	107	#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
	108	struct mpt_fw_xfer32 {
	109	unsigned int iocnum;
	110	unsigned int fwlen;
	111	u32 bufp;
	112	};
	113	#endif /}/
	114
	115	/*
116	* IOCTL header structure.
117	* iocnum - must be defined.
118	* port - must be defined for all IOCTL commands other than MPTIOCINFO
119	* maxDataSize - ignored on MPTCOMMAND commands
120	* - ignored on MPTFWREPLACE commands
121	* - on query commands, reports the maximum number of bytes to be returned
122	* to the host driver (count includes the header).
123	* That is, set to sizeof(struct mpt_ioctl_iocinfo) for fixed sized commands.
124	* Set to sizeof(struct mpt_ioctl_targetinfo) + datasize for variable
125	* sized commands. (MPTTARGETINFO, MPTEVENTREPORT)
126	*/
127	typedef struct _mpt_ioctl_header {
128	unsigned int iocnum; /* IOC unit number */
129	unsigned int port; /* IOC port number */
130	int maxDataSize; /* Maximum Num. bytes to transfer on read */
131	} mpt_ioctl_header;
132
133	/*
134	* Issue a diagnostic reset
135	*/
136	struct mpt_ioctl_diag_reset {
137	mpt_ioctl_header hdr;
138	};
139
140
141	/*
142	* PCI bus/device/function information structure.
143	*/
144	struct mpt_ioctl_pci_info {
145	union {
146	struct {
147	unsigned int deviceNumber : 5;
148	unsigned int functionNumber : 3;
149	unsigned int busNumber : 24;
150	} bits;
151	unsigned int asUlong;
152	} u;
153	};
154
155	struct mpt_ioctl_pci_info2 {
156	union {
157	struct {
158	unsigned int deviceNumber : 5;
159	unsigned int functionNumber : 3;
160	unsigned int busNumber : 24;
161	} bits;
162	unsigned int asUlong;
163	} u;
164	int segmentID;
165	};
166
167	/*
168	* Adapter Information Page
169	* Read only.
170	* Data starts at offset 0xC
171	*/
1da177e4	172	#define MPT_IOCTL_INTERFACE_SCSI (0x00)
9cc1cfbc ME	173	#define MPT_IOCTL_INTERFACE_FC (0x01)
	174	#define MPT_IOCTL_INTERFACE_FC_IP (0x02)
	175	#define MPT_IOCTL_INTERFACE_SAS (0x03)
1da177e4 LT	176	#define MPT_IOCTL_VERSION_LENGTH (32)
	177
	178	struct mpt_ioctl_iocinfo {
	179	mpt_ioctl_header hdr;
	180	int adapterType; /* SCSI or FCP */
	181	int port; /* port number */
	182	int pciId; /* PCI Id. */
	183	int hwRev; /* hardware revision */
	184	int subSystemDevice; /* PCI subsystem Device ID */
	185	int subSystemVendor; /* PCI subsystem Vendor ID */
	186	int numDevices; /* number of devices */
	187	int FWVersion; /* FW Version (integer) */
	188	int BIOSVersion; /* BIOS Version (integer) */
	189	char driverVersion[MPT_IOCTL_VERSION_LENGTH]; /* Driver Version (string) */
	190	char busChangeEvent;
	191	char hostId;
	192	char rsvd[2];
	193	struct mpt_ioctl_pci_info2 pciInfo; /* Added Rev 2 */
	194	};
	195
	196	struct mpt_ioctl_iocinfo_rev1 {
	197	mpt_ioctl_header hdr;
	198	int adapterType; /* SCSI or FCP */
	199	int port; /* port number */
	200	int pciId; /* PCI Id. */
	201	int hwRev; /* hardware revision */
	202	int subSystemDevice; /* PCI subsystem Device ID */
	203	int subSystemVendor; /* PCI subsystem Vendor ID */
	204	int numDevices; /* number of devices */
	205	int FWVersion; /* FW Version (integer) */
	206	int BIOSVersion; /* BIOS Version (integer) */
	207	char driverVersion[MPT_IOCTL_VERSION_LENGTH]; /* Driver Version (string) */
	208	char busChangeEvent;
	209	char hostId;
	210	char rsvd[2];
	211	struct mpt_ioctl_pci_info pciInfo; /* Added Rev 1 */
	212	};
	213
	214	/* Original structure, must always accept these
	215	* IOCTLs. 4 byte pads can occur based on arch with
	216	* above structure. Wish to re-align, but cannot.
	217	*/
	218	struct mpt_ioctl_iocinfo_rev0 {
	219	mpt_ioctl_header hdr;
	220	int adapterType; /* SCSI or FCP */
	221	int port; /* port number */
	222	int pciId; /* PCI Id. */
	223	int hwRev; /* hardware revision */
	224	int subSystemDevice; /* PCI subsystem Device ID */
	225	int subSystemVendor; /* PCI subsystem Vendor ID */
	226	int numDevices; /* number of devices */
	227	int FWVersion; /* FW Version (integer) */
	228	int BIOSVersion; /* BIOS Version (integer) */
	229	char driverVersion[MPT_IOCTL_VERSION_LENGTH]; /* Driver Version (string) */
	230	char busChangeEvent;
	231	char hostId;
	232	char rsvd[2];
	233	};
	234
	235	/*
	236	* Device Information Page
	237	* Report the number of, and ids of, all targets
	238	* on this IOC. The ids array is a packed structure
	239	* of the known targetInfo.
240	* bits 31-24: reserved
241	* 23-16: LUN
242	* 15- 8: Bus Number
243	* 7- 0: Target ID
244	*/
245	struct mpt_ioctl_targetinfo {
246	mpt_ioctl_header hdr;
247	int numDevices; /* Num targets on this ioc */
248	int targetInfo[1];
249	};
250
251
252	/*
253	* Event reporting IOCTL's. These IOCTL's will
254	* use the following defines:
255	*/
256	struct mpt_ioctl_eventquery {
257	mpt_ioctl_header hdr;
258	unsigned short eventEntries;
259	unsigned short reserved;
260	unsigned int eventTypes;
261	};
262
263	struct mpt_ioctl_eventenable {
264	mpt_ioctl_header hdr;
265	unsigned int eventTypes;
266	};
267
268	#ifndef __KERNEL__
269	typedef struct {
270	uint event;
271	uint eventContext;
272	uint data[2];
273	} MPT_IOCTL_EVENTS;
274	#endif
275
276	struct mpt_ioctl_eventreport {
277	mpt_ioctl_header hdr;
278	MPT_IOCTL_EVENTS eventData[1];
279	};
280
281	#define MPT_MAX_NAME 32
282	struct mpt_ioctl_test {
283	mpt_ioctl_header hdr;
284	u8 name[MPT_MAX_NAME];
285	int chip_type;
286	u8 product [MPT_PRODUCT_LENGTH];
287	};
288
289	/* Replace the FW image cached in host driver memory
290	* newImageSize - image size in bytes
291	* newImage - first byte of the new image
292	*/
293	typedef struct mpt_ioctl_replace_fw {
294	mpt_ioctl_header hdr;
295	int newImageSize;
296	u8 newImage[1];
297	} mpt_ioctl_replace_fw_t;
298
299	/* General MPT Pass through data strucutre
300	*
301	* iocnum
302	* timeout - in seconds, command timeout. If 0, set by driver to
303	* default value.
304	* replyFrameBufPtr - reply location
305	* dataInBufPtr - destination for read
306	* dataOutBufPtr - data source for write
307	* senseDataPtr - sense data location
308	* maxReplyBytes - maximum number of reply bytes to be sent to app.
309	* dataInSize - num bytes for data transfer in (read)
310	* dataOutSize - num bytes for data transfer out (write)
311	* dataSgeOffset - offset in words from the start of the request message
312	* to the first SGL
313	* MF[1];
314	*
315	* Remark: Some config pages have bi-directional transfer,
316	* both a read and a write. The basic structure allows for
317	* a bidirectional set up. Normal messages will have one or
318	* both of these buffers NULL.
319	*/
320	struct mpt_ioctl_command {
321	mpt_ioctl_header hdr;
322	int timeout; /* optional (seconds) */
323	char __user *replyFrameBufPtr;
324	char __user *dataInBufPtr;
325	char __user *dataOutBufPtr;
326	char __user *senseDataPtr;
327	int maxReplyBytes;
328	int dataInSize;
329	int dataOutSize;
330	int maxSenseBytes;
331	int dataSgeOffset;
332	char MF[1];
333	};
334
335	/*
336	* SPARC PLATFORM: See earlier remark.
337	*/
338	#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
339	struct mpt_ioctl_command32 {
340	mpt_ioctl_header hdr;
341	int timeout;
342	u32 replyFrameBufPtr;
343	u32 dataInBufPtr;
344	u32 dataOutBufPtr;
345	u32 senseDataPtr;
346	int maxReplyBytes;
347	int dataInSize;
348	int dataOutSize;
349	int maxSenseBytes;
350	int dataSgeOffset;
351	char MF[1];
352	};
353	#endif /}/
354
355
356	/=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=/
357	/*
358	* HP Specific IOCTL Defines and Structures
359	*/
360
361	#define CPQFCTS_IOC_MAGIC 'Z'
362	#define HP_IOC_MAGIC 'Z'
363	#define HP_GETHOSTINFO _IOR(HP_IOC_MAGIC, 20, hp_host_info_t)
364	#define HP_GETHOSTINFO1 _IOR(HP_IOC_MAGIC, 20, hp_host_info_rev0_t)
365	#define HP_GETTARGETINFO _IOR(HP_IOC_MAGIC, 21, hp_target_info_t)
366
367	/* All HP IOCTLs must include this header
368	*/
369	typedef struct _hp_header {
370	unsigned int iocnum;
371	unsigned int host;
372	unsigned int channel;
373	unsigned int id;
374	unsigned int lun;
375	} hp_header_t;
376
377	/*
378	* Header:
379	* iocnum required (input)
380	* host ignored
381	* channe ignored
382	* id ignored
383	* lun ignored
384	*/
385	typedef struct _hp_host_info {
386	hp_header_t hdr;
387	u16 vendor;
388	u16 device;
389	u16 subsystem_vendor;
390	u16 subsystem_id;
391	u8 devfn;
392	u8 bus;
393	ushort host_no; /* SCSI Host number, if scsi driver not loaded*/
394	u8 fw_version[16]; /* string */
395	u8 serial_number[24]; /* string */
396	u32 ioc_status;
397	u32 bus_phys_width;
398	u32 base_io_addr;
399	u32 rsvd;
400	unsigned int hard_resets; /* driver initiated resets */
401	unsigned int soft_resets; /* ioc, external resets */
402	unsigned int timeouts; /* num timeouts */
403	} hp_host_info_t;
404
405	/* replace ulongs with uints, need to preserve backwards
406	* compatibility.
407	*/
408	typedef struct _hp_host_info_rev0 {
409	hp_header_t hdr;
410	u16 vendor;
411	u16 device;
412	u16 subsystem_vendor;
413	u16 subsystem_id;
414	u8 devfn;
415	u8 bus;
416	ushort host_no; /* SCSI Host number, if scsi driver not loaded*/
417	u8 fw_version[16]; /* string */
418	u8 serial_number[24]; /* string */
419	u32 ioc_status;
420	u32 bus_phys_width;
421	u32 base_io_addr;
422	u32 rsvd;
423	unsigned long hard_resets; /* driver initiated resets */
424	unsigned long soft_resets; /* ioc, external resets */
425	unsigned long timeouts; /* num timeouts */
426	} hp_host_info_rev0_t;
427
428	/*
429	* Header:
430	* iocnum required (input)
431	* host required
432	* channel required (bus number)
433	* id required
434	* lun ignored
435	*
436	* All error values between 0 and 0xFFFF in size.
437	*/
438	typedef struct _hp_target_info {
439	hp_header_t hdr;
440	u32 parity_errors;
441	u32 phase_errors;
442	u32 select_timeouts;
443	u32 message_rejects;
444	u32 negotiated_speed;
445	u8 negotiated_width;
446	u8 rsvd[7]; /* 8 byte alignment */
447	} hp_target_info_t;
448
449	#define HP_STATUS_OTHER 1
450	#define HP_STATUS_OK 2
451	#define HP_STATUS_FAILED 3
452
453	#define HP_BUS_WIDTH_UNK 1
454	#define HP_BUS_WIDTH_8 2
455	#define HP_BUS_WIDTH_16 3
456	#define HP_BUS_WIDTH_32 4
457
458	#define HP_DEV_SPEED_ASYNC 2
459	#define HP_DEV_SPEED_FAST 3
460	#define HP_DEV_SPEED_ULTRA 4
461	#define HP_DEV_SPEED_ULTRA2 5
462	#define HP_DEV_SPEED_ULTRA160 6
463	#define HP_DEV_SPEED_SCSI1 7
464	#define HP_DEV_SPEED_ULTRA320 8
465
466	/=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=/
467
468
469	/=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=/
470
471	#endif
472