]> git.proxmox.com Git - mirror_qemu.git/blame - include/hw/scsi/scsi.h
projects / mirror_qemu.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
hw: Deprecate -drive if=scsi with non-onboard HBAs
[mirror_qemu.git] / include / hw / scsi / scsi.h
CommitLineData
1e37607b
GH		 1#ifndef QEMU_HW_SCSI_H
2#define QEMU_HW_SCSI_H
43b443b6 3
83c9f4ca 4#include "hw/qdev.h"
0d09e41a 5#include "hw/block/block.h"
9c17d615 6#include "sysemu/sysemu.h"
8e0a9320 7#include "qemu/notify.h"
43b443b6 8
27d6bf40
MA		 9#define MAX_SCSI_DEVS 255
10
6959e508
JL		 11#define SCSI_CMD_BUF_SIZE 16
12#define SCSI_SENSE_LEN 18
13#define SCSI_SENSE_LEN_SCANNER 32
14#define SCSI_INQUIRY_LEN 36
29362ebe 15
43b443b6 16typedef struct SCSIBus SCSIBus;
afd4030c 17typedef struct SCSIBusInfo SCSIBusInfo;
2599aece 18typedef struct SCSICommand SCSICommand;
43b443b6 19typedef struct SCSIDevice SCSIDevice;
5c6c0e51 20typedef struct SCSIRequest SCSIRequest;
8dbd4574 21typedef struct SCSIReqOps SCSIReqOps;
43b443b6 22
97a06435
GH		 23enum SCSIXferMode {
24 SCSI_XFER_NONE, /* TEST_UNIT_READY, ... */
25 SCSI_XFER_FROM_DEV, /* READ, INQUIRY, MODE_SENSE, ... */
26 SCSI_XFER_TO_DEV, /* WRITE, MODE_SELECT, ... */
27};
28
a1f0cce2
HR		 29typedef struct SCSISense {
30 uint8_t key;
31 uint8_t asc;
32 uint8_t ascq;
33} SCSISense;
34
2e323f03 35#define SCSI_SENSE_BUF_SIZE_OLD 96
c5f52875 36#define SCSI_SENSE_BUF_SIZE 252
b45ef674 37
2599aece
PB		 38struct SCSICommand {
39 uint8_t buf[SCSI_CMD_BUF_SIZE];
40 int len;
41 size_t xfer;
42 uint64_t lba;
43 enum SCSIXferMode mode;
44};
45
5c6c0e51 46struct SCSIRequest {
4c41d2ef
GH		 47 SCSIBus *bus;
48 SCSIDevice *dev;
adcf2754 49 const SCSIReqOps *ops;
ad2d30f7 50 uint32_t refcount;
4c41d2ef 51 uint32_t tag;
89b08ae1 52 uint32_t lun;
ed3a34a3 53 uint32_t status;
61e68b3f 54 void *hba_private;
01e95455 55 size_t resid;
2599aece 56 SCSICommand cmd;
8e0a9320 57 NotifierList cancel_notifiers;
61e68b3f
FZ		 58
59 /* Note:
60 * - fields before sense are initialized by scsi_req_alloc;
61 * - sense[] is uninitialized;
62 * - fields after sense are memset to 0 by scsi_req_alloc.
63 * */
64
65 uint8_t sense[SCSI_SENSE_BUF_SIZE];
66 uint32_t sense_len;
67 bool enqueued;
68 bool io_canceled;
69 bool retry;
70 bool dma_started;
7c84b1b8 71 BlockAIOCB *aiocb;
3d5aba97 72 QEMUSGList *sg;
9af99d98 73 QTAILQ_ENTRY(SCSIRequest) next;
5c6c0e51 74};
4c41d2ef 75
b9eea3e6
AL		 76#define TYPE_SCSI_DEVICE "scsi-device"
77#define SCSI_DEVICE(obj) \
78 OBJECT_CHECK(SCSIDevice, (obj), TYPE_SCSI_DEVICE)
79#define SCSI_DEVICE_CLASS(klass) \
80 OBJECT_CLASS_CHECK(SCSIDeviceClass, (klass), TYPE_SCSI_DEVICE)
81#define SCSI_DEVICE_GET_CLASS(obj) \
82 OBJECT_GET_CLASS(SCSIDeviceClass, (obj), TYPE_SCSI_DEVICE)
83
84typedef struct SCSIDeviceClass {
85 DeviceClass parent_class;
a818a4b6 86 void (*realize)(SCSIDevice *dev, Error **errp);
ff34c32c
PB		 87 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
88 void *hba_private);
b9eea3e6
AL		 89 SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun,
90 uint8_t *buf, void *hba_private);
91 void (*unit_attention_reported)(SCSIDevice *s);
92} SCSIDeviceClass;
93
43b443b6
GH		 94struct SCSIDevice
95{
96 DeviceState qdev;
71544d30
PB		 97 VMChangeStateEntry *vmsentry;
98 QEMUBH *bh;
43b443b6 99 uint32_t id;
428c149b 100 BlockConf conf;
6dc06f08 101 SCSISense unit_attention;
3653d8c4 102 bool sense_is_ua;
b45ef674
PB		 103 uint8_t sense[SCSI_SENSE_BUF_SIZE];
104 uint32_t sense_len;
9af99d98 105 QTAILQ_HEAD(, SCSIRequest) requests;
0d3545e7 106 uint32_t channel;
87dcd1b2 107 uint32_t lun;
b07995e3 108 int blocksize;
91376656 109 int type;
7877903a 110 uint64_t max_lba;
2ecab408
PB		 111 uint64_t wwn;
112 uint64_t port_wwn;
43b443b6
GH		 113};
114
63f740dd
PB		 115extern const VMStateDescription vmstate_scsi_device;
116
117#define VMSTATE_SCSI_DEVICE(_field, _state) { \
118 .name = (stringify(_field)), \
119 .size = sizeof(SCSIDevice), \
120 .vmsd = &vmstate_scsi_device, \
121 .flags = VMS_STRUCT, \
122 .offset = vmstate_offset_value(_state, _field, SCSIDevice), \
123}
124
43b443b6
GH		 125/* cdrom.c */
126int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track);
127int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num);
128
129/* scsi-bus.c */
8dbd4574
PB		 130struct SCSIReqOps {
131 size_t size;
12010e7b
PB		 132 void (*free_req)(SCSIRequest *req);
133 int32_t (*send_command)(SCSIRequest *req, uint8_t *buf);
134 void (*read_data)(SCSIRequest *req);
135 void (*write_data)(SCSIRequest *req);
12010e7b 136 uint8_t *(*get_buf)(SCSIRequest *req);
63f740dd
PB		 137
138 void (*save_request)(QEMUFile *f, SCSIRequest *req);
139 void (*load_request)(QEMUFile *f, SCSIRequest *req);
8dbd4574
PB		 140};
141
afd4030c 142struct SCSIBusInfo {
7e0380b9 143 int tcq;
0d3545e7 144 int max_channel, max_target, max_lun;
ff34c32c
PB		 145 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
146 void *hba_private);
c6df7102 147 void (*transfer_data)(SCSIRequest *req, uint32_t arg);
01e95455 148 void (*complete)(SCSIRequest *req, uint32_t arg, size_t resid);
94d3f98a 149 void (*cancel)(SCSIRequest *req);
53200fad 150 void (*change)(SCSIBus *bus, SCSIDevice *dev, SCSISense sense);
3d5aba97 151 QEMUSGList *(*get_sg_list)(SCSIRequest *req);
63f740dd
PB		 152
153 void (*save_request)(QEMUFile *f, SCSIRequest *req);
154 void *(*load_request)(QEMUFile *f, SCSIRequest *req);
8e86b93c 155 void (*free_request)(SCSIBus *bus, void *priv);
cfdc1bb0
PB		 156};
157
0d936928
AL		 158#define TYPE_SCSI_BUS "SCSI"
159#define SCSI_BUS(obj) OBJECT_CHECK(SCSIBus, (obj), TYPE_SCSI_BUS)
160
43b443b6
GH		 161struct SCSIBus {
162 BusState qbus;
163 int busnr;
164
6dc06f08 165 SCSISense unit_attention;
afd4030c 166 const SCSIBusInfo *info;
43b443b6
GH		 167};
168
b1187b51
AF		 169void scsi_bus_new(SCSIBus *bus, size_t bus_size, DeviceState *host,
170 const SCSIBusInfo *info, const char *bus_name);
43b443b6
GH		 171
172static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d)
173{
174 return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
175}
176
4be74634 177SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockBackend *blk,
76534da7 178 int unit, bool removable, int bootindex,
caad4eb3 179 const char *serial, Error **errp);
a64aa578 180void scsi_bus_legacy_handle_cmdline(SCSIBus *bus, bool deprecated);
fb8b660e 181void scsi_legacy_handle_cmdline(void);
43b443b6 182
a1f0cce2
HR		 183/*
184 * Predefined sense codes
185 */
186
187/* No sense data available */
188extern const struct SCSISense sense_code_NO_SENSE;
189/* LUN not ready, Manual intervention required */
190extern const struct SCSISense sense_code_LUN_NOT_READY;
191/* LUN not ready, Medium not present */
192extern const struct SCSISense sense_code_NO_MEDIUM;
68bb01f3
MA		 193/* LUN not ready, medium removal prevented */
194extern const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED;
a1f0cce2
HR		 195/* Hardware error, internal target failure */
196extern const struct SCSISense sense_code_TARGET_FAILURE;
197/* Illegal request, invalid command operation code */
198extern const struct SCSISense sense_code_INVALID_OPCODE;
199/* Illegal request, LBA out of range */
200extern const struct SCSISense sense_code_LBA_OUT_OF_RANGE;
201/* Illegal request, Invalid field in CDB */
202extern const struct SCSISense sense_code_INVALID_FIELD;
380feaff
PB		 203/* Illegal request, Invalid field in parameter list */
204extern const struct SCSISense sense_code_INVALID_PARAM;
205/* Illegal request, Parameter list length error */
206extern const struct SCSISense sense_code_INVALID_PARAM_LEN;
a1f0cce2
HR		 207/* Illegal request, LUN not supported */
208extern const struct SCSISense sense_code_LUN_NOT_SUPPORTED;
a872a304
PB		 209/* Illegal request, Saving parameters not supported */
210extern const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED;
211/* Illegal request, Incompatible format */
212extern const struct SCSISense sense_code_INCOMPATIBLE_FORMAT;
68bb01f3
MA		 213/* Illegal request, medium removal prevented */
214extern const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED;
9ec557bd
HG		 215/* Illegal request, Invalid Transfer Tag */
216extern const struct SCSISense sense_code_INVALID_TAG;
a1f0cce2
HR		 217/* Command aborted, I/O process terminated */
218extern const struct SCSISense sense_code_IO_ERROR;
219/* Command aborted, I_T Nexus loss occurred */
220extern const struct SCSISense sense_code_I_T_NEXUS_LOSS;
221/* Command aborted, Logical Unit failure */
222extern const struct SCSISense sense_code_LUN_FAILURE;
9ec557bd
HG		 223/* Command aborted, Overlapped Commands Attempted */
224extern const struct SCSISense sense_code_OVERLAPPED_COMMANDS;
aaebacef
PB		 225/* LUN not ready, Capacity data has changed */
226extern const struct SCSISense sense_code_CAPACITY_CHANGED;
8a9c16f6
PB		 227/* LUN not ready, Medium not present */
228extern const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM;
a872a304
PB		 229/* Unit attention, Power on, reset or bus device reset occurred */
230extern const struct SCSISense sense_code_RESET;
231/* Unit attention, Medium may have changed*/
232extern const struct SCSISense sense_code_MEDIUM_CHANGED;
233/* Unit attention, Reported LUNs data has changed */
234extern const struct SCSISense sense_code_REPORTED_LUNS_CHANGED;
235/* Unit attention, Device internal reset */
236extern const struct SCSISense sense_code_DEVICE_INTERNAL_RESET;
6a8a685c
RS		 237/* Data Protection, Write Protected */
238extern const struct SCSISense sense_code_WRITE_PROTECTED;
703dd81a
PB		 239/* Data Protection, Space Allocation Failed Write Protect */
240extern const struct SCSISense sense_code_SPACE_ALLOC_FAILED;
a1f0cce2
HR		 241
242#define SENSE_CODE(x) sense_code_ ## x
243
1894df02
HR		 244uint32_t scsi_data_cdb_xfer(uint8_t *buf);
245uint32_t scsi_cdb_xfer(uint8_t *buf);
246int scsi_cdb_length(uint8_t *buf);
f3b338ef
PB		 247int scsi_build_sense(uint8_t *in_buf, int in_len,
248 uint8_t *buf, int len, bool fixed);
a1f0cce2 249
adcf2754
PB		 250SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
251 uint32_t tag, uint32_t lun, void *hba_private);
c5bf71a9 252SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
c39ce112
PB		 253 uint8_t *buf, void *hba_private);
254int32_t scsi_req_enqueue(SCSIRequest *req);
ad2d30f7
PB		 255SCSIRequest *scsi_req_ref(SCSIRequest *req);
256void scsi_req_unref(SCSIRequest *req);
37659e51 257
ff34c32c
PB		 258int scsi_bus_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
259 void *hba_private);
3e7e180a 260int scsi_req_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf);
b45ef674 261void scsi_req_build_sense(SCSIRequest *req, SCSISense sense);
ec766865 262void scsi_req_print(SCSIRequest *req);
ad3376cc 263void scsi_req_continue(SCSIRequest *req);
ab9adc88 264void scsi_req_data(SCSIRequest *req, int len);
682a9b21 265void scsi_req_complete(SCSIRequest *req, int status);
0c34459b 266uint8_t *scsi_req_get_buf(SCSIRequest *req);
74382217 267int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len);
d5776465 268void scsi_req_cancel_complete(SCSIRequest *req);
94d3f98a 269void scsi_req_cancel(SCSIRequest *req);
8e0a9320 270void scsi_req_cancel_async(SCSIRequest *req, Notifier *notifier);
71544d30 271void scsi_req_retry(SCSIRequest *req);
c7b48872 272void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense);
e48e84ea 273void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense);
53200fad 274void scsi_device_report_change(SCSIDevice *dev, SCSISense sense);
8d72db68 275void scsi_device_unit_attention_reported(SCSIDevice *dev);
9fd7e859 276void scsi_generic_read_device_identification(SCSIDevice *dev);
b45ef674 277int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed);
0d3545e7 278SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun);
89b08ae1 279
765d1525
PB		 280/* scsi-generic.c. */
281extern const SCSIReqOps scsi_generic_req_ops;
282
43b443b6 283#endif
QEMU mirror