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 "qapi/error.h"
14 #include "qemu/error-report.h"
18 #include <sys/statvfs.h>
22 #include "qemu/module.h"
23 #include "qemu/filemonitor.h"
27 #include "qemu/units.h"
29 /* ----------------------------------------------------------------------- */
31 enum mtp_container_type {
38 /* MTP write stage, for internal use only */
39 enum mtp_write_status {
47 CMD_GET_DEVICE_INFO = 0x1001,
48 CMD_OPEN_SESSION = 0x1002,
49 CMD_CLOSE_SESSION = 0x1003,
50 CMD_GET_STORAGE_IDS = 0x1004,
51 CMD_GET_STORAGE_INFO = 0x1005,
52 CMD_GET_NUM_OBJECTS = 0x1006,
53 CMD_GET_OBJECT_HANDLES = 0x1007,
54 CMD_GET_OBJECT_INFO = 0x1008,
55 CMD_GET_OBJECT = 0x1009,
56 CMD_DELETE_OBJECT = 0x100b,
57 CMD_SEND_OBJECT_INFO = 0x100c,
58 CMD_SEND_OBJECT = 0x100d,
59 CMD_GET_PARTIAL_OBJECT = 0x101b,
60 CMD_GET_OBJECT_PROPS_SUPPORTED = 0x9801,
61 CMD_GET_OBJECT_PROP_DESC = 0x9802,
62 CMD_GET_OBJECT_PROP_VALUE = 0x9803,
66 RES_GENERAL_ERROR = 0x2002,
67 RES_SESSION_NOT_OPEN = 0x2003,
68 RES_INVALID_TRANSACTION_ID = 0x2004,
69 RES_OPERATION_NOT_SUPPORTED = 0x2005,
70 RES_PARAMETER_NOT_SUPPORTED = 0x2006,
71 RES_INCOMPLETE_TRANSFER = 0x2007,
72 RES_INVALID_STORAGE_ID = 0x2008,
73 RES_INVALID_OBJECT_HANDLE = 0x2009,
74 RES_INVALID_OBJECT_FORMAT_CODE = 0x200b,
75 RES_STORE_FULL = 0x200c,
76 RES_STORE_READ_ONLY = 0x200e,
77 RES_PARTIAL_DELETE = 0x2012,
78 RES_STORE_NOT_AVAILABLE = 0x2013,
79 RES_SPEC_BY_FORMAT_UNSUPPORTED = 0x2014,
80 RES_INVALID_OBJECTINFO = 0x2015,
81 RES_DESTINATION_UNSUPPORTED = 0x2020,
82 RES_INVALID_PARENT_OBJECT = 0x201a,
83 RES_INVALID_PARAMETER = 0x201d,
84 RES_SESSION_ALREADY_OPEN = 0x201e,
85 RES_INVALID_OBJECT_PROP_CODE = 0xA801,
88 FMT_UNDEFINED_OBJECT = 0x3000,
89 FMT_ASSOCIATION = 0x3001,
92 EVT_CANCEL_TRANSACTION = 0x4001,
93 EVT_OBJ_ADDED = 0x4002,
94 EVT_OBJ_REMOVED = 0x4003,
95 EVT_OBJ_INFO_CHANGED = 0x4007,
97 /* object properties */
98 PROP_STORAGE_ID = 0xDC01,
99 PROP_OBJECT_FORMAT = 0xDC02,
100 PROP_OBJECT_COMPRESSED_SIZE = 0xDC04,
101 PROP_PARENT_OBJECT = 0xDC0B,
102 PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER = 0xDC41,
107 DATA_TYPE_UINT16 = 0x0004,
108 DATA_TYPE_UINT32 = 0x0006,
109 DATA_TYPE_UINT64 = 0x0008,
110 DATA_TYPE_UINT128 = 0x000a,
111 DATA_TYPE_STRING = 0xffff,
119 } QEMU_PACKED mtp_container;
121 /* ----------------------------------------------------------------------- */
123 typedef struct MTPState MTPState;
124 typedef struct MTPControl MTPControl;
125 typedef struct MTPData MTPData;
126 typedef struct MTPObject MTPObject;
134 typedef struct MTPMonEntry MTPMonEntry;
140 QTAILQ_ENTRY(MTPMonEntry) next;
158 /* Used for >4G file sizes */
161 uint8_t write_status;
162 /* Internal pointer per every MTP_WRITE_BUF_SZ */
163 uint64_t data_offset;
172 /* file monitor watch id */
176 QLIST_HEAD(, MTPObject) children;
177 QLIST_ENTRY(MTPObject) list;
179 QTAILQ_ENTRY(MTPObject) next;
192 uint32_t next_handle;
195 QTAILQ_HEAD(, MTPObject) objects;
196 QFileMonitor *file_monitor;
197 QTAILQ_HEAD(, MTPMonEntry) events;
198 /* Responder is expecting a write operation */
201 uint32_t parent_handle;
209 * ObjectInfo dataset received from initiator
210 * Fields we don't care about are ignored
213 uint32_t storage_id; /*unused*/
215 uint16_t protection_status; /*unused*/
217 uint16_t thumb_format; /*unused*/
218 uint32_t thumb_comp_sz; /*unused*/
219 uint32_t thumb_pix_width; /*unused*/
220 uint32_t thumb_pix_height; /*unused*/
221 uint32_t image_pix_width; /*unused*/
222 uint32_t image_pix_height; /*unused*/
223 uint32_t image_bit_depth; /*unused*/
224 uint32_t parent; /*unused*/
227 uint32_t seq_no; /*unused*/
228 uint8_t length; /*part of filename field*/
229 uint8_t filename[0]; /* UTF-16 encoded */
230 char date_created[0]; /*unused*/
231 char date_modified[0]; /*unused*/
232 char keywords[0]; /*unused*/
233 /* string and other data follows */
234 } QEMU_PACKED ObjectInfo;
236 #define TYPE_USB_MTP "usb-mtp"
237 #define USB_MTP(obj) OBJECT_CHECK(MTPState, (obj), TYPE_USB_MTP)
239 #define QEMU_STORAGE_ID 0x00010001
241 #define MTP_FLAG_WRITABLE 0
243 #define FLAG_SET(_mtp, _flag) ((_mtp)->flags & (1 << (_flag)))
245 /* ----------------------------------------------------------------------- */
247 #define MTP_MANUFACTURER "QEMU"
248 #define MTP_PRODUCT "QEMU filesharing"
249 #define MTP_WRITE_BUF_SZ (512 * KiB)
252 STR_MANUFACTURER = 1,
261 static const USBDescStrings desc_strings = {
262 [STR_MANUFACTURER] = MTP_MANUFACTURER,
263 [STR_PRODUCT] = MTP_PRODUCT,
264 [STR_SERIALNUMBER] = "34617",
266 [STR_CONFIG_FULL] = "Full speed config (usb 1.1)",
267 [STR_CONFIG_HIGH] = "High speed config (usb 2.0)",
268 [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
271 static const USBDescIface desc_iface_full = {
272 .bInterfaceNumber = 0,
274 .bInterfaceClass = USB_CLASS_STILL_IMAGE,
275 .bInterfaceSubClass = 0x01,
276 .bInterfaceProtocol = 0x01,
277 .iInterface = STR_MTP,
278 .eps = (USBDescEndpoint[]) {
280 .bEndpointAddress = USB_DIR_IN | EP_DATA_IN,
281 .bmAttributes = USB_ENDPOINT_XFER_BULK,
282 .wMaxPacketSize = 64,
284 .bEndpointAddress = USB_DIR_OUT | EP_DATA_OUT,
285 .bmAttributes = USB_ENDPOINT_XFER_BULK,
286 .wMaxPacketSize = 64,
288 .bEndpointAddress = USB_DIR_IN | EP_EVENT,
289 .bmAttributes = USB_ENDPOINT_XFER_INT,
290 .wMaxPacketSize = 64,
296 static const USBDescDevice desc_device_full = {
298 .bMaxPacketSize0 = 8,
299 .bNumConfigurations = 1,
300 .confs = (USBDescConfig[]) {
303 .bConfigurationValue = 1,
304 .iConfiguration = STR_CONFIG_FULL,
305 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
308 .ifs = &desc_iface_full,
313 static const USBDescIface desc_iface_high = {
314 .bInterfaceNumber = 0,
316 .bInterfaceClass = USB_CLASS_STILL_IMAGE,
317 .bInterfaceSubClass = 0x01,
318 .bInterfaceProtocol = 0x01,
319 .iInterface = STR_MTP,
320 .eps = (USBDescEndpoint[]) {
322 .bEndpointAddress = USB_DIR_IN | EP_DATA_IN,
323 .bmAttributes = USB_ENDPOINT_XFER_BULK,
324 .wMaxPacketSize = 512,
326 .bEndpointAddress = USB_DIR_OUT | EP_DATA_OUT,
327 .bmAttributes = USB_ENDPOINT_XFER_BULK,
328 .wMaxPacketSize = 512,
330 .bEndpointAddress = USB_DIR_IN | EP_EVENT,
331 .bmAttributes = USB_ENDPOINT_XFER_INT,
332 .wMaxPacketSize = 64,
338 static const USBDescDevice desc_device_high = {
340 .bMaxPacketSize0 = 64,
341 .bNumConfigurations = 1,
342 .confs = (USBDescConfig[]) {
345 .bConfigurationValue = 1,
346 .iConfiguration = STR_CONFIG_HIGH,
347 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
350 .ifs = &desc_iface_high,
355 static const USBDescMSOS desc_msos = {
356 .CompatibleID = "MTP",
357 .SelectiveSuspendEnabled = true,
360 static const USBDesc desc = {
362 .idVendor = 0x46f4, /* CRC16() of "QEMU" */
365 .iManufacturer = STR_MANUFACTURER,
366 .iProduct = STR_PRODUCT,
367 .iSerialNumber = STR_SERIALNUMBER,
369 .full = &desc_device_full,
370 .high = &desc_device_high,
375 /* ----------------------------------------------------------------------- */
377 static MTPObject *usb_mtp_object_alloc(MTPState *s, uint32_t handle,
378 MTPObject *parent, const char *name)
380 MTPObject *o = g_new0(MTPObject, 1);
382 if (name[0] == '.') {
389 o->name = g_strdup(name);
390 if (parent == NULL) {
391 o->path = g_strdup(name);
393 o->path = g_strdup_printf("%s/%s", parent->path, name);
396 if (lstat(o->path, &o->stat) != 0) {
399 if (S_ISREG(o->stat.st_mode)) {
400 o->format = FMT_UNDEFINED_OBJECT;
401 } else if (S_ISDIR(o->stat.st_mode)) {
402 o->format = FMT_ASSOCIATION;
407 if (access(o->path, R_OK) != 0) {
411 trace_usb_mtp_object_alloc(s->dev.addr, o->handle, o->path);
413 QTAILQ_INSERT_TAIL(&s->objects, o, next);
423 static void usb_mtp_object_free(MTPState *s, MTPObject *o)
431 trace_usb_mtp_object_free(s->dev.addr, o->handle, o->path);
433 if (o->watchid != -1 && s->file_monitor) {
434 qemu_file_monitor_remove_watch(s->file_monitor, o->path, o->watchid);
437 QTAILQ_REMOVE(&s->objects, o, next);
439 QLIST_REMOVE(o, list);
440 o->parent->nchildren--;
443 while (!QLIST_EMPTY(&o->children)) {
444 iter = QLIST_FIRST(&o->children);
445 usb_mtp_object_free(s, iter);
452 static MTPObject *usb_mtp_object_lookup(MTPState *s, uint32_t handle)
456 QTAILQ_FOREACH(o, &s->objects, next) {
457 if (o->handle == handle) {
464 static MTPObject *usb_mtp_add_child(MTPState *s, MTPObject *o,
468 usb_mtp_object_alloc(s, s->next_handle++, o, name);
471 trace_usb_mtp_add_child(s->dev.addr, child->handle, child->path);
472 QLIST_INSERT_HEAD(&o->children, child, list);
475 if (child->format == FMT_ASSOCIATION) {
476 QLIST_INIT(&child->children);
483 static MTPObject *usb_mtp_object_lookup_name(MTPObject *parent,
484 const char *name, int len)
492 QLIST_FOREACH(iter, &parent->children, list) {
493 if (strncmp(iter->name, name, len) == 0) {
501 static MTPObject *usb_mtp_object_lookup_id(MTPState *s, int64_t id)
505 QTAILQ_FOREACH(iter, &s->objects, next) {
506 if (iter->watchid == id) {
514 static void file_monitor_event(int64_t id,
515 QFileMonitorEvent ev,
519 MTPState *s = opaque;
520 MTPObject *parent = usb_mtp_object_lookup_id(s, id);
521 MTPMonEntry *entry = NULL;
529 case QFILE_MONITOR_EVENT_CREATED:
530 if (usb_mtp_object_lookup_name(parent, name, -1)) {
531 /* Duplicate create event */
534 entry = g_new0(MTPMonEntry, 1);
535 entry->handle = s->next_handle;
536 entry->event = EVT_OBJ_ADDED;
537 o = usb_mtp_add_child(s, parent, name);
542 trace_usb_mtp_file_monitor_event(s->dev.addr, name, "Obj Added");
545 case QFILE_MONITOR_EVENT_DELETED:
547 * The kernel issues a IN_IGNORED event
548 * when a dir containing a watchpoint is
549 * deleted, so we don't have to delete the
552 o = usb_mtp_object_lookup_name(parent, name, -1);
556 entry = g_new0(MTPMonEntry, 1);
557 entry->handle = o->handle;
558 entry->event = EVT_OBJ_REMOVED;
559 trace_usb_mtp_file_monitor_event(s->dev.addr, o->path, "Obj Deleted");
560 usb_mtp_object_free(s, o);
563 case QFILE_MONITOR_EVENT_MODIFIED:
564 o = usb_mtp_object_lookup_name(parent, name, -1);
568 entry = g_new0(MTPMonEntry, 1);
569 entry->handle = o->handle;
570 entry->event = EVT_OBJ_INFO_CHANGED;
571 trace_usb_mtp_file_monitor_event(s->dev.addr, o->path, "Obj Modified");
574 case QFILE_MONITOR_EVENT_IGNORED:
575 trace_usb_mtp_file_monitor_event(s->dev.addr, parent->path,
576 "Obj parent dir ignored");
579 case QFILE_MONITOR_EVENT_ATTRIBUTES:
583 g_assert_not_reached();
587 QTAILQ_INSERT_HEAD(&s->events, entry, next);
591 static void usb_mtp_file_monitor_cleanup(MTPState *s)
595 QTAILQ_FOREACH_SAFE(e, &s->events, next, p) {
596 QTAILQ_REMOVE(&s->events, e, next);
600 qemu_file_monitor_free(s->file_monitor);
601 s->file_monitor = NULL;
605 static void usb_mtp_object_readdir(MTPState *s, MTPObject *o)
607 struct dirent *entry;
612 if (o->have_children) {
615 o->have_children = true;
617 fd = open(o->path, O_DIRECTORY | O_CLOEXEC | O_NOFOLLOW);
627 if (s->file_monitor) {
628 int64_t id = qemu_file_monitor_add_watch(s->file_monitor, o->path, NULL,
629 file_monitor_event, s, &err);
631 error_report("usb-mtp: failed to add watch for %s: %s", o->path,
632 error_get_pretty(err));
635 trace_usb_mtp_file_monitor_event(s->dev.addr, o->path,
641 while ((entry = readdir(dir)) != NULL) {
642 usb_mtp_add_child(s, o, entry->d_name);
647 /* ----------------------------------------------------------------------- */
649 static MTPData *usb_mtp_data_alloc(MTPControl *c)
651 MTPData *data = g_new0(MTPData, 1);
653 data->code = c->code;
654 data->trans = c->trans;
660 static void usb_mtp_data_free(MTPData *data)
665 if (data->fd != -1) {
672 static void usb_mtp_realloc(MTPData *data, uint32_t bytes)
674 if (data->length + bytes <= data->alloc) {
677 data->alloc = (data->length + bytes + 0xff) & ~0xff;
678 data->data = g_realloc(data->data, data->alloc);
681 static void usb_mtp_add_u8(MTPData *data, uint8_t val)
683 usb_mtp_realloc(data, 1);
684 data->data[data->length++] = val;
687 static void usb_mtp_add_u16(MTPData *data, uint16_t val)
689 usb_mtp_realloc(data, 2);
690 data->data[data->length++] = (val >> 0) & 0xff;
691 data->data[data->length++] = (val >> 8) & 0xff;
694 static void usb_mtp_add_u32(MTPData *data, uint32_t val)
696 usb_mtp_realloc(data, 4);
697 data->data[data->length++] = (val >> 0) & 0xff;
698 data->data[data->length++] = (val >> 8) & 0xff;
699 data->data[data->length++] = (val >> 16) & 0xff;
700 data->data[data->length++] = (val >> 24) & 0xff;
703 static void usb_mtp_add_u64(MTPData *data, uint64_t val)
705 usb_mtp_realloc(data, 8);
706 data->data[data->length++] = (val >> 0) & 0xff;
707 data->data[data->length++] = (val >> 8) & 0xff;
708 data->data[data->length++] = (val >> 16) & 0xff;
709 data->data[data->length++] = (val >> 24) & 0xff;
710 data->data[data->length++] = (val >> 32) & 0xff;
711 data->data[data->length++] = (val >> 40) & 0xff;
712 data->data[data->length++] = (val >> 48) & 0xff;
713 data->data[data->length++] = (val >> 56) & 0xff;
716 static void usb_mtp_add_u16_array(MTPData *data, uint32_t len,
717 const uint16_t *vals)
721 usb_mtp_add_u32(data, len);
722 for (i = 0; i < len; i++) {
723 usb_mtp_add_u16(data, vals[i]);
727 static void usb_mtp_add_u32_array(MTPData *data, uint32_t len,
728 const uint32_t *vals)
732 usb_mtp_add_u32(data, len);
733 for (i = 0; i < len; i++) {
734 usb_mtp_add_u32(data, vals[i]);
738 static void usb_mtp_add_wstr(MTPData *data, const wchar_t *str)
740 uint32_t len = wcslen(str);
744 len++; /* include terminating L'\0' */
747 usb_mtp_add_u8(data, len);
748 for (i = 0; i < len; i++) {
749 usb_mtp_add_u16(data, str[i]);
753 static void usb_mtp_add_str(MTPData *data, const char *str)
755 uint32_t len = strlen(str)+1;
756 wchar_t *wstr = g_new(wchar_t, len);
759 ret = mbstowcs(wstr, str, len);
761 usb_mtp_add_wstr(data, L"Oops");
763 usb_mtp_add_wstr(data, wstr);
769 static void usb_mtp_add_time(MTPData *data, time_t time)
774 gmtime_r(&time, &tm);
775 strftime(buf, sizeof(buf), "%Y%m%dT%H%M%S", &tm);
776 usb_mtp_add_str(data, buf);
779 /* ----------------------------------------------------------------------- */
781 static void usb_mtp_queue_result(MTPState *s, uint16_t code, uint32_t trans,
782 int argc, uint32_t arg0, uint32_t arg1,
785 MTPControl *c = g_new0(MTPControl, 1);
800 assert(s->result == NULL);
804 /* ----------------------------------------------------------------------- */
806 static MTPData *usb_mtp_get_device_info(MTPState *s, MTPControl *c)
808 static const uint16_t ops[] = {
813 CMD_GET_STORAGE_INFO,
815 CMD_GET_OBJECT_HANDLES,
818 CMD_SEND_OBJECT_INFO,
821 CMD_GET_PARTIAL_OBJECT,
822 CMD_GET_OBJECT_PROPS_SUPPORTED,
823 CMD_GET_OBJECT_PROP_DESC,
824 CMD_GET_OBJECT_PROP_VALUE,
826 static const uint16_t fmt[] = {
827 FMT_UNDEFINED_OBJECT,
830 MTPData *d = usb_mtp_data_alloc(c);
832 trace_usb_mtp_op_get_device_info(s->dev.addr);
834 usb_mtp_add_u16(d, 100);
835 usb_mtp_add_u32(d, 0x00000006);
836 usb_mtp_add_u16(d, 0x0064);
837 usb_mtp_add_wstr(d, L"");
838 usb_mtp_add_u16(d, 0x0000);
840 usb_mtp_add_u16_array(d, ARRAY_SIZE(ops), ops);
841 usb_mtp_add_u16_array(d, 0, NULL);
842 usb_mtp_add_u16_array(d, 0, NULL);
843 usb_mtp_add_u16_array(d, 0, NULL);
844 usb_mtp_add_u16_array(d, ARRAY_SIZE(fmt), fmt);
846 usb_mtp_add_wstr(d, L"" MTP_MANUFACTURER);
847 usb_mtp_add_wstr(d, L"" MTP_PRODUCT);
848 usb_mtp_add_wstr(d, L"0.1");
849 usb_mtp_add_wstr(d, L"0123456789abcdef0123456789abcdef");
854 static MTPData *usb_mtp_get_storage_ids(MTPState *s, MTPControl *c)
856 static const uint32_t ids[] = {
859 MTPData *d = usb_mtp_data_alloc(c);
861 trace_usb_mtp_op_get_storage_ids(s->dev.addr);
863 usb_mtp_add_u32_array(d, ARRAY_SIZE(ids), ids);
868 static MTPData *usb_mtp_get_storage_info(MTPState *s, MTPControl *c)
870 MTPData *d = usb_mtp_data_alloc(c);
874 trace_usb_mtp_op_get_storage_info(s->dev.addr);
876 if (FLAG_SET(s, MTP_FLAG_WRITABLE)) {
877 usb_mtp_add_u16(d, 0x0003);
878 usb_mtp_add_u16(d, 0x0002);
879 usb_mtp_add_u16(d, 0x0000);
881 usb_mtp_add_u16(d, 0x0001);
882 usb_mtp_add_u16(d, 0x0002);
883 usb_mtp_add_u16(d, 0x0001);
886 rc = statvfs(s->root, &buf);
888 usb_mtp_add_u64(d, (uint64_t)buf.f_frsize * buf.f_blocks);
889 usb_mtp_add_u64(d, (uint64_t)buf.f_bavail * buf.f_blocks);
890 usb_mtp_add_u32(d, buf.f_ffree);
892 usb_mtp_add_u64(d, 0xffffffff);
893 usb_mtp_add_u64(d, 0xffffffff);
894 usb_mtp_add_u32(d, 0xffffffff);
897 usb_mtp_add_str(d, s->desc);
898 usb_mtp_add_wstr(d, L"123456789abcdef");
902 static MTPData *usb_mtp_get_object_handles(MTPState *s, MTPControl *c,
905 MTPData *d = usb_mtp_data_alloc(c);
906 uint32_t i = 0, handles[o->nchildren];
909 trace_usb_mtp_op_get_object_handles(s->dev.addr, o->handle, o->path);
911 QLIST_FOREACH(iter, &o->children, list) {
912 handles[i++] = iter->handle;
914 assert(i == o->nchildren);
915 usb_mtp_add_u32_array(d, o->nchildren, handles);
920 static MTPData *usb_mtp_get_object_info(MTPState *s, MTPControl *c,
923 MTPData *d = usb_mtp_data_alloc(c);
925 trace_usb_mtp_op_get_object_info(s->dev.addr, o->handle, o->path);
927 usb_mtp_add_u32(d, QEMU_STORAGE_ID);
928 usb_mtp_add_u16(d, o->format);
929 usb_mtp_add_u16(d, 0);
931 if (o->stat.st_size > 0xFFFFFFFF) {
932 usb_mtp_add_u32(d, 0xFFFFFFFF);
934 usb_mtp_add_u32(d, o->stat.st_size);
937 usb_mtp_add_u16(d, 0);
938 usb_mtp_add_u32(d, 0);
939 usb_mtp_add_u32(d, 0);
940 usb_mtp_add_u32(d, 0);
941 usb_mtp_add_u32(d, 0);
942 usb_mtp_add_u32(d, 0);
943 usb_mtp_add_u32(d, 0);
946 usb_mtp_add_u32(d, o->parent->handle);
948 usb_mtp_add_u32(d, 0);
950 if (o->format == FMT_ASSOCIATION) {
951 usb_mtp_add_u16(d, 0x0001);
952 usb_mtp_add_u32(d, 0x00000001);
953 usb_mtp_add_u32(d, 0);
955 usb_mtp_add_u16(d, 0);
956 usb_mtp_add_u32(d, 0);
957 usb_mtp_add_u32(d, 0);
960 usb_mtp_add_str(d, o->name);
961 usb_mtp_add_time(d, o->stat.st_ctime);
962 usb_mtp_add_time(d, o->stat.st_mtime);
963 usb_mtp_add_wstr(d, L"");
968 static MTPData *usb_mtp_get_object(MTPState *s, MTPControl *c,
971 MTPData *d = usb_mtp_data_alloc(c);
973 trace_usb_mtp_op_get_object(s->dev.addr, o->handle, o->path);
975 d->fd = open(o->path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
977 usb_mtp_data_free(d);
980 d->length = o->stat.st_size;
982 d->data = g_malloc(d->alloc);
986 static MTPData *usb_mtp_get_partial_object(MTPState *s, MTPControl *c,
995 trace_usb_mtp_op_get_partial_object(s->dev.addr, o->handle, o->path,
996 c->argv[1], c->argv[2]);
998 d = usb_mtp_data_alloc(c);
999 d->fd = open(o->path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
1001 usb_mtp_data_free(d);
1005 offset = c->argv[1];
1006 if (offset > o->stat.st_size) {
1007 offset = o->stat.st_size;
1009 if (lseek(d->fd, offset, SEEK_SET) < 0) {
1010 usb_mtp_data_free(d);
1014 d->length = c->argv[2];
1015 if (d->length > o->stat.st_size - offset) {
1016 d->length = o->stat.st_size - offset;
1022 static MTPData *usb_mtp_get_object_props_supported(MTPState *s, MTPControl *c)
1024 static const uint16_t props[] = {
1027 PROP_OBJECT_COMPRESSED_SIZE,
1029 PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER,
1032 MTPData *d = usb_mtp_data_alloc(c);
1033 usb_mtp_add_u16_array(d, ARRAY_SIZE(props), props);
1038 static MTPData *usb_mtp_get_object_prop_desc(MTPState *s, MTPControl *c)
1040 MTPData *d = usb_mtp_data_alloc(c);
1041 switch (c->argv[0]) {
1042 case PROP_STORAGE_ID:
1043 usb_mtp_add_u16(d, PROP_STORAGE_ID);
1044 usb_mtp_add_u16(d, DATA_TYPE_UINT32);
1045 usb_mtp_add_u8(d, 0x00);
1046 usb_mtp_add_u32(d, 0x00000000);
1047 usb_mtp_add_u32(d, 0x00000000);
1048 usb_mtp_add_u8(d, 0x00);
1050 case PROP_OBJECT_FORMAT:
1051 usb_mtp_add_u16(d, PROP_OBJECT_FORMAT);
1052 usb_mtp_add_u16(d, DATA_TYPE_UINT16);
1053 usb_mtp_add_u8(d, 0x00);
1054 usb_mtp_add_u16(d, 0x0000);
1055 usb_mtp_add_u32(d, 0x00000000);
1056 usb_mtp_add_u8(d, 0x00);
1058 case PROP_OBJECT_COMPRESSED_SIZE:
1059 usb_mtp_add_u16(d, PROP_OBJECT_COMPRESSED_SIZE);
1060 usb_mtp_add_u16(d, DATA_TYPE_UINT64);
1061 usb_mtp_add_u8(d, 0x00);
1062 usb_mtp_add_u64(d, 0x0000000000000000);
1063 usb_mtp_add_u32(d, 0x00000000);
1064 usb_mtp_add_u8(d, 0x00);
1066 case PROP_PARENT_OBJECT:
1067 usb_mtp_add_u16(d, PROP_PARENT_OBJECT);
1068 usb_mtp_add_u16(d, DATA_TYPE_UINT32);
1069 usb_mtp_add_u8(d, 0x00);
1070 usb_mtp_add_u32(d, 0x00000000);
1071 usb_mtp_add_u32(d, 0x00000000);
1072 usb_mtp_add_u8(d, 0x00);
1074 case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER:
1075 usb_mtp_add_u16(d, PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER);
1076 usb_mtp_add_u16(d, DATA_TYPE_UINT128);
1077 usb_mtp_add_u8(d, 0x00);
1078 usb_mtp_add_u64(d, 0x0000000000000000);
1079 usb_mtp_add_u64(d, 0x0000000000000000);
1080 usb_mtp_add_u32(d, 0x00000000);
1081 usb_mtp_add_u8(d, 0x00);
1084 usb_mtp_add_u16(d, PROP_NAME);
1085 usb_mtp_add_u16(d, DATA_TYPE_STRING);
1086 usb_mtp_add_u8(d, 0x00);
1087 usb_mtp_add_u8(d, 0x00);
1088 usb_mtp_add_u32(d, 0x00000000);
1089 usb_mtp_add_u8(d, 0x00);
1092 usb_mtp_data_free(d);
1099 static MTPData *usb_mtp_get_object_prop_value(MTPState *s, MTPControl *c,
1102 MTPData *d = usb_mtp_data_alloc(c);
1103 switch (c->argv[1]) {
1104 case PROP_STORAGE_ID:
1105 usb_mtp_add_u32(d, QEMU_STORAGE_ID);
1107 case PROP_OBJECT_FORMAT:
1108 usb_mtp_add_u16(d, o->format);
1110 case PROP_OBJECT_COMPRESSED_SIZE:
1111 usb_mtp_add_u64(d, o->stat.st_size);
1113 case PROP_PARENT_OBJECT:
1114 if (o->parent == NULL) {
1115 usb_mtp_add_u32(d, 0x00000000);
1117 usb_mtp_add_u32(d, o->parent->handle);
1120 case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER:
1121 /* Should be persistent between sessions,
1122 * but using our objedt ID is "good enough"
1124 usb_mtp_add_u64(d, 0x0000000000000000);
1125 usb_mtp_add_u64(d, o->handle);
1128 usb_mtp_add_str(d, o->name);
1131 usb_mtp_data_free(d);
1139 * Return values when object @o is deleted.
1140 * If at least one of the deletions succeeded,
1141 * DELETE_SUCCESS is set and if at least one
1142 * of the deletions failed, DELETE_FAILURE is
1143 * set. Both bits being set (DELETE_PARTIAL)
1144 * signifies a RES_PARTIAL_DELETE being sent
1145 * back to the initiator.
1148 DELETE_SUCCESS = (1 << 0),
1149 DELETE_FAILURE = (1 << 1),
1150 DELETE_PARTIAL = (DELETE_FAILURE | DELETE_SUCCESS),
1153 static int usb_mtp_deletefn(MTPState *s, MTPObject *o, uint32_t trans)
1155 MTPObject *iter, *iter2;
1159 * TODO: Add support for Protection Status
1162 QLIST_FOREACH(iter, &o->children, list) {
1163 if (iter->format == FMT_ASSOCIATION) {
1164 QLIST_FOREACH(iter2, &iter->children, list) {
1165 ret |= usb_mtp_deletefn(s, iter2, trans);
1170 if (o->format == FMT_UNDEFINED_OBJECT) {
1171 if (remove(o->path)) {
1172 ret |= DELETE_FAILURE;
1174 usb_mtp_object_free(s, o);
1175 ret |= DELETE_SUCCESS;
1177 } else if (o->format == FMT_ASSOCIATION) {
1178 if (rmdir(o->path)) {
1179 ret |= DELETE_FAILURE;
1181 usb_mtp_object_free(s, o);
1182 ret |= DELETE_SUCCESS;
1189 static void usb_mtp_object_delete(MTPState *s, uint32_t handle,
1190 uint32_t format_code, uint32_t trans)
1195 /* Return error if store is read-only */
1196 if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1197 usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1202 if (format_code != 0) {
1203 usb_mtp_queue_result(s, RES_SPEC_BY_FORMAT_UNSUPPORTED,
1208 if (handle == 0xFFFFFFF) {
1209 o = QTAILQ_FIRST(&s->objects);
1211 o = usb_mtp_object_lookup(s, handle);
1214 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1219 ret = usb_mtp_deletefn(s, o, trans);
1221 case DELETE_SUCCESS:
1222 usb_mtp_queue_result(s, RES_OK, trans,
1225 case DELETE_FAILURE:
1226 usb_mtp_queue_result(s, RES_PARTIAL_DELETE,
1229 case DELETE_PARTIAL:
1230 usb_mtp_queue_result(s, RES_PARTIAL_DELETE,
1234 g_assert_not_reached();
1240 static void usb_mtp_command(MTPState *s, MTPControl *c)
1242 MTPData *data_in = NULL;
1243 MTPObject *o = NULL;
1244 uint32_t nres = 0, res0 = 0;
1248 if (c->code >= CMD_CLOSE_SESSION && s->session == 0) {
1249 usb_mtp_queue_result(s, RES_SESSION_NOT_OPEN,
1250 c->trans, 0, 0, 0, 0);
1254 /* process commands */
1256 case CMD_GET_DEVICE_INFO:
1257 data_in = usb_mtp_get_device_info(s, c);
1259 case CMD_OPEN_SESSION:
1261 usb_mtp_queue_result(s, RES_SESSION_ALREADY_OPEN,
1262 c->trans, 1, s->session, 0, 0);
1265 if (c->argv[0] == 0) {
1266 usb_mtp_queue_result(s, RES_INVALID_PARAMETER,
1267 c->trans, 0, 0, 0, 0);
1270 trace_usb_mtp_op_open_session(s->dev.addr);
1271 s->session = c->argv[0];
1272 usb_mtp_object_alloc(s, s->next_handle++, NULL, s->root);
1274 s->file_monitor = qemu_file_monitor_new(&err);
1276 error_report("usb-mtp: file monitoring init failed: %s",
1277 error_get_pretty(err));
1280 QTAILQ_INIT(&s->events);
1283 case CMD_CLOSE_SESSION:
1284 trace_usb_mtp_op_close_session(s->dev.addr);
1287 usb_mtp_file_monitor_cleanup(s);
1288 usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
1289 assert(QTAILQ_EMPTY(&s->objects));
1291 case CMD_GET_STORAGE_IDS:
1292 data_in = usb_mtp_get_storage_ids(s, c);
1294 case CMD_GET_STORAGE_INFO:
1295 if (c->argv[0] != QEMU_STORAGE_ID &&
1296 c->argv[0] != 0xffffffff) {
1297 usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
1298 c->trans, 0, 0, 0, 0);
1301 data_in = usb_mtp_get_storage_info(s, c);
1303 case CMD_GET_NUM_OBJECTS:
1304 case CMD_GET_OBJECT_HANDLES:
1305 if (c->argv[0] != QEMU_STORAGE_ID &&
1306 c->argv[0] != 0xffffffff) {
1307 usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
1308 c->trans, 0, 0, 0, 0);
1311 if (c->argv[1] != 0x00000000) {
1312 usb_mtp_queue_result(s, RES_SPEC_BY_FORMAT_UNSUPPORTED,
1313 c->trans, 0, 0, 0, 0);
1316 if (c->argv[2] == 0x00000000 ||
1317 c->argv[2] == 0xffffffff) {
1318 o = QTAILQ_FIRST(&s->objects);
1320 o = usb_mtp_object_lookup(s, c->argv[2]);
1323 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1324 c->trans, 0, 0, 0, 0);
1327 if (o->format != FMT_ASSOCIATION) {
1328 usb_mtp_queue_result(s, RES_INVALID_PARENT_OBJECT,
1329 c->trans, 0, 0, 0, 0);
1332 usb_mtp_object_readdir(s, o);
1333 if (c->code == CMD_GET_NUM_OBJECTS) {
1334 trace_usb_mtp_op_get_num_objects(s->dev.addr, o->handle, o->path);
1336 res0 = o->nchildren;
1338 data_in = usb_mtp_get_object_handles(s, c, o);
1341 case CMD_GET_OBJECT_INFO:
1342 o = usb_mtp_object_lookup(s, c->argv[0]);
1344 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1345 c->trans, 0, 0, 0, 0);
1348 data_in = usb_mtp_get_object_info(s, c, o);
1350 case CMD_GET_OBJECT:
1351 o = usb_mtp_object_lookup(s, c->argv[0]);
1353 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1354 c->trans, 0, 0, 0, 0);
1357 if (o->format == FMT_ASSOCIATION) {
1358 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1359 c->trans, 0, 0, 0, 0);
1362 data_in = usb_mtp_get_object(s, c, o);
1363 if (data_in == NULL) {
1364 usb_mtp_queue_result(s, RES_GENERAL_ERROR,
1365 c->trans, 0, 0, 0, 0);
1369 case CMD_DELETE_OBJECT:
1370 usb_mtp_object_delete(s, c->argv[0], c->argv[1], c->trans);
1372 case CMD_GET_PARTIAL_OBJECT:
1373 o = usb_mtp_object_lookup(s, c->argv[0]);
1375 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1376 c->trans, 0, 0, 0, 0);
1379 if (o->format == FMT_ASSOCIATION) {
1380 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1381 c->trans, 0, 0, 0, 0);
1384 data_in = usb_mtp_get_partial_object(s, c, o);
1385 if (data_in == NULL) {
1386 usb_mtp_queue_result(s, RES_GENERAL_ERROR,
1387 c->trans, 0, 0, 0, 0);
1391 res0 = data_in->length;
1393 case CMD_SEND_OBJECT_INFO:
1394 /* Return error if store is read-only */
1395 if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1396 usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1397 c->trans, 0, 0, 0, 0);
1398 } else if (c->argv[0] && (c->argv[0] != QEMU_STORAGE_ID)) {
1399 /* First parameter points to storage id or is 0 */
1400 usb_mtp_queue_result(s, RES_STORE_NOT_AVAILABLE, c->trans,
1402 } else if (c->argv[1] && !c->argv[0]) {
1403 /* If second parameter is specified, first must also be specified */
1404 usb_mtp_queue_result(s, RES_DESTINATION_UNSUPPORTED, c->trans,
1407 uint32_t handle = c->argv[1];
1408 if (handle == 0xFFFFFFFF || handle == 0) {
1410 o = QTAILQ_FIRST(&s->objects);
1412 o = usb_mtp_object_lookup(s, handle);
1415 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE, c->trans,
1417 } else if (o->format != FMT_ASSOCIATION) {
1418 usb_mtp_queue_result(s, RES_INVALID_PARENT_OBJECT, c->trans,
1423 s->dataset.parent_handle = o->handle;
1425 s->data_out = usb_mtp_data_alloc(c);
1427 case CMD_SEND_OBJECT:
1428 if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1429 usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1430 c->trans, 0, 0, 0, 0);
1433 if (!s->write_pending) {
1434 usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO,
1435 c->trans, 0, 0, 0, 0);
1438 s->data_out = usb_mtp_data_alloc(c);
1440 case CMD_GET_OBJECT_PROPS_SUPPORTED:
1441 if (c->argv[0] != FMT_UNDEFINED_OBJECT &&
1442 c->argv[0] != FMT_ASSOCIATION) {
1443 usb_mtp_queue_result(s, RES_INVALID_OBJECT_FORMAT_CODE,
1444 c->trans, 0, 0, 0, 0);
1447 data_in = usb_mtp_get_object_props_supported(s, c);
1449 case CMD_GET_OBJECT_PROP_DESC:
1450 if (c->argv[1] != FMT_UNDEFINED_OBJECT &&
1451 c->argv[1] != FMT_ASSOCIATION) {
1452 usb_mtp_queue_result(s, RES_INVALID_OBJECT_FORMAT_CODE,
1453 c->trans, 0, 0, 0, 0);
1456 data_in = usb_mtp_get_object_prop_desc(s, c);
1457 if (data_in == NULL) {
1458 usb_mtp_queue_result(s, RES_INVALID_OBJECT_PROP_CODE,
1459 c->trans, 0, 0, 0, 0);
1463 case CMD_GET_OBJECT_PROP_VALUE:
1464 o = usb_mtp_object_lookup(s, c->argv[0]);
1466 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1467 c->trans, 0, 0, 0, 0);
1470 data_in = usb_mtp_get_object_prop_value(s, c, o);
1471 if (data_in == NULL) {
1472 usb_mtp_queue_result(s, RES_INVALID_OBJECT_PROP_CODE,
1473 c->trans, 0, 0, 0, 0);
1478 trace_usb_mtp_op_unknown(s->dev.addr, c->code);
1479 usb_mtp_queue_result(s, RES_OPERATION_NOT_SUPPORTED,
1480 c->trans, 0, 0, 0, 0);
1484 /* return results on success */
1486 assert(s->data_in == NULL);
1487 s->data_in = data_in;
1489 usb_mtp_queue_result(s, RES_OK, c->trans, nres, res0, 0, 0);
1492 /* ----------------------------------------------------------------------- */
1494 static void usb_mtp_handle_reset(USBDevice *dev)
1496 MTPState *s = USB_MTP(dev);
1498 trace_usb_mtp_reset(s->dev.addr);
1500 usb_mtp_file_monitor_cleanup(s);
1501 usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
1503 usb_mtp_data_free(s->data_in);
1505 usb_mtp_data_free(s->data_out);
1511 static void usb_mtp_handle_control(USBDevice *dev, USBPacket *p,
1512 int request, int value, int index,
1513 int length, uint8_t *data)
1516 MTPState *s = USB_MTP(dev);
1517 uint16_t *event = (uint16_t *)data;
1520 case ClassInterfaceOutRequest | 0x64:
1521 if (*event == EVT_CANCEL_TRANSACTION) {
1524 usb_mtp_data_free(s->data_in);
1526 if (s->write_pending) {
1527 g_free(s->dataset.filename);
1528 s->write_pending = false;
1529 s->dataset.size = 0;
1531 usb_mtp_data_free(s->data_out);
1534 p->status = USB_RET_STALL;
1538 ret = usb_desc_handle_control(dev, p, request,
1539 value, index, length, data);
1545 trace_usb_mtp_stall(dev->addr, "unknown control request");
1548 static void usb_mtp_cancel_packet(USBDevice *dev, USBPacket *p)
1550 /* we don't use async packets, so this should never be called */
1551 fprintf(stderr, "%s\n", __func__);
1554 static char *utf16_to_str(uint8_t len, uint8_t *str16)
1556 wchar_t *wstr = g_new0(wchar_t, len + 1);
1560 for (count = 0; count < len; count++) {
1561 /* FIXME: not working for surrogate pairs */
1562 wstr[count] = lduw_le_p(str16 + (count * 2));
1566 dlen = wcstombs(NULL, wstr, 0) + 1;
1567 dest = g_malloc(dlen);
1568 wcstombs(dest, wstr, dlen);
1573 /* Wrapper around write, returns 0 on failure */
1574 static uint64_t write_retry(int fd, void *buf, uint64_t size, off_t offset)
1578 if (lseek(fd, offset, SEEK_SET) < 0) {
1582 ret = qemu_write_full(fd, buf, size);
1588 static int usb_mtp_update_object(MTPObject *parent, char *name)
1593 usb_mtp_object_lookup_name(parent, name, strlen(name));
1596 ret = lstat(o->path, &o->stat);
1602 static void usb_mtp_write_data(MTPState *s, uint32_t handle)
1604 MTPData *d = s->data_out;
1606 usb_mtp_object_lookup(s, s->dataset.parent_handle);
1614 switch (d->write_status) {
1616 if (!parent || !s->write_pending) {
1617 usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO, d->trans,
1622 if (s->dataset.filename) {
1623 path = g_strdup_printf("%s/%s", parent->path, s->dataset.filename);
1624 if (s->dataset.format == FMT_ASSOCIATION) {
1625 ret = mkdir(path, mask);
1627 usb_mtp_queue_result(s, RES_OK, d->trans, 3,
1629 s->dataset.parent_handle,
1636 d->fd = open(path, O_CREAT | O_WRONLY |
1637 O_CLOEXEC | O_NOFOLLOW, mask);
1643 /* Return success if initiator sent 0 sized data */
1644 if (!s->dataset.size) {
1647 if (d->length != MTP_WRITE_BUF_SZ && !d->pending) {
1648 d->write_status = WRITE_END;
1652 case WRITE_CONTINUE:
1654 rc = write_retry(d->fd, d->data, d->data_offset,
1655 d->offset - d->data_offset);
1656 if (rc != d->data_offset) {
1660 if (d->write_status != WRITE_END) {
1665 * Return an incomplete transfer if file size doesn't match
1666 * for < 4G file or if lstat fails which will result in an incorrect
1669 if ((s->dataset.size != 0xFFFFFFFF &&
1670 d->offset != s->dataset.size) ||
1671 usb_mtp_update_object(parent, s->dataset.filename)) {
1672 usb_mtp_queue_result(s, RES_INCOMPLETE_TRANSFER, d->trans,
1681 usb_mtp_queue_result(s, RES_STORE_FULL, d->trans,
1684 usb_mtp_queue_result(s, RES_OK, d->trans,
1689 * The write dataset is kept around and freed only
1690 * on success or if another write request comes in
1696 g_free(s->dataset.filename);
1697 s->dataset.size = 0;
1699 s->write_pending = false;
1702 static void usb_mtp_write_metadata(MTPState *s, uint64_t dlen)
1704 MTPData *d = s->data_out;
1705 ObjectInfo *dataset = (ObjectInfo *)d->data;
1708 MTPObject *p = usb_mtp_object_lookup(s, s->dataset.parent_handle);
1709 uint32_t next_handle = s->next_handle;
1710 size_t filename_chars = dlen - offsetof(ObjectInfo, filename);
1713 * filename is utf-16. We're intentionally doing
1714 * integer division to truncate if malicious guest
1715 * sent an odd number of bytes.
1717 filename_chars /= 2;
1719 assert(!s->write_pending);
1722 filename = utf16_to_str(MIN(dataset->length, filename_chars),
1725 if (strchr(filename, '/')) {
1726 usb_mtp_queue_result(s, RES_PARAMETER_NOT_SUPPORTED, d->trans,
1732 o = usb_mtp_object_lookup_name(p, filename, -1);
1734 next_handle = o->handle;
1737 s->dataset.filename = filename;
1738 s->dataset.format = dataset->format;
1739 s->dataset.size = dataset->size;
1740 s->write_pending = true;
1742 if (s->dataset.format == FMT_ASSOCIATION) {
1743 usb_mtp_write_data(s, next_handle);
1745 usb_mtp_queue_result(s, RES_OK, d->trans, 3, QEMU_STORAGE_ID,
1746 s->dataset.parent_handle, next_handle);
1750 static void usb_mtp_get_data(MTPState *s, mtp_container *container,
1753 MTPData *d = s->data_out;
1755 uint32_t data_len = p->iov.size;
1759 usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO, 0,
1764 /* Total length of incoming data */
1765 total_len = cpu_to_le32(container->length) - sizeof(mtp_container);
1766 /* Length of data in this packet */
1767 data_len -= sizeof(mtp_container);
1768 if (total_len < MTP_WRITE_BUF_SZ) {
1769 usb_mtp_realloc(d, total_len);
1770 d->length += total_len;
1772 usb_mtp_realloc(d, MTP_WRITE_BUF_SZ - sizeof(mtp_container));
1773 d->length += MTP_WRITE_BUF_SZ - sizeof(mtp_container);
1779 d->write_status = WRITE_START;
1783 memset(d->data, 0, d->length);
1784 if (d->length != MTP_WRITE_BUF_SZ) {
1785 usb_mtp_realloc(d, MTP_WRITE_BUF_SZ - d->length);
1786 d->length += (MTP_WRITE_BUF_SZ - d->length);
1789 d->write_status = WRITE_CONTINUE;
1793 if (d->length - d->data_offset > data_len) {
1796 dlen = d->length - d->data_offset;
1800 case CMD_SEND_OBJECT_INFO:
1801 usb_packet_copy(p, d->data + d->data_offset, dlen);
1803 d->data_offset += dlen;
1804 if (d->data_offset == d->length) {
1805 /* The operation might have already failed */
1807 usb_mtp_write_metadata(s, dlen);
1809 usb_mtp_data_free(s->data_out);
1814 case CMD_SEND_OBJECT:
1815 usb_packet_copy(p, d->data + d->data_offset, dlen);
1817 d->data_offset += dlen;
1818 if ((p->iov.size % 64) || !p->iov.size) {
1819 assert((s->dataset.size == 0xFFFFFFFF) ||
1820 (s->dataset.size == d->offset));
1822 if (d->length == MTP_WRITE_BUF_SZ) {
1823 d->write_status = WRITE_END;
1825 d->write_status = WRITE_START;
1827 usb_mtp_write_data(s, 0);
1828 usb_mtp_data_free(s->data_out);
1832 if (d->data_offset == d->length) {
1834 usb_mtp_write_data(s, 0);
1838 p->status = USB_RET_STALL;
1843 static void usb_mtp_handle_data(USBDevice *dev, USBPacket *p)
1845 MTPState *s = USB_MTP(dev);
1847 mtp_container container;
1849 uint16_t container_type;
1852 switch (p->ep->nr) {
1854 if (s->data_out != NULL) {
1856 trace_usb_mtp_stall(s->dev.addr, "awaiting data-out");
1857 p->status = USB_RET_STALL;
1860 if (p->iov.size < sizeof(container)) {
1861 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1862 p->status = USB_RET_STALL;
1865 if (s->data_in != NULL) {
1866 MTPData *d = s->data_in;
1867 uint64_t dlen = d->length - d->offset;
1869 trace_usb_mtp_data_in(s->dev.addr, d->trans, d->length);
1870 if (d->length + sizeof(container) > 0xFFFFFFFF) {
1871 container.length = cpu_to_le32(0xFFFFFFFF);
1874 cpu_to_le32(d->length + sizeof(container));
1876 container.type = cpu_to_le16(TYPE_DATA);
1877 container.code = cpu_to_le16(d->code);
1878 container.trans = cpu_to_le32(d->trans);
1879 usb_packet_copy(p, &container, sizeof(container));
1881 if (dlen > p->iov.size - sizeof(container)) {
1882 dlen = p->iov.size - sizeof(container);
1885 if (dlen > p->iov.size) {
1890 usb_packet_copy(p, d->data + d->offset, dlen);
1892 if (d->alloc < p->iov.size) {
1893 d->alloc = p->iov.size;
1894 d->data = g_realloc(d->data, d->alloc);
1896 rc = read(d->fd, d->data, dlen);
1898 memset(d->data, 0, dlen);
1899 s->result->code = RES_INCOMPLETE_TRANSFER;
1901 usb_packet_copy(p, d->data, dlen);
1904 if (d->offset == d->length) {
1905 usb_mtp_data_free(s->data_in);
1908 } else if (s->result != NULL) {
1909 MTPControl *r = s->result;
1910 int length = sizeof(container) + r->argc * sizeof(uint32_t);
1911 if (r->code == RES_OK) {
1912 trace_usb_mtp_success(s->dev.addr, r->trans,
1913 (r->argc > 0) ? r->argv[0] : 0,
1914 (r->argc > 1) ? r->argv[1] : 0);
1916 trace_usb_mtp_error(s->dev.addr, r->code, r->trans,
1917 (r->argc > 0) ? r->argv[0] : 0,
1918 (r->argc > 1) ? r->argv[1] : 0);
1920 container.length = cpu_to_le32(length);
1921 container.type = cpu_to_le16(TYPE_RESPONSE);
1922 container.code = cpu_to_le16(r->code);
1923 container.trans = cpu_to_le32(r->trans);
1924 for (i = 0; i < r->argc; i++) {
1925 params[i] = cpu_to_le32(r->argv[i]);
1927 usb_packet_copy(p, &container, sizeof(container));
1928 usb_packet_copy(p, ¶ms, length - sizeof(container));
1934 if (p->iov.size < sizeof(container)) {
1935 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1936 p->status = USB_RET_STALL;
1939 if ((s->data_out != NULL) && !s->data_out->first) {
1940 container_type = TYPE_DATA;
1942 usb_packet_copy(p, &container, sizeof(container));
1943 container_type = le16_to_cpu(container.type);
1945 switch (container_type) {
1947 if (s->data_in || s->data_out || s->result) {
1948 trace_usb_mtp_stall(s->dev.addr, "transaction inflight");
1949 p->status = USB_RET_STALL;
1952 cmd.code = le16_to_cpu(container.code);
1953 cmd.argc = (le32_to_cpu(container.length) - sizeof(container))
1955 cmd.trans = le32_to_cpu(container.trans);
1956 if (cmd.argc > ARRAY_SIZE(cmd.argv)) {
1957 cmd.argc = ARRAY_SIZE(cmd.argv);
1959 if (p->iov.size < sizeof(container) + cmd.argc * sizeof(uint32_t)) {
1960 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1961 p->status = USB_RET_STALL;
1964 usb_packet_copy(p, ¶ms, cmd.argc * sizeof(uint32_t));
1965 for (i = 0; i < cmd.argc; i++) {
1966 cmd.argv[i] = le32_to_cpu(params[i]);
1968 trace_usb_mtp_command(s->dev.addr, cmd.code, cmd.trans,
1969 (cmd.argc > 0) ? cmd.argv[0] : 0,
1970 (cmd.argc > 1) ? cmd.argv[1] : 0,
1971 (cmd.argc > 2) ? cmd.argv[2] : 0,
1972 (cmd.argc > 3) ? cmd.argv[3] : 0,
1973 (cmd.argc > 4) ? cmd.argv[4] : 0);
1974 usb_mtp_command(s, &cmd);
1977 /* One of the previous transfers has already errored but the
1978 * responder is still sending data associated with it
1980 if (s->result != NULL) {
1983 usb_mtp_get_data(s, &container, p);
1986 /* not needed as long as the mtp device is read-only */
1987 p->status = USB_RET_STALL;
1992 if (!QTAILQ_EMPTY(&s->events)) {
1993 struct MTPMonEntry *e = QTAILQ_LAST(&s->events);
1995 int len = sizeof(container) + sizeof(uint32_t);
1997 if (p->iov.size < len) {
1998 trace_usb_mtp_stall(s->dev.addr,
1999 "packet too small to send event");
2000 p->status = USB_RET_STALL;
2004 QTAILQ_REMOVE(&s->events, e, next);
2005 container.length = cpu_to_le32(len);
2006 container.type = cpu_to_le32(TYPE_EVENT);
2007 container.code = cpu_to_le16(e->event);
2008 container.trans = 0; /* no trans specific events */
2009 handle = cpu_to_le32(e->handle);
2010 usb_packet_copy(p, &container, sizeof(container));
2011 usb_packet_copy(p, &handle, sizeof(uint32_t));
2015 p->status = USB_RET_NAK;
2018 trace_usb_mtp_stall(s->dev.addr, "invalid endpoint");
2019 p->status = USB_RET_STALL;
2023 if (p->actual_length == 0) {
2024 trace_usb_mtp_nak(s->dev.addr, p->ep->nr);
2025 p->status = USB_RET_NAK;
2028 trace_usb_mtp_xfer(s->dev.addr, p->ep->nr, p->actual_length,
2034 static void usb_mtp_realize(USBDevice *dev, Error **errp)
2036 MTPState *s = USB_MTP(dev);
2038 usb_desc_create_serial(dev);
2040 QTAILQ_INIT(&s->objects);
2041 if (s->desc == NULL) {
2042 if (s->root == NULL) {
2043 error_setg(errp, "usb-mtp: rootdir property must be configured");
2046 s->desc = strrchr(s->root, '/');
2047 if (s->desc && s->desc[0]) {
2048 s->desc = g_strdup(s->desc + 1);
2050 s->desc = g_strdup("none");
2053 /* Mark store as RW */
2055 s->flags |= (1 << MTP_FLAG_WRITABLE);
2060 static const VMStateDescription vmstate_usb_mtp = {
2064 .minimum_version_id = 1,
2065 .fields = (VMStateField[]) {
2066 VMSTATE_USB_DEVICE(dev, MTPState),
2067 VMSTATE_END_OF_LIST()
2071 static Property mtp_properties[] = {
2072 DEFINE_PROP_STRING("rootdir", MTPState, root),
2073 DEFINE_PROP_STRING("desc", MTPState, desc),
2074 DEFINE_PROP_BOOL("readonly", MTPState, readonly, true),
2075 DEFINE_PROP_END_OF_LIST(),
2078 static void usb_mtp_class_initfn(ObjectClass *klass, void *data)
2080 DeviceClass *dc = DEVICE_CLASS(klass);
2081 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
2083 uc->realize = usb_mtp_realize;
2084 uc->product_desc = "QEMU USB MTP";
2085 uc->usb_desc = &desc;
2086 uc->cancel_packet = usb_mtp_cancel_packet;
2087 uc->handle_attach = usb_desc_attach;
2088 uc->handle_reset = usb_mtp_handle_reset;
2089 uc->handle_control = usb_mtp_handle_control;
2090 uc->handle_data = usb_mtp_handle_data;
2091 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
2092 dc->desc = "USB Media Transfer Protocol device";
2093 dc->fw_name = "mtp";
2094 dc->vmsd = &vmstate_usb_mtp;
2095 dc->props = mtp_properties;
2098 static TypeInfo mtp_info = {
2099 .name = TYPE_USB_MTP,
2100 .parent = TYPE_USB_DEVICE,
2101 .instance_size = sizeof(MTPState),
2102 .class_init = usb_mtp_class_initfn,
2105 static void usb_mtp_register_types(void)
2107 type_register_static(&mtp_info);
2110 type_init(usb_mtp_register_types)