1/* 2 * linux/drivers/message/fusion/mptbase.h 3 * High performance SCSI + LAN / Fibre Channel device drivers. 4 * For use with PCI chip/adapter(s): 5 * LSIFC9xx/LSI409xx Fibre Channel 6 * running LSI Fusion MPT (Message Passing Technology) firmware. 7 * 8 * Copyright (c) 1999-2008 LSI Corporation 9 * (mailto:DL-MPTFusionLinux@lsi.com) 10 * 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 MPTBASE_H_INCLUDED 49#define MPTBASE_H_INCLUDED 50/*{-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 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 MODULEAUTHOR 72#define MODULEAUTHOR "LSI Corporation" 73#endif 74 75#ifndef COPYRIGHT 76#define COPYRIGHT "Copyright (c) 1999-2008 " MODULEAUTHOR 77#endif 78 79#define MPT_LINUX_VERSION_COMMON "3.04.17" 80#define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.04.17" 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 18 91#define MPT_MAX_PROTOCOL_DRIVERS 16 92#define MPT_MAX_BUS 1 /* Do not change */ 93#define MPT_MAX_FC_DEVICES 255 94#define MPT_MAX_SCSI_DEVICES 16 95#define MPT_LAST_LUN 255 96#define MPT_SENSE_BUFFER_ALLOC 64 97 /* allow for 256 max sense alloc, but only 255 max request */ 98#if MPT_SENSE_BUFFER_ALLOC >= 256 99# undef MPT_SENSE_BUFFER_ALLOC 100# define MPT_SENSE_BUFFER_ALLOC 256 101# define MPT_SENSE_BUFFER_SIZE 255 102#else 103# define MPT_SENSE_BUFFER_SIZE MPT_SENSE_BUFFER_ALLOC 104#endif 105 106#define MPT_NAME_LENGTH 32 107#define MPT_KOBJ_NAME_LEN 20 108 109#define MPT_PROCFS_MPTBASEDIR "mpt" 110 /* chg it to "driver/fusion" ? */ 111#define MPT_PROCFS_SUMMARY_ALL_NODE MPT_PROCFS_MPTBASEDIR "/summary" 112#define MPT_PROCFS_SUMMARY_ALL_PATHNAME "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE 113#define MPT_FW_REV_MAGIC_ID_STRING "FwRev=" 114 115#define MPT_MAX_REQ_DEPTH 1023 116#define MPT_DEFAULT_REQ_DEPTH 256 117#define MPT_MIN_REQ_DEPTH 128 118 119#define MPT_MAX_REPLY_DEPTH MPT_MAX_REQ_DEPTH 120#define MPT_DEFAULT_REPLY_DEPTH 128 121#define MPT_MIN_REPLY_DEPTH 8 122#define MPT_MAX_REPLIES_PER_ISR 32 123 124#define MPT_MAX_FRAME_SIZE 128 125#define MPT_DEFAULT_FRAME_SIZE 128 126 127#define MPT_REPLY_FRAME_SIZE 0x50 /* Must be a multiple of 8 */ 128 129#define MPT_SG_REQ_128_SCALE 1 130#define MPT_SG_REQ_96_SCALE 2 131#define MPT_SG_REQ_64_SCALE 4 132 133#define CAN_SLEEP 1 134#define NO_SLEEP 0 135 136#define MPT_COALESCING_TIMEOUT 0x10 137 138 139/* 140 * SCSI transfer rate defines. 141 */ 142#define MPT_ULTRA320 0x08 143#define MPT_ULTRA160 0x09 144#define MPT_ULTRA2 0x0A 145#define MPT_ULTRA 0x0C 146#define MPT_FAST 0x19 147#define MPT_SCSI 0x32 148#define MPT_ASYNC 0xFF 149 150#define MPT_NARROW 0 151#define MPT_WIDE 1 152 153#define C0_1030 0x08 154#define XL_929 0x01 155 156 157/* 158 * Try to keep these at 2^N-1 159 */ 160#define MPT_FC_CAN_QUEUE 1024 161#define MPT_SCSI_CAN_QUEUE 127 162#define MPT_SAS_CAN_QUEUE 127 163 164/* 165 * Set the MAX_SGE value based on user input. 166 */ 167#ifdef CONFIG_FUSION_MAX_SGE 168#if CONFIG_FUSION_MAX_SGE < 16 169#define MPT_SCSI_SG_DEPTH 16 170#elif CONFIG_FUSION_MAX_SGE > 128 171#define MPT_SCSI_SG_DEPTH 128 172#else 173#define MPT_SCSI_SG_DEPTH CONFIG_FUSION_MAX_SGE 174#endif 175#else 176#define MPT_SCSI_SG_DEPTH 40 177#endif 178 179#ifdef CONFIG_FUSION_MAX_FC_SGE 180#if CONFIG_FUSION_MAX_FC_SGE < 16 181#define MPT_SCSI_FC_SG_DEPTH 16 182#elif CONFIG_FUSION_MAX_FC_SGE > 256 183#define MPT_SCSI_FC_SG_DEPTH 256 184#else 185#define MPT_SCSI_FC_SG_DEPTH CONFIG_FUSION_MAX_FC_SGE 186#endif 187#else 188#define MPT_SCSI_FC_SG_DEPTH 40 189#endif 190 191/* debug print string length used for events and iocstatus */ 192# define EVENT_DESCR_STR_SZ 100 193 194#define MPT_POLLING_INTERVAL 1000 /* in milliseconds */ 195 196#ifdef __KERNEL__ /* { */ 197/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 198 199#include <linux/proc_fs.h> 200 201/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 202/* 203 * Attempt semi-consistent error & warning msgs across 204 * MPT drivers. NOTE: Users of these macro defs must 205 * themselves define their own MYNAM. 206 */ 207#define MYIOC_s_FMT MYNAM ": %s: " 208#define MYIOC_s_DEBUG_FMT KERN_DEBUG MYNAM ": %s: " 209#define MYIOC_s_INFO_FMT KERN_INFO MYNAM ": %s: " 210#define MYIOC_s_NOTE_FMT KERN_NOTICE MYNAM ": %s: " 211#define MYIOC_s_WARN_FMT KERN_WARNING MYNAM ": %s: WARNING - " 212#define MYIOC_s_ERR_FMT KERN_ERR MYNAM ": %s: ERROR - " 213 214/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 215/* 216 * ATTO UL4D associated structures and defines 217 */ 218#define ATTOFLAG_DISC 0x0001 219#define ATTOFLAG_TAGGED 0x0002 220#define ATTOFLAG_WIDE_ENB 0x0008 221#define ATTOFLAG_ID_ENB 0x0010 222#define ATTOFLAG_LUN_ENB 0x0060 223 224typedef struct _ATTO_DEVICE_INFO 225{ 226 u8 Offset; /* 00h */ 227 u8 Period; /* 01h */ 228 u16 ATTOFlags; /* 02h */ 229} ATTO_DEVICE_INFO, MPI_POINTER PTR_ATTO_DEVICE_INFO, 230 ATTODeviceInfo_t, MPI_POINTER pATTODeviceInfo_t; 231 232typedef struct _ATTO_CONFIG_PAGE_SCSI_PORT_2 233{ 234 CONFIG_PAGE_HEADER Header; /* 00h */ 235 u16 PortFlags; /* 04h */ 236 u16 Unused1; /* 06h */ 237 u32 Unused2; /* 08h */ 238 ATTO_DEVICE_INFO DeviceSettings[16]; /* 0Ch */ 239} fATTO_CONFIG_PAGE_SCSI_PORT_2, MPI_POINTER PTR_ATTO_CONFIG_PAGE_SCSI_PORT_2, 240 ATTO_SCSIPortPage2_t, MPI_POINTER pATTO_SCSIPortPage2_t; 241 242 243/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 244/* 245 * MPT protocol driver defs... 246 */ 247typedef enum { 248 MPTBASE_DRIVER, /* MPT base class */ 249 MPTCTL_DRIVER, /* MPT ioctl class */ 250 MPTSPI_DRIVER, /* MPT SPI host class */ 251 MPTFC_DRIVER, /* MPT FC host class */ 252 MPTSAS_DRIVER, /* MPT SAS host class */ 253 MPTLAN_DRIVER, /* MPT LAN class */ 254 MPTSTM_DRIVER, /* MPT SCSI target mode class */ 255 MPTUNKNOWN_DRIVER 256} MPT_DRIVER_CLASS; 257 258struct mpt_pci_driver{ 259 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); 260 void (*remove) (struct pci_dev *dev); 261}; 262 263/* 264 * MPT adapter / port / bus / device info structures... 265 */ 266 267typedef union _MPT_FRAME_TRACKER { 268 struct { 269 struct list_head list; 270 u32 arg1; 271 u32 pad; 272 void *argp1; 273 } linkage; 274 /* 275 * NOTE: When request frames are free, on the linkage structure 276 * contets are valid. All other values are invalid. 277 * In particular, do NOT reply on offset [2] 278 * (in words) being the * message context. 279 * The message context must be reset (computed via base address 280 * + an offset) prior to issuing any command. 281 * 282 * NOTE2: On non-32-bit systems, where pointers are LARGE, 283 * using the linkage pointers destroys our sacred MsgContext 284 * field contents. But we don't care anymore because these 285 * are now reset in mpt_put_msg_frame() just prior to sending 286 * a request off to the IOC. 287 */ 288 struct { 289 u32 __hdr[2]; 290 /* 291 * The following _MUST_ match the location of the 292 * MsgContext field in the MPT message headers. 293 */ 294 union { 295 u32 MsgContext; 296 struct { 297 u16 req_idx; /* Request index */ 298 u8 cb_idx; /* callback function index */ 299 u8 rsvd; 300 } fld; 301 } msgctxu; 302 } hwhdr; 303 /* 304 * Remark: 32 bit identifier: 305 * 31-24: reserved 306 * 23-16: call back index 307 * 15-0 : request index 308 */ 309} MPT_FRAME_TRACKER; 310 311/* 312 * We might want to view/access a frame as: 313 * 1) generic request header 314 * 2) SCSIIORequest 315 * 3) SCSIIOReply 316 * 4) MPIDefaultReply 317 * 5) frame tracker 318 */ 319typedef struct _MPT_FRAME_HDR { 320 union { 321 MPIHeader_t hdr; 322 SCSIIORequest_t scsireq; 323 SCSIIOReply_t sreply; 324 ConfigReply_t configreply; 325 MPIDefaultReply_t reply; 326 MPT_FRAME_TRACKER frame; 327 } u; 328} MPT_FRAME_HDR; 329 330#define MPT_REQ_MSGFLAGS_DROPME 0x80 331 332typedef struct _MPT_SGL_HDR { 333 SGESimple32_t sge[1]; 334} MPT_SGL_HDR; 335 336typedef struct _MPT_SGL64_HDR { 337 SGESimple64_t sge[1]; 338} MPT_SGL64_HDR; 339 340/* 341 * System interface register set 342 */ 343 344typedef struct _SYSIF_REGS 345{ 346 u32 Doorbell; /* 00 System<->IOC Doorbell reg */ 347 u32 WriteSequence; /* 04 Write Sequence register */ 348 u32 Diagnostic; /* 08 Diagnostic register */ 349 u32 TestBase; /* 0C Test Base Address */ 350 u32 DiagRwData; /* 10 Read Write Data (fw download) */ 351 u32 DiagRwAddress; /* 14 Read Write Address (fw download)*/ 352 u32 Reserved1[6]; /* 18-2F reserved for future use */ 353 u32 IntStatus; /* 30 Interrupt Status */ 354 u32 IntMask; /* 34 Interrupt Mask */ 355 u32 Reserved2[2]; /* 38-3F reserved for future use */ 356 u32 RequestFifo; /* 40 Request Post/Free FIFO */ 357 u32 ReplyFifo; /* 44 Reply Post/Free FIFO */ 358 u32 RequestHiPriFifo; /* 48 Hi Priority Request FIFO */ 359 u32 Reserved3; /* 4C-4F reserved for future use */ 360 u32 HostIndex; /* 50 Host Index register */ 361 u32 Reserved4[15]; /* 54-8F */ 362 u32 Fubar; /* 90 For Fubar usage */ 363 u32 Reserved5[1050];/* 94-10F8 */ 364 u32 Reset_1078; /* 10FC Reset 1078 */ 365} SYSIF_REGS; 366 367/* 368 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h 369 * in conjunction with SYSIF_REGS accesses! 370 */ 371 372 373/* 374 * Dynamic Multi-Pathing specific stuff... 375 */ 376 377/* VirtTarget negoFlags field */ 378#define MPT_TARGET_NO_NEGO_WIDE 0x01 379#define MPT_TARGET_NO_NEGO_SYNC 0x02 380#define MPT_TARGET_NO_NEGO_QAS 0x04 381#define MPT_TAPE_NEGO_IDP 0x08 382 383/* 384 * VirtDevice - FC LUN device or SCSI target device 385 */ 386typedef struct _VirtTarget { 387 struct scsi_target *starget; 388 u8 tflags; 389 u8 ioc_id; 390 u8 id; 391 u8 channel; 392 u8 minSyncFactor; /* 0xFF is async */ 393 u8 maxOffset; /* 0 if async */ 394 u8 maxWidth; /* 0 if narrow, 1 if wide */ 395 u8 negoFlags; /* bit field, see above */ 396 u8 raidVolume; /* set, if RAID Volume */ 397 u8 type; /* byte 0 of Inquiry data */ 398 u8 deleted; /* target in process of being removed */ 399 u8 inDMD; /* currently in the device 400 removal delay timer */ 401 u32 num_luns; 402} VirtTarget; 403 404typedef struct _VirtDevice { 405 VirtTarget *vtarget; 406 u8 configured_lun; 407 int lun; 408} VirtDevice; 409 410/* 411 * Fibre Channel (SCSI) target device and associated defines... 412 */ 413#define MPT_TARGET_DEFAULT_DV_STATUS 0x00 414#define MPT_TARGET_FLAGS_VALID_NEGO 0x01 415#define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02 416#define MPT_TARGET_FLAGS_Q_YES 0x08 417#define MPT_TARGET_FLAGS_VALID_56 0x10 418#define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20 419#define MPT_TARGET_FLAGS_RAID_COMPONENT 0x40 420#define MPT_TARGET_FLAGS_LED_ON 0x80 421 422/* 423 * IOCTL structure and associated defines 424 */ 425 426#define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */ 427 428#define MPT_MGMT_STATUS_RF_VALID 0x01 /* The Reply Frame is VALID */ 429#define MPT_MGMT_STATUS_COMMAND_GOOD 0x02 /* Command Status GOOD */ 430#define MPT_MGMT_STATUS_PENDING 0x04 /* command is pending */ 431#define MPT_MGMT_STATUS_DID_IOCRESET 0x08 /* IOC Reset occurred 432 on the current*/ 433#define MPT_MGMT_STATUS_SENSE_VALID 0x10 /* valid sense info */ 434#define MPT_MGMT_STATUS_TIMER_ACTIVE 0x20 /* obsolete */ 435#define MPT_MGMT_STATUS_FREE_MF 0x40 /* free the mf from 436 complete routine */ 437 438#define INITIALIZE_MGMT_STATUS(status) \ 439 status = MPT_MGMT_STATUS_PENDING; 440#define CLEAR_MGMT_STATUS(status) \ 441 status = 0; 442#define CLEAR_MGMT_PENDING_STATUS(status) \ 443 status &= ~MPT_MGMT_STATUS_PENDING; 444#define SET_MGMT_MSG_CONTEXT(msg_context, value) \ 445 msg_context = value; 446 447typedef struct _MPT_MGMT { 448 struct mutex mutex; 449 struct completion done; 450 u8 reply[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */ 451 u8 sense[MPT_SENSE_BUFFER_ALLOC]; 452 u8 status; /* current command status */ 453 int completion_code; 454 u32 msg_context; 455} MPT_MGMT; 456 457/* 458 * Event Structure and define 459 */ 460#define MPTCTL_EVENT_LOG_SIZE (0x000000032) 461typedef struct _mpt_ioctl_events { 462 u32 event; /* Specified by define above */ 463 u32 eventContext; /* Index or counter */ 464 u32 data[2]; /* First 8 bytes of Event Data */ 465} MPT_IOCTL_EVENTS; 466 467/* 468 * CONFIGPARM status defines 469 */ 470#define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS 471#define MPT_CONFIG_ERROR 0x002F 472 473/* 474 * Substructure to store SCSI specific configuration page data 475 */ 476 /* dvStatus defines: */ 477#define MPT_SCSICFG_USE_NVRAM 0x01 /* WriteSDP1 using NVRAM */ 478#define MPT_SCSICFG_ALL_IDS 0x02 /* WriteSDP1 to all IDS */ 479/* #define MPT_SCSICFG_BLK_NEGO 0x10 WriteSDP1 with WDTR and SDTR disabled */ 480 481typedef struct _SpiCfgData { 482 u32 PortFlags; 483 int *nvram; /* table of device NVRAM values */ 484 IOCPage4_t *pIocPg4; /* SEP devices addressing */ 485 dma_addr_t IocPg4_dma; /* Phys Addr of IOCPage4 data */ 486 int IocPg4Sz; /* IOCPage4 size */ 487 u8 minSyncFactor; /* 0xFF if async */ 488 u8 maxSyncOffset; /* 0 if async */ 489 u8 maxBusWidth; /* 0 if narrow, 1 if wide */ 490 u8 busType; /* SE, LVD, HD */ 491 u8 sdp1version; /* SDP1 version */ 492 u8 sdp1length; /* SDP1 length */ 493 u8 sdp0version; /* SDP0 version */ 494 u8 sdp0length; /* SDP0 length */ 495 u8 dvScheduled; /* 1 if scheduled */ 496 u8 noQas; /* Disable QAS for this adapter */ 497 u8 Saf_Te; /* 1 to force all Processors as 498 * SAF-TE if Inquiry data length 499 * is too short to check for SAF-TE 500 */ 501 u8 bus_reset; /* 1 to allow bus reset */ 502 u8 rsvd[1]; 503}SpiCfgData; 504 505typedef struct _SasCfgData { 506 u8 ptClear; /* 1 to automatically clear the 507 * persistent table. 508 * 0 to disable 509 * automatic clearing. 510 */ 511}SasCfgData; 512 513/* 514 * Inactive volume link list of raid component data 515 * @inactive_list 516 */ 517struct inactive_raid_component_info { 518 struct list_head list; 519 u8 volumeID; /* volume target id */ 520 u8 volumeBus; /* volume channel */ 521 IOC_3_PHYS_DISK d; /* phys disk info */ 522}; 523 524typedef struct _RaidCfgData { 525 IOCPage2_t *pIocPg2; /* table of Raid Volumes */ 526 IOCPage3_t *pIocPg3; /* table of physical disks */ 527 struct mutex inactive_list_mutex; 528 struct list_head inactive_list; /* link list for physical 529 disk that belong in 530 inactive volumes */ 531}RaidCfgData; 532 533typedef struct _FcCfgData { 534 /* will ultimately hold fc_port_page0 also */ 535 struct { 536 FCPortPage1_t *data; 537 dma_addr_t dma; 538 int pg_sz; 539 } fc_port_page1[2]; 540} FcCfgData; 541 542#define MPT_RPORT_INFO_FLAGS_REGISTERED 0x01 /* rport registered */ 543#define MPT_RPORT_INFO_FLAGS_MISSING 0x02 /* missing from DevPage0 scan */ 544 545/* 546 * data allocated for each fc rport device 547 */ 548struct mptfc_rport_info 549{ 550 struct list_head list; 551 struct fc_rport *rport; 552 struct scsi_target *starget; 553 FCDevicePage0_t pg0; 554 u8 flags; 555}; 556 557typedef void (*MPT_ADD_SGE)(void *pAddr, u32 flagslength, dma_addr_t dma_addr); 558typedef void (*MPT_ADD_CHAIN)(void *pAddr, u8 next, u16 length, 559 dma_addr_t dma_addr); 560typedef void (*MPT_SCHEDULE_TARGET_RESET)(void *ioc); 561 562/* 563 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS 564 */ 565typedef struct _MPT_ADAPTER 566{ 567 int id; /* Unique adapter id N {0,1,2,...} */ 568 int pci_irq; /* This irq */ 569 char name[MPT_NAME_LENGTH]; /* "iocN" */ 570 char prod_name[MPT_NAME_LENGTH]; /* "LSIFC9x9" */ 571#ifdef CONFIG_FUSION_LOGGING 572 /* used in mpt_display_event_info */ 573 char evStr[EVENT_DESCR_STR_SZ]; 574#endif 575 char board_name[16]; 576 char board_assembly[16]; 577 char board_tracer[16]; 578 u16 nvdata_version_persistent; 579 u16 nvdata_version_default; 580 int debug_level; 581 u8 io_missing_delay; 582 u16 device_missing_delay; 583 SYSIF_REGS __iomem *chip; /* == c8817000 (mmap) */ 584 SYSIF_REGS __iomem *pio_chip; /* Programmed IO (downloadboot) */ 585 u8 bus_type; 586 u32 mem_phys; /* == f4020000 (mmap) */ 587 u32 pio_mem_phys; /* Programmed IO (downloadboot) */ 588 int mem_size; /* mmap memory size */ 589 int number_of_buses; 590 int devices_per_bus; 591 int alloc_total; 592 u32 last_state; 593 int active; 594 u8 *alloc; /* frames alloc ptr */ 595 dma_addr_t alloc_dma; 596 u32 alloc_sz; 597 MPT_FRAME_HDR *reply_frames; /* Reply msg frames - rounded up! */ 598 u32 reply_frames_low_dma; 599 int reply_depth; /* Num Allocated reply frames */ 600 int reply_sz; /* Reply frame size */ 601 int num_chain; /* Number of chain buffers */ 602 MPT_ADD_SGE add_sge; /* Pointer to add_sge 603 function */ 604 MPT_ADD_CHAIN add_chain; /* Pointer to add_chain 605 function */ 606 /* Pool of buffers for chaining. ReqToChain 607 * and ChainToChain track index of chain buffers. 608 * ChainBuffer (DMA) virt/phys addresses. 609 * FreeChainQ (lock) locking mechanisms. 610 */ 611 int *ReqToChain; 612 int *RequestNB; 613 int *ChainToChain; 614 u8 *ChainBuffer; 615 dma_addr_t ChainBufferDMA; 616 struct list_head FreeChainQ; 617 spinlock_t FreeChainQlock; 618 /* We (host driver) get to manage our own RequestQueue! */ 619 dma_addr_t req_frames_dma; 620 MPT_FRAME_HDR *req_frames; /* Request msg frames - rounded up! */ 621 u32 req_frames_low_dma; 622 int req_depth; /* Number of request frames */ 623 int req_sz; /* Request frame size (bytes) */ 624 spinlock_t FreeQlock; 625 struct list_head FreeQ; 626 /* Pool of SCSI sense buffers for commands coming from 627 * the SCSI mid-layer. We have one 256 byte sense buffer 628 * for each REQ entry. 629 */ 630 u8 *sense_buf_pool; 631 dma_addr_t sense_buf_pool_dma; 632 u32 sense_buf_low_dma; 633 u8 *HostPageBuffer; /* SAS - host page buffer support */ 634 u32 HostPageBuffer_sz; 635 dma_addr_t HostPageBuffer_dma; 636 int mtrr_reg; 637 struct pci_dev *pcidev; /* struct pci_dev pointer */ 638 int bars; /* bitmask of BAR's that must be configured */ 639 int msi_enable; 640 u8 __iomem *memmap; /* mmap address */ 641 struct Scsi_Host *sh; /* Scsi Host pointer */ 642 SpiCfgData spi_data; /* Scsi config. data */ 643 RaidCfgData raid_data; /* Raid config. data */ 644 SasCfgData sas_data; /* Sas config. data */ 645 FcCfgData fc_data; /* Fc config. data */ 646 struct proc_dir_entry *ioc_dentry; 647 struct _MPT_ADAPTER *alt_ioc; /* ptr to 929 bound adapter port */ 648 u32 biosVersion; /* BIOS version from IO Unit Page 2 */ 649 int eventTypes; /* Event logging parameters */ 650 int eventContext; /* Next event context */ 651 int eventLogSize; /* Max number of cached events */ 652 struct _mpt_ioctl_events *events; /* pointer to event log */ 653 u8 *cached_fw; /* Pointer to FW */ 654 dma_addr_t cached_fw_dma; 655 int hs_reply_idx; 656#ifndef MFCNT 657 u32 pad0; 658#else 659 u32 mfcnt; 660#endif 661 u32 NB_for_64_byte_frame; 662 u32 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)]; 663 u16 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)]; 664 IOCFactsReply_t facts; 665 PortFactsReply_t pfacts[2]; 666 FCPortPage0_t fc_port_page0[2]; 667 LANPage0_t lan_cnfg_page0; 668 LANPage1_t lan_cnfg_page1; 669 670 u8 ir_firmware; /* =1 if IR firmware detected */ 671 /* 672 * Description: errata_flag_1064 673 * If a PCIX read occurs within 1 or 2 cycles after the chip receives 674 * a split completion for a read data, an internal address pointer incorrectly 675 * increments by 32 bytes 676 */ 677 int errata_flag_1064; 678 int aen_event_read_flag; /* flag to indicate event log was read*/ 679 u8 FirstWhoInit; 680 u8 upload_fw; /* If set, do a fw upload */ 681 u8 NBShiftFactor; /* NB Shift Factor based on Block Size (Facts) */ 682 u8 pad1[4]; 683 u8 DoneCtx; 684 u8 TaskCtx; 685 u8 InternalCtx; 686 struct list_head list; 687 struct net_device *netdev; 688 struct list_head sas_topology; 689 struct mutex sas_topology_mutex; 690 691 struct workqueue_struct *fw_event_q; 692 struct list_head fw_event_list; 693 spinlock_t fw_event_lock; 694 u8 fw_events_off; /* if '1', then ignore events */ 695 char fw_event_q_name[MPT_KOBJ_NAME_LEN]; 696 697 struct mutex sas_discovery_mutex; 698 u8 sas_discovery_runtime; 699 u8 sas_discovery_ignore_events; 700 701 /* port_info object for the host */ 702 struct mptsas_portinfo *hba_port_info; 703 u64 hba_port_sas_addr; 704 u16 hba_port_num_phy; 705 struct list_head sas_device_info_list; 706 struct mutex sas_device_info_mutex; 707 u8 old_sas_discovery_protocal; 708 u8 sas_discovery_quiesce_io; 709 int sas_index; /* index refrencing */ 710 MPT_MGMT sas_mgmt; 711 MPT_MGMT mptbase_cmds; /* for sending config pages */ 712 MPT_MGMT internal_cmds; 713 MPT_MGMT taskmgmt_cmds; 714 MPT_MGMT ioctl_cmds; 715 spinlock_t taskmgmt_lock; /* diagnostic reset lock */ 716 int taskmgmt_in_progress; 717 u8 taskmgmt_quiesce_io; 718 u8 ioc_reset_in_progress; 719 MPT_SCHEDULE_TARGET_RESET schedule_target_reset; 720 struct work_struct sas_persist_task; 721 722 struct work_struct fc_setup_reset_work; 723 struct list_head fc_rports; 724 struct work_struct fc_lsc_work; 725 u8 fc_link_speed[2]; 726 spinlock_t fc_rescan_work_lock; 727 struct work_struct fc_rescan_work; 728 char fc_rescan_work_q_name[MPT_KOBJ_NAME_LEN]; 729 struct workqueue_struct *fc_rescan_work_q; 730 731 /* driver forced bus resets count */ 732 unsigned long hard_resets; 733 /* fw/external bus resets count */ 734 unsigned long soft_resets; 735 /* cmd timeouts */ 736 unsigned long timeouts; 737 738 struct scsi_cmnd **ScsiLookup; 739 spinlock_t scsi_lookup_lock; 740 u64 dma_mask; 741 u32 broadcast_aen_busy; 742 char reset_work_q_name[MPT_KOBJ_NAME_LEN]; 743 struct workqueue_struct *reset_work_q; 744 struct delayed_work fault_reset_work; 745 746 u8 sg_addr_size; 747 u8 in_rescan; 748 u8 SGE_size; 749 750} MPT_ADAPTER; 751 752/* 753 * New return value convention: 754 * 1 = Ok to free associated request frame 755 * 0 = not Ok ... 756 */ 757typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply); 758typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply); 759typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase); 760/* reset_phase defs */ 761#define MPT_IOC_PRE_RESET 0 762#define MPT_IOC_POST_RESET 1 763#define MPT_IOC_SETUP_RESET 2 764 765/* 766 * Invent MPT host event (super-set of MPI Events) 767 * Fitted to 1030's 64-byte [max] request frame size 768 */ 769typedef struct _MPT_HOST_EVENT { 770 EventNotificationReply_t MpiEvent; /* 8 32-bit words! */ 771 u32 pad[6]; 772 void *next; 773} MPT_HOST_EVENT; 774 775#define MPT_HOSTEVENT_IOC_BRINGUP 0x91 776#define MPT_HOSTEVENT_IOC_RECOVER 0x92 777 778/* Define the generic types based on the size 779 * of the dma_addr_t type. 780 */ 781typedef struct _mpt_sge { 782 u32 FlagsLength; 783 dma_addr_t Address; 784} MptSge_t; 785 786 787#define mpt_msg_flags(ioc) \ 788 (ioc->sg_addr_size == sizeof(u64)) ? \ 789 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \ 790 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32 791 792#define MPT_SGE_FLAGS_64_BIT_ADDRESSING \ 793 (MPI_SGE_FLAGS_64_BIT_ADDRESSING << MPI_SGE_FLAGS_SHIFT) 794 795/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 796/* 797 * Funky (private) macros... 798 */ 799#include "mptdebug.h" 800 801#define MPT_INDEX_2_MFPTR(ioc,idx) \ 802 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) ) 803 804#define MFPTR_2_MPT_INDEX(ioc,mf) \ 805 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz ) 806 807#define MPT_INDEX_2_RFPTR(ioc,idx) \ 808 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) ) 809 810/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 811 812#define SCSI_STD_SENSE_BYTES 18 813#define SCSI_STD_INQUIRY_BYTES 36 814#define SCSI_MAX_INQUIRY_BYTES 96 815 816/* 817 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers 818 * Private to the driver. 819 */ 820/* LOCAL structure and fields used when processing 821 * internally generated commands. These include: 822 * bus scan, dv and config requests. 823 */ 824typedef struct _MPT_LOCAL_REPLY { 825 ConfigPageHeader_t header; 826 int completion; 827 u8 sense[SCSI_STD_SENSE_BYTES]; 828 u8 scsiStatus; 829 u8 skip; 830 u32 pad; 831} MPT_LOCAL_REPLY; 832 833#define MPT_HOST_BUS_UNKNOWN (0xFF) 834#define MPT_HOST_TOO_MANY_TM (0x05) 835#define MPT_HOST_NVRAM_INVALID (0xFFFFFFFF) 836#define MPT_HOST_NO_CHAIN (0xFFFFFFFF) 837#define MPT_NVRAM_MASK_TIMEOUT (0x000000FF) 838#define MPT_NVRAM_SYNC_MASK (0x0000FF00) 839#define MPT_NVRAM_SYNC_SHIFT (8) 840#define MPT_NVRAM_DISCONNECT_ENABLE (0x00010000) 841#define MPT_NVRAM_ID_SCAN_ENABLE (0x00020000) 842#define MPT_NVRAM_LUN_SCAN_ENABLE (0x00040000) 843#define MPT_NVRAM_TAG_QUEUE_ENABLE (0x00080000) 844#define MPT_NVRAM_WIDE_DISABLE (0x00100000) 845#define MPT_NVRAM_BOOT_CHOICE (0x00200000) 846 847/* The TM_STATE variable is used to provide strict single threading of TM 848 * requests as well as communicate TM error conditions. 849 */ 850#define TM_STATE_NONE (0) 851#define TM_STATE_IN_PROGRESS (1) 852#define TM_STATE_ERROR (2) 853 854typedef enum { 855 FC, 856 SPI, 857 SAS 858} BUS_TYPE; 859 860typedef struct _MPT_SCSI_HOST { 861 MPT_ADAPTER *ioc; 862 ushort sel_timeout[MPT_MAX_FC_DEVICES]; 863 char *info_kbuf; 864 long last_queue_full; 865 u16 spi_pending; 866 struct list_head target_reset_list; 867} MPT_SCSI_HOST; 868 869/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 870/* 871 * More Dynamic Multi-Pathing stuff... 872 */ 873 874/* Forward decl, a strange C thing, to prevent gcc compiler warnings */ 875struct scsi_cmnd; 876 877/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 878/* 879 * Generic structure passed to the base mpt_config function. 880 */ 881typedef struct _x_config_parms { 882 union { 883 ConfigExtendedPageHeader_t *ehdr; 884 ConfigPageHeader_t *hdr; 885 } cfghdr; 886 dma_addr_t physAddr; 887 u32 pageAddr; /* properly formatted */ 888 u16 status; 889 u8 action; 890 u8 dir; 891 u8 timeout; /* seconds */ 892} CONFIGPARMS; 893 894/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 895/* 896 * Public entry points... 897 */ 898extern int mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id); 899extern void mpt_detach(struct pci_dev *pdev); 900#ifdef CONFIG_PM 901extern int mpt_suspend(struct pci_dev *pdev, pm_message_t state); 902extern int mpt_resume(struct pci_dev *pdev); 903#endif 904extern u8 mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass, 905 char *func_name); 906extern void mpt_deregister(u8 cb_idx); 907extern int mpt_event_register(u8 cb_idx, MPT_EVHANDLER ev_cbfunc); 908extern void mpt_event_deregister(u8 cb_idx); 909extern int mpt_reset_register(u8 cb_idx, MPT_RESETHANDLER reset_func); 910extern void mpt_reset_deregister(u8 cb_idx); 911extern int mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, u8 cb_idx); 912extern void mpt_device_driver_deregister(u8 cb_idx); 913extern MPT_FRAME_HDR *mpt_get_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc); 914extern void mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf); 915extern void mpt_put_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf); 916extern void mpt_put_msg_frame_hi_pri(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf); 917 918extern int mpt_send_handshake_request(u8 cb_idx, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag); 919extern int mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp); 920extern u32 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked); 921extern void mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan); 922extern int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag); 923extern int mpt_Soft_Hard_ResetHandler(MPT_ADAPTER *ioc, int sleepFlag); 924extern int mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg); 925extern int mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size); 926extern void mpt_free_fw_memory(MPT_ADAPTER *ioc); 927extern int mpt_findImVolumes(MPT_ADAPTER *ioc); 928extern int mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode); 929extern int mpt_raid_phys_disk_pg0(MPT_ADAPTER *ioc, u8 phys_disk_num, pRaidPhysDiskPage0_t phys_disk); 930extern int mpt_raid_phys_disk_pg1(MPT_ADAPTER *ioc, u8 phys_disk_num, 931 pRaidPhysDiskPage1_t phys_disk); 932extern int mpt_raid_phys_disk_get_num_paths(MPT_ADAPTER *ioc, 933 u8 phys_disk_num); 934extern int mpt_set_taskmgmt_in_progress_flag(MPT_ADAPTER *ioc); 935extern void mpt_clear_taskmgmt_in_progress_flag(MPT_ADAPTER *ioc); 936extern void mpt_halt_firmware(MPT_ADAPTER *ioc); 937 938 939/* 940 * Public data decl's... 941 */ 942extern struct list_head ioc_list; 943extern int mpt_fwfault_debug; 944 945/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 946#endif /* } __KERNEL__ */ 947 948#ifdef CONFIG_64BIT 949#define CAST_U32_TO_PTR(x) ((void *)(u64)x) 950#define CAST_PTR_TO_U32(x) ((u32)(u64)x) 951#else 952#define CAST_U32_TO_PTR(x) ((void *)x) 953#define CAST_PTR_TO_U32(x) ((u32)x) 954#endif 955 956#define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \ 957 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \ 958 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \ 959 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \ 960 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b' 961 962/* 963 * Shifted SGE Defines - Use in SGE with FlagsLength member. 964 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header). 965 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read 966 */ 967#define MPT_TRANSFER_IOC_TO_HOST (0x00000000) 968#define MPT_TRANSFER_HOST_TO_IOC (0x04000000) 969#define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000) 970#define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000) 971#define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000) 972#define MPT_SGE_FLAGS_DIRECTION (0x04000000) 973#define MPT_SGE_FLAGS_END_OF_LIST (0x01000000) 974 975#define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000) 976#define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000) 977#define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000) 978#define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000) 979 980#define MPT_SGE_FLAGS_SSIMPLE_READ \ 981 (MPT_SGE_FLAGS_LAST_ELEMENT | \ 982 MPT_SGE_FLAGS_END_OF_BUFFER | \ 983 MPT_SGE_FLAGS_END_OF_LIST | \ 984 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \ 985 MPT_TRANSFER_IOC_TO_HOST) 986#define MPT_SGE_FLAGS_SSIMPLE_WRITE \ 987 (MPT_SGE_FLAGS_LAST_ELEMENT | \ 988 MPT_SGE_FLAGS_END_OF_BUFFER | \ 989 MPT_SGE_FLAGS_END_OF_LIST | \ 990 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \ 991 MPT_TRANSFER_HOST_TO_IOC) 992 993/*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 994#endif 995