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