drivers/scsi/vmw_pvscsi.h

   1 /*
   2  * VMware PVSCSI header file
   3  *
   4  * Copyright (C) 2008-2014, VMware, Inc. All Rights Reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; version 2 of the License and no later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  13  * NON INFRINGEMENT.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Maintained by: Arvind Kumar <arvindkumar@vmware.com>
  21  *
  22  */
  23
  24 #ifndef _VMW_PVSCSI_H_
  25 #define _VMW_PVSCSI_H_
  26
  27 #include <linux/types.h>
  28
  29 #define PVSCSI_DRIVER_VERSION_STRING   "1.0.5.0-k"
  30
  31 #define PVSCSI_MAX_NUM_SG_ENTRIES_PER_SEGMENT 128
  32
  33 #define MASK(n)        ((1 << (n)) - 1)        /* make an n-bit mask */
  34
  35 #define PCI_VENDOR_ID_VMWARE            0x15AD
  36 #define PCI_DEVICE_ID_VMWARE_PVSCSI     0x07C0
  37
  38 /*
  39  * host adapter status/error codes
  40  */
  41 enum HostBusAdapterStatus {
  42         BTSTAT_SUCCESS       = 0x00,  /* CCB complete normally with no errors */
  43         BTSTAT_LINKED_COMMAND_COMPLETED           = 0x0a,
  44         BTSTAT_LINKED_COMMAND_COMPLETED_WITH_FLAG = 0x0b,
  45         BTSTAT_DATA_UNDERRUN = 0x0c,
  46         BTSTAT_SELTIMEO      = 0x11,  /* SCSI selection timeout */
  47         BTSTAT_DATARUN       = 0x12,  /* data overrun/underrun */
  48         BTSTAT_BUSFREE       = 0x13,  /* unexpected bus free */
  49         BTSTAT_INVPHASE      = 0x14,  /* invalid bus phase or sequence
  50                                        * requested by target */
  51         BTSTAT_LUNMISMATCH   = 0x17,  /* linked CCB has different LUN from
  52                                        * first CCB */
  53         BTSTAT_INVPARAM      = 0x1a,  /* invalid parameter in CCB or segment
  54                                        * list */
  55         BTSTAT_SENSFAILED    = 0x1b,  /* auto request sense failed */
  56         BTSTAT_TAGREJECT     = 0x1c,  /* SCSI II tagged queueing message
  57                                        * rejected by target */
  58         BTSTAT_BADMSG        = 0x1d,  /* unsupported message received by the
  59                                        * host adapter */
  60         BTSTAT_HAHARDWARE    = 0x20,  /* host adapter hardware failed */
  61         BTSTAT_NORESPONSE    = 0x21,  /* target did not respond to SCSI ATN,
  62                                        * sent a SCSI RST */
  63         BTSTAT_SENTRST       = 0x22,  /* host adapter asserted a SCSI RST */
  64         BTSTAT_RECVRST       = 0x23,  /* other SCSI devices asserted a SCSI
  65                                        * RST */
  66         BTSTAT_DISCONNECT    = 0x24,  /* target device reconnected improperly
  67                                        * (w/o tag) */
  68         BTSTAT_BUSRESET      = 0x25,  /* host adapter issued BUS device reset */
  69         BTSTAT_ABORTQUEUE    = 0x26,  /* abort queue generated */
  70         BTSTAT_HASOFTWARE    = 0x27,  /* host adapter software error */
  71         BTSTAT_HATIMEOUT     = 0x30,  /* host adapter hardware timeout error */
  72         BTSTAT_SCSIPARITY    = 0x34,  /* SCSI parity error detected */
  73 };
  74
  75 /*
  76  * SCSI device status values.
  77  */
  78 enum ScsiDeviceStatus {
  79         SDSTAT_GOOD  = 0x00, /* No errors. */
  80         SDSTAT_CHECK = 0x02, /* Check condition. */
  81 };
  82
  83 /*
  84  * Register offsets.
  85  *
  86  * These registers are accessible both via i/o space and mm i/o.
  87  */
  88
  89 enum PVSCSIRegOffset {
  90         PVSCSI_REG_OFFSET_COMMAND        =    0x0,
  91         PVSCSI_REG_OFFSET_COMMAND_DATA   =    0x4,
  92         PVSCSI_REG_OFFSET_COMMAND_STATUS =    0x8,
  93         PVSCSI_REG_OFFSET_LAST_STS_0     =  0x100,
  94         PVSCSI_REG_OFFSET_LAST_STS_1     =  0x104,
  95         PVSCSI_REG_OFFSET_LAST_STS_2     =  0x108,
  96         PVSCSI_REG_OFFSET_LAST_STS_3     =  0x10c,
  97         PVSCSI_REG_OFFSET_INTR_STATUS    = 0x100c,
  98         PVSCSI_REG_OFFSET_INTR_MASK      = 0x2010,
  99         PVSCSI_REG_OFFSET_KICK_NON_RW_IO = 0x3014,
 100         PVSCSI_REG_OFFSET_DEBUG          = 0x3018,
 101         PVSCSI_REG_OFFSET_KICK_RW_IO     = 0x4018,
 102 };
 103
 104 /*
 105  * Virtual h/w commands.
 106  */
 107
 108 enum PVSCSICommands {
 109         PVSCSI_CMD_FIRST             = 0, /* has to be first */
 110
 111         PVSCSI_CMD_ADAPTER_RESET     = 1,
 112         PVSCSI_CMD_ISSUE_SCSI        = 2,
 113         PVSCSI_CMD_SETUP_RINGS       = 3,
 114         PVSCSI_CMD_RESET_BUS         = 4,
 115         PVSCSI_CMD_RESET_DEVICE      = 5,
 116         PVSCSI_CMD_ABORT_CMD         = 6,
 117         PVSCSI_CMD_CONFIG            = 7,
 118         PVSCSI_CMD_SETUP_MSG_RING    = 8,
 119         PVSCSI_CMD_DEVICE_UNPLUG     = 9,
 120         PVSCSI_CMD_SETUP_REQCALLTHRESHOLD     = 10,
 121
 122         PVSCSI_CMD_LAST              = 11  /* has to be last */
 123 };
 124
 125 /*
 126  * Command descriptor for PVSCSI_CMD_RESET_DEVICE --
 127  */
 128
 129 struct PVSCSICmdDescResetDevice {
 130         u32     target;
 131         u8      lun[8];
 132 } __packed;
 133
 134 /*
 135  * Command descriptor for PVSCSI_CMD_CONFIG --
 136  */
 137
 138 struct PVSCSICmdDescConfigCmd {
 139         u64 cmpAddr;
 140         u64 configPageAddress;
 141         u32 configPageNum;
 142         u32 _pad;
 143 } __packed;
 144
 145 /*
 146  * Command descriptor for PVSCSI_CMD_SETUP_REQCALLTHRESHOLD --
 147  */
 148
 149 struct PVSCSICmdDescSetupReqCall {
 150         u32 enable;
 151 } __packed;
 152
 153 enum PVSCSIConfigPageType {
 154         PVSCSI_CONFIG_PAGE_CONTROLLER = 0x1958,
 155         PVSCSI_CONFIG_PAGE_PHY        = 0x1959,
 156         PVSCSI_CONFIG_PAGE_DEVICE     = 0x195a,
 157 };
 158
 159 enum PVSCSIConfigPageAddressType {
 160         PVSCSI_CONFIG_CONTROLLER_ADDRESS = 0x2120,
 161         PVSCSI_CONFIG_BUSTARGET_ADDRESS  = 0x2121,
 162         PVSCSI_CONFIG_PHY_ADDRESS        = 0x2122,
 163 };
 164
 165 /*
 166  * Command descriptor for PVSCSI_CMD_ABORT_CMD --
 167  *
 168  * - currently does not support specifying the LUN.
 169  * - _pad should be 0.
 170  */
 171
 172 struct PVSCSICmdDescAbortCmd {
 173         u64     context;
 174         u32     target;
 175         u32     _pad;
 176 } __packed;
 177
 178 /*
 179  * Command descriptor for PVSCSI_CMD_SETUP_RINGS --
 180  *
 181  * Notes:
 182  * - reqRingNumPages and cmpRingNumPages need to be power of two.
 183  * - reqRingNumPages and cmpRingNumPages need to be different from 0,
 184  * - reqRingNumPages and cmpRingNumPages need to be inferior to
 185  *   PVSCSI_SETUP_RINGS_MAX_NUM_PAGES.
 186  */
 187
 188 #define PVSCSI_SETUP_RINGS_MAX_NUM_PAGES        32
 189 struct PVSCSICmdDescSetupRings {
 190         u32     reqRingNumPages;
 191         u32     cmpRingNumPages;
 192         u64     ringsStatePPN;
 193         u64     reqRingPPNs[PVSCSI_SETUP_RINGS_MAX_NUM_PAGES];
 194         u64     cmpRingPPNs[PVSCSI_SETUP_RINGS_MAX_NUM_PAGES];
 195 } __packed;
 196
 197 /*
 198  * Command descriptor for PVSCSI_CMD_SETUP_MSG_RING --
 199  *
 200  * Notes:
 201  * - this command was not supported in the initial revision of the h/w
 202  *   interface. Before using it, you need to check that it is supported by
 203  *   writing PVSCSI_CMD_SETUP_MSG_RING to the 'command' register, then
 204  *   immediately after read the 'command status' register:
 205  *       * a value of -1 means that the cmd is NOT supported,
 206  *       * a value != -1 means that the cmd IS supported.
 207  *   If it's supported the 'command status' register should return:
 208  *      sizeof(PVSCSICmdDescSetupMsgRing) / sizeof(u32).
 209  * - this command should be issued _after_ the usual SETUP_RINGS so that the
 210  *   RingsState page is already setup. If not, the command is a nop.
 211  * - numPages needs to be a power of two,
 212  * - numPages needs to be different from 0,
 213  * - _pad should be zero.
 214  */
 215
 216 #define PVSCSI_SETUP_MSG_RING_MAX_NUM_PAGES  16
 217
 218 struct PVSCSICmdDescSetupMsgRing {
 219         u32     numPages;
 220         u32     _pad;
 221         u64     ringPPNs[PVSCSI_SETUP_MSG_RING_MAX_NUM_PAGES];
 222 } __packed;
 223
 224 enum PVSCSIMsgType {
 225         PVSCSI_MSG_DEV_ADDED          = 0,
 226         PVSCSI_MSG_DEV_REMOVED        = 1,
 227         PVSCSI_MSG_LAST               = 2,
 228 };
 229
 230 /*
 231  * Msg descriptor.
 232  *
 233  * sizeof(struct PVSCSIRingMsgDesc) == 128.
 234  *
 235  * - type is of type enum PVSCSIMsgType.
 236  * - the content of args depend on the type of event being delivered.
 237  */
 238
 239 struct PVSCSIRingMsgDesc {
 240         u32     type;
 241         u32     args[31];
 242 } __packed;
 243
 244 struct PVSCSIMsgDescDevStatusChanged {
 245         u32     type;  /* PVSCSI_MSG_DEV _ADDED / _REMOVED */
 246         u32     bus;
 247         u32     target;
 248         u8      lun[8];
 249         u32     pad[27];
 250 } __packed;
 251
 252 /*
 253  * Rings state.
 254  *
 255  * - the fields:
 256  *    . msgProdIdx,
 257  *    . msgConsIdx,
 258  *    . msgNumEntriesLog2,
 259  *   .. are only used once the SETUP_MSG_RING cmd has been issued.
 260  * - '_pad' helps to ensure that the msg related fields are on their own
 261  *   cache-line.
 262  */
 263
 264 struct PVSCSIRingsState {
 265         u32     reqProdIdx;
 266         u32     reqConsIdx;
 267         u32     reqNumEntriesLog2;
 268
 269         u32     cmpProdIdx;
 270         u32     cmpConsIdx;
 271         u32     cmpNumEntriesLog2;
 272
 273         u32     reqCallThreshold;
 274
 275         u8      _pad[100];
 276
 277         u32     msgProdIdx;
 278         u32     msgConsIdx;
 279         u32     msgNumEntriesLog2;
 280 } __packed;
 281
 282 /*
 283  * Request descriptor.
 284  *
 285  * sizeof(RingReqDesc) = 128
 286  *
 287  * - context: is a unique identifier of a command. It could normally be any
 288  *   64bit value, however we currently store it in the serialNumber variable
 289  *   of struct SCSI_Command, so we have the following restrictions due to the
 290  *   way this field is handled in the vmkernel storage stack:
 291  *    * this value can't be 0,
 292  *    * the upper 32bit need to be 0 since serialNumber is as a u32.
 293  *   Currently tracked as PR 292060.
 294  * - dataLen: contains the total number of bytes that need to be transferred.
 295  * - dataAddr:
 296  *   * if PVSCSI_FLAG_CMD_WITH_SG_LIST is set: dataAddr is the PA of the first
 297  *     s/g table segment, each s/g segment is entirely contained on a single
 298  *     page of physical memory,
 299  *   * if PVSCSI_FLAG_CMD_WITH_SG_LIST is NOT set, then dataAddr is the PA of
 300  *     the buffer used for the DMA transfer,
 301  * - flags:
 302  *   * PVSCSI_FLAG_CMD_WITH_SG_LIST: see dataAddr above,
 303  *   * PVSCSI_FLAG_CMD_DIR_NONE: no DMA involved,
 304  *   * PVSCSI_FLAG_CMD_DIR_TOHOST: transfer from device to main memory,
 305  *   * PVSCSI_FLAG_CMD_DIR_TODEVICE: transfer from main memory to device,
 306  *   * PVSCSI_FLAG_CMD_OUT_OF_BAND_CDB: reserved to handle CDBs larger than
 307  *     16bytes. To be specified.
 308  * - vcpuHint: vcpuId of the processor that will be most likely waiting for the
 309  *   completion of the i/o. For guest OSes that use lowest priority message
 310  *   delivery mode (such as windows), we use this "hint" to deliver the
 311  *   completion action to the proper vcpu. For now, we can use the vcpuId of
 312  *   the processor that initiated the i/o as a likely candidate for the vcpu
 313  *   that will be waiting for the completion..
 314  * - bus should be 0: we currently only support bus 0 for now.
 315  * - unused should be zero'd.
 316  */
 317
 318 #define PVSCSI_FLAG_CMD_WITH_SG_LIST        (1 << 0)
 319 #define PVSCSI_FLAG_CMD_OUT_OF_BAND_CDB     (1 << 1)
 320 #define PVSCSI_FLAG_CMD_DIR_NONE            (1 << 2)
 321 #define PVSCSI_FLAG_CMD_DIR_TOHOST          (1 << 3)
 322 #define PVSCSI_FLAG_CMD_DIR_TODEVICE        (1 << 4)
 323
 324 struct PVSCSIRingReqDesc {
 325         u64     context;
 326         u64     dataAddr;
 327         u64     dataLen;
 328         u64     senseAddr;
 329         u32     senseLen;
 330         u32     flags;
 331         u8      cdb[16];
 332         u8      cdbLen;
 333         u8      lun[8];
 334         u8      tag;
 335         u8      bus;
 336         u8      target;
 337         u8      vcpuHint;
 338         u8      unused[59];
 339 } __packed;
 340
 341 /*
 342  * Scatter-gather list management.
 343  *
 344  * As described above, when PVSCSI_FLAG_CMD_WITH_SG_LIST is set in the
 345  * RingReqDesc.flags, then RingReqDesc.dataAddr is the PA of the first s/g
 346  * table segment.
 347  *
 348  * - each segment of the s/g table contain a succession of struct
 349  *   PVSCSISGElement.
 350  * - each segment is entirely contained on a single physical page of memory.
 351  * - a "chain" s/g element has the flag PVSCSI_SGE_FLAG_CHAIN_ELEMENT set in
 352  *   PVSCSISGElement.flags and in this case:
 353  *     * addr is the PA of the next s/g segment,
 354  *     * length is undefined, assumed to be 0.
 355  */
 356
 357 struct PVSCSISGElement {
 358         u64     addr;
 359         u32     length;
 360         u32     flags;
 361 } __packed;
 362
 363 /*
 364  * Completion descriptor.
 365  *
 366  * sizeof(RingCmpDesc) = 32
 367  *
 368  * - context: identifier of the command. The same thing that was specified
 369  *   under "context" as part of struct RingReqDesc at initiation time,
 370  * - dataLen: number of bytes transferred for the actual i/o operation,
 371  * - senseLen: number of bytes written into the sense buffer,
 372  * - hostStatus: adapter status,
 373  * - scsiStatus: device status,
 374  * - _pad should be zero.
 375  */
 376
 377 struct PVSCSIRingCmpDesc {
 378         u64     context;
 379         u64     dataLen;
 380         u32     senseLen;
 381         u16     hostStatus;
 382         u16     scsiStatus;
 383         u32     _pad[2];
 384 } __packed;
 385
 386 struct PVSCSIConfigPageHeader {
 387         u32 pageNum;
 388         u16 numDwords;
 389         u16 hostStatus;
 390         u16 scsiStatus;
 391         u16 reserved[3];
 392 } __packed;
 393
 394 struct PVSCSIConfigPageController {
 395         struct PVSCSIConfigPageHeader header;
 396         u64 nodeWWN; /* Device name as defined in the SAS spec. */
 397         u16 manufacturer[64];
 398         u16 serialNumber[64];
 399         u16 opromVersion[32];
 400         u16 hwVersion[32];
 401         u16 firmwareVersion[32];
 402         u32 numPhys;
 403         u8  useConsecutivePhyWWNs;
 404         u8  reserved[3];
 405 } __packed;
 406
 407 /*
 408  * Interrupt status / IRQ bits.
 409  */
 410
 411 #define PVSCSI_INTR_CMPL_0                 (1 << 0)
 412 #define PVSCSI_INTR_CMPL_1                 (1 << 1)
 413 #define PVSCSI_INTR_CMPL_MASK              MASK(2)
 414
 415 #define PVSCSI_INTR_MSG_0                  (1 << 2)
 416 #define PVSCSI_INTR_MSG_1                  (1 << 3)
 417 #define PVSCSI_INTR_MSG_MASK               (MASK(2) << 2)
 418
 419 #define PVSCSI_INTR_ALL_SUPPORTED          MASK(4)
 420
 421 /*
 422  * Number of MSI-X vectors supported.
 423  */
 424 #define PVSCSI_MAX_INTRS        24
 425
 426 /*
 427  * Enumeration of supported MSI-X vectors
 428  */
 429 #define PVSCSI_VECTOR_COMPLETION   0
 430
 431 /*
 432  * Misc constants for the rings.
 433  */
 434
 435 #define PVSCSI_MAX_NUM_PAGES_REQ_RING   PVSCSI_SETUP_RINGS_MAX_NUM_PAGES
 436 #define PVSCSI_MAX_NUM_PAGES_CMP_RING   PVSCSI_SETUP_RINGS_MAX_NUM_PAGES
 437 #define PVSCSI_MAX_NUM_PAGES_MSG_RING   PVSCSI_SETUP_MSG_RING_MAX_NUM_PAGES
 438
 439 #define PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE \
 440                                 (PAGE_SIZE / sizeof(struct PVSCSIRingReqDesc))
 441
 442 #define PVSCSI_MAX_REQ_QUEUE_DEPTH \
 443         (PVSCSI_MAX_NUM_PAGES_REQ_RING * PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE)
 444
 445 #define PVSCSI_MEM_SPACE_COMMAND_NUM_PAGES     1
 446 #define PVSCSI_MEM_SPACE_INTR_STATUS_NUM_PAGES 1
 447 #define PVSCSI_MEM_SPACE_MISC_NUM_PAGES        2
 448 #define PVSCSI_MEM_SPACE_KICK_IO_NUM_PAGES     2
 449 #define PVSCSI_MEM_SPACE_MSIX_NUM_PAGES        2
 450
 451 enum PVSCSIMemSpace {
 452         PVSCSI_MEM_SPACE_COMMAND_PAGE           = 0,
 453         PVSCSI_MEM_SPACE_INTR_STATUS_PAGE       = 1,
 454         PVSCSI_MEM_SPACE_MISC_PAGE              = 2,
 455         PVSCSI_MEM_SPACE_KICK_IO_PAGE           = 4,
 456         PVSCSI_MEM_SPACE_MSIX_TABLE_PAGE        = 6,
 457         PVSCSI_MEM_SPACE_MSIX_PBA_PAGE          = 7,
 458 };
 459
 460 #define PVSCSI_MEM_SPACE_NUM_PAGES \
 461         (PVSCSI_MEM_SPACE_COMMAND_NUM_PAGES +       \
 462          PVSCSI_MEM_SPACE_INTR_STATUS_NUM_PAGES +   \
 463          PVSCSI_MEM_SPACE_MISC_NUM_PAGES +          \
 464          PVSCSI_MEM_SPACE_KICK_IO_NUM_PAGES +       \
 465          PVSCSI_MEM_SPACE_MSIX_NUM_PAGES)
 466
 467 #define PVSCSI_MEM_SPACE_SIZE        (PVSCSI_MEM_SPACE_NUM_PAGES * PAGE_SIZE)
 468
 469 #endif /* _VMW_PVSCSI_H_ */