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