drivers/scsi/3w-9xxx.h

   1 /*
   2    3w-9xxx.h -- 3ware 9000 Storage Controller device driver for Linux.
   3
   4    Written By: Adam Radford <linuxraid@amcc.com>
   5
   6    Copyright (C) 2004 Applied Micro Circuits Corporation.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; version 2 of the License.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    NO WARRANTY
  18    THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
  19    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
  20    LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
  21    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
  22    solely responsible for determining the appropriateness of using and
  23    distributing the Program and assumes all risks associated with its
  24    exercise of rights under this Agreement, including but not limited to
  25    the risks and costs of program errors, damage to or loss of data,
  26    programs or equipment, and unavailability or interruption of operations.
  27
  28    DISCLAIMER OF LIABILITY
  29    NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
  30    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31    DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
  32    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  33    TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  34    USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
  35    HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
  36
  37    You should have received a copy of the GNU General Public License
  38    along with this program; if not, write to the Free Software
  39    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  40
  41    Bugs/Comments/Suggestions should be mailed to:
  42    linuxraid@amcc.com
  43
  44    For more information, goto:
  45    http://www.amcc.com
  46 */
  47
  48 #ifndef _3W_9XXX_H
  49 #define _3W_9XXX_H
  50
  51 /* AEN string type */
  52 typedef struct TAG_twa_message_type {
  53   unsigned int   code;
  54   char*          text;
  55 } twa_message_type;
  56
  57 /* AEN strings */
  58 static twa_message_type twa_aen_table[] = {
  59         {0x0000, "AEN queue empty"},
  60         {0x0001, "Controller reset occurred"},
  61         {0x0002, "Degraded unit detected"},
  62         {0x0003, "Controller error occured"},
  63         {0x0004, "Background rebuild failed"},
  64         {0x0005, "Background rebuild done"},
  65         {0x0006, "Incomplete unit detected"},
  66         {0x0007, "Background initialize done"},
  67         {0x0008, "Unclean shutdown detected"},
  68         {0x0009, "Drive timeout detected"},
  69         {0x000A, "Drive error detected"},
  70         {0x000B, "Rebuild started"},
  71         {0x000C, "Background initialize started"},
  72         {0x000D, "Entire logical unit was deleted"},
  73         {0x000E, "Background initialize failed"},
  74         {0x000F, "SMART attribute exceeded threshold"},
  75         {0x0010, "Power supply reported AC under range"},
  76         {0x0011, "Power supply reported DC out of range"},
  77         {0x0012, "Power supply reported a malfunction"},
  78         {0x0013, "Power supply predicted malfunction"},
  79         {0x0014, "Battery charge is below threshold"},
  80         {0x0015, "Fan speed is below threshold"},
  81         {0x0016, "Temperature sensor is above threshold"},
  82         {0x0017, "Power supply was removed"},
  83         {0x0018, "Power supply was inserted"},
  84         {0x0019, "Drive was removed from a bay"},
  85         {0x001A, "Drive was inserted into a bay"},
  86         {0x001B, "Drive bay cover door was opened"},
  87         {0x001C, "Drive bay cover door was closed"},
  88         {0x001D, "Product case was opened"},
  89         {0x0020, "Prepare for shutdown (power-off)"},
  90         {0x0021, "Downgrade UDMA mode to lower speed"},
  91         {0x0022, "Upgrade UDMA mode to higher speed"},
  92         {0x0023, "Sector repair completed"},
  93         {0x0024, "Sbuf memory test failed"},
  94         {0x0025, "Error flushing cached write data to array"},
  95         {0x0026, "Drive reported data ECC error"},
  96         {0x0027, "DCB has checksum error"},
  97         {0x0028, "DCB version is unsupported"},
  98         {0x0029, "Background verify started"},
  99         {0x002A, "Background verify failed"},
 100         {0x002B, "Background verify done"},
 101         {0x002C, "Bad sector overwritten during rebuild"},
 102         {0x002D, "Background rebuild error on source drive"},
 103         {0x002E, "Replace failed because replacement drive too small"},
 104         {0x002F, "Verify failed because array was never initialized"},
 105         {0x0030, "Unsupported ATA drive"},
 106         {0x0031, "Synchronize host/controller time"},
 107         {0x0032, "Spare capacity is inadequate for some units"},
 108         {0x0033, "Background migration started"},
 109         {0x0034, "Background migration failed"},
 110         {0x0035, "Background migration done"},
 111         {0x0036, "Verify detected and fixed data/parity mismatch"},
 112         {0x0037, "SO-DIMM incompatible"},
 113         {0x0038, "SO-DIMM not detected"},
 114         {0x0039, "Corrected Sbuf ECC error"},
 115         {0x003A, "Drive power on reset detected"},
 116         {0x003B, "Background rebuild paused"},
 117         {0x003C, "Background initialize paused"},
 118         {0x003D, "Background verify paused"},
 119         {0x003E, "Background migration paused"},
 120         {0x003F, "Corrupt flash file system detected"},
 121         {0x0040, "Flash file system repaired"},
 122         {0x0041, "Unit number assignments were lost"},
 123         {0x0042, "Error during read of primary DCB"},
 124         {0x0043, "Latent error found in backup DCB"},
 125         {0x00FC, "Recovered/finished array membership update"},
 126         {0x00FD, "Handler lockup"},
 127         {0x00FE, "Retrying PCI transfer"},
 128         {0x00FF, "AEN queue is full"},
 129         {0xFFFFFFFF, (char*) 0}
 130 };
 131
 132 /* AEN severity table */
 133 static char *twa_aen_severity_table[] =
 134 {
 135         "None", "ERROR", "WARNING", "INFO", "DEBUG", (char*) 0
 136 };
 137
 138 /* Error strings */
 139 static twa_message_type twa_error_table[] = {
 140         {0x0100, "SGL entry contains zero data"},
 141         {0x0101, "Invalid command opcode"},
 142         {0x0102, "SGL entry has unaligned address"},
 143         {0x0103, "SGL size does not match command"},
 144         {0x0104, "SGL entry has illegal length"},
 145         {0x0105, "Command packet is not aligned"},
 146         {0x0106, "Invalid request ID"},
 147         {0x0107, "Duplicate request ID"},
 148         {0x0108, "ID not locked"},
 149         {0x0109, "LBA out of range"},
 150         {0x010A, "Logical unit not supported"},
 151         {0x010B, "Parameter table does not exist"},
 152         {0x010C, "Parameter index does not exist"},
 153         {0x010D, "Invalid field in CDB"},
 154         {0x010E, "Specified port has invalid drive"},
 155         {0x010F, "Parameter item size mismatch"},
 156         {0x0110, "Failed memory allocation"},
 157         {0x0111, "Memory request too large"},
 158         {0x0112, "Out of memory segments"},
 159         {0x0113, "Invalid address to deallocate"},
 160         {0x0114, "Out of memory"},
 161         {0x0115, "Out of heap"},
 162         {0x0120, "Double degrade"},
 163         {0x0121, "Drive not degraded"},
 164         {0x0122, "Reconstruct error"},
 165         {0x0123, "Replace not accepted"},
 166         {0x0124, "Replace drive capacity too small"},
 167         {0x0125, "Sector count not allowed"},
 168         {0x0126, "No spares left"},
 169         {0x0127, "Reconstruct error"},
 170         {0x0128, "Unit is offline"},
 171         {0x0129, "Cannot update status to DCB"},
 172         {0x0130, "Invalid stripe handle"},
 173         {0x0131, "Handle that was not locked"},
 174         {0x0132, "Handle that was not empty"},
 175         {0x0133, "Handle has different owner"},
 176         {0x0140, "IPR has parent"},
 177         {0x0150, "Illegal Pbuf address alignment"},
 178         {0x0151, "Illegal Pbuf transfer length"},
 179         {0x0152, "Illegal Sbuf address alignment"},
 180         {0x0153, "Illegal Sbuf transfer length"},
 181         {0x0160, "Command packet too large"},
 182         {0x0161, "SGL exceeds maximum length"},
 183         {0x0162, "SGL has too many entries"},
 184         {0x0170, "Insufficient resources for rebuilder"},
 185         {0x0171, "Verify error (data != parity)"},
 186         {0x0180, "Requested segment not in directory of this DCB"},
 187         {0x0181, "DCB segment has unsupported version"},
 188         {0x0182, "DCB segment has checksum error"},
 189         {0x0183, "DCB support (settings) segment invalid"},
 190         {0x0184, "DCB UDB (unit descriptor block) segment invalid"},
 191         {0x0185, "DCB GUID (globally unique identifier) segment invalid"},
 192         {0x01A0, "Could not clear Sbuf"},
 193         {0x01C0, "Flash identify failed"},
 194         {0x01C1, "Flash out of bounds"},
 195         {0x01C2, "Flash verify error"},
 196         {0x01C3, "Flash file object not found"},
 197         {0x01C4, "Flash file already present"},
 198         {0x01C5, "Flash file system full"},
 199         {0x01C6, "Flash file not present"},
 200         {0x01C7, "Flash file size error"},
 201         {0x01C8, "Bad flash file checksum"},
 202         {0x01CA, "Corrupt flash file system detected"},
 203         {0x01D0, "Invalid field in parameter list"},
 204         {0x01D1, "Parameter list length error"},
 205         {0x01D2, "Parameter item is not changeable"},
 206         {0x01D3, "Parameter item is not saveable"},
 207         {0x0200, "UDMA CRC error"},
 208         {0x0201, "Internal CRC error"},
 209         {0x0202, "Data ECC error"},
 210         {0x0203, "ADP level 1 error"},
 211         {0x0204, "Port timeout"},
 212         {0x0205, "Drive power on reset"},
 213         {0x0206, "ADP level 2 error"},
 214         {0x0207, "Soft reset failed"},
 215         {0x0208, "Drive not ready"},
 216         {0x0209, "Unclassified port error"},
 217         {0x020A, "Drive aborted command"},
 218         {0x0210, "Internal CRC error"},
 219         {0x0211, "PCI abort error"},
 220         {0x0212, "PCI parity error"},
 221         {0x0213, "Port handler error"},
 222         {0x0214, "Token interrupt count error"},
 223         {0x0215, "Timeout waiting for PCI transfer"},
 224         {0x0216, "Corrected buffer ECC"},
 225         {0x0217, "Uncorrected buffer ECC"},
 226         {0x0230, "Unsupported command during flash recovery"},
 227         {0x0231, "Next image buffer expected"},
 228         {0x0232, "Binary image architecture incompatible"},
 229         {0x0233, "Binary image has no signature"},
 230         {0x0234, "Binary image has bad checksum"},
 231         {0x0235, "Image downloaded overflowed buffer"},
 232         {0x0240, "I2C device not found"},
 233         {0x0241, "I2C transaction aborted"},
 234         {0x0242, "SO-DIMM parameter(s) incompatible using defaults"},
 235         {0x0243, "SO-DIMM unsupported"},
 236         {0x0248, "SPI transfer status error"},
 237         {0x0249, "SPI transfer timeout error"},
 238         {0x0250, "Invalid unit descriptor size in CreateUnit"},
 239         {0x0251, "Unit descriptor size exceeds data buffer in CreateUnit"},
 240         {0x0252, "Invalid value in CreateUnit descriptor"},
 241         {0x0253, "Inadequate disk space to support descriptor in CreateUnit"},
 242         {0x0254, "Unable to create data channel for this unit descriptor"},
 243         {0x0255, "CreateUnit descriptor specifies a drive already in use"},
 244         {0x0256, "Unable to write configuration to all disks during CreateUnit"},
 245         {0x0257, "CreateUnit does not support this descriptor version"},
 246         {0x0258, "Invalid subunit for RAID 0 or 5 in CreateUnit"},
 247         {0x0259, "Too many descriptors in CreateUnit"},
 248         {0x025A, "Invalid configuration specified in CreateUnit descriptor"},
 249         {0x025B, "Invalid LBA offset specified in CreateUnit descriptor"},
 250         {0x025C, "Invalid stripelet size specified in CreateUnit descriptor"},
 251         {0x0260, "SMART attribute exceeded threshold"},
 252         {0xFFFFFFFF, (char*) 0}
 253 };
 254
 255 /* Control register bit definitions */
 256 #define TW_CONTROL_CLEAR_HOST_INTERRUPT        0x00080000
 257 #define TW_CONTROL_CLEAR_ATTENTION_INTERRUPT   0x00040000
 258 #define TW_CONTROL_MASK_COMMAND_INTERRUPT      0x00020000
 259 #define TW_CONTROL_MASK_RESPONSE_INTERRUPT     0x00010000
 260 #define TW_CONTROL_UNMASK_COMMAND_INTERRUPT    0x00008000
 261 #define TW_CONTROL_UNMASK_RESPONSE_INTERRUPT   0x00004000
 262 #define TW_CONTROL_CLEAR_ERROR_STATUS          0x00000200
 263 #define TW_CONTROL_ISSUE_SOFT_RESET            0x00000100
 264 #define TW_CONTROL_ENABLE_INTERRUPTS           0x00000080
 265 #define TW_CONTROL_DISABLE_INTERRUPTS          0x00000040
 266 #define TW_CONTROL_ISSUE_HOST_INTERRUPT        0x00000020
 267 #define TW_CONTROL_CLEAR_PARITY_ERROR          0x00800000
 268 #define TW_CONTROL_CLEAR_QUEUE_ERROR           0x00400000
 269 #define TW_CONTROL_CLEAR_PCI_ABORT             0x00100000
 270 #define TW_CONTROL_CLEAR_SBUF_WRITE_ERROR      0x00000008
 271
 272 /* Status register bit definitions */
 273 #define TW_STATUS_MAJOR_VERSION_MASK           0xF0000000
 274 #define TW_STATUS_MINOR_VERSION_MASK           0x0F000000
 275 #define TW_STATUS_PCI_PARITY_ERROR             0x00800000
 276 #define TW_STATUS_QUEUE_ERROR                  0x00400000
 277 #define TW_STATUS_MICROCONTROLLER_ERROR        0x00200000
 278 #define TW_STATUS_PCI_ABORT                    0x00100000
 279 #define TW_STATUS_HOST_INTERRUPT               0x00080000
 280 #define TW_STATUS_ATTENTION_INTERRUPT          0x00040000
 281 #define TW_STATUS_COMMAND_INTERRUPT            0x00020000
 282 #define TW_STATUS_RESPONSE_INTERRUPT           0x00010000
 283 #define TW_STATUS_COMMAND_QUEUE_FULL           0x00008000
 284 #define TW_STATUS_RESPONSE_QUEUE_EMPTY         0x00004000
 285 #define TW_STATUS_MICROCONTROLLER_READY        0x00002000
 286 #define TW_STATUS_COMMAND_QUEUE_EMPTY          0x00001000
 287 #define TW_STATUS_EXPECTED_BITS                0x00002000
 288 #define TW_STATUS_UNEXPECTED_BITS              0x00F00008
 289 #define TW_STATUS_SBUF_WRITE_ERROR             0x00000008
 290 #define TW_STATUS_VALID_INTERRUPT              0x00DF0008
 291
 292 /* RESPONSE QUEUE BIT DEFINITIONS */
 293 #define TW_RESPONSE_ID_MASK                    0x00000FF0
 294
 295 /* PCI related defines */
 296 #define TW_DEVICE_NAME                         "3w-9xxx"
 297 #define TW_NUMDEVICES 1
 298 #define TW_PCI_CLEAR_PARITY_ERRORS 0xc100
 299 #define TW_PCI_CLEAR_PCI_ABORT     0x2000
 300
 301 /* Command packet opcodes used by the driver */
 302 #define TW_OP_INIT_CONNECTION 0x1
 303 #define TW_OP_GET_PARAM       0x12
 304 #define TW_OP_SET_PARAM       0x13
 305 #define TW_OP_EXECUTE_SCSI    0x10
 306 #define TW_OP_DOWNLOAD_FIRMWARE 0x16
 307 #define TW_OP_RESET             0x1C
 308
 309 /* Asynchronous Event Notification (AEN) codes used by the driver */
 310 #define TW_AEN_QUEUE_EMPTY       0x0000
 311 #define TW_AEN_SOFT_RESET        0x0001
 312 #define TW_AEN_SYNC_TIME_WITH_HOST 0x031
 313 #define TW_AEN_SEVERITY_ERROR    0x1
 314 #define TW_AEN_SEVERITY_DEBUG    0x4
 315 #define TW_AEN_NOT_RETRIEVED 0x1
 316 #define TW_AEN_RETRIEVED 0x2
 317
 318 /* Command state defines */
 319 #define TW_S_INITIAL   0x1  /* Initial state */
 320 #define TW_S_STARTED   0x2  /* Id in use */
 321 #define TW_S_POSTED    0x4  /* Posted to the controller */
 322 #define TW_S_PENDING   0x8  /* Waiting to be posted in isr */
 323 #define TW_S_COMPLETED 0x10 /* Completed by isr */
 324 #define TW_S_FINISHED  0x20 /* I/O completely done */
 325
 326 /* Compatibility defines */
 327 #define TW_9000_ARCH_ID 0x5
 328 #define TW_CURRENT_FW_SRL 24
 329 #define TW_CURRENT_FW_BUILD 5
 330 #define TW_CURRENT_FW_BRANCH 1
 331
 332 /* Phase defines */
 333 #define TW_PHASE_INITIAL 0
 334 #define TW_PHASE_SINGLE  1
 335 #define TW_PHASE_SGLIST  2
 336
 337 /* Misc defines */
 338 #define TW_SECTOR_SIZE                        512
 339 #define TW_ALIGNMENT_9000                     4  /* 4 bytes */
 340 #define TW_ALIGNMENT_9000_SGL                 0x3
 341 #define TW_MAX_UNITS                          16
 342 #define TW_INIT_MESSAGE_CREDITS               0x100
 343 #define TW_INIT_COMMAND_PACKET_SIZE           0x3
 344 #define TW_INIT_COMMAND_PACKET_SIZE_EXTENDED  0x6
 345 #define TW_EXTENDED_INIT_CONNECT              0x2
 346 #define TW_BUNDLED_FW_SAFE_TO_FLASH           0x4
 347 #define TW_CTLR_FW_RECOMMENDS_FLASH           0x8
 348 #define TW_CTLR_FW_COMPATIBLE                 0x2
 349 #define TW_BASE_FW_SRL                        0x17
 350 #define TW_BASE_FW_BRANCH                     0
 351 #define TW_BASE_FW_BUILD                      1
 352 #if BITS_PER_LONG > 32
 353 #define TW_APACHE_MAX_SGL_LENGTH 72
 354 #define TW_ESCALADE_MAX_SGL_LENGTH 41
 355 #define TW_APACHE_CMD_PKT_SIZE 5
 356 #else
 357 #define TW_APACHE_MAX_SGL_LENGTH 109
 358 #define TW_ESCALADE_MAX_SGL_LENGTH 62
 359 #define TW_APACHE_CMD_PKT_SIZE 4
 360 #endif
 361 #define TW_ATA_PASS_SGL_MAX                   60
 362 #define TW_Q_LENGTH                           256
 363 #define TW_Q_START                            0
 364 #define TW_MAX_SLOT                           32
 365 #define TW_MAX_RESET_TRIES                    2
 366 #define TW_MAX_CMDS_PER_LUN                   254
 367 #define TW_MAX_RESPONSE_DRAIN                 256
 368 #define TW_MAX_AEN_DRAIN                      40
 369 #define TW_IN_IOCTL                           2
 370 #define TW_IN_CHRDEV_IOCTL                    3
 371 #define TW_IN_ATTENTION_LOOP                  4
 372 #define TW_MAX_SECTORS                        256
 373 #define TW_AEN_WAIT_TIME                      1000
 374 #define TW_IOCTL_WAIT_TIME                    (1 * HZ) /* 1 second */
 375 #define TW_MAX_CDB_LEN                        16
 376 #define TW_ISR_DONT_COMPLETE                  2
 377 #define TW_ISR_DONT_RESULT                    3
 378 #define TW_IOCTL_CHRDEV_TIMEOUT               60 /* 60 seconds */
 379 #define TW_IOCTL_CHRDEV_FREE                  -1
 380 #define TW_COMMAND_OFFSET                     128 /* 128 bytes */
 381 #define TW_VERSION_TABLE                      0x0402
 382 #define TW_TIMEKEEP_TABLE                     0x040A
 383 #define TW_INFORMATION_TABLE                  0x0403
 384 #define TW_PARAM_FWVER                        3
 385 #define TW_PARAM_FWVER_LENGTH                 16
 386 #define TW_PARAM_BIOSVER                      4
 387 #define TW_PARAM_BIOSVER_LENGTH               16
 388 #define TW_PARAM_PORTCOUNT                    3
 389 #define TW_PARAM_PORTCOUNT_LENGTH             1
 390 #define TW_MIN_SGL_LENGTH                     0x200 /* 512 bytes */
 391 #define TW_MAX_SENSE_LENGTH                   256
 392 #define TW_EVENT_SOURCE_AEN                   0x1000
 393 #define TW_EVENT_SOURCE_COMMAND               0x1001
 394 #define TW_EVENT_SOURCE_PCHIP                 0x1002
 395 #define TW_EVENT_SOURCE_DRIVER                0x1003
 396 #define TW_IOCTL_GET_COMPATIBILITY_INFO       0x101
 397 #define TW_IOCTL_GET_LAST_EVENT               0x102
 398 #define TW_IOCTL_GET_FIRST_EVENT              0x103
 399 #define TW_IOCTL_GET_NEXT_EVENT               0x104
 400 #define TW_IOCTL_GET_PREVIOUS_EVENT           0x105
 401 #define TW_IOCTL_GET_LOCK                     0x106
 402 #define TW_IOCTL_RELEASE_LOCK                 0x107
 403 #define TW_IOCTL_FIRMWARE_PASS_THROUGH        0x108
 404 #define TW_IOCTL_ERROR_STATUS_NOT_LOCKED      0x1001 // Not locked
 405 #define TW_IOCTL_ERROR_STATUS_LOCKED          0x1002 // Already locked
 406 #define TW_IOCTL_ERROR_STATUS_NO_MORE_EVENTS  0x1003 // No more events
 407 #define TW_IOCTL_ERROR_STATUS_AEN_CLOBBER     0x1004 // AEN clobber occurred
 408 #define TW_IOCTL_ERROR_OS_EFAULT              -EFAULT // Bad address
 409 #define TW_IOCTL_ERROR_OS_EINTR               -EINTR  // Interrupted system call
 410 #define TW_IOCTL_ERROR_OS_EINVAL              -EINVAL // Invalid argument
 411 #define TW_IOCTL_ERROR_OS_ENOMEM              -ENOMEM // Out of memory
 412 #define TW_IOCTL_ERROR_OS_ERESTARTSYS         -ERESTARTSYS // Restart system call
 413 #define TW_IOCTL_ERROR_OS_EIO                 -EIO // I/O error
 414 #define TW_IOCTL_ERROR_OS_ENOTTY              -ENOTTY // Not a typewriter
 415 #define TW_IOCTL_ERROR_OS_ENODEV              -ENODEV // No such device
 416 #define TW_ALLOCATION_LENGTH                  128
 417 #define TW_SENSE_DATA_LENGTH                  18
 418 #define TW_STATUS_CHECK_CONDITION             2
 419 #define TW_ERROR_LOGICAL_UNIT_NOT_SUPPORTED   0x10a
 420 #define TW_ERROR_UNIT_OFFLINE                 0x128
 421 #define TW_MESSAGE_SOURCE_CONTROLLER_ERROR    3
 422 #define TW_MESSAGE_SOURCE_CONTROLLER_EVENT    4
 423 #define TW_MESSAGE_SOURCE_LINUX_DRIVER        6
 424 #define TW_DRIVER TW_MESSAGE_SOURCE_LINUX_DRIVER
 425 #define TW_MESSAGE_SOURCE_LINUX_OS            9
 426 #define TW_OS TW_MESSAGE_SOURCE_LINUX_OS
 427 #if BITS_PER_LONG > 32
 428 #define TW_COMMAND_SIZE                       5
 429 #define TW_DMA_MASK                           DMA_64BIT_MASK
 430 #else
 431 #define TW_COMMAND_SIZE                       4
 432 #define TW_DMA_MASK                           DMA_32BIT_MASK
 433 #endif
 434 #ifndef PCI_DEVICE_ID_3WARE_9000
 435 #define PCI_DEVICE_ID_3WARE_9000 0x1002
 436 #endif
 437
 438 /* Bitmask macros to eliminate bitfields */
 439
 440 /* opcode: 5, reserved: 3 */
 441 #define TW_OPRES_IN(x,y) ((x << 5) | (y & 0x1f))
 442 #define TW_OP_OUT(x) (x & 0x1f)
 443
 444 /* opcode: 5, sgloffset: 3 */
 445 #define TW_OPSGL_IN(x,y) ((x << 5) | (y & 0x1f))
 446 #define TW_SGL_OUT(x) ((x >> 5) & 0x7)
 447
 448 /* severity: 3, reserved: 5 */
 449 #define TW_SEV_OUT(x) (x & 0x7)
 450
 451 /* reserved_1: 4, response_id: 8, reserved_2: 20 */
 452 #define TW_RESID_OUT(x) ((x >> 4) & 0xff)
 453
 454 /* Macros */
 455 #define TW_CONTROL_REG_ADDR(x) (x->base_addr)
 456 #define TW_STATUS_REG_ADDR(x) ((unsigned char *)x->base_addr + 0x4)
 457 #if BITS_PER_LONG > 32
 458 #define TW_COMMAND_QUEUE_REG_ADDR(x) ((unsigned char *)x->base_addr + 0x20)
 459 #else
 460 #define TW_COMMAND_QUEUE_REG_ADDR(x) ((unsigned char *)x->base_addr + 0x8)
 461 #endif
 462 #define TW_RESPONSE_QUEUE_REG_ADDR(x) ((unsigned char *)x->base_addr + 0xC)
 463 #define TW_CLEAR_ALL_INTERRUPTS(x) (writel(TW_STATUS_VALID_INTERRUPT, TW_CONTROL_REG_ADDR(x)))
 464 #define TW_CLEAR_ATTENTION_INTERRUPT(x) (writel(TW_CONTROL_CLEAR_ATTENTION_INTERRUPT, TW_CONTROL_REG_ADDR(x)))
 465 #define TW_CLEAR_HOST_INTERRUPT(x) (writel(TW_CONTROL_CLEAR_HOST_INTERRUPT, TW_CONTROL_REG_ADDR(x)))
 466 #define TW_DISABLE_INTERRUPTS(x) (writel(TW_CONTROL_DISABLE_INTERRUPTS, TW_CONTROL_REG_ADDR(x)))
 467 #define TW_ENABLE_AND_CLEAR_INTERRUPTS(x) (writel(TW_CONTROL_CLEAR_ATTENTION_INTERRUPT | TW_CONTROL_UNMASK_RESPONSE_INTERRUPT | TW_CONTROL_ENABLE_INTERRUPTS, TW_CONTROL_REG_ADDR(x)))
 468 #define TW_MASK_COMMAND_INTERRUPT(x) (writel(TW_CONTROL_MASK_COMMAND_INTERRUPT, TW_CONTROL_REG_ADDR(x)))
 469 #define TW_UNMASK_COMMAND_INTERRUPT(x) (writel(TW_CONTROL_UNMASK_COMMAND_INTERRUPT, TW_CONTROL_REG_ADDR(x)))
 470 #define TW_SOFT_RESET(x) (writel(TW_CONTROL_ISSUE_SOFT_RESET | \
 471                         TW_CONTROL_CLEAR_HOST_INTERRUPT | \
 472                         TW_CONTROL_CLEAR_ATTENTION_INTERRUPT | \
 473                         TW_CONTROL_MASK_COMMAND_INTERRUPT | \
 474                         TW_CONTROL_MASK_RESPONSE_INTERRUPT | \
 475                         TW_CONTROL_CLEAR_ERROR_STATUS | \
 476                         TW_CONTROL_DISABLE_INTERRUPTS, TW_CONTROL_REG_ADDR(x)))
 477 #define TW_PRINTK(h,a,b,c) { \
 478 if (h) \
 479 printk(KERN_WARNING "3w-9xxx: scsi%d: ERROR: (0x%02X:0x%04X): %s.\n",h->host_no,a,b,c); \
 480 else \
 481 printk(KERN_WARNING "3w-9xxx: ERROR: (0x%02X:0x%04X): %s.\n",a,b,c); \
 482 }
 483
 484 #pragma pack(1)
 485
 486 /* Scatter Gather List Entry */
 487 typedef struct TAG_TW_SG_Entry {
 488         unsigned long address;
 489         u32 length;
 490 } TW_SG_Entry;
 491
 492 /* Command Packet */
 493 typedef struct TW_Command {
 494         unsigned char opcode__sgloffset;
 495         unsigned char size;
 496         unsigned char request_id;
 497         unsigned char unit__hostid;
 498         /* Second DWORD */
 499         unsigned char status;
 500         unsigned char flags;
 501         union {
 502                 unsigned short block_count;
 503                 unsigned short parameter_count;
 504         } byte6_offset;
 505         union {
 506                 struct {
 507                         u32 lba;
 508                         TW_SG_Entry sgl[TW_ESCALADE_MAX_SGL_LENGTH];
 509 #if BITS_PER_LONG > 32
 510                         u32 padding[2]; /* pad to 512 bytes */
 511 #else
 512                         u32 padding;
 513 #endif
 514                 } io;
 515                 struct {
 516                         TW_SG_Entry sgl[TW_ESCALADE_MAX_SGL_LENGTH];
 517 #if BITS_PER_LONG > 32
 518                         u32 padding[3];
 519 #else
 520                         u32 padding[2];
 521 #endif
 522                 } param;
 523         } byte8_offset;
 524 } TW_Command;
 525
 526 /* Scatter gather element for 9000+ controllers */
 527 typedef struct TAG_TW_SG_Apache {
 528         unsigned long address;
 529         u32 length;
 530 } TW_SG_Apache;
 531
 532 /* Command Packet for 9000+ controllers */
 533 typedef struct TAG_TW_Command_Apache {
 534         unsigned char opcode__reserved;
 535         unsigned char unit;
 536         unsigned short request_id;
 537         unsigned char status;
 538         unsigned char sgl_offset;
 539         unsigned short sgl_entries;
 540         unsigned char cdb[16];
 541         TW_SG_Apache sg_list[TW_APACHE_MAX_SGL_LENGTH];
 542 #if BITS_PER_LONG > 32
 543         unsigned char padding[8];
 544 #endif
 545 } TW_Command_Apache;
 546
 547 /* New command packet header */
 548 typedef struct TAG_TW_Command_Apache_Header {
 549         unsigned char sense_data[TW_SENSE_DATA_LENGTH];
 550         struct {
 551                 char reserved[4];
 552                 unsigned short error;
 553                 unsigned char padding;
 554                 unsigned char severity__reserved;
 555         } status_block;
 556         unsigned char err_specific_desc[98];
 557         struct {
 558                 unsigned char size_header;
 559                 unsigned short reserved;
 560                 unsigned char size_sense;
 561         } header_desc;
 562 } TW_Command_Apache_Header;
 563
 564 /* This struct is a union of the 2 command packets */
 565 typedef struct TAG_TW_Command_Full {
 566         TW_Command_Apache_Header header;
 567         union {
 568                 TW_Command oldcommand;
 569                 TW_Command_Apache newcommand;
 570         } command;
 571 } TW_Command_Full;
 572
 573 /* Initconnection structure */
 574 typedef struct TAG_TW_Initconnect {
 575         unsigned char opcode__reserved;
 576         unsigned char size;
 577         unsigned char request_id;
 578         unsigned char res2;
 579         unsigned char status;
 580         unsigned char flags;
 581         unsigned short message_credits;
 582         u32 features;
 583         unsigned short fw_srl;
 584         unsigned short fw_arch_id;
 585         unsigned short fw_branch;
 586         unsigned short fw_build;
 587         u32 result;
 588 } TW_Initconnect;
 589
 590 /* Event info structure */
 591 typedef struct TAG_TW_Event
 592 {
 593         unsigned int sequence_id;
 594         unsigned int time_stamp_sec;
 595         unsigned short aen_code;
 596         unsigned char severity;
 597         unsigned char retrieved;
 598         unsigned char repeat_count;
 599         unsigned char parameter_len;
 600         unsigned char parameter_data[98];
 601 } TW_Event;
 602
 603 typedef struct TAG_TW_Ioctl_Driver_Command {
 604         unsigned int control_code;
 605         unsigned int status;
 606         unsigned int unique_id;
 607         unsigned int sequence_id;
 608         unsigned int os_specific;
 609         unsigned int buffer_length;
 610 } TW_Ioctl_Driver_Command;
 611
 612 typedef struct TAG_TW_Ioctl_Apache {
 613         TW_Ioctl_Driver_Command driver_command;
 614         char padding[488];
 615         TW_Command_Full firmware_command;
 616         char data_buffer[1];
 617 } TW_Ioctl_Buf_Apache;
 618
 619 /* Lock structure for ioctl get/release lock */
 620 typedef struct TAG_TW_Lock {
 621         unsigned long timeout_msec;
 622         unsigned long time_remaining_msec;
 623         unsigned long force_flag;
 624 } TW_Lock;
 625
 626 /* GetParam descriptor */
 627 typedef struct {
 628         unsigned short  table_id;
 629         unsigned short  parameter_id;
 630         unsigned short  parameter_size_bytes;
 631         unsigned short  actual_parameter_size_bytes;
 632         unsigned char   data[1];
 633 } TW_Param_Apache, *PTW_Param_Apache;
 634
 635 /* Response queue */
 636 typedef union TAG_TW_Response_Queue {
 637         u32 response_id;
 638         u32 value;
 639 } TW_Response_Queue;
 640
 641 typedef struct TAG_TW_Info {
 642         char *buffer;
 643         int length;
 644         int offset;
 645         int position;
 646 } TW_Info;
 647
 648 /* Compatibility information structure */
 649 typedef struct TAG_TW_Compatibility_Info
 650 {
 651         char driver_version[32];
 652         unsigned short working_srl;
 653         unsigned short working_branch;
 654         unsigned short working_build;
 655 } TW_Compatibility_Info;
 656
 657 typedef struct TAG_TW_Device_Extension {
 658         u32                     *base_addr;
 659         unsigned long           *generic_buffer_virt[TW_Q_LENGTH];
 660         unsigned long           generic_buffer_phys[TW_Q_LENGTH];
 661         TW_Command_Full         *command_packet_virt[TW_Q_LENGTH];
 662         unsigned long           command_packet_phys[TW_Q_LENGTH];
 663         struct pci_dev          *tw_pci_dev;
 664         struct scsi_cmnd        *srb[TW_Q_LENGTH];
 665         unsigned char           free_queue[TW_Q_LENGTH];
 666         unsigned char           free_head;
 667         unsigned char           free_tail;
 668         unsigned char           pending_queue[TW_Q_LENGTH];
 669         unsigned char           pending_head;
 670         unsigned char           pending_tail;
 671         int                     state[TW_Q_LENGTH];
 672         unsigned int            posted_request_count;
 673         unsigned int            max_posted_request_count;
 674         unsigned int            pending_request_count;
 675         unsigned int            max_pending_request_count;
 676         unsigned int            max_sgl_entries;
 677         unsigned int            sgl_entries;
 678         unsigned int            num_aborts;
 679         unsigned int            num_resets;
 680         unsigned int            sector_count;
 681         unsigned int            max_sector_count;
 682         unsigned int            aen_count;
 683         struct Scsi_Host        *host;
 684         long                    flags;
 685         int                     reset_print;
 686         TW_Event                *event_queue[TW_Q_LENGTH];
 687         unsigned char           error_index;
 688         unsigned char           event_queue_wrapped;
 689         unsigned int            error_sequence_id;
 690         int                     ioctl_sem_lock;
 691         u32                     ioctl_msec;
 692         int                     chrdev_request_id;
 693         wait_queue_head_t       ioctl_wqueue;
 694         struct semaphore        ioctl_sem;
 695         char                    aen_clobber;
 696         unsigned short          working_srl;
 697         unsigned short          working_branch;
 698         unsigned short          working_build;
 699 } TW_Device_Extension;
 700
 701 #pragma pack()
 702
 703 #endif /* _3W_9XXX_H */
 704