hw/scsi.h

   1 #ifndef QEMU_HW_SCSI_H
   2 #define QEMU_HW_SCSI_H
   3
   4 #include "qdev.h"
   5 #include "block.h"
   6 #include "block_int.h"
   7
   8 #define MAX_SCSI_DEVS   255
   9
  10 #define SCSI_CMD_BUF_SIZE     16
  11
  12 /* scsi-disk.c */
  13 enum scsi_reason {
  14     SCSI_REASON_DONE, /* Command complete.  */
  15     SCSI_REASON_DATA  /* Transfer complete, more data required.  */
  16 };
  17
  18 typedef struct SCSIBus SCSIBus;
  19 typedef struct SCSIBusOps SCSIBusOps;
  20 typedef struct SCSIDevice SCSIDevice;
  21 typedef struct SCSIDeviceInfo SCSIDeviceInfo;
  22 typedef struct SCSIRequest SCSIRequest;
  23
  24 enum SCSIXferMode {
  25     SCSI_XFER_NONE,      /*  TEST_UNIT_READY, ...            */
  26     SCSI_XFER_FROM_DEV,  /*  READ, INQUIRY, MODE_SENSE, ...  */
  27     SCSI_XFER_TO_DEV,    /*  WRITE, MODE_SELECT, ...         */
  28 };
  29
  30 typedef struct SCSISense {
  31     uint8_t key;
  32     uint8_t asc;
  33     uint8_t ascq;
  34 } SCSISense;
  35
  36 struct SCSIRequest {
  37     SCSIBus           *bus;
  38     SCSIDevice        *dev;
  39     uint32_t          refcount;
  40     uint32_t          tag;
  41     uint32_t          lun;
  42     uint32_t          status;
  43     struct {
  44         uint8_t buf[SCSI_CMD_BUF_SIZE];
  45         int len;
  46         size_t xfer;
  47         uint64_t lba;
  48         enum SCSIXferMode mode;
  49     } cmd;
  50     BlockDriverAIOCB  *aiocb;
  51     bool enqueued;
  52     QTAILQ_ENTRY(SCSIRequest) next;
  53 };
  54
  55 struct SCSIDevice
  56 {
  57     DeviceState qdev;
  58     uint32_t id;
  59     BlockConf conf;
  60     SCSIDeviceInfo *info;
  61     QTAILQ_HEAD(, SCSIRequest) requests;
  62     int blocksize;
  63     int type;
  64 };
  65
  66 /* cdrom.c */
  67 int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track);
  68 int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num);
  69
  70 /* scsi-bus.c */
  71 typedef int (*scsi_qdev_initfn)(SCSIDevice *dev);
  72 struct SCSIDeviceInfo {
  73     DeviceInfo qdev;
  74     scsi_qdev_initfn init;
  75     void (*destroy)(SCSIDevice *s);
  76     SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun);
  77     void (*free_req)(SCSIRequest *req);
  78     int32_t (*send_command)(SCSIRequest *req, uint8_t *buf);
  79     void (*read_data)(SCSIRequest *req);
  80     int (*write_data)(SCSIRequest *req);
  81     void (*cancel_io)(SCSIRequest *req);
  82     uint8_t *(*get_buf)(SCSIRequest *req);
  83 };
  84
  85 struct SCSIBusOps {
  86     void (*complete)(SCSIRequest *req, int reason, uint32_t arg);
  87     void (*cancel)(SCSIRequest *req);
  88 };
  89
  90 struct SCSIBus {
  91     BusState qbus;
  92     int busnr;
  93
  94     int tcq, ndev;
  95     const SCSIBusOps *ops;
  96
  97     SCSIDevice *devs[MAX_SCSI_DEVS];
  98 };
  99
 100 void scsi_bus_new(SCSIBus *bus, DeviceState *host, int tcq, int ndev,
 101                   const SCSIBusOps *ops);
 102 void scsi_qdev_register(SCSIDeviceInfo *info);
 103
 104 static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d)
 105 {
 106     return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
 107 }
 108
 109 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
 110                                       int unit, bool removable);
 111 int scsi_bus_legacy_handle_cmdline(SCSIBus *bus);
 112
 113 /*
 114  * Predefined sense codes
 115  */
 116
 117 /* No sense data available */
 118 extern const struct SCSISense sense_code_NO_SENSE;
 119 /* LUN not ready, Manual intervention required */
 120 extern const struct SCSISense sense_code_LUN_NOT_READY;
 121 /* LUN not ready, Medium not present */
 122 extern const struct SCSISense sense_code_NO_MEDIUM;
 123 /* Hardware error, internal target failure */
 124 extern const struct SCSISense sense_code_TARGET_FAILURE;
 125 /* Illegal request, invalid command operation code */
 126 extern const struct SCSISense sense_code_INVALID_OPCODE;
 127 /* Illegal request, LBA out of range */
 128 extern const struct SCSISense sense_code_LBA_OUT_OF_RANGE;
 129 /* Illegal request, Invalid field in CDB */
 130 extern const struct SCSISense sense_code_INVALID_FIELD;
 131 /* Illegal request, LUN not supported */
 132 extern const struct SCSISense sense_code_LUN_NOT_SUPPORTED;
 133 /* Command aborted, I/O process terminated */
 134 extern const struct SCSISense sense_code_IO_ERROR;
 135 /* Command aborted, I_T Nexus loss occurred */
 136 extern const struct SCSISense sense_code_I_T_NEXUS_LOSS;
 137 /* Command aborted, Logical Unit failure */
 138 extern const struct SCSISense sense_code_LUN_FAILURE;
 139
 140 #define SENSE_CODE(x) sense_code_ ## x
 141
 142 int scsi_build_sense(SCSISense sense, uint8_t *buf, int len, int fixed);
 143 int scsi_sense_valid(SCSISense sense);
 144
 145 SCSIRequest *scsi_req_alloc(size_t size, SCSIDevice *d, uint32_t tag, uint32_t lun);
 146 void scsi_req_enqueue(SCSIRequest *req);
 147 void scsi_req_free(SCSIRequest *req);
 148 SCSIRequest *scsi_req_ref(SCSIRequest *req);
 149 void scsi_req_unref(SCSIRequest *req);
 150
 151 int scsi_req_parse(SCSIRequest *req, uint8_t *buf);
 152 void scsi_req_print(SCSIRequest *req);
 153 void scsi_req_data(SCSIRequest *req, int len);
 154 void scsi_req_complete(SCSIRequest *req);
 155 void scsi_req_abort(SCSIRequest *req, int status);
 156 void scsi_req_cancel(SCSIRequest *req);
 157 void scsi_device_purge_requests(SCSIDevice *sdev);
 158
 159 #endif