LXR linux/include/linux/virtio

   1/*
   2 * This header is BSD licensed so anyone can use the definitions to implement
   3 * compatible drivers/servers.
   4 *
   5 * Redistribution and use in source and binary forms, with or without
   6 * modification, are permitted provided that the following conditions
   7 * are met:
   8 * 1. Redistributions of source code must retain the above copyright
   9 *    notice, this list of conditions and the following disclaimer.
  10 * 2. Redistributions in binary form must reproduce the above copyright
  11 *    notice, this list of conditions and the following disclaimer in the
  12 *    documentation and/or other materials provided with the distribution.
  13 *
  14 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 * SUCH DAMAGE.
  25 */
  26
  27#ifndef _LINUX_VIRTIO_SCSI_H
  28#define _LINUX_VIRTIO_SCSI_H
  29
  30#define VIRTIO_SCSI_CDB_SIZE   32
  31#define VIRTIO_SCSI_SENSE_SIZE 96
  32
  33/* SCSI command request, followed by data-out */
  34struct virtio_scsi_cmd_req {
  35        u8 lun[8];              /* Logical Unit Number */
  36        u64 tag;                /* Command identifier */
  37        u8 task_attr;           /* Task attribute */
  38        u8 prio;
  39        u8 crn;
  40        u8 cdb[VIRTIO_SCSI_CDB_SIZE];
  41} __packed;
  42
  43/* Response, followed by sense data and data-in */
  44struct virtio_scsi_cmd_resp {
  45        u32 sense_len;          /* Sense data length */
  46        u32 resid;              /* Residual bytes in data buffer */
  47        u16 status_qualifier;   /* Status qualifier */
  48        u8 status;              /* Command completion status */
  49        u8 response;            /* Response values */
  50        u8 sense[VIRTIO_SCSI_SENSE_SIZE];
  51} __packed;
  52
  53/* Task Management Request */
  54struct virtio_scsi_ctrl_tmf_req {
  55        u32 type;
  56        u32 subtype;
  57        u8 lun[8];
  58        u64 tag;
  59} __packed;
  60
  61struct virtio_scsi_ctrl_tmf_resp {
  62        u8 response;
  63} __packed;
  64
  65/* Asynchronous notification query/subscription */
  66struct virtio_scsi_ctrl_an_req {
  67        u32 type;
  68        u8 lun[8];
  69        u32 event_requested;
  70} __packed;
  71
  72struct virtio_scsi_ctrl_an_resp {
  73        u32 event_actual;
  74        u8 response;
  75} __packed;
  76
  77struct virtio_scsi_event {
  78        u32 event;
  79        u8 lun[8];
  80        u32 reason;
  81} __packed;
  82
  83struct virtio_scsi_config {
  84        u32 num_queues;
  85        u32 seg_max;
  86        u32 max_sectors;
  87        u32 cmd_per_lun;
  88        u32 event_info_size;
  89        u32 sense_size;
  90        u32 cdb_size;
  91        u16 max_channel;
  92        u16 max_target;
  93        u32 max_lun;
  94} __packed;
  95
  96/* Feature Bits */
  97#define VIRTIO_SCSI_F_INOUT                    0
  98#define VIRTIO_SCSI_F_HOTPLUG                  1
  99#define VIRTIO_SCSI_F_CHANGE                   2
 100
 101/* Response codes */
 102#define VIRTIO_SCSI_S_OK                       0
 103#define VIRTIO_SCSI_S_OVERRUN                  1
 104#define VIRTIO_SCSI_S_ABORTED                  2
 105#define VIRTIO_SCSI_S_BAD_TARGET               3
 106#define VIRTIO_SCSI_S_RESET                    4
 107#define VIRTIO_SCSI_S_BUSY                     5
 108#define VIRTIO_SCSI_S_TRANSPORT_FAILURE        6
 109#define VIRTIO_SCSI_S_TARGET_FAILURE           7
 110#define VIRTIO_SCSI_S_NEXUS_FAILURE            8
 111#define VIRTIO_SCSI_S_FAILURE                  9
 112#define VIRTIO_SCSI_S_FUNCTION_SUCCEEDED       10
 113#define VIRTIO_SCSI_S_FUNCTION_REJECTED        11
 114#define VIRTIO_SCSI_S_INCORRECT_LUN            12
 115
 116/* Controlq type codes.  */
 117#define VIRTIO_SCSI_T_TMF                      0
 118#define VIRTIO_SCSI_T_AN_QUERY                 1
 119#define VIRTIO_SCSI_T_AN_SUBSCRIBE             2
 120
 121/* Valid TMF subtypes.  */
 122#define VIRTIO_SCSI_T_TMF_ABORT_TASK           0
 123#define VIRTIO_SCSI_T_TMF_ABORT_TASK_SET       1
 124#define VIRTIO_SCSI_T_TMF_CLEAR_ACA            2
 125#define VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET       3
 126#define VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET      4
 127#define VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET   5
 128#define VIRTIO_SCSI_T_TMF_QUERY_TASK           6
 129#define VIRTIO_SCSI_T_TMF_QUERY_TASK_SET       7
 130
 131/* Events.  */
 132#define VIRTIO_SCSI_T_EVENTS_MISSED            0x80000000
 133#define VIRTIO_SCSI_T_NO_EVENT                 0
 134#define VIRTIO_SCSI_T_TRANSPORT_RESET          1
 135#define VIRTIO_SCSI_T_ASYNC_NOTIFY             2
 136#define VIRTIO_SCSI_T_PARAM_CHANGE             3
 137
 138/* Reasons of transport reset event */
 139#define VIRTIO_SCSI_EVT_RESET_HARD             0
 140#define VIRTIO_SCSI_EVT_RESET_RESCAN           1
 141#define VIRTIO_SCSI_EVT_RESET_REMOVED          2
 142
 143#define VIRTIO_SCSI_S_SIMPLE                   0
 144#define VIRTIO_SCSI_S_ORDERED                  1
 145#define VIRTIO_SCSI_S_HEAD                     2
 146#define VIRTIO_SCSI_S_ACA                      3
 147
 148
 149#endif /* _LINUX_VIRTIO_SCSI_H */
 150