drivers/scsi/ipr.h

   1 /*
   2  * ipr.h -- driver for IBM Power Linux RAID adapters
   3  *
   4  * Written By: Brian King <brking@us.ibm.com>, IBM Corporation
   5  *
   6  * Copyright (C) 2003, 2004 IBM 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; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  * Alan Cox <alan@redhat.com> - Removed several careless u32/dma_addr_t errors
  23  *                              that broke 64bit platforms.
  24  */
  25
  26 #ifndef _IPR_H
  27 #define _IPR_H
  28
  29 #include <linux/types.h>
  30 #include <linux/completion.h>
  31 #include <linux/libata.h>
  32 #include <linux/list.h>
  33 #include <linux/kref.h>
  34 #include <scsi/scsi.h>
  35 #include <scsi/scsi_cmnd.h>
  36
  37 /*
  38  * Literals
  39  */
  40 #define IPR_DRIVER_VERSION "2.2.0"
  41 #define IPR_DRIVER_DATE "(September 25, 2006)"
  42
  43 /*
  44  * IPR_MAX_CMD_PER_LUN: This defines the maximum number of outstanding
  45  *      ops per device for devices not running tagged command queuing.
  46  *      This can be adjusted at runtime through sysfs device attributes.
  47  */
  48 #define IPR_MAX_CMD_PER_LUN                             6
  49 #define IPR_MAX_CMD_PER_ATA_LUN                 1
  50
  51 /*
  52  * IPR_NUM_BASE_CMD_BLKS: This defines the maximum number of
  53  *      ops the mid-layer can send to the adapter.
  54  */
  55 #define IPR_NUM_BASE_CMD_BLKS                           100
  56
  57 #define IPR_SUBS_DEV_ID_2780    0x0264
  58 #define IPR_SUBS_DEV_ID_5702    0x0266
  59 #define IPR_SUBS_DEV_ID_5703    0x0278
  60 #define IPR_SUBS_DEV_ID_572E  0x028D
  61 #define IPR_SUBS_DEV_ID_573E  0x02D3
  62 #define IPR_SUBS_DEV_ID_573D  0x02D4
  63 #define IPR_SUBS_DEV_ID_571A    0x02C0
  64 #define IPR_SUBS_DEV_ID_571B    0x02BE
  65 #define IPR_SUBS_DEV_ID_571E  0x02BF
  66 #define IPR_SUBS_DEV_ID_571F    0x02D5
  67 #define IPR_SUBS_DEV_ID_572A    0x02C1
  68 #define IPR_SUBS_DEV_ID_572B    0x02C2
  69 #define IPR_SUBS_DEV_ID_575B    0x030D
  70
  71 #define IPR_NAME                                "ipr"
  72
  73 /*
  74  * Return codes
  75  */
  76 #define IPR_RC_JOB_CONTINUE             1
  77 #define IPR_RC_JOB_RETURN               2
  78
  79 /*
  80  * IOASCs
  81  */
  82 #define IPR_IOASC_NR_INIT_CMD_REQUIRED          0x02040200
  83 #define IPR_IOASC_SYNC_REQUIRED                 0x023f0000
  84 #define IPR_IOASC_MED_DO_NOT_REALLOC            0x03110C00
  85 #define IPR_IOASC_HW_SEL_TIMEOUT                        0x04050000
  86 #define IPR_IOASC_HW_DEV_BUS_STATUS                     0x04448500
  87 #define IPR_IOASC_IOASC_MASK                    0xFFFFFF00
  88 #define IPR_IOASC_SCSI_STATUS_MASK              0x000000FF
  89 #define IPR_IOASC_IR_INVALID_REQ_TYPE_OR_PKT    0x05240000
  90 #define IPR_IOASC_IR_RESOURCE_HANDLE            0x05250000
  91 #define IPR_IOASC_IR_NO_CMDS_TO_2ND_IOA         0x05258100
  92 #define IPR_IOASA_IR_DUAL_IOA_DISABLED          0x052C8000
  93 #define IPR_IOASC_BUS_WAS_RESET                 0x06290000
  94 #define IPR_IOASC_BUS_WAS_RESET_BY_OTHER                0x06298000
  95 #define IPR_IOASC_ABORTED_CMD_TERM_BY_HOST      0x0B5A0000
  96
  97 #define IPR_FIRST_DRIVER_IOASC                  0x10000000
  98 #define IPR_IOASC_IOA_WAS_RESET                 0x10000001
  99 #define IPR_IOASC_PCI_ACCESS_ERROR                      0x10000002
 100
 101 #define IPR_NUM_LOG_HCAMS                               2
 102 #define IPR_NUM_CFG_CHG_HCAMS                           2
 103 #define IPR_NUM_HCAMS   (IPR_NUM_LOG_HCAMS + IPR_NUM_CFG_CHG_HCAMS)
 104 #define IPR_MAX_NUM_TARGETS_PER_BUS                     256
 105 #define IPR_MAX_NUM_LUNS_PER_TARGET                     256
 106 #define IPR_MAX_NUM_VSET_LUNS_PER_TARGET        8
 107 #define IPR_VSET_BUS                                    0xff
 108 #define IPR_IOA_BUS                                             0xff
 109 #define IPR_IOA_TARGET                                  0xff
 110 #define IPR_IOA_LUN                                             0xff
 111 #define IPR_MAX_NUM_BUSES                               16
 112 #define IPR_MAX_BUS_TO_SCAN                             IPR_MAX_NUM_BUSES
 113
 114 #define IPR_NUM_RESET_RELOAD_RETRIES            3
 115
 116 /* We need resources for HCAMS, IOA reset, IOA bringdown, and ERP */
 117 #define IPR_NUM_INTERNAL_CMD_BLKS       (IPR_NUM_HCAMS + \
 118                                      ((IPR_NUM_RESET_RELOAD_RETRIES + 1) * 2) + 3)
 119
 120 #define IPR_MAX_COMMANDS                IPR_NUM_BASE_CMD_BLKS
 121 #define IPR_NUM_CMD_BLKS                (IPR_NUM_BASE_CMD_BLKS + \
 122                                                 IPR_NUM_INTERNAL_CMD_BLKS)
 123
 124 #define IPR_MAX_PHYSICAL_DEVS                           192
 125
 126 #define IPR_MAX_SGLIST                                  64
 127 #define IPR_IOA_MAX_SECTORS                             32767
 128 #define IPR_VSET_MAX_SECTORS                            512
 129 #define IPR_MAX_CDB_LEN                                 16
 130
 131 #define IPR_DEFAULT_BUS_WIDTH                           16
 132 #define IPR_80MBs_SCSI_RATE             ((80 * 10) / (IPR_DEFAULT_BUS_WIDTH / 8))
 133 #define IPR_U160_SCSI_RATE      ((160 * 10) / (IPR_DEFAULT_BUS_WIDTH / 8))
 134 #define IPR_U320_SCSI_RATE      ((320 * 10) / (IPR_DEFAULT_BUS_WIDTH / 8))
 135 #define IPR_MAX_SCSI_RATE(width) ((320 * 10) / ((width) / 8))
 136
 137 #define IPR_IOA_RES_HANDLE                              0xffffffff
 138 #define IPR_INVALID_RES_HANDLE                  0
 139 #define IPR_IOA_RES_ADDR                                0x00ffffff
 140
 141 /*
 142  * Adapter Commands
 143  */
 144 #define IPR_QUERY_RSRC_STATE                            0xC2
 145 #define IPR_RESET_DEVICE                                0xC3
 146 #define IPR_RESET_TYPE_SELECT                           0x80
 147 #define IPR_LUN_RESET                                   0x40
 148 #define IPR_TARGET_RESET                                        0x20
 149 #define IPR_BUS_RESET                                   0x10
 150 #define IPR_ATA_PHY_RESET                                       0x80
 151 #define IPR_ID_HOST_RR_Q                                0xC4
 152 #define IPR_QUERY_IOA_CONFIG                            0xC5
 153 #define IPR_CANCEL_ALL_REQUESTS                 0xCE
 154 #define IPR_HOST_CONTROLLED_ASYNC                       0xCF
 155 #define IPR_HCAM_CDB_OP_CODE_CONFIG_CHANGE      0x01
 156 #define IPR_HCAM_CDB_OP_CODE_LOG_DATA           0x02
 157 #define IPR_SET_SUPPORTED_DEVICES                       0xFB
 158 #define IPR_IOA_SHUTDOWN                                0xF7
 159 #define IPR_WR_BUF_DOWNLOAD_AND_SAVE                    0x05
 160
 161 /*
 162  * Timeouts
 163  */
 164 #define IPR_SHUTDOWN_TIMEOUT                    (ipr_fastfail ? 60 * HZ : 10 * 60 * HZ)
 165 #define IPR_VSET_RW_TIMEOUT                     (ipr_fastfail ? 30 * HZ : 2 * 60 * HZ)
 166 #define IPR_ABBREV_SHUTDOWN_TIMEOUT             (10 * HZ)
 167 #define IPR_DEVICE_RESET_TIMEOUT                (ipr_fastfail ? 10 * HZ : 30 * HZ)
 168 #define IPR_CANCEL_ALL_TIMEOUT          (ipr_fastfail ? 10 * HZ : 30 * HZ)
 169 #define IPR_ABORT_TASK_TIMEOUT          (ipr_fastfail ? 10 * HZ : 30 * HZ)
 170 #define IPR_INTERNAL_TIMEOUT                    (ipr_fastfail ? 10 * HZ : 30 * HZ)
 171 #define IPR_WRITE_BUFFER_TIMEOUT                (10 * 60 * HZ)
 172 #define IPR_SET_SUP_DEVICE_TIMEOUT              (2 * 60 * HZ)
 173 #define IPR_REQUEST_SENSE_TIMEOUT               (10 * HZ)
 174 #define IPR_OPERATIONAL_TIMEOUT         (5 * 60)
 175 #define IPR_WAIT_FOR_RESET_TIMEOUT              (2 * HZ)
 176 #define IPR_CHECK_FOR_RESET_TIMEOUT             (HZ / 10)
 177 #define IPR_WAIT_FOR_BIST_TIMEOUT               (2 * HZ)
 178 #define IPR_DUMP_TIMEOUT                        (15 * HZ)
 179
 180 /*
 181  * SCSI Literals
 182  */
 183 #define IPR_VENDOR_ID_LEN                       8
 184 #define IPR_PROD_ID_LEN                         16
 185 #define IPR_SERIAL_NUM_LEN                      8
 186
 187 /*
 188  * Hardware literals
 189  */
 190 #define IPR_FMT2_MBX_ADDR_MASK                          0x0fffffff
 191 #define IPR_FMT2_MBX_BAR_SEL_MASK                       0xf0000000
 192 #define IPR_FMT2_MKR_BAR_SEL_SHIFT                      28
 193 #define IPR_GET_FMT2_BAR_SEL(mbx) \
 194 (((mbx) & IPR_FMT2_MBX_BAR_SEL_MASK) >> IPR_FMT2_MKR_BAR_SEL_SHIFT)
 195 #define IPR_SDT_FMT2_BAR0_SEL                           0x0
 196 #define IPR_SDT_FMT2_BAR1_SEL                           0x1
 197 #define IPR_SDT_FMT2_BAR2_SEL                           0x2
 198 #define IPR_SDT_FMT2_BAR3_SEL                           0x3
 199 #define IPR_SDT_FMT2_BAR4_SEL                           0x4
 200 #define IPR_SDT_FMT2_BAR5_SEL                           0x5
 201 #define IPR_SDT_FMT2_EXP_ROM_SEL                        0x8
 202 #define IPR_FMT2_SDT_READY_TO_USE                       0xC4D4E3F2
 203 #define IPR_DOORBELL                                    0x82800000
 204 #define IPR_RUNTIME_RESET                               0x40000000
 205
 206 #define IPR_PCII_IOA_TRANS_TO_OPER                      (0x80000000 >> 0)
 207 #define IPR_PCII_IOARCB_XFER_FAILED                     (0x80000000 >> 3)
 208 #define IPR_PCII_IOA_UNIT_CHECKED                       (0x80000000 >> 4)
 209 #define IPR_PCII_NO_HOST_RRQ                            (0x80000000 >> 5)
 210 #define IPR_PCII_CRITICAL_OPERATION                     (0x80000000 >> 6)
 211 #define IPR_PCII_IO_DEBUG_ACKNOWLEDGE           (0x80000000 >> 7)
 212 #define IPR_PCII_IOARRIN_LOST                           (0x80000000 >> 27)
 213 #define IPR_PCII_MMIO_ERROR                             (0x80000000 >> 28)
 214 #define IPR_PCII_PROC_ERR_STATE                 (0x80000000 >> 29)
 215 #define IPR_PCII_HRRQ_UPDATED                           (0x80000000 >> 30)
 216 #define IPR_PCII_CORE_ISSUED_RST_REQ            (0x80000000 >> 31)
 217
 218 #define IPR_PCII_ERROR_INTERRUPTS \
 219 (IPR_PCII_IOARCB_XFER_FAILED | IPR_PCII_IOA_UNIT_CHECKED | \
 220 IPR_PCII_NO_HOST_RRQ | IPR_PCII_IOARRIN_LOST | IPR_PCII_MMIO_ERROR)
 221
 222 #define IPR_PCII_OPER_INTERRUPTS \
 223 (IPR_PCII_ERROR_INTERRUPTS | IPR_PCII_HRRQ_UPDATED | IPR_PCII_IOA_TRANS_TO_OPER)
 224
 225 #define IPR_UPROCI_RESET_ALERT                  (0x80000000 >> 7)
 226 #define IPR_UPROCI_IO_DEBUG_ALERT                       (0x80000000 >> 9)
 227
 228 #define IPR_LDUMP_MAX_LONG_ACK_DELAY_IN_USEC            200000  /* 200 ms */
 229 #define IPR_LDUMP_MAX_SHORT_ACK_DELAY_IN_USEC           200000  /* 200 ms */
 230
 231 /*
 232  * Dump literals
 233  */
 234 #define IPR_MAX_IOA_DUMP_SIZE                           (4 * 1024 * 1024)
 235 #define IPR_NUM_SDT_ENTRIES                             511
 236 #define IPR_MAX_NUM_DUMP_PAGES  ((IPR_MAX_IOA_DUMP_SIZE / PAGE_SIZE) + 1)
 237
 238 /*
 239  * Misc literals
 240  */
 241 #define IPR_NUM_IOADL_ENTRIES                   IPR_MAX_SGLIST
 242
 243 /*
 244  * Adapter interface types
 245  */
 246
 247 struct ipr_res_addr {
 248         u8 reserved;
 249         u8 bus;
 250         u8 target;
 251         u8 lun;
 252 #define IPR_GET_PHYS_LOC(res_addr) \
 253         (((res_addr).bus << 16) | ((res_addr).target << 8) | (res_addr).lun)
 254 }__attribute__((packed, aligned (4)));
 255
 256 struct ipr_std_inq_vpids {
 257         u8 vendor_id[IPR_VENDOR_ID_LEN];
 258         u8 product_id[IPR_PROD_ID_LEN];
 259 }__attribute__((packed));
 260
 261 struct ipr_vpd {
 262         struct ipr_std_inq_vpids vpids;
 263         u8 sn[IPR_SERIAL_NUM_LEN];
 264 }__attribute__((packed));
 265
 266 struct ipr_ext_vpd {
 267         struct ipr_vpd vpd;
 268         __be32 wwid[2];
 269 }__attribute__((packed));
 270
 271 struct ipr_std_inq_data {
 272         u8 peri_qual_dev_type;
 273 #define IPR_STD_INQ_PERI_QUAL(peri) ((peri) >> 5)
 274 #define IPR_STD_INQ_PERI_DEV_TYPE(peri) ((peri) & 0x1F)
 275
 276         u8 removeable_medium_rsvd;
 277 #define IPR_STD_INQ_REMOVEABLE_MEDIUM 0x80
 278
 279 #define IPR_IS_DASD_DEVICE(std_inq) \
 280 ((IPR_STD_INQ_PERI_DEV_TYPE((std_inq).peri_qual_dev_type) == TYPE_DISK) && \
 281 !(((std_inq).removeable_medium_rsvd) & IPR_STD_INQ_REMOVEABLE_MEDIUM))
 282
 283 #define IPR_IS_SES_DEVICE(std_inq) \
 284 (IPR_STD_INQ_PERI_DEV_TYPE((std_inq).peri_qual_dev_type) == TYPE_ENCLOSURE)
 285
 286         u8 version;
 287         u8 aen_naca_fmt;
 288         u8 additional_len;
 289         u8 sccs_rsvd;
 290         u8 bq_enc_multi;
 291         u8 sync_cmdq_flags;
 292
 293         struct ipr_std_inq_vpids vpids;
 294
 295         u8 ros_rsvd_ram_rsvd[4];
 296
 297         u8 serial_num[IPR_SERIAL_NUM_LEN];
 298 }__attribute__ ((packed));
 299
 300 struct ipr_config_table_entry {
 301         u8 proto;
 302 #define IPR_PROTO_SATA                  0x02
 303 #define IPR_PROTO_SATA_ATAPI            0x03
 304 #define IPR_PROTO_SAS_STP               0x06
 305 #define IPR_PROTO_SAS_STP_ATAPI 0x07
 306         u8 array_id;
 307         u8 flags;
 308 #define IPR_IS_IOA_RESOURCE     0x80
 309 #define IPR_IS_ARRAY_MEMBER 0x20
 310 #define IPR_IS_HOT_SPARE        0x10
 311
 312         u8 rsvd_subtype;
 313 #define IPR_RES_SUBTYPE(res) (((res)->cfgte.rsvd_subtype) & 0x0f)
 314 #define IPR_SUBTYPE_AF_DASD                     0
 315 #define IPR_SUBTYPE_GENERIC_SCSI        1
 316 #define IPR_SUBTYPE_VOLUME_SET          2
 317 #define IPR_SUBTYPE_GENERIC_ATA 4
 318
 319 #define IPR_QUEUEING_MODEL(res) ((((res)->cfgte.flags) & 0x70) >> 4)
 320 #define IPR_QUEUE_FROZEN_MODEL  0
 321 #define IPR_QUEUE_NACA_MODEL            1
 322
 323         struct ipr_res_addr res_addr;
 324         __be32 res_handle;
 325         __be32 reserved4[2];
 326         struct ipr_std_inq_data std_inq_data;
 327 }__attribute__ ((packed, aligned (4)));
 328
 329 struct ipr_config_table_hdr {
 330         u8 num_entries;
 331         u8 flags;
 332 #define IPR_UCODE_DOWNLOAD_REQ  0x10
 333         __be16 reserved;
 334 }__attribute__((packed, aligned (4)));
 335
 336 struct ipr_config_table {
 337         struct ipr_config_table_hdr hdr;
 338         struct ipr_config_table_entry dev[IPR_MAX_PHYSICAL_DEVS];
 339 }__attribute__((packed, aligned (4)));
 340
 341 struct ipr_hostrcb_cfg_ch_not {
 342         struct ipr_config_table_entry cfgte;
 343         u8 reserved[936];
 344 }__attribute__((packed, aligned (4)));
 345
 346 struct ipr_supported_device {
 347         __be16 data_length;
 348         u8 reserved;
 349         u8 num_records;
 350         struct ipr_std_inq_vpids vpids;
 351         u8 reserved2[16];
 352 }__attribute__((packed, aligned (4)));
 353
 354 /* Command packet structure */
 355 struct ipr_cmd_pkt {
 356         __be16 reserved;                /* Reserved by IOA */
 357         u8 request_type;
 358 #define IPR_RQTYPE_SCSICDB              0x00
 359 #define IPR_RQTYPE_IOACMD               0x01
 360 #define IPR_RQTYPE_HCAM                 0x02
 361 #define IPR_RQTYPE_ATA_PASSTHRU 0x04
 362
 363         u8 luntar_luntrn;
 364
 365         u8 flags_hi;
 366 #define IPR_FLAGS_HI_WRITE_NOT_READ             0x80
 367 #define IPR_FLAGS_HI_NO_ULEN_CHK                0x20
 368 #define IPR_FLAGS_HI_SYNC_OVERRIDE              0x10
 369 #define IPR_FLAGS_HI_SYNC_COMPLETE              0x08
 370 #define IPR_FLAGS_HI_NO_LINK_DESC               0x04
 371
 372         u8 flags_lo;
 373 #define IPR_FLAGS_LO_ALIGNED_BFR                0x20
 374 #define IPR_FLAGS_LO_DELAY_AFTER_RST    0x10
 375 #define IPR_FLAGS_LO_UNTAGGED_TASK              0x00
 376 #define IPR_FLAGS_LO_SIMPLE_TASK                0x02
 377 #define IPR_FLAGS_LO_ORDERED_TASK               0x04
 378 #define IPR_FLAGS_LO_HEAD_OF_Q_TASK             0x06
 379 #define IPR_FLAGS_LO_ACA_TASK                   0x08
 380
 381         u8 cdb[16];
 382         __be16 timeout;
 383 }__attribute__ ((packed, aligned(4)));
 384
 385 struct ipr_ioarcb_ata_regs {
 386         u8 flags;
 387 #define IPR_ATA_FLAG_PACKET_CMD                 0x80
 388 #define IPR_ATA_FLAG_XFER_TYPE_DMA                      0x40
 389 #define IPR_ATA_FLAG_STATUS_ON_GOOD_COMPLETION  0x20
 390         u8 reserved[3];
 391
 392         __be16 data;
 393         u8 feature;
 394         u8 nsect;
 395         u8 lbal;
 396         u8 lbam;
 397         u8 lbah;
 398         u8 device;
 399         u8 command;
 400         u8 reserved2[3];
 401         u8 hob_feature;
 402         u8 hob_nsect;
 403         u8 hob_lbal;
 404         u8 hob_lbam;
 405         u8 hob_lbah;
 406         u8 ctl;
 407 }__attribute__ ((packed, aligned(4)));
 408
 409 struct ipr_ioarcb_add_data {
 410         union {
 411                 struct ipr_ioarcb_ata_regs regs;
 412                 __be32 add_cmd_parms[10];
 413         }u;
 414 }__attribute__ ((packed, aligned(4)));
 415
 416 /* IOA Request Control Block    128 bytes  */
 417 struct ipr_ioarcb {
 418         __be32 ioarcb_host_pci_addr;
 419         __be32 reserved;
 420         __be32 res_handle;
 421         __be32 host_response_handle;
 422         __be32 reserved1;
 423         __be32 reserved2;
 424         __be32 reserved3;
 425
 426         __be32 write_data_transfer_length;
 427         __be32 read_data_transfer_length;
 428         __be32 write_ioadl_addr;
 429         __be32 write_ioadl_len;
 430         __be32 read_ioadl_addr;
 431         __be32 read_ioadl_len;
 432
 433         __be32 ioasa_host_pci_addr;
 434         __be16 ioasa_len;
 435         __be16 reserved4;
 436
 437         struct ipr_cmd_pkt cmd_pkt;
 438
 439         __be32 add_cmd_parms_len;
 440         struct ipr_ioarcb_add_data add_data;
 441 }__attribute__((packed, aligned (4)));
 442
 443 struct ipr_ioadl_desc {
 444         __be32 flags_and_data_len;
 445 #define IPR_IOADL_FLAGS_MASK            0xff000000
 446 #define IPR_IOADL_GET_FLAGS(x) (be32_to_cpu(x) & IPR_IOADL_FLAGS_MASK)
 447 #define IPR_IOADL_DATA_LEN_MASK         0x00ffffff
 448 #define IPR_IOADL_GET_DATA_LEN(x) (be32_to_cpu(x) & IPR_IOADL_DATA_LEN_MASK)
 449 #define IPR_IOADL_FLAGS_READ            0x48000000
 450 #define IPR_IOADL_FLAGS_READ_LAST       0x49000000
 451 #define IPR_IOADL_FLAGS_WRITE           0x68000000
 452 #define IPR_IOADL_FLAGS_WRITE_LAST      0x69000000
 453 #define IPR_IOADL_FLAGS_LAST            0x01000000
 454
 455         __be32 address;
 456 }__attribute__((packed, aligned (8)));
 457
 458 struct ipr_ioasa_vset {
 459         __be32 failing_lba_hi;
 460         __be32 failing_lba_lo;
 461         __be32 reserved;
 462 }__attribute__((packed, aligned (4)));
 463
 464 struct ipr_ioasa_af_dasd {
 465         __be32 failing_lba;
 466         __be32 reserved[2];
 467 }__attribute__((packed, aligned (4)));
 468
 469 struct ipr_ioasa_gpdd {
 470         u8 end_state;
 471         u8 bus_phase;
 472         __be16 reserved;
 473         __be32 ioa_data[2];
 474 }__attribute__((packed, aligned (4)));
 475
 476 struct ipr_ioasa_gata {
 477         u8 error;
 478         u8 nsect;               /* Interrupt reason */
 479         u8 lbal;
 480         u8 lbam;
 481         u8 lbah;
 482         u8 device;
 483         u8 status;
 484         u8 alt_status;  /* ATA CTL */
 485         u8 hob_nsect;
 486         u8 hob_lbal;
 487         u8 hob_lbam;
 488         u8 hob_lbah;
 489 }__attribute__((packed, aligned (4)));
 490
 491 struct ipr_auto_sense {
 492         __be16 auto_sense_len;
 493         __be16 ioa_data_len;
 494         __be32 data[SCSI_SENSE_BUFFERSIZE/sizeof(__be32)];
 495 };
 496
 497 struct ipr_ioasa {
 498         __be32 ioasc;
 499 #define IPR_IOASC_SENSE_KEY(ioasc) ((ioasc) >> 24)
 500 #define IPR_IOASC_SENSE_CODE(ioasc) (((ioasc) & 0x00ff0000) >> 16)
 501 #define IPR_IOASC_SENSE_QUAL(ioasc) (((ioasc) & 0x0000ff00) >> 8)
 502 #define IPR_IOASC_SENSE_STATUS(ioasc) ((ioasc) & 0x000000ff)
 503
 504         __be16 ret_stat_len;    /* Length of the returned IOASA */
 505
 506         __be16 avail_stat_len;  /* Total Length of status available. */
 507
 508         __be32 residual_data_len;       /* number of bytes in the host data */
 509         /* buffers that were not used by the IOARCB command. */
 510
 511         __be32 ilid;
 512 #define IPR_NO_ILID                     0
 513 #define IPR_DRIVER_ILID         0xffffffff
 514
 515         __be32 fd_ioasc;
 516
 517         __be32 fd_phys_locator;
 518
 519         __be32 fd_res_handle;
 520
 521         __be32 ioasc_specific;  /* status code specific field */
 522 #define IPR_ADDITIONAL_STATUS_FMT               0x80000000
 523 #define IPR_AUTOSENSE_VALID                     0x40000000
 524 #define IPR_ATA_DEVICE_WAS_RESET                0x20000000
 525 #define IPR_IOASC_SPECIFIC_MASK         0x00ffffff
 526 #define IPR_FIELD_POINTER_VALID         (0x80000000 >> 8)
 527 #define IPR_FIELD_POINTER_MASK          0x0000ffff
 528
 529         union {
 530                 struct ipr_ioasa_vset vset;
 531                 struct ipr_ioasa_af_dasd dasd;
 532                 struct ipr_ioasa_gpdd gpdd;
 533                 struct ipr_ioasa_gata gata;
 534         } u;
 535
 536         struct ipr_auto_sense auto_sense;
 537 }__attribute__((packed, aligned (4)));
 538
 539 struct ipr_mode_parm_hdr {
 540         u8 length;
 541         u8 medium_type;
 542         u8 device_spec_parms;
 543         u8 block_desc_len;
 544 }__attribute__((packed));
 545
 546 struct ipr_mode_pages {
 547         struct ipr_mode_parm_hdr hdr;
 548         u8 data[255 - sizeof(struct ipr_mode_parm_hdr)];
 549 }__attribute__((packed));
 550
 551 struct ipr_mode_page_hdr {
 552         u8 ps_page_code;
 553 #define IPR_MODE_PAGE_PS        0x80
 554 #define IPR_GET_MODE_PAGE_CODE(hdr) ((hdr)->ps_page_code & 0x3F)
 555         u8 page_length;
 556 }__attribute__ ((packed));
 557
 558 struct ipr_dev_bus_entry {
 559         struct ipr_res_addr res_addr;
 560         u8 flags;
 561 #define IPR_SCSI_ATTR_ENABLE_QAS                        0x80
 562 #define IPR_SCSI_ATTR_DISABLE_QAS                       0x40
 563 #define IPR_SCSI_ATTR_QAS_MASK                          0xC0
 564 #define IPR_SCSI_ATTR_ENABLE_TM                         0x20
 565 #define IPR_SCSI_ATTR_NO_TERM_PWR                       0x10
 566 #define IPR_SCSI_ATTR_TM_SUPPORTED                      0x08
 567 #define IPR_SCSI_ATTR_LVD_TO_SE_NOT_ALLOWED     0x04
 568
 569         u8 scsi_id;
 570         u8 bus_width;
 571         u8 extended_reset_delay;
 572 #define IPR_EXTENDED_RESET_DELAY        7
 573
 574         __be32 max_xfer_rate;
 575
 576         u8 spinup_delay;
 577         u8 reserved3;
 578         __be16 reserved4;
 579 }__attribute__((packed, aligned (4)));
 580
 581 struct ipr_mode_page28 {
 582         struct ipr_mode_page_hdr hdr;
 583         u8 num_entries;
 584         u8 entry_length;
 585         struct ipr_dev_bus_entry bus[0];
 586 }__attribute__((packed));
 587
 588 struct ipr_ioa_vpd {
 589         struct ipr_std_inq_data std_inq_data;
 590         u8 ascii_part_num[12];
 591         u8 reserved[40];
 592         u8 ascii_plant_code[4];
 593 }__attribute__((packed));
 594
 595 struct ipr_inquiry_page3 {
 596         u8 peri_qual_dev_type;
 597         u8 page_code;
 598         u8 reserved1;
 599         u8 page_length;
 600         u8 ascii_len;
 601         u8 reserved2[3];
 602         u8 load_id[4];
 603         u8 major_release;
 604         u8 card_type;
 605         u8 minor_release[2];
 606         u8 ptf_number[4];
 607         u8 patch_number[4];
 608 }__attribute__((packed));
 609
 610 #define IPR_INQUIRY_PAGE0_ENTRIES 20
 611 struct ipr_inquiry_page0 {
 612         u8 peri_qual_dev_type;
 613         u8 page_code;
 614         u8 reserved1;
 615         u8 len;
 616         u8 page[IPR_INQUIRY_PAGE0_ENTRIES];
 617 }__attribute__((packed));
 618
 619 struct ipr_hostrcb_device_data_entry {
 620         struct ipr_vpd vpd;
 621         struct ipr_res_addr dev_res_addr;
 622         struct ipr_vpd new_vpd;
 623         struct ipr_vpd ioa_last_with_dev_vpd;
 624         struct ipr_vpd cfc_last_with_dev_vpd;
 625         __be32 ioa_data[5];
 626 }__attribute__((packed, aligned (4)));
 627
 628 struct ipr_hostrcb_device_data_entry_enhanced {
 629         struct ipr_ext_vpd vpd;
 630         u8 ccin[4];
 631         struct ipr_res_addr dev_res_addr;
 632         struct ipr_ext_vpd new_vpd;
 633         u8 new_ccin[4];
 634         struct ipr_ext_vpd ioa_last_with_dev_vpd;
 635         struct ipr_ext_vpd cfc_last_with_dev_vpd;
 636 }__attribute__((packed, aligned (4)));
 637
 638 struct ipr_hostrcb_array_data_entry {
 639         struct ipr_vpd vpd;
 640         struct ipr_res_addr expected_dev_res_addr;
 641         struct ipr_res_addr dev_res_addr;
 642 }__attribute__((packed, aligned (4)));
 643
 644 struct ipr_hostrcb_array_data_entry_enhanced {
 645         struct ipr_ext_vpd vpd;
 646         u8 ccin[4];
 647         struct ipr_res_addr expected_dev_res_addr;
 648         struct ipr_res_addr dev_res_addr;
 649 }__attribute__((packed, aligned (4)));
 650
 651 struct ipr_hostrcb_type_ff_error {
 652         __be32 ioa_data[502];
 653 }__attribute__((packed, aligned (4)));
 654
 655 struct ipr_hostrcb_type_01_error {
 656         __be32 seek_counter;
 657         __be32 read_counter;
 658         u8 sense_data[32];
 659         __be32 ioa_data[236];
 660 }__attribute__((packed, aligned (4)));
 661
 662 struct ipr_hostrcb_type_02_error {
 663         struct ipr_vpd ioa_vpd;
 664         struct ipr_vpd cfc_vpd;
 665         struct ipr_vpd ioa_last_attached_to_cfc_vpd;
 666         struct ipr_vpd cfc_last_attached_to_ioa_vpd;
 667         __be32 ioa_data[3];
 668 }__attribute__((packed, aligned (4)));
 669
 670 struct ipr_hostrcb_type_12_error {
 671         struct ipr_ext_vpd ioa_vpd;
 672         struct ipr_ext_vpd cfc_vpd;
 673         struct ipr_ext_vpd ioa_last_attached_to_cfc_vpd;
 674         struct ipr_ext_vpd cfc_last_attached_to_ioa_vpd;
 675         __be32 ioa_data[3];
 676 }__attribute__((packed, aligned (4)));
 677
 678 struct ipr_hostrcb_type_03_error {
 679         struct ipr_vpd ioa_vpd;
 680         struct ipr_vpd cfc_vpd;
 681         __be32 errors_detected;
 682         __be32 errors_logged;
 683         u8 ioa_data[12];
 684         struct ipr_hostrcb_device_data_entry dev[3];
 685 }__attribute__((packed, aligned (4)));
 686
 687 struct ipr_hostrcb_type_13_error {
 688         struct ipr_ext_vpd ioa_vpd;
 689         struct ipr_ext_vpd cfc_vpd;
 690         __be32 errors_detected;
 691         __be32 errors_logged;
 692         struct ipr_hostrcb_device_data_entry_enhanced dev[3];
 693 }__attribute__((packed, aligned (4)));
 694
 695 struct ipr_hostrcb_type_04_error {
 696         struct ipr_vpd ioa_vpd;
 697         struct ipr_vpd cfc_vpd;
 698         u8 ioa_data[12];
 699         struct ipr_hostrcb_array_data_entry array_member[10];
 700         __be32 exposed_mode_adn;
 701         __be32 array_id;
 702         struct ipr_vpd incomp_dev_vpd;
 703         __be32 ioa_data2;
 704         struct ipr_hostrcb_array_data_entry array_member2[8];
 705         struct ipr_res_addr last_func_vset_res_addr;
 706         u8 vset_serial_num[IPR_SERIAL_NUM_LEN];
 707         u8 protection_level[8];
 708 }__attribute__((packed, aligned (4)));
 709
 710 struct ipr_hostrcb_type_14_error {
 711         struct ipr_ext_vpd ioa_vpd;
 712         struct ipr_ext_vpd cfc_vpd;
 713         __be32 exposed_mode_adn;
 714         __be32 array_id;
 715         struct ipr_res_addr last_func_vset_res_addr;
 716         u8 vset_serial_num[IPR_SERIAL_NUM_LEN];
 717         u8 protection_level[8];
 718         __be32 num_entries;
 719         struct ipr_hostrcb_array_data_entry_enhanced array_member[18];
 720 }__attribute__((packed, aligned (4)));
 721
 722 struct ipr_hostrcb_type_07_error {
 723         u8 failure_reason[64];
 724         struct ipr_vpd vpd;
 725         u32 data[222];
 726 }__attribute__((packed, aligned (4)));
 727
 728 struct ipr_hostrcb_type_17_error {
 729         u8 failure_reason[64];
 730         struct ipr_ext_vpd vpd;
 731         u32 data[476];
 732 }__attribute__((packed, aligned (4)));
 733
 734 struct ipr_hostrcb_error {
 735         __be32 failing_dev_ioasc;
 736         struct ipr_res_addr failing_dev_res_addr;
 737         __be32 failing_dev_res_handle;
 738         __be32 prc;
 739         union {
 740                 struct ipr_hostrcb_type_ff_error type_ff_error;
 741                 struct ipr_hostrcb_type_01_error type_01_error;
 742                 struct ipr_hostrcb_type_02_error type_02_error;
 743                 struct ipr_hostrcb_type_03_error type_03_error;
 744                 struct ipr_hostrcb_type_04_error type_04_error;
 745                 struct ipr_hostrcb_type_07_error type_07_error;
 746                 struct ipr_hostrcb_type_12_error type_12_error;
 747                 struct ipr_hostrcb_type_13_error type_13_error;
 748                 struct ipr_hostrcb_type_14_error type_14_error;
 749                 struct ipr_hostrcb_type_17_error type_17_error;
 750         } u;
 751 }__attribute__((packed, aligned (4)));
 752
 753 struct ipr_hostrcb_raw {
 754         __be32 data[sizeof(struct ipr_hostrcb_error)/sizeof(__be32)];
 755 }__attribute__((packed, aligned (4)));
 756
 757 struct ipr_hcam {
 758         u8 op_code;
 759 #define IPR_HOST_RCB_OP_CODE_CONFIG_CHANGE                      0xE1
 760 #define IPR_HOST_RCB_OP_CODE_LOG_DATA                           0xE2
 761
 762         u8 notify_type;
 763 #define IPR_HOST_RCB_NOTIF_TYPE_EXISTING_CHANGED        0x00
 764 #define IPR_HOST_RCB_NOTIF_TYPE_NEW_ENTRY                       0x01
 765 #define IPR_HOST_RCB_NOTIF_TYPE_REM_ENTRY                       0x02
 766 #define IPR_HOST_RCB_NOTIF_TYPE_ERROR_LOG_ENTRY         0x10
 767 #define IPR_HOST_RCB_NOTIF_TYPE_INFORMATION_ENTRY       0x11
 768
 769         u8 notifications_lost;
 770 #define IPR_HOST_RCB_NO_NOTIFICATIONS_LOST                      0
 771 #define IPR_HOST_RCB_NOTIFICATIONS_LOST                         0x80
 772
 773         u8 flags;
 774 #define IPR_HOSTRCB_INTERNAL_OPER       0x80
 775 #define IPR_HOSTRCB_ERR_RESP_SENT       0x40
 776
 777         u8 overlay_id;
 778 #define IPR_HOST_RCB_OVERLAY_ID_1                               0x01
 779 #define IPR_HOST_RCB_OVERLAY_ID_2                               0x02
 780 #define IPR_HOST_RCB_OVERLAY_ID_3                               0x03
 781 #define IPR_HOST_RCB_OVERLAY_ID_4                               0x04
 782 #define IPR_HOST_RCB_OVERLAY_ID_6                               0x06
 783 #define IPR_HOST_RCB_OVERLAY_ID_7                               0x07
 784 #define IPR_HOST_RCB_OVERLAY_ID_12                              0x12
 785 #define IPR_HOST_RCB_OVERLAY_ID_13                              0x13
 786 #define IPR_HOST_RCB_OVERLAY_ID_14                              0x14
 787 #define IPR_HOST_RCB_OVERLAY_ID_16                              0x16
 788 #define IPR_HOST_RCB_OVERLAY_ID_17                              0x17
 789 #define IPR_HOST_RCB_OVERLAY_ID_DEFAULT                 0xFF
 790
 791         u8 reserved1[3];
 792         __be32 ilid;
 793         __be32 time_since_last_ioa_reset;
 794         __be32 reserved2;
 795         __be32 length;
 796
 797         union {
 798                 struct ipr_hostrcb_error error;
 799                 struct ipr_hostrcb_cfg_ch_not ccn;
 800                 struct ipr_hostrcb_raw raw;
 801         } u;
 802 }__attribute__((packed, aligned (4)));
 803
 804 struct ipr_hostrcb {
 805         struct ipr_hcam hcam;
 806         dma_addr_t hostrcb_dma;
 807         struct list_head queue;
 808 };
 809
 810 /* IPR smart dump table structures */
 811 struct ipr_sdt_entry {
 812         __be32 bar_str_offset;
 813         __be32 end_offset;
 814         u8 entry_byte;
 815         u8 reserved[3];
 816
 817         u8 flags;
 818 #define IPR_SDT_ENDIAN          0x80
 819 #define IPR_SDT_VALID_ENTRY     0x20
 820
 821         u8 resv;
 822         __be16 priority;
 823 }__attribute__((packed, aligned (4)));
 824
 825 struct ipr_sdt_header {
 826         __be32 state;
 827         __be32 num_entries;
 828         __be32 num_entries_used;
 829         __be32 dump_size;
 830 }__attribute__((packed, aligned (4)));
 831
 832 struct ipr_sdt {
 833         struct ipr_sdt_header hdr;
 834         struct ipr_sdt_entry entry[IPR_NUM_SDT_ENTRIES];
 835 }__attribute__((packed, aligned (4)));
 836
 837 struct ipr_uc_sdt {
 838         struct ipr_sdt_header hdr;
 839         struct ipr_sdt_entry entry[1];
 840 }__attribute__((packed, aligned (4)));
 841
 842 /*
 843  * Driver types
 844  */
 845 struct ipr_bus_attributes {
 846         u8 bus;
 847         u8 qas_enabled;
 848         u8 bus_width;
 849         u8 reserved;
 850         u32 max_xfer_rate;
 851 };
 852
 853 struct ipr_sata_port {
 854         struct ipr_ioa_cfg *ioa_cfg;
 855         struct ata_port *ap;
 856         struct ipr_resource_entry *res;
 857         struct ipr_ioasa_gata ioasa;
 858 };
 859
 860 struct ipr_resource_entry {
 861         struct ipr_config_table_entry cfgte;
 862         u8 needs_sync_complete:1;
 863         u8 in_erp:1;
 864         u8 add_to_ml:1;
 865         u8 del_from_ml:1;
 866         u8 resetting_device:1;
 867
 868         struct scsi_device *sdev;
 869         struct ipr_sata_port *sata_port;
 870         struct list_head queue;
 871 };
 872
 873 struct ipr_resource_hdr {
 874         u16 num_entries;
 875         u16 reserved;
 876 };
 877
 878 struct ipr_resource_table {
 879         struct ipr_resource_hdr hdr;
 880         struct ipr_resource_entry dev[IPR_MAX_PHYSICAL_DEVS];
 881 };
 882
 883 struct ipr_misc_cbs {
 884         struct ipr_ioa_vpd ioa_vpd;
 885         struct ipr_inquiry_page0 page0_data;
 886         struct ipr_inquiry_page3 page3_data;
 887         struct ipr_mode_pages mode_pages;
 888         struct ipr_supported_device supp_dev;
 889 };
 890
 891 struct ipr_interrupt_offsets {
 892         unsigned long set_interrupt_mask_reg;
 893         unsigned long clr_interrupt_mask_reg;
 894         unsigned long sense_interrupt_mask_reg;
 895         unsigned long clr_interrupt_reg;
 896
 897         unsigned long sense_interrupt_reg;
 898         unsigned long ioarrin_reg;
 899         unsigned long sense_uproc_interrupt_reg;
 900         unsigned long set_uproc_interrupt_reg;
 901         unsigned long clr_uproc_interrupt_reg;
 902 };
 903
 904 struct ipr_interrupts {
 905         void __iomem *set_interrupt_mask_reg;
 906         void __iomem *clr_interrupt_mask_reg;
 907         void __iomem *sense_interrupt_mask_reg;
 908         void __iomem *clr_interrupt_reg;
 909
 910         void __iomem *sense_interrupt_reg;
 911         void __iomem *ioarrin_reg;
 912         void __iomem *sense_uproc_interrupt_reg;
 913         void __iomem *set_uproc_interrupt_reg;
 914         void __iomem *clr_uproc_interrupt_reg;
 915 };
 916
 917 struct ipr_chip_cfg_t {
 918         u32 mailbox;
 919         u8 cache_line_size;
 920         struct ipr_interrupt_offsets regs;
 921 };
 922
 923 struct ipr_chip_t {
 924         u16 vendor;
 925         u16 device;
 926         const struct ipr_chip_cfg_t *cfg;
 927 };
 928
 929 enum ipr_shutdown_type {
 930         IPR_SHUTDOWN_NORMAL = 0x00,
 931         IPR_SHUTDOWN_PREPARE_FOR_NORMAL = 0x40,
 932         IPR_SHUTDOWN_ABBREV = 0x80,
 933         IPR_SHUTDOWN_NONE = 0x100
 934 };
 935
 936 struct ipr_trace_entry {
 937         u32 time;
 938
 939         u8 op_code;
 940         u8 ata_op_code;
 941         u8 type;
 942 #define IPR_TRACE_START                 0x00
 943 #define IPR_TRACE_FINISH                0xff
 944         u8 cmd_index;
 945
 946         __be32 res_handle;
 947         union {
 948                 u32 ioasc;
 949                 u32 add_data;
 950                 u32 res_addr;
 951         } u;
 952 };
 953
 954 struct ipr_sglist {
 955         u32 order;
 956         u32 num_sg;
 957         u32 num_dma_sg;
 958         u32 buffer_len;
 959         struct scatterlist scatterlist[1];
 960 };
 961
 962 enum ipr_sdt_state {
 963         INACTIVE,
 964         WAIT_FOR_DUMP,
 965         GET_DUMP,
 966         ABORT_DUMP,
 967         DUMP_OBTAINED
 968 };
 969
 970 enum ipr_cache_state {
 971         CACHE_NONE,
 972         CACHE_DISABLED,
 973         CACHE_ENABLED,
 974         CACHE_INVALID
 975 };
 976
 977 /* Per-controller data */
 978 struct ipr_ioa_cfg {
 979         char eye_catcher[8];
 980 #define IPR_EYECATCHER                  "iprcfg"
 981
 982         struct list_head queue;
 983
 984         u8 allow_interrupts:1;
 985         u8 in_reset_reload:1;
 986         u8 in_ioa_bringdown:1;
 987         u8 ioa_unit_checked:1;
 988         u8 ioa_is_dead:1;
 989         u8 dump_taken:1;
 990         u8 allow_cmds:1;
 991         u8 allow_ml_add_del:1;
 992         u8 needs_hard_reset:1;
 993
 994         enum ipr_cache_state cache_state;
 995         u16 type; /* CCIN of the card */
 996
 997         u8 log_level;
 998 #define IPR_MAX_LOG_LEVEL                       4
 999 #define IPR_DEFAULT_LOG_LEVEL           2
1000
1001 #define IPR_NUM_TRACE_INDEX_BITS        8
1002 #define IPR_NUM_TRACE_ENTRIES           (1 << IPR_NUM_TRACE_INDEX_BITS)
1003 #define IPR_TRACE_SIZE  (sizeof(struct ipr_trace_entry) * IPR_NUM_TRACE_ENTRIES)
1004         char trace_start[8];
1005 #define IPR_TRACE_START_LABEL                   "trace"
1006         struct ipr_trace_entry *trace;
1007         u32 trace_index:IPR_NUM_TRACE_INDEX_BITS;
1008
1009         /*
1010          * Queue for free command blocks
1011          */
1012         char ipr_free_label[8];
1013 #define IPR_FREEQ_LABEL                 "free-q"
1014         struct list_head free_q;
1015
1016         /*
1017          * Queue for command blocks outstanding to the adapter
1018          */
1019         char ipr_pending_label[8];
1020 #define IPR_PENDQ_LABEL                 "pend-q"
1021         struct list_head pending_q;
1022
1023         char cfg_table_start[8];
1024 #define IPR_CFG_TBL_START               "cfg"
1025         struct ipr_config_table *cfg_table;
1026         dma_addr_t cfg_table_dma;
1027
1028         char resource_table_label[8];
1029 #define IPR_RES_TABLE_LABEL             "res_tbl"
1030         struct ipr_resource_entry *res_entries;
1031         struct list_head free_res_q;
1032         struct list_head used_res_q;
1033
1034         char ipr_hcam_label[8];
1035 #define IPR_HCAM_LABEL                  "hcams"
1036         struct ipr_hostrcb *hostrcb[IPR_NUM_HCAMS];
1037         dma_addr_t hostrcb_dma[IPR_NUM_HCAMS];
1038         struct list_head hostrcb_free_q;
1039         struct list_head hostrcb_pending_q;
1040
1041         __be32 *host_rrq;
1042         dma_addr_t host_rrq_dma;
1043 #define IPR_HRRQ_REQ_RESP_HANDLE_MASK   0xfffffffc
1044 #define IPR_HRRQ_RESP_BIT_SET                   0x00000002
1045 #define IPR_HRRQ_TOGGLE_BIT                             0x00000001
1046 #define IPR_HRRQ_REQ_RESP_HANDLE_SHIFT  2
1047         volatile __be32 *hrrq_start;
1048         volatile __be32 *hrrq_end;
1049         volatile __be32 *hrrq_curr;
1050         volatile u32 toggle_bit;
1051
1052         struct ipr_bus_attributes bus_attr[IPR_MAX_NUM_BUSES];
1053
1054         const struct ipr_chip_cfg_t *chip_cfg;
1055
1056         void __iomem *hdw_dma_regs;     /* iomapped PCI memory space */
1057         unsigned long hdw_dma_regs_pci; /* raw PCI memory space */
1058         void __iomem *ioa_mailbox;
1059         struct ipr_interrupts regs;
1060
1061         u16 saved_pcix_cmd_reg;
1062         u16 reset_retries;
1063
1064         u32 errors_logged;
1065         u32 doorbell;
1066
1067         struct Scsi_Host *host;
1068         struct pci_dev *pdev;
1069         struct ipr_sglist *ucode_sglist;
1070         u8 saved_mode_page_len;
1071
1072         struct work_struct work_q;
1073
1074         wait_queue_head_t reset_wait_q;
1075
1076         struct ipr_dump *dump;
1077         enum ipr_sdt_state sdt_state;
1078
1079         struct ipr_misc_cbs *vpd_cbs;
1080         dma_addr_t vpd_cbs_dma;
1081
1082         struct pci_pool *ipr_cmd_pool;
1083
1084         struct ipr_cmnd *reset_cmd;
1085
1086         struct ata_host ata_host;
1087         char ipr_cmd_label[8];
1088 #define IPR_CMD_LABEL           "ipr_cmnd"
1089         struct ipr_cmnd *ipr_cmnd_list[IPR_NUM_CMD_BLKS];
1090         u32 ipr_cmnd_list_dma[IPR_NUM_CMD_BLKS];
1091 };
1092
1093 struct ipr_cmnd {
1094         struct ipr_ioarcb ioarcb;
1095         struct ipr_ioasa ioasa;
1096         struct ipr_ioadl_desc ioadl[IPR_NUM_IOADL_ENTRIES];
1097         struct list_head queue;
1098         struct scsi_cmnd *scsi_cmd;
1099         struct ata_queued_cmd *qc;
1100         struct completion completion;
1101         struct timer_list timer;
1102         void (*done) (struct ipr_cmnd *);
1103         int (*job_step) (struct ipr_cmnd *);
1104         int (*job_step_failed) (struct ipr_cmnd *);
1105         u16 cmd_index;
1106         u8 sense_buffer[SCSI_SENSE_BUFFERSIZE];
1107         dma_addr_t sense_buffer_dma;
1108         unsigned short dma_use_sg;
1109         dma_addr_t dma_handle;
1110         struct ipr_cmnd *sibling;
1111         union {
1112                 enum ipr_shutdown_type shutdown_type;
1113                 struct ipr_hostrcb *hostrcb;
1114                 unsigned long time_left;
1115                 unsigned long scratch;
1116                 struct ipr_resource_entry *res;
1117                 struct scsi_device *sdev;
1118         } u;
1119
1120         struct ipr_ioa_cfg *ioa_cfg;
1121 };
1122
1123 struct ipr_ses_table_entry {
1124         char product_id[17];
1125         char compare_product_id_byte[17];
1126         u32 max_bus_speed_limit;        /* MB/sec limit for this backplane */
1127 };
1128
1129 struct ipr_dump_header {
1130         u32 eye_catcher;
1131 #define IPR_DUMP_EYE_CATCHER            0xC5D4E3F2
1132         u32 len;
1133         u32 num_entries;
1134         u32 first_entry_offset;
1135         u32 status;
1136 #define IPR_DUMP_STATUS_SUCCESS                 0
1137 #define IPR_DUMP_STATUS_QUAL_SUCCESS            2
1138 #define IPR_DUMP_STATUS_FAILED                  0xffffffff
1139         u32 os;
1140 #define IPR_DUMP_OS_LINUX       0x4C4E5558
1141         u32 driver_name;
1142 #define IPR_DUMP_DRIVER_NAME    0x49505232
1143 }__attribute__((packed, aligned (4)));
1144
1145 struct ipr_dump_entry_header {
1146         u32 eye_catcher;
1147 #define IPR_DUMP_EYE_CATCHER            0xC5D4E3F2
1148         u32 len;
1149         u32 num_elems;
1150         u32 offset;
1151         u32 data_type;
1152 #define IPR_DUMP_DATA_TYPE_ASCII        0x41534349
1153 #define IPR_DUMP_DATA_TYPE_BINARY       0x42494E41
1154         u32 id;
1155 #define IPR_DUMP_IOA_DUMP_ID            0x494F4131
1156 #define IPR_DUMP_LOCATION_ID            0x4C4F4341
1157 #define IPR_DUMP_TRACE_ID               0x54524143
1158 #define IPR_DUMP_DRIVER_VERSION_ID      0x44525652
1159 #define IPR_DUMP_DRIVER_TYPE_ID 0x54595045
1160 #define IPR_DUMP_IOA_CTRL_BLK           0x494F4342
1161 #define IPR_DUMP_PEND_OPS               0x414F5053
1162         u32 status;
1163 }__attribute__((packed, aligned (4)));
1164
1165 struct ipr_dump_location_entry {
1166         struct ipr_dump_entry_header hdr;
1167         u8 location[BUS_ID_SIZE];
1168 }__attribute__((packed));
1169
1170 struct ipr_dump_trace_entry {
1171         struct ipr_dump_entry_header hdr;
1172         u32 trace[IPR_TRACE_SIZE / sizeof(u32)];
1173 }__attribute__((packed, aligned (4)));
1174
1175 struct ipr_dump_version_entry {
1176         struct ipr_dump_entry_header hdr;
1177         u8 version[sizeof(IPR_DRIVER_VERSION)];
1178 };
1179
1180 struct ipr_dump_ioa_type_entry {
1181         struct ipr_dump_entry_header hdr;
1182         u32 type;
1183         u32 fw_version;
1184 };
1185
1186 struct ipr_driver_dump {
1187         struct ipr_dump_header hdr;
1188         struct ipr_dump_version_entry version_entry;
1189         struct ipr_dump_location_entry location_entry;
1190         struct ipr_dump_ioa_type_entry ioa_type_entry;
1191         struct ipr_dump_trace_entry trace_entry;
1192 }__attribute__((packed));
1193
1194 struct ipr_ioa_dump {
1195         struct ipr_dump_entry_header hdr;
1196         struct ipr_sdt sdt;
1197         __be32 *ioa_data[IPR_MAX_NUM_DUMP_PAGES];
1198         u32 reserved;
1199         u32 next_page_index;
1200         u32 page_offset;
1201         u32 format;
1202 #define IPR_SDT_FMT2            2
1203 #define IPR_SDT_UNKNOWN         3
1204 }__attribute__((packed, aligned (4)));
1205
1206 struct ipr_dump {
1207         struct kref kref;
1208         struct ipr_ioa_cfg *ioa_cfg;
1209         struct ipr_driver_dump driver_dump;
1210         struct ipr_ioa_dump ioa_dump;
1211 };
1212
1213 struct ipr_error_table_t {
1214         u32 ioasc;
1215         int log_ioasa;
1216         int log_hcam;
1217         char *error;
1218 };
1219
1220 struct ipr_software_inq_lid_info {
1221         __be32 load_id;
1222         __be32 timestamp[3];
1223 }__attribute__((packed, aligned (4)));
1224
1225 struct ipr_ucode_image_header {
1226         __be32 header_length;
1227         __be32 lid_table_offset;
1228         u8 major_release;
1229         u8 card_type;
1230         u8 minor_release[2];
1231         u8 reserved[20];
1232         char eyecatcher[16];
1233         __be32 num_lids;
1234         struct ipr_software_inq_lid_info lid[1];
1235 }__attribute__((packed, aligned (4)));
1236
1237 /*
1238  * Macros
1239  */
1240 #define IPR_DBG_CMD(CMD) if (ipr_debug) { CMD; }
1241
1242 #ifdef CONFIG_SCSI_IPR_TRACE
1243 #define ipr_create_trace_file(kobj, attr) sysfs_create_bin_file(kobj, attr)
1244 #define ipr_remove_trace_file(kobj, attr) sysfs_remove_bin_file(kobj, attr)
1245 #else
1246 #define ipr_create_trace_file(kobj, attr) 0
1247 #define ipr_remove_trace_file(kobj, attr) do { } while(0)
1248 #endif
1249
1250 #ifdef CONFIG_SCSI_IPR_DUMP
1251 #define ipr_create_dump_file(kobj, attr) sysfs_create_bin_file(kobj, attr)
1252 #define ipr_remove_dump_file(kobj, attr) sysfs_remove_bin_file(kobj, attr)
1253 #else
1254 #define ipr_create_dump_file(kobj, attr) 0
1255 #define ipr_remove_dump_file(kobj, attr) do { } while(0)
1256 #endif
1257
1258 /*
1259  * Error logging macros
1260  */
1261 #define ipr_err(...) printk(KERN_ERR IPR_NAME ": "__VA_ARGS__)
1262 #define ipr_info(...) printk(KERN_INFO IPR_NAME ": "__VA_ARGS__)
1263 #define ipr_dbg(...) IPR_DBG_CMD(printk(KERN_INFO IPR_NAME ": "__VA_ARGS__))
1264
1265 #define ipr_ra_printk(level, ioa_cfg, ra, fmt, ...) \
1266         printk(level IPR_NAME ": %d:%d:%d:%d: " fmt, (ioa_cfg)->host->host_no, \
1267                 (ra).bus, (ra).target, (ra).lun, ##__VA_ARGS__)
1268
1269 #define ipr_ra_err(ioa_cfg, ra, fmt, ...) \
1270         ipr_ra_printk(KERN_ERR, ioa_cfg, ra, fmt, ##__VA_ARGS__)
1271
1272 #define ipr_res_err(ioa_cfg, res, fmt, ...) \
1273         ipr_ra_err(ioa_cfg, (res)->cfgte.res_addr, fmt, ##__VA_ARGS__)
1274
1275 #define ipr_phys_res_err(ioa_cfg, res, fmt, ...)                        \
1276 {                                                                       \
1277         if ((res).bus >= IPR_MAX_NUM_BUSES) {                           \
1278                 ipr_err(fmt": unknown\n", ##__VA_ARGS__);               \
1279         } else {                                                        \
1280                 ipr_err(fmt": %d:%d:%d:%d\n",                           \
1281                         ##__VA_ARGS__, (ioa_cfg)->host->host_no,        \
1282                         (res).bus, (res).target, (res).lun);            \
1283         }                                                               \
1284 }
1285
1286 #define ipr_trace ipr_dbg("%s: %s: Line: %d\n",\
1287         __FILE__, __FUNCTION__, __LINE__)
1288
1289 #define ENTER IPR_DBG_CMD(printk(KERN_INFO IPR_NAME": Entering %s\n", __FUNCTION__))
1290 #define LEAVE IPR_DBG_CMD(printk(KERN_INFO IPR_NAME": Leaving %s\n", __FUNCTION__))
1291
1292 #define ipr_err_separator \
1293 ipr_err("----------------------------------------------------------\n")
1294
1295
1296 /*
1297  * Inlines
1298  */
1299
1300 /**
1301  * ipr_is_ioa_resource - Determine if a resource is the IOA
1302  * @res:        resource entry struct
1303  *
1304  * Return value:
1305  *      1 if IOA / 0 if not IOA
1306  **/
1307 static inline int ipr_is_ioa_resource(struct ipr_resource_entry *res)
1308 {
1309         return (res->cfgte.flags & IPR_IS_IOA_RESOURCE) ? 1 : 0;
1310 }
1311
1312 /**
1313  * ipr_is_af_dasd_device - Determine if a resource is an AF DASD
1314  * @res:        resource entry struct
1315  *
1316  * Return value:
1317  *      1 if AF DASD / 0 if not AF DASD
1318  **/
1319 static inline int ipr_is_af_dasd_device(struct ipr_resource_entry *res)
1320 {
1321         if (IPR_IS_DASD_DEVICE(res->cfgte.std_inq_data) &&
1322             !ipr_is_ioa_resource(res) &&
1323             IPR_RES_SUBTYPE(res) == IPR_SUBTYPE_AF_DASD)
1324                 return 1;
1325         else
1326                 return 0;
1327 }
1328
1329 /**
1330  * ipr_is_vset_device - Determine if a resource is a VSET
1331  * @res:        resource entry struct
1332  *
1333  * Return value:
1334  *      1 if VSET / 0 if not VSET
1335  **/
1336 static inline int ipr_is_vset_device(struct ipr_resource_entry *res)
1337 {
1338         if (IPR_IS_DASD_DEVICE(res->cfgte.std_inq_data) &&
1339             !ipr_is_ioa_resource(res) &&
1340             IPR_RES_SUBTYPE(res) == IPR_SUBTYPE_VOLUME_SET)
1341                 return 1;
1342         else
1343                 return 0;
1344 }
1345
1346 /**
1347  * ipr_is_gscsi - Determine if a resource is a generic scsi resource
1348  * @res:        resource entry struct
1349  *
1350  * Return value:
1351  *      1 if GSCSI / 0 if not GSCSI
1352  **/
1353 static inline int ipr_is_gscsi(struct ipr_resource_entry *res)
1354 {
1355         if (!ipr_is_ioa_resource(res) &&
1356             IPR_RES_SUBTYPE(res) == IPR_SUBTYPE_GENERIC_SCSI)
1357                 return 1;
1358         else
1359                 return 0;
1360 }
1361
1362 /**
1363  * ipr_is_scsi_disk - Determine if a resource is a SCSI disk
1364  * @res:        resource entry struct
1365  *
1366  * Return value:
1367  *      1 if SCSI disk / 0 if not SCSI disk
1368  **/
1369 static inline int ipr_is_scsi_disk(struct ipr_resource_entry *res)
1370 {
1371         if (ipr_is_af_dasd_device(res) ||
1372             (ipr_is_gscsi(res) && IPR_IS_DASD_DEVICE(res->cfgte.std_inq_data)))
1373                 return 1;
1374         else
1375                 return 0;
1376 }
1377
1378 /**
1379  * ipr_is_gata - Determine if a resource is a generic ATA resource
1380  * @res:        resource entry struct
1381  *
1382  * Return value:
1383  *      1 if GATA / 0 if not GATA
1384  **/
1385 static inline int ipr_is_gata(struct ipr_resource_entry *res)
1386 {
1387         if (!ipr_is_ioa_resource(res) &&
1388             IPR_RES_SUBTYPE(res) == IPR_SUBTYPE_GENERIC_ATA)
1389                 return 1;
1390         else
1391                 return 0;
1392 }
1393
1394 /**
1395  * ipr_is_naca_model - Determine if a resource is using NACA queueing model
1396  * @res:        resource entry struct
1397  *
1398  * Return value:
1399  *      1 if NACA queueing model / 0 if not NACA queueing model
1400  **/
1401 static inline int ipr_is_naca_model(struct ipr_resource_entry *res)
1402 {
1403         if (ipr_is_gscsi(res) && IPR_QUEUEING_MODEL(res) == IPR_QUEUE_NACA_MODEL)
1404                 return 1;
1405         return 0;
1406 }
1407
1408 /**
1409  * ipr_is_device - Determine if resource address is that of a device
1410  * @res_addr:   resource address struct
1411  *
1412  * Return value:
1413  *      1 if AF / 0 if not AF
1414  **/
1415 static inline int ipr_is_device(struct ipr_res_addr *res_addr)
1416 {
1417         if ((res_addr->bus < IPR_MAX_NUM_BUSES) &&
1418             (res_addr->target < (IPR_MAX_NUM_TARGETS_PER_BUS - 1)))
1419                 return 1;
1420
1421         return 0;
1422 }
1423
1424 /**
1425  * ipr_sdt_is_fmt2 - Determine if a SDT address is in format 2
1426  * @sdt_word:   SDT address
1427  *
1428  * Return value:
1429  *      1 if format 2 / 0 if not
1430  **/
1431 static inline int ipr_sdt_is_fmt2(u32 sdt_word)
1432 {
1433         u32 bar_sel = IPR_GET_FMT2_BAR_SEL(sdt_word);
1434
1435         switch (bar_sel) {
1436         case IPR_SDT_FMT2_BAR0_SEL:
1437         case IPR_SDT_FMT2_BAR1_SEL:
1438         case IPR_SDT_FMT2_BAR2_SEL:
1439         case IPR_SDT_FMT2_BAR3_SEL:
1440         case IPR_SDT_FMT2_BAR4_SEL:
1441         case IPR_SDT_FMT2_BAR5_SEL:
1442         case IPR_SDT_FMT2_EXP_ROM_SEL:
1443                 return 1;
1444         };
1445
1446         return 0;
1447 }
1448
1449 #endif