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