hw/scsi/vmw_pvscsi.h

4  * Copyright (C) 2008-2009, VMware, Inc. All Rights Reserved.
7  * under the terms of the GNU General Public License as published by the
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
30 #define MASK(n)        ((1 << (n)) - 1)        /* make an n-bit mask */
35 enum HostBusAdapterStatus {
72 enum PVSCSIRegOffset {
91 enum PVSCSICommands {
108 #define PVSCSI_COMMAND_PROCESSING_FAILED     (-1)
109 #define PVSCSI_COMMAND_NOT_ENOUGH_DATA       (-2)
112  * Command descriptor for PVSCSI_CMD_RESET_DEVICE --
123  * Command descriptor for PVSCSI_CMD_ABORT_CMD --
125  * - currently does not support specifying the LUN.
126  * - pad should be 0.
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
159  * Command descriptor for PVSCSI_CMD_SETUP_MSG_RING --
162  * - this command was not supported in the initial revision of the h/w
166  *       * a value of -1 means that the cmd is NOT supported,
167  *       * a value != -1 means that the cmd IS supported.
170  * - this command should be issued _after_ the usual SETUP_RINGS so that the
172  * - numPages needs to be a power of two,
173  * - numPages needs to be different from 0,
174  * - pad should be zero.
187 enum PVSCSIMsgType {
198  * - type is of type enum PVSCSIMsgType.
199  * - the content of args depend on the type of event being delivered.
222  * - the fields:
227  * - 'pad' helps to ensure that the msg related fields are on their own
228  *   cache-line.
254  * - context: is a unique identifier of a command. It could normally be any
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.
262  * - dataAddr:
268  * - flags:
275  * - vcpuHint: vcpuId of the processor that will be most likely waiting for the
277  *   delivery mode (such as windows), we use this "hint" to deliver the
279  *   the processor that initiated the i/o as a likely candidate for the vcpu
281  * - bus should be 0: we currently only support bus 0 for now.
282  * - unused should be zero'd.
304     uint32_t    flags;  member
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:
336     uint32_t    flags;  member
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.
381  * Number of MSI-X vectors supported.
386  * Enumeration of supported MSI-X vectors
416 enum PVSCSIMemSpace {