xref: /openbmc/qemu/hw/usb/dev-uas.c (revision b69c3c21)
10f58f68bSGerd Hoffmann /*
20f58f68bSGerd Hoffmann  * UAS (USB Attached SCSI) emulation
30f58f68bSGerd Hoffmann  *
40f58f68bSGerd Hoffmann  * Copyright Red Hat, Inc. 2012
50f58f68bSGerd Hoffmann  *
60f58f68bSGerd Hoffmann  * Author: Gerd Hoffmann <kraxel@redhat.com>
70f58f68bSGerd Hoffmann  *
80f58f68bSGerd Hoffmann  * This work is licensed under the terms of the GNU GPL, version 2 or later.
90f58f68bSGerd Hoffmann  * See the COPYING file in the top-level directory.
100f58f68bSGerd Hoffmann  */
110f58f68bSGerd Hoffmann 
12e532b2e0SPeter Maydell #include "qemu/osdep.h"
131de7afc9SPaolo Bonzini #include "qemu/option.h"
141de7afc9SPaolo Bonzini #include "qemu/config-file.h"
150f58f68bSGerd Hoffmann #include "trace.h"
166b7afb7fSGonglei #include "qemu/error-report.h"
17db725815SMarkus Armbruster #include "qemu/main-loop.h"
180b8fa32fSMarkus Armbruster #include "qemu/module.h"
190f58f68bSGerd Hoffmann 
200f58f68bSGerd Hoffmann #include "hw/usb.h"
21d6454270SMarkus Armbruster #include "migration/vmstate.h"
22463581a8SMichael S. Tsirkin #include "desc.h"
23a27bd6c7SMarkus Armbruster #include "hw/qdev-properties.h"
240d09e41aSPaolo Bonzini #include "hw/scsi/scsi.h"
2508e2c9f1SPaolo Bonzini #include "scsi/constants.h"
260f58f68bSGerd Hoffmann 
270f58f68bSGerd Hoffmann /* --------------------------------------------------------------------- */
280f58f68bSGerd Hoffmann 
290f58f68bSGerd Hoffmann #define UAS_UI_COMMAND              0x01
300f58f68bSGerd Hoffmann #define UAS_UI_SENSE                0x03
310f58f68bSGerd Hoffmann #define UAS_UI_RESPONSE             0x04
320f58f68bSGerd Hoffmann #define UAS_UI_TASK_MGMT            0x05
330f58f68bSGerd Hoffmann #define UAS_UI_READ_READY           0x06
340f58f68bSGerd Hoffmann #define UAS_UI_WRITE_READY          0x07
350f58f68bSGerd Hoffmann 
360f58f68bSGerd Hoffmann #define UAS_RC_TMF_COMPLETE         0x00
370f58f68bSGerd Hoffmann #define UAS_RC_INVALID_INFO_UNIT    0x02
380f58f68bSGerd Hoffmann #define UAS_RC_TMF_NOT_SUPPORTED    0x04
390f58f68bSGerd Hoffmann #define UAS_RC_TMF_FAILED           0x05
400f58f68bSGerd Hoffmann #define UAS_RC_TMF_SUCCEEDED        0x08
410f58f68bSGerd Hoffmann #define UAS_RC_INCORRECT_LUN        0x09
420f58f68bSGerd Hoffmann #define UAS_RC_OVERLAPPED_TAG       0x0a
430f58f68bSGerd Hoffmann 
440f58f68bSGerd Hoffmann #define UAS_TMF_ABORT_TASK          0x01
450f58f68bSGerd Hoffmann #define UAS_TMF_ABORT_TASK_SET      0x02
460f58f68bSGerd Hoffmann #define UAS_TMF_CLEAR_TASK_SET      0x04
470f58f68bSGerd Hoffmann #define UAS_TMF_LOGICAL_UNIT_RESET  0x08
480f58f68bSGerd Hoffmann #define UAS_TMF_I_T_NEXUS_RESET     0x10
490f58f68bSGerd Hoffmann #define UAS_TMF_CLEAR_ACA           0x40
500f58f68bSGerd Hoffmann #define UAS_TMF_QUERY_TASK          0x80
510f58f68bSGerd Hoffmann #define UAS_TMF_QUERY_TASK_SET      0x81
520f58f68bSGerd Hoffmann #define UAS_TMF_QUERY_ASYNC_EVENT   0x82
530f58f68bSGerd Hoffmann 
540f58f68bSGerd Hoffmann #define UAS_PIPE_ID_COMMAND         0x01
550f58f68bSGerd Hoffmann #define UAS_PIPE_ID_STATUS          0x02
560f58f68bSGerd Hoffmann #define UAS_PIPE_ID_DATA_IN         0x03
570f58f68bSGerd Hoffmann #define UAS_PIPE_ID_DATA_OUT        0x04
580f58f68bSGerd Hoffmann 
590f58f68bSGerd Hoffmann typedef struct {
600f58f68bSGerd Hoffmann     uint8_t    id;
610f58f68bSGerd Hoffmann     uint8_t    reserved;
620f58f68bSGerd Hoffmann     uint16_t   tag;
635007c940SHans de Goede } QEMU_PACKED  uas_iu_header;
640f58f68bSGerd Hoffmann 
650f58f68bSGerd Hoffmann typedef struct {
660f58f68bSGerd Hoffmann     uint8_t    prio_taskattr;   /* 6:3 priority, 2:0 task attribute   */
670f58f68bSGerd Hoffmann     uint8_t    reserved_1;
680f58f68bSGerd Hoffmann     uint8_t    add_cdb_length;  /* 7:2 additional adb length (dwords) */
690f58f68bSGerd Hoffmann     uint8_t    reserved_2;
700f58f68bSGerd Hoffmann     uint64_t   lun;
710f58f68bSGerd Hoffmann     uint8_t    cdb[16];
720f58f68bSGerd Hoffmann     uint8_t    add_cdb[];
735007c940SHans de Goede } QEMU_PACKED  uas_iu_command;
740f58f68bSGerd Hoffmann 
750f58f68bSGerd Hoffmann typedef struct {
760f58f68bSGerd Hoffmann     uint16_t   status_qualifier;
770f58f68bSGerd Hoffmann     uint8_t    status;
780f58f68bSGerd Hoffmann     uint8_t    reserved[7];
790f58f68bSGerd Hoffmann     uint16_t   sense_length;
800f58f68bSGerd Hoffmann     uint8_t    sense_data[18];
815007c940SHans de Goede } QEMU_PACKED  uas_iu_sense;
820f58f68bSGerd Hoffmann 
830f58f68bSGerd Hoffmann typedef struct {
8449cfa2fdSHans de Goede     uint8_t    add_response_info[3];
850f58f68bSGerd Hoffmann     uint8_t    response_code;
865007c940SHans de Goede } QEMU_PACKED  uas_iu_response;
870f58f68bSGerd Hoffmann 
880f58f68bSGerd Hoffmann typedef struct {
890f58f68bSGerd Hoffmann     uint8_t    function;
900f58f68bSGerd Hoffmann     uint8_t    reserved;
910f58f68bSGerd Hoffmann     uint16_t   task_tag;
920f58f68bSGerd Hoffmann     uint64_t   lun;
935007c940SHans de Goede } QEMU_PACKED  uas_iu_task_mgmt;
940f58f68bSGerd Hoffmann 
950f58f68bSGerd Hoffmann typedef struct {
965007c940SHans de Goede     uas_iu_header  hdr;
970f58f68bSGerd Hoffmann     union {
985007c940SHans de Goede         uas_iu_command   command;
995007c940SHans de Goede         uas_iu_sense     sense;
1005007c940SHans de Goede         uas_iu_task_mgmt task;
1015007c940SHans de Goede         uas_iu_response  response;
1020f58f68bSGerd Hoffmann     };
1035007c940SHans de Goede } QEMU_PACKED  uas_iu;
1040f58f68bSGerd Hoffmann 
1050f58f68bSGerd Hoffmann /* --------------------------------------------------------------------- */
1060f58f68bSGerd Hoffmann 
10789a453d4SGerd Hoffmann #define UAS_STREAM_BM_ATTR  4
10889a453d4SGerd Hoffmann #define UAS_MAX_STREAMS     (1 << UAS_STREAM_BM_ATTR)
10989a453d4SGerd Hoffmann 
1100f58f68bSGerd Hoffmann typedef struct UASDevice UASDevice;
1110f58f68bSGerd Hoffmann typedef struct UASRequest UASRequest;
1120f58f68bSGerd Hoffmann typedef struct UASStatus UASStatus;
1130f58f68bSGerd Hoffmann 
1140f58f68bSGerd Hoffmann struct UASDevice {
1150f58f68bSGerd Hoffmann     USBDevice                 dev;
1160f58f68bSGerd Hoffmann     SCSIBus                   bus;
1170f58f68bSGerd Hoffmann     QEMUBH                    *status_bh;
1180f58f68bSGerd Hoffmann     QTAILQ_HEAD(, UASStatus)  results;
1190f58f68bSGerd Hoffmann     QTAILQ_HEAD(, UASRequest) requests;
12089a453d4SGerd Hoffmann 
1211556a8fcSGerd Hoffmann     /* properties */
1221556a8fcSGerd Hoffmann     uint32_t                  requestlog;
1231556a8fcSGerd Hoffmann 
12489a453d4SGerd Hoffmann     /* usb 2.0 only */
12589a453d4SGerd Hoffmann     USBPacket                 *status2;
12689a453d4SGerd Hoffmann     UASRequest                *datain2;
12789a453d4SGerd Hoffmann     UASRequest                *dataout2;
12889a453d4SGerd Hoffmann 
12989a453d4SGerd Hoffmann     /* usb 3.0 only */
1300478661eSHans de Goede     USBPacket                 *data3[UAS_MAX_STREAMS + 1];
1310478661eSHans de Goede     USBPacket                 *status3[UAS_MAX_STREAMS + 1];
1320f58f68bSGerd Hoffmann };
1330f58f68bSGerd Hoffmann 
1340b06d099SGonglei #define TYPE_USB_UAS "usb-uas"
1350b06d099SGonglei #define USB_UAS(obj) OBJECT_CHECK(UASDevice, (obj), TYPE_USB_UAS)
1360b06d099SGonglei 
1370f58f68bSGerd Hoffmann struct UASRequest {
1380f58f68bSGerd Hoffmann     uint16_t     tag;
1390f58f68bSGerd Hoffmann     uint64_t     lun;
1400f58f68bSGerd Hoffmann     UASDevice    *uas;
1410f58f68bSGerd Hoffmann     SCSIDevice   *dev;
1420f58f68bSGerd Hoffmann     SCSIRequest  *req;
1430f58f68bSGerd Hoffmann     USBPacket    *data;
1440f58f68bSGerd Hoffmann     bool         data_async;
1450f58f68bSGerd Hoffmann     bool         active;
1460f58f68bSGerd Hoffmann     bool         complete;
1470f58f68bSGerd Hoffmann     uint32_t     buf_off;
1480f58f68bSGerd Hoffmann     uint32_t     buf_size;
1490f58f68bSGerd Hoffmann     uint32_t     data_off;
1500f58f68bSGerd Hoffmann     uint32_t     data_size;
1510f58f68bSGerd Hoffmann     QTAILQ_ENTRY(UASRequest)  next;
1520f58f68bSGerd Hoffmann };
1530f58f68bSGerd Hoffmann 
1540f58f68bSGerd Hoffmann struct UASStatus {
15589a453d4SGerd Hoffmann     uint32_t                  stream;
1565007c940SHans de Goede     uas_iu                    status;
1570f58f68bSGerd Hoffmann     uint32_t                  length;
1580f58f68bSGerd Hoffmann     QTAILQ_ENTRY(UASStatus)   next;
1590f58f68bSGerd Hoffmann };
1600f58f68bSGerd Hoffmann 
1610f58f68bSGerd Hoffmann /* --------------------------------------------------------------------- */
1620f58f68bSGerd Hoffmann 
1630f58f68bSGerd Hoffmann enum {
1640f58f68bSGerd Hoffmann     STR_MANUFACTURER = 1,
1650f58f68bSGerd Hoffmann     STR_PRODUCT,
1660f58f68bSGerd Hoffmann     STR_SERIALNUMBER,
1670f58f68bSGerd Hoffmann     STR_CONFIG_HIGH,
16889a453d4SGerd Hoffmann     STR_CONFIG_SUPER,
1690f58f68bSGerd Hoffmann };
1700f58f68bSGerd Hoffmann 
1710f58f68bSGerd Hoffmann static const USBDescStrings desc_strings = {
1720f58f68bSGerd Hoffmann     [STR_MANUFACTURER] = "QEMU",
1730f58f68bSGerd Hoffmann     [STR_PRODUCT]      = "USB Attached SCSI HBA",
1740f58f68bSGerd Hoffmann     [STR_SERIALNUMBER] = "27842",
1750f58f68bSGerd Hoffmann     [STR_CONFIG_HIGH]  = "High speed config (usb 2.0)",
17689a453d4SGerd Hoffmann     [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
1770f58f68bSGerd Hoffmann };
1780f58f68bSGerd Hoffmann 
1790f58f68bSGerd Hoffmann static const USBDescIface desc_iface_high = {
1800f58f68bSGerd Hoffmann     .bInterfaceNumber              = 0,
1810f58f68bSGerd Hoffmann     .bNumEndpoints                 = 4,
1820f58f68bSGerd Hoffmann     .bInterfaceClass               = USB_CLASS_MASS_STORAGE,
1830f58f68bSGerd Hoffmann     .bInterfaceSubClass            = 0x06, /* SCSI */
1840f58f68bSGerd Hoffmann     .bInterfaceProtocol            = 0x62, /* UAS  */
1850f58f68bSGerd Hoffmann     .eps = (USBDescEndpoint[]) {
1860f58f68bSGerd Hoffmann         {
1870f58f68bSGerd Hoffmann             .bEndpointAddress      = USB_DIR_OUT | UAS_PIPE_ID_COMMAND,
1880f58f68bSGerd Hoffmann             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
1890f58f68bSGerd Hoffmann             .wMaxPacketSize        = 512,
1900f58f68bSGerd Hoffmann             .extra = (uint8_t[]) {
1910f58f68bSGerd Hoffmann                 0x04,  /*  u8  bLength */
1920f58f68bSGerd Hoffmann                 0x24,  /*  u8  bDescriptorType */
1930f58f68bSGerd Hoffmann                 UAS_PIPE_ID_COMMAND,
1940f58f68bSGerd Hoffmann                 0x00,  /*  u8  bReserved */
1950f58f68bSGerd Hoffmann             },
1960f58f68bSGerd Hoffmann         },{
1970f58f68bSGerd Hoffmann             .bEndpointAddress      = USB_DIR_IN | UAS_PIPE_ID_STATUS,
1980f58f68bSGerd Hoffmann             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
1990f58f68bSGerd Hoffmann             .wMaxPacketSize        = 512,
2000f58f68bSGerd Hoffmann             .extra = (uint8_t[]) {
2010f58f68bSGerd Hoffmann                 0x04,  /*  u8  bLength */
2020f58f68bSGerd Hoffmann                 0x24,  /*  u8  bDescriptorType */
2030f58f68bSGerd Hoffmann                 UAS_PIPE_ID_STATUS,
2040f58f68bSGerd Hoffmann                 0x00,  /*  u8  bReserved */
2050f58f68bSGerd Hoffmann             },
2060f58f68bSGerd Hoffmann         },{
2070f58f68bSGerd Hoffmann             .bEndpointAddress      = USB_DIR_IN | UAS_PIPE_ID_DATA_IN,
2080f58f68bSGerd Hoffmann             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
2090f58f68bSGerd Hoffmann             .wMaxPacketSize        = 512,
2100f58f68bSGerd Hoffmann             .extra = (uint8_t[]) {
2110f58f68bSGerd Hoffmann                 0x04,  /*  u8  bLength */
2120f58f68bSGerd Hoffmann                 0x24,  /*  u8  bDescriptorType */
2130f58f68bSGerd Hoffmann                 UAS_PIPE_ID_DATA_IN,
2140f58f68bSGerd Hoffmann                 0x00,  /*  u8  bReserved */
2150f58f68bSGerd Hoffmann             },
2160f58f68bSGerd Hoffmann         },{
2170f58f68bSGerd Hoffmann             .bEndpointAddress      = USB_DIR_OUT | UAS_PIPE_ID_DATA_OUT,
2180f58f68bSGerd Hoffmann             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
2190f58f68bSGerd Hoffmann             .wMaxPacketSize        = 512,
2200f58f68bSGerd Hoffmann             .extra = (uint8_t[]) {
2210f58f68bSGerd Hoffmann                 0x04,  /*  u8  bLength */
2220f58f68bSGerd Hoffmann                 0x24,  /*  u8  bDescriptorType */
2230f58f68bSGerd Hoffmann                 UAS_PIPE_ID_DATA_OUT,
2240f58f68bSGerd Hoffmann                 0x00,  /*  u8  bReserved */
2250f58f68bSGerd Hoffmann             },
2260f58f68bSGerd Hoffmann         },
2270f58f68bSGerd Hoffmann     }
2280f58f68bSGerd Hoffmann };
2290f58f68bSGerd Hoffmann 
23089a453d4SGerd Hoffmann static const USBDescIface desc_iface_super = {
23189a453d4SGerd Hoffmann     .bInterfaceNumber              = 0,
23289a453d4SGerd Hoffmann     .bNumEndpoints                 = 4,
23389a453d4SGerd Hoffmann     .bInterfaceClass               = USB_CLASS_MASS_STORAGE,
23489a453d4SGerd Hoffmann     .bInterfaceSubClass            = 0x06, /* SCSI */
23589a453d4SGerd Hoffmann     .bInterfaceProtocol            = 0x62, /* UAS  */
23689a453d4SGerd Hoffmann     .eps = (USBDescEndpoint[]) {
23789a453d4SGerd Hoffmann         {
23889a453d4SGerd Hoffmann             .bEndpointAddress      = USB_DIR_OUT | UAS_PIPE_ID_COMMAND,
23989a453d4SGerd Hoffmann             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
24089a453d4SGerd Hoffmann             .wMaxPacketSize        = 1024,
24189a453d4SGerd Hoffmann             .bMaxBurst             = 15,
24289a453d4SGerd Hoffmann             .extra = (uint8_t[]) {
24389a453d4SGerd Hoffmann                 0x04,  /*  u8  bLength */
24489a453d4SGerd Hoffmann                 0x24,  /*  u8  bDescriptorType */
24589a453d4SGerd Hoffmann                 UAS_PIPE_ID_COMMAND,
24689a453d4SGerd Hoffmann                 0x00,  /*  u8  bReserved */
24789a453d4SGerd Hoffmann             },
24889a453d4SGerd Hoffmann         },{
24989a453d4SGerd Hoffmann             .bEndpointAddress      = USB_DIR_IN | UAS_PIPE_ID_STATUS,
25089a453d4SGerd Hoffmann             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
25189a453d4SGerd Hoffmann             .wMaxPacketSize        = 1024,
25289a453d4SGerd Hoffmann             .bMaxBurst             = 15,
25389a453d4SGerd Hoffmann             .bmAttributes_super    = UAS_STREAM_BM_ATTR,
25489a453d4SGerd Hoffmann             .extra = (uint8_t[]) {
25589a453d4SGerd Hoffmann                 0x04,  /*  u8  bLength */
25689a453d4SGerd Hoffmann                 0x24,  /*  u8  bDescriptorType */
25789a453d4SGerd Hoffmann                 UAS_PIPE_ID_STATUS,
25889a453d4SGerd Hoffmann                 0x00,  /*  u8  bReserved */
25989a453d4SGerd Hoffmann             },
26089a453d4SGerd Hoffmann         },{
26189a453d4SGerd Hoffmann             .bEndpointAddress      = USB_DIR_IN | UAS_PIPE_ID_DATA_IN,
26289a453d4SGerd Hoffmann             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
26389a453d4SGerd Hoffmann             .wMaxPacketSize        = 1024,
26489a453d4SGerd Hoffmann             .bMaxBurst             = 15,
26589a453d4SGerd Hoffmann             .bmAttributes_super    = UAS_STREAM_BM_ATTR,
26689a453d4SGerd Hoffmann             .extra = (uint8_t[]) {
26789a453d4SGerd Hoffmann                 0x04,  /*  u8  bLength */
26889a453d4SGerd Hoffmann                 0x24,  /*  u8  bDescriptorType */
26989a453d4SGerd Hoffmann                 UAS_PIPE_ID_DATA_IN,
27089a453d4SGerd Hoffmann                 0x00,  /*  u8  bReserved */
27189a453d4SGerd Hoffmann             },
27289a453d4SGerd Hoffmann         },{
27389a453d4SGerd Hoffmann             .bEndpointAddress      = USB_DIR_OUT | UAS_PIPE_ID_DATA_OUT,
27489a453d4SGerd Hoffmann             .bmAttributes          = USB_ENDPOINT_XFER_BULK,
27589a453d4SGerd Hoffmann             .wMaxPacketSize        = 1024,
27689a453d4SGerd Hoffmann             .bMaxBurst             = 15,
27789a453d4SGerd Hoffmann             .bmAttributes_super    = UAS_STREAM_BM_ATTR,
27889a453d4SGerd Hoffmann             .extra = (uint8_t[]) {
27989a453d4SGerd Hoffmann                 0x04,  /*  u8  bLength */
28089a453d4SGerd Hoffmann                 0x24,  /*  u8  bDescriptorType */
28189a453d4SGerd Hoffmann                 UAS_PIPE_ID_DATA_OUT,
28289a453d4SGerd Hoffmann                 0x00,  /*  u8  bReserved */
28389a453d4SGerd Hoffmann             },
28489a453d4SGerd Hoffmann         },
28589a453d4SGerd Hoffmann     }
28689a453d4SGerd Hoffmann };
28789a453d4SGerd Hoffmann 
2880f58f68bSGerd Hoffmann static const USBDescDevice desc_device_high = {
2890f58f68bSGerd Hoffmann     .bcdUSB                        = 0x0200,
2900f58f68bSGerd Hoffmann     .bMaxPacketSize0               = 64,
2910f58f68bSGerd Hoffmann     .bNumConfigurations            = 1,
2920f58f68bSGerd Hoffmann     .confs = (USBDescConfig[]) {
2930f58f68bSGerd Hoffmann         {
2940f58f68bSGerd Hoffmann             .bNumInterfaces        = 1,
2950f58f68bSGerd Hoffmann             .bConfigurationValue   = 1,
2960f58f68bSGerd Hoffmann             .iConfiguration        = STR_CONFIG_HIGH,
297bd93976aSPantelis Koukousoulas             .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
2980f58f68bSGerd Hoffmann             .nif = 1,
2990f58f68bSGerd Hoffmann             .ifs = &desc_iface_high,
3000f58f68bSGerd Hoffmann         },
3010f58f68bSGerd Hoffmann     },
3020f58f68bSGerd Hoffmann };
3030f58f68bSGerd Hoffmann 
30489a453d4SGerd Hoffmann static const USBDescDevice desc_device_super = {
30589a453d4SGerd Hoffmann     .bcdUSB                        = 0x0300,
3068ddcc435SGerd Hoffmann     .bMaxPacketSize0               = 9,
30789a453d4SGerd Hoffmann     .bNumConfigurations            = 1,
30889a453d4SGerd Hoffmann     .confs = (USBDescConfig[]) {
30989a453d4SGerd Hoffmann         {
31089a453d4SGerd Hoffmann             .bNumInterfaces        = 1,
31189a453d4SGerd Hoffmann             .bConfigurationValue   = 1,
31289a453d4SGerd Hoffmann             .iConfiguration        = STR_CONFIG_SUPER,
313bd93976aSPantelis Koukousoulas             .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER,
31489a453d4SGerd Hoffmann             .nif = 1,
31589a453d4SGerd Hoffmann             .ifs = &desc_iface_super,
31689a453d4SGerd Hoffmann         },
31789a453d4SGerd Hoffmann     },
31889a453d4SGerd Hoffmann };
31989a453d4SGerd Hoffmann 
3200f58f68bSGerd Hoffmann static const USBDesc desc = {
3210f58f68bSGerd Hoffmann     .id = {
3220f58f68bSGerd Hoffmann         .idVendor          = 0x46f4, /* CRC16() of "QEMU" */
3230daf5304SGerd Hoffmann         .idProduct         = 0x0003,
3240f58f68bSGerd Hoffmann         .bcdDevice         = 0,
3250f58f68bSGerd Hoffmann         .iManufacturer     = STR_MANUFACTURER,
3260f58f68bSGerd Hoffmann         .iProduct          = STR_PRODUCT,
3270f58f68bSGerd Hoffmann         .iSerialNumber     = STR_SERIALNUMBER,
3280f58f68bSGerd Hoffmann     },
3290f58f68bSGerd Hoffmann     .high  = &desc_device_high,
33089a453d4SGerd Hoffmann     .super = &desc_device_super,
3310f58f68bSGerd Hoffmann     .str   = desc_strings,
3320f58f68bSGerd Hoffmann };
3330f58f68bSGerd Hoffmann 
3340f58f68bSGerd Hoffmann /* --------------------------------------------------------------------- */
3350f58f68bSGerd Hoffmann 
33689a453d4SGerd Hoffmann static bool uas_using_streams(UASDevice *uas)
33789a453d4SGerd Hoffmann {
33889a453d4SGerd Hoffmann     return uas->dev.speed == USB_SPEED_SUPER;
33989a453d4SGerd Hoffmann }
34089a453d4SGerd Hoffmann 
34189a453d4SGerd Hoffmann /* --------------------------------------------------------------------- */
34289a453d4SGerd Hoffmann 
34389a453d4SGerd Hoffmann static UASStatus *usb_uas_alloc_status(UASDevice *uas, uint8_t id, uint16_t tag)
3440f58f68bSGerd Hoffmann {
3450f58f68bSGerd Hoffmann     UASStatus *st = g_new0(UASStatus, 1);
3460f58f68bSGerd Hoffmann 
3470f58f68bSGerd Hoffmann     st->status.hdr.id = id;
3480f58f68bSGerd Hoffmann     st->status.hdr.tag = cpu_to_be16(tag);
3495007c940SHans de Goede     st->length = sizeof(uas_iu_header);
35089a453d4SGerd Hoffmann     if (uas_using_streams(uas)) {
35189a453d4SGerd Hoffmann         st->stream = tag;
35289a453d4SGerd Hoffmann     }
3530f58f68bSGerd Hoffmann     return st;
3540f58f68bSGerd Hoffmann }
3550f58f68bSGerd Hoffmann 
3560f58f68bSGerd Hoffmann static void usb_uas_send_status_bh(void *opaque)
3570f58f68bSGerd Hoffmann {
3580f58f68bSGerd Hoffmann     UASDevice *uas = opaque;
35989a453d4SGerd Hoffmann     UASStatus *st;
36089a453d4SGerd Hoffmann     USBPacket *p;
3610f58f68bSGerd Hoffmann 
36289a453d4SGerd Hoffmann     while ((st = QTAILQ_FIRST(&uas->results)) != NULL) {
36389a453d4SGerd Hoffmann         if (uas_using_streams(uas)) {
36489a453d4SGerd Hoffmann             p = uas->status3[st->stream];
36589a453d4SGerd Hoffmann             uas->status3[st->stream] = NULL;
36689a453d4SGerd Hoffmann         } else {
36789a453d4SGerd Hoffmann             p = uas->status2;
36889a453d4SGerd Hoffmann             uas->status2 = NULL;
36989a453d4SGerd Hoffmann         }
37089a453d4SGerd Hoffmann         if (p == NULL) {
37189a453d4SGerd Hoffmann             break;
37289a453d4SGerd Hoffmann         }
3730f58f68bSGerd Hoffmann 
3740f58f68bSGerd Hoffmann         usb_packet_copy(p, &st->status, st->length);
3750f58f68bSGerd Hoffmann         QTAILQ_REMOVE(&uas->results, st, next);
3760f58f68bSGerd Hoffmann         g_free(st);
3770f58f68bSGerd Hoffmann 
3789a77a0f5SHans de Goede         p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
3790f58f68bSGerd Hoffmann         usb_packet_complete(&uas->dev, p);
3800f58f68bSGerd Hoffmann     }
38189a453d4SGerd Hoffmann }
3820f58f68bSGerd Hoffmann 
3830f58f68bSGerd Hoffmann static void usb_uas_queue_status(UASDevice *uas, UASStatus *st, int length)
3840f58f68bSGerd Hoffmann {
38589a453d4SGerd Hoffmann     USBPacket *p = uas_using_streams(uas) ?
38689a453d4SGerd Hoffmann         uas->status3[st->stream] : uas->status2;
38789a453d4SGerd Hoffmann 
3880f58f68bSGerd Hoffmann     st->length += length;
3890f58f68bSGerd Hoffmann     QTAILQ_INSERT_TAIL(&uas->results, st, next);
39089a453d4SGerd Hoffmann     if (p) {
3910f58f68bSGerd Hoffmann         /*
3920f58f68bSGerd Hoffmann          * Just schedule bh make sure any in-flight data transaction
3930f58f68bSGerd Hoffmann          * is finished before completing (sending) the status packet.
3940f58f68bSGerd Hoffmann          */
3950f58f68bSGerd Hoffmann         qemu_bh_schedule(uas->status_bh);
3960f58f68bSGerd Hoffmann     } else {
3970f58f68bSGerd Hoffmann         USBEndpoint *ep = usb_ep_get(&uas->dev, USB_TOKEN_IN,
3980f58f68bSGerd Hoffmann                                      UAS_PIPE_ID_STATUS);
39989a453d4SGerd Hoffmann         usb_wakeup(ep, st->stream);
4000f58f68bSGerd Hoffmann     }
4010f58f68bSGerd Hoffmann }
4020f58f68bSGerd Hoffmann 
40349cfa2fdSHans de Goede static void usb_uas_queue_response(UASDevice *uas, uint16_t tag, uint8_t code)
4040f58f68bSGerd Hoffmann {
40589a453d4SGerd Hoffmann     UASStatus *st = usb_uas_alloc_status(uas, UAS_UI_RESPONSE, tag);
4060f58f68bSGerd Hoffmann 
4070f58f68bSGerd Hoffmann     trace_usb_uas_response(uas->dev.addr, tag, code);
4080f58f68bSGerd Hoffmann     st->status.response.response_code = code;
4095007c940SHans de Goede     usb_uas_queue_status(uas, st, sizeof(uas_iu_response));
4100f58f68bSGerd Hoffmann }
4110f58f68bSGerd Hoffmann 
4120f58f68bSGerd Hoffmann static void usb_uas_queue_sense(UASRequest *req, uint8_t status)
4130f58f68bSGerd Hoffmann {
41489a453d4SGerd Hoffmann     UASStatus *st = usb_uas_alloc_status(req->uas, UAS_UI_SENSE, req->tag);
4150f58f68bSGerd Hoffmann     int len, slen = 0;
4160f58f68bSGerd Hoffmann 
4170f58f68bSGerd Hoffmann     trace_usb_uas_sense(req->uas->dev.addr, req->tag, status);
4180f58f68bSGerd Hoffmann     st->status.sense.status = status;
4190f58f68bSGerd Hoffmann     st->status.sense.status_qualifier = cpu_to_be16(0);
4200f58f68bSGerd Hoffmann     if (status != GOOD) {
4210f58f68bSGerd Hoffmann         slen = scsi_req_get_sense(req->req, st->status.sense.sense_data,
4220f58f68bSGerd Hoffmann                                   sizeof(st->status.sense.sense_data));
4230f58f68bSGerd Hoffmann         st->status.sense.sense_length = cpu_to_be16(slen);
4240f58f68bSGerd Hoffmann     }
4255007c940SHans de Goede     len = sizeof(uas_iu_sense) - sizeof(st->status.sense.sense_data) + slen;
4260f58f68bSGerd Hoffmann     usb_uas_queue_status(req->uas, st, len);
4270f58f68bSGerd Hoffmann }
4280f58f68bSGerd Hoffmann 
429d4bfc7b9SHans de Goede static void usb_uas_queue_fake_sense(UASDevice *uas, uint16_t tag,
430d4bfc7b9SHans de Goede                                      struct SCSISense sense)
431d4bfc7b9SHans de Goede {
432d4bfc7b9SHans de Goede     UASStatus *st = usb_uas_alloc_status(uas, UAS_UI_SENSE, tag);
433d4bfc7b9SHans de Goede     int len, slen = 0;
434d4bfc7b9SHans de Goede 
435d4bfc7b9SHans de Goede     st->status.sense.status = CHECK_CONDITION;
436d4bfc7b9SHans de Goede     st->status.sense.status_qualifier = cpu_to_be16(0);
437d4bfc7b9SHans de Goede     st->status.sense.sense_data[0] = 0x70;
438d4bfc7b9SHans de Goede     st->status.sense.sense_data[2] = sense.key;
439d4bfc7b9SHans de Goede     st->status.sense.sense_data[7] = 10;
440d4bfc7b9SHans de Goede     st->status.sense.sense_data[12] = sense.asc;
441d4bfc7b9SHans de Goede     st->status.sense.sense_data[13] = sense.ascq;
442d4bfc7b9SHans de Goede     slen = 18;
4435007c940SHans de Goede     len = sizeof(uas_iu_sense) - sizeof(st->status.sense.sense_data) + slen;
444d4bfc7b9SHans de Goede     usb_uas_queue_status(uas, st, len);
445d4bfc7b9SHans de Goede }
446d4bfc7b9SHans de Goede 
4470f58f68bSGerd Hoffmann static void usb_uas_queue_read_ready(UASRequest *req)
4480f58f68bSGerd Hoffmann {
44989a453d4SGerd Hoffmann     UASStatus *st = usb_uas_alloc_status(req->uas, UAS_UI_READ_READY,
45089a453d4SGerd Hoffmann                                          req->tag);
4510f58f68bSGerd Hoffmann 
4520f58f68bSGerd Hoffmann     trace_usb_uas_read_ready(req->uas->dev.addr, req->tag);
4530f58f68bSGerd Hoffmann     usb_uas_queue_status(req->uas, st, 0);
4540f58f68bSGerd Hoffmann }
4550f58f68bSGerd Hoffmann 
4560f58f68bSGerd Hoffmann static void usb_uas_queue_write_ready(UASRequest *req)
4570f58f68bSGerd Hoffmann {
45889a453d4SGerd Hoffmann     UASStatus *st = usb_uas_alloc_status(req->uas, UAS_UI_WRITE_READY,
45989a453d4SGerd Hoffmann                                          req->tag);
4600f58f68bSGerd Hoffmann 
4610f58f68bSGerd Hoffmann     trace_usb_uas_write_ready(req->uas->dev.addr, req->tag);
4620f58f68bSGerd Hoffmann     usb_uas_queue_status(req->uas, st, 0);
4630f58f68bSGerd Hoffmann }
4640f58f68bSGerd Hoffmann 
4650f58f68bSGerd Hoffmann /* --------------------------------------------------------------------- */
4660f58f68bSGerd Hoffmann 
4670f58f68bSGerd Hoffmann static int usb_uas_get_lun(uint64_t lun64)
4680f58f68bSGerd Hoffmann {
4690f58f68bSGerd Hoffmann     return (lun64 >> 48) & 0xff;
4700f58f68bSGerd Hoffmann }
4710f58f68bSGerd Hoffmann 
4720f58f68bSGerd Hoffmann static SCSIDevice *usb_uas_get_dev(UASDevice *uas, uint64_t lun64)
4730f58f68bSGerd Hoffmann {
4740f58f68bSGerd Hoffmann     if ((lun64 >> 56) != 0x00) {
4750f58f68bSGerd Hoffmann         return NULL;
4760f58f68bSGerd Hoffmann     }
4770f58f68bSGerd Hoffmann     return scsi_device_find(&uas->bus, 0, 0, usb_uas_get_lun(lun64));
4780f58f68bSGerd Hoffmann }
4790f58f68bSGerd Hoffmann 
4800f58f68bSGerd Hoffmann static void usb_uas_complete_data_packet(UASRequest *req)
4810f58f68bSGerd Hoffmann {
4820f58f68bSGerd Hoffmann     USBPacket *p;
4830f58f68bSGerd Hoffmann 
4840f58f68bSGerd Hoffmann     if (!req->data_async) {
4850f58f68bSGerd Hoffmann         return;
4860f58f68bSGerd Hoffmann     }
4870f58f68bSGerd Hoffmann     p = req->data;
4880f58f68bSGerd Hoffmann     req->data = NULL;
4890f58f68bSGerd Hoffmann     req->data_async = false;
4909a77a0f5SHans de Goede     p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */
4910f58f68bSGerd Hoffmann     usb_packet_complete(&req->uas->dev, p);
4920f58f68bSGerd Hoffmann }
4930f58f68bSGerd Hoffmann 
4940f58f68bSGerd Hoffmann static void usb_uas_copy_data(UASRequest *req)
4950f58f68bSGerd Hoffmann {
4960f58f68bSGerd Hoffmann     uint32_t length;
4970f58f68bSGerd Hoffmann 
4980f58f68bSGerd Hoffmann     length = MIN(req->buf_size - req->buf_off,
4999a77a0f5SHans de Goede                  req->data->iov.size - req->data->actual_length);
5000f58f68bSGerd Hoffmann     trace_usb_uas_xfer_data(req->uas->dev.addr, req->tag, length,
5019a77a0f5SHans de Goede                             req->data->actual_length, req->data->iov.size,
5020f58f68bSGerd Hoffmann                             req->buf_off, req->buf_size);
5030f58f68bSGerd Hoffmann     usb_packet_copy(req->data, scsi_req_get_buf(req->req) + req->buf_off,
5040f58f68bSGerd Hoffmann                     length);
5050f58f68bSGerd Hoffmann     req->buf_off += length;
5060f58f68bSGerd Hoffmann     req->data_off += length;
5070f58f68bSGerd Hoffmann 
5089a77a0f5SHans de Goede     if (req->data->actual_length == req->data->iov.size) {
5090f58f68bSGerd Hoffmann         usb_uas_complete_data_packet(req);
5100f58f68bSGerd Hoffmann     }
5110f58f68bSGerd Hoffmann     if (req->buf_size && req->buf_off == req->buf_size) {
5120f58f68bSGerd Hoffmann         req->buf_off = 0;
5130f58f68bSGerd Hoffmann         req->buf_size = 0;
5140f58f68bSGerd Hoffmann         scsi_req_continue(req->req);
5150f58f68bSGerd Hoffmann     }
5160f58f68bSGerd Hoffmann }
5170f58f68bSGerd Hoffmann 
5180f58f68bSGerd Hoffmann static void usb_uas_start_next_transfer(UASDevice *uas)
5190f58f68bSGerd Hoffmann {
5200f58f68bSGerd Hoffmann     UASRequest *req;
5210f58f68bSGerd Hoffmann 
52289a453d4SGerd Hoffmann     if (uas_using_streams(uas)) {
52389a453d4SGerd Hoffmann         return;
52489a453d4SGerd Hoffmann     }
52589a453d4SGerd Hoffmann 
5260f58f68bSGerd Hoffmann     QTAILQ_FOREACH(req, &uas->requests, next) {
5270f58f68bSGerd Hoffmann         if (req->active || req->complete) {
5280f58f68bSGerd Hoffmann             continue;
5290f58f68bSGerd Hoffmann         }
53089a453d4SGerd Hoffmann         if (req->req->cmd.mode == SCSI_XFER_FROM_DEV && uas->datain2 == NULL) {
53189a453d4SGerd Hoffmann             uas->datain2 = req;
5320f58f68bSGerd Hoffmann             usb_uas_queue_read_ready(req);
5330f58f68bSGerd Hoffmann             req->active = true;
5340f58f68bSGerd Hoffmann             return;
5350f58f68bSGerd Hoffmann         }
53689a453d4SGerd Hoffmann         if (req->req->cmd.mode == SCSI_XFER_TO_DEV && uas->dataout2 == NULL) {
53789a453d4SGerd Hoffmann             uas->dataout2 = req;
5380f58f68bSGerd Hoffmann             usb_uas_queue_write_ready(req);
5390f58f68bSGerd Hoffmann             req->active = true;
5400f58f68bSGerd Hoffmann             return;
5410f58f68bSGerd Hoffmann         }
5420f58f68bSGerd Hoffmann     }
5430f58f68bSGerd Hoffmann }
5440f58f68bSGerd Hoffmann 
5455007c940SHans de Goede static UASRequest *usb_uas_alloc_request(UASDevice *uas, uas_iu *iu)
5460f58f68bSGerd Hoffmann {
5470f58f68bSGerd Hoffmann     UASRequest *req;
5480f58f68bSGerd Hoffmann 
5490f58f68bSGerd Hoffmann     req = g_new0(UASRequest, 1);
5500f58f68bSGerd Hoffmann     req->uas = uas;
5515007c940SHans de Goede     req->tag = be16_to_cpu(iu->hdr.tag);
5525007c940SHans de Goede     req->lun = be64_to_cpu(iu->command.lun);
5530f58f68bSGerd Hoffmann     req->dev = usb_uas_get_dev(req->uas, req->lun);
5540f58f68bSGerd Hoffmann     return req;
5550f58f68bSGerd Hoffmann }
5560f58f68bSGerd Hoffmann 
5570f58f68bSGerd Hoffmann static void usb_uas_scsi_free_request(SCSIBus *bus, void *priv)
5580f58f68bSGerd Hoffmann {
5590f58f68bSGerd Hoffmann     UASRequest *req = priv;
5600f58f68bSGerd Hoffmann     UASDevice *uas = req->uas;
5610f58f68bSGerd Hoffmann 
56289a453d4SGerd Hoffmann     if (req == uas->datain2) {
56389a453d4SGerd Hoffmann         uas->datain2 = NULL;
5640f58f68bSGerd Hoffmann     }
56589a453d4SGerd Hoffmann     if (req == uas->dataout2) {
56689a453d4SGerd Hoffmann         uas->dataout2 = NULL;
5670f58f68bSGerd Hoffmann     }
5680f58f68bSGerd Hoffmann     QTAILQ_REMOVE(&uas->requests, req, next);
5690f58f68bSGerd Hoffmann     g_free(req);
570347e40ffSGerd Hoffmann     usb_uas_start_next_transfer(uas);
5710f58f68bSGerd Hoffmann }
5720f58f68bSGerd Hoffmann 
5730f58f68bSGerd Hoffmann static UASRequest *usb_uas_find_request(UASDevice *uas, uint16_t tag)
5740f58f68bSGerd Hoffmann {
5750f58f68bSGerd Hoffmann     UASRequest *req;
5760f58f68bSGerd Hoffmann 
5770f58f68bSGerd Hoffmann     QTAILQ_FOREACH(req, &uas->requests, next) {
5780f58f68bSGerd Hoffmann         if (req->tag == tag) {
5790f58f68bSGerd Hoffmann             return req;
5800f58f68bSGerd Hoffmann         }
5810f58f68bSGerd Hoffmann     }
5820f58f68bSGerd Hoffmann     return NULL;
5830f58f68bSGerd Hoffmann }
5840f58f68bSGerd Hoffmann 
5850f58f68bSGerd Hoffmann static void usb_uas_scsi_transfer_data(SCSIRequest *r, uint32_t len)
5860f58f68bSGerd Hoffmann {
5870f58f68bSGerd Hoffmann     UASRequest *req = r->hba_private;
5880f58f68bSGerd Hoffmann 
5890f58f68bSGerd Hoffmann     trace_usb_uas_scsi_data(req->uas->dev.addr, req->tag, len);
5900f58f68bSGerd Hoffmann     req->buf_off = 0;
5910f58f68bSGerd Hoffmann     req->buf_size = len;
5920f58f68bSGerd Hoffmann     if (req->data) {
5930f58f68bSGerd Hoffmann         usb_uas_copy_data(req);
5940f58f68bSGerd Hoffmann     } else {
5950f58f68bSGerd Hoffmann         usb_uas_start_next_transfer(req->uas);
5960f58f68bSGerd Hoffmann     }
5970f58f68bSGerd Hoffmann }
5980f58f68bSGerd Hoffmann 
5990f58f68bSGerd Hoffmann static void usb_uas_scsi_command_complete(SCSIRequest *r,
6000f58f68bSGerd Hoffmann                                           uint32_t status, size_t resid)
6010f58f68bSGerd Hoffmann {
6020f58f68bSGerd Hoffmann     UASRequest *req = r->hba_private;
6030f58f68bSGerd Hoffmann 
6040f58f68bSGerd Hoffmann     trace_usb_uas_scsi_complete(req->uas->dev.addr, req->tag, status, resid);
6050f58f68bSGerd Hoffmann     req->complete = true;
6060f58f68bSGerd Hoffmann     if (req->data) {
6070f58f68bSGerd Hoffmann         usb_uas_complete_data_packet(req);
6080f58f68bSGerd Hoffmann     }
6090f58f68bSGerd Hoffmann     usb_uas_queue_sense(req, status);
6100f58f68bSGerd Hoffmann     scsi_req_unref(req->req);
6110f58f68bSGerd Hoffmann }
6120f58f68bSGerd Hoffmann 
6130f58f68bSGerd Hoffmann static void usb_uas_scsi_request_cancelled(SCSIRequest *r)
6140f58f68bSGerd Hoffmann {
6150f58f68bSGerd Hoffmann     UASRequest *req = r->hba_private;
6160f58f68bSGerd Hoffmann 
6170f58f68bSGerd Hoffmann     /* FIXME: queue notification to status pipe? */
6180f58f68bSGerd Hoffmann     scsi_req_unref(req->req);
6190f58f68bSGerd Hoffmann }
6200f58f68bSGerd Hoffmann 
6210f58f68bSGerd Hoffmann static const struct SCSIBusInfo usb_uas_scsi_info = {
6220f58f68bSGerd Hoffmann     .tcq = true,
6230f58f68bSGerd Hoffmann     .max_target = 0,
6240f58f68bSGerd Hoffmann     .max_lun = 255,
6250f58f68bSGerd Hoffmann 
6260f58f68bSGerd Hoffmann     .transfer_data = usb_uas_scsi_transfer_data,
6270f58f68bSGerd Hoffmann     .complete = usb_uas_scsi_command_complete,
6280f58f68bSGerd Hoffmann     .cancel = usb_uas_scsi_request_cancelled,
6290f58f68bSGerd Hoffmann     .free_request = usb_uas_scsi_free_request,
6300f58f68bSGerd Hoffmann };
6310f58f68bSGerd Hoffmann 
6320f58f68bSGerd Hoffmann /* --------------------------------------------------------------------- */
6330f58f68bSGerd Hoffmann 
6340f58f68bSGerd Hoffmann static void usb_uas_handle_reset(USBDevice *dev)
6350f58f68bSGerd Hoffmann {
6360b06d099SGonglei     UASDevice *uas = USB_UAS(dev);
6370f58f68bSGerd Hoffmann     UASRequest *req, *nreq;
6380f58f68bSGerd Hoffmann     UASStatus *st, *nst;
6390f58f68bSGerd Hoffmann 
6400f58f68bSGerd Hoffmann     trace_usb_uas_reset(dev->addr);
6410f58f68bSGerd Hoffmann     QTAILQ_FOREACH_SAFE(req, &uas->requests, next, nreq) {
6420f58f68bSGerd Hoffmann         scsi_req_cancel(req->req);
6430f58f68bSGerd Hoffmann     }
6440f58f68bSGerd Hoffmann     QTAILQ_FOREACH_SAFE(st, &uas->results, next, nst) {
6450f58f68bSGerd Hoffmann         QTAILQ_REMOVE(&uas->results, st, next);
6460f58f68bSGerd Hoffmann         g_free(st);
6470f58f68bSGerd Hoffmann     }
6480f58f68bSGerd Hoffmann }
6490f58f68bSGerd Hoffmann 
6509a77a0f5SHans de Goede static void usb_uas_handle_control(USBDevice *dev, USBPacket *p,
6510f58f68bSGerd Hoffmann                int request, int value, int index, int length, uint8_t *data)
6520f58f68bSGerd Hoffmann {
6530f58f68bSGerd Hoffmann     int ret;
6540f58f68bSGerd Hoffmann 
6550f58f68bSGerd Hoffmann     ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
6560f58f68bSGerd Hoffmann     if (ret >= 0) {
6579a77a0f5SHans de Goede         return;
6580f58f68bSGerd Hoffmann     }
659e306b2fdSGerd Hoffmann     error_report("%s: unhandled control request (req 0x%x, val 0x%x, idx 0x%x",
660e306b2fdSGerd Hoffmann                  __func__, request, value, index);
6619a77a0f5SHans de Goede     p->status = USB_RET_STALL;
6620f58f68bSGerd Hoffmann }
6630f58f68bSGerd Hoffmann 
6640f58f68bSGerd Hoffmann static void usb_uas_cancel_io(USBDevice *dev, USBPacket *p)
6650f58f68bSGerd Hoffmann {
6660b06d099SGonglei     UASDevice *uas = USB_UAS(dev);
6670f58f68bSGerd Hoffmann     UASRequest *req, *nreq;
66889a453d4SGerd Hoffmann     int i;
6690f58f68bSGerd Hoffmann 
67089a453d4SGerd Hoffmann     if (uas->status2 == p) {
67189a453d4SGerd Hoffmann         uas->status2 = NULL;
6720f58f68bSGerd Hoffmann         qemu_bh_cancel(uas->status_bh);
6730f58f68bSGerd Hoffmann         return;
6740f58f68bSGerd Hoffmann     }
67589a453d4SGerd Hoffmann     if (uas_using_streams(uas)) {
6760478661eSHans de Goede         for (i = 0; i <= UAS_MAX_STREAMS; i++) {
67789a453d4SGerd Hoffmann             if (uas->status3[i] == p) {
67889a453d4SGerd Hoffmann                 uas->status3[i] = NULL;
67989a453d4SGerd Hoffmann                 return;
68089a453d4SGerd Hoffmann             }
68189a453d4SGerd Hoffmann             if (uas->data3[i] == p) {
68289a453d4SGerd Hoffmann                 uas->data3[i] = NULL;
68389a453d4SGerd Hoffmann                 return;
68489a453d4SGerd Hoffmann             }
68589a453d4SGerd Hoffmann         }
68689a453d4SGerd Hoffmann     }
6870f58f68bSGerd Hoffmann     QTAILQ_FOREACH_SAFE(req, &uas->requests, next, nreq) {
6880f58f68bSGerd Hoffmann         if (req->data == p) {
6890f58f68bSGerd Hoffmann             req->data = NULL;
6900f58f68bSGerd Hoffmann             return;
6910f58f68bSGerd Hoffmann         }
6920f58f68bSGerd Hoffmann     }
6930f58f68bSGerd Hoffmann     assert(!"canceled usb packet not found");
6940f58f68bSGerd Hoffmann }
6950f58f68bSGerd Hoffmann 
6965007c940SHans de Goede static void usb_uas_command(UASDevice *uas, uas_iu *iu)
6970f58f68bSGerd Hoffmann {
6980f58f68bSGerd Hoffmann     UASRequest *req;
6990f58f68bSGerd Hoffmann     uint32_t len;
7005007c940SHans de Goede     uint16_t tag = be16_to_cpu(iu->hdr.tag);
7010f58f68bSGerd Hoffmann 
7023453f9a0SHans de Goede     if (uas_using_streams(uas) && tag > UAS_MAX_STREAMS) {
7033453f9a0SHans de Goede         goto invalid_tag;
7043453f9a0SHans de Goede     }
705d4bfc7b9SHans de Goede     req = usb_uas_find_request(uas, tag);
7060f58f68bSGerd Hoffmann     if (req) {
7070f58f68bSGerd Hoffmann         goto overlapped_tag;
7080f58f68bSGerd Hoffmann     }
7095007c940SHans de Goede     req = usb_uas_alloc_request(uas, iu);
7100f58f68bSGerd Hoffmann     if (req->dev == NULL) {
7110f58f68bSGerd Hoffmann         goto bad_target;
7120f58f68bSGerd Hoffmann     }
7130f58f68bSGerd Hoffmann 
7140f58f68bSGerd Hoffmann     trace_usb_uas_command(uas->dev.addr, req->tag,
7150f58f68bSGerd Hoffmann                           usb_uas_get_lun(req->lun),
7160f58f68bSGerd Hoffmann                           req->lun >> 32, req->lun & 0xffffffff);
7170f58f68bSGerd Hoffmann     QTAILQ_INSERT_TAIL(&uas->requests, req, next);
71889a453d4SGerd Hoffmann     if (uas_using_streams(uas) && uas->data3[req->tag] != NULL) {
71989a453d4SGerd Hoffmann         req->data = uas->data3[req->tag];
72089a453d4SGerd Hoffmann         req->data_async = true;
72189a453d4SGerd Hoffmann         uas->data3[req->tag] = NULL;
72289a453d4SGerd Hoffmann     }
72389a453d4SGerd Hoffmann 
7240f58f68bSGerd Hoffmann     req->req = scsi_req_new(req->dev, req->tag,
7250f58f68bSGerd Hoffmann                             usb_uas_get_lun(req->lun),
7265007c940SHans de Goede                             iu->command.cdb, req);
7271556a8fcSGerd Hoffmann     if (uas->requestlog) {
72889a453d4SGerd Hoffmann         scsi_req_print(req->req);
7291556a8fcSGerd Hoffmann     }
7300f58f68bSGerd Hoffmann     len = scsi_req_enqueue(req->req);
7310f58f68bSGerd Hoffmann     if (len) {
7320f58f68bSGerd Hoffmann         req->data_size = len;
7330f58f68bSGerd Hoffmann         scsi_req_continue(req->req);
7340f58f68bSGerd Hoffmann     }
7350f58f68bSGerd Hoffmann     return;
7360f58f68bSGerd Hoffmann 
7373453f9a0SHans de Goede invalid_tag:
7383453f9a0SHans de Goede     usb_uas_queue_fake_sense(uas, tag, sense_code_INVALID_TAG);
7393453f9a0SHans de Goede     return;
7403453f9a0SHans de Goede 
7410f58f68bSGerd Hoffmann overlapped_tag:
742d4bfc7b9SHans de Goede     usb_uas_queue_fake_sense(uas, tag, sense_code_OVERLAPPED_COMMANDS);
7430f58f68bSGerd Hoffmann     return;
7440f58f68bSGerd Hoffmann 
7450f58f68bSGerd Hoffmann bad_target:
746d4bfc7b9SHans de Goede     usb_uas_queue_fake_sense(uas, tag, sense_code_LUN_NOT_SUPPORTED);
7470f58f68bSGerd Hoffmann     g_free(req);
7480f58f68bSGerd Hoffmann }
7490f58f68bSGerd Hoffmann 
7505007c940SHans de Goede static void usb_uas_task(UASDevice *uas, uas_iu *iu)
7510f58f68bSGerd Hoffmann {
7525007c940SHans de Goede     uint16_t tag = be16_to_cpu(iu->hdr.tag);
7535007c940SHans de Goede     uint64_t lun64 = be64_to_cpu(iu->task.lun);
7540f58f68bSGerd Hoffmann     SCSIDevice *dev = usb_uas_get_dev(uas, lun64);
7550f58f68bSGerd Hoffmann     int lun = usb_uas_get_lun(lun64);
7560f58f68bSGerd Hoffmann     UASRequest *req;
7570f58f68bSGerd Hoffmann     uint16_t task_tag;
7580f58f68bSGerd Hoffmann 
7593453f9a0SHans de Goede     if (uas_using_streams(uas) && tag > UAS_MAX_STREAMS) {
7603453f9a0SHans de Goede         goto invalid_tag;
7613453f9a0SHans de Goede     }
7625007c940SHans de Goede     req = usb_uas_find_request(uas, be16_to_cpu(iu->hdr.tag));
7630f58f68bSGerd Hoffmann     if (req) {
7640f58f68bSGerd Hoffmann         goto overlapped_tag;
7650f58f68bSGerd Hoffmann     }
7665eb6d9e3SHans de Goede     if (dev == NULL) {
7675eb6d9e3SHans de Goede         goto incorrect_lun;
7685eb6d9e3SHans de Goede     }
7690f58f68bSGerd Hoffmann 
7705007c940SHans de Goede     switch (iu->task.function) {
7710f58f68bSGerd Hoffmann     case UAS_TMF_ABORT_TASK:
7725007c940SHans de Goede         task_tag = be16_to_cpu(iu->task.task_tag);
7730f58f68bSGerd Hoffmann         trace_usb_uas_tmf_abort_task(uas->dev.addr, tag, task_tag);
7740f58f68bSGerd Hoffmann         req = usb_uas_find_request(uas, task_tag);
7750f58f68bSGerd Hoffmann         if (req && req->dev == dev) {
7760f58f68bSGerd Hoffmann             scsi_req_cancel(req->req);
7770f58f68bSGerd Hoffmann         }
77849cfa2fdSHans de Goede         usb_uas_queue_response(uas, tag, UAS_RC_TMF_COMPLETE);
7790f58f68bSGerd Hoffmann         break;
7800f58f68bSGerd Hoffmann 
7810f58f68bSGerd Hoffmann     case UAS_TMF_LOGICAL_UNIT_RESET:
7820f58f68bSGerd Hoffmann         trace_usb_uas_tmf_logical_unit_reset(uas->dev.addr, tag, lun);
7830f58f68bSGerd Hoffmann         qdev_reset_all(&dev->qdev);
78449cfa2fdSHans de Goede         usb_uas_queue_response(uas, tag, UAS_RC_TMF_COMPLETE);
7850f58f68bSGerd Hoffmann         break;
7860f58f68bSGerd Hoffmann 
7870f58f68bSGerd Hoffmann     default:
7885007c940SHans de Goede         trace_usb_uas_tmf_unsupported(uas->dev.addr, tag, iu->task.function);
78949cfa2fdSHans de Goede         usb_uas_queue_response(uas, tag, UAS_RC_TMF_NOT_SUPPORTED);
7900f58f68bSGerd Hoffmann         break;
7910f58f68bSGerd Hoffmann     }
7920f58f68bSGerd Hoffmann     return;
7930f58f68bSGerd Hoffmann 
7943453f9a0SHans de Goede invalid_tag:
79549cfa2fdSHans de Goede     usb_uas_queue_response(uas, tag, UAS_RC_INVALID_INFO_UNIT);
7963453f9a0SHans de Goede     return;
7973453f9a0SHans de Goede 
7980f58f68bSGerd Hoffmann overlapped_tag:
79949cfa2fdSHans de Goede     usb_uas_queue_response(uas, req->tag, UAS_RC_OVERLAPPED_TAG);
8000f58f68bSGerd Hoffmann     return;
8010f58f68bSGerd Hoffmann 
8020f58f68bSGerd Hoffmann incorrect_lun:
80349cfa2fdSHans de Goede     usb_uas_queue_response(uas, tag, UAS_RC_INCORRECT_LUN);
8040f58f68bSGerd Hoffmann }
8050f58f68bSGerd Hoffmann 
8069a77a0f5SHans de Goede static void usb_uas_handle_data(USBDevice *dev, USBPacket *p)
8070f58f68bSGerd Hoffmann {
8080b06d099SGonglei     UASDevice *uas = USB_UAS(dev);
8095007c940SHans de Goede     uas_iu iu;
8100f58f68bSGerd Hoffmann     UASStatus *st;
8110f58f68bSGerd Hoffmann     UASRequest *req;
8129a77a0f5SHans de Goede     int length;
8130f58f68bSGerd Hoffmann 
8140f58f68bSGerd Hoffmann     switch (p->ep->nr) {
8150f58f68bSGerd Hoffmann     case UAS_PIPE_ID_COMMAND:
8165007c940SHans de Goede         length = MIN(sizeof(iu), p->iov.size);
8175007c940SHans de Goede         usb_packet_copy(p, &iu, length);
8185007c940SHans de Goede         switch (iu.hdr.id) {
8190f58f68bSGerd Hoffmann         case UAS_UI_COMMAND:
8205007c940SHans de Goede             usb_uas_command(uas, &iu);
8210f58f68bSGerd Hoffmann             break;
8220f58f68bSGerd Hoffmann         case UAS_UI_TASK_MGMT:
8235007c940SHans de Goede             usb_uas_task(uas, &iu);
8240f58f68bSGerd Hoffmann             break;
8250f58f68bSGerd Hoffmann         default:
8266b7afb7fSGonglei             error_report("%s: unknown command iu: id 0x%x",
8275007c940SHans de Goede                          __func__, iu.hdr.id);
8289a77a0f5SHans de Goede             p->status = USB_RET_STALL;
8290f58f68bSGerd Hoffmann             break;
8300f58f68bSGerd Hoffmann         }
8310f58f68bSGerd Hoffmann         break;
8320f58f68bSGerd Hoffmann     case UAS_PIPE_ID_STATUS:
83389a453d4SGerd Hoffmann         if (p->stream) {
83489a453d4SGerd Hoffmann             QTAILQ_FOREACH(st, &uas->results, next) {
83589a453d4SGerd Hoffmann                 if (st->stream == p->stream) {
83689a453d4SGerd Hoffmann                     break;
83789a453d4SGerd Hoffmann                 }
83889a453d4SGerd Hoffmann             }
8390f58f68bSGerd Hoffmann             if (st == NULL) {
84089a453d4SGerd Hoffmann                 assert(uas->status3[p->stream] == NULL);
84189a453d4SGerd Hoffmann                 uas->status3[p->stream] = p;
8429a77a0f5SHans de Goede                 p->status = USB_RET_ASYNC;
8430f58f68bSGerd Hoffmann                 break;
8440f58f68bSGerd Hoffmann             }
84589a453d4SGerd Hoffmann         } else {
84689a453d4SGerd Hoffmann             st = QTAILQ_FIRST(&uas->results);
84789a453d4SGerd Hoffmann             if (st == NULL) {
84889a453d4SGerd Hoffmann                 assert(uas->status2 == NULL);
84989a453d4SGerd Hoffmann                 uas->status2 = p;
85089a453d4SGerd Hoffmann                 p->status = USB_RET_ASYNC;
85189a453d4SGerd Hoffmann                 break;
85289a453d4SGerd Hoffmann             }
85389a453d4SGerd Hoffmann         }
8540f58f68bSGerd Hoffmann         usb_packet_copy(p, &st->status, st->length);
8550f58f68bSGerd Hoffmann         QTAILQ_REMOVE(&uas->results, st, next);
8560f58f68bSGerd Hoffmann         g_free(st);
8570f58f68bSGerd Hoffmann         break;
8580f58f68bSGerd Hoffmann     case UAS_PIPE_ID_DATA_IN:
8590f58f68bSGerd Hoffmann     case UAS_PIPE_ID_DATA_OUT:
86089a453d4SGerd Hoffmann         if (p->stream) {
86189a453d4SGerd Hoffmann             req = usb_uas_find_request(uas, p->stream);
86289a453d4SGerd Hoffmann         } else {
86389a453d4SGerd Hoffmann             req = (p->ep->nr == UAS_PIPE_ID_DATA_IN)
86489a453d4SGerd Hoffmann                 ? uas->datain2 : uas->dataout2;
86589a453d4SGerd Hoffmann         }
8660f58f68bSGerd Hoffmann         if (req == NULL) {
86789a453d4SGerd Hoffmann             if (p->stream) {
86889a453d4SGerd Hoffmann                 assert(uas->data3[p->stream] == NULL);
86989a453d4SGerd Hoffmann                 uas->data3[p->stream] = p;
87089a453d4SGerd Hoffmann                 p->status = USB_RET_ASYNC;
87189a453d4SGerd Hoffmann                 break;
87289a453d4SGerd Hoffmann             } else {
8736b7afb7fSGonglei                 error_report("%s: no inflight request", __func__);
8749a77a0f5SHans de Goede                 p->status = USB_RET_STALL;
8750f58f68bSGerd Hoffmann                 break;
8760f58f68bSGerd Hoffmann             }
87789a453d4SGerd Hoffmann         }
8780f58f68bSGerd Hoffmann         scsi_req_ref(req->req);
8790f58f68bSGerd Hoffmann         req->data = p;
8800f58f68bSGerd Hoffmann         usb_uas_copy_data(req);
8819a77a0f5SHans de Goede         if (p->actual_length == p->iov.size || req->complete) {
8820f58f68bSGerd Hoffmann             req->data = NULL;
8830f58f68bSGerd Hoffmann         } else {
8840f58f68bSGerd Hoffmann             req->data_async = true;
8859a77a0f5SHans de Goede             p->status = USB_RET_ASYNC;
8860f58f68bSGerd Hoffmann         }
8870f58f68bSGerd Hoffmann         scsi_req_unref(req->req);
8880f58f68bSGerd Hoffmann         usb_uas_start_next_transfer(uas);
8890f58f68bSGerd Hoffmann         break;
8900f58f68bSGerd Hoffmann     default:
8916b7afb7fSGonglei         error_report("%s: invalid endpoint %d", __func__, p->ep->nr);
8929a77a0f5SHans de Goede         p->status = USB_RET_STALL;
8930f58f68bSGerd Hoffmann         break;
8940f58f68bSGerd Hoffmann     }
8950f58f68bSGerd Hoffmann }
8960f58f68bSGerd Hoffmann 
897*b69c3c21SMarkus Armbruster static void usb_uas_unrealize(USBDevice *dev)
8980f58f68bSGerd Hoffmann {
8990b06d099SGonglei     UASDevice *uas = USB_UAS(dev);
9000f58f68bSGerd Hoffmann 
9010f58f68bSGerd Hoffmann     qemu_bh_delete(uas->status_bh);
9020f58f68bSGerd Hoffmann }
9030f58f68bSGerd Hoffmann 
904b89dc7e3SGonglei static void usb_uas_realize(USBDevice *dev, Error **errp)
9050f58f68bSGerd Hoffmann {
9060b06d099SGonglei     UASDevice *uas = USB_UAS(dev);
9070d4cf3e7SGerd Hoffmann     DeviceState *d = DEVICE(dev);
9080f58f68bSGerd Hoffmann 
9090f58f68bSGerd Hoffmann     usb_desc_create_serial(dev);
9100f58f68bSGerd Hoffmann     usb_desc_init(dev);
9110d4cf3e7SGerd Hoffmann     if (d->hotplugged) {
9120d4cf3e7SGerd Hoffmann         uas->dev.auto_attach = 0;
9130d4cf3e7SGerd Hoffmann     }
9140f58f68bSGerd Hoffmann 
9150f58f68bSGerd Hoffmann     QTAILQ_INIT(&uas->results);
9160f58f68bSGerd Hoffmann     QTAILQ_INIT(&uas->requests);
9170f58f68bSGerd Hoffmann     uas->status_bh = qemu_bh_new(usb_uas_send_status_bh, uas);
9180f58f68bSGerd Hoffmann 
919b1187b51SAndreas Färber     scsi_bus_new(&uas->bus, sizeof(uas->bus), DEVICE(dev),
920b1187b51SAndreas Färber                  &usb_uas_scsi_info, NULL);
9210f58f68bSGerd Hoffmann }
9220f58f68bSGerd Hoffmann 
9230f58f68bSGerd Hoffmann static const VMStateDescription vmstate_usb_uas = {
9240f58f68bSGerd Hoffmann     .name = "usb-uas",
9250f58f68bSGerd Hoffmann     .unmigratable = 1,
9260f58f68bSGerd Hoffmann     .fields = (VMStateField[]) {
9270f58f68bSGerd Hoffmann         VMSTATE_USB_DEVICE(dev, UASDevice),
9280f58f68bSGerd Hoffmann         VMSTATE_END_OF_LIST()
9290f58f68bSGerd Hoffmann     }
9300f58f68bSGerd Hoffmann };
9310f58f68bSGerd Hoffmann 
9321556a8fcSGerd Hoffmann static Property uas_properties[] = {
9331556a8fcSGerd Hoffmann     DEFINE_PROP_UINT32("log-scsi-req", UASDevice, requestlog, 0),
9341556a8fcSGerd Hoffmann     DEFINE_PROP_END_OF_LIST(),
9351556a8fcSGerd Hoffmann };
9361556a8fcSGerd Hoffmann 
9370f58f68bSGerd Hoffmann static void usb_uas_class_initfn(ObjectClass *klass, void *data)
9380f58f68bSGerd Hoffmann {
9390f58f68bSGerd Hoffmann     DeviceClass *dc = DEVICE_CLASS(klass);
9400f58f68bSGerd Hoffmann     USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
9410f58f68bSGerd Hoffmann 
942b89dc7e3SGonglei     uc->realize        = usb_uas_realize;
9430f58f68bSGerd Hoffmann     uc->product_desc   = desc_strings[STR_PRODUCT];
9440f58f68bSGerd Hoffmann     uc->usb_desc       = &desc;
9450f58f68bSGerd Hoffmann     uc->cancel_packet  = usb_uas_cancel_io;
9460f58f68bSGerd Hoffmann     uc->handle_attach  = usb_desc_attach;
9470f58f68bSGerd Hoffmann     uc->handle_reset   = usb_uas_handle_reset;
9480f58f68bSGerd Hoffmann     uc->handle_control = usb_uas_handle_control;
9490f58f68bSGerd Hoffmann     uc->handle_data    = usb_uas_handle_data;
950c4fe9700SMarc-André Lureau     uc->unrealize      = usb_uas_unrealize;
9510d4cf3e7SGerd Hoffmann     uc->attached_settable = true;
952125ee0edSMarcel Apfelbaum     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
9530f58f68bSGerd Hoffmann     dc->fw_name = "storage";
9540f58f68bSGerd Hoffmann     dc->vmsd = &vmstate_usb_uas;
9554f67d30bSMarc-André Lureau     device_class_set_props(dc, uas_properties);
9560f58f68bSGerd Hoffmann }
9570f58f68bSGerd Hoffmann 
9588c43a6f0SAndreas Färber static const TypeInfo uas_info = {
9590b06d099SGonglei     .name          = TYPE_USB_UAS,
9600f58f68bSGerd Hoffmann     .parent        = TYPE_USB_DEVICE,
9610f58f68bSGerd Hoffmann     .instance_size = sizeof(UASDevice),
9620f58f68bSGerd Hoffmann     .class_init    = usb_uas_class_initfn,
9630f58f68bSGerd Hoffmann };
9640f58f68bSGerd Hoffmann 
9650f58f68bSGerd Hoffmann static void usb_uas_register_types(void)
9660f58f68bSGerd Hoffmann {
9670f58f68bSGerd Hoffmann     type_register_static(&uas_info);
9680f58f68bSGerd Hoffmann }
9690f58f68bSGerd Hoffmann 
9700f58f68bSGerd Hoffmann type_init(usb_uas_register_types)
971