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