The function scsi_bus_new() creates a new SCSI bus; callers can either pass in a name argument to specify the name of the new bus, or they can pass in NULL to allow the bus to be given an automatically generated unique name. Almost all callers want to use the autogenerated name; the only exception is the virtio-scsi device. Taking a name argument that should almost always be NULL is an easy-to-misuse API design -- it encourages callers to think perhaps they should pass in some standard name like "scsi" or "scsi-bus". We don't do this anywhere for SCSI, but we do (incorrectly) do it for other bus types such as i2c. The function name also implies that it will return a newly allocated object, when it in fact does in-place allocation. We more commonly name such functions foo_init(), with foo_new() being the allocate-and-return variant. Replace all the scsi_bus_new() callsites with either: * scsi_bus_init() for the usual case where the caller wants an autogenerated bus name * scsi_bus_init_named() for the rare case where the caller needs to specify the bus name and document that for the _named() version it's then the caller's responsibility to think about uniqueness of bus names. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com> Reviewed-by: Michael S. Tsirkin <mst@redhat.com> Acked-by: Paolo Bonzini <pbonzini@redhat.com> Message-id: 20210923121153.23754-2-peter.maydell@linaro.org
230 lines
8 KiB
C
230 lines
8 KiB
C
#ifndef QEMU_HW_SCSI_H
|
|
#define QEMU_HW_SCSI_H
|
|
|
|
#include "block/aio.h"
|
|
#include "hw/block/block.h"
|
|
#include "hw/qdev-core.h"
|
|
#include "scsi/utils.h"
|
|
#include "qemu/notify.h"
|
|
#include "qom/object.h"
|
|
|
|
#define MAX_SCSI_DEVS 255
|
|
|
|
typedef struct SCSIBus SCSIBus;
|
|
typedef struct SCSIBusInfo SCSIBusInfo;
|
|
typedef struct SCSIDevice SCSIDevice;
|
|
typedef struct SCSIRequest SCSIRequest;
|
|
typedef struct SCSIReqOps SCSIReqOps;
|
|
|
|
#define SCSI_SENSE_BUF_SIZE_OLD 96
|
|
#define SCSI_SENSE_BUF_SIZE 252
|
|
#define DEFAULT_IO_TIMEOUT 30
|
|
|
|
struct SCSIRequest {
|
|
SCSIBus *bus;
|
|
SCSIDevice *dev;
|
|
const SCSIReqOps *ops;
|
|
uint32_t refcount;
|
|
uint32_t tag;
|
|
uint32_t lun;
|
|
int16_t status;
|
|
int16_t host_status;
|
|
void *hba_private;
|
|
size_t resid;
|
|
SCSICommand cmd;
|
|
NotifierList cancel_notifiers;
|
|
|
|
/* Note:
|
|
* - fields before sense are initialized by scsi_req_alloc;
|
|
* - sense[] is uninitialized;
|
|
* - fields after sense are memset to 0 by scsi_req_alloc.
|
|
* */
|
|
|
|
uint8_t sense[SCSI_SENSE_BUF_SIZE];
|
|
uint32_t sense_len;
|
|
bool enqueued;
|
|
bool io_canceled;
|
|
bool retry;
|
|
bool dma_started;
|
|
BlockAIOCB *aiocb;
|
|
QEMUSGList *sg;
|
|
QTAILQ_ENTRY(SCSIRequest) next;
|
|
};
|
|
|
|
#define TYPE_SCSI_DEVICE "scsi-device"
|
|
OBJECT_DECLARE_TYPE(SCSIDevice, SCSIDeviceClass, SCSI_DEVICE)
|
|
|
|
struct SCSIDeviceClass {
|
|
DeviceClass parent_class;
|
|
void (*realize)(SCSIDevice *dev, Error **errp);
|
|
void (*unrealize)(SCSIDevice *dev);
|
|
int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
|
|
void *hba_private);
|
|
SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun,
|
|
uint8_t *buf, void *hba_private);
|
|
void (*unit_attention_reported)(SCSIDevice *s);
|
|
};
|
|
|
|
struct SCSIDevice
|
|
{
|
|
DeviceState qdev;
|
|
VMChangeStateEntry *vmsentry;
|
|
QEMUBH *bh;
|
|
uint32_t id;
|
|
BlockConf conf;
|
|
SCSISense unit_attention;
|
|
bool sense_is_ua;
|
|
uint8_t sense[SCSI_SENSE_BUF_SIZE];
|
|
uint32_t sense_len;
|
|
QTAILQ_HEAD(, SCSIRequest) requests;
|
|
uint32_t channel;
|
|
uint32_t lun;
|
|
int blocksize;
|
|
int type;
|
|
uint64_t max_lba;
|
|
uint64_t wwn;
|
|
uint64_t port_wwn;
|
|
int scsi_version;
|
|
int default_scsi_version;
|
|
uint32_t io_timeout;
|
|
bool needs_vpd_bl_emulation;
|
|
bool hba_supports_iothread;
|
|
};
|
|
|
|
extern const VMStateDescription vmstate_scsi_device;
|
|
|
|
#define VMSTATE_SCSI_DEVICE(_field, _state) { \
|
|
.name = (stringify(_field)), \
|
|
.size = sizeof(SCSIDevice), \
|
|
.vmsd = &vmstate_scsi_device, \
|
|
.flags = VMS_STRUCT, \
|
|
.offset = vmstate_offset_value(_state, _field, SCSIDevice), \
|
|
}
|
|
|
|
/* cdrom.c */
|
|
int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track);
|
|
int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num);
|
|
|
|
/* scsi-bus.c */
|
|
struct SCSIReqOps {
|
|
size_t size;
|
|
void (*free_req)(SCSIRequest *req);
|
|
int32_t (*send_command)(SCSIRequest *req, uint8_t *buf);
|
|
void (*read_data)(SCSIRequest *req);
|
|
void (*write_data)(SCSIRequest *req);
|
|
uint8_t *(*get_buf)(SCSIRequest *req);
|
|
|
|
void (*save_request)(QEMUFile *f, SCSIRequest *req);
|
|
void (*load_request)(QEMUFile *f, SCSIRequest *req);
|
|
};
|
|
|
|
struct SCSIBusInfo {
|
|
int tcq;
|
|
int max_channel, max_target, max_lun;
|
|
int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
|
|
void *hba_private);
|
|
void (*transfer_data)(SCSIRequest *req, uint32_t arg);
|
|
void (*fail)(SCSIRequest *req);
|
|
void (*complete)(SCSIRequest *req, size_t resid);
|
|
void (*cancel)(SCSIRequest *req);
|
|
void (*change)(SCSIBus *bus, SCSIDevice *dev, SCSISense sense);
|
|
QEMUSGList *(*get_sg_list)(SCSIRequest *req);
|
|
|
|
void (*save_request)(QEMUFile *f, SCSIRequest *req);
|
|
void *(*load_request)(QEMUFile *f, SCSIRequest *req);
|
|
void (*free_request)(SCSIBus *bus, void *priv);
|
|
};
|
|
|
|
#define TYPE_SCSI_BUS "SCSI"
|
|
OBJECT_DECLARE_SIMPLE_TYPE(SCSIBus, SCSI_BUS)
|
|
|
|
struct SCSIBus {
|
|
BusState qbus;
|
|
int busnr;
|
|
|
|
SCSISense unit_attention;
|
|
const SCSIBusInfo *info;
|
|
};
|
|
|
|
/**
|
|
* scsi_bus_init_named: Initialize a SCSI bus with the specified name
|
|
* @bus: SCSIBus object to initialize
|
|
* @bus_size: size of @bus object
|
|
* @host: Device which owns the bus (generally the SCSI controller)
|
|
* @info: structure defining callbacks etc for the controller
|
|
* @bus_name: Name to use for this bus
|
|
*
|
|
* This in-place initializes @bus as a new SCSI bus with a name
|
|
* provided by the caller. It is the caller's responsibility to make
|
|
* sure that name does not clash with the name of any other bus in the
|
|
* system. Unless you need the new bus to have a specific name, you
|
|
* should use scsi_bus_new() instead.
|
|
*/
|
|
void scsi_bus_init_named(SCSIBus *bus, size_t bus_size, DeviceState *host,
|
|
const SCSIBusInfo *info, const char *bus_name);
|
|
|
|
/**
|
|
* scsi_bus_init: Initialize a SCSI bus
|
|
*
|
|
* This in-place-initializes @bus as a new SCSI bus and gives it
|
|
* an automatically generated unique name.
|
|
*/
|
|
static inline void scsi_bus_init(SCSIBus *bus, size_t bus_size,
|
|
DeviceState *host, const SCSIBusInfo *info)
|
|
{
|
|
scsi_bus_init_named(bus, bus_size, host, info, NULL);
|
|
}
|
|
|
|
static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d)
|
|
{
|
|
return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
|
|
}
|
|
|
|
SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockBackend *blk,
|
|
int unit, bool removable, int bootindex,
|
|
bool share_rw,
|
|
BlockdevOnError rerror,
|
|
BlockdevOnError werror,
|
|
const char *serial, Error **errp);
|
|
void scsi_bus_legacy_handle_cmdline(SCSIBus *bus);
|
|
void scsi_legacy_handle_cmdline(void);
|
|
|
|
SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
|
|
uint32_t tag, uint32_t lun, void *hba_private);
|
|
SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
|
|
uint8_t *buf, void *hba_private);
|
|
int32_t scsi_req_enqueue(SCSIRequest *req);
|
|
SCSIRequest *scsi_req_ref(SCSIRequest *req);
|
|
void scsi_req_unref(SCSIRequest *req);
|
|
|
|
int scsi_bus_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
|
|
void *hba_private);
|
|
int scsi_req_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf);
|
|
void scsi_req_build_sense(SCSIRequest *req, SCSISense sense);
|
|
void scsi_req_print(SCSIRequest *req);
|
|
void scsi_req_continue(SCSIRequest *req);
|
|
void scsi_req_data(SCSIRequest *req, int len);
|
|
void scsi_req_complete(SCSIRequest *req, int status);
|
|
void scsi_req_complete_failed(SCSIRequest *req, int host_status);
|
|
uint8_t *scsi_req_get_buf(SCSIRequest *req);
|
|
int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len);
|
|
void scsi_req_cancel_complete(SCSIRequest *req);
|
|
void scsi_req_cancel(SCSIRequest *req);
|
|
void scsi_req_cancel_async(SCSIRequest *req, Notifier *notifier);
|
|
void scsi_req_retry(SCSIRequest *req);
|
|
void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense);
|
|
void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense);
|
|
void scsi_device_report_change(SCSIDevice *dev, SCSISense sense);
|
|
void scsi_device_unit_attention_reported(SCSIDevice *dev);
|
|
void scsi_generic_read_device_inquiry(SCSIDevice *dev);
|
|
int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed);
|
|
int scsi_SG_IO_FROM_DEV(BlockBackend *blk, uint8_t *cmd, uint8_t cmd_size,
|
|
uint8_t *buf, uint8_t buf_size, uint32_t timeout);
|
|
SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun);
|
|
SCSIDevice *scsi_device_get(SCSIBus *bus, int channel, int target, int lun);
|
|
|
|
/* scsi-generic.c. */
|
|
extern const SCSIReqOps scsi_generic_req_ops;
|
|
|
|
#endif
|