1#ifndef QEMU_HW_SCSI_H
2#define QEMU_HW_SCSI_H
3
4#include "hw/qdev.h"
5#include "hw/block/block.h"
6#include "sysemu/sysemu.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
35
36
37
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};
89
90extern const VMStateDescription vmstate_scsi_device;
91
92#define VMSTATE_SCSI_DEVICE(_field, _state) { \
93 .name = (stringify(_field)), \
94 .size = sizeof(SCSIDevice), \
95 .vmsd = &vmstate_scsi_device, \
96 .flags = VMS_STRUCT, \
97 .offset = vmstate_offset_value(_state, _field, SCSIDevice), \
98}
99
100
101int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track);
102int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num);
103
104
105struct SCSIReqOps {
106 size_t size;
107 void (*free_req)(SCSIRequest *req);
108 int32_t (*send_command)(SCSIRequest *req, uint8_t *buf);
109 void (*read_data)(SCSIRequest *req);
110 void (*write_data)(SCSIRequest *req);
111 uint8_t *(*get_buf)(SCSIRequest *req);
112
113 void (*save_request)(QEMUFile *f, SCSIRequest *req);
114 void (*load_request)(QEMUFile *f, SCSIRequest *req);
115};
116
117struct SCSIBusInfo {
118 int tcq;
119 int max_channel, max_target, max_lun;
120 int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
121 void *hba_private);
122 void (*transfer_data)(SCSIRequest *req, uint32_t arg);
123 void (*complete)(SCSIRequest *req, uint32_t arg, size_t resid);
124 void (*cancel)(SCSIRequest *req);
125 void (*change)(SCSIBus *bus, SCSIDevice *dev, SCSISense sense);
126 QEMUSGList *(*get_sg_list)(SCSIRequest *req);
127
128 void (*save_request)(QEMUFile *f, SCSIRequest *req);
129 void *(*load_request)(QEMUFile *f, SCSIRequest *req);
130 void (*free_request)(SCSIBus *bus, void *priv);
131};
132
133#define TYPE_SCSI_BUS "SCSI"
134#define SCSI_BUS(obj) OBJECT_CHECK(SCSIBus, (obj), TYPE_SCSI_BUS)
135
136struct SCSIBus {
137 BusState qbus;
138 int busnr;
139
140 SCSISense unit_attention;
141 const SCSIBusInfo *info;
142};
143
144void scsi_bus_new(SCSIBus *bus, size_t bus_size, DeviceState *host,
145 const SCSIBusInfo *info, const char *bus_name);
146
147static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d)
148{
149 return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
150}
151
152SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockBackend *blk,
153 int unit, bool removable, int bootindex,
154 const char *serial, Error **errp);
155void scsi_bus_legacy_handle_cmdline(SCSIBus *bus, bool deprecated);
156void scsi_legacy_handle_cmdline(void);
157
158SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
159 uint32_t tag, uint32_t lun, void *hba_private);
160SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
161 uint8_t *buf, void *hba_private);
162int32_t scsi_req_enqueue(SCSIRequest *req);
163SCSIRequest *scsi_req_ref(SCSIRequest *req);
164void scsi_req_unref(SCSIRequest *req);
165
166int scsi_bus_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
167 void *hba_private);
168int scsi_req_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf);
169void scsi_req_build_sense(SCSIRequest *req, SCSISense sense);
170void scsi_req_print(SCSIRequest *req);
171void scsi_req_continue(SCSIRequest *req);
172void scsi_req_data(SCSIRequest *req, int len);
173void scsi_req_complete(SCSIRequest *req, int status);
174uint8_t *scsi_req_get_buf(SCSIRequest *req);
175int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len);
176void scsi_req_cancel_complete(SCSIRequest *req);
177void scsi_req_cancel(SCSIRequest *req);
178void scsi_req_cancel_async(SCSIRequest *req, Notifier *notifier);
179void scsi_req_retry(SCSIRequest *req);
180void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense);
181void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense);
182void scsi_device_report_change(SCSIDevice *dev, SCSISense sense);
183void scsi_device_unit_attention_reported(SCSIDevice *dev);
184void scsi_generic_read_device_identification(SCSIDevice *dev);
185int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed);
186SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun);
187
188
189extern const SCSIReqOps scsi_generic_req_ops;
190
191#endif
192
