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"
17 #include <sys/statvfs.h>
18 #ifdef CONFIG_INOTIFY1
19 #include <sys/inotify.h>
20 #include "qemu/main-loop.h"
23 #include "qemu-common.h"
29 /* ----------------------------------------------------------------------- */
31 enum mtp_container_type {
40 CMD_GET_DEVICE_INFO = 0x1001,
41 CMD_OPEN_SESSION = 0x1002,
42 CMD_CLOSE_SESSION = 0x1003,
43 CMD_GET_STORAGE_IDS = 0x1004,
44 CMD_GET_STORAGE_INFO = 0x1005,
45 CMD_GET_NUM_OBJECTS = 0x1006,
46 CMD_GET_OBJECT_HANDLES = 0x1007,
47 CMD_GET_OBJECT_INFO = 0x1008,
48 CMD_GET_OBJECT = 0x1009,
49 CMD_DELETE_OBJECT = 0x100b,
50 CMD_SEND_OBJECT_INFO = 0x100c,
51 CMD_SEND_OBJECT = 0x100d,
52 CMD_GET_PARTIAL_OBJECT = 0x101b,
53 CMD_GET_OBJECT_PROPS_SUPPORTED = 0x9801,
54 CMD_GET_OBJECT_PROP_DESC = 0x9802,
55 CMD_GET_OBJECT_PROP_VALUE = 0x9803,
59 RES_GENERAL_ERROR = 0x2002,
60 RES_SESSION_NOT_OPEN = 0x2003,
61 RES_INVALID_TRANSACTION_ID = 0x2004,
62 RES_OPERATION_NOT_SUPPORTED = 0x2005,
63 RES_PARAMETER_NOT_SUPPORTED = 0x2006,
64 RES_INCOMPLETE_TRANSFER = 0x2007,
65 RES_INVALID_STORAGE_ID = 0x2008,
66 RES_INVALID_OBJECT_HANDLE = 0x2009,
67 RES_INVALID_OBJECT_FORMAT_CODE = 0x200b,
68 RES_STORE_FULL = 0x200c,
69 RES_STORE_READ_ONLY = 0x200e,
70 RES_PARTIAL_DELETE = 0x2012,
71 RES_STORE_NOT_AVAILABLE = 0x2013,
72 RES_SPEC_BY_FORMAT_UNSUPPORTED = 0x2014,
73 RES_INVALID_OBJECTINFO = 0x2015,
74 RES_DESTINATION_UNSUPPORTED = 0x2020,
75 RES_INVALID_PARENT_OBJECT = 0x201a,
76 RES_INVALID_PARAMETER = 0x201d,
77 RES_SESSION_ALREADY_OPEN = 0x201e,
78 RES_INVALID_OBJECT_PROP_CODE = 0xA801,
81 FMT_UNDEFINED_OBJECT = 0x3000,
82 FMT_ASSOCIATION = 0x3001,
85 EVT_CANCEL_TRANSACTION = 0x4001,
86 EVT_OBJ_ADDED = 0x4002,
87 EVT_OBJ_REMOVED = 0x4003,
88 EVT_OBJ_INFO_CHANGED = 0x4007,
90 /* object properties */
91 PROP_STORAGE_ID = 0xDC01,
92 PROP_OBJECT_FORMAT = 0xDC02,
93 PROP_OBJECT_COMPRESSED_SIZE = 0xDC04,
94 PROP_PARENT_OBJECT = 0xDC0B,
95 PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER = 0xDC41,
100 DATA_TYPE_UINT16 = 0x0004,
101 DATA_TYPE_UINT32 = 0x0006,
102 DATA_TYPE_UINT64 = 0x0008,
103 DATA_TYPE_UINT128 = 0x000a,
104 DATA_TYPE_STRING = 0xffff,
112 } QEMU_PACKED mtp_container;
114 /* ----------------------------------------------------------------------- */
116 typedef struct MTPState MTPState;
117 typedef struct MTPControl MTPControl;
118 typedef struct MTPData MTPData;
119 typedef struct MTPObject MTPObject;
127 #ifdef CONFIG_INOTIFY1
128 typedef struct MTPMonEntry MTPMonEntry;
134 QTAILQ_ENTRY(MTPMonEntry) next;
153 /* Used for >4G file sizes */
155 uint64_t cached_length;
165 #ifdef CONFIG_INOTIFY1
166 /* inotify watch cookie */
171 QLIST_HEAD(, MTPObject) children;
172 QLIST_ENTRY(MTPObject) list;
174 QTAILQ_ENTRY(MTPObject) next;
187 uint32_t next_handle;
190 QTAILQ_HEAD(, MTPObject) objects;
191 #ifdef CONFIG_INOTIFY1
192 /* inotify descriptor */
194 QTAILQ_HEAD(events, MTPMonEntry) events;
196 /* Responder is expecting a write operation */
199 uint32_t parent_handle;
207 * ObjectInfo dataset received from initiator
208 * Fields we don't care about are ignored
211 uint32_t storage_id; /*unused*/
213 uint16_t protection_status; /*unused*/
215 uint16_t thumb_format; /*unused*/
216 uint32_t thumb_comp_sz; /*unused*/
217 uint32_t thumb_pix_width; /*unused*/
218 uint32_t thumb_pix_height; /*unused*/
219 uint32_t image_pix_width; /*unused*/
220 uint32_t image_pix_height; /*unused*/
221 uint32_t image_bit_depth; /*unused*/
222 uint32_t parent; /*unused*/
225 uint32_t seq_no; /*unused*/
226 uint8_t length; /*part of filename field*/
227 uint16_t filename[0];
228 char date_created[0]; /*unused*/
229 char date_modified[0]; /*unused*/
230 char keywords[0]; /*unused*/
231 /* string and other data follows */
232 } QEMU_PACKED ObjectInfo;
234 #define TYPE_USB_MTP "usb-mtp"
235 #define USB_MTP(obj) OBJECT_CHECK(MTPState, (obj), TYPE_USB_MTP)
237 #define QEMU_STORAGE_ID 0x00010001
239 #define MTP_FLAG_WRITABLE 0
241 #define FLAG_SET(_mtp, _flag) ((_mtp)->flags & (1 << (_flag)))
243 /* ----------------------------------------------------------------------- */
245 #define MTP_MANUFACTURER "QEMU"
246 #define MTP_PRODUCT "QEMU filesharing"
249 STR_MANUFACTURER = 1,
258 static const USBDescStrings desc_strings = {
259 [STR_MANUFACTURER] = MTP_MANUFACTURER,
260 [STR_PRODUCT] = MTP_PRODUCT,
261 [STR_SERIALNUMBER] = "34617",
263 [STR_CONFIG_FULL] = "Full speed config (usb 1.1)",
264 [STR_CONFIG_HIGH] = "High speed config (usb 2.0)",
265 [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
268 static const USBDescIface desc_iface_full = {
269 .bInterfaceNumber = 0,
271 .bInterfaceClass = USB_CLASS_STILL_IMAGE,
272 .bInterfaceSubClass = 0x01,
273 .bInterfaceProtocol = 0x01,
274 .iInterface = STR_MTP,
275 .eps = (USBDescEndpoint[]) {
277 .bEndpointAddress = USB_DIR_IN | EP_DATA_IN,
278 .bmAttributes = USB_ENDPOINT_XFER_BULK,
279 .wMaxPacketSize = 64,
281 .bEndpointAddress = USB_DIR_OUT | EP_DATA_OUT,
282 .bmAttributes = USB_ENDPOINT_XFER_BULK,
283 .wMaxPacketSize = 64,
285 .bEndpointAddress = USB_DIR_IN | EP_EVENT,
286 .bmAttributes = USB_ENDPOINT_XFER_INT,
287 .wMaxPacketSize = 64,
293 static const USBDescDevice desc_device_full = {
295 .bMaxPacketSize0 = 8,
296 .bNumConfigurations = 1,
297 .confs = (USBDescConfig[]) {
300 .bConfigurationValue = 1,
301 .iConfiguration = STR_CONFIG_FULL,
302 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
305 .ifs = &desc_iface_full,
310 static const USBDescIface desc_iface_high = {
311 .bInterfaceNumber = 0,
313 .bInterfaceClass = USB_CLASS_STILL_IMAGE,
314 .bInterfaceSubClass = 0x01,
315 .bInterfaceProtocol = 0x01,
316 .iInterface = STR_MTP,
317 .eps = (USBDescEndpoint[]) {
319 .bEndpointAddress = USB_DIR_IN | EP_DATA_IN,
320 .bmAttributes = USB_ENDPOINT_XFER_BULK,
321 .wMaxPacketSize = 512,
323 .bEndpointAddress = USB_DIR_OUT | EP_DATA_OUT,
324 .bmAttributes = USB_ENDPOINT_XFER_BULK,
325 .wMaxPacketSize = 512,
327 .bEndpointAddress = USB_DIR_IN | EP_EVENT,
328 .bmAttributes = USB_ENDPOINT_XFER_INT,
329 .wMaxPacketSize = 64,
335 static const USBDescDevice desc_device_high = {
337 .bMaxPacketSize0 = 64,
338 .bNumConfigurations = 1,
339 .confs = (USBDescConfig[]) {
342 .bConfigurationValue = 1,
343 .iConfiguration = STR_CONFIG_HIGH,
344 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
347 .ifs = &desc_iface_high,
352 static const USBDescMSOS desc_msos = {
353 .CompatibleID = "MTP",
354 .SelectiveSuspendEnabled = true,
357 static const USBDesc desc = {
359 .idVendor = 0x46f4, /* CRC16() of "QEMU" */
362 .iManufacturer = STR_MANUFACTURER,
363 .iProduct = STR_PRODUCT,
364 .iSerialNumber = STR_SERIALNUMBER,
366 .full = &desc_device_full,
367 .high = &desc_device_high,
372 /* ----------------------------------------------------------------------- */
374 static MTPObject *usb_mtp_object_alloc(MTPState *s, uint32_t handle,
375 MTPObject *parent, char *name)
377 MTPObject *o = g_new0(MTPObject, 1);
379 if (name[0] == '.') {
385 o->name = g_strdup(name);
386 if (parent == NULL) {
387 o->path = g_strdup(name);
389 o->path = g_strdup_printf("%s/%s", parent->path, name);
392 if (lstat(o->path, &o->stat) != 0) {
395 if (S_ISREG(o->stat.st_mode)) {
396 o->format = FMT_UNDEFINED_OBJECT;
397 } else if (S_ISDIR(o->stat.st_mode)) {
398 o->format = FMT_ASSOCIATION;
403 if (access(o->path, R_OK) != 0) {
407 trace_usb_mtp_object_alloc(s->dev.addr, o->handle, o->path);
409 QTAILQ_INSERT_TAIL(&s->objects, o, next);
419 static void usb_mtp_object_free(MTPState *s, MTPObject *o)
427 trace_usb_mtp_object_free(s->dev.addr, o->handle, o->path);
429 QTAILQ_REMOVE(&s->objects, o, next);
431 QLIST_REMOVE(o, list);
432 o->parent->nchildren--;
435 while (!QLIST_EMPTY(&o->children)) {
436 iter = QLIST_FIRST(&o->children);
437 usb_mtp_object_free(s, iter);
444 static MTPObject *usb_mtp_object_lookup(MTPState *s, uint32_t handle)
448 QTAILQ_FOREACH(o, &s->objects, next) {
449 if (o->handle == handle) {
456 static MTPObject *usb_mtp_add_child(MTPState *s, MTPObject *o,
460 usb_mtp_object_alloc(s, s->next_handle++, o, name);
463 trace_usb_mtp_add_child(s->dev.addr, child->handle, child->path);
464 QLIST_INSERT_HEAD(&o->children, child, list);
467 if (child->format == FMT_ASSOCIATION) {
468 QLIST_INIT(&child->children);
475 static MTPObject *usb_mtp_object_lookup_name(MTPObject *parent,
480 QLIST_FOREACH(iter, &parent->children, list) {
481 if (strncmp(iter->name, name, len) == 0) {
489 #ifdef CONFIG_INOTIFY1
490 static MTPObject *usb_mtp_object_lookup_wd(MTPState *s, int wd)
494 QTAILQ_FOREACH(iter, &s->objects, next) {
495 if (iter->watchfd == wd) {
503 static void inotify_watchfn(void *arg)
507 /* From the man page: atleast one event can be read */
509 char buf[sizeof(struct inotify_event) + NAME_MAX + 1];
512 bytes = read(s->inotifyfd, buf, sizeof(buf));
516 /* Better luck next time */
521 * TODO: Ignore initiator initiated events.
522 * For now we are good because the store is RO
526 struct inotify_event *event = (struct inotify_event *)p;
528 uint32_t mask = event->mask & (IN_CREATE | IN_DELETE |
529 IN_MODIFY | IN_IGNORED);
530 MTPObject *parent = usb_mtp_object_lookup_wd(s, event->wd);
531 MTPMonEntry *entry = NULL;
534 pos = pos + sizeof(struct inotify_event) + event->len;
543 if (usb_mtp_object_lookup_name
544 (parent, event->name, event->len)) {
545 /* Duplicate create event */
548 entry = g_new0(MTPMonEntry, 1);
549 entry->handle = s->next_handle;
550 entry->event = EVT_OBJ_ADDED;
551 o = usb_mtp_add_child(s, parent, event->name);
556 o->watchfd = watchfd;
557 trace_usb_mtp_inotify_event(s->dev.addr, event->name,
558 event->mask, "Obj Added");
563 * The kernel issues a IN_IGNORED event
564 * when a dir containing a watchpoint is
565 * deleted, so we don't have to delete the
568 o = usb_mtp_object_lookup_name(parent, event->name, event->len);
572 entry = g_new0(MTPMonEntry, 1);
573 entry->handle = o->handle;
574 entry->event = EVT_OBJ_REMOVED;
575 trace_usb_mtp_inotify_event(s->dev.addr, o->path,
576 event->mask, "Obj Deleted");
577 usb_mtp_object_free(s, o);
581 o = usb_mtp_object_lookup_name(parent, event->name, event->len);
585 entry = g_new0(MTPMonEntry, 1);
586 entry->handle = o->handle;
587 entry->event = EVT_OBJ_INFO_CHANGED;
588 trace_usb_mtp_inotify_event(s->dev.addr, o->path,
589 event->mask, "Obj Modified");
593 trace_usb_mtp_inotify_event(s->dev.addr, parent->path,
594 event->mask, "Obj parent dir ignored");
598 fprintf(stderr, "usb-mtp: failed to parse inotify event\n");
603 QTAILQ_INSERT_HEAD(&s->events, entry, next);
609 static int usb_mtp_inotify_init(MTPState *s)
613 fd = inotify_init1(IN_NONBLOCK);
618 QTAILQ_INIT(&s->events);
621 qemu_set_fd_handler(fd, inotify_watchfn, NULL, s);
626 static void usb_mtp_inotify_cleanup(MTPState *s)
634 qemu_set_fd_handler(s->inotifyfd, NULL, NULL, s);
637 QTAILQ_FOREACH_SAFE(e, &s->events, next, p) {
638 QTAILQ_REMOVE(&s->events, e, next);
643 static int usb_mtp_add_watch(int inotifyfd, char *path)
645 uint32_t mask = IN_CREATE | IN_DELETE | IN_MODIFY |
648 return inotify_add_watch(inotifyfd, path, mask);
652 static void usb_mtp_object_readdir(MTPState *s, MTPObject *o)
654 struct dirent *entry;
658 if (o->have_children) {
661 o->have_children = true;
663 fd = open(o->path, O_DIRECTORY | O_CLOEXEC | O_NOFOLLOW);
671 #ifdef CONFIG_INOTIFY1
672 int watchfd = usb_mtp_add_watch(s->inotifyfd, o->path);
674 fprintf(stderr, "usb-mtp: failed to add watch for %s\n", o->path);
676 trace_usb_mtp_inotify_event(s->dev.addr, o->path,
678 o->watchfd = watchfd;
681 while ((entry = readdir(dir)) != NULL) {
682 usb_mtp_add_child(s, o, entry->d_name);
687 /* ----------------------------------------------------------------------- */
689 static MTPData *usb_mtp_data_alloc(MTPControl *c)
691 MTPData *data = g_new0(MTPData, 1);
693 data->code = c->code;
694 data->trans = c->trans;
700 static void usb_mtp_data_free(MTPData *data)
705 if (data->fd != -1) {
712 static void usb_mtp_realloc(MTPData *data, uint32_t bytes)
714 if (data->length + bytes <= data->alloc) {
717 data->alloc = (data->length + bytes + 0xff) & ~0xff;
718 data->data = g_realloc(data->data, data->alloc);
721 static void usb_mtp_add_u8(MTPData *data, uint8_t val)
723 usb_mtp_realloc(data, 1);
724 data->data[data->length++] = val;
727 static void usb_mtp_add_u16(MTPData *data, uint16_t val)
729 usb_mtp_realloc(data, 2);
730 data->data[data->length++] = (val >> 0) & 0xff;
731 data->data[data->length++] = (val >> 8) & 0xff;
734 static void usb_mtp_add_u32(MTPData *data, uint32_t val)
736 usb_mtp_realloc(data, 4);
737 data->data[data->length++] = (val >> 0) & 0xff;
738 data->data[data->length++] = (val >> 8) & 0xff;
739 data->data[data->length++] = (val >> 16) & 0xff;
740 data->data[data->length++] = (val >> 24) & 0xff;
743 static void usb_mtp_add_u64(MTPData *data, uint64_t val)
745 usb_mtp_realloc(data, 8);
746 data->data[data->length++] = (val >> 0) & 0xff;
747 data->data[data->length++] = (val >> 8) & 0xff;
748 data->data[data->length++] = (val >> 16) & 0xff;
749 data->data[data->length++] = (val >> 24) & 0xff;
750 data->data[data->length++] = (val >> 32) & 0xff;
751 data->data[data->length++] = (val >> 40) & 0xff;
752 data->data[data->length++] = (val >> 48) & 0xff;
753 data->data[data->length++] = (val >> 56) & 0xff;
756 static void usb_mtp_add_u16_array(MTPData *data, uint32_t len,
757 const uint16_t *vals)
761 usb_mtp_add_u32(data, len);
762 for (i = 0; i < len; i++) {
763 usb_mtp_add_u16(data, vals[i]);
767 static void usb_mtp_add_u32_array(MTPData *data, uint32_t len,
768 const uint32_t *vals)
772 usb_mtp_add_u32(data, len);
773 for (i = 0; i < len; i++) {
774 usb_mtp_add_u32(data, vals[i]);
778 static void usb_mtp_add_wstr(MTPData *data, const wchar_t *str)
780 uint32_t len = wcslen(str);
784 len++; /* include terminating L'\0' */
787 usb_mtp_add_u8(data, len);
788 for (i = 0; i < len; i++) {
789 usb_mtp_add_u16(data, str[i]);
793 static void usb_mtp_add_str(MTPData *data, const char *str)
795 uint32_t len = strlen(str)+1;
796 wchar_t *wstr = g_new(wchar_t, len);
799 ret = mbstowcs(wstr, str, len);
801 usb_mtp_add_wstr(data, L"Oops");
803 usb_mtp_add_wstr(data, wstr);
809 static void usb_mtp_add_time(MTPData *data, time_t time)
814 gmtime_r(&time, &tm);
815 strftime(buf, sizeof(buf), "%Y%m%dT%H%M%S", &tm);
816 usb_mtp_add_str(data, buf);
819 /* ----------------------------------------------------------------------- */
821 static void usb_mtp_queue_result(MTPState *s, uint16_t code, uint32_t trans,
822 int argc, uint32_t arg0, uint32_t arg1,
825 MTPControl *c = g_new0(MTPControl, 1);
840 assert(s->result == NULL);
844 /* ----------------------------------------------------------------------- */
846 static MTPData *usb_mtp_get_device_info(MTPState *s, MTPControl *c)
848 static const uint16_t ops[] = {
853 CMD_GET_STORAGE_INFO,
855 CMD_GET_OBJECT_HANDLES,
858 CMD_SEND_OBJECT_INFO,
861 CMD_GET_PARTIAL_OBJECT,
862 CMD_GET_OBJECT_PROPS_SUPPORTED,
863 CMD_GET_OBJECT_PROP_DESC,
864 CMD_GET_OBJECT_PROP_VALUE,
866 static const uint16_t fmt[] = {
867 FMT_UNDEFINED_OBJECT,
870 MTPData *d = usb_mtp_data_alloc(c);
872 trace_usb_mtp_op_get_device_info(s->dev.addr);
874 usb_mtp_add_u16(d, 100);
875 usb_mtp_add_u32(d, 0x00000006);
876 usb_mtp_add_u16(d, 0x0064);
877 usb_mtp_add_wstr(d, L"");
878 usb_mtp_add_u16(d, 0x0000);
880 usb_mtp_add_u16_array(d, ARRAY_SIZE(ops), ops);
881 usb_mtp_add_u16_array(d, 0, NULL);
882 usb_mtp_add_u16_array(d, 0, NULL);
883 usb_mtp_add_u16_array(d, 0, NULL);
884 usb_mtp_add_u16_array(d, ARRAY_SIZE(fmt), fmt);
886 usb_mtp_add_wstr(d, L"" MTP_MANUFACTURER);
887 usb_mtp_add_wstr(d, L"" MTP_PRODUCT);
888 usb_mtp_add_wstr(d, L"0.1");
889 usb_mtp_add_wstr(d, L"0123456789abcdef0123456789abcdef");
894 static MTPData *usb_mtp_get_storage_ids(MTPState *s, MTPControl *c)
896 static const uint32_t ids[] = {
899 MTPData *d = usb_mtp_data_alloc(c);
901 trace_usb_mtp_op_get_storage_ids(s->dev.addr);
903 usb_mtp_add_u32_array(d, ARRAY_SIZE(ids), ids);
908 static MTPData *usb_mtp_get_storage_info(MTPState *s, MTPControl *c)
910 MTPData *d = usb_mtp_data_alloc(c);
914 trace_usb_mtp_op_get_storage_info(s->dev.addr);
916 if (FLAG_SET(s, MTP_FLAG_WRITABLE)) {
917 usb_mtp_add_u16(d, 0x0003);
918 usb_mtp_add_u16(d, 0x0002);
919 usb_mtp_add_u16(d, 0x0000);
921 usb_mtp_add_u16(d, 0x0001);
922 usb_mtp_add_u16(d, 0x0002);
923 usb_mtp_add_u16(d, 0x0001);
926 rc = statvfs(s->root, &buf);
928 usb_mtp_add_u64(d, (uint64_t)buf.f_frsize * buf.f_blocks);
929 usb_mtp_add_u64(d, (uint64_t)buf.f_bavail * buf.f_blocks);
930 usb_mtp_add_u32(d, buf.f_ffree);
932 usb_mtp_add_u64(d, 0xffffffff);
933 usb_mtp_add_u64(d, 0xffffffff);
934 usb_mtp_add_u32(d, 0xffffffff);
937 usb_mtp_add_str(d, s->desc);
938 usb_mtp_add_wstr(d, L"123456789abcdef");
942 static MTPData *usb_mtp_get_object_handles(MTPState *s, MTPControl *c,
945 MTPData *d = usb_mtp_data_alloc(c);
946 uint32_t i = 0, handles[o->nchildren];
949 trace_usb_mtp_op_get_object_handles(s->dev.addr, o->handle, o->path);
951 QLIST_FOREACH(iter, &o->children, list) {
952 handles[i++] = iter->handle;
954 assert(i == o->nchildren);
955 usb_mtp_add_u32_array(d, o->nchildren, handles);
960 static MTPData *usb_mtp_get_object_info(MTPState *s, MTPControl *c,
963 MTPData *d = usb_mtp_data_alloc(c);
965 trace_usb_mtp_op_get_object_info(s->dev.addr, o->handle, o->path);
967 usb_mtp_add_u32(d, QEMU_STORAGE_ID);
968 usb_mtp_add_u16(d, o->format);
969 usb_mtp_add_u16(d, 0);
971 if (o->stat.st_size > 0xFFFFFFFF) {
972 usb_mtp_add_u32(d, 0xFFFFFFFF);
974 usb_mtp_add_u32(d, o->stat.st_size);
977 usb_mtp_add_u16(d, 0);
978 usb_mtp_add_u32(d, 0);
979 usb_mtp_add_u32(d, 0);
980 usb_mtp_add_u32(d, 0);
981 usb_mtp_add_u32(d, 0);
982 usb_mtp_add_u32(d, 0);
983 usb_mtp_add_u32(d, 0);
986 usb_mtp_add_u32(d, o->parent->handle);
988 usb_mtp_add_u32(d, 0);
990 if (o->format == FMT_ASSOCIATION) {
991 usb_mtp_add_u16(d, 0x0001);
992 usb_mtp_add_u32(d, 0x00000001);
993 usb_mtp_add_u32(d, 0);
995 usb_mtp_add_u16(d, 0);
996 usb_mtp_add_u32(d, 0);
997 usb_mtp_add_u32(d, 0);
1000 usb_mtp_add_str(d, o->name);
1001 usb_mtp_add_time(d, o->stat.st_ctime);
1002 usb_mtp_add_time(d, o->stat.st_mtime);
1003 usb_mtp_add_wstr(d, L"");
1008 static MTPData *usb_mtp_get_object(MTPState *s, MTPControl *c,
1011 MTPData *d = usb_mtp_data_alloc(c);
1013 trace_usb_mtp_op_get_object(s->dev.addr, o->handle, o->path);
1015 d->fd = open(o->path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
1017 usb_mtp_data_free(d);
1020 d->length = o->stat.st_size;
1022 d->data = g_malloc(d->alloc);
1026 static MTPData *usb_mtp_get_partial_object(MTPState *s, MTPControl *c,
1035 trace_usb_mtp_op_get_partial_object(s->dev.addr, o->handle, o->path,
1036 c->argv[1], c->argv[2]);
1038 d = usb_mtp_data_alloc(c);
1039 d->fd = open(o->path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
1041 usb_mtp_data_free(d);
1045 offset = c->argv[1];
1046 if (offset > o->stat.st_size) {
1047 offset = o->stat.st_size;
1049 if (lseek(d->fd, offset, SEEK_SET) < 0) {
1050 usb_mtp_data_free(d);
1054 d->length = c->argv[2];
1055 if (d->length > o->stat.st_size - offset) {
1056 d->length = o->stat.st_size - offset;
1062 static MTPData *usb_mtp_get_object_props_supported(MTPState *s, MTPControl *c)
1064 static const uint16_t props[] = {
1067 PROP_OBJECT_COMPRESSED_SIZE,
1069 PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER,
1072 MTPData *d = usb_mtp_data_alloc(c);
1073 usb_mtp_add_u16_array(d, ARRAY_SIZE(props), props);
1078 static MTPData *usb_mtp_get_object_prop_desc(MTPState *s, MTPControl *c)
1080 MTPData *d = usb_mtp_data_alloc(c);
1081 switch (c->argv[0]) {
1082 case PROP_STORAGE_ID:
1083 usb_mtp_add_u16(d, PROP_STORAGE_ID);
1084 usb_mtp_add_u16(d, DATA_TYPE_UINT32);
1085 usb_mtp_add_u8(d, 0x00);
1086 usb_mtp_add_u32(d, 0x00000000);
1087 usb_mtp_add_u32(d, 0x00000000);
1088 usb_mtp_add_u8(d, 0x00);
1090 case PROP_OBJECT_FORMAT:
1091 usb_mtp_add_u16(d, PROP_OBJECT_FORMAT);
1092 usb_mtp_add_u16(d, DATA_TYPE_UINT16);
1093 usb_mtp_add_u8(d, 0x00);
1094 usb_mtp_add_u16(d, 0x0000);
1095 usb_mtp_add_u32(d, 0x00000000);
1096 usb_mtp_add_u8(d, 0x00);
1098 case PROP_OBJECT_COMPRESSED_SIZE:
1099 usb_mtp_add_u16(d, PROP_OBJECT_COMPRESSED_SIZE);
1100 usb_mtp_add_u16(d, DATA_TYPE_UINT64);
1101 usb_mtp_add_u8(d, 0x00);
1102 usb_mtp_add_u64(d, 0x0000000000000000);
1103 usb_mtp_add_u32(d, 0x00000000);
1104 usb_mtp_add_u8(d, 0x00);
1106 case PROP_PARENT_OBJECT:
1107 usb_mtp_add_u16(d, PROP_PARENT_OBJECT);
1108 usb_mtp_add_u16(d, DATA_TYPE_UINT32);
1109 usb_mtp_add_u8(d, 0x00);
1110 usb_mtp_add_u32(d, 0x00000000);
1111 usb_mtp_add_u32(d, 0x00000000);
1112 usb_mtp_add_u8(d, 0x00);
1114 case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER:
1115 usb_mtp_add_u16(d, PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER);
1116 usb_mtp_add_u16(d, DATA_TYPE_UINT128);
1117 usb_mtp_add_u8(d, 0x00);
1118 usb_mtp_add_u64(d, 0x0000000000000000);
1119 usb_mtp_add_u64(d, 0x0000000000000000);
1120 usb_mtp_add_u32(d, 0x00000000);
1121 usb_mtp_add_u8(d, 0x00);
1124 usb_mtp_add_u16(d, PROP_NAME);
1125 usb_mtp_add_u16(d, DATA_TYPE_STRING);
1126 usb_mtp_add_u8(d, 0x00);
1127 usb_mtp_add_u8(d, 0x00);
1128 usb_mtp_add_u32(d, 0x00000000);
1129 usb_mtp_add_u8(d, 0x00);
1132 usb_mtp_data_free(d);
1139 static MTPData *usb_mtp_get_object_prop_value(MTPState *s, MTPControl *c,
1142 MTPData *d = usb_mtp_data_alloc(c);
1143 switch (c->argv[1]) {
1144 case PROP_STORAGE_ID:
1145 usb_mtp_add_u32(d, QEMU_STORAGE_ID);
1147 case PROP_OBJECT_FORMAT:
1148 usb_mtp_add_u16(d, o->format);
1150 case PROP_OBJECT_COMPRESSED_SIZE:
1151 usb_mtp_add_u64(d, o->stat.st_size);
1153 case PROP_PARENT_OBJECT:
1154 if (o->parent == NULL) {
1155 usb_mtp_add_u32(d, 0x00000000);
1157 usb_mtp_add_u32(d, o->parent->handle);
1160 case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER:
1161 /* Should be persistent between sessions,
1162 * but using our objedt ID is "good enough"
1164 usb_mtp_add_u64(d, 0x0000000000000000);
1165 usb_mtp_add_u64(d, o->handle);
1168 usb_mtp_add_str(d, o->name);
1171 usb_mtp_data_free(d);
1178 /* Return correct return code for a delete event */
1185 /* Assumes that children, if any, have been already freed */
1186 static void usb_mtp_object_free_one(MTPState *s, MTPObject *o)
1188 #ifndef CONFIG_INOTIFY1
1189 assert(o->nchildren == 0);
1190 QTAILQ_REMOVE(&s->objects, o, next);
1197 static int usb_mtp_deletefn(MTPState *s, MTPObject *o, uint32_t trans)
1199 MTPObject *iter, *iter2;
1200 bool partial_delete = false;
1201 bool success = false;
1204 * TODO: Add support for Protection Status
1207 QLIST_FOREACH(iter, &o->children, list) {
1208 if (iter->format == FMT_ASSOCIATION) {
1209 QLIST_FOREACH(iter2, &iter->children, list) {
1210 usb_mtp_deletefn(s, iter2, trans);
1215 if (o->format == FMT_UNDEFINED_OBJECT) {
1216 if (remove(o->path)) {
1217 partial_delete = true;
1219 usb_mtp_object_free_one(s, o);
1224 if (o->format == FMT_ASSOCIATION) {
1225 if (rmdir(o->path)) {
1226 partial_delete = true;
1228 usb_mtp_object_free_one(s, o);
1233 if (success && partial_delete) {
1234 return PARTIAL_DELETE;
1236 if (!success && partial_delete) {
1242 static void usb_mtp_object_delete(MTPState *s, uint32_t handle,
1243 uint32_t format_code, uint32_t trans)
1248 /* Return error if store is read-only */
1249 if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1250 usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1255 if (format_code != 0) {
1256 usb_mtp_queue_result(s, RES_SPEC_BY_FORMAT_UNSUPPORTED,
1261 if (handle == 0xFFFFFFF) {
1262 o = QTAILQ_FIRST(&s->objects);
1264 o = usb_mtp_object_lookup(s, handle);
1267 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1272 ret = usb_mtp_deletefn(s, o, trans);
1273 if (ret == PARTIAL_DELETE) {
1274 usb_mtp_queue_result(s, RES_PARTIAL_DELETE,
1277 } else if (ret == READ_ONLY) {
1278 usb_mtp_queue_result(s, RES_STORE_READ_ONLY, trans,
1282 usb_mtp_queue_result(s, RES_OK, trans,
1288 static void usb_mtp_command(MTPState *s, MTPControl *c)
1290 MTPData *data_in = NULL;
1291 MTPObject *o = NULL;
1292 uint32_t nres = 0, res0 = 0;
1295 if (c->code >= CMD_CLOSE_SESSION && s->session == 0) {
1296 usb_mtp_queue_result(s, RES_SESSION_NOT_OPEN,
1297 c->trans, 0, 0, 0, 0);
1301 /* process commands */
1303 case CMD_GET_DEVICE_INFO:
1304 data_in = usb_mtp_get_device_info(s, c);
1306 case CMD_OPEN_SESSION:
1308 usb_mtp_queue_result(s, RES_SESSION_ALREADY_OPEN,
1309 c->trans, 1, s->session, 0, 0);
1312 if (c->argv[0] == 0) {
1313 usb_mtp_queue_result(s, RES_INVALID_PARAMETER,
1314 c->trans, 0, 0, 0, 0);
1317 trace_usb_mtp_op_open_session(s->dev.addr);
1318 s->session = c->argv[0];
1319 usb_mtp_object_alloc(s, s->next_handle++, NULL, s->root);
1320 #ifdef CONFIG_INOTIFY1
1321 if (usb_mtp_inotify_init(s)) {
1322 fprintf(stderr, "usb-mtp: file monitoring init failed\n");
1326 case CMD_CLOSE_SESSION:
1327 trace_usb_mtp_op_close_session(s->dev.addr);
1330 #ifdef CONFIG_INOTIFY1
1331 usb_mtp_inotify_cleanup(s);
1333 usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
1334 assert(QTAILQ_EMPTY(&s->objects));
1336 case CMD_GET_STORAGE_IDS:
1337 data_in = usb_mtp_get_storage_ids(s, c);
1339 case CMD_GET_STORAGE_INFO:
1340 if (c->argv[0] != QEMU_STORAGE_ID &&
1341 c->argv[0] != 0xffffffff) {
1342 usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
1343 c->trans, 0, 0, 0, 0);
1346 data_in = usb_mtp_get_storage_info(s, c);
1348 case CMD_GET_NUM_OBJECTS:
1349 case CMD_GET_OBJECT_HANDLES:
1350 if (c->argv[0] != QEMU_STORAGE_ID &&
1351 c->argv[0] != 0xffffffff) {
1352 usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
1353 c->trans, 0, 0, 0, 0);
1356 if (c->argv[1] != 0x00000000) {
1357 usb_mtp_queue_result(s, RES_SPEC_BY_FORMAT_UNSUPPORTED,
1358 c->trans, 0, 0, 0, 0);
1361 if (c->argv[2] == 0x00000000 ||
1362 c->argv[2] == 0xffffffff) {
1363 o = QTAILQ_FIRST(&s->objects);
1365 o = usb_mtp_object_lookup(s, c->argv[2]);
1368 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1369 c->trans, 0, 0, 0, 0);
1372 if (o->format != FMT_ASSOCIATION) {
1373 usb_mtp_queue_result(s, RES_INVALID_PARENT_OBJECT,
1374 c->trans, 0, 0, 0, 0);
1377 usb_mtp_object_readdir(s, o);
1378 if (c->code == CMD_GET_NUM_OBJECTS) {
1379 trace_usb_mtp_op_get_num_objects(s->dev.addr, o->handle, o->path);
1381 res0 = o->nchildren;
1383 data_in = usb_mtp_get_object_handles(s, c, o);
1386 case CMD_GET_OBJECT_INFO:
1387 o = usb_mtp_object_lookup(s, c->argv[0]);
1389 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1390 c->trans, 0, 0, 0, 0);
1393 data_in = usb_mtp_get_object_info(s, c, o);
1395 case CMD_GET_OBJECT:
1396 o = usb_mtp_object_lookup(s, c->argv[0]);
1398 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1399 c->trans, 0, 0, 0, 0);
1402 if (o->format == FMT_ASSOCIATION) {
1403 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1404 c->trans, 0, 0, 0, 0);
1407 data_in = usb_mtp_get_object(s, c, o);
1408 if (data_in == NULL) {
1409 usb_mtp_queue_result(s, RES_GENERAL_ERROR,
1410 c->trans, 0, 0, 0, 0);
1414 case CMD_DELETE_OBJECT:
1415 usb_mtp_object_delete(s, c->argv[0], c->argv[1], c->trans);
1417 case CMD_GET_PARTIAL_OBJECT:
1418 o = usb_mtp_object_lookup(s, c->argv[0]);
1420 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1421 c->trans, 0, 0, 0, 0);
1424 if (o->format == FMT_ASSOCIATION) {
1425 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1426 c->trans, 0, 0, 0, 0);
1429 data_in = usb_mtp_get_partial_object(s, c, o);
1430 if (data_in == NULL) {
1431 usb_mtp_queue_result(s, RES_GENERAL_ERROR,
1432 c->trans, 0, 0, 0, 0);
1436 res0 = data_in->length;
1438 case CMD_SEND_OBJECT_INFO:
1439 /* Return error if store is read-only */
1440 if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1441 usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1442 c->trans, 0, 0, 0, 0);
1443 } else if (c->argv[0] && (c->argv[0] != QEMU_STORAGE_ID)) {
1444 /* First parameter points to storage id or is 0 */
1445 usb_mtp_queue_result(s, RES_STORE_NOT_AVAILABLE, c->trans,
1447 } else if (c->argv[1] && !c->argv[0]) {
1448 /* If second parameter is specified, first must also be specified */
1449 usb_mtp_queue_result(s, RES_DESTINATION_UNSUPPORTED, c->trans,
1452 uint32_t handle = c->argv[1];
1453 if (handle == 0xFFFFFFFF || handle == 0) {
1455 o = QTAILQ_FIRST(&s->objects);
1457 o = usb_mtp_object_lookup(s, handle);
1460 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE, c->trans,
1462 } else if (o->format != FMT_ASSOCIATION) {
1463 usb_mtp_queue_result(s, RES_INVALID_PARENT_OBJECT, c->trans,
1468 s->dataset.parent_handle = o->handle;
1470 s->data_out = usb_mtp_data_alloc(c);
1472 case CMD_SEND_OBJECT:
1473 if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1474 usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1475 c->trans, 0, 0, 0, 0);
1478 if (!s->write_pending) {
1479 usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO,
1480 c->trans, 0, 0, 0, 0);
1483 s->data_out = usb_mtp_data_alloc(c);
1485 case CMD_GET_OBJECT_PROPS_SUPPORTED:
1486 if (c->argv[0] != FMT_UNDEFINED_OBJECT &&
1487 c->argv[0] != FMT_ASSOCIATION) {
1488 usb_mtp_queue_result(s, RES_INVALID_OBJECT_FORMAT_CODE,
1489 c->trans, 0, 0, 0, 0);
1492 data_in = usb_mtp_get_object_props_supported(s, c);
1494 case CMD_GET_OBJECT_PROP_DESC:
1495 if (c->argv[1] != FMT_UNDEFINED_OBJECT &&
1496 c->argv[1] != FMT_ASSOCIATION) {
1497 usb_mtp_queue_result(s, RES_INVALID_OBJECT_FORMAT_CODE,
1498 c->trans, 0, 0, 0, 0);
1501 data_in = usb_mtp_get_object_prop_desc(s, c);
1502 if (data_in == NULL) {
1503 usb_mtp_queue_result(s, RES_INVALID_OBJECT_PROP_CODE,
1504 c->trans, 0, 0, 0, 0);
1508 case CMD_GET_OBJECT_PROP_VALUE:
1509 o = usb_mtp_object_lookup(s, c->argv[0]);
1511 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1512 c->trans, 0, 0, 0, 0);
1515 data_in = usb_mtp_get_object_prop_value(s, c, o);
1516 if (data_in == NULL) {
1517 usb_mtp_queue_result(s, RES_INVALID_OBJECT_PROP_CODE,
1518 c->trans, 0, 0, 0, 0);
1523 trace_usb_mtp_op_unknown(s->dev.addr, c->code);
1524 usb_mtp_queue_result(s, RES_OPERATION_NOT_SUPPORTED,
1525 c->trans, 0, 0, 0, 0);
1529 /* return results on success */
1531 assert(s->data_in == NULL);
1532 s->data_in = data_in;
1534 usb_mtp_queue_result(s, RES_OK, c->trans, nres, res0, 0, 0);
1537 /* ----------------------------------------------------------------------- */
1539 static void usb_mtp_handle_reset(USBDevice *dev)
1541 MTPState *s = USB_MTP(dev);
1543 trace_usb_mtp_reset(s->dev.addr);
1545 #ifdef CONFIG_INOTIFY1
1546 usb_mtp_inotify_cleanup(s);
1548 usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
1550 usb_mtp_data_free(s->data_in);
1552 usb_mtp_data_free(s->data_out);
1558 static void usb_mtp_handle_control(USBDevice *dev, USBPacket *p,
1559 int request, int value, int index,
1560 int length, uint8_t *data)
1563 MTPState *s = USB_MTP(dev);
1564 uint16_t *event = (uint16_t *)data;
1567 case ClassInterfaceOutRequest | 0x64:
1568 if (*event == EVT_CANCEL_TRANSACTION) {
1571 usb_mtp_data_free(s->data_in);
1573 if (s->write_pending) {
1574 g_free(s->dataset.filename);
1575 s->write_pending = false;
1576 s->dataset.size = 0;
1578 usb_mtp_data_free(s->data_out);
1581 p->status = USB_RET_STALL;
1585 ret = usb_desc_handle_control(dev, p, request,
1586 value, index, length, data);
1592 trace_usb_mtp_stall(dev->addr, "unknown control request");
1595 static void usb_mtp_cancel_packet(USBDevice *dev, USBPacket *p)
1597 /* we don't use async packets, so this should never be called */
1598 fprintf(stderr, "%s\n", __func__);
1601 static char *utf16_to_str(uint8_t len, uint16_t *arr)
1603 wchar_t *wstr = g_new0(wchar_t, len + 1);
1607 for (count = 0; count < len; count++) {
1608 /* FIXME: not working for surrogate pairs */
1609 wstr[count] = (wchar_t)arr[count];
1613 dlen = wcstombs(NULL, wstr, 0) + 1;
1614 dest = g_malloc(dlen);
1615 wcstombs(dest, wstr, dlen);
1620 /* Wrapper around write, returns 0 on failure */
1621 static uint64_t write_retry(int fd, void *buf, uint64_t size)
1623 uint64_t bytes_left = size, ret;
1625 while (bytes_left > 0) {
1626 ret = write(fd, buf, bytes_left);
1627 if ((ret == -1) && (errno != EINTR || errno != EAGAIN ||
1628 errno != EWOULDBLOCK)) {
1635 return size - bytes_left;
1638 static void usb_mtp_write_data(MTPState *s)
1640 MTPData *d = s->data_out;
1642 usb_mtp_object_lookup(s, s->dataset.parent_handle);
1649 if (parent == NULL || !s->write_pending) {
1650 usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO, d->trans,
1655 if (s->dataset.filename) {
1656 path = g_strdup_printf("%s/%s", parent->path, s->dataset.filename);
1657 if (s->dataset.format == FMT_ASSOCIATION) {
1658 d->fd = mkdir(path, mask);
1661 if ((s->dataset.size != 0xFFFFFFFF) && (s->dataset.size < d->length)) {
1662 usb_mtp_queue_result(s, RES_STORE_FULL, d->trans,
1666 d->fd = open(path, O_CREAT | O_WRONLY | O_CLOEXEC | O_NOFOLLOW, mask);
1668 usb_mtp_queue_result(s, RES_STORE_FULL, d->trans,
1674 * Return success if initiator sent 0 sized data
1676 if (!s->dataset.size) {
1680 rc = write_retry(d->fd, d->data, d->offset);
1681 if (rc != d->offset) {
1682 usb_mtp_queue_result(s, RES_STORE_FULL, d->trans,
1686 /* Only for < 4G file sizes */
1687 if (s->dataset.size != 0xFFFFFFFF && rc != s->dataset.size) {
1688 usb_mtp_queue_result(s, RES_INCOMPLETE_TRANSFER, d->trans,
1695 usb_mtp_queue_result(s, RES_OK, d->trans,
1700 * The write dataset is kept around and freed only
1701 * on success or if another write request comes in
1707 g_free(s->dataset.filename);
1708 s->dataset.size = 0;
1710 s->write_pending = false;
1713 static void usb_mtp_write_metadata(MTPState *s, uint64_t dlen)
1715 MTPData *d = s->data_out;
1716 ObjectInfo *dataset = (ObjectInfo *)d->data;
1719 MTPObject *p = usb_mtp_object_lookup(s, s->dataset.parent_handle);
1720 uint32_t next_handle = s->next_handle;
1722 assert(!s->write_pending);
1725 filename = utf16_to_str(MIN(dataset->length,
1726 dlen - offsetof(ObjectInfo, filename)),
1729 if (strchr(filename, '/')) {
1730 usb_mtp_queue_result(s, RES_PARAMETER_NOT_SUPPORTED, d->trans,
1735 o = usb_mtp_object_lookup_name(p, filename, dataset->length);
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);
1747 /* next_handle will be allocated to the newly created dir */
1749 usb_mtp_queue_result(s, RES_STORE_FULL, d->trans,
1756 usb_mtp_queue_result(s, RES_OK, d->trans, 3, QEMU_STORAGE_ID,
1757 s->dataset.parent_handle, next_handle);
1760 static void usb_mtp_get_data(MTPState *s, mtp_container *container,
1763 MTPData *d = s->data_out;
1765 uint32_t data_len = p->iov.size;
1769 usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO, 0,
1774 /* Total length of incoming data */
1775 total_len = cpu_to_le32(container->length) - sizeof(mtp_container);
1776 /* Length of data in this packet */
1777 data_len -= sizeof(mtp_container);
1778 usb_mtp_realloc(d, total_len);
1779 d->length += total_len;
1781 d->cached_length = total_len;
1787 usb_mtp_realloc(d, d->cached_length);
1788 d->length += d->cached_length;
1792 if (d->length - d->offset > data_len) {
1795 dlen = d->length - d->offset;
1796 /* Check for cached data for large files */
1797 if ((s->dataset.size == 0xFFFFFFFF) && (dlen < p->iov.size)) {
1798 usb_mtp_realloc(d, p->iov.size - dlen);
1799 d->length += p->iov.size - dlen;
1805 case CMD_SEND_OBJECT_INFO:
1806 usb_packet_copy(p, d->data + d->offset, dlen);
1808 if (d->offset == d->length) {
1809 /* The operation might have already failed */
1811 usb_mtp_write_metadata(s, dlen);
1813 usb_mtp_data_free(s->data_out);
1818 case CMD_SEND_OBJECT:
1819 usb_packet_copy(p, d->data + d->offset, dlen);
1821 if ((p->iov.size % 64) || !p->iov.size) {
1822 assert((s->dataset.size == 0xFFFFFFFF) ||
1823 (s->dataset.size == d->length));
1825 usb_mtp_write_data(s);
1826 usb_mtp_data_free(s->data_out);
1830 if (d->offset == d->length) {
1835 p->status = USB_RET_STALL;
1840 static void usb_mtp_handle_data(USBDevice *dev, USBPacket *p)
1842 MTPState *s = USB_MTP(dev);
1844 mtp_container container;
1846 uint16_t container_type;
1849 switch (p->ep->nr) {
1851 if (s->data_out != NULL) {
1853 trace_usb_mtp_stall(s->dev.addr, "awaiting data-out");
1854 p->status = USB_RET_STALL;
1857 if (p->iov.size < sizeof(container)) {
1858 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1859 p->status = USB_RET_STALL;
1862 if (s->data_in != NULL) {
1863 MTPData *d = s->data_in;
1864 uint64_t dlen = d->length - d->offset;
1866 trace_usb_mtp_data_in(s->dev.addr, d->trans, d->length);
1867 if (d->length + sizeof(container) > 0xFFFFFFFF) {
1868 container.length = cpu_to_le32(0xFFFFFFFF);
1871 cpu_to_le32(d->length + sizeof(container));
1873 container.type = cpu_to_le16(TYPE_DATA);
1874 container.code = cpu_to_le16(d->code);
1875 container.trans = cpu_to_le32(d->trans);
1876 usb_packet_copy(p, &container, sizeof(container));
1878 if (dlen > p->iov.size - sizeof(container)) {
1879 dlen = p->iov.size - sizeof(container);
1882 if (dlen > p->iov.size) {
1887 usb_packet_copy(p, d->data + d->offset, dlen);
1889 if (d->alloc < p->iov.size) {
1890 d->alloc = p->iov.size;
1891 d->data = g_realloc(d->data, d->alloc);
1893 rc = read(d->fd, d->data, dlen);
1895 memset(d->data, 0, dlen);
1896 s->result->code = RES_INCOMPLETE_TRANSFER;
1898 usb_packet_copy(p, d->data, dlen);
1901 if (d->offset == d->length) {
1902 usb_mtp_data_free(s->data_in);
1905 } else if (s->result != NULL) {
1906 MTPControl *r = s->result;
1907 int length = sizeof(container) + r->argc * sizeof(uint32_t);
1908 if (r->code == RES_OK) {
1909 trace_usb_mtp_success(s->dev.addr, r->trans,
1910 (r->argc > 0) ? r->argv[0] : 0,
1911 (r->argc > 1) ? r->argv[1] : 0);
1913 trace_usb_mtp_error(s->dev.addr, r->code, r->trans,
1914 (r->argc > 0) ? r->argv[0] : 0,
1915 (r->argc > 1) ? r->argv[1] : 0);
1917 container.length = cpu_to_le32(length);
1918 container.type = cpu_to_le16(TYPE_RESPONSE);
1919 container.code = cpu_to_le16(r->code);
1920 container.trans = cpu_to_le32(r->trans);
1921 for (i = 0; i < r->argc; i++) {
1922 params[i] = cpu_to_le32(r->argv[i]);
1924 usb_packet_copy(p, &container, sizeof(container));
1925 usb_packet_copy(p, ¶ms, length - sizeof(container));
1931 if (p->iov.size < sizeof(container)) {
1932 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1933 p->status = USB_RET_STALL;
1936 if ((s->data_out != NULL) && !s->data_out->first) {
1937 container_type = TYPE_DATA;
1939 usb_packet_copy(p, &container, sizeof(container));
1940 container_type = le16_to_cpu(container.type);
1942 switch (container_type) {
1944 if (s->data_in || s->data_out || s->result) {
1945 trace_usb_mtp_stall(s->dev.addr, "transaction inflight");
1946 p->status = USB_RET_STALL;
1949 cmd.code = le16_to_cpu(container.code);
1950 cmd.argc = (le32_to_cpu(container.length) - sizeof(container))
1952 cmd.trans = le32_to_cpu(container.trans);
1953 if (cmd.argc > ARRAY_SIZE(cmd.argv)) {
1954 cmd.argc = ARRAY_SIZE(cmd.argv);
1956 if (p->iov.size < sizeof(container) + cmd.argc * sizeof(uint32_t)) {
1957 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1958 p->status = USB_RET_STALL;
1961 usb_packet_copy(p, ¶ms, cmd.argc * sizeof(uint32_t));
1962 for (i = 0; i < cmd.argc; i++) {
1963 cmd.argv[i] = le32_to_cpu(params[i]);
1965 trace_usb_mtp_command(s->dev.addr, cmd.code, cmd.trans,
1966 (cmd.argc > 0) ? cmd.argv[0] : 0,
1967 (cmd.argc > 1) ? cmd.argv[1] : 0,
1968 (cmd.argc > 2) ? cmd.argv[2] : 0,
1969 (cmd.argc > 3) ? cmd.argv[3] : 0,
1970 (cmd.argc > 4) ? cmd.argv[4] : 0);
1971 usb_mtp_command(s, &cmd);
1974 /* One of the previous transfers has already errored but the
1975 * responder is still sending data associated with it
1977 if (s->result != NULL) {
1980 usb_mtp_get_data(s, &container, p);
1983 /* not needed as long as the mtp device is read-only */
1984 p->status = USB_RET_STALL;
1989 #ifdef CONFIG_INOTIFY1
1990 if (!QTAILQ_EMPTY(&s->events)) {
1991 struct MTPMonEntry *e = QTAILQ_LAST(&s->events, events);
1993 int len = sizeof(container) + sizeof(uint32_t);
1995 if (p->iov.size < len) {
1996 trace_usb_mtp_stall(s->dev.addr,
1997 "packet too small to send event");
1998 p->status = USB_RET_STALL;
2002 QTAILQ_REMOVE(&s->events, e, next);
2003 container.length = cpu_to_le32(len);
2004 container.type = cpu_to_le32(TYPE_EVENT);
2005 container.code = cpu_to_le16(e->event);
2006 container.trans = 0; /* no trans specific events */
2007 handle = cpu_to_le32(e->handle);
2008 usb_packet_copy(p, &container, sizeof(container));
2009 usb_packet_copy(p, &handle, sizeof(uint32_t));
2014 p->status = USB_RET_NAK;
2017 trace_usb_mtp_stall(s->dev.addr, "invalid endpoint");
2018 p->status = USB_RET_STALL;
2022 if (p->actual_length == 0) {
2023 trace_usb_mtp_nak(s->dev.addr, p->ep->nr);
2024 p->status = USB_RET_NAK;
2027 trace_usb_mtp_xfer(s->dev.addr, p->ep->nr, p->actual_length,
2033 static void usb_mtp_realize(USBDevice *dev, Error **errp)
2035 MTPState *s = USB_MTP(dev);
2037 usb_desc_create_serial(dev);
2039 QTAILQ_INIT(&s->objects);
2040 if (s->desc == NULL) {
2041 if (s->root == NULL) {
2042 error_setg(errp, "usb-mtp: rootdir property must be configured");
2045 s->desc = strrchr(s->root, '/');
2046 if (s->desc && s->desc[0]) {
2047 s->desc = g_strdup(s->desc + 1);
2049 s->desc = g_strdup("none");
2052 /* Mark store as RW */
2054 s->flags |= (1 << MTP_FLAG_WRITABLE);
2059 static const VMStateDescription vmstate_usb_mtp = {
2063 .minimum_version_id = 1,
2064 .fields = (VMStateField[]) {
2065 VMSTATE_USB_DEVICE(dev, MTPState),
2066 VMSTATE_END_OF_LIST()
2070 static Property mtp_properties[] = {
2071 DEFINE_PROP_STRING("rootdir", MTPState, root),
2072 DEFINE_PROP_STRING("desc", MTPState, desc),
2073 DEFINE_PROP_BOOL("readonly", MTPState, readonly, true),
2074 DEFINE_PROP_END_OF_LIST(),
2077 static void usb_mtp_class_initfn(ObjectClass *klass, void *data)
2079 DeviceClass *dc = DEVICE_CLASS(klass);
2080 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
2082 uc->realize = usb_mtp_realize;
2083 uc->product_desc = "QEMU USB MTP";
2084 uc->usb_desc = &desc;
2085 uc->cancel_packet = usb_mtp_cancel_packet;
2086 uc->handle_attach = usb_desc_attach;
2087 uc->handle_reset = usb_mtp_handle_reset;
2088 uc->handle_control = usb_mtp_handle_control;
2089 uc->handle_data = usb_mtp_handle_data;
2090 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
2091 dc->desc = "USB Media Transfer Protocol device";
2092 dc->fw_name = "mtp";
2093 dc->vmsd = &vmstate_usb_mtp;
2094 dc->props = mtp_properties;
2097 static TypeInfo mtp_info = {
2098 .name = TYPE_USB_MTP,
2099 .parent = TYPE_USB_DEVICE,
2100 .instance_size = sizeof(MTPState),
2101 .class_init = usb_mtp_class_initfn,
2104 static void usb_mtp_register_types(void)
2106 type_register_static(&mtp_info);
2109 type_init(usb_mtp_register_types)