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.
12 #include "qemu/osdep.h"
16 #include <sys/statvfs.h>
18 #include <sys/inotify.h>
19 #include "qemu/main-loop.h"
22 #include "qemu-common.h"
26 #include "hw/usb/desc.h"
28 /* ----------------------------------------------------------------------- */
30 enum mtp_container_type
{
39 CMD_GET_DEVICE_INFO
= 0x1001,
40 CMD_OPEN_SESSION
= 0x1002,
41 CMD_CLOSE_SESSION
= 0x1003,
42 CMD_GET_STORAGE_IDS
= 0x1004,
43 CMD_GET_STORAGE_INFO
= 0x1005,
44 CMD_GET_NUM_OBJECTS
= 0x1006,
45 CMD_GET_OBJECT_HANDLES
= 0x1007,
46 CMD_GET_OBJECT_INFO
= 0x1008,
47 CMD_GET_OBJECT
= 0x1009,
48 CMD_GET_PARTIAL_OBJECT
= 0x101b,
52 RES_GENERAL_ERROR
= 0x2002,
53 RES_SESSION_NOT_OPEN
= 0x2003,
54 RES_INVALID_TRANSACTION_ID
= 0x2004,
55 RES_OPERATION_NOT_SUPPORTED
= 0x2005,
56 RES_PARAMETER_NOT_SUPPORTED
= 0x2006,
57 RES_INCOMPLETE_TRANSFER
= 0x2007,
58 RES_INVALID_STORAGE_ID
= 0x2008,
59 RES_INVALID_OBJECT_HANDLE
= 0x2009,
60 RES_SPEC_BY_FORMAT_UNSUPPORTED
= 0x2014,
61 RES_INVALID_PARENT_OBJECT
= 0x201a,
62 RES_INVALID_PARAMETER
= 0x201d,
63 RES_SESSION_ALREADY_OPEN
= 0x201e,
66 FMT_UNDEFINED_OBJECT
= 0x3000,
67 FMT_ASSOCIATION
= 0x3001,
70 EVT_OBJ_ADDED
= 0x4002,
71 EVT_OBJ_REMOVED
= 0x4003,
72 EVT_OBJ_INFO_CHANGED
= 0x4007,
80 } QEMU_PACKED mtp_container
;
82 /* ----------------------------------------------------------------------- */
84 typedef struct MTPState MTPState
;
85 typedef struct MTPControl MTPControl
;
86 typedef struct MTPData MTPData
;
87 typedef struct MTPObject MTPObject
;
96 typedef struct MTPMonEntry MTPMonEntry
;
102 QTAILQ_ENTRY(MTPMonEntry
) next
;
131 /* inotify watch cookie */
136 QLIST_HEAD(, MTPObject
) children
;
137 QLIST_ENTRY(MTPObject
) list
;
139 QTAILQ_ENTRY(MTPObject
) next
;
152 uint32_t next_handle
;
154 QTAILQ_HEAD(, MTPObject
) objects
;
156 /* inotify descriptor */
158 QTAILQ_HEAD(events
, MTPMonEntry
) events
;
162 #define TYPE_USB_MTP "usb-mtp"
163 #define USB_MTP(obj) OBJECT_CHECK(MTPState, (obj), TYPE_USB_MTP)
165 #define QEMU_STORAGE_ID 0x00010001
167 #define MTP_FLAG_WRITABLE 0
169 #define FLAG_SET(_mtp, _flag) ((_mtp)->flags & (1 << (_flag)))
171 /* ----------------------------------------------------------------------- */
173 #define MTP_MANUFACTURER "QEMU"
174 #define MTP_PRODUCT "QEMU filesharing"
177 STR_MANUFACTURER
= 1,
186 static const USBDescStrings desc_strings
= {
187 [STR_MANUFACTURER
] = MTP_MANUFACTURER
,
188 [STR_PRODUCT
] = MTP_PRODUCT
,
189 [STR_SERIALNUMBER
] = "34617",
191 [STR_CONFIG_FULL
] = "Full speed config (usb 1.1)",
192 [STR_CONFIG_HIGH
] = "High speed config (usb 2.0)",
193 [STR_CONFIG_SUPER
] = "Super speed config (usb 3.0)",
196 static const USBDescIface desc_iface_full
= {
197 .bInterfaceNumber
= 0,
199 .bInterfaceClass
= USB_CLASS_STILL_IMAGE
,
200 .bInterfaceSubClass
= 0x01,
201 .bInterfaceProtocol
= 0x01,
202 .iInterface
= STR_MTP
,
203 .eps
= (USBDescEndpoint
[]) {
205 .bEndpointAddress
= USB_DIR_IN
| EP_DATA_IN
,
206 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
207 .wMaxPacketSize
= 64,
209 .bEndpointAddress
= USB_DIR_OUT
| EP_DATA_OUT
,
210 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
211 .wMaxPacketSize
= 64,
213 .bEndpointAddress
= USB_DIR_IN
| EP_EVENT
,
214 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
215 .wMaxPacketSize
= 64,
221 static const USBDescDevice desc_device_full
= {
223 .bMaxPacketSize0
= 8,
224 .bNumConfigurations
= 1,
225 .confs
= (USBDescConfig
[]) {
228 .bConfigurationValue
= 1,
229 .iConfiguration
= STR_CONFIG_FULL
,
230 .bmAttributes
= USB_CFG_ATT_ONE
| USB_CFG_ATT_WAKEUP
,
233 .ifs
= &desc_iface_full
,
238 static const USBDescIface desc_iface_high
= {
239 .bInterfaceNumber
= 0,
241 .bInterfaceClass
= USB_CLASS_STILL_IMAGE
,
242 .bInterfaceSubClass
= 0x01,
243 .bInterfaceProtocol
= 0x01,
244 .iInterface
= STR_MTP
,
245 .eps
= (USBDescEndpoint
[]) {
247 .bEndpointAddress
= USB_DIR_IN
| EP_DATA_IN
,
248 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
249 .wMaxPacketSize
= 512,
251 .bEndpointAddress
= USB_DIR_OUT
| EP_DATA_OUT
,
252 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
253 .wMaxPacketSize
= 512,
255 .bEndpointAddress
= USB_DIR_IN
| EP_EVENT
,
256 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
257 .wMaxPacketSize
= 64,
263 static const USBDescDevice desc_device_high
= {
265 .bMaxPacketSize0
= 64,
266 .bNumConfigurations
= 1,
267 .confs
= (USBDescConfig
[]) {
270 .bConfigurationValue
= 1,
271 .iConfiguration
= STR_CONFIG_HIGH
,
272 .bmAttributes
= USB_CFG_ATT_ONE
| USB_CFG_ATT_WAKEUP
,
275 .ifs
= &desc_iface_high
,
280 static const USBDescMSOS desc_msos
= {
281 .CompatibleID
= "MTP",
282 .SelectiveSuspendEnabled
= true,
285 static const USBDesc desc
= {
287 .idVendor
= 0x46f4, /* CRC16() of "QEMU" */
290 .iManufacturer
= STR_MANUFACTURER
,
291 .iProduct
= STR_PRODUCT
,
292 .iSerialNumber
= STR_SERIALNUMBER
,
294 .full
= &desc_device_full
,
295 .high
= &desc_device_high
,
300 /* ----------------------------------------------------------------------- */
302 static MTPObject
*usb_mtp_object_alloc(MTPState
*s
, uint32_t handle
,
303 MTPObject
*parent
, char *name
)
305 MTPObject
*o
= g_new0(MTPObject
, 1);
307 if (name
[0] == '.') {
313 o
->name
= g_strdup(name
);
314 if (parent
== NULL
) {
315 o
->path
= g_strdup(name
);
317 o
->path
= g_strdup_printf("%s/%s", parent
->path
, name
);
320 if (lstat(o
->path
, &o
->stat
) != 0) {
323 if (S_ISREG(o
->stat
.st_mode
)) {
324 o
->format
= FMT_UNDEFINED_OBJECT
;
325 } else if (S_ISDIR(o
->stat
.st_mode
)) {
326 o
->format
= FMT_ASSOCIATION
;
331 if (access(o
->path
, R_OK
) != 0) {
335 trace_usb_mtp_object_alloc(s
->dev
.addr
, o
->handle
, o
->path
);
337 QTAILQ_INSERT_TAIL(&s
->objects
, o
, next
);
347 static void usb_mtp_object_free(MTPState
*s
, MTPObject
*o
)
355 trace_usb_mtp_object_free(s
->dev
.addr
, o
->handle
, o
->path
);
357 QTAILQ_REMOVE(&s
->objects
, o
, next
);
359 QLIST_REMOVE(o
, list
);
360 o
->parent
->nchildren
--;
363 while (!QLIST_EMPTY(&o
->children
)) {
364 iter
= QLIST_FIRST(&o
->children
);
365 usb_mtp_object_free(s
, iter
);
372 static MTPObject
*usb_mtp_object_lookup(MTPState
*s
, uint32_t handle
)
376 QTAILQ_FOREACH(o
, &s
->objects
, next
) {
377 if (o
->handle
== handle
) {
384 static MTPObject
*usb_mtp_add_child(MTPState
*s
, MTPObject
*o
,
388 usb_mtp_object_alloc(s
, s
->next_handle
++, o
, name
);
391 trace_usb_mtp_add_child(s
->dev
.addr
, child
->handle
, child
->path
);
392 QLIST_INSERT_HEAD(&o
->children
, child
, list
);
395 if (child
->format
== FMT_ASSOCIATION
) {
396 QLIST_INIT(&child
->children
);
404 static MTPObject
*usb_mtp_object_lookup_name(MTPObject
*parent
,
409 QLIST_FOREACH(iter
, &parent
->children
, list
) {
410 if (strncmp(iter
->name
, name
, len
) == 0) {
418 static MTPObject
*usb_mtp_object_lookup_wd(MTPState
*s
, int wd
)
422 QTAILQ_FOREACH(iter
, &s
->objects
, next
) {
423 if (iter
->watchfd
== wd
) {
431 static void inotify_watchfn(void *arg
)
435 /* From the man page: atleast one event can be read */
437 char buf
[sizeof(struct inotify_event
) + NAME_MAX
+ 1];
440 bytes
= read(s
->inotifyfd
, buf
, sizeof(buf
));
444 /* Better luck next time */
449 * TODO: Ignore initiator initiated events.
450 * For now we are good because the store is RO
454 struct inotify_event
*event
= (struct inotify_event
*)p
;
456 uint32_t mask
= event
->mask
& (IN_CREATE
| IN_DELETE
|
457 IN_MODIFY
| IN_IGNORED
);
458 MTPObject
*parent
= usb_mtp_object_lookup_wd(s
, event
->wd
);
459 MTPMonEntry
*entry
= NULL
;
462 pos
= pos
+ sizeof(struct inotify_event
) + event
->len
;
471 if (usb_mtp_object_lookup_name
472 (parent
, event
->name
, event
->len
)) {
473 /* Duplicate create event */
476 entry
= g_new0(MTPMonEntry
, 1);
477 entry
->handle
= s
->next_handle
;
478 entry
->event
= EVT_OBJ_ADDED
;
479 o
= usb_mtp_add_child(s
, parent
, event
->name
);
484 o
->watchfd
= watchfd
;
485 trace_usb_mtp_inotify_event(s
->dev
.addr
, event
->name
,
486 event
->mask
, "Obj Added");
491 * The kernel issues a IN_IGNORED event
492 * when a dir containing a watchpoint is
493 * deleted, so we don't have to delete the
496 o
= usb_mtp_object_lookup_name(parent
, event
->name
, event
->len
);
500 entry
= g_new0(MTPMonEntry
, 1);
501 entry
->handle
= o
->handle
;
502 entry
->event
= EVT_OBJ_REMOVED
;
503 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
504 event
->mask
, "Obj Deleted");
505 usb_mtp_object_free(s
, o
);
509 o
= usb_mtp_object_lookup_name(parent
, event
->name
, event
->len
);
513 entry
= g_new0(MTPMonEntry
, 1);
514 entry
->handle
= o
->handle
;
515 entry
->event
= EVT_OBJ_INFO_CHANGED
;
516 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
517 event
->mask
, "Obj Modified");
521 o
= usb_mtp_object_lookup_name(parent
, event
->name
, event
->len
);
522 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
523 event
->mask
, "Obj ignored");
527 fprintf(stderr
, "usb-mtp: failed to parse inotify event\n");
532 QTAILQ_INSERT_HEAD(&s
->events
, entry
, next
);
538 static int usb_mtp_inotify_init(MTPState
*s
)
542 fd
= inotify_init1(IN_NONBLOCK
);
547 QTAILQ_INIT(&s
->events
);
550 qemu_set_fd_handler(fd
, inotify_watchfn
, NULL
, s
);
555 static void usb_mtp_inotify_cleanup(MTPState
*s
)
563 qemu_set_fd_handler(s
->inotifyfd
, NULL
, NULL
, s
);
566 QTAILQ_FOREACH_SAFE(e
, &s
->events
, next
, p
) {
567 QTAILQ_REMOVE(&s
->events
, e
, next
);
572 static int usb_mtp_add_watch(int inotifyfd
, char *path
)
574 uint32_t mask
= IN_CREATE
| IN_DELETE
| IN_MODIFY
|
577 return inotify_add_watch(inotifyfd
, path
, mask
);
581 static void usb_mtp_object_readdir(MTPState
*s
, MTPObject
*o
)
583 struct dirent
*entry
;
586 if (o
->have_children
) {
589 o
->have_children
= true;
591 dir
= opendir(o
->path
);
596 int watchfd
= usb_mtp_add_watch(s
->inotifyfd
, o
->path
);
598 fprintf(stderr
, "usb-mtp: failed to add watch for %s\n", o
->path
);
600 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
602 o
->watchfd
= watchfd
;
605 while ((entry
= readdir(dir
)) != NULL
) {
606 usb_mtp_add_child(s
, o
, entry
->d_name
);
611 /* ----------------------------------------------------------------------- */
613 static MTPData
*usb_mtp_data_alloc(MTPControl
*c
)
615 MTPData
*data
= g_new0(MTPData
, 1);
617 data
->code
= c
->code
;
618 data
->trans
= c
->trans
;
624 static void usb_mtp_data_free(MTPData
*data
)
629 if (data
->fd
!= -1) {
636 static void usb_mtp_realloc(MTPData
*data
, uint32_t bytes
)
638 if (data
->length
+ bytes
<= data
->alloc
) {
641 data
->alloc
= (data
->length
+ bytes
+ 0xff) & ~0xff;
642 data
->data
= g_realloc(data
->data
, data
->alloc
);
645 static void usb_mtp_add_u8(MTPData
*data
, uint8_t val
)
647 usb_mtp_realloc(data
, 1);
648 data
->data
[data
->length
++] = val
;
651 static void usb_mtp_add_u16(MTPData
*data
, uint16_t val
)
653 usb_mtp_realloc(data
, 2);
654 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
655 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
658 static void usb_mtp_add_u32(MTPData
*data
, uint32_t val
)
660 usb_mtp_realloc(data
, 4);
661 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
662 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
663 data
->data
[data
->length
++] = (val
>> 16) & 0xff;
664 data
->data
[data
->length
++] = (val
>> 24) & 0xff;
667 static void usb_mtp_add_u64(MTPData
*data
, uint64_t val
)
669 usb_mtp_realloc(data
, 8);
670 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
671 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
672 data
->data
[data
->length
++] = (val
>> 16) & 0xff;
673 data
->data
[data
->length
++] = (val
>> 24) & 0xff;
674 data
->data
[data
->length
++] = (val
>> 32) & 0xff;
675 data
->data
[data
->length
++] = (val
>> 40) & 0xff;
676 data
->data
[data
->length
++] = (val
>> 48) & 0xff;
677 data
->data
[data
->length
++] = (val
>> 56) & 0xff;
680 static void usb_mtp_add_u16_array(MTPData
*data
, uint32_t len
,
681 const uint16_t *vals
)
685 usb_mtp_add_u32(data
, len
);
686 for (i
= 0; i
< len
; i
++) {
687 usb_mtp_add_u16(data
, vals
[i
]);
691 static void usb_mtp_add_u32_array(MTPData
*data
, uint32_t len
,
692 const uint32_t *vals
)
696 usb_mtp_add_u32(data
, len
);
697 for (i
= 0; i
< len
; i
++) {
698 usb_mtp_add_u32(data
, vals
[i
]);
702 static void usb_mtp_add_wstr(MTPData
*data
, const wchar_t *str
)
704 uint32_t len
= wcslen(str
);
708 len
++; /* include terminating L'\0' */
711 usb_mtp_add_u8(data
, len
);
712 for (i
= 0; i
< len
; i
++) {
713 usb_mtp_add_u16(data
, str
[i
]);
717 static void usb_mtp_add_str(MTPData
*data
, const char *str
)
719 uint32_t len
= strlen(str
)+1;
720 wchar_t *wstr
= g_new(wchar_t, len
);
723 ret
= mbstowcs(wstr
, str
, len
);
725 usb_mtp_add_wstr(data
, L
"Oops");
727 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
;
1301 if (!QTAILQ_EMPTY(&s
->events
)) {
1302 struct MTPMonEntry
*e
= QTAILQ_LAST(&s
->events
, events
);
1304 int len
= sizeof(container
) + sizeof(uint32_t);
1306 if (p
->iov
.size
< len
) {
1307 trace_usb_mtp_stall(s
->dev
.addr
,
1308 "packet too small to send event");
1309 p
->status
= USB_RET_STALL
;
1313 QTAILQ_REMOVE(&s
->events
, e
, next
);
1314 container
.length
= cpu_to_le32(len
);
1315 container
.type
= cpu_to_le32(TYPE_EVENT
);
1316 container
.code
= cpu_to_le16(e
->event
);
1317 container
.trans
= 0; /* no trans specific events */
1318 handle
= cpu_to_le32(e
->handle
);
1319 usb_packet_copy(p
, &container
, sizeof(container
));
1320 usb_packet_copy(p
, &handle
, sizeof(uint32_t));
1325 p
->status
= USB_RET_NAK
;
1328 trace_usb_mtp_stall(s
->dev
.addr
, "invalid endpoint");
1329 p
->status
= USB_RET_STALL
;
1333 if (p
->actual_length
== 0) {
1334 trace_usb_mtp_nak(s
->dev
.addr
, p
->ep
->nr
);
1335 p
->status
= USB_RET_NAK
;
1338 trace_usb_mtp_xfer(s
->dev
.addr
, p
->ep
->nr
, p
->actual_length
,
1344 static void usb_mtp_realize(USBDevice
*dev
, Error
**errp
)
1346 MTPState
*s
= USB_MTP(dev
);
1348 usb_desc_create_serial(dev
);
1350 QTAILQ_INIT(&s
->objects
);
1351 if (s
->desc
== NULL
) {
1352 if (s
->root
== NULL
) {
1353 error_setg(errp
, "usb-mtp: x-root property must be configured");
1356 s
->desc
= strrchr(s
->root
, '/');
1357 if (s
->desc
&& s
->desc
[0]) {
1358 s
->desc
= g_strdup(s
->desc
+ 1);
1360 s
->desc
= g_strdup("none");
1365 static const VMStateDescription vmstate_usb_mtp
= {
1369 .minimum_version_id
= 1,
1370 .fields
= (VMStateField
[]) {
1371 VMSTATE_USB_DEVICE(dev
, MTPState
),
1372 VMSTATE_END_OF_LIST()
1376 static Property mtp_properties
[] = {
1377 DEFINE_PROP_STRING("x-root", MTPState
, root
),
1378 DEFINE_PROP_STRING("desc", MTPState
, desc
),
1379 DEFINE_PROP_END_OF_LIST(),
1382 static void usb_mtp_class_initfn(ObjectClass
*klass
, void *data
)
1384 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1385 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
1387 uc
->realize
= usb_mtp_realize
;
1388 uc
->product_desc
= "QEMU USB MTP";
1389 uc
->usb_desc
= &desc
;
1390 uc
->cancel_packet
= usb_mtp_cancel_packet
;
1391 uc
->handle_attach
= usb_desc_attach
;
1392 uc
->handle_reset
= usb_mtp_handle_reset
;
1393 uc
->handle_control
= usb_mtp_handle_control
;
1394 uc
->handle_data
= usb_mtp_handle_data
;
1395 dc
->fw_name
= "mtp";
1396 dc
->vmsd
= &vmstate_usb_mtp
;
1397 dc
->props
= mtp_properties
;
1400 static TypeInfo mtp_info
= {
1401 .name
= TYPE_USB_MTP
,
1402 .parent
= TYPE_USB_DEVICE
,
1403 .instance_size
= sizeof(MTPState
),
1404 .class_init
= usb_mtp_class_initfn
,
1407 static void usb_mtp_register_types(void)
1409 type_register_static(&mtp_info
);
1412 type_init(usb_mtp_register_types
)