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
10#define MAX_SCSI_DEVS 255
11
12typedef struct SCSIBus SCSIBus;
13typedef struct SCSIBusInfo SCSIBusInfo;
14typedef struct SCSIDevice SCSIDevice;
15typedef struct SCSIRequest SCSIRequest;
16typedef struct SCSIReqOps SCSIReqOps;
17
18#define SCSI_SENSE_BUF_SIZE_OLD 96
19#define SCSI_SENSE_BUF_SIZE 252
20
21struct SCSIRequest {
22 SCSIBus *bus;
23 SCSIDevice *dev;
24 const SCSIReqOps *ops;
25 uint32_t refcount;
26 uint32_t tag;
27 uint32_t lun;
28 uint32_t status;
29 void *hba_private;
30 size_t resid;
31 SCSICommand cmd;
32 NotifierList cancel_notifiers;
33
34 /* Note:
35 * - fields before sense are initialized by scsi_req_alloc;
36 * - sense[] is uninitialized;
37 * - fields after sense are memset to 0 by scsi_req_alloc.
38 * */
39
40 uint8_t sense[SCSI_SENSE_BUF_SIZE];
41 uint32_t sense_len;
42 bool enqueued;
43 bool io_canceled;
44 bool retry;
45 bool dma_started;
46 BlockAIOCB *aiocb;
47 QEMUSGList *sg;
48 QTAILQ_ENTRY(SCSIRequest) next;
49};
50
51#define TYPE_SCSI_DEVICE "scsi-device"
52#define SCSI_DEVICE(obj) \
53 OBJECT_CHECK(SCSIDevice, (obj), TYPE_SCSI_DEVICE)
54#define SCSI_DEVICE_CLASS(klass) \
55 OBJECT_CLASS_CHECK(SCSIDeviceClass, (klass), TYPE_SCSI_DEVICE)
56#define SCSI_DEVICE_GET_CLASS(obj) \
57 OBJECT_GET_CLASS(SCSIDeviceClass, (obj), TYPE_SCSI_DEVICE)
58
59typedef struct SCSIDeviceClass {
60 DeviceClass parent_class;
61 void (*realize)(SCSIDevice *dev, Error **errp);
62 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
63 void *hba_private);
64 SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun,
65 uint8_t *buf, void *hba_private);
66 void (*unit_attention_reported)(SCSIDevice *s);
67} SCSIDeviceClass;
68
69struct SCSIDevice
70{
71 DeviceState qdev;
72 VMChangeStateEntry *vmsentry;
73 QEMUBH *bh;
74 uint32_t id;
75 BlockConf conf;
76 SCSISense unit_attention;
77 bool sense_is_ua;
78 uint8_t sense[SCSI_SENSE_BUF_SIZE];
79 uint32_t sense_len;
80 QTAILQ_HEAD(, SCSIRequest) requests;
81 uint32_t channel;
82 uint32_t lun;
83 int blocksize;
84 int type;
85 uint64_t max_lba;
86 uint64_t wwn;
87 uint64_t port_wwn;
88 int scsi_version;
89 int default_scsi_version;
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/* cdrom.c */
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/* scsi-bus.c */
109struct SCSIReqOps {
110 size_t size;
111 void (*free_req)(SCSIRequest *req);
112 int32_t (*send_command)(SCSIRequest *req, uint8_t *buf);
113 void (*read_data)(SCSIRequest *req);
114 void (*write_data)(SCSIRequest *req);
115 uint8_t *(*get_buf)(SCSIRequest *req);
116
117 void (*save_request)(QEMUFile *f, SCSIRequest *req);
118 void (*load_request)(QEMUFile *f, SCSIRequest *req);
119};
120
121struct SCSIBusInfo {
122 int tcq;
123 int max_channel, max_target, max_lun;
124 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
125 void *hba_private);
126 void (*transfer_data)(SCSIRequest *req, uint32_t arg);
127 void (*complete)(SCSIRequest *req, uint32_t arg, size_t resid);
128 void (*cancel)(SCSIRequest *req);
129 void (*change)(SCSIBus *bus, SCSIDevice *dev, SCSISense sense);
130 QEMUSGList *(*get_sg_list)(SCSIRequest *req);
131
132 void (*save_request)(QEMUFile *f, SCSIRequest *req);
133 void *(*load_request)(QEMUFile *f, SCSIRequest *req);
134 void (*free_request)(SCSIBus *bus, void *priv);
135};
136
137#define TYPE_SCSI_BUS "SCSI"
138#define SCSI_BUS(obj) OBJECT_CHECK(SCSIBus, (obj), TYPE_SCSI_BUS)
139
140struct SCSIBus {
141 BusState qbus;
142 int busnr;
143
144 SCSISense unit_attention;
145 const SCSIBusInfo *info;
146};
147
148void scsi_bus_new(SCSIBus *bus, size_t bus_size, DeviceState *host,
149 const SCSIBusInfo *info, const char *bus_name);
150
151static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d)
152{
153 return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
154}
155
156SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockBackend *blk,
157 int unit, bool removable, int bootindex,
158 bool share_rw,
159 BlockdevOnError rerror,
160 BlockdevOnError werror,
161 const char *serial, Error **errp);
162void scsi_bus_legacy_handle_cmdline(SCSIBus *bus);
163void scsi_legacy_handle_cmdline(void);
164
165SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
166 uint32_t tag, uint32_t lun, void *hba_private);
167SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
168 uint8_t *buf, void *hba_private);
169int32_t scsi_req_enqueue(SCSIRequest *req);
170SCSIRequest *scsi_req_ref(SCSIRequest *req);
171void scsi_req_unref(SCSIRequest *req);
172
173int scsi_bus_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
174 void *hba_private);
175int scsi_req_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf);
176void scsi_req_build_sense(SCSIRequest *req, SCSISense sense);
177void scsi_req_print(SCSIRequest *req);
178void scsi_req_continue(SCSIRequest *req);
179void scsi_req_data(SCSIRequest *req, int len);
180void scsi_req_complete(SCSIRequest *req, int status);
181uint8_t *scsi_req_get_buf(SCSIRequest *req);
182int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len);
183void scsi_req_cancel_complete(SCSIRequest *req);
184void scsi_req_cancel(SCSIRequest *req);
185void scsi_req_cancel_async(SCSIRequest *req, Notifier *notifier);
186void scsi_req_retry(SCSIRequest *req);
187void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense);
188void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense);
189void scsi_device_report_change(SCSIDevice *dev, SCSISense sense);
190void scsi_device_unit_attention_reported(SCSIDevice *dev);
191void scsi_generic_read_device_inquiry(SCSIDevice *dev);
192int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed);
193int scsi_SG_IO_FROM_DEV(BlockBackend *blk, uint8_t *cmd, uint8_t cmd_size,
194 uint8_t *buf, uint8_t buf_size);
195SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun);
196
197/* scsi-generic.c. */
198extern const SCSIReqOps scsi_generic_req_ops;
199
200#endif
201