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 Logic Fusion MPT (Message Passing Technology) firmware. 7 * 8 * Copyright (c) 1999-2005 LSI Logic Corporation 9 * (mailto:mpt_linux_developer@lsil.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/version.h> 53 #include <linux/config.h> 54 #include <linux/kernel.h> 55 #include <linux/pci.h> 56 57 #include "lsi/mpi_type.h" 58 #include "lsi/mpi.h" /* Fusion MPI(nterface) basic defs */ 59 #include "lsi/mpi_ioc.h" /* Fusion MPT IOC(ontroller) defs */ 60 #include "lsi/mpi_cnfg.h" /* IOC configuration support */ 61 #include "lsi/mpi_init.h" /* SCSI Host (initiator) protocol support */ 62 #include "lsi/mpi_lan.h" /* LAN over FC protocol support */ 63 #include "lsi/mpi_raid.h" /* Integrated Mirroring support */ 64 65 #include "lsi/mpi_fc.h" /* Fibre Channel (lowlevel) support */ 66 #include "lsi/mpi_targ.h" /* SCSI/FCP Target protcol support */ 67 #include "lsi/mpi_tool.h" /* Tools support */ 68 69 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 70 71 #ifndef MODULEAUTHOR 72 #define MODULEAUTHOR "LSI Logic Corporation" 73 #endif 74 75 #ifndef COPYRIGHT 76 #define COPYRIGHT "Copyright (c) 1999-2005 " MODULEAUTHOR 77 #endif 78 79 #define MPT_LINUX_VERSION_COMMON "3.03.01" 80 #define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.03.01" 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 108 #define MPT_PROCFS_MPTBASEDIR "mpt" 109 /* chg it to "driver/fusion" ? */ 110 #define MPT_PROCFS_SUMMARY_ALL_NODE MPT_PROCFS_MPTBASEDIR "/summary" 111 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE 112 #define MPT_FW_REV_MAGIC_ID_STRING "FwRev=" 113 114 #define MPT_MAX_REQ_DEPTH 1023 115 #define MPT_DEFAULT_REQ_DEPTH 256 116 #define MPT_MIN_REQ_DEPTH 128 117 118 #define MPT_MAX_REPLY_DEPTH MPT_MAX_REQ_DEPTH 119 #define MPT_DEFAULT_REPLY_DEPTH 128 120 #define MPT_MIN_REPLY_DEPTH 8 121 #define MPT_MAX_REPLIES_PER_ISR 32 122 123 #define MPT_MAX_FRAME_SIZE 128 124 #define MPT_DEFAULT_FRAME_SIZE 128 125 126 #define MPT_REPLY_FRAME_SIZE 0x40 /* Must be a multiple of 8 */ 127 128 #define MPT_SG_REQ_128_SCALE 1 129 #define MPT_SG_REQ_96_SCALE 2 130 #define MPT_SG_REQ_64_SCALE 4 131 132 #define CAN_SLEEP 1 133 #define NO_SLEEP 0 134 135 #define MPT_COALESCING_TIMEOUT 0x10 136 137 /* 138 * SCSI transfer rate defines. 139 */ 140 #define MPT_ULTRA320 0x08 141 #define MPT_ULTRA160 0x09 142 #define MPT_ULTRA2 0x0A 143 #define MPT_ULTRA 0x0C 144 #define MPT_FAST 0x19 145 #define MPT_SCSI 0x32 146 #define MPT_ASYNC 0xFF 147 148 #define MPT_NARROW 0 149 #define MPT_WIDE 1 150 151 #define C0_1030 0x08 152 #define XL_929 0x01 153 154 155 /* 156 * Try to keep these at 2^N-1 157 */ 158 #define MPT_FC_CAN_QUEUE 127 159 #define MPT_SCSI_CAN_QUEUE 127 160 161 /* 162 * Set the MAX_SGE value based on user input. 163 */ 164 #ifdef CONFIG_FUSION_MAX_SGE 165 #if CONFIG_FUSION_MAX_SGE < 16 166 #define MPT_SCSI_SG_DEPTH 16 167 #elif CONFIG_FUSION_MAX_SGE > 128 168 #define MPT_SCSI_SG_DEPTH 128 169 #else 170 #define MPT_SCSI_SG_DEPTH CONFIG_FUSION_MAX_SGE 171 #endif 172 #else 173 #define MPT_SCSI_SG_DEPTH 40 174 #endif 175 176 #ifdef __KERNEL__ /* { */ 177 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 178 179 #include <linux/proc_fs.h> 180 181 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 182 /* 183 * Attempt semi-consistent error & warning msgs across 184 * MPT drivers. NOTE: Users of these macro defs must 185 * themselves define their own MYNAM. 186 */ 187 #define MYIOC_s_INFO_FMT KERN_INFO MYNAM ": %s: " 188 #define MYIOC_s_NOTE_FMT KERN_NOTICE MYNAM ": %s: " 189 #define MYIOC_s_WARN_FMT KERN_WARNING MYNAM ": %s: WARNING - " 190 #define MYIOC_s_ERR_FMT KERN_ERR MYNAM ": %s: ERROR - " 191 192 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 193 /* 194 * MPT protocol driver defs... 195 */ 196 typedef enum { 197 MPTBASE_DRIVER, /* MPT base class */ 198 MPTCTL_DRIVER, /* MPT ioctl class */ 199 MPTSPI_DRIVER, /* MPT SPI host class */ 200 MPTFC_DRIVER, /* MPT FC host class */ 201 MPTSAS_DRIVER, /* MPT SAS host class */ 202 MPTLAN_DRIVER, /* MPT LAN class */ 203 MPTSTM_DRIVER, /* MPT SCSI target mode class */ 204 MPTUNKNOWN_DRIVER 205 } MPT_DRIVER_CLASS; 206 207 struct mpt_pci_driver{ 208 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); 209 void (*remove) (struct pci_dev *dev); 210 }; 211 212 /* 213 * MPT adapter / port / bus / device info structures... 214 */ 215 216 typedef union _MPT_FRAME_TRACKER { 217 struct { 218 struct list_head list; 219 u32 arg1; 220 u32 pad; 221 void *argp1; 222 } linkage; 223 /* 224 * NOTE: When request frames are free, on the linkage structure 225 * contets are valid. All other values are invalid. 226 * In particular, do NOT reply on offset [2] 227 * (in words) being the * message context. 228 * The message context must be reset (computed via base address 229 * + an offset) prior to issuing any command. 230 * 231 * NOTE2: On non-32-bit systems, where pointers are LARGE, 232 * using the linkage pointers destroys our sacred MsgContext 233 * field contents. But we don't care anymore because these 234 * are now reset in mpt_put_msg_frame() just prior to sending 235 * a request off to the IOC. 236 */ 237 struct { 238 u32 __hdr[2]; 239 /* 240 * The following _MUST_ match the location of the 241 * MsgContext field in the MPT message headers. 242 */ 243 union { 244 u32 MsgContext; 245 struct { 246 u16 req_idx; /* Request index */ 247 u8 cb_idx; /* callback function index */ 248 u8 rsvd; 249 } fld; 250 } msgctxu; 251 } hwhdr; 252 /* 253 * Remark: 32 bit identifier: 254 * 31-24: reserved 255 * 23-16: call back index 256 * 15-0 : request index 257 */ 258 } MPT_FRAME_TRACKER; 259 260 /* 261 * We might want to view/access a frame as: 262 * 1) generic request header 263 * 2) SCSIIORequest 264 * 3) SCSIIOReply 265 * 4) MPIDefaultReply 266 * 5) frame tracker 267 */ 268 typedef struct _MPT_FRAME_HDR { 269 union { 270 MPIHeader_t hdr; 271 SCSIIORequest_t scsireq; 272 SCSIIOReply_t sreply; 273 ConfigReply_t configreply; 274 MPIDefaultReply_t reply; 275 MPT_FRAME_TRACKER frame; 276 } u; 277 } MPT_FRAME_HDR; 278 279 #define MPT_REQ_MSGFLAGS_DROPME 0x80 280 281 typedef struct _MPT_SGL_HDR { 282 SGESimple32_t sge[1]; 283 } MPT_SGL_HDR; 284 285 typedef struct _MPT_SGL64_HDR { 286 SGESimple64_t sge[1]; 287 } MPT_SGL64_HDR; 288 289 /* 290 * System interface register set 291 */ 292 293 typedef struct _SYSIF_REGS 294 { 295 u32 Doorbell; /* 00 System<->IOC Doorbell reg */ 296 u32 WriteSequence; /* 04 Write Sequence register */ 297 u32 Diagnostic; /* 08 Diagnostic register */ 298 u32 TestBase; /* 0C Test Base Address */ 299 u32 DiagRwData; /* 10 Read Write Data (fw download) */ 300 u32 DiagRwAddress; /* 14 Read Write Address (fw download)*/ 301 u32 Reserved1[6]; /* 18-2F reserved for future use */ 302 u32 IntStatus; /* 30 Interrupt Status */ 303 u32 IntMask; /* 34 Interrupt Mask */ 304 u32 Reserved2[2]; /* 38-3F reserved for future use */ 305 u32 RequestFifo; /* 40 Request Post/Free FIFO */ 306 u32 ReplyFifo; /* 44 Reply Post/Free FIFO */ 307 u32 Reserved3[2]; /* 48-4F reserved for future use */ 308 u32 HostIndex; /* 50 Host Index register */ 309 u32 Reserved4[15]; /* 54-8F */ 310 u32 Fubar; /* 90 For Fubar usage */ 311 u32 Reserved5[27]; /* 94-FF */ 312 } SYSIF_REGS; 313 314 /* 315 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h 316 * in conjunction with SYSIF_REGS accesses! 317 */ 318 319 320 /* 321 * Dynamic Multi-Pathing specific stuff... 322 */ 323 324 /* VirtDevice negoFlags field */ 325 #define MPT_TARGET_NO_NEGO_WIDE 0x01 326 #define MPT_TARGET_NO_NEGO_SYNC 0x02 327 #define MPT_TARGET_NO_NEGO_QAS 0x04 328 #define MPT_TAPE_NEGO_IDP 0x08 329 330 /* 331 * VirtDevice - FC LUN device or SCSI target device 332 */ 333 typedef struct _VirtDevice { 334 struct scsi_device *device; 335 u8 tflags; 336 u8 ioc_id; 337 u8 target_id; 338 u8 bus_id; 339 u8 minSyncFactor; /* 0xFF is async */ 340 u8 maxOffset; /* 0 if async */ 341 u8 maxWidth; /* 0 if narrow, 1 if wide */ 342 u8 negoFlags; /* bit field, see above */ 343 u8 raidVolume; /* set, if RAID Volume */ 344 u8 type; /* byte 0 of Inquiry data */ 345 u8 cflags; /* controller flags */ 346 u8 rsvd1raid; 347 u16 fc_phys_lun; 348 u16 fc_xlat_lun; 349 u32 num_luns; 350 u32 luns[8]; /* Max LUNs is 256 */ 351 u8 pad[4]; 352 u8 inq_data[8]; 353 /* IEEE Registered Extended Identifier 354 obtained via INQUIRY VPD page 0x83 */ 355 /* NOTE: Do not separate uniq_prepad and uniq_data 356 as they are treateed as a single entity in the code */ 357 u8 uniq_prepad[8]; 358 u8 uniq_data[20]; 359 u8 pad2[4]; 360 } VirtDevice; 361 362 /* 363 * Fibre Channel (SCSI) target device and associated defines... 364 */ 365 #define MPT_TARGET_DEFAULT_DV_STATUS 0x00 366 #define MPT_TARGET_FLAGS_VALID_NEGO 0x01 367 #define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02 368 #define MPT_TARGET_FLAGS_Q_YES 0x08 369 #define MPT_TARGET_FLAGS_VALID_56 0x10 370 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20 371 372 /* 373 * /proc/mpt interface 374 */ 375 typedef struct { 376 const char *name; 377 mode_t mode; 378 int pad; 379 read_proc_t *read_proc; 380 write_proc_t *write_proc; 381 } mpt_proc_entry_t; 382 383 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \ 384 do { \ 385 len -= offset; \ 386 if (len < request) { \ 387 *eof = 1; \ 388 if (len <= 0) \ 389 return 0; \ 390 } else \ 391 len = request; \ 392 *start = buf + offset; \ 393 return len; \ 394 } while (0) 395 396 397 /* 398 * IOCTL structure and associated defines 399 */ 400 401 #define MPT_IOCTL_STATUS_DID_IOCRESET 0x01 /* IOC Reset occurred on the current*/ 402 #define MPT_IOCTL_STATUS_RF_VALID 0x02 /* The Reply Frame is VALID */ 403 #define MPT_IOCTL_STATUS_TIMER_ACTIVE 0x04 /* The timer is running */ 404 #define MPT_IOCTL_STATUS_SENSE_VALID 0x08 /* Sense data is valid */ 405 #define MPT_IOCTL_STATUS_COMMAND_GOOD 0x10 /* Command Status GOOD */ 406 #define MPT_IOCTL_STATUS_TMTIMER_ACTIVE 0x20 /* The TM timer is running */ 407 #define MPT_IOCTL_STATUS_TM_FAILED 0x40 /* User TM request failed */ 408 409 #define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */ 410 411 typedef struct _MPT_IOCTL { 412 struct _MPT_ADAPTER *ioc; 413 u8 ReplyFrame[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */ 414 u8 sense[MPT_SENSE_BUFFER_ALLOC]; 415 int wait_done; /* wake-up value for this ioc */ 416 u8 rsvd; 417 u8 status; /* current command status */ 418 u8 reset; /* 1 if bus reset allowed */ 419 u8 target; /* target for reset */ 420 struct semaphore sem_ioc; 421 } MPT_IOCTL; 422 423 /* 424 * Event Structure and define 425 */ 426 #define MPTCTL_EVENT_LOG_SIZE (0x0000000A) 427 typedef struct _mpt_ioctl_events { 428 u32 event; /* Specified by define above */ 429 u32 eventContext; /* Index or counter */ 430 int data[2]; /* First 8 bytes of Event Data */ 431 } MPT_IOCTL_EVENTS; 432 433 /* 434 * CONFIGPARM status defines 435 */ 436 #define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS 437 #define MPT_CONFIG_ERROR 0x002F 438 439 /* 440 * Substructure to store SCSI specific configuration page data 441 */ 442 /* dvStatus defines: */ 443 #define MPT_SCSICFG_NEGOTIATE 0x01 /* Negotiate on next IO */ 444 #define MPT_SCSICFG_NEED_DV 0x02 /* Schedule DV */ 445 #define MPT_SCSICFG_DV_PENDING 0x04 /* DV on this physical id pending */ 446 #define MPT_SCSICFG_DV_NOT_DONE 0x08 /* DV has not been performed */ 447 #define MPT_SCSICFG_BLK_NEGO 0x10 /* WriteSDP1 with WDTR and SDTR disabled */ 448 #define MPT_SCSICFG_RELOAD_IOC_PG3 0x20 /* IOC Pg 3 data is obsolete */ 449 /* Args passed to writeSDP1: */ 450 #define MPT_SCSICFG_USE_NVRAM 0x01 /* WriteSDP1 using NVRAM */ 451 #define MPT_SCSICFG_ALL_IDS 0x02 /* WriteSDP1 to all IDS */ 452 /* #define MPT_SCSICFG_BLK_NEGO 0x10 WriteSDP1 with WDTR and SDTR disabled */ 453 454 typedef struct _ScsiCfgData { 455 u32 PortFlags; 456 int *nvram; /* table of device NVRAM values */ 457 IOCPage2_t *pIocPg2; /* table of Raid Volumes */ 458 IOCPage3_t *pIocPg3; /* table of physical disks */ 459 IOCPage4_t *pIocPg4; /* SEP devices addressing */ 460 dma_addr_t IocPg4_dma; /* Phys Addr of IOCPage4 data */ 461 int IocPg4Sz; /* IOCPage4 size */ 462 u8 dvStatus[MPT_MAX_SCSI_DEVICES]; 463 int isRaid; /* bit field, 1 if RAID */ 464 u8 minSyncFactor; /* 0xFF if async */ 465 u8 maxSyncOffset; /* 0 if async */ 466 u8 maxBusWidth; /* 0 if narrow, 1 if wide */ 467 u8 busType; /* SE, LVD, HD */ 468 u8 sdp1version; /* SDP1 version */ 469 u8 sdp1length; /* SDP1 length */ 470 u8 sdp0version; /* SDP0 version */ 471 u8 sdp0length; /* SDP0 length */ 472 u8 dvScheduled; /* 1 if scheduled */ 473 u8 forceDv; /* 1 to force DV scheduling */ 474 u8 noQas; /* Disable QAS for this adapter */ 475 u8 Saf_Te; /* 1 to force all Processors as SAF-TE if Inquiry data length is too short to check for SAF-TE */ 476 u8 mpt_dv; /* command line option: enhanced=1, basic=0 */ 477 u8 rsvd[1]; 478 } ScsiCfgData; 479 480 /* 481 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS 482 */ 483 typedef struct _MPT_ADAPTER 484 { 485 int id; /* Unique adapter id N {0,1,2,...} */ 486 int pci_irq; /* This irq */ 487 char name[MPT_NAME_LENGTH]; /* "iocN" */ 488 char *prod_name; /* "LSIFC9x9" */ 489 SYSIF_REGS __iomem *chip; /* == c8817000 (mmap) */ 490 SYSIF_REGS __iomem *pio_chip; /* Programmed IO (downloadboot) */ 491 u8 bus_type; 492 u32 mem_phys; /* == f4020000 (mmap) */ 493 u32 pio_mem_phys; /* Programmed IO (downloadboot) */ 494 int mem_size; /* mmap memory size */ 495 int alloc_total; 496 u32 last_state; 497 int active; 498 u8 *alloc; /* frames alloc ptr */ 499 dma_addr_t alloc_dma; 500 u32 alloc_sz; 501 MPT_FRAME_HDR *reply_frames; /* Reply msg frames - rounded up! */ 502 u32 reply_frames_low_dma; 503 int reply_depth; /* Num Allocated reply frames */ 504 int reply_sz; /* Reply frame size */ 505 int num_chain; /* Number of chain buffers */ 506 /* Pool of buffers for chaining. ReqToChain 507 * and ChainToChain track index of chain buffers. 508 * ChainBuffer (DMA) virt/phys addresses. 509 * FreeChainQ (lock) locking mechanisms. 510 */ 511 int *ReqToChain; 512 int *RequestNB; 513 int *ChainToChain; 514 u8 *ChainBuffer; 515 dma_addr_t ChainBufferDMA; 516 struct list_head FreeChainQ; 517 spinlock_t FreeChainQlock; 518 /* We (host driver) get to manage our own RequestQueue! */ 519 dma_addr_t req_frames_dma; 520 MPT_FRAME_HDR *req_frames; /* Request msg frames - rounded up! */ 521 u32 req_frames_low_dma; 522 int req_depth; /* Number of request frames */ 523 int req_sz; /* Request frame size (bytes) */ 524 spinlock_t FreeQlock; 525 struct list_head FreeQ; 526 /* Pool of SCSI sense buffers for commands coming from 527 * the SCSI mid-layer. We have one 256 byte sense buffer 528 * for each REQ entry. 529 */ 530 u8 *sense_buf_pool; 531 dma_addr_t sense_buf_pool_dma; 532 u32 sense_buf_low_dma; 533 int mtrr_reg; 534 struct pci_dev *pcidev; /* struct pci_dev pointer */ 535 u8 __iomem *memmap; /* mmap address */ 536 struct Scsi_Host *sh; /* Scsi Host pointer */ 537 ScsiCfgData spi_data; /* Scsi config. data */ 538 MPT_IOCTL *ioctl; /* ioctl data pointer */ 539 struct proc_dir_entry *ioc_dentry; 540 struct _MPT_ADAPTER *alt_ioc; /* ptr to 929 bound adapter port */ 541 spinlock_t diagLock; /* diagnostic reset lock */ 542 int diagPending; 543 u32 biosVersion; /* BIOS version from IO Unit Page 2 */ 544 int eventTypes; /* Event logging parameters */ 545 int eventContext; /* Next event context */ 546 int eventLogSize; /* Max number of cached events */ 547 struct _mpt_ioctl_events *events; /* pointer to event log */ 548 u8 *cached_fw; /* Pointer to FW */ 549 dma_addr_t cached_fw_dma; 550 struct list_head configQ; /* linked list of config. requests */ 551 int hs_reply_idx; 552 #ifndef MFCNT 553 u32 pad0; 554 #else 555 u32 mfcnt; 556 #endif 557 u32 NB_for_64_byte_frame; 558 u32 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)]; 559 u16 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)]; 560 IOCFactsReply_t facts; 561 PortFactsReply_t pfacts[2]; 562 FCPortPage0_t fc_port_page0[2]; 563 LANPage0_t lan_cnfg_page0; 564 LANPage1_t lan_cnfg_page1; 565 /* 566 * Description: errata_flag_1064 567 * If a PCIX read occurs within 1 or 2 cycles after the chip receives 568 * a split completion for a read data, an internal address pointer incorrectly 569 * increments by 32 bytes 570 */ 571 int errata_flag_1064; 572 u8 FirstWhoInit; 573 u8 upload_fw; /* If set, do a fw upload */ 574 u8 reload_fw; /* Force a FW Reload on next reset */ 575 u8 NBShiftFactor; /* NB Shift Factor based on Block Size (Facts) */ 576 u8 pad1[4]; 577 int DoneCtx; 578 int TaskCtx; 579 int InternalCtx; 580 struct list_head list; 581 struct net_device *netdev; 582 } MPT_ADAPTER; 583 584 /* 585 * New return value convention: 586 * 1 = Ok to free associated request frame 587 * 0 = not Ok ... 588 */ 589 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply); 590 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply); 591 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase); 592 /* reset_phase defs */ 593 #define MPT_IOC_PRE_RESET 0 594 #define MPT_IOC_POST_RESET 1 595 #define MPT_IOC_SETUP_RESET 2 596 597 /* 598 * Invent MPT host event (super-set of MPI Events) 599 * Fitted to 1030's 64-byte [max] request frame size 600 */ 601 typedef struct _MPT_HOST_EVENT { 602 EventNotificationReply_t MpiEvent; /* 8 32-bit words! */ 603 u32 pad[6]; 604 void *next; 605 } MPT_HOST_EVENT; 606 607 #define MPT_HOSTEVENT_IOC_BRINGUP 0x91 608 #define MPT_HOSTEVENT_IOC_RECOVER 0x92 609 610 /* Define the generic types based on the size 611 * of the dma_addr_t type. 612 */ 613 typedef struct _mpt_sge { 614 u32 FlagsLength; 615 dma_addr_t Address; 616 } MptSge_t; 617 618 #define mpt_addr_size() \ 619 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \ 620 MPI_SGE_FLAGS_32_BIT_ADDRESSING) 621 622 #define mpt_msg_flags() \ 623 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \ 624 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32) 625 626 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 627 /* 628 * Funky (private) macros... 629 */ 630 #ifdef MPT_DEBUG 631 #define dprintk(x) printk x 632 #else 633 #define dprintk(x) 634 #endif 635 636 #ifdef MPT_DEBUG_INIT 637 #define dinitprintk(x) printk x 638 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) \ 639 { int i, n = 10; \ 640 u32 *m = (u32 *)(mfp); \ 641 printk(KERN_INFO " "); \ 642 for (i=0; i<n; i++) \ 643 printk(" %08x", le32_to_cpu(m[i])); \ 644 printk("\n"); \ 645 } 646 #else 647 #define dinitprintk(x) 648 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) 649 #endif 650 651 #ifdef MPT_DEBUG_EXIT 652 #define dexitprintk(x) printk x 653 #else 654 #define dexitprintk(x) 655 #endif 656 657 #if defined MPT_DEBUG_FAIL || defined (MPT_DEBUG_SG) 658 #define dfailprintk(x) printk x 659 #else 660 #define dfailprintk(x) 661 #endif 662 663 #ifdef MPT_DEBUG_HANDSHAKE 664 #define dhsprintk(x) printk x 665 #else 666 #define dhsprintk(x) 667 #endif 668 669 #ifdef MPT_DEBUG_EVENTS 670 #define devtprintk(x) printk x 671 #else 672 #define devtprintk(x) 673 #endif 674 675 #ifdef MPT_DEBUG_RESET 676 #define drsprintk(x) printk x 677 #else 678 #define drsprintk(x) 679 #endif 680 681 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME) 682 #if defined(MPT_DEBUG_MSG_FRAME) 683 #define dmfprintk(x) printk x 684 #define DBG_DUMP_REQUEST_FRAME(mfp) \ 685 { int i, n = 24; \ 686 u32 *m = (u32 *)(mfp); \ 687 for (i=0; i<n; i++) { \ 688 if (i && ((i%8)==0)) \ 689 printk("\n"); \ 690 printk("%08x ", le32_to_cpu(m[i])); \ 691 } \ 692 printk("\n"); \ 693 } 694 #else 695 #define dmfprintk(x) 696 #define DBG_DUMP_REQUEST_FRAME(mfp) 697 #endif 698 699 #ifdef MPT_DEBUG_IRQ 700 #define dirqprintk(x) printk x 701 #else 702 #define dirqprintk(x) 703 #endif 704 705 #ifdef MPT_DEBUG_SG 706 #define dsgprintk(x) printk x 707 #else 708 #define dsgprintk(x) 709 #endif 710 711 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG) 712 #define ddlprintk(x) printk x 713 #else 714 #define ddlprintk(x) 715 #endif 716 717 #ifdef MPT_DEBUG_DV 718 #define ddvprintk(x) printk x 719 #else 720 #define ddvprintk(x) 721 #endif 722 723 #ifdef MPT_DEBUG_NEGO 724 #define dnegoprintk(x) printk x 725 #else 726 #define dnegoprintk(x) 727 #endif 728 729 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY) 730 #define ddvtprintk(x) printk x 731 #else 732 #define ddvtprintk(x) 733 #endif 734 735 #ifdef MPT_DEBUG_IOCTL 736 #define dctlprintk(x) printk x 737 #else 738 #define dctlprintk(x) 739 #endif 740 741 #ifdef MPT_DEBUG_REPLY 742 #define dreplyprintk(x) printk x 743 #else 744 #define dreplyprintk(x) 745 #endif 746 747 #ifdef MPT_DEBUG_TM 748 #define dtmprintk(x) printk x 749 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) \ 750 { u32 *m = (u32 *)(mfp); \ 751 int i, n = 13; \ 752 printk("TM_REQUEST:\n"); \ 753 for (i=0; i<n; i++) { \ 754 if (i && ((i%8)==0)) \ 755 printk("\n"); \ 756 printk("%08x ", le32_to_cpu(m[i])); \ 757 } \ 758 printk("\n"); \ 759 } 760 #define DBG_DUMP_TM_REPLY_FRAME(mfp) \ 761 { u32 *m = (u32 *)(mfp); \ 762 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \ 763 printk("TM_REPLY MessageLength=%d:\n", n); \ 764 for (i=0; i<n; i++) { \ 765 if (i && ((i%8)==0)) \ 766 printk("\n"); \ 767 printk(" %08x", le32_to_cpu(m[i])); \ 768 } \ 769 printk("\n"); \ 770 } 771 #else 772 #define dtmprintk(x) 773 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) 774 #define DBG_DUMP_TM_REPLY_FRAME(mfp) 775 #endif 776 777 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG) 778 #define dcprintk(x) printk x 779 #else 780 #define dcprintk(x) 781 #endif 782 783 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME) 784 #define dsprintk(x) printk x 785 #else 786 #define dsprintk(x) 787 #endif 788 789 790 #define MPT_INDEX_2_MFPTR(ioc,idx) \ 791 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) ) 792 793 #define MFPTR_2_MPT_INDEX(ioc,mf) \ 794 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz ) 795 796 #define MPT_INDEX_2_RFPTR(ioc,idx) \ 797 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) ) 798 799 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME) 800 #define DBG_DUMP_REPLY_FRAME(mfp) \ 801 { u32 *m = (u32 *)(mfp); \ 802 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \ 803 printk(KERN_INFO " "); \ 804 for (i=0; i<n; i++) \ 805 printk(" %08x", le32_to_cpu(m[i])); \ 806 printk("\n"); \ 807 } 808 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \ 809 { int i, n = 3; \ 810 u32 *m = (u32 *)(mfp); \ 811 printk(KERN_INFO " "); \ 812 for (i=0; i<n; i++) \ 813 printk(" %08x", le32_to_cpu(m[i])); \ 814 printk("\n"); \ 815 } 816 #else 817 #define DBG_DUMP_REPLY_FRAME(mfp) 818 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) 819 #endif 820 821 822 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 823 824 #define SCSI_STD_SENSE_BYTES 18 825 #define SCSI_STD_INQUIRY_BYTES 36 826 #define SCSI_MAX_INQUIRY_BYTES 96 827 828 /* 829 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers 830 * Private to the driver. 831 */ 832 /* LOCAL structure and fields used when processing 833 * internally generated commands. These include: 834 * bus scan, dv and config requests. 835 */ 836 typedef struct _MPT_LOCAL_REPLY { 837 ConfigPageHeader_t header; 838 int completion; 839 u8 sense[SCSI_STD_SENSE_BYTES]; 840 u8 scsiStatus; 841 u8 skip; 842 u32 pad; 843 } MPT_LOCAL_REPLY; 844 845 #define MPT_HOST_BUS_UNKNOWN (0xFF) 846 #define MPT_HOST_TOO_MANY_TM (0x05) 847 #define MPT_HOST_NVRAM_INVALID (0xFFFFFFFF) 848 #define MPT_HOST_NO_CHAIN (0xFFFFFFFF) 849 #define MPT_NVRAM_MASK_TIMEOUT (0x000000FF) 850 #define MPT_NVRAM_SYNC_MASK (0x0000FF00) 851 #define MPT_NVRAM_SYNC_SHIFT (8) 852 #define MPT_NVRAM_DISCONNECT_ENABLE (0x00010000) 853 #define MPT_NVRAM_ID_SCAN_ENABLE (0x00020000) 854 #define MPT_NVRAM_LUN_SCAN_ENABLE (0x00040000) 855 #define MPT_NVRAM_TAG_QUEUE_ENABLE (0x00080000) 856 #define MPT_NVRAM_WIDE_DISABLE (0x00100000) 857 #define MPT_NVRAM_BOOT_CHOICE (0x00200000) 858 859 /* The TM_STATE variable is used to provide strict single threading of TM 860 * requests as well as communicate TM error conditions. 861 */ 862 #define TM_STATE_NONE (0) 863 #define TM_STATE_IN_PROGRESS (1) 864 #define TM_STATE_ERROR (2) 865 866 typedef enum { 867 FC, 868 SCSI, 869 SAS 870 } BUS_TYPE; 871 872 typedef struct _MPT_SCSI_HOST { 873 MPT_ADAPTER *ioc; 874 int port; 875 u32 pad0; 876 struct scsi_cmnd **ScsiLookup; 877 VirtDevice **Targets; 878 MPT_LOCAL_REPLY *pLocal; /* used for internal commands */ 879 struct timer_list timer; 880 /* Pool of memory for holding SCpnts before doing 881 * OS callbacks. freeQ is the free pool. 882 */ 883 u8 tmPending; 884 u8 resetPending; 885 u8 negoNvram; /* DV disabled, nego NVRAM */ 886 u8 pad1; 887 u8 tmState; 888 u8 rsvd[2]; 889 MPT_FRAME_HDR *cmdPtr; /* Ptr to nonOS request */ 890 struct scsi_cmnd *abortSCpnt; 891 MPT_LOCAL_REPLY localReply; /* internal cmd reply struct */ 892 unsigned long hard_resets; /* driver forced bus resets count */ 893 unsigned long soft_resets; /* fw/external bus resets count */ 894 unsigned long timeouts; /* cmd timeouts */ 895 ushort sel_timeout[MPT_MAX_FC_DEVICES]; 896 char *info_kbuf; 897 wait_queue_head_t scandv_waitq; 898 int scandv_wait_done; 899 long last_queue_full; 900 u8 mpt_pq_filter; 901 } MPT_SCSI_HOST; 902 903 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 904 /* 905 * More Dynamic Multi-Pathing stuff... 906 */ 907 908 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */ 909 struct scsi_cmnd; 910 911 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 912 /* 913 * Generic structure passed to the base mpt_config function. 914 */ 915 typedef struct _x_config_parms { 916 struct list_head linkage; /* linked list */ 917 struct timer_list timer; /* timer function for this request */ 918 ConfigPageHeader_t *hdr; 919 dma_addr_t physAddr; 920 int wait_done; /* wait for this request */ 921 u32 pageAddr; /* properly formatted */ 922 u8 action; 923 u8 dir; 924 u8 timeout; /* seconds */ 925 u8 pad1; 926 u16 status; 927 u16 pad2; 928 } CONFIGPARMS; 929 930 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 931 /* 932 * Public entry points... 933 */ 934 extern int mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id); 935 extern void mpt_detach(struct pci_dev *pdev); 936 #ifdef CONFIG_PM 937 extern int mpt_suspend(struct pci_dev *pdev, pm_message_t state); 938 extern int mpt_resume(struct pci_dev *pdev); 939 #endif 940 extern int mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass); 941 extern void mpt_deregister(int cb_idx); 942 extern int mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc); 943 extern void mpt_event_deregister(int cb_idx); 944 extern int mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func); 945 extern void mpt_reset_deregister(int cb_idx); 946 extern int mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx); 947 extern void mpt_device_driver_deregister(int cb_idx); 948 extern MPT_FRAME_HDR *mpt_get_msg_frame(int handle, MPT_ADAPTER *ioc); 949 extern void mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf); 950 extern void mpt_put_msg_frame(int handle, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf); 951 extern void mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr); 952 953 extern int mpt_send_handshake_request(int handle, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag); 954 extern int mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp); 955 extern u32 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked); 956 extern void mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan); 957 extern int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag); 958 extern int mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg); 959 extern int mpt_toolbox(MPT_ADAPTER *ioc, CONFIGPARMS *cfg); 960 extern void mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size); 961 extern void mpt_free_fw_memory(MPT_ADAPTER *ioc); 962 extern int mpt_findImVolumes(MPT_ADAPTER *ioc); 963 extern int mpt_read_ioc_pg_3(MPT_ADAPTER *ioc); 964 965 /* 966 * Public data decl's... 967 */ 968 extern struct list_head ioc_list; 969 extern struct proc_dir_entry *mpt_proc_root_dir; 970 971 extern int mpt_lan_index; /* needed by mptlan.c */ 972 extern int mpt_stm_index; /* needed by mptstm.c */ 973 974 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 975 #endif /* } __KERNEL__ */ 976 977 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__) 978 #define CAST_U32_TO_PTR(x) ((void *)(u64)x) 979 #define CAST_PTR_TO_U32(x) ((u32)(u64)x) 980 #else 981 #define CAST_U32_TO_PTR(x) ((void *)x) 982 #define CAST_PTR_TO_U32(x) ((u32)x) 983 #endif 984 985 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \ 986 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \ 987 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \ 988 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \ 989 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b' 990 991 /* 992 * Shifted SGE Defines - Use in SGE with FlagsLength member. 993 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header). 994 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read 995 */ 996 #define MPT_TRANSFER_IOC_TO_HOST (0x00000000) 997 #define MPT_TRANSFER_HOST_TO_IOC (0x04000000) 998 #define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000) 999 #define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000) 1000 #define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000) 1001 #define MPT_SGE_FLAGS_DIRECTION (0x04000000) 1002 #define MPT_SGE_FLAGS_ADDRESSING (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT) 1003 #define MPT_SGE_FLAGS_END_OF_LIST (0x01000000) 1004 1005 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000) 1006 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000) 1007 #define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000) 1008 #define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000) 1009 1010 #define MPT_SGE_FLAGS_SSIMPLE_READ \ 1011 (MPT_SGE_FLAGS_LAST_ELEMENT | \ 1012 MPT_SGE_FLAGS_END_OF_BUFFER | \ 1013 MPT_SGE_FLAGS_END_OF_LIST | \ 1014 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \ 1015 MPT_SGE_FLAGS_ADDRESSING | \ 1016 MPT_TRANSFER_IOC_TO_HOST) 1017 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \ 1018 (MPT_SGE_FLAGS_LAST_ELEMENT | \ 1019 MPT_SGE_FLAGS_END_OF_BUFFER | \ 1020 MPT_SGE_FLAGS_END_OF_LIST | \ 1021 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \ 1022 MPT_SGE_FLAGS_ADDRESSING | \ 1023 MPT_TRANSFER_HOST_TO_IOC) 1024 1025 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/ 1026 #endif 1027 1028