hw/scsi/vmw_pvscsi.h

4  * Copyright (C) 2008-2009, VMware, Inc. All Rights Reserved.
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 */
33  * host adapter status/error codes
51                                  /* the host adapter                */
52    BTSTAT_HAHARDWARE    = 0x20,  /* host adapter hardware failed */
55    BTSTAT_SENTRST       = 0x22,  /* host adapter asserted a SCSI RST */
59    BTSTAT_BUSRESET      = 0x25,  /* host adapter issued BUS device reset */
61    BTSTAT_HASOFTWARE    = 0x27,  /* host adapter software error */
62    BTSTAT_HATIMEOUT     = 0x30,  /* host adapter hardware timeout error */
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
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:
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.
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
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
281  * - bus should be 0: we currently only support bus 0 for now.
282  * - unused should be zero'd.
318  * Scatter-gather list management.
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
346  * - context: identifier of the command. The same thing that was specified
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