drivers/scsi/hpsa_cmd.h

   1 /*
   2  *    Disk Array driver for HP Smart Array SAS controllers
   3  *    Copyright 2016 Microsemi Corporation
   4  *    Copyright 2014-2015 PMC-Sierra, Inc.
   5  *    Copyright 2000,2009-2015 Hewlett-Packard Development Company, L.P.
   6  *
   7  *    This program is free software; you can redistribute it and/or modify
   8  *    it under the terms of the GNU General Public License as published by
   9  *    the Free Software Foundation; version 2 of the License.
  10  *
  11  *    This program is distributed in the hope that it will be useful,
  12  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  14  *    NON INFRINGEMENT.  See the GNU General Public License for more details.
  15  *
  16  *    Questions/Comments/Bugfixes to esc.storagedev@microsemi.com
  17  *
  18  */
  19 #ifndef HPSA_CMD_H
  20 #define HPSA_CMD_H
  21
  22 /* general boundary defintions */
  23 #define SENSEINFOBYTES          32 /* may vary between hbas */
  24 #define SG_ENTRIES_IN_CMD       32 /* Max SG entries excluding chain blocks */
  25 #define HPSA_SG_CHAIN           0x80000000
  26 #define HPSA_SG_LAST            0x40000000
  27 #define MAXREPLYQS              256
  28
  29 /* Command Status value */
  30 #define CMD_SUCCESS             0x0000
  31 #define CMD_TARGET_STATUS       0x0001
  32 #define CMD_DATA_UNDERRUN       0x0002
  33 #define CMD_DATA_OVERRUN        0x0003
  34 #define CMD_INVALID             0x0004
  35 #define CMD_PROTOCOL_ERR        0x0005
  36 #define CMD_HARDWARE_ERR        0x0006
  37 #define CMD_CONNECTION_LOST     0x0007
  38 #define CMD_ABORTED             0x0008
  39 #define CMD_ABORT_FAILED        0x0009
  40 #define CMD_UNSOLICITED_ABORT   0x000A
  41 #define CMD_TIMEOUT             0x000B
  42 #define CMD_UNABORTABLE         0x000C
  43 #define CMD_TMF_STATUS          0x000D
  44 #define CMD_IOACCEL_DISABLED    0x000E
  45 #define CMD_CTLR_LOCKUP         0xffff
  46 /* Note: CMD_CTLR_LOCKUP is not a value defined by the CISS spec
  47  * it is a value defined by the driver that commands can be marked
  48  * with when a controller lockup has been detected by the driver
  49  */
  50
  51 /* TMF function status values */
  52 #define CISS_TMF_COMPLETE       0x00
  53 #define CISS_TMF_INVALID_FRAME  0x02
  54 #define CISS_TMF_NOT_SUPPORTED  0x04
  55 #define CISS_TMF_FAILED         0x05
  56 #define CISS_TMF_SUCCESS        0x08
  57 #define CISS_TMF_WRONG_LUN      0x09
  58 #define CISS_TMF_OVERLAPPED_TAG 0x0a
  59
  60 /* Unit Attentions ASC's as defined for the MSA2012sa */
  61 #define POWER_OR_RESET                  0x29
  62 #define STATE_CHANGED                   0x2a
  63 #define UNIT_ATTENTION_CLEARED          0x2f
  64 #define LUN_FAILED                      0x3e
  65 #define REPORT_LUNS_CHANGED             0x3f
  66
  67 /* Unit Attentions ASCQ's as defined for the MSA2012sa */
  68
  69         /* These ASCQ's defined for ASC = POWER_OR_RESET */
  70 #define POWER_ON_RESET                  0x00
  71 #define POWER_ON_REBOOT                 0x01
  72 #define SCSI_BUS_RESET                  0x02
  73 #define MSA_TARGET_RESET                0x03
  74 #define CONTROLLER_FAILOVER             0x04
  75 #define TRANSCEIVER_SE                  0x05
  76 #define TRANSCEIVER_LVD                 0x06
  77
  78         /* These ASCQ's defined for ASC = STATE_CHANGED */
  79 #define RESERVATION_PREEMPTED           0x03
  80 #define ASYM_ACCESS_CHANGED             0x06
  81 #define LUN_CAPACITY_CHANGED            0x09
  82
  83 /* transfer direction */
  84 #define XFER_NONE               0x00
  85 #define XFER_WRITE              0x01
  86 #define XFER_READ               0x02
  87 #define XFER_RSVD               0x03
  88
  89 /* task attribute */
  90 #define ATTR_UNTAGGED           0x00
  91 #define ATTR_SIMPLE             0x04
  92 #define ATTR_HEADOFQUEUE        0x05
  93 #define ATTR_ORDERED            0x06
  94 #define ATTR_ACA                0x07
  95
  96 /* cdb type */
  97 #define TYPE_CMD                0x00
  98 #define TYPE_MSG                0x01
  99 #define TYPE_IOACCEL2_CMD       0x81 /* 0x81 is not used by hardware */
 100
 101 /* Message Types  */
 102 #define HPSA_TASK_MANAGEMENT    0x00
 103 #define HPSA_RESET              0x01
 104 #define HPSA_SCAN               0x02
 105 #define HPSA_NOOP               0x03
 106
 107 #define HPSA_CTLR_RESET_TYPE    0x00
 108 #define HPSA_BUS_RESET_TYPE     0x01
 109 #define HPSA_TARGET_RESET_TYPE  0x03
 110 #define HPSA_LUN_RESET_TYPE     0x04
 111 #define HPSA_NEXUS_RESET_TYPE   0x05
 112
 113 /* Task Management Functions */
 114 #define HPSA_TMF_ABORT_TASK     0x00
 115 #define HPSA_TMF_ABORT_TASK_SET 0x01
 116 #define HPSA_TMF_CLEAR_ACA      0x02
 117 #define HPSA_TMF_CLEAR_TASK_SET 0x03
 118 #define HPSA_TMF_QUERY_TASK     0x04
 119 #define HPSA_TMF_QUERY_TASK_SET 0x05
 120 #define HPSA_TMF_QUERY_ASYNCEVENT 0x06
 121
 122
 123
 124 /* config space register offsets */
 125 #define CFG_VENDORID            0x00
 126 #define CFG_DEVICEID            0x02
 127 #define CFG_I2OBAR              0x10
 128 #define CFG_MEM1BAR             0x14
 129
 130 /* i2o space register offsets */
 131 #define I2O_IBDB_SET            0x20
 132 #define I2O_IBDB_CLEAR          0x70
 133 #define I2O_INT_STATUS          0x30
 134 #define I2O_INT_MASK            0x34
 135 #define I2O_IBPOST_Q            0x40
 136 #define I2O_OBPOST_Q            0x44
 137 #define I2O_DMA1_CFG            0x214
 138
 139 /* Configuration Table */
 140 #define CFGTBL_ChangeReq        0x00000001l
 141 #define CFGTBL_AccCmds          0x00000001l
 142 #define DOORBELL_CTLR_RESET     0x00000004l
 143 #define DOORBELL_CTLR_RESET2    0x00000020l
 144 #define DOORBELL_CLEAR_EVENTS   0x00000040l
 145
 146 #define CFGTBL_Trans_Simple     0x00000002l
 147 #define CFGTBL_Trans_Performant 0x00000004l
 148 #define CFGTBL_Trans_io_accel1  0x00000080l
 149 #define CFGTBL_Trans_io_accel2  0x00000100l
 150 #define CFGTBL_Trans_use_short_tags 0x20000000l
 151 #define CFGTBL_Trans_enable_directed_msix (1 << 30)
 152
 153 #define CFGTBL_BusType_Ultra2   0x00000001l
 154 #define CFGTBL_BusType_Ultra3   0x00000002l
 155 #define CFGTBL_BusType_Fibre1G  0x00000100l
 156 #define CFGTBL_BusType_Fibre2G  0x00000200l
 157
 158 /* VPD Inquiry types */
 159 #define HPSA_INQUIRY_FAILED             0x02
 160 #define HPSA_VPD_SUPPORTED_PAGES        0x00
 161 #define HPSA_VPD_LV_DEVICE_ID           0x83
 162 #define HPSA_VPD_LV_DEVICE_GEOMETRY     0xC1
 163 #define HPSA_VPD_LV_IOACCEL_STATUS      0xC2
 164 #define HPSA_VPD_LV_STATUS              0xC3
 165 #define HPSA_VPD_HEADER_SZ              4
 166
 167 /* Logical volume states */
 168 #define HPSA_VPD_LV_STATUS_UNSUPPORTED                  0xff
 169 #define HPSA_LV_OK                                      0x0
 170 #define HPSA_LV_FAILED                                  0x01
 171 #define HPSA_LV_NOT_AVAILABLE                           0x0b
 172 #define HPSA_LV_UNDERGOING_ERASE                        0x0F
 173 #define HPSA_LV_UNDERGOING_RPI                          0x12
 174 #define HPSA_LV_PENDING_RPI                             0x13
 175 #define HPSA_LV_ENCRYPTED_NO_KEY                        0x14
 176 #define HPSA_LV_PLAINTEXT_IN_ENCRYPT_ONLY_CONTROLLER    0x15
 177 #define HPSA_LV_UNDERGOING_ENCRYPTION                   0x16
 178 #define HPSA_LV_UNDERGOING_ENCRYPTION_REKEYING          0x17
 179 #define HPSA_LV_ENCRYPTED_IN_NON_ENCRYPTED_CONTROLLER   0x18
 180 #define HPSA_LV_PENDING_ENCRYPTION                      0x19
 181 #define HPSA_LV_PENDING_ENCRYPTION_REKEYING             0x1A
 182
 183 struct vals32 {
 184         u32   lower;
 185         u32   upper;
 186 };
 187
 188 union u64bit {
 189         struct vals32 val32;
 190         u64 val;
 191 };
 192
 193 /* FIXME this is a per controller value (barf!) */
 194 #define HPSA_MAX_LUN 1024
 195 #define HPSA_MAX_PHYS_LUN 1024
 196 #define MAX_EXT_TARGETS 32
 197 #define HPSA_MAX_DEVICES (HPSA_MAX_PHYS_LUN + HPSA_MAX_LUN + \
 198         MAX_EXT_TARGETS + 1) /* + 1 is for the controller itself */
 199
 200 /* SCSI-3 Commands */
 201 #pragma pack(1)
 202
 203 #define HPSA_INQUIRY 0x12
 204 struct InquiryData {
 205         u8 data_byte[36];
 206 };
 207
 208 #define HPSA_REPORT_LOG 0xc2    /* Report Logical LUNs */
 209 #define HPSA_REPORT_PHYS 0xc3   /* Report Physical LUNs */
 210 #define HPSA_REPORT_PHYS_EXTENDED 0x02
 211 #define HPSA_CISS_READ  0xc0    /* CISS Read */
 212 #define HPSA_GET_RAID_MAP 0xc8  /* CISS Get RAID Layout Map */
 213
 214 #define RAID_MAP_MAX_ENTRIES   256
 215
 216 struct raid_map_disk_data {
 217         u32   ioaccel_handle;         /**< Handle to access this disk via the
 218                                         *  I/O accelerator */
 219         u8    xor_mult[2];            /**< XOR multipliers for this position,
 220                                         *  valid for data disks only */
 221         u8    reserved[2];
 222 };
 223
 224 struct raid_map_data {
 225         __le32   structure_size;        /* Size of entire structure in bytes */
 226         __le32   volume_blk_size;       /* bytes / block in the volume */
 227         __le64   volume_blk_cnt;        /* logical blocks on the volume */
 228         u8    phys_blk_shift;           /* Shift factor to convert between
 229                                          * units of logical blocks and physical
 230                                          * disk blocks */
 231         u8    parity_rotation_shift;    /* Shift factor to convert between units
 232                                          * of logical stripes and physical
 233                                          * stripes */
 234         __le16   strip_size;            /* blocks used on each disk / stripe */
 235         __le64   disk_starting_blk;     /* First disk block used in volume */
 236         __le64   disk_blk_cnt;          /* disk blocks used by volume / disk */
 237         __le16   data_disks_per_row;    /* data disk entries / row in the map */
 238         __le16   metadata_disks_per_row;/* mirror/parity disk entries / row
 239                                          * in the map */
 240         __le16   row_cnt;               /* rows in each layout map */
 241         __le16   layout_map_count;      /* layout maps (1 map per mirror/parity
 242                                          * group) */
 243         __le16   flags;                 /* Bit 0 set if encryption enabled */
 244 #define RAID_MAP_FLAG_ENCRYPT_ON  0x01
 245         __le16   dekindex;              /* Data encryption key index. */
 246         u8    reserved[16];
 247         struct raid_map_disk_data data[RAID_MAP_MAX_ENTRIES];
 248 };
 249
 250 struct ReportLUNdata {
 251         u8 LUNListLength[4];
 252         u8 extended_response_flag;
 253         u8 reserved[3];
 254         u8 LUN[HPSA_MAX_LUN][8];
 255 };
 256
 257 struct ext_report_lun_entry {
 258         u8 lunid[8];
 259 #define MASKED_DEVICE(x) ((x)[3] & 0xC0)
 260 #define GET_BMIC_BUS(lunid) ((lunid)[7] & 0x3F)
 261 #define GET_BMIC_LEVEL_TWO_TARGET(lunid) ((lunid)[6])
 262 #define GET_BMIC_DRIVE_NUMBER(lunid) (((GET_BMIC_BUS((lunid)) - 1) << 8) + \
 263                         GET_BMIC_LEVEL_TWO_TARGET((lunid)))
 264         u8 wwid[8];
 265         u8 device_type;
 266         u8 device_flags;
 267         u8 lun_count; /* multi-lun device, how many luns */
 268         u8 redundant_paths;
 269         u32 ioaccel_handle; /* ioaccel1 only uses lower 16 bits */
 270 };
 271
 272 struct ReportExtendedLUNdata {
 273         u8 LUNListLength[4];
 274         u8 extended_response_flag;
 275         u8 reserved[3];
 276         struct ext_report_lun_entry LUN[HPSA_MAX_PHYS_LUN];
 277 };
 278
 279 struct SenseSubsystem_info {
 280         u8 reserved[36];
 281         u8 portname[8];
 282         u8 reserved1[1108];
 283 };
 284
 285 /* BMIC commands */
 286 #define BMIC_READ 0x26
 287 #define BMIC_WRITE 0x27
 288 #define BMIC_CACHE_FLUSH 0xc2
 289 #define HPSA_CACHE_FLUSH 0x01   /* C2 was already being used by HPSA */
 290 #define BMIC_FLASH_FIRMWARE 0xF7
 291 #define BMIC_SENSE_CONTROLLER_PARAMETERS 0x64
 292 #define BMIC_IDENTIFY_PHYSICAL_DEVICE 0x15
 293 #define BMIC_IDENTIFY_CONTROLLER 0x11
 294 #define BMIC_SET_DIAG_OPTIONS 0xF4
 295 #define BMIC_SENSE_DIAG_OPTIONS 0xF5
 296 #define HPSA_DIAG_OPTS_DISABLE_RLD_CACHING 0x80000000
 297 #define BMIC_SENSE_SUBSYSTEM_INFORMATION 0x66
 298 #define BMIC_SENSE_STORAGE_BOX_PARAMS 0x65
 299
 300 /* Command List Structure */
 301 union SCSI3Addr {
 302         struct {
 303                 u8 Dev;
 304                 u8 Bus:6;
 305                 u8 Mode:2;        /* b00 */
 306         } PeripDev;
 307         struct {
 308                 u8 DevLSB;
 309                 u8 DevMSB:6;
 310                 u8 Mode:2;        /* b01 */
 311         } LogDev;
 312         struct {
 313                 u8 Dev:5;
 314                 u8 Bus:3;
 315                 u8 Targ:6;
 316                 u8 Mode:2;        /* b10 */
 317         } LogUnit;
 318 };
 319
 320 struct PhysDevAddr {
 321         u32             TargetId:24;
 322         u32             Bus:6;
 323         u32             Mode:2;
 324         /* 2 level target device addr */
 325         union SCSI3Addr  Target[2];
 326 };
 327
 328 struct LogDevAddr {
 329         u32            VolId:30;
 330         u32            Mode:2;
 331         u8             reserved[4];
 332 };
 333
 334 union LUNAddr {
 335         u8               LunAddrBytes[8];
 336         union SCSI3Addr    SCSI3Lun[4];
 337         struct PhysDevAddr PhysDev;
 338         struct LogDevAddr  LogDev;
 339 };
 340
 341 struct CommandListHeader {
 342         u8              ReplyQueue;
 343         u8              SGList;
 344         __le16          SGTotal;
 345         __le64          tag;
 346         union LUNAddr     LUN;
 347 };
 348
 349 struct RequestBlock {
 350         u8   CDBLen;
 351         /*
 352          * type_attr_dir:
 353          * type: low 3 bits
 354          * attr: middle 3 bits
 355          * dir: high 2 bits
 356          */
 357         u8      type_attr_dir;
 358 #define TYPE_ATTR_DIR(t, a, d) ((((d) & 0x03) << 6) |\
 359                                 (((a) & 0x07) << 3) |\
 360                                 ((t) & 0x07))
 361 #define GET_TYPE(tad) ((tad) & 0x07)
 362 #define GET_ATTR(tad) (((tad) >> 3) & 0x07)
 363 #define GET_DIR(tad) (((tad) >> 6) & 0x03)
 364         u16  Timeout;
 365         u8   CDB[16];
 366 };
 367
 368 struct ErrDescriptor {
 369         __le64 Addr;
 370         __le32 Len;
 371 };
 372
 373 struct SGDescriptor {
 374         __le64 Addr;
 375         __le32 Len;
 376         __le32 Ext;
 377 };
 378
 379 union MoreErrInfo {
 380         struct {
 381                 u8  Reserved[3];
 382                 u8  Type;
 383                 u32 ErrorInfo;
 384         } Common_Info;
 385         struct {
 386                 u8  Reserved[2];
 387                 u8  offense_size; /* size of offending entry */
 388                 u8  offense_num;  /* byte # of offense 0-base */
 389                 u32 offense_value;
 390         } Invalid_Cmd;
 391 };
 392 struct ErrorInfo {
 393         u8               ScsiStatus;
 394         u8               SenseLen;
 395         u16              CommandStatus;
 396         u32              ResidualCnt;
 397         union MoreErrInfo  MoreErrInfo;
 398         u8               SenseInfo[SENSEINFOBYTES];
 399 };
 400 /* Command types */
 401 #define CMD_IOCTL_PEND  0x01
 402 #define CMD_SCSI        0x03
 403 #define CMD_IOACCEL1    0x04
 404 #define CMD_IOACCEL2    0x05
 405 #define IOACCEL2_TMF    0x06
 406
 407 #define DIRECT_LOOKUP_SHIFT 4
 408 #define DIRECT_LOOKUP_MASK (~((1 << DIRECT_LOOKUP_SHIFT) - 1))
 409
 410 #define HPSA_ERROR_BIT          0x02
 411 struct ctlr_info; /* defined in hpsa.h */
 412 /* The size of this structure needs to be divisible by 128
 413  * on all architectures.  The low 4 bits of the addresses
 414  * are used as follows:
 415  *
 416  * bit 0: to device, used to indicate "performant mode" command
 417  *        from device, indidcates error status.
 418  * bit 1-3: to device, indicates block fetch table entry for
 419  *          reducing DMA in fetching commands from host memory.
 420  */
 421
 422 #define COMMANDLIST_ALIGNMENT 128
 423 struct CommandList {
 424         struct CommandListHeader Header;
 425         struct RequestBlock      Request;
 426         struct ErrDescriptor     ErrDesc;
 427         struct SGDescriptor      SG[SG_ENTRIES_IN_CMD];
 428         /* information associated with the command */
 429         u32                        busaddr; /* physical addr of this record */
 430         struct ErrorInfo *err_info; /* pointer to the allocated mem */
 431         struct ctlr_info           *h;
 432         int                        cmd_type;
 433         long                       cmdindex;
 434         struct completion *waiting;
 435         struct scsi_cmnd *scsi_cmd;
 436         struct work_struct work;
 437
 438         /*
 439          * For commands using either of the two "ioaccel" paths to
 440          * bypass the RAID stack and go directly to the physical disk
 441          * phys_disk is a pointer to the hpsa_scsi_dev_t to which the
 442          * i/o is destined.  We need to store that here because the command
 443          * may potentially encounter TASK SET FULL and need to be resubmitted
 444          * For "normal" i/o's not using the "ioaccel" paths, phys_disk is
 445          * not used.
 446          */
 447         struct hpsa_scsi_dev_t *phys_disk;
 448
 449         int abort_pending;
 450         struct hpsa_scsi_dev_t *reset_pending;
 451         atomic_t refcount; /* Must be last to avoid memset in hpsa_cmd_init() */
 452 } __aligned(COMMANDLIST_ALIGNMENT);
 453
 454 /* Max S/G elements in I/O accelerator command */
 455 #define IOACCEL1_MAXSGENTRIES           24
 456 #define IOACCEL2_MAXSGENTRIES           28
 457
 458 /*
 459  * Structure for I/O accelerator (mode 1) commands.
 460  * Note that this structure must be 128-byte aligned in size.
 461  */
 462 #define IOACCEL1_COMMANDLIST_ALIGNMENT 128
 463 struct io_accel1_cmd {
 464         __le16 dev_handle;              /* 0x00 - 0x01 */
 465         u8  reserved1;                  /* 0x02 */
 466         u8  function;                   /* 0x03 */
 467         u8  reserved2[8];               /* 0x04 - 0x0B */
 468         u32 err_info;                   /* 0x0C - 0x0F */
 469         u8  reserved3[2];               /* 0x10 - 0x11 */
 470         u8  err_info_len;               /* 0x12 */
 471         u8  reserved4;                  /* 0x13 */
 472         u8  sgl_offset;                 /* 0x14 */
 473         u8  reserved5[7];               /* 0x15 - 0x1B */
 474         __le32 transfer_len;            /* 0x1C - 0x1F */
 475         u8  reserved6[4];               /* 0x20 - 0x23 */
 476         __le16 io_flags;                /* 0x24 - 0x25 */
 477         u8  reserved7[14];              /* 0x26 - 0x33 */
 478         u8  LUN[8];                     /* 0x34 - 0x3B */
 479         __le32 control;                 /* 0x3C - 0x3F */
 480         u8  CDB[16];                    /* 0x40 - 0x4F */
 481         u8  reserved8[16];              /* 0x50 - 0x5F */
 482         __le16 host_context_flags;      /* 0x60 - 0x61 */
 483         __le16 timeout_sec;             /* 0x62 - 0x63 */
 484         u8  ReplyQueue;                 /* 0x64 */
 485         u8  reserved9[3];               /* 0x65 - 0x67 */
 486         __le64 tag;                     /* 0x68 - 0x6F */
 487         __le64 host_addr;               /* 0x70 - 0x77 */
 488         u8  CISS_LUN[8];                /* 0x78 - 0x7F */
 489         struct SGDescriptor SG[IOACCEL1_MAXSGENTRIES];
 490 } __aligned(IOACCEL1_COMMANDLIST_ALIGNMENT);
 491
 492 #define IOACCEL1_FUNCTION_SCSIIO        0x00
 493 #define IOACCEL1_SGLOFFSET              32
 494
 495 #define IOACCEL1_IOFLAGS_IO_REQ         0x4000
 496 #define IOACCEL1_IOFLAGS_CDBLEN_MASK    0x001F
 497 #define IOACCEL1_IOFLAGS_CDBLEN_MAX     16
 498
 499 #define IOACCEL1_CONTROL_NODATAXFER     0x00000000
 500 #define IOACCEL1_CONTROL_DATA_OUT       0x01000000
 501 #define IOACCEL1_CONTROL_DATA_IN        0x02000000
 502 #define IOACCEL1_CONTROL_TASKPRIO_MASK  0x00007800
 503 #define IOACCEL1_CONTROL_TASKPRIO_SHIFT 11
 504 #define IOACCEL1_CONTROL_SIMPLEQUEUE    0x00000000
 505 #define IOACCEL1_CONTROL_HEADOFQUEUE    0x00000100
 506 #define IOACCEL1_CONTROL_ORDEREDQUEUE   0x00000200
 507 #define IOACCEL1_CONTROL_ACA            0x00000400
 508
 509 #define IOACCEL1_HCFLAGS_CISS_FORMAT    0x0013
 510
 511 #define IOACCEL1_BUSADDR_CMDTYPE        0x00000060
 512
 513 struct ioaccel2_sg_element {
 514         __le64 address;
 515         __le32 length;
 516         u8 reserved[3];
 517         u8 chain_indicator;
 518 #define IOACCEL2_CHAIN 0x80
 519 };
 520
 521 /*
 522  * SCSI Response Format structure for IO Accelerator Mode 2
 523  */
 524 struct io_accel2_scsi_response {
 525         u8 IU_type;
 526 #define IOACCEL2_IU_TYPE_SRF                    0x60
 527         u8 reserved1[3];
 528         u8 req_id[4];           /* request identifier */
 529         u8 reserved2[4];
 530         u8 serv_response;               /* service response */
 531 #define IOACCEL2_SERV_RESPONSE_COMPLETE         0x000
 532 #define IOACCEL2_SERV_RESPONSE_FAILURE          0x001
 533 #define IOACCEL2_SERV_RESPONSE_TMF_COMPLETE     0x002
 534 #define IOACCEL2_SERV_RESPONSE_TMF_SUCCESS      0x003
 535 #define IOACCEL2_SERV_RESPONSE_TMF_REJECTED     0x004
 536 #define IOACCEL2_SERV_RESPONSE_TMF_WRONG_LUN    0x005
 537         u8 status;                      /* status */
 538 #define IOACCEL2_STATUS_SR_TASK_COMP_GOOD       0x00
 539 #define IOACCEL2_STATUS_SR_TASK_COMP_CHK_COND   0x02
 540 #define IOACCEL2_STATUS_SR_TASK_COMP_BUSY       0x08
 541 #define IOACCEL2_STATUS_SR_TASK_COMP_RES_CON    0x18
 542 #define IOACCEL2_STATUS_SR_TASK_COMP_SET_FULL   0x28
 543 #define IOACCEL2_STATUS_SR_TASK_COMP_ABORTED    0x40
 544 #define IOACCEL2_STATUS_SR_IOACCEL_DISABLED     0x0E
 545 #define IOACCEL2_STATUS_SR_IO_ERROR             0x01
 546 #define IOACCEL2_STATUS_SR_IO_ABORTED           0x02
 547 #define IOACCEL2_STATUS_SR_NO_PATH_TO_DEVICE    0x03
 548 #define IOACCEL2_STATUS_SR_INVALID_DEVICE       0x04
 549 #define IOACCEL2_STATUS_SR_UNDERRUN             0x51
 550 #define IOACCEL2_STATUS_SR_OVERRUN              0x75
 551         u8 data_present;                /* low 2 bits */
 552 #define IOACCEL2_NO_DATAPRESENT         0x000
 553 #define IOACCEL2_RESPONSE_DATAPRESENT   0x001
 554 #define IOACCEL2_SENSE_DATA_PRESENT     0x002
 555 #define IOACCEL2_RESERVED               0x003
 556         u8 sense_data_len;              /* sense/response data length */
 557         u8 resid_cnt[4];                /* residual count */
 558         u8 sense_data_buff[32];         /* sense/response data buffer */
 559 };
 560
 561 /*
 562  * Structure for I/O accelerator (mode 2 or m2) commands.
 563  * Note that this structure must be 128-byte aligned in size.
 564  */
 565 #define IOACCEL2_COMMANDLIST_ALIGNMENT 128
 566 struct io_accel2_cmd {
 567         u8  IU_type;                    /* IU Type */
 568         u8  direction;                  /* direction, memtype, and encryption */
 569 #define IOACCEL2_DIRECTION_MASK         0x03 /* bits 0,1: direction  */
 570 #define IOACCEL2_DIRECTION_MEMTYPE_MASK 0x04 /* bit 2: memtype source/dest */
 571                                              /*     0b=PCIe, 1b=DDR */
 572 #define IOACCEL2_DIRECTION_ENCRYPT_MASK 0x08 /* bit 3: encryption flag */
 573                                              /*     0=off, 1=on */
 574         u8  reply_queue;                /* Reply Queue ID */
 575         u8  reserved1;                  /* Reserved */
 576         __le32 scsi_nexus;              /* Device Handle */
 577         __le32 Tag;                     /* cciss tag, lower 4 bytes only */
 578         __le32 tweak_lower;             /* Encryption tweak, lower 4 bytes */
 579         u8  cdb[16];                    /* SCSI Command Descriptor Block */
 580         u8  cciss_lun[8];               /* 8 byte SCSI address */
 581         __le32 data_len;                /* Total bytes to transfer */
 582         u8  cmd_priority_task_attr;     /* priority and task attrs */
 583 #define IOACCEL2_PRIORITY_MASK 0x78
 584 #define IOACCEL2_ATTR_MASK 0x07
 585         u8  sg_count;                   /* Number of sg elements */
 586         __le16 dekindex;                /* Data encryption key index */
 587         __le64 err_ptr;                 /* Error Pointer */
 588         __le32 err_len;                 /* Error Length*/
 589         __le32 tweak_upper;             /* Encryption tweak, upper 4 bytes */
 590         struct ioaccel2_sg_element sg[IOACCEL2_MAXSGENTRIES];
 591         struct io_accel2_scsi_response error_data;
 592 } __aligned(IOACCEL2_COMMANDLIST_ALIGNMENT);
 593
 594 /*
 595  * defines for Mode 2 command struct
 596  * FIXME: this can't be all I need mfm
 597  */
 598 #define IOACCEL2_IU_TYPE        0x40
 599 #define IOACCEL2_IU_TMF_TYPE    0x41
 600 #define IOACCEL2_DIR_NO_DATA    0x00
 601 #define IOACCEL2_DIR_DATA_IN    0x01
 602 #define IOACCEL2_DIR_DATA_OUT   0x02
 603 #define IOACCEL2_TMF_ABORT      0x01
 604 /*
 605  * SCSI Task Management Request format for Accelerator Mode 2
 606  */
 607 struct hpsa_tmf_struct {
 608         u8 iu_type;             /* Information Unit Type */
 609         u8 reply_queue;         /* Reply Queue ID */
 610         u8 tmf;                 /* Task Management Function */
 611         u8 reserved1;           /* byte 3 Reserved */
 612         __le32 it_nexus;        /* SCSI I-T Nexus */
 613         u8 lun_id[8];           /* LUN ID for TMF request */
 614         __le64 tag;             /* cciss tag associated w/ request */
 615         __le64 abort_tag;       /* cciss tag of SCSI cmd or TMF to abort */
 616         __le64 error_ptr;               /* Error Pointer */
 617         __le32 error_len;               /* Error Length */
 618 } __aligned(IOACCEL2_COMMANDLIST_ALIGNMENT);
 619
 620 /* Configuration Table Structure */
 621 struct HostWrite {
 622         __le32          TransportRequest;
 623         __le32          command_pool_addr_hi;
 624         __le32          CoalIntDelay;
 625         __le32          CoalIntCount;
 626 };
 627
 628 #define SIMPLE_MODE     0x02
 629 #define PERFORMANT_MODE 0x04
 630 #define MEMQ_MODE       0x08
 631 #define IOACCEL_MODE_1  0x80
 632
 633 #define DRIVER_SUPPORT_UA_ENABLE        0x00000001
 634
 635 struct CfgTable {
 636         u8              Signature[4];
 637         __le32          SpecValence;
 638         __le32          TransportSupport;
 639         __le32          TransportActive;
 640         struct HostWrite HostWrite;
 641         __le32          CmdsOutMax;
 642         __le32          BusTypes;
 643         __le32          TransMethodOffset;
 644         u8              ServerName[16];
 645         __le32          HeartBeat;
 646         __le32          driver_support;
 647 #define                 ENABLE_SCSI_PREFETCH            0x100
 648 #define                 ENABLE_UNIT_ATTN                0x01
 649         __le32          MaxScatterGatherElements;
 650         __le32          MaxLogicalUnits;
 651         __le32          MaxPhysicalDevices;
 652         __le32          MaxPhysicalDrivesPerLogicalUnit;
 653         __le32          MaxPerformantModeCommands;
 654         __le32          MaxBlockFetch;
 655         __le32          PowerConservationSupport;
 656         __le32          PowerConservationEnable;
 657         __le32          TMFSupportFlags;
 658         u8              TMFTagMask[8];
 659         u8              reserved[0x78 - 0x70];
 660         __le32          misc_fw_support;                /* offset 0x78 */
 661 #define                 MISC_FW_DOORBELL_RESET          0x02
 662 #define                 MISC_FW_DOORBELL_RESET2         0x010
 663 #define                 MISC_FW_RAID_OFFLOAD_BASIC      0x020
 664 #define                 MISC_FW_EVENT_NOTIFY            0x080
 665         u8              driver_version[32];
 666         __le32          max_cached_write_size;
 667         u8              driver_scratchpad[16];
 668         __le32          max_error_info_length;
 669         __le32          io_accel_max_embedded_sg_count;
 670         __le32          io_accel_request_size_offset;
 671         __le32          event_notify;
 672 #define         HPSA_EVENT_NOTIFY_ACCEL_IO_PATH_STATE_CHANGE (1 << 30)
 673 #define         HPSA_EVENT_NOTIFY_ACCEL_IO_PATH_CONFIG_CHANGE (1 << 31)
 674         __le32          clear_event_notify;
 675 };
 676
 677 #define NUM_BLOCKFETCH_ENTRIES 8
 678 struct TransTable_struct {
 679         __le32          BlockFetch[NUM_BLOCKFETCH_ENTRIES];
 680         __le32          RepQSize;
 681         __le32          RepQCount;
 682         __le32          RepQCtrAddrLow32;
 683         __le32          RepQCtrAddrHigh32;
 684 #define MAX_REPLY_QUEUES 64
 685         struct vals32  RepQAddr[MAX_REPLY_QUEUES];
 686 };
 687
 688 struct hpsa_pci_info {
 689         unsigned char   bus;
 690         unsigned char   dev_fn;
 691         unsigned short  domain;
 692         u32             board_id;
 693 };
 694
 695 struct bmic_identify_controller {
 696         u8      configured_logical_drive_count; /* offset 0 */
 697         u8      pad1[153];
 698         __le16  extended_logical_unit_count;    /* offset 154 */
 699         u8      pad2[136];
 700         u8      controller_mode;        /* offset 292 */
 701         u8      pad3[32];
 702 };
 703
 704
 705 struct bmic_identify_physical_device {
 706         u8    scsi_bus;          /* SCSI Bus number on controller */
 707         u8    scsi_id;           /* SCSI ID on this bus */
 708         __le16 block_size;           /* sector size in bytes */
 709         __le32 total_blocks;         /* number for sectors on drive */
 710         __le32 reserved_blocks;   /* controller reserved (RIS) */
 711         u8    model[40];         /* Physical Drive Model */
 712         u8    serial_number[40]; /* Drive Serial Number */
 713         u8    firmware_revision[8]; /* drive firmware revision */
 714         u8    scsi_inquiry_bits; /* inquiry byte 7 bits */
 715         u8    compaq_drive_stamp; /* 0 means drive not stamped */
 716         u8    last_failure_reason;
 717 #define BMIC_LAST_FAILURE_TOO_SMALL_IN_LOAD_CONFIG              0x01
 718 #define BMIC_LAST_FAILURE_ERROR_ERASING_RIS                     0x02
 719 #define BMIC_LAST_FAILURE_ERROR_SAVING_RIS                      0x03
 720 #define BMIC_LAST_FAILURE_FAIL_DRIVE_COMMAND                    0x04
 721 #define BMIC_LAST_FAILURE_MARK_BAD_FAILED                       0x05
 722 #define BMIC_LAST_FAILURE_MARK_BAD_FAILED_IN_FINISH_REMAP       0x06
 723 #define BMIC_LAST_FAILURE_TIMEOUT                               0x07
 724 #define BMIC_LAST_FAILURE_AUTOSENSE_FAILED                      0x08
 725 #define BMIC_LAST_FAILURE_MEDIUM_ERROR_1                        0x09
 726 #define BMIC_LAST_FAILURE_MEDIUM_ERROR_2                        0x0a
 727 #define BMIC_LAST_FAILURE_NOT_READY_BAD_SENSE                   0x0b
 728 #define BMIC_LAST_FAILURE_NOT_READY                             0x0c
 729 #define BMIC_LAST_FAILURE_HARDWARE_ERROR                        0x0d
 730 #define BMIC_LAST_FAILURE_ABORTED_COMMAND                       0x0e
 731 #define BMIC_LAST_FAILURE_WRITE_PROTECTED                       0x0f
 732 #define BMIC_LAST_FAILURE_SPIN_UP_FAILURE_IN_RECOVER            0x10
 733 #define BMIC_LAST_FAILURE_REBUILD_WRITE_ERROR                   0x11
 734 #define BMIC_LAST_FAILURE_TOO_SMALL_IN_HOT_PLUG                 0x12
 735 #define BMIC_LAST_FAILURE_BUS_RESET_RECOVERY_ABORTED            0x13
 736 #define BMIC_LAST_FAILURE_REMOVED_IN_HOT_PLUG                   0x14
 737 #define BMIC_LAST_FAILURE_INIT_REQUEST_SENSE_FAILED             0x15
 738 #define BMIC_LAST_FAILURE_INIT_START_UNIT_FAILED                0x16
 739 #define BMIC_LAST_FAILURE_INQUIRY_FAILED                        0x17
 740 #define BMIC_LAST_FAILURE_NON_DISK_DEVICE                       0x18
 741 #define BMIC_LAST_FAILURE_READ_CAPACITY_FAILED                  0x19
 742 #define BMIC_LAST_FAILURE_INVALID_BLOCK_SIZE                    0x1a
 743 #define BMIC_LAST_FAILURE_HOT_PLUG_REQUEST_SENSE_FAILED         0x1b
 744 #define BMIC_LAST_FAILURE_HOT_PLUG_START_UNIT_FAILED            0x1c
 745 #define BMIC_LAST_FAILURE_WRITE_ERROR_AFTER_REMAP               0x1d
 746 #define BMIC_LAST_FAILURE_INIT_RESET_RECOVERY_ABORTED           0x1e
 747 #define BMIC_LAST_FAILURE_DEFERRED_WRITE_ERROR                  0x1f
 748 #define BMIC_LAST_FAILURE_MISSING_IN_SAVE_RIS                   0x20
 749 #define BMIC_LAST_FAILURE_WRONG_REPLACE                         0x21
 750 #define BMIC_LAST_FAILURE_GDP_VPD_INQUIRY_FAILED                0x22
 751 #define BMIC_LAST_FAILURE_GDP_MODE_SENSE_FAILED                 0x23
 752 #define BMIC_LAST_FAILURE_DRIVE_NOT_IN_48BIT_MODE               0x24
 753 #define BMIC_LAST_FAILURE_DRIVE_TYPE_MIX_IN_HOT_PLUG            0x25
 754 #define BMIC_LAST_FAILURE_DRIVE_TYPE_MIX_IN_LOAD_CFG            0x26
 755 #define BMIC_LAST_FAILURE_PROTOCOL_ADAPTER_FAILED               0x27
 756 #define BMIC_LAST_FAILURE_FAULTY_ID_BAY_EMPTY                   0x28
 757 #define BMIC_LAST_FAILURE_FAULTY_ID_BAY_OCCUPIED                0x29
 758 #define BMIC_LAST_FAILURE_FAULTY_ID_INVALID_BAY                 0x2a
 759 #define BMIC_LAST_FAILURE_WRITE_RETRIES_FAILED                  0x2b
 760
 761 #define BMIC_LAST_FAILURE_SMART_ERROR_REPORTED                  0x37
 762 #define BMIC_LAST_FAILURE_PHY_RESET_FAILED                      0x38
 763 #define BMIC_LAST_FAILURE_ONLY_ONE_CTLR_CAN_SEE_DRIVE           0x40
 764 #define BMIC_LAST_FAILURE_KC_VOLUME_FAILED                      0x41
 765 #define BMIC_LAST_FAILURE_UNEXPECTED_REPLACEMENT                0x42
 766 #define BMIC_LAST_FAILURE_OFFLINE_ERASE                         0x80
 767 #define BMIC_LAST_FAILURE_OFFLINE_TOO_SMALL                     0x81
 768 #define BMIC_LAST_FAILURE_OFFLINE_DRIVE_TYPE_MIX                0x82
 769 #define BMIC_LAST_FAILURE_OFFLINE_ERASE_COMPLETE                0x83
 770
 771         u8     flags;
 772         u8     more_flags;
 773         u8     scsi_lun;          /* SCSI LUN for phys drive */
 774         u8     yet_more_flags;
 775         u8     even_more_flags;
 776         __le32 spi_speed_rules;/* SPI Speed data:Ultra disable diagnose */
 777         u8     phys_connector[2];         /* connector number on controller */
 778         u8     phys_box_on_bus;  /* phys enclosure this drive resides */
 779         u8     phys_bay_in_box;  /* phys drv bay this drive resides */
 780         __le32 rpm;              /* Drive rotational speed in rpm */
 781         u8     device_type;       /* type of drive */
 782         u8     sata_version;     /* only valid when drive_type is SATA */
 783         __le64 big_total_block_count;
 784         __le64 ris_starting_lba;
 785         __le32 ris_size;
 786         u8     wwid[20];
 787         u8     controller_phy_map[32];
 788         __le16 phy_count;
 789         u8     phy_connected_dev_type[256];
 790         u8     phy_to_drive_bay_num[256];
 791         __le16 phy_to_attached_dev_index[256];
 792         u8     box_index;
 793         u8     reserved;
 794         __le16 extra_physical_drive_flags;
 795 #define BMIC_PHYS_DRIVE_SUPPORTS_GAS_GAUGE(idphydrv) \
 796         (idphydrv->extra_physical_drive_flags & (1 << 10))
 797         u8     negotiated_link_rate[256];
 798         u8     phy_to_phy_map[256];
 799         u8     redundant_path_present_map;
 800         u8     redundant_path_failure_map;
 801         u8     active_path_number;
 802         __le16 alternate_paths_phys_connector[8];
 803         u8     alternate_paths_phys_box_on_port[8];
 804         u8     multi_lun_device_lun_count;
 805         u8     minimum_good_fw_revision[8];
 806         u8     unique_inquiry_bytes[20];
 807         u8     current_temperature_degreesC;
 808         u8     temperature_threshold_degreesC;
 809         u8     max_temperature_degreesC;
 810         u8     logical_blocks_per_phys_block_exp; /* phyblocksize = 512*2^exp */
 811         __le16 current_queue_depth_limit;
 812         u8     reserved_switch_stuff[60];
 813         __le16 power_on_hours; /* valid only if gas gauge supported */
 814         __le16 percent_endurance_used; /* valid only if gas gauge supported. */
 815 #define BMIC_PHYS_DRIVE_SSD_WEAROUT(idphydrv) \
 816         ((idphydrv->percent_endurance_used & 0x80) || \
 817          (idphydrv->percent_endurance_used > 10000))
 818         u8     drive_authentication;
 819 #define BMIC_PHYS_DRIVE_AUTHENTICATED(idphydrv) \
 820         (idphydrv->drive_authentication == 0x80)
 821         u8     smart_carrier_authentication;
 822 #define BMIC_SMART_CARRIER_AUTHENTICATION_SUPPORTED(idphydrv) \
 823         (idphydrv->smart_carrier_authentication != 0x0)
 824 #define BMIC_SMART_CARRIER_AUTHENTICATED(idphydrv) \
 825         (idphydrv->smart_carrier_authentication == 0x01)
 826         u8     smart_carrier_app_fw_version;
 827         u8     smart_carrier_bootloader_fw_version;
 828         u8     sanitize_support_flags;
 829         u8     drive_key_flags;
 830         u8     encryption_key_name[64];
 831         __le32 misc_drive_flags;
 832         __le16 dek_index;
 833         __le16 hba_drive_encryption_flags;
 834         __le16 max_overwrite_time;
 835         __le16 max_block_erase_time;
 836         __le16 max_crypto_erase_time;
 837         u8     device_connector_info[5];
 838         u8     connector_name[8][8];
 839         u8     page_83_id[16];
 840         u8     max_link_rate[256];
 841         u8     neg_phys_link_rate[256];
 842         u8     box_conn_name[8];
 843 } __attribute((aligned(512)));
 844
 845 struct bmic_sense_subsystem_info {
 846         u8      primary_slot_number;
 847         u8      reserved[3];
 848         u8      chasis_serial_number[32];
 849         u8      primary_world_wide_id[8];
 850         u8      primary_array_serial_number[32]; /* NULL terminated */
 851         u8      primary_cache_serial_number[32]; /* NULL terminated */
 852         u8      reserved_2[8];
 853         u8      secondary_array_serial_number[32];
 854         u8      secondary_cache_serial_number[32];
 855         u8      pad[332];
 856 };
 857
 858 struct bmic_sense_storage_box_params {
 859         u8      reserved[36];
 860         u8      inquiry_valid;
 861         u8      reserved_1[68];
 862         u8      phys_box_on_port;
 863         u8      reserved_2[22];
 864         u16     connection_info;
 865         u8      reserver_3[84];
 866         u8      phys_connector[2];
 867         u8      reserved_4[296];
 868 };
 869
 870 #pragma pack()
 871 #endif /* HPSA_CMD_H */