drivers/scsi/ipr.h

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