1#ifndef QEMU_HW_SCSI_H
2#define QEMU_HW_SCSI_H
3
4#include "block/aio.h"
5#include "hw/block/block.h"
6#include "hw/qdev-core.h"
7#include "scsi/utils.h"
8#include "qemu/notify.h"
9#include "qom/object.h"
10
11#define MAX_SCSI_DEVS 255
12
13typedef struct SCSIBus SCSIBus;
14typedef struct SCSIBusInfo SCSIBusInfo;
15typedef struct SCSIDevice SCSIDevice;
16typedef struct SCSIRequest SCSIRequest;
17typedef struct SCSIReqOps SCSIReqOps;
18
19#define SCSI_SENSE_BUF_SIZE_OLD 96
20#define SCSI_SENSE_BUF_SIZE 252
21#define DEFAULT_IO_TIMEOUT 30
22
23struct SCSIRequest {
24 SCSIBus *bus;
25 SCSIDevice *dev;
26 const SCSIReqOps *ops;
27 uint32_t refcount;
28 uint32_t tag;
29 uint32_t lun;
30 int16_t status;
31 int16_t host_status;
32 void *hba_private;
33 uint64_t residual;
34 SCSICommand cmd;
35 NotifierList cancel_notifiers;
36
37
38
39
40
41
42
43 uint8_t sense[SCSI_SENSE_BUF_SIZE];
44 uint32_t sense_len;
45 bool enqueued;
46 bool io_canceled;
47 bool retry;
48 bool dma_started;
49 BlockAIOCB *aiocb;
50 QEMUSGList *sg;
51 QTAILQ_ENTRY(SCSIRequest) next;
52};
53
54#define TYPE_SCSI_DEVICE "scsi-device"
55OBJECT_DECLARE_TYPE(SCSIDevice, SCSIDeviceClass, SCSI_DEVICE)
56
57struct SCSIDeviceClass {
58 DeviceClass parent_class;
59 void (*realize)(SCSIDevice *dev, Error **errp);
60 void (*unrealize)(SCSIDevice *dev);
61 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
62 size_t buf_len, void *hba_private);
63 SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun,
64 uint8_t *buf, void *hba_private);
65 void (*unit_attention_reported)(SCSIDevice *s);
66};
67
68struct SCSIDevice
69{
70 DeviceState qdev;
71 VMChangeStateEntry *vmsentry;
72 QEMUBH *bh;
73 uint32_t id;
74 BlockConf conf;
75 SCSISense unit_attention;
76 bool sense_is_ua;
77 uint8_t sense[SCSI_SENSE_BUF_SIZE];
78 uint32_t sense_len;
79 QTAILQ_HEAD(, SCSIRequest) requests;
80 uint32_t channel;
81 uint32_t lun;
82 int blocksize;
83 int type;
84 uint64_t max_lba;
85 uint64_t wwn;
86 uint64_t port_wwn;
87 int scsi_version;
88 int default_scsi_version;
89 uint32_t io_timeout;
90 bool needs_vpd_bl_emulation;
91 bool hba_supports_iothread;
92};
93
94extern const VMStateDescription vmstate_scsi_device;
95
96#define VMSTATE_SCSI_DEVICE(_field, _state) { \
97 .name = (stringify(_field)), \
98 .size = sizeof(SCSIDevice), \
99 .vmsd = &vmstate_scsi_device, \
100 .flags = VMS_STRUCT, \
101 .offset = vmstate_offset_value(_state, _field, SCSIDevice), \
102}
103
104
105int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track);
106int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num);
107
108
109struct SCSIReqOps {
110 size_t size;
111 void (*init_req)(SCSIRequest *req);
112 void (*free_req)(SCSIRequest *req);
113 int32_t (*send_command)(SCSIRequest *req, uint8_t *buf);
114 void (*read_data)(SCSIRequest *req);
115 void (*write_data)(SCSIRequest *req);
116 uint8_t *(*get_buf)(SCSIRequest *req);
117
118 void (*save_request)(QEMUFile *f, SCSIRequest *req);
119 void (*load_request)(QEMUFile *f, SCSIRequest *req);
120};
121
122struct SCSIBusInfo {
123 int tcq;
124 int max_channel, max_target, max_lun;
125 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
126 size_t buf_len, void *hba_private);
127 void (*transfer_data)(SCSIRequest *req, uint32_t arg);
128 void (*fail)(SCSIRequest *req);
129 void (*complete)(SCSIRequest *req, size_t residual);
130 void (*cancel)(SCSIRequest *req);
131 void (*change)(SCSIBus *bus, SCSIDevice *dev, SCSISense sense);
132 QEMUSGList *(*get_sg_list)(SCSIRequest *req);
133
134 void (*save_request)(QEMUFile *f, SCSIRequest *req);
135 void *(*load_request)(QEMUFile *f, SCSIRequest *req);
136 void (*free_request)(SCSIBus *bus, void *priv);
137
138
139
140
141
142
143
144
145 void (*drained_begin)(SCSIBus *bus);
146 void (*drained_end)(SCSIBus *bus);
147};
148
149#define TYPE_SCSI_BUS "SCSI"
150OBJECT_DECLARE_SIMPLE_TYPE(SCSIBus, SCSI_BUS)
151
152struct SCSIBus {
153 BusState qbus;
154 int busnr;
155
156 SCSISense unit_attention;
157 const SCSIBusInfo *info;
158
159 int drain_count;
160};
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176void scsi_bus_init_named(SCSIBus *bus, size_t bus_size, DeviceState *host,
177 const SCSIBusInfo *info, const char *bus_name);
178
179
180
181
182
183
184
185static inline void scsi_bus_init(SCSIBus *bus, size_t bus_size,
186 DeviceState *host, const SCSIBusInfo *info)
187{
188 scsi_bus_init_named(bus, bus_size, host, info, NULL);
189}
190
191static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d)
192{
193 return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
194}
195
196SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockBackend *blk,
197 int unit, bool removable, int bootindex,
198 bool share_rw,
199 BlockdevOnError rerror,
200 BlockdevOnError werror,
201 const char *serial, Error **errp);
202void scsi_bus_set_ua(SCSIBus *bus, SCSISense sense);
203void scsi_bus_legacy_handle_cmdline(SCSIBus *bus);
204
205SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
206 uint32_t tag, uint32_t lun, void *hba_private);
207SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
208 uint8_t *buf, size_t buf_len, void *hba_private);
209int32_t scsi_req_enqueue(SCSIRequest *req);
210SCSIRequest *scsi_req_ref(SCSIRequest *req);
211void scsi_req_unref(SCSIRequest *req);
212
213int scsi_bus_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
214 size_t buf_len, void *hba_private);
215int scsi_req_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
216 size_t buf_len);
217void scsi_req_build_sense(SCSIRequest *req, SCSISense sense);
218void scsi_req_print(SCSIRequest *req);
219void scsi_req_continue(SCSIRequest *req);
220void scsi_req_data(SCSIRequest *req, int len);
221void scsi_req_complete(SCSIRequest *req, int status);
222void scsi_req_complete_failed(SCSIRequest *req, int host_status);
223uint8_t *scsi_req_get_buf(SCSIRequest *req);
224int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len);
225void scsi_req_cancel_complete(SCSIRequest *req);
226void scsi_req_cancel(SCSIRequest *req);
227void scsi_req_cancel_async(SCSIRequest *req, Notifier *notifier);
228void scsi_req_retry(SCSIRequest *req);
229void scsi_device_drained_begin(SCSIDevice *sdev);
230void scsi_device_drained_end(SCSIDevice *sdev);
231void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense);
232void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense);
233void scsi_device_report_change(SCSIDevice *dev, SCSISense sense);
234void scsi_device_unit_attention_reported(SCSIDevice *dev);
235void scsi_generic_read_device_inquiry(SCSIDevice *dev);
236int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed);
237int scsi_SG_IO_FROM_DEV(BlockBackend *blk, uint8_t *cmd, uint8_t cmd_size,
238 uint8_t *buf, uint8_t buf_size, uint32_t timeout);
239SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun);
240SCSIDevice *scsi_device_get(SCSIBus *bus, int channel, int target, int lun);
241
242
243extern const SCSIReqOps scsi_generic_req_ops;
244
245
246#define SCSI_DISK_QUIRK_MODE_PAGE_APPLE_VENDOR 0
247#define SCSI_DISK_QUIRK_MODE_SENSE_ROM_USE_DBD 1
248#define SCSI_DISK_QUIRK_MODE_PAGE_VENDOR_SPECIFIC_APPLE 2
249#define SCSI_DISK_QUIRK_MODE_PAGE_TRUNCATED 3
250
251#endif
252