2
* VMware PVSCSI header file
4
* Copyright (C) 2008-2009, VMware, Inc. All Rights Reserved.
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.
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
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.
20
* Maintained by: Arvind Kumar <arvindkumar@vmware.com>
27
#define VMW_PAGE_SIZE (4096)
28
#define VMW_PAGE_SHIFT (12)
30
#define MASK(n) ((1 << (n)) - 1) /* make an n-bit mask */
33
* host adapter status/error codes
35
enum HostBusAdapterStatus {
36
BTSTAT_SUCCESS = 0x00, /* CCB complete normally with no errors */
37
BTSTAT_LINKED_COMMAND_COMPLETED = 0x0a,
38
BTSTAT_LINKED_COMMAND_COMPLETED_WITH_FLAG = 0x0b,
39
BTSTAT_DATA_UNDERRUN = 0x0c,
40
BTSTAT_SELTIMEO = 0x11, /* SCSI selection timeout */
41
BTSTAT_DATARUN = 0x12, /* data overrun/underrun */
42
BTSTAT_BUSFREE = 0x13, /* unexpected bus free */
43
BTSTAT_INVPHASE = 0x14, /* invalid bus phase or sequence */
44
/* requested by target */
45
BTSTAT_LUNMISMATCH = 0x17, /* linked CCB has different LUN */
47
BTSTAT_SENSFAILED = 0x1b, /* auto request sense failed */
48
BTSTAT_TAGREJECT = 0x1c, /* SCSI II tagged queueing message */
49
/* rejected by target */
50
BTSTAT_BADMSG = 0x1d, /* unsupported message received by */
51
/* the host adapter */
52
BTSTAT_HAHARDWARE = 0x20, /* host adapter hardware failed */
53
BTSTAT_NORESPONSE = 0x21, /* target did not respond to SCSI ATN, */
55
BTSTAT_SENTRST = 0x22, /* host adapter asserted a SCSI RST */
56
BTSTAT_RECVRST = 0x23, /* other SCSI devices asserted a SCSI RST */
57
BTSTAT_DISCONNECT = 0x24, /* target device reconnected improperly */
59
BTSTAT_BUSRESET = 0x25, /* host adapter issued BUS device reset */
60
BTSTAT_ABORTQUEUE = 0x26, /* abort queue generated */
61
BTSTAT_HASOFTWARE = 0x27, /* host adapter software error */
62
BTSTAT_HATIMEOUT = 0x30, /* host adapter hardware timeout error */
63
BTSTAT_SCSIPARITY = 0x34, /* SCSI parity error detected */
69
* These registers are accessible both via i/o space and mm i/o.
72
enum PVSCSIRegOffset {
73
PVSCSI_REG_OFFSET_COMMAND = 0x0,
74
PVSCSI_REG_OFFSET_COMMAND_DATA = 0x4,
75
PVSCSI_REG_OFFSET_COMMAND_STATUS = 0x8,
76
PVSCSI_REG_OFFSET_LAST_STS_0 = 0x100,
77
PVSCSI_REG_OFFSET_LAST_STS_1 = 0x104,
78
PVSCSI_REG_OFFSET_LAST_STS_2 = 0x108,
79
PVSCSI_REG_OFFSET_LAST_STS_3 = 0x10c,
80
PVSCSI_REG_OFFSET_INTR_STATUS = 0x100c,
81
PVSCSI_REG_OFFSET_INTR_MASK = 0x2010,
82
PVSCSI_REG_OFFSET_KICK_NON_RW_IO = 0x3014,
83
PVSCSI_REG_OFFSET_DEBUG = 0x3018,
84
PVSCSI_REG_OFFSET_KICK_RW_IO = 0x4018,
88
* Virtual h/w commands.
92
PVSCSI_CMD_FIRST = 0, /* has to be first */
94
PVSCSI_CMD_ADAPTER_RESET = 1,
95
PVSCSI_CMD_ISSUE_SCSI = 2,
96
PVSCSI_CMD_SETUP_RINGS = 3,
97
PVSCSI_CMD_RESET_BUS = 4,
98
PVSCSI_CMD_RESET_DEVICE = 5,
99
PVSCSI_CMD_ABORT_CMD = 6,
100
PVSCSI_CMD_CONFIG = 7,
101
PVSCSI_CMD_SETUP_MSG_RING = 8,
102
PVSCSI_CMD_DEVICE_UNPLUG = 9,
104
PVSCSI_CMD_LAST = 10 /* has to be last */
107
#define PVSCSI_COMMAND_PROCESSING_SUCCEEDED (0)
108
#define PVSCSI_COMMAND_PROCESSING_FAILED (-1)
109
#define PVSCSI_COMMAND_NOT_ENOUGH_DATA (-2)
112
* Command descriptor for PVSCSI_CMD_RESET_DEVICE --
115
struct PVSCSICmdDescResetDevice {
120
typedef struct PVSCSICmdDescResetDevice PVSCSICmdDescResetDevice;
123
* Command descriptor for PVSCSI_CMD_ABORT_CMD --
125
* - currently does not support specifying the LUN.
129
struct PVSCSICmdDescAbortCmd {
135
typedef struct PVSCSICmdDescAbortCmd PVSCSICmdDescAbortCmd;
138
* Command descriptor for PVSCSI_CMD_SETUP_RINGS --
141
* - reqRingNumPages and cmpRingNumPages need to be power of two.
142
* - reqRingNumPages and cmpRingNumPages need to be different from 0,
143
* - reqRingNumPages and cmpRingNumPages need to be inferior to
144
* PVSCSI_SETUP_RINGS_MAX_NUM_PAGES.
147
#define PVSCSI_SETUP_RINGS_MAX_NUM_PAGES 32
148
struct PVSCSICmdDescSetupRings {
149
uint32_t reqRingNumPages;
150
uint32_t cmpRingNumPages;
151
uint64_t ringsStatePPN;
152
uint64_t reqRingPPNs[PVSCSI_SETUP_RINGS_MAX_NUM_PAGES];
153
uint64_t cmpRingPPNs[PVSCSI_SETUP_RINGS_MAX_NUM_PAGES];
156
typedef struct PVSCSICmdDescSetupRings PVSCSICmdDescSetupRings;
159
* Command descriptor for PVSCSI_CMD_SETUP_MSG_RING --
162
* - this command was not supported in the initial revision of the h/w
163
* interface. Before using it, you need to check that it is supported by
164
* writing PVSCSI_CMD_SETUP_MSG_RING to the 'command' register, then
165
* immediately after read the 'command status' register:
166
* * a value of -1 means that the cmd is NOT supported,
167
* * a value != -1 means that the cmd IS supported.
168
* If it's supported the 'command status' register should return:
169
* sizeof(PVSCSICmdDescSetupMsgRing) / sizeof(uint32_t).
170
* - this command should be issued _after_ the usual SETUP_RINGS so that the
171
* RingsState page is already setup. If not, the command is a nop.
172
* - numPages needs to be a power of two,
173
* - numPages needs to be different from 0,
174
* - pad should be zero.
177
#define PVSCSI_SETUP_MSG_RING_MAX_NUM_PAGES 16
179
struct PVSCSICmdDescSetupMsgRing {
182
uint64_t ringPPNs[PVSCSI_SETUP_MSG_RING_MAX_NUM_PAGES];
185
typedef struct PVSCSICmdDescSetupMsgRing PVSCSICmdDescSetupMsgRing;
188
PVSCSI_MSG_DEV_ADDED = 0,
189
PVSCSI_MSG_DEV_REMOVED = 1,
196
* sizeof(struct PVSCSIRingMsgDesc) == 128.
198
* - type is of type enum PVSCSIMsgType.
199
* - the content of args depend on the type of event being delivered.
202
struct PVSCSIRingMsgDesc {
207
typedef struct PVSCSIRingMsgDesc PVSCSIRingMsgDesc;
209
struct PVSCSIMsgDescDevStatusChanged {
210
uint32_t type; /* PVSCSI_MSG_DEV _ADDED / _REMOVED */
217
typedef struct PVSCSIMsgDescDevStatusChanged PVSCSIMsgDescDevStatusChanged;
225
* . msgNumEntriesLog2,
226
* .. are only used once the SETUP_MSG_RING cmd has been issued.
227
* - 'pad' helps to ensure that the msg related fields are on their own
231
struct PVSCSIRingsState {
234
uint32_t reqNumEntriesLog2;
238
uint32_t cmpNumEntriesLog2;
244
uint32_t msgNumEntriesLog2;
247
typedef struct PVSCSIRingsState PVSCSIRingsState;
250
* Request descriptor.
252
* sizeof(RingReqDesc) = 128
254
* - context: is a unique identifier of a command. It could normally be any
255
* 64bit value, however we currently store it in the serialNumber variable
256
* of struct SCSI_Command, so we have the following restrictions due to the
257
* way this field is handled in the vmkernel storage stack:
258
* * this value can't be 0,
259
* * the upper 32bit need to be 0 since serialNumber is as a uint32_t.
260
* Currently tracked as PR 292060.
261
* - dataLen: contains the total number of bytes that need to be transferred.
263
* * if PVSCSI_FLAG_CMD_WITH_SG_LIST is set: dataAddr is the PA of the first
264
* s/g table segment, each s/g segment is entirely contained on a single
265
* page of physical memory,
266
* * if PVSCSI_FLAG_CMD_WITH_SG_LIST is NOT set, then dataAddr is the PA of
267
* the buffer used for the DMA transfer,
269
* * PVSCSI_FLAG_CMD_WITH_SG_LIST: see dataAddr above,
270
* * PVSCSI_FLAG_CMD_DIR_NONE: no DMA involved,
271
* * PVSCSI_FLAG_CMD_DIR_TOHOST: transfer from device to main memory,
272
* * PVSCSI_FLAG_CMD_DIR_TODEVICE: transfer from main memory to device,
273
* * PVSCSI_FLAG_CMD_OUT_OF_BAND_CDB: reserved to handle CDBs larger than
274
* 16bytes. To be specified.
275
* - vcpuHint: vcpuId of the processor that will be most likely waiting for the
276
* completion of the i/o. For guest OSes that use lowest priority message
277
* delivery mode (such as windows), we use this "hint" to deliver the
278
* completion action to the proper vcpu. For now, we can use the vcpuId of
279
* the processor that initiated the i/o as a likely candidate for the vcpu
280
* that will be waiting for the completion..
281
* - bus should be 0: we currently only support bus 0 for now.
282
* - unused should be zero'd.
285
#define PVSCSI_FLAG_CMD_WITH_SG_LIST (1 << 0)
286
#define PVSCSI_FLAG_CMD_OUT_OF_BAND_CDB (1 << 1)
287
#define PVSCSI_FLAG_CMD_DIR_NONE (1 << 2)
288
#define PVSCSI_FLAG_CMD_DIR_TOHOST (1 << 3)
289
#define PVSCSI_FLAG_CMD_DIR_TODEVICE (1 << 4)
291
#define PVSCSI_KNOWN_FLAGS \
292
(PVSCSI_FLAG_CMD_WITH_SG_LIST | \
293
PVSCSI_FLAG_CMD_OUT_OF_BAND_CDB | \
294
PVSCSI_FLAG_CMD_DIR_NONE | \
295
PVSCSI_FLAG_CMD_DIR_TOHOST | \
296
PVSCSI_FLAG_CMD_DIR_TODEVICE)
298
struct PVSCSIRingReqDesc {
315
typedef struct PVSCSIRingReqDesc PVSCSIRingReqDesc;
318
* Scatter-gather list management.
320
* As described above, when PVSCSI_FLAG_CMD_WITH_SG_LIST is set in the
321
* RingReqDesc.flags, then RingReqDesc.dataAddr is the PA of the first s/g
324
* - each segment of the s/g table contain a succession of struct
326
* - each segment is entirely contained on a single physical page of memory.
327
* - a "chain" s/g element has the flag PVSCSI_SGE_FLAG_CHAIN_ELEMENT set in
328
* PVSCSISGElement.flags and in this case:
329
* * addr is the PA of the next s/g segment,
330
* * length is undefined, assumed to be 0.
333
struct PVSCSISGElement {
339
typedef struct PVSCSISGElement PVSCSISGElement;
342
* Completion descriptor.
344
* sizeof(RingCmpDesc) = 32
346
* - context: identifier of the command. The same thing that was specified
347
* under "context" as part of struct RingReqDesc at initiation time,
348
* - dataLen: number of bytes transferred for the actual i/o operation,
349
* - senseLen: number of bytes written into the sense buffer,
350
* - hostStatus: adapter status,
351
* - scsiStatus: device status,
352
* - pad should be zero.
355
struct PVSCSIRingCmpDesc {
364
typedef struct PVSCSIRingCmpDesc PVSCSIRingCmpDesc;
367
* Interrupt status / IRQ bits.
370
#define PVSCSI_INTR_CMPL_0 (1 << 0)
371
#define PVSCSI_INTR_CMPL_1 (1 << 1)
372
#define PVSCSI_INTR_CMPL_MASK MASK(2)
374
#define PVSCSI_INTR_MSG_0 (1 << 2)
375
#define PVSCSI_INTR_MSG_1 (1 << 3)
376
#define PVSCSI_INTR_MSG_MASK (MASK(2) << 2)
378
#define PVSCSI_INTR_ALL_SUPPORTED MASK(4)
381
* Number of MSI-X vectors supported.
383
#define PVSCSI_MAX_INTRS 24
386
* Enumeration of supported MSI-X vectors
388
#define PVSCSI_VECTOR_COMPLETION 0
391
* Misc constants for the rings.
394
#define PVSCSI_MAX_NUM_PAGES_REQ_RING PVSCSI_SETUP_RINGS_MAX_NUM_PAGES
395
#define PVSCSI_MAX_NUM_PAGES_CMP_RING PVSCSI_SETUP_RINGS_MAX_NUM_PAGES
396
#define PVSCSI_MAX_NUM_PAGES_MSG_RING PVSCSI_SETUP_MSG_RING_MAX_NUM_PAGES
398
#define PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE \
399
(VMW_PAGE_SIZE / sizeof(struct PVSCSIRingReqDesc))
401
#define PVSCSI_MAX_NUM_CMP_ENTRIES_PER_PAGE \
402
(VMW_PAGE_SIZE / sizeof(PVSCSIRingCmpDesc))
404
#define PVSCSI_MAX_NUM_MSG_ENTRIES_PER_PAGE \
405
(VMW_PAGE_SIZE / sizeof(PVSCSIRingMsgDesc))
407
#define PVSCSI_MAX_REQ_QUEUE_DEPTH \
408
(PVSCSI_MAX_NUM_PAGES_REQ_RING * PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE)
410
#define PVSCSI_MEM_SPACE_COMMAND_NUM_PAGES 1
411
#define PVSCSI_MEM_SPACE_INTR_STATUS_NUM_PAGES 1
412
#define PVSCSI_MEM_SPACE_MISC_NUM_PAGES 2
413
#define PVSCSI_MEM_SPACE_KICK_IO_NUM_PAGES 2
414
#define PVSCSI_MEM_SPACE_MSIX_NUM_PAGES 2
416
enum PVSCSIMemSpace {
417
PVSCSI_MEM_SPACE_COMMAND_PAGE = 0,
418
PVSCSI_MEM_SPACE_INTR_STATUS_PAGE = 1,
419
PVSCSI_MEM_SPACE_MISC_PAGE = 2,
420
PVSCSI_MEM_SPACE_KICK_IO_PAGE = 4,
421
PVSCSI_MEM_SPACE_MSIX_TABLE_PAGE = 6,
422
PVSCSI_MEM_SPACE_MSIX_PBA_PAGE = 7,
425
#define PVSCSI_MEM_SPACE_NUM_PAGES \
426
(PVSCSI_MEM_SPACE_COMMAND_NUM_PAGES + \
427
PVSCSI_MEM_SPACE_INTR_STATUS_NUM_PAGES + \
428
PVSCSI_MEM_SPACE_MISC_NUM_PAGES + \
429
PVSCSI_MEM_SPACE_KICK_IO_NUM_PAGES + \
430
PVSCSI_MEM_SPACE_MSIX_NUM_PAGES)
432
#define PVSCSI_MEM_SPACE_SIZE (PVSCSI_MEM_SPACE_NUM_PAGES * VMW_PAGE_SIZE)
434
#endif /* VMW_PVSCSI_H */