]>
Commit | Line | Data |
---|---|---|
1e37607b GH |
1 | #ifndef QEMU_HW_SCSI_H |
2 | #define QEMU_HW_SCSI_H | |
43b443b6 GH |
3 | |
4 | #include "qdev.h" | |
4c41d2ef | 5 | #include "block.h" |
31e404f4 | 6 | #include "hw/block-common.h" |
71544d30 | 7 | #include "sysemu.h" |
43b443b6 | 8 | |
27d6bf40 MA |
9 | #define MAX_SCSI_DEVS 255 |
10 | ||
29362ebe GH |
11 | #define SCSI_CMD_BUF_SIZE 16 |
12 | ||
43b443b6 | 13 | typedef struct SCSIBus SCSIBus; |
afd4030c | 14 | typedef struct SCSIBusInfo SCSIBusInfo; |
2599aece | 15 | typedef struct SCSICommand SCSICommand; |
43b443b6 | 16 | typedef struct SCSIDevice SCSIDevice; |
5c6c0e51 | 17 | typedef struct SCSIRequest SCSIRequest; |
8dbd4574 | 18 | typedef struct SCSIReqOps SCSIReqOps; |
43b443b6 | 19 | |
97a06435 GH |
20 | enum SCSIXferMode { |
21 | SCSI_XFER_NONE, /* TEST_UNIT_READY, ... */ | |
22 | SCSI_XFER_FROM_DEV, /* READ, INQUIRY, MODE_SENSE, ... */ | |
23 | SCSI_XFER_TO_DEV, /* WRITE, MODE_SELECT, ... */ | |
24 | }; | |
25 | ||
a1f0cce2 HR |
26 | typedef struct SCSISense { |
27 | uint8_t key; | |
28 | uint8_t asc; | |
29 | uint8_t ascq; | |
30 | } SCSISense; | |
31 | ||
b45ef674 PB |
32 | #define SCSI_SENSE_BUF_SIZE 96 |
33 | ||
2599aece PB |
34 | struct SCSICommand { |
35 | uint8_t buf[SCSI_CMD_BUF_SIZE]; | |
36 | int len; | |
37 | size_t xfer; | |
38 | uint64_t lba; | |
39 | enum SCSIXferMode mode; | |
40 | }; | |
41 | ||
5c6c0e51 | 42 | struct SCSIRequest { |
4c41d2ef GH |
43 | SCSIBus *bus; |
44 | SCSIDevice *dev; | |
adcf2754 | 45 | const SCSIReqOps *ops; |
ad2d30f7 | 46 | uint32_t refcount; |
4c41d2ef | 47 | uint32_t tag; |
89b08ae1 | 48 | uint32_t lun; |
ed3a34a3 | 49 | uint32_t status; |
01e95455 | 50 | size_t resid; |
2599aece | 51 | SCSICommand cmd; |
4c41d2ef | 52 | BlockDriverAIOCB *aiocb; |
3d5aba97 PB |
53 | QEMUSGList *sg; |
54 | bool dma_started; | |
b45ef674 PB |
55 | uint8_t sense[SCSI_SENSE_BUF_SIZE]; |
56 | uint32_t sense_len; | |
e8637c90 | 57 | bool enqueued; |
e88c591d | 58 | bool io_canceled; |
71544d30 | 59 | bool retry; |
c5bf71a9 | 60 | void *hba_private; |
9af99d98 | 61 | QTAILQ_ENTRY(SCSIRequest) next; |
5c6c0e51 | 62 | }; |
4c41d2ef | 63 | |
b9eea3e6 AL |
64 | #define TYPE_SCSI_DEVICE "scsi-device" |
65 | #define SCSI_DEVICE(obj) \ | |
66 | OBJECT_CHECK(SCSIDevice, (obj), TYPE_SCSI_DEVICE) | |
67 | #define SCSI_DEVICE_CLASS(klass) \ | |
68 | OBJECT_CLASS_CHECK(SCSIDeviceClass, (klass), TYPE_SCSI_DEVICE) | |
69 | #define SCSI_DEVICE_GET_CLASS(obj) \ | |
70 | OBJECT_GET_CLASS(SCSIDeviceClass, (obj), TYPE_SCSI_DEVICE) | |
71 | ||
72 | typedef struct SCSIDeviceClass { | |
73 | DeviceClass parent_class; | |
74 | int (*init)(SCSIDevice *dev); | |
75 | void (*destroy)(SCSIDevice *s); | |
76 | SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun, | |
77 | uint8_t *buf, void *hba_private); | |
78 | void (*unit_attention_reported)(SCSIDevice *s); | |
79 | } SCSIDeviceClass; | |
80 | ||
43b443b6 GH |
81 | struct SCSIDevice |
82 | { | |
83 | DeviceState qdev; | |
71544d30 PB |
84 | VMChangeStateEntry *vmsentry; |
85 | QEMUBH *bh; | |
43b443b6 | 86 | uint32_t id; |
428c149b | 87 | BlockConf conf; |
6dc06f08 | 88 | SCSISense unit_attention; |
3653d8c4 | 89 | bool sense_is_ua; |
b45ef674 PB |
90 | uint8_t sense[SCSI_SENSE_BUF_SIZE]; |
91 | uint32_t sense_len; | |
9af99d98 | 92 | QTAILQ_HEAD(, SCSIRequest) requests; |
0d3545e7 | 93 | uint32_t channel; |
87dcd1b2 | 94 | uint32_t lun; |
b07995e3 | 95 | int blocksize; |
91376656 | 96 | int type; |
7877903a | 97 | uint64_t max_lba; |
43b443b6 GH |
98 | }; |
99 | ||
63f740dd PB |
100 | extern const VMStateDescription vmstate_scsi_device; |
101 | ||
102 | #define VMSTATE_SCSI_DEVICE(_field, _state) { \ | |
103 | .name = (stringify(_field)), \ | |
104 | .size = sizeof(SCSIDevice), \ | |
105 | .vmsd = &vmstate_scsi_device, \ | |
106 | .flags = VMS_STRUCT, \ | |
107 | .offset = vmstate_offset_value(_state, _field, SCSIDevice), \ | |
108 | } | |
109 | ||
43b443b6 GH |
110 | /* cdrom.c */ |
111 | int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track); | |
112 | int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num); | |
113 | ||
114 | /* scsi-bus.c */ | |
8dbd4574 PB |
115 | struct SCSIReqOps { |
116 | size_t size; | |
12010e7b PB |
117 | void (*free_req)(SCSIRequest *req); |
118 | int32_t (*send_command)(SCSIRequest *req, uint8_t *buf); | |
119 | void (*read_data)(SCSIRequest *req); | |
120 | void (*write_data)(SCSIRequest *req); | |
121 | void (*cancel_io)(SCSIRequest *req); | |
122 | uint8_t *(*get_buf)(SCSIRequest *req); | |
63f740dd PB |
123 | |
124 | void (*save_request)(QEMUFile *f, SCSIRequest *req); | |
125 | void (*load_request)(QEMUFile *f, SCSIRequest *req); | |
8dbd4574 PB |
126 | }; |
127 | ||
afd4030c | 128 | struct SCSIBusInfo { |
7e0380b9 | 129 | int tcq; |
0d3545e7 | 130 | int max_channel, max_target, max_lun; |
c6df7102 | 131 | void (*transfer_data)(SCSIRequest *req, uint32_t arg); |
01e95455 | 132 | void (*complete)(SCSIRequest *req, uint32_t arg, size_t resid); |
94d3f98a | 133 | void (*cancel)(SCSIRequest *req); |
350e6e41 CM |
134 | void (*hotplug)(SCSIBus *bus, SCSIDevice *dev); |
135 | void (*hot_unplug)(SCSIBus *bus, SCSIDevice *dev); | |
53200fad | 136 | void (*change)(SCSIBus *bus, SCSIDevice *dev, SCSISense sense); |
3d5aba97 | 137 | QEMUSGList *(*get_sg_list)(SCSIRequest *req); |
63f740dd PB |
138 | |
139 | void (*save_request)(QEMUFile *f, SCSIRequest *req); | |
140 | void *(*load_request)(QEMUFile *f, SCSIRequest *req); | |
8e86b93c | 141 | void (*free_request)(SCSIBus *bus, void *priv); |
cfdc1bb0 PB |
142 | }; |
143 | ||
0d936928 AL |
144 | #define TYPE_SCSI_BUS "SCSI" |
145 | #define SCSI_BUS(obj) OBJECT_CHECK(SCSIBus, (obj), TYPE_SCSI_BUS) | |
146 | ||
43b443b6 GH |
147 | struct SCSIBus { |
148 | BusState qbus; | |
149 | int busnr; | |
150 | ||
6dc06f08 | 151 | SCSISense unit_attention; |
afd4030c | 152 | const SCSIBusInfo *info; |
43b443b6 GH |
153 | }; |
154 | ||
afd4030c | 155 | void scsi_bus_new(SCSIBus *bus, DeviceState *host, const SCSIBusInfo *info); |
43b443b6 GH |
156 | |
157 | static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d) | |
158 | { | |
159 | return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus); | |
160 | } | |
161 | ||
2d1fd261 | 162 | SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv, |
ce4e7e46 | 163 | int unit, bool removable, int bootindex); |
fa66b909 | 164 | int scsi_bus_legacy_handle_cmdline(SCSIBus *bus); |
43b443b6 | 165 | |
a1f0cce2 HR |
166 | /* |
167 | * Predefined sense codes | |
168 | */ | |
169 | ||
170 | /* No sense data available */ | |
171 | extern const struct SCSISense sense_code_NO_SENSE; | |
172 | /* LUN not ready, Manual intervention required */ | |
173 | extern const struct SCSISense sense_code_LUN_NOT_READY; | |
174 | /* LUN not ready, Medium not present */ | |
175 | extern const struct SCSISense sense_code_NO_MEDIUM; | |
68bb01f3 MA |
176 | /* LUN not ready, medium removal prevented */ |
177 | extern const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED; | |
a1f0cce2 HR |
178 | /* Hardware error, internal target failure */ |
179 | extern const struct SCSISense sense_code_TARGET_FAILURE; | |
180 | /* Illegal request, invalid command operation code */ | |
181 | extern const struct SCSISense sense_code_INVALID_OPCODE; | |
182 | /* Illegal request, LBA out of range */ | |
183 | extern const struct SCSISense sense_code_LBA_OUT_OF_RANGE; | |
184 | /* Illegal request, Invalid field in CDB */ | |
185 | extern const struct SCSISense sense_code_INVALID_FIELD; | |
380feaff PB |
186 | /* Illegal request, Invalid field in parameter list */ |
187 | extern const struct SCSISense sense_code_INVALID_PARAM; | |
188 | /* Illegal request, Parameter list length error */ | |
189 | extern const struct SCSISense sense_code_INVALID_PARAM_LEN; | |
a1f0cce2 HR |
190 | /* Illegal request, LUN not supported */ |
191 | extern const struct SCSISense sense_code_LUN_NOT_SUPPORTED; | |
a872a304 PB |
192 | /* Illegal request, Saving parameters not supported */ |
193 | extern const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED; | |
194 | /* Illegal request, Incompatible format */ | |
195 | extern const struct SCSISense sense_code_INCOMPATIBLE_FORMAT; | |
68bb01f3 MA |
196 | /* Illegal request, medium removal prevented */ |
197 | extern const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED; | |
a1f0cce2 HR |
198 | /* Command aborted, I/O process terminated */ |
199 | extern const struct SCSISense sense_code_IO_ERROR; | |
200 | /* Command aborted, I_T Nexus loss occurred */ | |
201 | extern const struct SCSISense sense_code_I_T_NEXUS_LOSS; | |
202 | /* Command aborted, Logical Unit failure */ | |
203 | extern const struct SCSISense sense_code_LUN_FAILURE; | |
aaebacef PB |
204 | /* LUN not ready, Capacity data has changed */ |
205 | extern const struct SCSISense sense_code_CAPACITY_CHANGED; | |
8a9c16f6 PB |
206 | /* LUN not ready, Medium not present */ |
207 | extern const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM; | |
a872a304 PB |
208 | /* Unit attention, Power on, reset or bus device reset occurred */ |
209 | extern const struct SCSISense sense_code_RESET; | |
210 | /* Unit attention, Medium may have changed*/ | |
211 | extern const struct SCSISense sense_code_MEDIUM_CHANGED; | |
212 | /* Unit attention, Reported LUNs data has changed */ | |
213 | extern const struct SCSISense sense_code_REPORTED_LUNS_CHANGED; | |
214 | /* Unit attention, Device internal reset */ | |
215 | extern const struct SCSISense sense_code_DEVICE_INTERNAL_RESET; | |
6a8a685c RS |
216 | /* Data Protection, Write Protected */ |
217 | extern const struct SCSISense sense_code_WRITE_PROTECTED; | |
a1f0cce2 HR |
218 | |
219 | #define SENSE_CODE(x) sense_code_ ## x | |
220 | ||
a1f0cce2 | 221 | int scsi_sense_valid(SCSISense sense); |
f3b338ef PB |
222 | int scsi_build_sense(uint8_t *in_buf, int in_len, |
223 | uint8_t *buf, int len, bool fixed); | |
a1f0cce2 | 224 | |
adcf2754 PB |
225 | SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d, |
226 | uint32_t tag, uint32_t lun, void *hba_private); | |
c5bf71a9 | 227 | SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun, |
c39ce112 PB |
228 | uint8_t *buf, void *hba_private); |
229 | int32_t scsi_req_enqueue(SCSIRequest *req); | |
89b08ae1 | 230 | void scsi_req_free(SCSIRequest *req); |
ad2d30f7 PB |
231 | SCSIRequest *scsi_req_ref(SCSIRequest *req); |
232 | void scsi_req_unref(SCSIRequest *req); | |
37659e51 | 233 | |
b45ef674 | 234 | void scsi_req_build_sense(SCSIRequest *req, SCSISense sense); |
ec766865 | 235 | void scsi_req_print(SCSIRequest *req); |
ad3376cc | 236 | void scsi_req_continue(SCSIRequest *req); |
ab9adc88 | 237 | void scsi_req_data(SCSIRequest *req, int len); |
682a9b21 | 238 | void scsi_req_complete(SCSIRequest *req, int status); |
0c34459b | 239 | uint8_t *scsi_req_get_buf(SCSIRequest *req); |
74382217 | 240 | int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len); |
19d110ab | 241 | void scsi_req_abort(SCSIRequest *req, int status); |
94d3f98a | 242 | void scsi_req_cancel(SCSIRequest *req); |
71544d30 | 243 | void scsi_req_retry(SCSIRequest *req); |
c7b48872 | 244 | void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense); |
e48e84ea | 245 | void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense); |
53200fad | 246 | void scsi_device_report_change(SCSIDevice *dev, SCSISense sense); |
b45ef674 | 247 | int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed); |
0d3545e7 | 248 | SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun); |
89b08ae1 | 249 | |
765d1525 PB |
250 | /* scsi-generic.c. */ |
251 | extern const SCSIReqOps scsi_generic_req_ops; | |
252 | ||
43b443b6 | 253 | #endif |