target-i386: Add API to get note's size
[qemu/ar7.git] / hw / scsi.h
blob2eb66f7393a8352554577bc6bb0d243e18a0bab9
1 #ifndef QEMU_HW_SCSI_H
2 #define QEMU_HW_SCSI_H
4 #include "qdev.h"
5 #include "block.h"
6 #include "sysemu.h"
8 #define MAX_SCSI_DEVS 255
10 #define SCSI_CMD_BUF_SIZE 16
12 typedef struct SCSIBus SCSIBus;
13 typedef struct SCSIBusInfo SCSIBusInfo;
14 typedef struct SCSICommand SCSICommand;
15 typedef struct SCSIDevice SCSIDevice;
16 typedef struct SCSIRequest SCSIRequest;
17 typedef struct SCSIReqOps SCSIReqOps;
19 enum SCSIXferMode {
20 SCSI_XFER_NONE, /* TEST_UNIT_READY, ... */
21 SCSI_XFER_FROM_DEV, /* READ, INQUIRY, MODE_SENSE, ... */
22 SCSI_XFER_TO_DEV, /* WRITE, MODE_SELECT, ... */
25 typedef struct SCSISense {
26 uint8_t key;
27 uint8_t asc;
28 uint8_t ascq;
29 } SCSISense;
31 #define SCSI_SENSE_BUF_SIZE 96
33 struct SCSICommand {
34 uint8_t buf[SCSI_CMD_BUF_SIZE];
35 int len;
36 size_t xfer;
37 uint64_t lba;
38 enum SCSIXferMode mode;
41 struct SCSIRequest {
42 SCSIBus *bus;
43 SCSIDevice *dev;
44 const SCSIReqOps *ops;
45 uint32_t refcount;
46 uint32_t tag;
47 uint32_t lun;
48 uint32_t status;
49 size_t resid;
50 SCSICommand cmd;
51 BlockDriverAIOCB *aiocb;
52 QEMUSGList *sg;
53 bool dma_started;
54 uint8_t sense[SCSI_SENSE_BUF_SIZE];
55 uint32_t sense_len;
56 bool enqueued;
57 bool io_canceled;
58 bool retry;
59 void *hba_private;
60 QTAILQ_ENTRY(SCSIRequest) next;
63 #define TYPE_SCSI_DEVICE "scsi-device"
64 #define SCSI_DEVICE(obj) \
65 OBJECT_CHECK(SCSIDevice, (obj), TYPE_SCSI_DEVICE)
66 #define SCSI_DEVICE_CLASS(klass) \
67 OBJECT_CLASS_CHECK(SCSIDeviceClass, (klass), TYPE_SCSI_DEVICE)
68 #define SCSI_DEVICE_GET_CLASS(obj) \
69 OBJECT_GET_CLASS(SCSIDeviceClass, (obj), TYPE_SCSI_DEVICE)
71 typedef struct SCSIDeviceClass {
72 DeviceClass parent_class;
73 int (*init)(SCSIDevice *dev);
74 void (*destroy)(SCSIDevice *s);
75 SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun,
76 uint8_t *buf, void *hba_private);
77 void (*unit_attention_reported)(SCSIDevice *s);
78 } SCSIDeviceClass;
80 struct SCSIDevice
82 DeviceState qdev;
83 VMChangeStateEntry *vmsentry;
84 QEMUBH *bh;
85 uint32_t id;
86 BlockConf conf;
87 SCSISense unit_attention;
88 bool sense_is_ua;
89 uint8_t sense[SCSI_SENSE_BUF_SIZE];
90 uint32_t sense_len;
91 QTAILQ_HEAD(, SCSIRequest) requests;
92 uint32_t channel;
93 uint32_t lun;
94 int blocksize;
95 int type;
96 uint64_t max_lba;
99 extern const VMStateDescription vmstate_scsi_device;
101 #define VMSTATE_SCSI_DEVICE(_field, _state) { \
102 .name = (stringify(_field)), \
103 .size = sizeof(SCSIDevice), \
104 .vmsd = &vmstate_scsi_device, \
105 .flags = VMS_STRUCT, \
106 .offset = vmstate_offset_value(_state, _field, SCSIDevice), \
109 /* cdrom.c */
110 int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track);
111 int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num);
113 /* scsi-bus.c */
114 struct SCSIReqOps {
115 size_t size;
116 void (*free_req)(SCSIRequest *req);
117 int32_t (*send_command)(SCSIRequest *req, uint8_t *buf);
118 void (*read_data)(SCSIRequest *req);
119 void (*write_data)(SCSIRequest *req);
120 void (*cancel_io)(SCSIRequest *req);
121 uint8_t *(*get_buf)(SCSIRequest *req);
123 void (*save_request)(QEMUFile *f, SCSIRequest *req);
124 void (*load_request)(QEMUFile *f, SCSIRequest *req);
127 struct SCSIBusInfo {
128 int tcq;
129 int max_channel, max_target, max_lun;
130 void (*transfer_data)(SCSIRequest *req, uint32_t arg);
131 void (*complete)(SCSIRequest *req, uint32_t arg, size_t resid);
132 void (*cancel)(SCSIRequest *req);
133 QEMUSGList *(*get_sg_list)(SCSIRequest *req);
135 void (*save_request)(QEMUFile *f, SCSIRequest *req);
136 void *(*load_request)(QEMUFile *f, SCSIRequest *req);
139 struct SCSIBus {
140 BusState qbus;
141 int busnr;
143 SCSISense unit_attention;
144 const SCSIBusInfo *info;
147 void scsi_bus_new(SCSIBus *bus, DeviceState *host, const SCSIBusInfo *info);
149 static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d)
151 return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
154 SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
155 int unit, bool removable, int bootindex);
156 int scsi_bus_legacy_handle_cmdline(SCSIBus *bus);
159 * Predefined sense codes
162 /* No sense data available */
163 extern const struct SCSISense sense_code_NO_SENSE;
164 /* LUN not ready, Manual intervention required */
165 extern const struct SCSISense sense_code_LUN_NOT_READY;
166 /* LUN not ready, Medium not present */
167 extern const struct SCSISense sense_code_NO_MEDIUM;
168 /* LUN not ready, medium removal prevented */
169 extern const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED;
170 /* Hardware error, internal target failure */
171 extern const struct SCSISense sense_code_TARGET_FAILURE;
172 /* Illegal request, invalid command operation code */
173 extern const struct SCSISense sense_code_INVALID_OPCODE;
174 /* Illegal request, LBA out of range */
175 extern const struct SCSISense sense_code_LBA_OUT_OF_RANGE;
176 /* Illegal request, Invalid field in CDB */
177 extern const struct SCSISense sense_code_INVALID_FIELD;
178 /* Illegal request, LUN not supported */
179 extern const struct SCSISense sense_code_LUN_NOT_SUPPORTED;
180 /* Illegal request, Saving parameters not supported */
181 extern const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED;
182 /* Illegal request, Incompatible format */
183 extern const struct SCSISense sense_code_INCOMPATIBLE_FORMAT;
184 /* Illegal request, medium removal prevented */
185 extern const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED;
186 /* Command aborted, I/O process terminated */
187 extern const struct SCSISense sense_code_IO_ERROR;
188 /* Command aborted, I_T Nexus loss occurred */
189 extern const struct SCSISense sense_code_I_T_NEXUS_LOSS;
190 /* Command aborted, Logical Unit failure */
191 extern const struct SCSISense sense_code_LUN_FAILURE;
192 /* LUN not ready, Medium not present */
193 extern const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM;
194 /* Unit attention, Power on, reset or bus device reset occurred */
195 extern const struct SCSISense sense_code_RESET;
196 /* Unit attention, Medium may have changed*/
197 extern const struct SCSISense sense_code_MEDIUM_CHANGED;
198 /* Unit attention, Reported LUNs data has changed */
199 extern const struct SCSISense sense_code_REPORTED_LUNS_CHANGED;
200 /* Unit attention, Device internal reset */
201 extern const struct SCSISense sense_code_DEVICE_INTERNAL_RESET;
203 #define SENSE_CODE(x) sense_code_ ## x
205 int scsi_sense_valid(SCSISense sense);
206 int scsi_build_sense(uint8_t *in_buf, int in_len,
207 uint8_t *buf, int len, bool fixed);
209 SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
210 uint32_t tag, uint32_t lun, void *hba_private);
211 SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
212 uint8_t *buf, void *hba_private);
213 int32_t scsi_req_enqueue(SCSIRequest *req);
214 void scsi_req_free(SCSIRequest *req);
215 SCSIRequest *scsi_req_ref(SCSIRequest *req);
216 void scsi_req_unref(SCSIRequest *req);
218 void scsi_req_build_sense(SCSIRequest *req, SCSISense sense);
219 void scsi_req_print(SCSIRequest *req);
220 void scsi_req_continue(SCSIRequest *req);
221 void scsi_req_data(SCSIRequest *req, int len);
222 void scsi_req_complete(SCSIRequest *req, int status);
223 uint8_t *scsi_req_get_buf(SCSIRequest *req);
224 int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len);
225 void scsi_req_abort(SCSIRequest *req, int status);
226 void scsi_req_cancel(SCSIRequest *req);
227 void scsi_req_retry(SCSIRequest *req);
228 void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense);
229 int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed);
230 SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun);
232 /* scsi-generic.c. */
233 extern const SCSIReqOps scsi_generic_req_ops;
235 #endif