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