brintos

brintos / linux-shallow public Read only

0
0
Text · 31.3 KiB · b406fd6 Raw
1004 lines · c
1/*2 *  linux/drivers/message/fusion/mptbase.h3 *      High performance SCSI + LAN / Fibre Channel device drivers.4 *      For use with PCI chip/adapter(s):5 *          LSIFC9xx/LSI409xx Fibre Channel6 *      running LSI Fusion MPT (Message Passing Technology) firmware.7 *8 *  Copyright (c) 1999-2008 LSI Corporation9 *  (mailto:DL-MPTFusionLinux@lsi.com)10 *11 */12/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/13/*14    This program is free software; you can redistribute it and/or modify15    it under the terms of the GNU General Public License as published by16    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 of20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the21    GNU General Public License for more details.22 23    NO WARRANTY24    THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR25    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT26    LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,27    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is28    solely responsible for determining the appropriateness of using and29    distributing the Program and assumes all risks associated with its30    exercise of rights under this Agreement, including but not limited to31    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 LIABILITY35    NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY36    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL37    DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND38    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR39    TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE40    USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED41    HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES42 43    You should have received a copy of the GNU General Public License44    along with this program; if not, write to the Free Software45    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA46*/47 48#ifndef MPTBASE_H_INCLUDED49#define MPTBASE_H_INCLUDED50/*{-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/51 52#include <linux/kernel.h>53#include <linux/pci.h>54#include <linux/mutex.h>55 56#include "lsi/mpi_type.h"57#include "lsi/mpi.h"		/* Fusion MPI(nterface) basic defs */58#include "lsi/mpi_ioc.h"	/* Fusion MPT IOC(ontroller) defs */59#include "lsi/mpi_cnfg.h"	/* IOC configuration support */60#include "lsi/mpi_init.h"	/* SCSI Host (initiator) protocol support */61#include "lsi/mpi_lan.h"	/* LAN over FC protocol support */62#include "lsi/mpi_raid.h"	/* Integrated Mirroring support */63 64#include "lsi/mpi_fc.h"		/* Fibre Channel (lowlevel) support */65#include "lsi/mpi_targ.h"	/* SCSI/FCP Target protcol support */66#include "lsi/mpi_tool.h"	/* Tools support */67#include "lsi/mpi_sas.h"	/* SAS support */68 69/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/70 71#ifndef MODULEAUTHOR72#define MODULEAUTHOR	"LSI Corporation"73#endif74 75#ifndef COPYRIGHT76#define COPYRIGHT	"Copyright (c) 1999-2008 " MODULEAUTHOR77#endif78 79#define MPT_LINUX_VERSION_COMMON	"3.04.20"80#define MPT_LINUX_PACKAGE_NAME		"@(#)mptlinux-3.04.20"81#define WHAT_MAGIC_STRING		"@" "(" "#" ")"82 83#define show_mptmod_ver(s,ver)  \84	printk(KERN_INFO "%s %s\n", s, ver);85 86/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/87/*88 *  Fusion MPT(linux) driver configurable stuff...89 */90#define MPT_MAX_ADAPTERS		1891#define MPT_MAX_PROTOCOL_DRIVERS	1692#define MPT_MAX_CALLBACKNAME_LEN	4993#define MPT_MAX_BUS			1	/* Do not change */94#define MPT_MAX_FC_DEVICES		25595#define MPT_MAX_SCSI_DEVICES		1696#define MPT_LAST_LUN			25597#define MPT_SENSE_BUFFER_ALLOC		6498	/* allow for 256 max sense alloc, but only 255 max request */99#if MPT_SENSE_BUFFER_ALLOC >= 256100#	undef MPT_SENSE_BUFFER_ALLOC101#	define MPT_SENSE_BUFFER_ALLOC	256102#	define MPT_SENSE_BUFFER_SIZE	255103#else104#	define MPT_SENSE_BUFFER_SIZE	MPT_SENSE_BUFFER_ALLOC105#endif106 107#define MPT_NAME_LENGTH			32108#define MPT_KOBJ_NAME_LEN		20109 110#define MPT_PROCFS_MPTBASEDIR		"mpt"111						/* chg it to "driver/fusion" ? */112#define MPT_PROCFS_SUMMARY_ALL_NODE		MPT_PROCFS_MPTBASEDIR "/summary"113#define MPT_PROCFS_SUMMARY_ALL_PATHNAME		"/proc/" MPT_PROCFS_SUMMARY_ALL_NODE114#define MPT_FW_REV_MAGIC_ID_STRING		"FwRev="115 116#define  MPT_MAX_REQ_DEPTH		1023117#define  MPT_DEFAULT_REQ_DEPTH		256118#define  MPT_MIN_REQ_DEPTH		128119 120#define  MPT_MAX_REPLY_DEPTH		MPT_MAX_REQ_DEPTH121#define  MPT_DEFAULT_REPLY_DEPTH	128122#define  MPT_MIN_REPLY_DEPTH		8123#define  MPT_MAX_REPLIES_PER_ISR	32124 125#define  MPT_MAX_FRAME_SIZE		128126#define  MPT_DEFAULT_FRAME_SIZE		128127 128#define  MPT_REPLY_FRAME_SIZE		0x50  /* Must be a multiple of 8 */129 130#define  MPT_SG_REQ_128_SCALE		1131#define  MPT_SG_REQ_96_SCALE		2132#define  MPT_SG_REQ_64_SCALE		4133 134#define	 CAN_SLEEP			1135#define  NO_SLEEP			0136 137#define MPT_COALESCING_TIMEOUT		0x10138 139 140/*141 * SCSI transfer rate defines.142 */143#define MPT_ULTRA320			0x08144#define MPT_ULTRA160			0x09145#define MPT_ULTRA2			0x0A146#define MPT_ULTRA			0x0C147#define MPT_FAST			0x19148#define MPT_SCSI			0x32149#define MPT_ASYNC			0xFF150 151#define MPT_NARROW			0152#define MPT_WIDE			1153 154#define C0_1030				0x08155#define XL_929				0x01156 157 158/*159 *	Try to keep these at 2^N-1160 */161#define MPT_FC_CAN_QUEUE	1024162#define MPT_SCSI_CAN_QUEUE	127163#define MPT_SAS_CAN_QUEUE	127164 165/*166 * Set the MAX_SGE value based on user input.167 */168#ifdef CONFIG_FUSION_MAX_SGE169#if CONFIG_FUSION_MAX_SGE  < 16170#define MPT_SCSI_SG_DEPTH	16171#elif CONFIG_FUSION_MAX_SGE  > 128172#define MPT_SCSI_SG_DEPTH	128173#else174#define MPT_SCSI_SG_DEPTH	CONFIG_FUSION_MAX_SGE175#endif176#else177#define MPT_SCSI_SG_DEPTH	40178#endif179 180#ifdef CONFIG_FUSION_MAX_FC_SGE181#if CONFIG_FUSION_MAX_FC_SGE  < 16182#define MPT_SCSI_FC_SG_DEPTH	16183#elif CONFIG_FUSION_MAX_FC_SGE  > 256184#define MPT_SCSI_FC_SG_DEPTH	256185#else186#define MPT_SCSI_FC_SG_DEPTH	CONFIG_FUSION_MAX_FC_SGE187#endif188#else189#define MPT_SCSI_FC_SG_DEPTH	40190#endif191 192/* debug print string length used for events and iocstatus */193# define EVENT_DESCR_STR_SZ             100194 195#define MPT_POLLING_INTERVAL		1000	/* in milliseconds */196 197#ifdef __KERNEL__	/* { */198/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/199 200#include <linux/proc_fs.h>201 202/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/203/*204 * Attempt semi-consistent error & warning msgs across205 * MPT drivers.  NOTE: Users of these macro defs must206 * themselves define their own MYNAM.207 */208#define MYIOC_s_FMT			MYNAM ": %s: "209#define MYIOC_s_DEBUG_FMT		KERN_DEBUG MYNAM ": %s: "210#define MYIOC_s_INFO_FMT		KERN_INFO MYNAM ": %s: "211#define MYIOC_s_NOTE_FMT		KERN_NOTICE MYNAM ": %s: "212#define MYIOC_s_WARN_FMT		KERN_WARNING MYNAM ": %s: WARNING - "213#define MYIOC_s_ERR_FMT			KERN_ERR MYNAM ": %s: ERROR - "214 215/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/216/*217 *  ATTO UL4D associated structures and defines218 */219#define ATTOFLAG_DISC     0x0001220#define ATTOFLAG_TAGGED   0x0002221#define ATTOFLAG_WIDE_ENB 0x0008222#define ATTOFLAG_ID_ENB   0x0010223#define ATTOFLAG_LUN_ENB  0x0060224 225typedef struct _ATTO_DEVICE_INFO226{227	u8	Offset;					/* 00h */228	u8	Period;					/* 01h */229	u16	ATTOFlags;				/* 02h */230} ATTO_DEVICE_INFO, MPI_POINTER PTR_ATTO_DEVICE_INFO,231  ATTODeviceInfo_t, MPI_POINTER pATTODeviceInfo_t;232 233typedef struct _ATTO_CONFIG_PAGE_SCSI_PORT_2234{235	CONFIG_PAGE_HEADER	Header;			/* 00h */236	u16			PortFlags;		/* 04h */237	u16			Unused1;		/* 06h */238	u32			Unused2;		/* 08h */239	ATTO_DEVICE_INFO	DeviceSettings[16];	/* 0Ch */240} fATTO_CONFIG_PAGE_SCSI_PORT_2, MPI_POINTER PTR_ATTO_CONFIG_PAGE_SCSI_PORT_2,241  ATTO_SCSIPortPage2_t, MPI_POINTER pATTO_SCSIPortPage2_t;242 243 244/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/245/*246 *  MPT protocol driver defs...247 */248typedef enum {249	MPTBASE_DRIVER,		/* MPT base class */250	MPTCTL_DRIVER,		/* MPT ioctl class */251	MPTSPI_DRIVER,		/* MPT SPI host class */252	MPTFC_DRIVER,		/* MPT FC host class */253	MPTSAS_DRIVER,		/* MPT SAS host class */254	MPTLAN_DRIVER,		/* MPT LAN class */255	MPTSTM_DRIVER,		/* MPT SCSI target mode class */256	MPTUNKNOWN_DRIVER257} MPT_DRIVER_CLASS;258 259struct mpt_pci_driver{260	int  (*probe) (struct pci_dev *dev);261	void (*remove) (struct pci_dev *dev);262};263 264/*265 *  MPT adapter / port / bus / device info structures...266 */267 268typedef union _MPT_FRAME_TRACKER {269	struct {270		struct list_head	list;271		u32			 arg1;272		u32			 pad;273		void			*argp1;274	} linkage;275	/*276	 * NOTE: When request frames are free, on the linkage structure277	 * contents are valid.  All other values are invalid.278	 * In particular, do NOT reply on offset [2]279	 * (in words) being the * message context.280	 * The message context must be reset (computed via base address281	 * + an offset) prior to issuing any command.282	 *283	 * NOTE2: On non-32-bit systems, where pointers are LARGE,284	 * using the linkage pointers destroys our sacred MsgContext285	 * field contents.  But we don't care anymore because these286	 * are now reset in mpt_put_msg_frame() just prior to sending287	 * a request off to the IOC.288	 */289	struct {290		u32 __hdr[2];291		/*292		 * The following _MUST_ match the location of the293		 * MsgContext field in the MPT message headers.294		 */295		union {296			u32		 MsgContext;297			struct {298				u16	 req_idx;	/* Request index */299				u8	 cb_idx;	/* callback function index */300				u8	 rsvd;301			} fld;302		} msgctxu;303	} hwhdr;304	/*305	 * Remark: 32 bit identifier:306	 *  31-24: reserved307	 *  23-16: call back index308	 *  15-0 : request index309	 */310} MPT_FRAME_TRACKER;311 312/*313 *  We might want to view/access a frame as:314 *    1) generic request header315 *    2) SCSIIORequest316 *    3) SCSIIOReply317 *    4) MPIDefaultReply318 *    5) frame tracker319 */320typedef struct _MPT_FRAME_HDR {321	union {322		MPIHeader_t		hdr;323		SCSIIORequest_t		scsireq;324		SCSIIOReply_t		sreply;325		ConfigReply_t		configreply;326		MPIDefaultReply_t	reply;327		MPT_FRAME_TRACKER	frame;328	} u;329} MPT_FRAME_HDR;330 331#define MPT_REQ_MSGFLAGS_DROPME		0x80332 333typedef struct _MPT_SGL_HDR {334	SGESimple32_t	 sge[1];335} MPT_SGL_HDR;336 337typedef struct _MPT_SGL64_HDR {338	SGESimple64_t	 sge[1];339} MPT_SGL64_HDR;340 341/*342 *  System interface register set343 */344 345typedef struct _SYSIF_REGS346{347	u32	Doorbell;	/* 00     System<->IOC Doorbell reg  */348	u32	WriteSequence;	/* 04     Write Sequence register    */349	u32	Diagnostic;	/* 08     Diagnostic register        */350	u32	TestBase;	/* 0C     Test Base Address          */351	u32	DiagRwData;	/* 10     Read Write Data (fw download)   */352	u32	DiagRwAddress;	/* 14     Read Write Address (fw download)*/353	u32	Reserved1[6];	/* 18-2F  reserved for future use    */354	u32	IntStatus;	/* 30     Interrupt Status           */355	u32	IntMask;	/* 34     Interrupt Mask             */356	u32	Reserved2[2];	/* 38-3F  reserved for future use    */357	u32	RequestFifo;	/* 40     Request Post/Free FIFO     */358	u32	ReplyFifo;	/* 44     Reply   Post/Free FIFO     */359	u32	RequestHiPriFifo; /* 48   Hi Priority Request FIFO   */360	u32	Reserved3;	/* 4C-4F  reserved for future use    */361	u32	HostIndex;	/* 50     Host Index register        */362	u32	Reserved4[15];	/* 54-8F                             */363	u32	Fubar;		/* 90     For Fubar usage            */364	u32	Reserved5[1050];/* 94-10F8                           */365	u32	Reset_1078;	/* 10FC   Reset 1078                 */366} SYSIF_REGS;367 368/*369 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h370 * in conjunction with SYSIF_REGS accesses!371 */372 373 374/*375 *	Dynamic Multi-Pathing specific stuff...376 */377 378/* VirtTarget negoFlags field */379#define MPT_TARGET_NO_NEGO_WIDE		0x01380#define MPT_TARGET_NO_NEGO_SYNC		0x02381#define MPT_TARGET_NO_NEGO_QAS		0x04382#define MPT_TAPE_NEGO_IDP     		0x08383 384/*385 *	VirtDevice - FC LUN device or SCSI target device386 */387typedef struct _VirtTarget {388	struct scsi_target	*starget;389	u8			 tflags;390	u8			 ioc_id;391	u8			 id;392	u8			 channel;393	u8			 minSyncFactor;	/* 0xFF is async */394	u8			 maxOffset;	/* 0 if async */395	u8			 maxWidth;	/* 0 if narrow, 1 if wide */396	u8			 negoFlags;	/* bit field, see above */397	u8			 raidVolume;	/* set, if RAID Volume */398	u8			 type;		/* byte 0 of Inquiry data */399	u8			 deleted;	/* target in process of being removed */400	u8			 inDMD;		/* currently in the device401						   removal delay timer */402	u32			 num_luns;403} VirtTarget;404 405typedef struct _VirtDevice {406	VirtTarget		*vtarget;407	u8			 configured_lun;408	u64			 lun;409} VirtDevice;410 411/*412 *  Fibre Channel (SCSI) target device and associated defines...413 */414#define MPT_TARGET_DEFAULT_DV_STATUS	0x00415#define MPT_TARGET_FLAGS_VALID_NEGO	0x01416#define MPT_TARGET_FLAGS_VALID_INQUIRY	0x02417#define MPT_TARGET_FLAGS_Q_YES		0x08418#define MPT_TARGET_FLAGS_VALID_56	0x10419#define MPT_TARGET_FLAGS_SAF_TE_ISSUED	0x20420#define MPT_TARGET_FLAGS_RAID_COMPONENT	0x40421#define MPT_TARGET_FLAGS_LED_ON		0x80422 423/*424 *	IOCTL structure and associated defines425 */426 427#define MPTCTL_RESET_OK			0x01	/* Issue Bus Reset */428 429#define MPT_MGMT_STATUS_RF_VALID	0x01	/* The Reply Frame is VALID */430#define MPT_MGMT_STATUS_COMMAND_GOOD	0x02	/* Command Status GOOD */431#define MPT_MGMT_STATUS_PENDING		0x04	/* command is pending */432#define MPT_MGMT_STATUS_DID_IOCRESET	0x08	/* IOC Reset occurred433						   on the current*/434#define MPT_MGMT_STATUS_SENSE_VALID	0x10	/* valid sense info */435#define MPT_MGMT_STATUS_TIMER_ACTIVE	0x20	/* obsolete */436#define MPT_MGMT_STATUS_FREE_MF		0x40	/* free the mf from437						   complete routine */438 439#define INITIALIZE_MGMT_STATUS(status) \440	status = MPT_MGMT_STATUS_PENDING;441#define CLEAR_MGMT_STATUS(status) \442	status = 0;443#define CLEAR_MGMT_PENDING_STATUS(status) \444	status &= ~MPT_MGMT_STATUS_PENDING;445#define SET_MGMT_MSG_CONTEXT(msg_context, value) \446	msg_context = value;447 448typedef struct _MPT_MGMT {449	struct mutex		 mutex;450	struct completion	 done;451	u8			 reply[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */452	u8			 sense[MPT_SENSE_BUFFER_ALLOC];453	u8			 status;	/* current command status */454	int			 completion_code;455	u32			 msg_context;456} MPT_MGMT;457 458/*459 *  Event Structure and define460 */461#define MPTCTL_EVENT_LOG_SIZE		(0x000000032)462typedef struct _mpt_ioctl_events {463	u32	event;		/* Specified by define above */464	u32	eventContext;	/* Index or counter */465	u32	data[2];	/* First 8 bytes of Event Data */466} MPT_IOCTL_EVENTS;467 468/*469 * CONFIGPARM status  defines470 */471#define MPT_CONFIG_GOOD		MPI_IOCSTATUS_SUCCESS472#define MPT_CONFIG_ERROR	0x002F473 474/*475 *	Substructure to store SCSI specific configuration page data476 */477						/* dvStatus defines: */478#define MPT_SCSICFG_USE_NVRAM		0x01	/* WriteSDP1 using NVRAM */479#define MPT_SCSICFG_ALL_IDS		0x02	/* WriteSDP1 to all IDS */480/* #define MPT_SCSICFG_BLK_NEGO		0x10	   WriteSDP1 with WDTR and SDTR disabled */481 482typedef	struct _SpiCfgData {483	u32		 PortFlags;484	int		*nvram;			/* table of device NVRAM values */485	IOCPage4_t	*pIocPg4;		/* SEP devices addressing */486	dma_addr_t	 IocPg4_dma;		/* Phys Addr of IOCPage4 data */487	int		 IocPg4Sz;		/* IOCPage4 size */488	u8		 minSyncFactor;		/* 0xFF if async */489	u8		 maxSyncOffset;		/* 0 if async */490	u8		 maxBusWidth;		/* 0 if narrow, 1 if wide */491	u8		 busType;		/* SE, LVD, HD */492	u8		 sdp1version;		/* SDP1 version */493	u8		 sdp1length;		/* SDP1 length  */494	u8		 sdp0version;		/* SDP0 version */495	u8		 sdp0length;		/* SDP0 length  */496	u8		 dvScheduled;		/* 1 if scheduled */497	u8		 noQas;			/* Disable QAS for this adapter */498	u8		 Saf_Te;		/* 1 to force all Processors as499						 * SAF-TE if Inquiry data length500						 * is too short to check for SAF-TE501						 */502	u8		 bus_reset;		/* 1 to allow bus reset */503	u8		 rsvd[1];504}SpiCfgData;505 506typedef	struct _SasCfgData {507	u8		 ptClear;		/* 1 to automatically clear the508						 * persistent table.509						 * 0 to disable510						 * automatic clearing.511						 */512}SasCfgData;513 514/*515 * Inactive volume link list of raid component data516 * @inactive_list517 */518struct inactive_raid_component_info {519	struct 	 list_head list;520	u8		 volumeID;		/* volume target id */521	u8		 volumeBus;		/* volume channel */522	IOC_3_PHYS_DISK	 d;			/* phys disk info */523};524 525typedef	struct _RaidCfgData {526	IOCPage2_t	*pIocPg2;		/* table of Raid Volumes */527	IOCPage3_t	*pIocPg3;		/* table of physical disks */528	struct mutex	inactive_list_mutex;529	struct list_head	inactive_list; /* link list for physical530						disk that belong in531						inactive volumes */532}RaidCfgData;533 534typedef struct _FcCfgData {535	/* will ultimately hold fc_port_page0 also */536	struct {537		FCPortPage1_t	*data;538		dma_addr_t	 dma;539		int		 pg_sz;540	}			 fc_port_page1[2];541} FcCfgData;542 543#define MPT_RPORT_INFO_FLAGS_REGISTERED	0x01	/* rport registered */544#define MPT_RPORT_INFO_FLAGS_MISSING	0x02	/* missing from DevPage0 scan */545 546/*547 * data allocated for each fc rport device548 */549struct mptfc_rport_info550{551	struct list_head list;552	struct fc_rport *rport;553	struct scsi_target *starget;554	FCDevicePage0_t pg0;555	u8		flags;556};557 558/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/559 560/*561 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers562 * Private to the driver.563 */564 565#define MPT_HOST_BUS_UNKNOWN		(0xFF)566#define MPT_HOST_TOO_MANY_TM		(0x05)567#define MPT_HOST_NVRAM_INVALID		(0xFFFFFFFF)568#define MPT_HOST_NO_CHAIN		(0xFFFFFFFF)569#define MPT_NVRAM_MASK_TIMEOUT		(0x000000FF)570#define MPT_NVRAM_SYNC_MASK		(0x0000FF00)571#define MPT_NVRAM_SYNC_SHIFT		(8)572#define MPT_NVRAM_DISCONNECT_ENABLE	(0x00010000)573#define MPT_NVRAM_ID_SCAN_ENABLE	(0x00020000)574#define MPT_NVRAM_LUN_SCAN_ENABLE	(0x00040000)575#define MPT_NVRAM_TAG_QUEUE_ENABLE	(0x00080000)576#define MPT_NVRAM_WIDE_DISABLE		(0x00100000)577#define MPT_NVRAM_BOOT_CHOICE		(0x00200000)578 579typedef enum {580	FC,581	SPI,582	SAS583} BUS_TYPE;584 585typedef struct _MPT_SCSI_HOST {586	struct _MPT_ADAPTER		 *ioc;587	ushort			  sel_timeout[MPT_MAX_FC_DEVICES];588	char			  *info_kbuf;589	long			  last_queue_full;590	u16			  spi_pending;591	struct list_head	  target_reset_list;592} MPT_SCSI_HOST;593 594typedef void (*MPT_ADD_SGE)(void *pAddr, u32 flagslength, dma_addr_t dma_addr);595typedef void (*MPT_ADD_CHAIN)(void *pAddr, u8 next, u16 length,596		dma_addr_t dma_addr);597typedef void (*MPT_SCHEDULE_TARGET_RESET)(void *ioc);598typedef void (*MPT_FLUSH_RUNNING_CMDS)(MPT_SCSI_HOST *hd);599 600/*601 *  Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS602 */603typedef struct _MPT_ADAPTER604{605	int			 id;		/* Unique adapter id N {0,1,2,...} */606	int			 pci_irq;	/* This irq           */607	char			 name[MPT_NAME_LENGTH];	/* "iocN"             */608	const char		 *prod_name;	/* "LSIFC9x9"         */609#ifdef CONFIG_FUSION_LOGGING610	/* used in mpt_display_event_info */611	char			 evStr[EVENT_DESCR_STR_SZ];612#endif613	char			 board_name[16];614	char			 board_assembly[16];615	char			 board_tracer[16];616	u16			 nvdata_version_persistent;617	u16			 nvdata_version_default;618	int			 debug_level;619	u8			 io_missing_delay;620	u16			 device_missing_delay;621	SYSIF_REGS __iomem	*chip;		/* == c8817000 (mmap) */622	SYSIF_REGS __iomem	*pio_chip;	/* Programmed IO (downloadboot) */623	u8			 bus_type;624	u32			 mem_phys;	/* == f4020000 (mmap) */625	u32			 pio_mem_phys;	/* Programmed IO (downloadboot) */626	int			 mem_size;	/* mmap memory size */627	int			 number_of_buses;628	int			 devices_per_bus;629	int			 alloc_total;630	u32			 last_state;631	int			 active;632	u8			*alloc;		/* frames alloc ptr */633	dma_addr_t		 alloc_dma;634	u32			 alloc_sz;635	MPT_FRAME_HDR		*reply_frames;	/* Reply msg frames - rounded up! */636	u32			 reply_frames_low_dma;637	int			 reply_depth;	/* Num Allocated reply frames */638	int			 reply_sz;	/* Reply frame size */639	int			 num_chain;	/* Number of chain buffers */640	MPT_ADD_SGE              add_sge;       /* Pointer to add_sge641						   function */642	MPT_ADD_CHAIN		 add_chain;	/* Pointer to add_chain643						   function */644		/* Pool of buffers for chaining. ReqToChain645		 * and ChainToChain track index of chain buffers.646		 * ChainBuffer (DMA) virt/phys addresses.647		 * FreeChainQ (lock) locking mechanisms.648		 */649	int			*ReqToChain;650	int			*RequestNB;651	int			*ChainToChain;652	u8			*ChainBuffer;653	dma_addr_t		 ChainBufferDMA;654	struct list_head	 FreeChainQ;655	spinlock_t		 FreeChainQlock;656		/* We (host driver) get to manage our own RequestQueue! */657	dma_addr_t		 req_frames_dma;658	MPT_FRAME_HDR		*req_frames;	/* Request msg frames - rounded up! */659	u32			 req_frames_low_dma;660	int			 req_depth;	/* Number of request frames */661	int			 req_sz;	/* Request frame size (bytes) */662	spinlock_t		 FreeQlock;663	struct list_head	 FreeQ;664		/* Pool of SCSI sense buffers for commands coming from665		 * the SCSI mid-layer.  We have one 256 byte sense buffer666		 * for each REQ entry.667		 */668	u8			*sense_buf_pool;669	dma_addr_t		 sense_buf_pool_dma;670	u32			 sense_buf_low_dma;671	u8			*HostPageBuffer; /* SAS - host page buffer support */672	u32			HostPageBuffer_sz;673	dma_addr_t		HostPageBuffer_dma;674	struct pci_dev		*pcidev;	/* struct pci_dev pointer */675	int			bars;		/* bitmask of BAR's that must be configured */676	int			msi_enable;677	u8			__iomem *memmap;	/* mmap address */678	struct Scsi_Host	*sh;		/* Scsi Host pointer */679	SpiCfgData		spi_data;	/* Scsi config. data */680	RaidCfgData		raid_data;	/* Raid config. data */681	SasCfgData		sas_data;	/* Sas config. data */682	FcCfgData		fc_data;	/* Fc config. data */683	struct proc_dir_entry	*ioc_dentry;684	struct _MPT_ADAPTER	*alt_ioc;	/* ptr to 929 bound adapter port */685	u32			 biosVersion;	/* BIOS version from IO Unit Page 2 */686	int			 eventTypes;	/* Event logging parameters */687	int			 eventContext;	/* Next event context */688	int			 eventLogSize;	/* Max number of cached events */689	struct _mpt_ioctl_events *events;	/* pointer to event log */690	u8			*cached_fw;	/* Pointer to FW */691	dma_addr_t	 	cached_fw_dma;692	int			 hs_reply_idx;693#ifndef MFCNT694	u32			 pad0;695#else696	u32			 mfcnt;697#endif698	u32			 NB_for_64_byte_frame;699	u32			 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];700	u16			 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];701	IOCFactsReply_t		 facts;702	PortFactsReply_t	 pfacts[2];703	FCPortPage0_t		 fc_port_page0[2];704	LANPage0_t		 lan_cnfg_page0;705	LANPage1_t		 lan_cnfg_page1;706 707	u8			 ir_firmware; /* =1 if IR firmware detected */708	/*709	 * Description: errata_flag_1064710	 * If a PCIX read occurs within 1 or 2 cycles after the chip receives711	 * a split completion for a read data, an internal address pointer incorrectly712	 * increments by 32 bytes713	 */714	int			 errata_flag_1064;715	int			 aen_event_read_flag; /* flag to indicate event log was read*/716	u8			 FirstWhoInit;717	u8			 upload_fw;	/* If set, do a fw upload */718	u8			 NBShiftFactor;  /* NB Shift Factor based on Block Size (Facts)  */719	u8			 pad1[4];720	u8			 DoneCtx;721	u8			 TaskCtx;722	u8			 InternalCtx;723	struct list_head	 list;724	struct net_device	*netdev;725	struct list_head	 sas_topology;726	struct mutex		 sas_topology_mutex;727 728	struct workqueue_struct	*fw_event_q;729	struct list_head	 fw_event_list;730	spinlock_t		 fw_event_lock;731	u8			 fw_events_off; /* if '1', then ignore events */732 733	struct mutex		 sas_discovery_mutex;734	u8			 sas_discovery_runtime;735	u8			 sas_discovery_ignore_events;736 737	/* port_info object for the host */738	struct mptsas_portinfo	*hba_port_info;739	u64			 hba_port_sas_addr;740	u16			 hba_port_num_phy;741	struct list_head	 sas_device_info_list;742	struct mutex		 sas_device_info_mutex;743	u8			 old_sas_discovery_protocal;744	u8			 sas_discovery_quiesce_io;745	int			 sas_index; /* index refrencing */746	MPT_MGMT		 sas_mgmt;747	MPT_MGMT		 mptbase_cmds; /* for sending config pages */748	MPT_MGMT		 internal_cmds;749	MPT_MGMT		 taskmgmt_cmds;750	MPT_MGMT		 ioctl_cmds;751	spinlock_t		 taskmgmt_lock; /* diagnostic reset lock */752	int			 taskmgmt_in_progress;753	u8			 taskmgmt_quiesce_io;754	u8			 ioc_reset_in_progress;755	u8			 reset_status;756	u8			 wait_on_reset_completion;757	MPT_SCHEDULE_TARGET_RESET schedule_target_reset;758	MPT_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;759 760	struct work_struct	 fc_setup_reset_work;761	struct list_head	 fc_rports;762	struct work_struct	 fc_lsc_work;763	u8			 fc_link_speed[2];764	spinlock_t		 fc_rescan_work_lock;765	struct work_struct	 fc_rescan_work;766	struct workqueue_struct *fc_rescan_work_q;767 768	/* driver forced bus resets count */769	unsigned long		  hard_resets;770	/* fw/external bus resets count */771	unsigned long		  soft_resets;772	/* cmd timeouts */773	unsigned long		  timeouts;774 775	struct scsi_cmnd	**ScsiLookup;776	spinlock_t		  scsi_lookup_lock;777	u64			dma_mask;778	u32			  broadcast_aen_busy;779	struct workqueue_struct *reset_work_q;780	struct delayed_work	 fault_reset_work;781 782	u8			sg_addr_size;783	u8			in_rescan;784	u8			SGE_size;785 786} MPT_ADAPTER;787 788/*789 *  New return value convention:790 *    1 = Ok to free associated request frame791 *    0 = not Ok ...792 */793typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);794typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);795typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);796/* reset_phase defs */797#define MPT_IOC_PRE_RESET		0798#define MPT_IOC_POST_RESET		1799#define MPT_IOC_SETUP_RESET		2800 801/*802 * Invent MPT host event (super-set of MPI Events)803 * Fitted to 1030's 64-byte [max] request frame size804 */805typedef struct _MPT_HOST_EVENT {806	EventNotificationReply_t	 MpiEvent;	/* 8 32-bit words! */807	u32				 pad[6];808	void				*next;809} MPT_HOST_EVENT;810 811#define MPT_HOSTEVENT_IOC_BRINGUP	0x91812#define MPT_HOSTEVENT_IOC_RECOVER	0x92813 814/* Define the generic types based on the size815 * of the dma_addr_t type.816 */817typedef struct _mpt_sge {818	u32		FlagsLength;819	dma_addr_t	Address;820} MptSge_t;821 822 823#define mpt_msg_flags(ioc) \824	(ioc->sg_addr_size == sizeof(u64)) ?		\825	MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : 		\826	MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32827 828#define MPT_SGE_FLAGS_64_BIT_ADDRESSING \829	(MPI_SGE_FLAGS_64_BIT_ADDRESSING << MPI_SGE_FLAGS_SHIFT)830 831/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/832/*833 *  Funky (private) macros...834 */835#include "mptdebug.h"836 837#define MPT_INDEX_2_MFPTR(ioc,idx) \838	(MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )839 840#define MFPTR_2_MPT_INDEX(ioc,mf) \841	(int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )842 843#define MPT_INDEX_2_RFPTR(ioc,idx) \844	(MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )845 846/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/847 848#define SCSI_STD_SENSE_BYTES    18849#define SCSI_STD_INQUIRY_BYTES  36850#define SCSI_MAX_INQUIRY_BYTES  96851 852/*853 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers854 * Private to the driver.855 */856/* LOCAL structure and fields used when processing857 * internally generated commands. These include:858 * bus scan, dv and config requests.859 */860typedef struct _MPT_LOCAL_REPLY {861	ConfigPageHeader_t header;862	int	completion;863	u8	sense[SCSI_STD_SENSE_BYTES];864	u8	scsiStatus;865	u8	skip;866	u32	pad;867} MPT_LOCAL_REPLY;868 869 870/* The TM_STATE variable is used to provide strict single threading of TM871 * requests as well as communicate TM error conditions.872 */873#define TM_STATE_NONE          (0)874#define	TM_STATE_IN_PROGRESS   (1)875#define	TM_STATE_ERROR	       (2)876 877/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/878/*879 *	More Dynamic Multi-Pathing stuff...880 */881 882/* Forward decl, a strange C thing, to prevent gcc compiler warnings */883struct scsi_cmnd;884 885/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/886/*887 * Generic structure passed to the base mpt_config function.888 */889typedef struct _x_config_parms {890	union {891		ConfigExtendedPageHeader_t	*ehdr;892		ConfigPageHeader_t	*hdr;893	} cfghdr;894	dma_addr_t		 physAddr;895	u32			 pageAddr;	/* properly formatted */896	u16			 status;897	u8			 action;898	u8			 dir;899	u8			 timeout;	/* seconds */900} CONFIGPARMS;901 902/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/903/*904 *  Public entry points...905 */906extern int	 mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);907extern void	 mpt_detach(struct pci_dev *pdev);908#ifdef CONFIG_PM909extern int	 mpt_suspend(struct pci_dev *pdev, pm_message_t state);910extern int	 mpt_resume(struct pci_dev *pdev);911#endif912extern u8	 mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass,913		char *func_name);914extern void	 mpt_deregister(u8 cb_idx);915extern int	 mpt_event_register(u8 cb_idx, MPT_EVHANDLER ev_cbfunc);916extern void	 mpt_event_deregister(u8 cb_idx);917extern int	 mpt_reset_register(u8 cb_idx, MPT_RESETHANDLER reset_func);918extern void	 mpt_reset_deregister(u8 cb_idx);919extern int	 mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, u8 cb_idx);920extern void	 mpt_device_driver_deregister(u8 cb_idx);921extern MPT_FRAME_HDR	*mpt_get_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc);922extern void	 mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);923extern void	 mpt_put_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);924extern void	 mpt_put_msg_frame_hi_pri(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);925 926extern int	 mpt_send_handshake_request(u8 cb_idx, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);927extern int	 mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);928extern u32	 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);929extern void	 mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);930extern int	 mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);931extern int	 mpt_Soft_Hard_ResetHandler(MPT_ADAPTER *ioc, int sleepFlag);932extern int	 mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);933extern int	 mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);934extern void	 mpt_free_fw_memory(MPT_ADAPTER *ioc);935extern int	 mpt_findImVolumes(MPT_ADAPTER *ioc);936extern int	 mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);937extern int	 mpt_raid_phys_disk_pg0(MPT_ADAPTER *ioc, u8 phys_disk_num, pRaidPhysDiskPage0_t phys_disk);938extern int	mpt_raid_phys_disk_pg1(MPT_ADAPTER *ioc, u8 phys_disk_num,939		pRaidPhysDiskPage1_t phys_disk);940extern int	mpt_raid_phys_disk_get_num_paths(MPT_ADAPTER *ioc,941		u8 phys_disk_num);942extern int	 mpt_set_taskmgmt_in_progress_flag(MPT_ADAPTER *ioc);943extern void	 mpt_clear_taskmgmt_in_progress_flag(MPT_ADAPTER *ioc);944extern void __noreturn mpt_halt_firmware(MPT_ADAPTER *ioc);945 946 947/*948 *  Public data decl's...949 */950extern struct list_head	  ioc_list;951extern int mpt_fwfault_debug;952 953/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/954#endif		/* } __KERNEL__ */955 956#ifdef CONFIG_64BIT957#define CAST_U32_TO_PTR(x)	((void *)(u64)x)958#define CAST_PTR_TO_U32(x)	((u32)(u64)x)959#else960#define CAST_U32_TO_PTR(x)	((void *)x)961#define CAST_PTR_TO_U32(x)	((u32)x)962#endif963 964#define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \965	((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR)	? 'I' : 'i',	\966	((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET)	? 'T' : 't',	\967	((pflags) & MPI_PORTFACTS_PROTOCOL_LAN)		? 'L' : 'l',	\968	((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR)	? 'B' : 'b'969 970/*971 *  Shifted SGE Defines - Use in SGE with FlagsLength member.972 *  Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).973 *  Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read974 */975#define MPT_TRANSFER_IOC_TO_HOST		(0x00000000)976#define MPT_TRANSFER_HOST_TO_IOC		(0x04000000)977#define MPT_SGE_FLAGS_LAST_ELEMENT		(0x80000000)978#define MPT_SGE_FLAGS_END_OF_BUFFER		(0x40000000)979#define MPT_SGE_FLAGS_LOCAL_ADDRESS		(0x08000000)980#define MPT_SGE_FLAGS_DIRECTION			(0x04000000)981#define MPT_SGE_FLAGS_END_OF_LIST		(0x01000000)982 983#define MPT_SGE_FLAGS_TRANSACTION_ELEMENT	(0x00000000)984#define MPT_SGE_FLAGS_SIMPLE_ELEMENT		(0x10000000)985#define MPT_SGE_FLAGS_CHAIN_ELEMENT		(0x30000000)986#define MPT_SGE_FLAGS_ELEMENT_MASK		(0x30000000)987 988#define MPT_SGE_FLAGS_SSIMPLE_READ \989	(MPT_SGE_FLAGS_LAST_ELEMENT |	\990	 MPT_SGE_FLAGS_END_OF_BUFFER |	\991	 MPT_SGE_FLAGS_END_OF_LIST |	\992	 MPT_SGE_FLAGS_SIMPLE_ELEMENT |	\993	 MPT_TRANSFER_IOC_TO_HOST)994#define MPT_SGE_FLAGS_SSIMPLE_WRITE \995	(MPT_SGE_FLAGS_LAST_ELEMENT |	\996	 MPT_SGE_FLAGS_END_OF_BUFFER |	\997	 MPT_SGE_FLAGS_END_OF_LIST |	\998	 MPT_SGE_FLAGS_SIMPLE_ELEMENT |	\999	 MPT_TRANSFER_HOST_TO_IOC)1000 1001/*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/1002#endif1003 1004