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