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