2 * Media Transfer Protocol implementation, backed by host filesystem.
4 * Copyright Red Hat, Inc 2014
7 * Gerd Hoffmann <kraxel@redhat.com>
9 * This code is licensed under the GPL v2 or later.
17 #include <sys/statvfs.h>
19 #include <sys/inotify.h>
20 #include "qemu/main-loop.h"
23 #include "qemu-common.h"
27 #include "hw/usb/desc.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_GET_PARTIAL_OBJECT
= 0x101b,
53 RES_GENERAL_ERROR
= 0x2002,
54 RES_SESSION_NOT_OPEN
= 0x2003,
55 RES_INVALID_TRANSACTION_ID
= 0x2004,
56 RES_OPERATION_NOT_SUPPORTED
= 0x2005,
57 RES_PARAMETER_NOT_SUPPORTED
= 0x2006,
58 RES_INCOMPLETE_TRANSFER
= 0x2007,
59 RES_INVALID_STORAGE_ID
= 0x2008,
60 RES_INVALID_OBJECT_HANDLE
= 0x2009,
61 RES_SPEC_BY_FORMAT_UNSUPPORTED
= 0x2014,
62 RES_INVALID_PARENT_OBJECT
= 0x201a,
63 RES_INVALID_PARAMETER
= 0x201d,
64 RES_SESSION_ALREADY_OPEN
= 0x201e,
67 FMT_UNDEFINED_OBJECT
= 0x3000,
68 FMT_ASSOCIATION
= 0x3001,
71 EVT_OBJ_ADDED
= 0x4002,
72 EVT_OBJ_REMOVED
= 0x4003,
73 EVT_OBJ_INFO_CHANGED
= 0x4007,
81 } QEMU_PACKED mtp_container
;
83 /* ----------------------------------------------------------------------- */
85 typedef struct MTPState MTPState
;
86 typedef struct MTPControl MTPControl
;
87 typedef struct MTPData MTPData
;
88 typedef struct MTPObject MTPObject
;
97 typedef struct MTPMonEntry MTPMonEntry
;
103 QTAILQ_ENTRY(MTPMonEntry
) next
;
132 /* inotify watch cookie */
137 QLIST_HEAD(, MTPObject
) children
;
138 QLIST_ENTRY(MTPObject
) list
;
140 QTAILQ_ENTRY(MTPObject
) next
;
153 uint32_t next_handle
;
155 QTAILQ_HEAD(, MTPObject
) objects
;
157 /* inotify descriptor */
159 QTAILQ_HEAD(events
, MTPMonEntry
) events
;
163 #define TYPE_USB_MTP "usb-mtp"
164 #define USB_MTP(obj) OBJECT_CHECK(MTPState, (obj), TYPE_USB_MTP)
166 #define QEMU_STORAGE_ID 0x00010001
168 #define MTP_FLAG_WRITABLE 0
170 #define FLAG_SET(_mtp, _flag) ((_mtp)->flags & (1 << (_flag)))
172 /* ----------------------------------------------------------------------- */
174 #define MTP_MANUFACTURER "QEMU"
175 #define MTP_PRODUCT "QEMU filesharing"
178 STR_MANUFACTURER
= 1,
187 static const USBDescStrings desc_strings
= {
188 [STR_MANUFACTURER
] = MTP_MANUFACTURER
,
189 [STR_PRODUCT
] = MTP_PRODUCT
,
190 [STR_SERIALNUMBER
] = "34617",
192 [STR_CONFIG_FULL
] = "Full speed config (usb 1.1)",
193 [STR_CONFIG_HIGH
] = "High speed config (usb 2.0)",
194 [STR_CONFIG_SUPER
] = "Super speed config (usb 3.0)",
197 static const USBDescIface desc_iface_full
= {
198 .bInterfaceNumber
= 0,
200 .bInterfaceClass
= USB_CLASS_STILL_IMAGE
,
201 .bInterfaceSubClass
= 0x01,
202 .bInterfaceProtocol
= 0x01,
203 .iInterface
= STR_MTP
,
204 .eps
= (USBDescEndpoint
[]) {
206 .bEndpointAddress
= USB_DIR_IN
| EP_DATA_IN
,
207 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
208 .wMaxPacketSize
= 64,
210 .bEndpointAddress
= USB_DIR_OUT
| EP_DATA_OUT
,
211 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
212 .wMaxPacketSize
= 64,
214 .bEndpointAddress
= USB_DIR_IN
| EP_EVENT
,
215 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
222 static const USBDescDevice desc_device_full
= {
224 .bMaxPacketSize0
= 8,
225 .bNumConfigurations
= 1,
226 .confs
= (USBDescConfig
[]) {
229 .bConfigurationValue
= 1,
230 .iConfiguration
= STR_CONFIG_FULL
,
231 .bmAttributes
= USB_CFG_ATT_ONE
| USB_CFG_ATT_WAKEUP
,
234 .ifs
= &desc_iface_full
,
239 static const USBDescIface desc_iface_high
= {
240 .bInterfaceNumber
= 0,
242 .bInterfaceClass
= USB_CLASS_STILL_IMAGE
,
243 .bInterfaceSubClass
= 0x01,
244 .bInterfaceProtocol
= 0x01,
245 .iInterface
= STR_MTP
,
246 .eps
= (USBDescEndpoint
[]) {
248 .bEndpointAddress
= USB_DIR_IN
| EP_DATA_IN
,
249 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
250 .wMaxPacketSize
= 512,
252 .bEndpointAddress
= USB_DIR_OUT
| EP_DATA_OUT
,
253 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
254 .wMaxPacketSize
= 512,
256 .bEndpointAddress
= USB_DIR_IN
| EP_EVENT
,
257 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
264 static const USBDescDevice desc_device_high
= {
266 .bMaxPacketSize0
= 64,
267 .bNumConfigurations
= 1,
268 .confs
= (USBDescConfig
[]) {
271 .bConfigurationValue
= 1,
272 .iConfiguration
= STR_CONFIG_HIGH
,
273 .bmAttributes
= USB_CFG_ATT_ONE
| USB_CFG_ATT_WAKEUP
,
276 .ifs
= &desc_iface_high
,
281 static const USBDescMSOS desc_msos
= {
282 .CompatibleID
= "MTP",
283 .SelectiveSuspendEnabled
= true,
286 static const USBDesc desc
= {
288 .idVendor
= 0x46f4, /* CRC16() of "QEMU" */
291 .iManufacturer
= STR_MANUFACTURER
,
292 .iProduct
= STR_PRODUCT
,
293 .iSerialNumber
= STR_SERIALNUMBER
,
295 .full
= &desc_device_full
,
296 .high
= &desc_device_high
,
301 /* ----------------------------------------------------------------------- */
303 static MTPObject
*usb_mtp_object_alloc(MTPState
*s
, uint32_t handle
,
304 MTPObject
*parent
, char *name
)
306 MTPObject
*o
= g_new0(MTPObject
, 1);
308 if (name
[0] == '.') {
314 o
->name
= g_strdup(name
);
315 if (parent
== NULL
) {
316 o
->path
= g_strdup(name
);
318 o
->path
= g_strdup_printf("%s/%s", parent
->path
, name
);
321 if (lstat(o
->path
, &o
->stat
) != 0) {
324 if (S_ISREG(o
->stat
.st_mode
)) {
325 o
->format
= FMT_UNDEFINED_OBJECT
;
326 } else if (S_ISDIR(o
->stat
.st_mode
)) {
327 o
->format
= FMT_ASSOCIATION
;
332 if (access(o
->path
, R_OK
) != 0) {
336 trace_usb_mtp_object_alloc(s
->dev
.addr
, o
->handle
, o
->path
);
338 QTAILQ_INSERT_TAIL(&s
->objects
, o
, next
);
348 static void usb_mtp_object_free(MTPState
*s
, MTPObject
*o
)
356 trace_usb_mtp_object_free(s
->dev
.addr
, o
->handle
, o
->path
);
358 QTAILQ_REMOVE(&s
->objects
, o
, next
);
360 QLIST_REMOVE(o
, list
);
361 o
->parent
->nchildren
--;
364 while (!QLIST_EMPTY(&o
->children
)) {
365 iter
= QLIST_FIRST(&o
->children
);
366 usb_mtp_object_free(s
, iter
);
373 static MTPObject
*usb_mtp_object_lookup(MTPState
*s
, uint32_t handle
)
377 QTAILQ_FOREACH(o
, &s
->objects
, next
) {
378 if (o
->handle
== handle
) {
385 static MTPObject
*usb_mtp_add_child(MTPState
*s
, MTPObject
*o
,
389 usb_mtp_object_alloc(s
, s
->next_handle
++, o
, name
);
392 trace_usb_mtp_add_child(s
->dev
.addr
, child
->handle
, child
->path
);
393 QLIST_INSERT_HEAD(&o
->children
, child
, list
);
396 if (child
->format
== FMT_ASSOCIATION
) {
397 QLIST_INIT(&child
->children
);
405 static MTPObject
*usb_mtp_object_lookup_name(MTPObject
*parent
,
410 QLIST_FOREACH(iter
, &parent
->children
, list
) {
411 if (strncmp(iter
->name
, name
, len
) == 0) {
419 static MTPObject
*usb_mtp_object_lookup_wd(MTPState
*s
, int wd
)
423 QTAILQ_FOREACH(iter
, &s
->objects
, next
) {
424 if (iter
->watchfd
== wd
) {
432 static void inotify_watchfn(void *arg
)
436 /* From the man page: atleast one event can be read */
437 int len
= sizeof(struct inotify_event
) + NAME_MAX
+ 1;
442 bytes
= read(s
->inotifyfd
, buf
, len
);
446 /* Better luck next time */
451 * TODO: Ignore initiator initiated events.
452 * For now we are good because the store is RO
456 struct inotify_event
*event
= (struct inotify_event
*)p
;
458 uint32_t mask
= event
->mask
& (IN_CREATE
| IN_DELETE
|
459 IN_MODIFY
| IN_IGNORED
);
460 MTPObject
*parent
= usb_mtp_object_lookup_wd(s
, event
->wd
);
461 MTPMonEntry
*entry
= NULL
;
464 pos
= pos
+ sizeof(struct inotify_event
) + event
->len
;
473 if (usb_mtp_object_lookup_name
474 (parent
, event
->name
, event
->len
)) {
475 /* Duplicate create event */
478 entry
= g_new0(MTPMonEntry
, 1);
479 entry
->handle
= s
->next_handle
;
480 entry
->event
= EVT_OBJ_ADDED
;
481 o
= usb_mtp_add_child(s
, parent
, event
->name
);
486 o
->watchfd
= watchfd
;
487 trace_usb_mtp_inotify_event(s
->dev
.addr
, event
->name
,
488 event
->mask
, "Obj Added");
493 * The kernel issues a IN_IGNORED event
494 * when a dir containing a watchpoint is
495 * deleted, so we don't have to delete the
498 o
= usb_mtp_object_lookup_name(parent
, event
->name
, event
->len
);
502 entry
= g_new0(MTPMonEntry
, 1);
503 entry
->handle
= o
->handle
;
504 entry
->event
= EVT_OBJ_REMOVED
;
505 usb_mtp_object_free(s
, o
);
506 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
507 event
->mask
, "Obj Deleted");
511 o
= usb_mtp_object_lookup_name(parent
, event
->name
, event
->len
);
515 entry
= g_new0(MTPMonEntry
, 1);
516 entry
->handle
= o
->handle
;
517 entry
->event
= EVT_OBJ_INFO_CHANGED
;
518 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
519 event
->mask
, "Obj Modified");
523 o
= usb_mtp_object_lookup_name(parent
, event
->name
, event
->len
);
524 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
525 event
->mask
, "Obj ignored");
529 fprintf(stderr
, "usb-mtp: failed to parse inotify event\n");
534 QTAILQ_INSERT_HEAD(&s
->events
, entry
, next
);
540 static int usb_mtp_inotify_init(MTPState
*s
)
544 fd
= inotify_init1(IN_NONBLOCK
);
549 QTAILQ_INIT(&s
->events
);
552 qemu_set_fd_handler(fd
, inotify_watchfn
, NULL
, s
);
557 static void usb_mtp_inotify_cleanup(MTPState
*s
)
565 qemu_set_fd_handler(s
->inotifyfd
, NULL
, NULL
, s
);
568 QTAILQ_FOREACH(e
, &s
->events
, next
) {
569 QTAILQ_REMOVE(&s
->events
, e
, next
);
574 static int usb_mtp_add_watch(int inotifyfd
, char *path
)
576 uint32_t mask
= IN_CREATE
| IN_DELETE
| IN_MODIFY
|
579 return inotify_add_watch(inotifyfd
, path
, mask
);
583 static void usb_mtp_object_readdir(MTPState
*s
, MTPObject
*o
)
585 struct dirent
*entry
;
588 if (o
->have_children
) {
591 o
->have_children
= true;
593 dir
= opendir(o
->path
);
598 int watchfd
= usb_mtp_add_watch(s
->inotifyfd
, o
->path
);
600 fprintf(stderr
, "usb-mtp: failed to add watch for %s\n", o
->path
);
602 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
604 o
->watchfd
= watchfd
;
607 while ((entry
= readdir(dir
)) != NULL
) {
608 usb_mtp_add_child(s
, o
, entry
->d_name
);
613 /* ----------------------------------------------------------------------- */
615 static MTPData
*usb_mtp_data_alloc(MTPControl
*c
)
617 MTPData
*data
= g_new0(MTPData
, 1);
619 data
->code
= c
->code
;
620 data
->trans
= c
->trans
;
626 static void usb_mtp_data_free(MTPData
*data
)
631 if (data
->fd
!= -1) {
638 static void usb_mtp_realloc(MTPData
*data
, uint32_t bytes
)
640 if (data
->length
+ bytes
<= data
->alloc
) {
643 data
->alloc
= (data
->length
+ bytes
+ 0xff) & ~0xff;
644 data
->data
= g_realloc(data
->data
, data
->alloc
);
647 static void usb_mtp_add_u8(MTPData
*data
, uint8_t val
)
649 usb_mtp_realloc(data
, 1);
650 data
->data
[data
->length
++] = val
;
653 static void usb_mtp_add_u16(MTPData
*data
, uint16_t val
)
655 usb_mtp_realloc(data
, 2);
656 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
657 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
660 static void usb_mtp_add_u32(MTPData
*data
, uint32_t val
)
662 usb_mtp_realloc(data
, 4);
663 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
664 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
665 data
->data
[data
->length
++] = (val
>> 16) & 0xff;
666 data
->data
[data
->length
++] = (val
>> 24) & 0xff;
669 static void usb_mtp_add_u64(MTPData
*data
, uint64_t val
)
671 usb_mtp_realloc(data
, 8);
672 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
673 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
674 data
->data
[data
->length
++] = (val
>> 16) & 0xff;
675 data
->data
[data
->length
++] = (val
>> 24) & 0xff;
676 data
->data
[data
->length
++] = (val
>> 32) & 0xff;
677 data
->data
[data
->length
++] = (val
>> 40) & 0xff;
678 data
->data
[data
->length
++] = (val
>> 48) & 0xff;
679 data
->data
[data
->length
++] = (val
>> 56) & 0xff;
682 static void usb_mtp_add_u16_array(MTPData
*data
, uint32_t len
,
683 const uint16_t *vals
)
687 usb_mtp_add_u32(data
, len
);
688 for (i
= 0; i
< len
; i
++) {
689 usb_mtp_add_u16(data
, vals
[i
]);
693 static void usb_mtp_add_u32_array(MTPData
*data
, uint32_t len
,
694 const uint32_t *vals
)
698 usb_mtp_add_u32(data
, len
);
699 for (i
= 0; i
< len
; i
++) {
700 usb_mtp_add_u32(data
, vals
[i
]);
704 static void usb_mtp_add_wstr(MTPData
*data
, const wchar_t *str
)
706 uint32_t len
= wcslen(str
);
710 len
++; /* include terminating L'\0' */
713 usb_mtp_add_u8(data
, len
);
714 for (i
= 0; i
< len
; i
++) {
715 usb_mtp_add_u16(data
, str
[i
]);
719 static void usb_mtp_add_str(MTPData
*data
, const char *str
)
721 uint32_t len
= strlen(str
)+1;
725 ret
= mbstowcs(wstr
, str
, len
);
727 usb_mtp_add_wstr(data
, L
"Oops");
729 usb_mtp_add_wstr(data
, wstr
);
733 static void usb_mtp_add_time(MTPData
*data
, time_t time
)
738 gmtime_r(&time
, &tm
);
739 strftime(buf
, sizeof(buf
), "%Y%m%dT%H%M%S", &tm
);
740 usb_mtp_add_str(data
, buf
);
743 /* ----------------------------------------------------------------------- */
745 static void usb_mtp_queue_result(MTPState
*s
, uint16_t code
, uint32_t trans
,
746 int argc
, uint32_t arg0
, uint32_t arg1
)
748 MTPControl
*c
= g_new0(MTPControl
, 1);
760 assert(s
->result
== NULL
);
764 /* ----------------------------------------------------------------------- */
766 static MTPData
*usb_mtp_get_device_info(MTPState
*s
, MTPControl
*c
)
768 static const uint16_t ops
[] = {
773 CMD_GET_STORAGE_INFO
,
775 CMD_GET_OBJECT_HANDLES
,
778 CMD_GET_PARTIAL_OBJECT
,
780 static const uint16_t fmt
[] = {
781 FMT_UNDEFINED_OBJECT
,
784 MTPData
*d
= usb_mtp_data_alloc(c
);
786 trace_usb_mtp_op_get_device_info(s
->dev
.addr
);
788 usb_mtp_add_u16(d
, 100);
789 usb_mtp_add_u32(d
, 0xffffffff);
790 usb_mtp_add_u16(d
, 0x0101);
791 usb_mtp_add_wstr(d
, L
"");
792 usb_mtp_add_u16(d
, 0x0000);
794 usb_mtp_add_u16_array(d
, ARRAY_SIZE(ops
), ops
);
795 usb_mtp_add_u16_array(d
, 0, NULL
);
796 usb_mtp_add_u16_array(d
, 0, NULL
);
797 usb_mtp_add_u16_array(d
, 0, NULL
);
798 usb_mtp_add_u16_array(d
, ARRAY_SIZE(fmt
), fmt
);
800 usb_mtp_add_wstr(d
, L
"" MTP_MANUFACTURER
);
801 usb_mtp_add_wstr(d
, L
"" MTP_PRODUCT
);
802 usb_mtp_add_wstr(d
, L
"0.1");
803 usb_mtp_add_wstr(d
, L
"0123456789abcdef0123456789abcdef");
808 static MTPData
*usb_mtp_get_storage_ids(MTPState
*s
, MTPControl
*c
)
810 static const uint32_t ids
[] = {
813 MTPData
*d
= usb_mtp_data_alloc(c
);
815 trace_usb_mtp_op_get_storage_ids(s
->dev
.addr
);
817 usb_mtp_add_u32_array(d
, ARRAY_SIZE(ids
), ids
);
822 static MTPData
*usb_mtp_get_storage_info(MTPState
*s
, MTPControl
*c
)
824 MTPData
*d
= usb_mtp_data_alloc(c
);
828 trace_usb_mtp_op_get_storage_info(s
->dev
.addr
);
830 if (FLAG_SET(s
, MTP_FLAG_WRITABLE
)) {
831 usb_mtp_add_u16(d
, 0x0003);
832 usb_mtp_add_u16(d
, 0x0002);
833 usb_mtp_add_u16(d
, 0x0000);
835 usb_mtp_add_u16(d
, 0x0001);
836 usb_mtp_add_u16(d
, 0x0002);
837 usb_mtp_add_u16(d
, 0x0001);
840 rc
= statvfs(s
->root
, &buf
);
842 usb_mtp_add_u64(d
, (uint64_t)buf
.f_frsize
* buf
.f_blocks
);
843 usb_mtp_add_u64(d
, (uint64_t)buf
.f_bavail
* buf
.f_blocks
);
844 usb_mtp_add_u32(d
, buf
.f_ffree
);
846 usb_mtp_add_u64(d
, 0xffffffff);
847 usb_mtp_add_u64(d
, 0xffffffff);
848 usb_mtp_add_u32(d
, 0xffffffff);
851 usb_mtp_add_str(d
, s
->desc
);
852 usb_mtp_add_wstr(d
, L
"123456789abcdef");
856 static MTPData
*usb_mtp_get_object_handles(MTPState
*s
, MTPControl
*c
,
859 MTPData
*d
= usb_mtp_data_alloc(c
);
860 uint32_t i
= 0, handles
[o
->nchildren
];
863 trace_usb_mtp_op_get_object_handles(s
->dev
.addr
, o
->handle
, o
->path
);
865 QLIST_FOREACH(iter
, &o
->children
, list
) {
866 handles
[i
++] = iter
->handle
;
868 assert(i
== o
->nchildren
);
869 usb_mtp_add_u32_array(d
, o
->nchildren
, handles
);
874 static MTPData
*usb_mtp_get_object_info(MTPState
*s
, MTPControl
*c
,
877 MTPData
*d
= usb_mtp_data_alloc(c
);
879 trace_usb_mtp_op_get_object_info(s
->dev
.addr
, o
->handle
, o
->path
);
881 usb_mtp_add_u32(d
, QEMU_STORAGE_ID
);
882 usb_mtp_add_u16(d
, o
->format
);
883 usb_mtp_add_u16(d
, 0);
884 usb_mtp_add_u32(d
, o
->stat
.st_size
);
886 usb_mtp_add_u16(d
, 0);
887 usb_mtp_add_u32(d
, 0);
888 usb_mtp_add_u32(d
, 0);
889 usb_mtp_add_u32(d
, 0);
890 usb_mtp_add_u32(d
, 0);
891 usb_mtp_add_u32(d
, 0);
892 usb_mtp_add_u32(d
, 0);
895 usb_mtp_add_u32(d
, o
->parent
->handle
);
897 usb_mtp_add_u32(d
, 0);
899 if (o
->format
== FMT_ASSOCIATION
) {
900 usb_mtp_add_u16(d
, 0x0001);
901 usb_mtp_add_u32(d
, 0x00000001);
902 usb_mtp_add_u32(d
, 0);
904 usb_mtp_add_u16(d
, 0);
905 usb_mtp_add_u32(d
, 0);
906 usb_mtp_add_u32(d
, 0);
909 usb_mtp_add_str(d
, o
->name
);
910 usb_mtp_add_time(d
, o
->stat
.st_ctime
);
911 usb_mtp_add_time(d
, o
->stat
.st_mtime
);
912 usb_mtp_add_wstr(d
, L
"");
917 static MTPData
*usb_mtp_get_object(MTPState
*s
, MTPControl
*c
,
920 MTPData
*d
= usb_mtp_data_alloc(c
);
922 trace_usb_mtp_op_get_object(s
->dev
.addr
, o
->handle
, o
->path
);
924 d
->fd
= open(o
->path
, O_RDONLY
);
926 usb_mtp_data_free(d
);
929 d
->length
= o
->stat
.st_size
;
931 d
->data
= g_malloc(d
->alloc
);
935 static MTPData
*usb_mtp_get_partial_object(MTPState
*s
, MTPControl
*c
,
938 MTPData
*d
= usb_mtp_data_alloc(c
);
941 trace_usb_mtp_op_get_partial_object(s
->dev
.addr
, o
->handle
, o
->path
,
942 c
->argv
[1], c
->argv
[2]);
944 d
->fd
= open(o
->path
, O_RDONLY
);
946 usb_mtp_data_free(d
);
951 if (offset
> o
->stat
.st_size
) {
952 offset
= o
->stat
.st_size
;
954 if (lseek(d
->fd
, offset
, SEEK_SET
) < 0) {
955 usb_mtp_data_free(d
);
959 d
->length
= c
->argv
[2];
960 if (d
->length
> o
->stat
.st_size
- offset
) {
961 d
->length
= o
->stat
.st_size
- offset
;
967 static void usb_mtp_command(MTPState
*s
, MTPControl
*c
)
969 MTPData
*data_in
= NULL
;
971 uint32_t nres
= 0, res0
= 0;
974 if (c
->code
>= CMD_CLOSE_SESSION
&& s
->session
== 0) {
975 usb_mtp_queue_result(s
, RES_SESSION_NOT_OPEN
,
980 /* process commands */
982 case CMD_GET_DEVICE_INFO
:
983 data_in
= usb_mtp_get_device_info(s
, c
);
985 case CMD_OPEN_SESSION
:
987 usb_mtp_queue_result(s
, RES_SESSION_ALREADY_OPEN
,
988 c
->trans
, 1, s
->session
, 0);
991 if (c
->argv
[0] == 0) {
992 usb_mtp_queue_result(s
, RES_INVALID_PARAMETER
,
996 trace_usb_mtp_op_open_session(s
->dev
.addr
);
997 s
->session
= c
->argv
[0];
998 usb_mtp_object_alloc(s
, s
->next_handle
++, NULL
, s
->root
);
1000 if (usb_mtp_inotify_init(s
)) {
1001 fprintf(stderr
, "usb-mtp: file monitoring init failed\n");
1005 case CMD_CLOSE_SESSION
:
1006 trace_usb_mtp_op_close_session(s
->dev
.addr
);
1010 usb_mtp_inotify_cleanup(s
);
1012 usb_mtp_object_free(s
, QTAILQ_FIRST(&s
->objects
));
1013 assert(QTAILQ_EMPTY(&s
->objects
));
1015 case CMD_GET_STORAGE_IDS
:
1016 data_in
= usb_mtp_get_storage_ids(s
, c
);
1018 case CMD_GET_STORAGE_INFO
:
1019 if (c
->argv
[0] != QEMU_STORAGE_ID
&&
1020 c
->argv
[0] != 0xffffffff) {
1021 usb_mtp_queue_result(s
, RES_INVALID_STORAGE_ID
,
1025 data_in
= usb_mtp_get_storage_info(s
, c
);
1027 case CMD_GET_NUM_OBJECTS
:
1028 case CMD_GET_OBJECT_HANDLES
:
1029 if (c
->argv
[0] != QEMU_STORAGE_ID
&&
1030 c
->argv
[0] != 0xffffffff) {
1031 usb_mtp_queue_result(s
, RES_INVALID_STORAGE_ID
,
1035 if (c
->argv
[1] != 0x00000000) {
1036 usb_mtp_queue_result(s
, RES_SPEC_BY_FORMAT_UNSUPPORTED
,
1040 if (c
->argv
[2] == 0x00000000 ||
1041 c
->argv
[2] == 0xffffffff) {
1042 o
= QTAILQ_FIRST(&s
->objects
);
1044 o
= usb_mtp_object_lookup(s
, c
->argv
[2]);
1047 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1051 if (o
->format
!= FMT_ASSOCIATION
) {
1052 usb_mtp_queue_result(s
, RES_INVALID_PARENT_OBJECT
,
1056 usb_mtp_object_readdir(s
, o
);
1057 if (c
->code
== CMD_GET_NUM_OBJECTS
) {
1058 trace_usb_mtp_op_get_num_objects(s
->dev
.addr
, o
->handle
, o
->path
);
1060 res0
= o
->nchildren
;
1062 data_in
= usb_mtp_get_object_handles(s
, c
, o
);
1065 case CMD_GET_OBJECT_INFO
:
1066 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1068 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1072 data_in
= usb_mtp_get_object_info(s
, c
, o
);
1074 case CMD_GET_OBJECT
:
1075 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1077 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1081 if (o
->format
== FMT_ASSOCIATION
) {
1082 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1086 data_in
= usb_mtp_get_object(s
, c
, o
);
1087 if (data_in
== NULL
) {
1088 usb_mtp_queue_result(s
, RES_GENERAL_ERROR
,
1093 case CMD_GET_PARTIAL_OBJECT
:
1094 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1096 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1100 if (o
->format
== FMT_ASSOCIATION
) {
1101 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1105 data_in
= usb_mtp_get_partial_object(s
, c
, o
);
1106 if (data_in
== NULL
) {
1107 usb_mtp_queue_result(s
, RES_GENERAL_ERROR
,
1112 res0
= data_in
->length
;
1115 trace_usb_mtp_op_unknown(s
->dev
.addr
, c
->code
);
1116 usb_mtp_queue_result(s
, RES_OPERATION_NOT_SUPPORTED
,
1121 /* return results on success */
1123 assert(s
->data_in
== NULL
);
1124 s
->data_in
= data_in
;
1126 usb_mtp_queue_result(s
, RES_OK
, c
->trans
, nres
, res0
, 0);
1129 /* ----------------------------------------------------------------------- */
1131 static void usb_mtp_handle_reset(USBDevice
*dev
)
1133 MTPState
*s
= USB_MTP(dev
);
1135 trace_usb_mtp_reset(s
->dev
.addr
);
1138 usb_mtp_inotify_cleanup(s
);
1140 usb_mtp_object_free(s
, QTAILQ_FIRST(&s
->objects
));
1142 usb_mtp_data_free(s
->data_in
);
1144 usb_mtp_data_free(s
->data_out
);
1150 static void usb_mtp_handle_control(USBDevice
*dev
, USBPacket
*p
,
1151 int request
, int value
, int index
,
1152 int length
, uint8_t *data
)
1156 ret
= usb_desc_handle_control(dev
, p
, request
, value
, index
, length
, data
);
1161 trace_usb_mtp_stall(dev
->addr
, "unknown control request");
1162 p
->status
= USB_RET_STALL
;
1165 static void usb_mtp_cancel_packet(USBDevice
*dev
, USBPacket
*p
)
1167 /* we don't use async packets, so this should never be called */
1168 fprintf(stderr
, "%s\n", __func__
);
1171 static void usb_mtp_handle_data(USBDevice
*dev
, USBPacket
*p
)
1173 MTPState
*s
= USB_MTP(dev
);
1175 mtp_container container
;
1179 switch (p
->ep
->nr
) {
1181 if (s
->data_out
!= NULL
) {
1183 trace_usb_mtp_stall(s
->dev
.addr
, "awaiting data-out");
1184 p
->status
= USB_RET_STALL
;
1187 if (p
->iov
.size
< sizeof(container
)) {
1188 trace_usb_mtp_stall(s
->dev
.addr
, "packet too small");
1189 p
->status
= USB_RET_STALL
;
1192 if (s
->data_in
!= NULL
) {
1193 MTPData
*d
= s
->data_in
;
1194 int dlen
= d
->length
- d
->offset
;
1196 trace_usb_mtp_data_in(s
->dev
.addr
, d
->trans
, d
->length
);
1197 container
.length
= cpu_to_le32(d
->length
+ sizeof(container
));
1198 container
.type
= cpu_to_le16(TYPE_DATA
);
1199 container
.code
= cpu_to_le16(d
->code
);
1200 container
.trans
= cpu_to_le32(d
->trans
);
1201 usb_packet_copy(p
, &container
, sizeof(container
));
1203 if (dlen
> p
->iov
.size
- sizeof(container
)) {
1204 dlen
= p
->iov
.size
- sizeof(container
);
1207 if (dlen
> p
->iov
.size
) {
1212 usb_packet_copy(p
, d
->data
+ d
->offset
, dlen
);
1214 if (d
->alloc
< p
->iov
.size
) {
1215 d
->alloc
= p
->iov
.size
;
1216 d
->data
= g_realloc(d
->data
, d
->alloc
);
1218 rc
= read(d
->fd
, d
->data
, dlen
);
1220 memset(d
->data
, 0, dlen
);
1221 s
->result
->code
= RES_INCOMPLETE_TRANSFER
;
1223 usb_packet_copy(p
, d
->data
, dlen
);
1226 if (d
->offset
== d
->length
) {
1227 usb_mtp_data_free(s
->data_in
);
1230 } else if (s
->result
!= NULL
) {
1231 MTPControl
*r
= s
->result
;
1232 int length
= sizeof(container
) + r
->argc
* sizeof(uint32_t);
1233 if (r
->code
== RES_OK
) {
1234 trace_usb_mtp_success(s
->dev
.addr
, r
->trans
,
1235 (r
->argc
> 0) ? r
->argv
[0] : 0,
1236 (r
->argc
> 1) ? r
->argv
[1] : 0);
1238 trace_usb_mtp_error(s
->dev
.addr
, r
->code
, r
->trans
,
1239 (r
->argc
> 0) ? r
->argv
[0] : 0,
1240 (r
->argc
> 1) ? r
->argv
[1] : 0);
1242 container
.length
= cpu_to_le32(length
);
1243 container
.type
= cpu_to_le16(TYPE_RESPONSE
);
1244 container
.code
= cpu_to_le16(r
->code
);
1245 container
.trans
= cpu_to_le32(r
->trans
);
1246 for (i
= 0; i
< r
->argc
; i
++) {
1247 params
[i
] = cpu_to_le32(r
->argv
[i
]);
1249 usb_packet_copy(p
, &container
, sizeof(container
));
1250 usb_packet_copy(p
, ¶ms
, length
- sizeof(container
));
1256 if (p
->iov
.size
< sizeof(container
)) {
1257 trace_usb_mtp_stall(s
->dev
.addr
, "packet too small");
1258 p
->status
= USB_RET_STALL
;
1261 usb_packet_copy(p
, &container
, sizeof(container
));
1262 switch (le16_to_cpu(container
.type
)) {
1264 if (s
->data_in
|| s
->data_out
|| s
->result
) {
1265 trace_usb_mtp_stall(s
->dev
.addr
, "transaction inflight");
1266 p
->status
= USB_RET_STALL
;
1269 cmd
.code
= le16_to_cpu(container
.code
);
1270 cmd
.argc
= (le32_to_cpu(container
.length
) - sizeof(container
))
1272 cmd
.trans
= le32_to_cpu(container
.trans
);
1273 if (cmd
.argc
> ARRAY_SIZE(cmd
.argv
)) {
1274 cmd
.argc
= ARRAY_SIZE(cmd
.argv
);
1276 if (p
->iov
.size
< sizeof(container
) + cmd
.argc
* sizeof(uint32_t)) {
1277 trace_usb_mtp_stall(s
->dev
.addr
, "packet too small");
1278 p
->status
= USB_RET_STALL
;
1281 usb_packet_copy(p
, ¶ms
, cmd
.argc
* sizeof(uint32_t));
1282 for (i
= 0; i
< cmd
.argc
; i
++) {
1283 cmd
.argv
[i
] = le32_to_cpu(params
[i
]);
1285 trace_usb_mtp_command(s
->dev
.addr
, cmd
.code
, cmd
.trans
,
1286 (cmd
.argc
> 0) ? cmd
.argv
[0] : 0,
1287 (cmd
.argc
> 1) ? cmd
.argv
[1] : 0,
1288 (cmd
.argc
> 2) ? cmd
.argv
[2] : 0,
1289 (cmd
.argc
> 3) ? cmd
.argv
[3] : 0,
1290 (cmd
.argc
> 4) ? cmd
.argv
[4] : 0);
1291 usb_mtp_command(s
, &cmd
);
1294 /* not needed as long as the mtp device is read-only */
1295 p
->status
= USB_RET_STALL
;
1300 p
->status
= USB_RET_NAK
;
1303 trace_usb_mtp_stall(s
->dev
.addr
, "invalid endpoint");
1304 p
->status
= USB_RET_STALL
;
1308 if (p
->actual_length
== 0) {
1309 trace_usb_mtp_nak(s
->dev
.addr
, p
->ep
->nr
);
1310 p
->status
= USB_RET_NAK
;
1313 trace_usb_mtp_xfer(s
->dev
.addr
, p
->ep
->nr
, p
->actual_length
,
1319 static void usb_mtp_realize(USBDevice
*dev
, Error
**errp
)
1321 MTPState
*s
= USB_MTP(dev
);
1323 usb_desc_create_serial(dev
);
1325 QTAILQ_INIT(&s
->objects
);
1326 if (s
->desc
== NULL
) {
1327 if (s
->root
== NULL
) {
1328 error_setg(errp
, "usb-mtp: x-root property must be configured");
1331 s
->desc
= strrchr(s
->root
, '/');
1332 if (s
->desc
&& s
->desc
[0]) {
1333 s
->desc
= g_strdup(s
->desc
+ 1);
1335 s
->desc
= g_strdup("none");
1340 static const VMStateDescription vmstate_usb_mtp
= {
1344 .minimum_version_id
= 1,
1345 .fields
= (VMStateField
[]) {
1346 VMSTATE_USB_DEVICE(dev
, MTPState
),
1347 VMSTATE_END_OF_LIST()
1351 static Property mtp_properties
[] = {
1352 DEFINE_PROP_STRING("x-root", MTPState
, root
),
1353 DEFINE_PROP_STRING("desc", MTPState
, desc
),
1354 DEFINE_PROP_END_OF_LIST(),
1357 static void usb_mtp_class_initfn(ObjectClass
*klass
, void *data
)
1359 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1360 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
1362 uc
->realize
= usb_mtp_realize
;
1363 uc
->product_desc
= "QEMU USB MTP";
1364 uc
->usb_desc
= &desc
;
1365 uc
->cancel_packet
= usb_mtp_cancel_packet
;
1366 uc
->handle_attach
= usb_desc_attach
;
1367 uc
->handle_reset
= usb_mtp_handle_reset
;
1368 uc
->handle_control
= usb_mtp_handle_control
;
1369 uc
->handle_data
= usb_mtp_handle_data
;
1370 dc
->fw_name
= "mtp";
1371 dc
->vmsd
= &vmstate_usb_mtp
;
1372 dc
->props
= mtp_properties
;
1375 static TypeInfo mtp_info
= {
1376 .name
= TYPE_USB_MTP
,
1377 .parent
= TYPE_USB_DEVICE
,
1378 .instance_size
= sizeof(MTPState
),
1379 .class_init
= usb_mtp_class_initfn
,
1382 static void usb_mtp_register_types(void)
1384 type_register_static(&mtp_info
);
1387 type_init(usb_mtp_register_types
)