8 #define MAX_SCSI_DEVS 255
10 #define SCSI_CMD_BUF_SIZE 16
12 typedef struct SCSIBus SCSIBus
;
13 typedef struct SCSIBusOps SCSIBusOps
;
14 typedef struct SCSICommand SCSICommand
;
15 typedef struct SCSIDevice SCSIDevice
;
16 typedef struct SCSIDeviceInfo SCSIDeviceInfo
;
17 typedef struct SCSIRequest SCSIRequest
;
18 typedef struct SCSIReqOps SCSIReqOps
;
21 SCSI_XFER_NONE
, /* TEST_UNIT_READY, ... */
22 SCSI_XFER_FROM_DEV
, /* READ, INQUIRY, MODE_SENSE, ... */
23 SCSI_XFER_TO_DEV
, /* WRITE, MODE_SELECT, ... */
26 typedef struct SCSISense
{
32 #define SCSI_SENSE_BUF_SIZE 96
35 uint8_t buf
[SCSI_CMD_BUF_SIZE
];
39 enum SCSIXferMode mode
;
51 BlockDriverAIOCB
*aiocb
;
52 uint8_t sense
[SCSI_SENSE_BUF_SIZE
];
56 QTAILQ_ENTRY(SCSIRequest
) next
;
65 SCSISense unit_attention
;
66 uint8_t sense
[SCSI_SENSE_BUF_SIZE
];
68 QTAILQ_HEAD(, SCSIRequest
) requests
;
75 int cdrom_read_toc(int nb_sectors
, uint8_t *buf
, int msf
, int start_track
);
76 int cdrom_read_toc_raw(int nb_sectors
, uint8_t *buf
, int msf
, int session_num
);
81 void (*free_req
)(SCSIRequest
*req
);
82 int32_t (*send_command
)(SCSIRequest
*req
, uint8_t *buf
);
83 void (*read_data
)(SCSIRequest
*req
);
84 void (*write_data
)(SCSIRequest
*req
);
85 void (*cancel_io
)(SCSIRequest
*req
);
86 uint8_t *(*get_buf
)(SCSIRequest
*req
);
89 typedef int (*scsi_qdev_initfn
)(SCSIDevice
*dev
);
90 struct SCSIDeviceInfo
{
92 scsi_qdev_initfn init
;
93 void (*destroy
)(SCSIDevice
*s
);
94 SCSIRequest
*(*alloc_req
)(SCSIDevice
*s
, uint32_t tag
, uint32_t lun
,
100 void (*transfer_data
)(SCSIRequest
*req
, uint32_t arg
);
101 void (*complete
)(SCSIRequest
*req
, uint32_t arg
);
102 void (*cancel
)(SCSIRequest
*req
);
109 SCSISense unit_attention
;
111 const SCSIBusOps
*ops
;
113 SCSIDevice
*devs
[MAX_SCSI_DEVS
];
116 void scsi_bus_new(SCSIBus
*bus
, DeviceState
*host
, int tcq
, int ndev
,
117 const SCSIBusOps
*ops
);
118 void scsi_qdev_register(SCSIDeviceInfo
*info
);
120 static inline SCSIBus
*scsi_bus_from_device(SCSIDevice
*d
)
122 return DO_UPCAST(SCSIBus
, qbus
, d
->qdev
.parent_bus
);
125 SCSIDevice
*scsi_bus_legacy_add_drive(SCSIBus
*bus
, BlockDriverState
*bdrv
,
126 int unit
, bool removable
);
127 int scsi_bus_legacy_handle_cmdline(SCSIBus
*bus
);
130 * Predefined sense codes
133 /* No sense data available */
134 extern const struct SCSISense sense_code_NO_SENSE
;
135 /* LUN not ready, Manual intervention required */
136 extern const struct SCSISense sense_code_LUN_NOT_READY
;
137 /* LUN not ready, Medium not present */
138 extern const struct SCSISense sense_code_NO_MEDIUM
;
139 /* LUN not ready, medium removal prevented */
140 extern const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED
;
141 /* Hardware error, internal target failure */
142 extern const struct SCSISense sense_code_TARGET_FAILURE
;
143 /* Illegal request, invalid command operation code */
144 extern const struct SCSISense sense_code_INVALID_OPCODE
;
145 /* Illegal request, LBA out of range */
146 extern const struct SCSISense sense_code_LBA_OUT_OF_RANGE
;
147 /* Illegal request, Invalid field in CDB */
148 extern const struct SCSISense sense_code_INVALID_FIELD
;
149 /* Illegal request, LUN not supported */
150 extern const struct SCSISense sense_code_LUN_NOT_SUPPORTED
;
151 /* Illegal request, Saving parameters not supported */
152 extern const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED
;
153 /* Illegal request, Incompatible format */
154 extern const struct SCSISense sense_code_INCOMPATIBLE_FORMAT
;
155 /* Illegal request, medium removal prevented */
156 extern const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED
;
157 /* Command aborted, I/O process terminated */
158 extern const struct SCSISense sense_code_IO_ERROR
;
159 /* Command aborted, I_T Nexus loss occurred */
160 extern const struct SCSISense sense_code_I_T_NEXUS_LOSS
;
161 /* Command aborted, Logical Unit failure */
162 extern const struct SCSISense sense_code_LUN_FAILURE
;
163 /* Unit attention, Power on, reset or bus device reset occurred */
164 extern const struct SCSISense sense_code_RESET
;
165 /* Unit attention, Medium may have changed*/
166 extern const struct SCSISense sense_code_MEDIUM_CHANGED
;
167 /* Unit attention, Reported LUNs data has changed */
168 extern const struct SCSISense sense_code_REPORTED_LUNS_CHANGED
;
169 /* Unit attention, Device internal reset */
170 extern const struct SCSISense sense_code_DEVICE_INTERNAL_RESET
;
172 #define SENSE_CODE(x) sense_code_ ## x
174 int scsi_sense_valid(SCSISense sense
);
176 SCSIRequest
*scsi_req_alloc(SCSIReqOps
*reqops
, SCSIDevice
*d
, uint32_t tag
,
177 uint32_t lun
, void *hba_private
);
178 SCSIRequest
*scsi_req_new(SCSIDevice
*d
, uint32_t tag
, uint32_t lun
,
179 uint8_t *buf
, void *hba_private
);
180 int32_t scsi_req_enqueue(SCSIRequest
*req
);
181 void scsi_req_free(SCSIRequest
*req
);
182 SCSIRequest
*scsi_req_ref(SCSIRequest
*req
);
183 void scsi_req_unref(SCSIRequest
*req
);
185 void scsi_req_build_sense(SCSIRequest
*req
, SCSISense sense
);
186 void scsi_req_print(SCSIRequest
*req
);
187 void scsi_req_continue(SCSIRequest
*req
);
188 void scsi_req_data(SCSIRequest
*req
, int len
);
189 void scsi_req_complete(SCSIRequest
*req
, int status
);
190 uint8_t *scsi_req_get_buf(SCSIRequest
*req
);
191 int scsi_req_get_sense(SCSIRequest
*req
, uint8_t *buf
, int len
);
192 void scsi_req_abort(SCSIRequest
*req
, int status
);
193 void scsi_req_cancel(SCSIRequest
*req
);
194 void scsi_device_purge_requests(SCSIDevice
*sdev
, SCSISense sense
);
195 int scsi_device_get_sense(SCSIDevice
*dev
, uint8_t *buf
, int len
, bool fixed
);