173 lines · c
1/*2 * This header is BSD licensed so anyone can use the definitions to implement3 * compatible drivers/servers.4 *5 * Redistribution and use in source and binary forms, with or without6 * modification, are permitted provided that the following conditions7 * are met:8 * 1. Redistributions of source code must retain the above copyright9 * notice, this list of conditions and the following disclaimer.10 * 2. Redistributions in binary form must reproduce the above copyright11 * notice, this list of conditions and the following disclaimer in the12 * documentation and/or other materials provided with the distribution.13 *14 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE17 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF24 * SUCH DAMAGE.25 */26 27#ifndef _LINUX_VIRTIO_SCSI_H28#define _LINUX_VIRTIO_SCSI_H29 30#include <linux/virtio_types.h>31 32/* Default values of the CDB and sense data size configuration fields */33#define VIRTIO_SCSI_CDB_DEFAULT_SIZE 3234#define VIRTIO_SCSI_SENSE_DEFAULT_SIZE 9635 36#ifndef VIRTIO_SCSI_CDB_SIZE37#define VIRTIO_SCSI_CDB_SIZE VIRTIO_SCSI_CDB_DEFAULT_SIZE38#endif39#ifndef VIRTIO_SCSI_SENSE_SIZE40#define VIRTIO_SCSI_SENSE_SIZE VIRTIO_SCSI_SENSE_DEFAULT_SIZE41#endif42 43/* SCSI command request, followed by data-out */44struct virtio_scsi_cmd_req {45 __u8 lun[8]; /* Logical Unit Number */46 __virtio64 tag; /* Command identifier */47 __u8 task_attr; /* Task attribute */48 __u8 prio; /* SAM command priority field */49 __u8 crn;50 __u8 cdb[VIRTIO_SCSI_CDB_SIZE];51} __attribute__((packed));52 53/* SCSI command request, followed by protection information */54struct virtio_scsi_cmd_req_pi {55 __u8 lun[8]; /* Logical Unit Number */56 __virtio64 tag; /* Command identifier */57 __u8 task_attr; /* Task attribute */58 __u8 prio; /* SAM command priority field */59 __u8 crn;60 __virtio32 pi_bytesout; /* DataOUT PI Number of bytes */61 __virtio32 pi_bytesin; /* DataIN PI Number of bytes */62 __u8 cdb[VIRTIO_SCSI_CDB_SIZE];63} __attribute__((packed));64 65/* Response, followed by sense data and data-in */66struct virtio_scsi_cmd_resp {67 __virtio32 sense_len; /* Sense data length */68 __virtio32 resid; /* Residual bytes in data buffer */69 __virtio16 status_qualifier; /* Status qualifier */70 __u8 status; /* Command completion status */71 __u8 response; /* Response values */72 __u8 sense[VIRTIO_SCSI_SENSE_SIZE];73} __attribute__((packed));74 75/* Task Management Request */76struct virtio_scsi_ctrl_tmf_req {77 __virtio32 type;78 __virtio32 subtype;79 __u8 lun[8];80 __virtio64 tag;81} __attribute__((packed));82 83struct virtio_scsi_ctrl_tmf_resp {84 __u8 response;85} __attribute__((packed));86 87/* Asynchronous notification query/subscription */88struct virtio_scsi_ctrl_an_req {89 __virtio32 type;90 __u8 lun[8];91 __virtio32 event_requested;92} __attribute__((packed));93 94struct virtio_scsi_ctrl_an_resp {95 __virtio32 event_actual;96 __u8 response;97} __attribute__((packed));98 99struct virtio_scsi_event {100 __virtio32 event;101 __u8 lun[8];102 __virtio32 reason;103} __attribute__((packed));104 105struct virtio_scsi_config {106 __virtio32 num_queues;107 __virtio32 seg_max;108 __virtio32 max_sectors;109 __virtio32 cmd_per_lun;110 __virtio32 event_info_size;111 __virtio32 sense_size;112 __virtio32 cdb_size;113 __virtio16 max_channel;114 __virtio16 max_target;115 __virtio32 max_lun;116} __attribute__((packed));117 118/* Feature Bits */119#define VIRTIO_SCSI_F_INOUT 0120#define VIRTIO_SCSI_F_HOTPLUG 1121#define VIRTIO_SCSI_F_CHANGE 2122#define VIRTIO_SCSI_F_T10_PI 3123 124/* Response codes */125#define VIRTIO_SCSI_S_OK 0126#define VIRTIO_SCSI_S_OVERRUN 1127#define VIRTIO_SCSI_S_ABORTED 2128#define VIRTIO_SCSI_S_BAD_TARGET 3129#define VIRTIO_SCSI_S_RESET 4130#define VIRTIO_SCSI_S_BUSY 5131#define VIRTIO_SCSI_S_TRANSPORT_FAILURE 6132#define VIRTIO_SCSI_S_TARGET_FAILURE 7133#define VIRTIO_SCSI_S_NEXUS_FAILURE 8134#define VIRTIO_SCSI_S_FAILURE 9135#define VIRTIO_SCSI_S_FUNCTION_SUCCEEDED 10136#define VIRTIO_SCSI_S_FUNCTION_REJECTED 11137#define VIRTIO_SCSI_S_INCORRECT_LUN 12138 139/* Controlq type codes. */140#define VIRTIO_SCSI_T_TMF 0141#define VIRTIO_SCSI_T_AN_QUERY 1142#define VIRTIO_SCSI_T_AN_SUBSCRIBE 2143 144/* Valid TMF subtypes. */145#define VIRTIO_SCSI_T_TMF_ABORT_TASK 0146#define VIRTIO_SCSI_T_TMF_ABORT_TASK_SET 1147#define VIRTIO_SCSI_T_TMF_CLEAR_ACA 2148#define VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET 3149#define VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET 4150#define VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET 5151#define VIRTIO_SCSI_T_TMF_QUERY_TASK 6152#define VIRTIO_SCSI_T_TMF_QUERY_TASK_SET 7153 154/* Events. */155#define VIRTIO_SCSI_T_EVENTS_MISSED 0x80000000156#define VIRTIO_SCSI_T_NO_EVENT 0157#define VIRTIO_SCSI_T_TRANSPORT_RESET 1158#define VIRTIO_SCSI_T_ASYNC_NOTIFY 2159#define VIRTIO_SCSI_T_PARAM_CHANGE 3160 161/* Reasons of transport reset event */162#define VIRTIO_SCSI_EVT_RESET_HARD 0163#define VIRTIO_SCSI_EVT_RESET_RESCAN 1164#define VIRTIO_SCSI_EVT_RESET_REMOVED 2165 166#define VIRTIO_SCSI_S_SIMPLE 0167#define VIRTIO_SCSI_S_ORDERED 1168#define VIRTIO_SCSI_S_HEAD 2169#define VIRTIO_SCSI_S_ACA 3170 171 172#endif /* _LINUX_VIRTIO_SCSI_H */173