]> git.proxmox.com Git - qemu.git/blame - hw/scsi.h
scsi: do not call send_command directly
[qemu.git] / hw / scsi.h
CommitLineData
1e37607b
GH
1#ifndef QEMU_HW_SCSI_H
2#define QEMU_HW_SCSI_H
43b443b6
GH
3
4#include "qdev.h"
4c41d2ef 5#include "block.h"
428c149b 6#include "block_int.h"
43b443b6 7
27d6bf40
MA
8#define MAX_SCSI_DEVS 255
9
29362ebe
GH
10#define SCSI_CMD_BUF_SIZE 16
11
43b443b6
GH
12/* scsi-disk.c */
13enum scsi_reason {
14 SCSI_REASON_DONE, /* Command complete. */
15 SCSI_REASON_DATA /* Transfer complete, more data required. */
16};
17
18typedef struct SCSIBus SCSIBus;
cfdc1bb0 19typedef struct SCSIBusOps SCSIBusOps;
43b443b6
GH
20typedef struct SCSIDevice SCSIDevice;
21typedef struct SCSIDeviceInfo SCSIDeviceInfo;
5c6c0e51 22typedef struct SCSIRequest SCSIRequest;
43b443b6 23
97a06435
GH
24enum SCSIXferMode {
25 SCSI_XFER_NONE, /* TEST_UNIT_READY, ... */
26 SCSI_XFER_FROM_DEV, /* READ, INQUIRY, MODE_SENSE, ... */
27 SCSI_XFER_TO_DEV, /* WRITE, MODE_SELECT, ... */
28};
29
a1f0cce2
HR
30typedef struct SCSISense {
31 uint8_t key;
32 uint8_t asc;
33 uint8_t ascq;
34} SCSISense;
35
5c6c0e51 36struct SCSIRequest {
4c41d2ef
GH
37 SCSIBus *bus;
38 SCSIDevice *dev;
ad2d30f7 39 uint32_t refcount;
4c41d2ef 40 uint32_t tag;
89b08ae1 41 uint32_t lun;
ed3a34a3 42 uint32_t status;
29362ebe
GH
43 struct {
44 uint8_t buf[SCSI_CMD_BUF_SIZE];
45 int len;
2ec749cb
GH
46 size_t xfer;
47 uint64_t lba;
97a06435 48 enum SCSIXferMode mode;
29362ebe 49 } cmd;
4c41d2ef 50 BlockDriverAIOCB *aiocb;
e8637c90 51 bool enqueued;
9af99d98 52 QTAILQ_ENTRY(SCSIRequest) next;
5c6c0e51 53};
4c41d2ef 54
43b443b6
GH
55struct SCSIDevice
56{
57 DeviceState qdev;
58 uint32_t id;
428c149b 59 BlockConf conf;
43b443b6 60 SCSIDeviceInfo *info;
9af99d98 61 QTAILQ_HEAD(, SCSIRequest) requests;
b07995e3 62 int blocksize;
91376656 63 int type;
43b443b6
GH
64};
65
66/* cdrom.c */
67int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track);
68int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num);
69
70/* scsi-bus.c */
71typedef int (*scsi_qdev_initfn)(SCSIDevice *dev);
72struct SCSIDeviceInfo {
73 DeviceInfo qdev;
74 scsi_qdev_initfn init;
75 void (*destroy)(SCSIDevice *s);
5c6c0e51 76 SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun);
ad2d30f7 77 void (*free_req)(SCSIRequest *req);
5c6c0e51
HR
78 int32_t (*send_command)(SCSIRequest *req, uint8_t *buf);
79 void (*read_data)(SCSIRequest *req);
80 int (*write_data)(SCSIRequest *req);
81 void (*cancel_io)(SCSIRequest *req);
82 uint8_t *(*get_buf)(SCSIRequest *req);
43b443b6
GH
83};
84
cfdc1bb0 85struct SCSIBusOps {
5c6c0e51 86 void (*complete)(SCSIRequest *req, int reason, uint32_t arg);
94d3f98a 87 void (*cancel)(SCSIRequest *req);
cfdc1bb0
PB
88};
89
43b443b6
GH
90struct SCSIBus {
91 BusState qbus;
92 int busnr;
93
94 int tcq, ndev;
cfdc1bb0 95 const SCSIBusOps *ops;
43b443b6 96
622b520f 97 SCSIDevice *devs[MAX_SCSI_DEVS];
43b443b6
GH
98};
99
100void scsi_bus_new(SCSIBus *bus, DeviceState *host, int tcq, int ndev,
cfdc1bb0 101 const SCSIBusOps *ops);
43b443b6
GH
102void scsi_qdev_register(SCSIDeviceInfo *info);
103
104static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d)
105{
106 return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
107}
108
2d1fd261
SH
109SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockDriverState *bdrv,
110 int unit, bool removable);
fa66b909 111int scsi_bus_legacy_handle_cmdline(SCSIBus *bus);
43b443b6 112
a1f0cce2
HR
113/*
114 * Predefined sense codes
115 */
116
117/* No sense data available */
118extern const struct SCSISense sense_code_NO_SENSE;
119/* LUN not ready, Manual intervention required */
120extern const struct SCSISense sense_code_LUN_NOT_READY;
121/* LUN not ready, Medium not present */
122extern const struct SCSISense sense_code_NO_MEDIUM;
123/* Hardware error, internal target failure */
124extern const struct SCSISense sense_code_TARGET_FAILURE;
125/* Illegal request, invalid command operation code */
126extern const struct SCSISense sense_code_INVALID_OPCODE;
127/* Illegal request, LBA out of range */
128extern const struct SCSISense sense_code_LBA_OUT_OF_RANGE;
129/* Illegal request, Invalid field in CDB */
130extern const struct SCSISense sense_code_INVALID_FIELD;
131/* Illegal request, LUN not supported */
132extern const struct SCSISense sense_code_LUN_NOT_SUPPORTED;
133/* Command aborted, I/O process terminated */
134extern const struct SCSISense sense_code_IO_ERROR;
135/* Command aborted, I_T Nexus loss occurred */
136extern const struct SCSISense sense_code_I_T_NEXUS_LOSS;
137/* Command aborted, Logical Unit failure */
138extern const struct SCSISense sense_code_LUN_FAILURE;
139
140#define SENSE_CODE(x) sense_code_ ## x
141
142int scsi_build_sense(SCSISense sense, uint8_t *buf, int len, int fixed);
143int scsi_sense_valid(SCSISense sense);
144
89b08ae1 145SCSIRequest *scsi_req_alloc(size_t size, SCSIDevice *d, uint32_t tag, uint32_t lun);
fc4f0754 146int32_t scsi_req_enqueue(SCSIRequest *req, uint8_t *buf);
89b08ae1 147void scsi_req_free(SCSIRequest *req);
ad2d30f7
PB
148SCSIRequest *scsi_req_ref(SCSIRequest *req);
149void scsi_req_unref(SCSIRequest *req);
37659e51 150
2ec749cb 151int scsi_req_parse(SCSIRequest *req, uint8_t *buf);
ec766865 152void scsi_req_print(SCSIRequest *req);
ab9adc88 153void scsi_req_data(SCSIRequest *req, int len);
ed3a34a3 154void scsi_req_complete(SCSIRequest *req);
19d110ab 155void scsi_req_abort(SCSIRequest *req, int status);
94d3f98a 156void scsi_req_cancel(SCSIRequest *req);
c557e889 157void scsi_device_purge_requests(SCSIDevice *sdev);
89b08ae1 158
43b443b6 159#endif