2 * Media Transfer Protocol implementation, backed by host filesystem.
4 * Copyright Red Hat, Inc 2014
9 * This code is licensed under the GPL v2 or later.
12 #include "qemu/osdep.h"
13 #include "qemu-common.h"
14 #include "qapi/error.h"
15 #include "qemu/error-report.h"
19 #include <sys/statvfs.h>
23 #include "qemu/module.h"
24 #include "qemu/filemonitor.h"
26 #include "hw/qdev-properties.h"
28 #include "migration/vmstate.h"
30 #include "qemu/units.h"
32 /* ----------------------------------------------------------------------- */
34 enum mtp_container_type {
41 /* MTP write stage, for internal use only */
42 enum mtp_write_status {
50 CMD_GET_DEVICE_INFO = 0x1001,
51 CMD_OPEN_SESSION = 0x1002,
52 CMD_CLOSE_SESSION = 0x1003,
53 CMD_GET_STORAGE_IDS = 0x1004,
54 CMD_GET_STORAGE_INFO = 0x1005,
55 CMD_GET_NUM_OBJECTS = 0x1006,
56 CMD_GET_OBJECT_HANDLES = 0x1007,
57 CMD_GET_OBJECT_INFO = 0x1008,
58 CMD_GET_OBJECT = 0x1009,
59 CMD_DELETE_OBJECT = 0x100b,
60 CMD_SEND_OBJECT_INFO = 0x100c,
61 CMD_SEND_OBJECT = 0x100d,
62 CMD_GET_PARTIAL_OBJECT = 0x101b,
63 CMD_GET_OBJECT_PROPS_SUPPORTED = 0x9801,
64 CMD_GET_OBJECT_PROP_DESC = 0x9802,
65 CMD_GET_OBJECT_PROP_VALUE = 0x9803,
69 RES_GENERAL_ERROR = 0x2002,
70 RES_SESSION_NOT_OPEN = 0x2003,
71 RES_INVALID_TRANSACTION_ID = 0x2004,
72 RES_OPERATION_NOT_SUPPORTED = 0x2005,
73 RES_PARAMETER_NOT_SUPPORTED = 0x2006,
74 RES_INCOMPLETE_TRANSFER = 0x2007,
75 RES_INVALID_STORAGE_ID = 0x2008,
76 RES_INVALID_OBJECT_HANDLE = 0x2009,
77 RES_INVALID_OBJECT_FORMAT_CODE = 0x200b,
78 RES_STORE_FULL = 0x200c,
79 RES_STORE_READ_ONLY = 0x200e,
80 RES_PARTIAL_DELETE = 0x2012,
81 RES_STORE_NOT_AVAILABLE = 0x2013,
82 RES_SPEC_BY_FORMAT_UNSUPPORTED = 0x2014,
83 RES_INVALID_OBJECTINFO = 0x2015,
84 RES_DESTINATION_UNSUPPORTED = 0x2020,
85 RES_INVALID_PARENT_OBJECT = 0x201a,
86 RES_INVALID_PARAMETER = 0x201d,
87 RES_SESSION_ALREADY_OPEN = 0x201e,
88 RES_INVALID_OBJECT_PROP_CODE = 0xA801,
91 FMT_UNDEFINED_OBJECT = 0x3000,
92 FMT_ASSOCIATION = 0x3001,
95 EVT_CANCEL_TRANSACTION = 0x4001,
96 EVT_OBJ_ADDED = 0x4002,
97 EVT_OBJ_REMOVED = 0x4003,
98 EVT_OBJ_INFO_CHANGED = 0x4007,
100 /* object properties */
101 PROP_STORAGE_ID = 0xDC01,
102 PROP_OBJECT_FORMAT = 0xDC02,
103 PROP_OBJECT_COMPRESSED_SIZE = 0xDC04,
104 PROP_PARENT_OBJECT = 0xDC0B,
105 PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER = 0xDC41,
110 DATA_TYPE_UINT16 = 0x0004,
111 DATA_TYPE_UINT32 = 0x0006,
112 DATA_TYPE_UINT64 = 0x0008,
113 DATA_TYPE_UINT128 = 0x000a,
114 DATA_TYPE_STRING = 0xffff,
122 } QEMU_PACKED mtp_container;
124 /* ----------------------------------------------------------------------- */
126 typedef struct MTPState MTPState;
127 typedef struct MTPControl MTPControl;
128 typedef struct MTPData MTPData;
129 typedef struct MTPObject MTPObject;
137 typedef struct MTPMonEntry MTPMonEntry;
143 QTAILQ_ENTRY(MTPMonEntry) next;
161 /* Used for >4G file sizes */
164 uint8_t write_status;
165 /* Internal pointer per every MTP_WRITE_BUF_SZ */
166 uint64_t data_offset;
175 /* file monitor watch id */
179 QLIST_HEAD(, MTPObject) children;
180 QLIST_ENTRY(MTPObject) list;
182 QTAILQ_ENTRY(MTPObject) next;
195 uint32_t next_handle;
198 QTAILQ_HEAD(, MTPObject) objects;
199 QFileMonitor *file_monitor;
200 QTAILQ_HEAD(, MTPMonEntry) events;
201 /* Responder is expecting a write operation */
204 uint32_t parent_handle;
212 * ObjectInfo dataset received from initiator
213 * Fields we don't care about are ignored
216 uint32_t storage_id; /*unused*/
218 uint16_t protection_status; /*unused*/
220 uint16_t thumb_format; /*unused*/
221 uint32_t thumb_comp_sz; /*unused*/
222 uint32_t thumb_pix_width; /*unused*/
223 uint32_t thumb_pix_height; /*unused*/
224 uint32_t image_pix_width; /*unused*/
225 uint32_t image_pix_height; /*unused*/
226 uint32_t image_bit_depth; /*unused*/
227 uint32_t parent; /*unused*/
230 uint32_t seq_no; /*unused*/
231 uint8_t length; /*part of filename field*/
232 uint8_t filename[0]; /* UTF-16 encoded */
233 char date_created[0]; /*unused*/
234 char date_modified[0]; /*unused*/
235 char keywords[0]; /*unused*/
236 /* string and other data follows */
237 } QEMU_PACKED ObjectInfo;
239 #define TYPE_USB_MTP "usb-mtp"
240 #define USB_MTP(obj) OBJECT_CHECK(MTPState, (obj), TYPE_USB_MTP)
242 #define QEMU_STORAGE_ID 0x00010001
244 #define MTP_FLAG_WRITABLE 0
246 #define FLAG_SET(_mtp, _flag) ((_mtp)->flags & (1 << (_flag)))
248 /* ----------------------------------------------------------------------- */
250 #define MTP_MANUFACTURER "QEMU"
251 #define MTP_PRODUCT "QEMU filesharing"
252 #define MTP_WRITE_BUF_SZ (512 * KiB)
255 STR_MANUFACTURER = 1,
264 static const USBDescStrings desc_strings = {
265 [STR_MANUFACTURER] = MTP_MANUFACTURER,
266 [STR_PRODUCT] = MTP_PRODUCT,
267 [STR_SERIALNUMBER] = "34617",
269 [STR_CONFIG_FULL] = "Full speed config (usb 1.1)",
270 [STR_CONFIG_HIGH] = "High speed config (usb 2.0)",
271 [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
274 static const USBDescIface desc_iface_full = {
275 .bInterfaceNumber = 0,
277 .bInterfaceClass = USB_CLASS_STILL_IMAGE,
278 .bInterfaceSubClass = 0x01,
279 .bInterfaceProtocol = 0x01,
280 .iInterface = STR_MTP,
281 .eps = (USBDescEndpoint[]) {
283 .bEndpointAddress = USB_DIR_IN | EP_DATA_IN,
284 .bmAttributes = USB_ENDPOINT_XFER_BULK,
285 .wMaxPacketSize = 64,
287 .bEndpointAddress = USB_DIR_OUT | EP_DATA_OUT,
288 .bmAttributes = USB_ENDPOINT_XFER_BULK,
289 .wMaxPacketSize = 64,
291 .bEndpointAddress = USB_DIR_IN | EP_EVENT,
292 .bmAttributes = USB_ENDPOINT_XFER_INT,
293 .wMaxPacketSize = 64,
299 static const USBDescDevice desc_device_full = {
301 .bMaxPacketSize0 = 8,
302 .bNumConfigurations = 1,
303 .confs = (USBDescConfig[]) {
306 .bConfigurationValue = 1,
307 .iConfiguration = STR_CONFIG_FULL,
308 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
311 .ifs = &desc_iface_full,
316 static const USBDescIface desc_iface_high = {
317 .bInterfaceNumber = 0,
319 .bInterfaceClass = USB_CLASS_STILL_IMAGE,
320 .bInterfaceSubClass = 0x01,
321 .bInterfaceProtocol = 0x01,
322 .iInterface = STR_MTP,
323 .eps = (USBDescEndpoint[]) {
325 .bEndpointAddress = USB_DIR_IN | EP_DATA_IN,
326 .bmAttributes = USB_ENDPOINT_XFER_BULK,
327 .wMaxPacketSize = 512,
329 .bEndpointAddress = USB_DIR_OUT | EP_DATA_OUT,
330 .bmAttributes = USB_ENDPOINT_XFER_BULK,
331 .wMaxPacketSize = 512,
333 .bEndpointAddress = USB_DIR_IN | EP_EVENT,
334 .bmAttributes = USB_ENDPOINT_XFER_INT,
335 .wMaxPacketSize = 64,
341 static const USBDescDevice desc_device_high = {
343 .bMaxPacketSize0 = 64,
344 .bNumConfigurations = 1,
345 .confs = (USBDescConfig[]) {
348 .bConfigurationValue = 1,
349 .iConfiguration = STR_CONFIG_HIGH,
350 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
353 .ifs = &desc_iface_high,
358 static const USBDescMSOS desc_msos = {
359 .CompatibleID = "MTP",
360 .SelectiveSuspendEnabled = true,
363 static const USBDesc desc = {
365 .idVendor = 0x46f4, /* CRC16() of "QEMU" */
368 .iManufacturer = STR_MANUFACTURER,
369 .iProduct = STR_PRODUCT,
370 .iSerialNumber = STR_SERIALNUMBER,
372 .full = &desc_device_full,
373 .high = &desc_device_high,
378 /* ----------------------------------------------------------------------- */
380 static MTPObject *usb_mtp_object_alloc(MTPState *s, uint32_t handle,
381 MTPObject *parent, const char *name)
383 MTPObject *o = g_new0(MTPObject, 1);
385 if (name[0] == '.') {
392 o->name = g_strdup(name);
393 if (parent == NULL) {
394 o->path = g_strdup(name);
396 o->path = g_strdup_printf("%s/%s", parent->path, name);
399 if (lstat(o->path, &o->stat) != 0) {
402 if (S_ISREG(o->stat.st_mode)) {
403 o->format = FMT_UNDEFINED_OBJECT;
404 } else if (S_ISDIR(o->stat.st_mode)) {
405 o->format = FMT_ASSOCIATION;
410 if (access(o->path, R_OK) != 0) {
414 trace_usb_mtp_object_alloc(s->dev.addr, o->handle, o->path);
416 QTAILQ_INSERT_TAIL(&s->objects, o, next);
426 static void usb_mtp_object_free(MTPState *s, MTPObject *o)
434 trace_usb_mtp_object_free(s->dev.addr, o->handle, o->path);
436 if (o->watchid != -1 && s->file_monitor) {
437 qemu_file_monitor_remove_watch(s->file_monitor, o->path, o->watchid);
440 QTAILQ_REMOVE(&s->objects, o, next);
442 QLIST_REMOVE(o, list);
443 o->parent->nchildren--;
446 while (!QLIST_EMPTY(&o->children)) {
447 iter = QLIST_FIRST(&o->children);
448 usb_mtp_object_free(s, iter);
455 static MTPObject *usb_mtp_object_lookup(MTPState *s, uint32_t handle)
459 QTAILQ_FOREACH(o, &s->objects, next) {
460 if (o->handle == handle) {
467 static MTPObject *usb_mtp_add_child(MTPState *s, MTPObject *o,
471 usb_mtp_object_alloc(s, s->next_handle++, o, name);
474 trace_usb_mtp_add_child(s->dev.addr, child->handle, child->path);
475 QLIST_INSERT_HEAD(&o->children, child, list);
478 if (child->format == FMT_ASSOCIATION) {
479 QLIST_INIT(&child->children);
486 static MTPObject *usb_mtp_object_lookup_name(MTPObject *parent,
487 const char *name, int len)
495 QLIST_FOREACH(iter, &parent->children, list) {
496 if (strncmp(iter->name, name, len) == 0) {
504 static MTPObject *usb_mtp_object_lookup_id(MTPState *s, int64_t id)
508 QTAILQ_FOREACH(iter, &s->objects, next) {
509 if (iter->watchid == id) {
517 static void file_monitor_event(int64_t id,
518 QFileMonitorEvent ev,
522 MTPState *s = opaque;
523 MTPObject *parent = usb_mtp_object_lookup_id(s, id);
524 MTPMonEntry *entry = NULL;
532 case QFILE_MONITOR_EVENT_CREATED:
533 if (usb_mtp_object_lookup_name(parent, name, -1)) {
534 /* Duplicate create event */
537 entry = g_new0(MTPMonEntry, 1);
538 entry->handle = s->next_handle;
539 entry->event = EVT_OBJ_ADDED;
540 o = usb_mtp_add_child(s, parent, name);
545 trace_usb_mtp_file_monitor_event(s->dev.addr, name, "Obj Added");
548 case QFILE_MONITOR_EVENT_DELETED:
550 * The kernel issues a IN_IGNORED event
551 * when a dir containing a watchpoint is
552 * deleted, so we don't have to delete the
555 o = usb_mtp_object_lookup_name(parent, name, -1);
559 entry = g_new0(MTPMonEntry, 1);
560 entry->handle = o->handle;
561 entry->event = EVT_OBJ_REMOVED;
562 trace_usb_mtp_file_monitor_event(s->dev.addr, o->path, "Obj Deleted");
563 usb_mtp_object_free(s, o);
566 case QFILE_MONITOR_EVENT_MODIFIED:
567 o = usb_mtp_object_lookup_name(parent, name, -1);
571 entry = g_new0(MTPMonEntry, 1);
572 entry->handle = o->handle;
573 entry->event = EVT_OBJ_INFO_CHANGED;
574 trace_usb_mtp_file_monitor_event(s->dev.addr, o->path, "Obj Modified");
577 case QFILE_MONITOR_EVENT_IGNORED:
578 trace_usb_mtp_file_monitor_event(s->dev.addr, parent->path,
579 "Obj parent dir ignored");
582 case QFILE_MONITOR_EVENT_ATTRIBUTES:
586 g_assert_not_reached();
590 QTAILQ_INSERT_HEAD(&s->events, entry, next);
594 static void usb_mtp_file_monitor_cleanup(MTPState *s)
598 QTAILQ_FOREACH_SAFE(e, &s->events, next, p) {
599 QTAILQ_REMOVE(&s->events, e, next);
603 qemu_file_monitor_free(s->file_monitor);
604 s->file_monitor = NULL;
608 static void usb_mtp_object_readdir(MTPState *s, MTPObject *o)
610 struct dirent *entry;
615 if (o->have_children) {
618 o->have_children = true;
620 fd = open(o->path, O_DIRECTORY | O_CLOEXEC | O_NOFOLLOW);
630 if (s->file_monitor) {
631 int64_t id = qemu_file_monitor_add_watch(s->file_monitor, o->path, NULL,
632 file_monitor_event, s, &err);
634 error_report("usb-mtp: failed to add watch for %s: %s", o->path,
635 error_get_pretty(err));
638 trace_usb_mtp_file_monitor_event(s->dev.addr, o->path,
644 while ((entry = readdir(dir)) != NULL) {
645 usb_mtp_add_child(s, o, entry->d_name);
650 /* ----------------------------------------------------------------------- */
652 static MTPData *usb_mtp_data_alloc(MTPControl *c)
654 MTPData *data = g_new0(MTPData, 1);
656 data->code = c->code;
657 data->trans = c->trans;
663 static void usb_mtp_data_free(MTPData *data)
668 if (data->fd != -1) {
675 static void usb_mtp_realloc(MTPData *data, uint32_t bytes)
677 if (data->length + bytes <= data->alloc) {
680 data->alloc = (data->length + bytes + 0xff) & ~0xff;
681 data->data = g_realloc(data->data, data->alloc);
684 static void usb_mtp_add_u8(MTPData *data, uint8_t val)
686 usb_mtp_realloc(data, 1);
687 data->data[data->length++] = val;
690 static void usb_mtp_add_u16(MTPData *data, uint16_t val)
692 usb_mtp_realloc(data, 2);
693 data->data[data->length++] = (val >> 0) & 0xff;
694 data->data[data->length++] = (val >> 8) & 0xff;
697 static void usb_mtp_add_u32(MTPData *data, uint32_t val)
699 usb_mtp_realloc(data, 4);
700 data->data[data->length++] = (val >> 0) & 0xff;
701 data->data[data->length++] = (val >> 8) & 0xff;
702 data->data[data->length++] = (val >> 16) & 0xff;
703 data->data[data->length++] = (val >> 24) & 0xff;
706 static void usb_mtp_add_u64(MTPData *data, uint64_t val)
708 usb_mtp_realloc(data, 8);
709 data->data[data->length++] = (val >> 0) & 0xff;
710 data->data[data->length++] = (val >> 8) & 0xff;
711 data->data[data->length++] = (val >> 16) & 0xff;
712 data->data[data->length++] = (val >> 24) & 0xff;
713 data->data[data->length++] = (val >> 32) & 0xff;
714 data->data[data->length++] = (val >> 40) & 0xff;
715 data->data[data->length++] = (val >> 48) & 0xff;
716 data->data[data->length++] = (val >> 56) & 0xff;
719 static void usb_mtp_add_u16_array(MTPData *data, uint32_t len,
720 const uint16_t *vals)
724 usb_mtp_add_u32(data, len);
725 for (i = 0; i < len; i++) {
726 usb_mtp_add_u16(data, vals[i]);
730 static void usb_mtp_add_u32_array(MTPData *data, uint32_t len,
731 const uint32_t *vals)
735 usb_mtp_add_u32(data, len);
736 for (i = 0; i < len; i++) {
737 usb_mtp_add_u32(data, vals[i]);
741 static void usb_mtp_add_wstr(MTPData *data, const wchar_t *str)
743 uint32_t len = wcslen(str);
747 len++; /* include terminating L'\0' */
750 usb_mtp_add_u8(data, len);
751 for (i = 0; i < len; i++) {
752 usb_mtp_add_u16(data, str[i]);
756 static void usb_mtp_add_str(MTPData *data, const char *str)
758 uint32_t len = strlen(str)+1;
759 wchar_t *wstr = g_new(wchar_t, len);
762 ret = mbstowcs(wstr, str, len);
764 usb_mtp_add_wstr(data, L"Oops");
766 usb_mtp_add_wstr(data, wstr);
772 static void usb_mtp_add_time(MTPData *data, time_t time)
777 gmtime_r(&time, &tm);
778 strftime(buf, sizeof(buf), "%Y%m%dT%H%M%S", &tm);
779 usb_mtp_add_str(data, buf);
782 /* ----------------------------------------------------------------------- */
784 static void usb_mtp_queue_result(MTPState *s, uint16_t code, uint32_t trans,
785 int argc, uint32_t arg0, uint32_t arg1,
788 MTPControl *c = g_new0(MTPControl, 1);
803 assert(s->result == NULL);
807 /* ----------------------------------------------------------------------- */
809 static MTPData *usb_mtp_get_device_info(MTPState *s, MTPControl *c)
811 static const uint16_t ops[] = {
816 CMD_GET_STORAGE_INFO,
818 CMD_GET_OBJECT_HANDLES,
821 CMD_SEND_OBJECT_INFO,
824 CMD_GET_PARTIAL_OBJECT,
825 CMD_GET_OBJECT_PROPS_SUPPORTED,
826 CMD_GET_OBJECT_PROP_DESC,
827 CMD_GET_OBJECT_PROP_VALUE,
829 static const uint16_t fmt[] = {
830 FMT_UNDEFINED_OBJECT,
833 MTPData *d = usb_mtp_data_alloc(c);
835 trace_usb_mtp_op_get_device_info(s->dev.addr);
837 usb_mtp_add_u16(d, 100);
838 usb_mtp_add_u32(d, 0x00000006);
839 usb_mtp_add_u16(d, 0x0064);
840 usb_mtp_add_wstr(d, L"");
841 usb_mtp_add_u16(d, 0x0000);
843 usb_mtp_add_u16_array(d, ARRAY_SIZE(ops), ops);
844 usb_mtp_add_u16_array(d, 0, NULL);
845 usb_mtp_add_u16_array(d, 0, NULL);
846 usb_mtp_add_u16_array(d, 0, NULL);
847 usb_mtp_add_u16_array(d, ARRAY_SIZE(fmt), fmt);
849 usb_mtp_add_wstr(d, L"" MTP_MANUFACTURER);
850 usb_mtp_add_wstr(d, L"" MTP_PRODUCT);
851 usb_mtp_add_wstr(d, L"0.1");
852 usb_mtp_add_wstr(d, L"0123456789abcdef0123456789abcdef");
857 static MTPData *usb_mtp_get_storage_ids(MTPState *s, MTPControl *c)
859 static const uint32_t ids[] = {
862 MTPData *d = usb_mtp_data_alloc(c);
864 trace_usb_mtp_op_get_storage_ids(s->dev.addr);
866 usb_mtp_add_u32_array(d, ARRAY_SIZE(ids), ids);
871 static MTPData *usb_mtp_get_storage_info(MTPState *s, MTPControl *c)
873 MTPData *d = usb_mtp_data_alloc(c);
877 trace_usb_mtp_op_get_storage_info(s->dev.addr);
879 if (FLAG_SET(s, MTP_FLAG_WRITABLE)) {
880 usb_mtp_add_u16(d, 0x0003);
881 usb_mtp_add_u16(d, 0x0002);
882 usb_mtp_add_u16(d, 0x0000);
884 usb_mtp_add_u16(d, 0x0001);
885 usb_mtp_add_u16(d, 0x0002);
886 usb_mtp_add_u16(d, 0x0001);
889 rc = statvfs(s->root, &buf);
891 usb_mtp_add_u64(d, (uint64_t)buf.f_frsize * buf.f_blocks);
892 usb_mtp_add_u64(d, (uint64_t)buf.f_bavail * buf.f_blocks);
893 usb_mtp_add_u32(d, buf.f_ffree);
895 usb_mtp_add_u64(d, 0xffffffff);
896 usb_mtp_add_u64(d, 0xffffffff);
897 usb_mtp_add_u32(d, 0xffffffff);
900 usb_mtp_add_str(d, s->desc);
901 usb_mtp_add_wstr(d, L"123456789abcdef");
905 static MTPData *usb_mtp_get_object_handles(MTPState *s, MTPControl *c,
908 MTPData *d = usb_mtp_data_alloc(c);
909 uint32_t i = 0, handles[o->nchildren];
912 trace_usb_mtp_op_get_object_handles(s->dev.addr, o->handle, o->path);
914 QLIST_FOREACH(iter, &o->children, list) {
915 handles[i++] = iter->handle;
917 assert(i == o->nchildren);
918 usb_mtp_add_u32_array(d, o->nchildren, handles);
923 static MTPData *usb_mtp_get_object_info(MTPState *s, MTPControl *c,
926 MTPData *d = usb_mtp_data_alloc(c);
928 trace_usb_mtp_op_get_object_info(s->dev.addr, o->handle, o->path);
930 usb_mtp_add_u32(d, QEMU_STORAGE_ID);
931 usb_mtp_add_u16(d, o->format);
932 usb_mtp_add_u16(d, 0);
934 if (o->stat.st_size > 0xFFFFFFFF) {
935 usb_mtp_add_u32(d, 0xFFFFFFFF);
937 usb_mtp_add_u32(d, o->stat.st_size);
940 usb_mtp_add_u16(d, 0);
941 usb_mtp_add_u32(d, 0);
942 usb_mtp_add_u32(d, 0);
943 usb_mtp_add_u32(d, 0);
944 usb_mtp_add_u32(d, 0);
945 usb_mtp_add_u32(d, 0);
946 usb_mtp_add_u32(d, 0);
949 usb_mtp_add_u32(d, o->parent->handle);
951 usb_mtp_add_u32(d, 0);
953 if (o->format == FMT_ASSOCIATION) {
954 usb_mtp_add_u16(d, 0x0001);
955 usb_mtp_add_u32(d, 0x00000001);
956 usb_mtp_add_u32(d, 0);
958 usb_mtp_add_u16(d, 0);
959 usb_mtp_add_u32(d, 0);
960 usb_mtp_add_u32(d, 0);
963 usb_mtp_add_str(d, o->name);
964 usb_mtp_add_time(d, o->stat.st_ctime);
965 usb_mtp_add_time(d, o->stat.st_mtime);
966 usb_mtp_add_wstr(d, L"");
971 static MTPData *usb_mtp_get_object(MTPState *s, MTPControl *c,
974 MTPData *d = usb_mtp_data_alloc(c);
976 trace_usb_mtp_op_get_object(s->dev.addr, o->handle, o->path);
978 d->fd = open(o->path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
980 usb_mtp_data_free(d);
983 d->length = o->stat.st_size;
985 d->data = g_malloc(d->alloc);
989 static MTPData *usb_mtp_get_partial_object(MTPState *s, MTPControl *c,
998 trace_usb_mtp_op_get_partial_object(s->dev.addr, o->handle, o->path,
999 c->argv[1], c->argv[2]);
1001 d = usb_mtp_data_alloc(c);
1002 d->fd = open(o->path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
1004 usb_mtp_data_free(d);
1008 offset = c->argv[1];
1009 if (offset > o->stat.st_size) {
1010 offset = o->stat.st_size;
1012 if (lseek(d->fd, offset, SEEK_SET) < 0) {
1013 usb_mtp_data_free(d);
1017 d->length = c->argv[2];
1018 if (d->length > o->stat.st_size - offset) {
1019 d->length = o->stat.st_size - offset;
1025 static MTPData *usb_mtp_get_object_props_supported(MTPState *s, MTPControl *c)
1027 static const uint16_t props[] = {
1030 PROP_OBJECT_COMPRESSED_SIZE,
1032 PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER,
1035 MTPData *d = usb_mtp_data_alloc(c);
1036 usb_mtp_add_u16_array(d, ARRAY_SIZE(props), props);
1041 static MTPData *usb_mtp_get_object_prop_desc(MTPState *s, MTPControl *c)
1043 MTPData *d = usb_mtp_data_alloc(c);
1044 switch (c->argv[0]) {
1045 case PROP_STORAGE_ID:
1046 usb_mtp_add_u16(d, PROP_STORAGE_ID);
1047 usb_mtp_add_u16(d, DATA_TYPE_UINT32);
1048 usb_mtp_add_u8(d, 0x00);
1049 usb_mtp_add_u32(d, 0x00000000);
1050 usb_mtp_add_u32(d, 0x00000000);
1051 usb_mtp_add_u8(d, 0x00);
1053 case PROP_OBJECT_FORMAT:
1054 usb_mtp_add_u16(d, PROP_OBJECT_FORMAT);
1055 usb_mtp_add_u16(d, DATA_TYPE_UINT16);
1056 usb_mtp_add_u8(d, 0x00);
1057 usb_mtp_add_u16(d, 0x0000);
1058 usb_mtp_add_u32(d, 0x00000000);
1059 usb_mtp_add_u8(d, 0x00);
1061 case PROP_OBJECT_COMPRESSED_SIZE:
1062 usb_mtp_add_u16(d, PROP_OBJECT_COMPRESSED_SIZE);
1063 usb_mtp_add_u16(d, DATA_TYPE_UINT64);
1064 usb_mtp_add_u8(d, 0x00);
1065 usb_mtp_add_u64(d, 0x0000000000000000);
1066 usb_mtp_add_u32(d, 0x00000000);
1067 usb_mtp_add_u8(d, 0x00);
1069 case PROP_PARENT_OBJECT:
1070 usb_mtp_add_u16(d, PROP_PARENT_OBJECT);
1071 usb_mtp_add_u16(d, DATA_TYPE_UINT32);
1072 usb_mtp_add_u8(d, 0x00);
1073 usb_mtp_add_u32(d, 0x00000000);
1074 usb_mtp_add_u32(d, 0x00000000);
1075 usb_mtp_add_u8(d, 0x00);
1077 case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER:
1078 usb_mtp_add_u16(d, PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER);
1079 usb_mtp_add_u16(d, DATA_TYPE_UINT128);
1080 usb_mtp_add_u8(d, 0x00);
1081 usb_mtp_add_u64(d, 0x0000000000000000);
1082 usb_mtp_add_u64(d, 0x0000000000000000);
1083 usb_mtp_add_u32(d, 0x00000000);
1084 usb_mtp_add_u8(d, 0x00);
1087 usb_mtp_add_u16(d, PROP_NAME);
1088 usb_mtp_add_u16(d, DATA_TYPE_STRING);
1089 usb_mtp_add_u8(d, 0x00);
1090 usb_mtp_add_u8(d, 0x00);
1091 usb_mtp_add_u32(d, 0x00000000);
1092 usb_mtp_add_u8(d, 0x00);
1095 usb_mtp_data_free(d);
1102 static MTPData *usb_mtp_get_object_prop_value(MTPState *s, MTPControl *c,
1105 MTPData *d = usb_mtp_data_alloc(c);
1106 switch (c->argv[1]) {
1107 case PROP_STORAGE_ID:
1108 usb_mtp_add_u32(d, QEMU_STORAGE_ID);
1110 case PROP_OBJECT_FORMAT:
1111 usb_mtp_add_u16(d, o->format);
1113 case PROP_OBJECT_COMPRESSED_SIZE:
1114 usb_mtp_add_u64(d, o->stat.st_size);
1116 case PROP_PARENT_OBJECT:
1117 if (o->parent == NULL) {
1118 usb_mtp_add_u32(d, 0x00000000);
1120 usb_mtp_add_u32(d, o->parent->handle);
1123 case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER:
1124 /* Should be persistent between sessions,
1125 * but using our objedt ID is "good enough"
1127 usb_mtp_add_u64(d, 0x0000000000000000);
1128 usb_mtp_add_u64(d, o->handle);
1131 usb_mtp_add_str(d, o->name);
1134 usb_mtp_data_free(d);
1142 * Return values when object @o is deleted.
1143 * If at least one of the deletions succeeded,
1144 * DELETE_SUCCESS is set and if at least one
1145 * of the deletions failed, DELETE_FAILURE is
1146 * set. Both bits being set (DELETE_PARTIAL)
1147 * signifies a RES_PARTIAL_DELETE being sent
1148 * back to the initiator.
1151 DELETE_SUCCESS = (1 << 0),
1152 DELETE_FAILURE = (1 << 1),
1153 DELETE_PARTIAL = (DELETE_FAILURE | DELETE_SUCCESS),
1156 static int usb_mtp_deletefn(MTPState *s, MTPObject *o, uint32_t trans)
1158 MTPObject *iter, *iter2;
1162 * TODO: Add support for Protection Status
1165 QLIST_FOREACH(iter, &o->children, list) {
1166 if (iter->format == FMT_ASSOCIATION) {
1167 QLIST_FOREACH(iter2, &iter->children, list) {
1168 ret |= usb_mtp_deletefn(s, iter2, trans);
1173 if (o->format == FMT_UNDEFINED_OBJECT) {
1174 if (remove(o->path)) {
1175 ret |= DELETE_FAILURE;
1177 usb_mtp_object_free(s, o);
1178 ret |= DELETE_SUCCESS;
1180 } else if (o->format == FMT_ASSOCIATION) {
1181 if (rmdir(o->path)) {
1182 ret |= DELETE_FAILURE;
1184 usb_mtp_object_free(s, o);
1185 ret |= DELETE_SUCCESS;
1192 static void usb_mtp_object_delete(MTPState *s, uint32_t handle,
1193 uint32_t format_code, uint32_t trans)
1198 /* Return error if store is read-only */
1199 if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1200 usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1205 if (format_code != 0) {
1206 usb_mtp_queue_result(s, RES_SPEC_BY_FORMAT_UNSUPPORTED,
1211 if (handle == 0xFFFFFFF) {
1212 o = QTAILQ_FIRST(&s->objects);
1214 o = usb_mtp_object_lookup(s, handle);
1217 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1222 ret = usb_mtp_deletefn(s, o, trans);
1224 case DELETE_SUCCESS:
1225 usb_mtp_queue_result(s, RES_OK, trans,
1228 case DELETE_FAILURE:
1229 usb_mtp_queue_result(s, RES_PARTIAL_DELETE,
1232 case DELETE_PARTIAL:
1233 usb_mtp_queue_result(s, RES_PARTIAL_DELETE,
1237 g_assert_not_reached();
1243 static void usb_mtp_command(MTPState *s, MTPControl *c)
1245 MTPData *data_in = NULL;
1246 MTPObject *o = NULL;
1247 uint32_t nres = 0, res0 = 0;
1251 if (c->code >= CMD_CLOSE_SESSION && s->session == 0) {
1252 usb_mtp_queue_result(s, RES_SESSION_NOT_OPEN,
1253 c->trans, 0, 0, 0, 0);
1257 /* process commands */
1259 case CMD_GET_DEVICE_INFO:
1260 data_in = usb_mtp_get_device_info(s, c);
1262 case CMD_OPEN_SESSION:
1264 usb_mtp_queue_result(s, RES_SESSION_ALREADY_OPEN,
1265 c->trans, 1, s->session, 0, 0);
1268 if (c->argv[0] == 0) {
1269 usb_mtp_queue_result(s, RES_INVALID_PARAMETER,
1270 c->trans, 0, 0, 0, 0);
1273 trace_usb_mtp_op_open_session(s->dev.addr);
1274 s->session = c->argv[0];
1275 usb_mtp_object_alloc(s, s->next_handle++, NULL, s->root);
1277 s->file_monitor = qemu_file_monitor_new(&err);
1279 error_report("usb-mtp: file monitoring init failed: %s",
1280 error_get_pretty(err));
1283 QTAILQ_INIT(&s->events);
1286 case CMD_CLOSE_SESSION:
1287 trace_usb_mtp_op_close_session(s->dev.addr);
1290 usb_mtp_file_monitor_cleanup(s);
1291 usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
1292 assert(QTAILQ_EMPTY(&s->objects));
1294 case CMD_GET_STORAGE_IDS:
1295 data_in = usb_mtp_get_storage_ids(s, c);
1297 case CMD_GET_STORAGE_INFO:
1298 if (c->argv[0] != QEMU_STORAGE_ID &&
1299 c->argv[0] != 0xffffffff) {
1300 usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
1301 c->trans, 0, 0, 0, 0);
1304 data_in = usb_mtp_get_storage_info(s, c);
1306 case CMD_GET_NUM_OBJECTS:
1307 case CMD_GET_OBJECT_HANDLES:
1308 if (c->argv[0] != QEMU_STORAGE_ID &&
1309 c->argv[0] != 0xffffffff) {
1310 usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
1311 c->trans, 0, 0, 0, 0);
1314 if (c->argv[1] != 0x00000000) {
1315 usb_mtp_queue_result(s, RES_SPEC_BY_FORMAT_UNSUPPORTED,
1316 c->trans, 0, 0, 0, 0);
1319 if (c->argv[2] == 0x00000000 ||
1320 c->argv[2] == 0xffffffff) {
1321 o = QTAILQ_FIRST(&s->objects);
1323 o = usb_mtp_object_lookup(s, c->argv[2]);
1326 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1327 c->trans, 0, 0, 0, 0);
1330 if (o->format != FMT_ASSOCIATION) {
1331 usb_mtp_queue_result(s, RES_INVALID_PARENT_OBJECT,
1332 c->trans, 0, 0, 0, 0);
1335 usb_mtp_object_readdir(s, o);
1336 if (c->code == CMD_GET_NUM_OBJECTS) {
1337 trace_usb_mtp_op_get_num_objects(s->dev.addr, o->handle, o->path);
1339 res0 = o->nchildren;
1341 data_in = usb_mtp_get_object_handles(s, c, o);
1344 case CMD_GET_OBJECT_INFO:
1345 o = usb_mtp_object_lookup(s, c->argv[0]);
1347 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1348 c->trans, 0, 0, 0, 0);
1351 data_in = usb_mtp_get_object_info(s, c, o);
1353 case CMD_GET_OBJECT:
1354 o = usb_mtp_object_lookup(s, c->argv[0]);
1356 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1357 c->trans, 0, 0, 0, 0);
1360 if (o->format == FMT_ASSOCIATION) {
1361 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1362 c->trans, 0, 0, 0, 0);
1365 data_in = usb_mtp_get_object(s, c, o);
1366 if (data_in == NULL) {
1367 usb_mtp_queue_result(s, RES_GENERAL_ERROR,
1368 c->trans, 0, 0, 0, 0);
1372 case CMD_DELETE_OBJECT:
1373 usb_mtp_object_delete(s, c->argv[0], c->argv[1], c->trans);
1375 case CMD_GET_PARTIAL_OBJECT:
1376 o = usb_mtp_object_lookup(s, c->argv[0]);
1378 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1379 c->trans, 0, 0, 0, 0);
1382 if (o->format == FMT_ASSOCIATION) {
1383 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1384 c->trans, 0, 0, 0, 0);
1387 data_in = usb_mtp_get_partial_object(s, c, o);
1388 if (data_in == NULL) {
1389 usb_mtp_queue_result(s, RES_GENERAL_ERROR,
1390 c->trans, 0, 0, 0, 0);
1394 res0 = data_in->length;
1396 case CMD_SEND_OBJECT_INFO:
1397 /* Return error if store is read-only */
1398 if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1399 usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1400 c->trans, 0, 0, 0, 0);
1401 } else if (c->argv[0] && (c->argv[0] != QEMU_STORAGE_ID)) {
1402 /* First parameter points to storage id or is 0 */
1403 usb_mtp_queue_result(s, RES_STORE_NOT_AVAILABLE, c->trans,
1405 } else if (c->argv[1] && !c->argv[0]) {
1406 /* If second parameter is specified, first must also be specified */
1407 usb_mtp_queue_result(s, RES_DESTINATION_UNSUPPORTED, c->trans,
1410 uint32_t handle = c->argv[1];
1411 if (handle == 0xFFFFFFFF || handle == 0) {
1413 o = QTAILQ_FIRST(&s->objects);
1415 o = usb_mtp_object_lookup(s, handle);
1418 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE, c->trans,
1420 } else if (o->format != FMT_ASSOCIATION) {
1421 usb_mtp_queue_result(s, RES_INVALID_PARENT_OBJECT, c->trans,
1426 s->dataset.parent_handle = o->handle;
1428 s->data_out = usb_mtp_data_alloc(c);
1430 case CMD_SEND_OBJECT:
1431 if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1432 usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1433 c->trans, 0, 0, 0, 0);
1436 if (!s->write_pending) {
1437 usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO,
1438 c->trans, 0, 0, 0, 0);
1441 s->data_out = usb_mtp_data_alloc(c);
1443 case CMD_GET_OBJECT_PROPS_SUPPORTED:
1444 if (c->argv[0] != FMT_UNDEFINED_OBJECT &&
1445 c->argv[0] != FMT_ASSOCIATION) {
1446 usb_mtp_queue_result(s, RES_INVALID_OBJECT_FORMAT_CODE,
1447 c->trans, 0, 0, 0, 0);
1450 data_in = usb_mtp_get_object_props_supported(s, c);
1452 case CMD_GET_OBJECT_PROP_DESC:
1453 if (c->argv[1] != FMT_UNDEFINED_OBJECT &&
1454 c->argv[1] != FMT_ASSOCIATION) {
1455 usb_mtp_queue_result(s, RES_INVALID_OBJECT_FORMAT_CODE,
1456 c->trans, 0, 0, 0, 0);
1459 data_in = usb_mtp_get_object_prop_desc(s, c);
1460 if (data_in == NULL) {
1461 usb_mtp_queue_result(s, RES_INVALID_OBJECT_PROP_CODE,
1462 c->trans, 0, 0, 0, 0);
1466 case CMD_GET_OBJECT_PROP_VALUE:
1467 o = usb_mtp_object_lookup(s, c->argv[0]);
1469 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1470 c->trans, 0, 0, 0, 0);
1473 data_in = usb_mtp_get_object_prop_value(s, c, o);
1474 if (data_in == NULL) {
1475 usb_mtp_queue_result(s, RES_INVALID_OBJECT_PROP_CODE,
1476 c->trans, 0, 0, 0, 0);
1481 trace_usb_mtp_op_unknown(s->dev.addr, c->code);
1482 usb_mtp_queue_result(s, RES_OPERATION_NOT_SUPPORTED,
1483 c->trans, 0, 0, 0, 0);
1487 /* return results on success */
1489 assert(s->data_in == NULL);
1490 s->data_in = data_in;
1492 usb_mtp_queue_result(s, RES_OK, c->trans, nres, res0, 0, 0);
1495 /* ----------------------------------------------------------------------- */
1497 static void usb_mtp_handle_reset(USBDevice *dev)
1499 MTPState *s = USB_MTP(dev);
1501 trace_usb_mtp_reset(s->dev.addr);
1503 usb_mtp_file_monitor_cleanup(s);
1504 usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
1506 usb_mtp_data_free(s->data_in);
1508 usb_mtp_data_free(s->data_out);
1514 static void usb_mtp_handle_control(USBDevice *dev, USBPacket *p,
1515 int request, int value, int index,
1516 int length, uint8_t *data)
1519 MTPState *s = USB_MTP(dev);
1520 uint16_t *event = (uint16_t *)data;
1523 case ClassInterfaceOutRequest | 0x64:
1524 if (*event == EVT_CANCEL_TRANSACTION) {
1527 usb_mtp_data_free(s->data_in);
1529 if (s->write_pending) {
1530 g_free(s->dataset.filename);
1531 s->write_pending = false;
1532 s->dataset.size = 0;
1534 usb_mtp_data_free(s->data_out);
1537 p->status = USB_RET_STALL;
1541 ret = usb_desc_handle_control(dev, p, request,
1542 value, index, length, data);
1548 trace_usb_mtp_stall(dev->addr, "unknown control request");
1551 static void usb_mtp_cancel_packet(USBDevice *dev, USBPacket *p)
1553 /* we don't use async packets, so this should never be called */
1554 fprintf(stderr, "%s\n", __func__);
1557 static char *utf16_to_str(uint8_t len, uint8_t *str16)
1559 wchar_t *wstr = g_new0(wchar_t, len + 1);
1563 for (count = 0; count < len; count++) {
1564 /* FIXME: not working for surrogate pairs */
1565 wstr[count] = lduw_le_p(str16 + (count * 2));
1569 dlen = wcstombs(NULL, wstr, 0) + 1;
1570 dest = g_malloc(dlen);
1571 wcstombs(dest, wstr, dlen);
1576 /* Wrapper around write, returns 0 on failure */
1577 static uint64_t write_retry(int fd, void *buf, uint64_t size, off_t offset)
1581 if (lseek(fd, offset, SEEK_SET) < 0) {
1585 ret = qemu_write_full(fd, buf, size);
1591 static int usb_mtp_update_object(MTPObject *parent, char *name)
1596 usb_mtp_object_lookup_name(parent, name, strlen(name));
1599 ret = lstat(o->path, &o->stat);
1605 static void usb_mtp_write_data(MTPState *s, uint32_t handle)
1607 MTPData *d = s->data_out;
1609 usb_mtp_object_lookup(s, s->dataset.parent_handle);
1617 switch (d->write_status) {
1619 if (!parent || !s->write_pending) {
1620 usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO, d->trans,
1625 if (s->dataset.filename) {
1626 path = g_strdup_printf("%s/%s", parent->path, s->dataset.filename);
1627 if (s->dataset.format == FMT_ASSOCIATION) {
1628 ret = mkdir(path, mask);
1630 usb_mtp_queue_result(s, RES_OK, d->trans, 3,
1632 s->dataset.parent_handle,
1639 d->fd = open(path, O_CREAT | O_WRONLY |
1640 O_CLOEXEC | O_NOFOLLOW, mask);
1646 /* Return success if initiator sent 0 sized data */
1647 if (!s->dataset.size) {
1650 if (d->length != MTP_WRITE_BUF_SZ && !d->pending) {
1651 d->write_status = WRITE_END;
1655 case WRITE_CONTINUE:
1657 rc = write_retry(d->fd, d->data, d->data_offset,
1658 d->offset - d->data_offset);
1659 if (rc != d->data_offset) {
1663 if (d->write_status != WRITE_END) {
1668 * Return an incomplete transfer if file size doesn't match
1669 * for < 4G file or if lstat fails which will result in an incorrect
1672 if ((s->dataset.size != 0xFFFFFFFF &&
1673 d->offset != s->dataset.size) ||
1674 usb_mtp_update_object(parent, s->dataset.filename)) {
1675 usb_mtp_queue_result(s, RES_INCOMPLETE_TRANSFER, d->trans,
1684 usb_mtp_queue_result(s, RES_STORE_FULL, d->trans,
1687 usb_mtp_queue_result(s, RES_OK, d->trans,
1692 * The write dataset is kept around and freed only
1693 * on success or if another write request comes in
1699 g_free(s->dataset.filename);
1700 s->dataset.size = 0;
1702 s->write_pending = false;
1705 static void usb_mtp_write_metadata(MTPState *s, uint64_t dlen)
1707 MTPData *d = s->data_out;
1708 ObjectInfo *dataset = (ObjectInfo *)d->data;
1711 MTPObject *p = usb_mtp_object_lookup(s, s->dataset.parent_handle);
1712 uint32_t next_handle = s->next_handle;
1713 size_t filename_chars = dlen - offsetof(ObjectInfo, filename);
1716 * filename is utf-16. We're intentionally doing
1717 * integer division to truncate if malicious guest
1718 * sent an odd number of bytes.
1720 filename_chars /= 2;
1722 assert(!s->write_pending);
1725 filename = utf16_to_str(MIN(dataset->length, filename_chars),
1728 if (strchr(filename, '/')) {
1729 usb_mtp_queue_result(s, RES_PARAMETER_NOT_SUPPORTED, d->trans,
1735 o = usb_mtp_object_lookup_name(p, filename, -1);
1737 next_handle = o->handle;
1740 s->dataset.filename = filename;
1741 s->dataset.format = dataset->format;
1742 s->dataset.size = dataset->size;
1743 s->write_pending = true;
1745 if (s->dataset.format == FMT_ASSOCIATION) {
1746 usb_mtp_write_data(s, next_handle);
1748 usb_mtp_queue_result(s, RES_OK, d->trans, 3, QEMU_STORAGE_ID,
1749 s->dataset.parent_handle, next_handle);
1753 static void usb_mtp_get_data(MTPState *s, mtp_container *container,
1756 MTPData *d = s->data_out;
1758 uint32_t data_len = p->iov.size;
1762 usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO, 0,
1767 /* Total length of incoming data */
1768 total_len = cpu_to_le32(container->length) - sizeof(mtp_container);
1769 /* Length of data in this packet */
1770 data_len -= sizeof(mtp_container);
1771 if (total_len < MTP_WRITE_BUF_SZ) {
1772 usb_mtp_realloc(d, total_len);
1773 d->length += total_len;
1775 usb_mtp_realloc(d, MTP_WRITE_BUF_SZ - sizeof(mtp_container));
1776 d->length += MTP_WRITE_BUF_SZ - sizeof(mtp_container);
1782 d->write_status = WRITE_START;
1786 memset(d->data, 0, d->length);
1787 if (d->length != MTP_WRITE_BUF_SZ) {
1788 usb_mtp_realloc(d, MTP_WRITE_BUF_SZ - d->length);
1789 d->length += (MTP_WRITE_BUF_SZ - d->length);
1792 d->write_status = WRITE_CONTINUE;
1796 if (d->length - d->data_offset > data_len) {
1799 dlen = d->length - d->data_offset;
1803 case CMD_SEND_OBJECT_INFO:
1804 usb_packet_copy(p, d->data + d->data_offset, dlen);
1806 d->data_offset += dlen;
1807 if (d->data_offset == d->length) {
1808 /* The operation might have already failed */
1810 usb_mtp_write_metadata(s, dlen);
1812 usb_mtp_data_free(s->data_out);
1817 case CMD_SEND_OBJECT:
1818 usb_packet_copy(p, d->data + d->data_offset, dlen);
1820 d->data_offset += dlen;
1821 if ((p->iov.size % 64) || !p->iov.size) {
1822 assert((s->dataset.size == 0xFFFFFFFF) ||
1823 (s->dataset.size == d->offset));
1825 if (d->length == MTP_WRITE_BUF_SZ) {
1826 d->write_status = WRITE_END;
1828 d->write_status = WRITE_START;
1830 usb_mtp_write_data(s, 0);
1831 usb_mtp_data_free(s->data_out);
1835 if (d->data_offset == d->length) {
1837 usb_mtp_write_data(s, 0);
1841 p->status = USB_RET_STALL;
1846 static void usb_mtp_handle_data(USBDevice *dev, USBPacket *p)
1848 MTPState *s = USB_MTP(dev);
1850 mtp_container container;
1852 uint16_t container_type;
1855 switch (p->ep->nr) {
1857 if (s->data_out != NULL) {
1859 trace_usb_mtp_stall(s->dev.addr, "awaiting data-out");
1860 p->status = USB_RET_STALL;
1863 if (p->iov.size < sizeof(container)) {
1864 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1865 p->status = USB_RET_STALL;
1868 if (s->data_in != NULL) {
1869 MTPData *d = s->data_in;
1870 uint64_t dlen = d->length - d->offset;
1872 trace_usb_mtp_data_in(s->dev.addr, d->trans, d->length);
1873 if (d->length + sizeof(container) > 0xFFFFFFFF) {
1874 container.length = cpu_to_le32(0xFFFFFFFF);
1877 cpu_to_le32(d->length + sizeof(container));
1879 container.type = cpu_to_le16(TYPE_DATA);
1880 container.code = cpu_to_le16(d->code);
1881 container.trans = cpu_to_le32(d->trans);
1882 usb_packet_copy(p, &container, sizeof(container));
1884 if (dlen > p->iov.size - sizeof(container)) {
1885 dlen = p->iov.size - sizeof(container);
1888 if (dlen > p->iov.size) {
1893 usb_packet_copy(p, d->data + d->offset, dlen);
1895 if (d->alloc < p->iov.size) {
1896 d->alloc = p->iov.size;
1897 d->data = g_realloc(d->data, d->alloc);
1899 rc = read(d->fd, d->data, dlen);
1901 memset(d->data, 0, dlen);
1902 s->result->code = RES_INCOMPLETE_TRANSFER;
1904 usb_packet_copy(p, d->data, dlen);
1907 if (d->offset == d->length) {
1908 usb_mtp_data_free(s->data_in);
1911 } else if (s->result != NULL) {
1912 MTPControl *r = s->result;
1913 int length = sizeof(container) + r->argc * sizeof(uint32_t);
1914 if (r->code == RES_OK) {
1915 trace_usb_mtp_success(s->dev.addr, r->trans,
1916 (r->argc > 0) ? r->argv[0] : 0,
1917 (r->argc > 1) ? r->argv[1] : 0);
1919 trace_usb_mtp_error(s->dev.addr, r->code, r->trans,
1920 (r->argc > 0) ? r->argv[0] : 0,
1921 (r->argc > 1) ? r->argv[1] : 0);
1923 container.length = cpu_to_le32(length);
1924 container.type = cpu_to_le16(TYPE_RESPONSE);
1925 container.code = cpu_to_le16(r->code);
1926 container.trans = cpu_to_le32(r->trans);
1927 for (i = 0; i < r->argc; i++) {
1928 params[i] = cpu_to_le32(r->argv[i]);
1930 usb_packet_copy(p, &container, sizeof(container));
1931 usb_packet_copy(p, ¶ms, length - sizeof(container));
1937 if (p->iov.size < sizeof(container)) {
1938 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1939 p->status = USB_RET_STALL;
1942 if ((s->data_out != NULL) && !s->data_out->first) {
1943 container_type = TYPE_DATA;
1945 usb_packet_copy(p, &container, sizeof(container));
1946 container_type = le16_to_cpu(container.type);
1948 switch (container_type) {
1950 if (s->data_in || s->data_out || s->result) {
1951 trace_usb_mtp_stall(s->dev.addr, "transaction inflight");
1952 p->status = USB_RET_STALL;
1955 cmd.code = le16_to_cpu(container.code);
1956 cmd.argc = (le32_to_cpu(container.length) - sizeof(container))
1958 cmd.trans = le32_to_cpu(container.trans);
1959 if (cmd.argc > ARRAY_SIZE(cmd.argv)) {
1960 cmd.argc = ARRAY_SIZE(cmd.argv);
1962 if (p->iov.size < sizeof(container) + cmd.argc * sizeof(uint32_t)) {
1963 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1964 p->status = USB_RET_STALL;
1967 usb_packet_copy(p, ¶ms, cmd.argc * sizeof(uint32_t));
1968 for (i = 0; i < cmd.argc; i++) {
1969 cmd.argv[i] = le32_to_cpu(params[i]);
1971 trace_usb_mtp_command(s->dev.addr, cmd.code, cmd.trans,
1972 (cmd.argc > 0) ? cmd.argv[0] : 0,
1973 (cmd.argc > 1) ? cmd.argv[1] : 0,
1974 (cmd.argc > 2) ? cmd.argv[2] : 0,
1975 (cmd.argc > 3) ? cmd.argv[3] : 0,
1976 (cmd.argc > 4) ? cmd.argv[4] : 0);
1977 usb_mtp_command(s, &cmd);
1980 /* One of the previous transfers has already errored but the
1981 * responder is still sending data associated with it
1983 if (s->result != NULL) {
1986 usb_mtp_get_data(s, &container, p);
1989 /* not needed as long as the mtp device is read-only */
1990 p->status = USB_RET_STALL;
1995 if (!QTAILQ_EMPTY(&s->events)) {
1996 struct MTPMonEntry *e = QTAILQ_LAST(&s->events);
1998 int len = sizeof(container) + sizeof(uint32_t);
2000 if (p->iov.size < len) {
2001 trace_usb_mtp_stall(s->dev.addr,
2002 "packet too small to send event");
2003 p->status = USB_RET_STALL;
2007 QTAILQ_REMOVE(&s->events, e, next);
2008 container.length = cpu_to_le32(len);
2009 container.type = cpu_to_le32(TYPE_EVENT);
2010 container.code = cpu_to_le16(e->event);
2011 container.trans = 0; /* no trans specific events */
2012 handle = cpu_to_le32(e->handle);
2013 usb_packet_copy(p, &container, sizeof(container));
2014 usb_packet_copy(p, &handle, sizeof(uint32_t));
2018 p->status = USB_RET_NAK;
2021 trace_usb_mtp_stall(s->dev.addr, "invalid endpoint");
2022 p->status = USB_RET_STALL;
2026 if (p->actual_length == 0) {
2027 trace_usb_mtp_nak(s->dev.addr, p->ep->nr);
2028 p->status = USB_RET_NAK;
2031 trace_usb_mtp_xfer(s->dev.addr, p->ep->nr, p->actual_length,
2037 static void usb_mtp_realize(USBDevice *dev, Error **errp)
2039 MTPState *s = USB_MTP(dev);
2041 if ((s->root == NULL) || !g_path_is_absolute(s->root)) {
2042 error_setg(errp, "usb-mtp: rootdir must be configured and be an absolute path");
2046 if (access(s->root, R_OK) != 0) {
2047 error_setg(errp, "usb-mtp: rootdir does not exist/not readable");
2049 } else if (!s->readonly && access(s->root, W_OK) != 0) {
2050 error_setg(errp, "usb-mtp: rootdir does not have write permissions");
2054 /* Mark store as RW */
2056 s->flags |= (1 << MTP_FLAG_WRITABLE);
2059 if (s->desc == NULL) {
2061 * This does not check if path exists
2062 * but we have the checks above
2064 s->desc = g_path_get_basename(s->root);
2067 usb_desc_create_serial(dev);
2069 QTAILQ_INIT(&s->objects);
2073 static const VMStateDescription vmstate_usb_mtp = {
2077 .minimum_version_id = 1,
2078 .fields = (VMStateField[]) {
2079 VMSTATE_USB_DEVICE(dev, MTPState),
2080 VMSTATE_END_OF_LIST()
2084 static Property mtp_properties[] = {
2085 DEFINE_PROP_STRING("rootdir", MTPState, root),
2086 DEFINE_PROP_STRING("desc", MTPState, desc),
2087 DEFINE_PROP_BOOL("readonly", MTPState, readonly, true),
2088 DEFINE_PROP_END_OF_LIST(),
2091 static void usb_mtp_class_initfn(ObjectClass *klass, void *data)
2093 DeviceClass *dc = DEVICE_CLASS(klass);
2094 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
2096 uc->realize = usb_mtp_realize;
2097 uc->product_desc = "QEMU USB MTP";
2098 uc->usb_desc = &desc;
2099 uc->cancel_packet = usb_mtp_cancel_packet;
2100 uc->handle_attach = usb_desc_attach;
2101 uc->handle_reset = usb_mtp_handle_reset;
2102 uc->handle_control = usb_mtp_handle_control;
2103 uc->handle_data = usb_mtp_handle_data;
2104 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
2105 dc->desc = "USB Media Transfer Protocol device";
2106 dc->fw_name = "mtp";
2107 dc->vmsd = &vmstate_usb_mtp;
2108 device_class_set_props(dc, mtp_properties);
2111 static TypeInfo mtp_info = {
2112 .name = TYPE_USB_MTP,
2113 .parent = TYPE_USB_DEVICE,
2114 .instance_size = sizeof(MTPState),
2115 .class_init = usb_mtp_class_initfn,
2118 static void usb_mtp_register_types(void)
2120 type_register_static(&mtp_info);
2123 type_init(usb_mtp_register_types)