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