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