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"
13 #include "qapi/error.h"
17 #include <sys/statvfs.h>
19 #include <sys/inotify.h>
20 #include "qapi/error.h"
21 #include "qemu/main-loop.h"
24 #include "qemu-common.h"
28 #include "hw/usb/desc.h"
30 /* ----------------------------------------------------------------------- */
32 enum mtp_container_type
{
41 CMD_GET_DEVICE_INFO
= 0x1001,
42 CMD_OPEN_SESSION
= 0x1002,
43 CMD_CLOSE_SESSION
= 0x1003,
44 CMD_GET_STORAGE_IDS
= 0x1004,
45 CMD_GET_STORAGE_INFO
= 0x1005,
46 CMD_GET_NUM_OBJECTS
= 0x1006,
47 CMD_GET_OBJECT_HANDLES
= 0x1007,
48 CMD_GET_OBJECT_INFO
= 0x1008,
49 CMD_GET_OBJECT
= 0x1009,
50 CMD_GET_PARTIAL_OBJECT
= 0x101b,
54 RES_GENERAL_ERROR
= 0x2002,
55 RES_SESSION_NOT_OPEN
= 0x2003,
56 RES_INVALID_TRANSACTION_ID
= 0x2004,
57 RES_OPERATION_NOT_SUPPORTED
= 0x2005,
58 RES_PARAMETER_NOT_SUPPORTED
= 0x2006,
59 RES_INCOMPLETE_TRANSFER
= 0x2007,
60 RES_INVALID_STORAGE_ID
= 0x2008,
61 RES_INVALID_OBJECT_HANDLE
= 0x2009,
62 RES_SPEC_BY_FORMAT_UNSUPPORTED
= 0x2014,
63 RES_INVALID_PARENT_OBJECT
= 0x201a,
64 RES_INVALID_PARAMETER
= 0x201d,
65 RES_SESSION_ALREADY_OPEN
= 0x201e,
68 FMT_UNDEFINED_OBJECT
= 0x3000,
69 FMT_ASSOCIATION
= 0x3001,
72 EVT_OBJ_ADDED
= 0x4002,
73 EVT_OBJ_REMOVED
= 0x4003,
74 EVT_OBJ_INFO_CHANGED
= 0x4007,
82 } QEMU_PACKED mtp_container
;
84 /* ----------------------------------------------------------------------- */
86 typedef struct MTPState MTPState
;
87 typedef struct MTPControl MTPControl
;
88 typedef struct MTPData MTPData
;
89 typedef struct MTPObject MTPObject
;
98 typedef struct MTPMonEntry MTPMonEntry
;
104 QTAILQ_ENTRY(MTPMonEntry
) next
;
133 /* inotify watch cookie */
138 QLIST_HEAD(, MTPObject
) children
;
139 QLIST_ENTRY(MTPObject
) list
;
141 QTAILQ_ENTRY(MTPObject
) next
;
154 uint32_t next_handle
;
156 QTAILQ_HEAD(, MTPObject
) objects
;
158 /* inotify descriptor */
160 QTAILQ_HEAD(events
, MTPMonEntry
) events
;
164 #define TYPE_USB_MTP "usb-mtp"
165 #define USB_MTP(obj) OBJECT_CHECK(MTPState, (obj), TYPE_USB_MTP)
167 #define QEMU_STORAGE_ID 0x00010001
169 #define MTP_FLAG_WRITABLE 0
171 #define FLAG_SET(_mtp, _flag) ((_mtp)->flags & (1 << (_flag)))
173 /* ----------------------------------------------------------------------- */
175 #define MTP_MANUFACTURER "QEMU"
176 #define MTP_PRODUCT "QEMU filesharing"
179 STR_MANUFACTURER
= 1,
188 static const USBDescStrings desc_strings
= {
189 [STR_MANUFACTURER
] = MTP_MANUFACTURER
,
190 [STR_PRODUCT
] = MTP_PRODUCT
,
191 [STR_SERIALNUMBER
] = "34617",
193 [STR_CONFIG_FULL
] = "Full speed config (usb 1.1)",
194 [STR_CONFIG_HIGH
] = "High speed config (usb 2.0)",
195 [STR_CONFIG_SUPER
] = "Super speed config (usb 3.0)",
198 static const USBDescIface desc_iface_full
= {
199 .bInterfaceNumber
= 0,
201 .bInterfaceClass
= USB_CLASS_STILL_IMAGE
,
202 .bInterfaceSubClass
= 0x01,
203 .bInterfaceProtocol
= 0x01,
204 .iInterface
= STR_MTP
,
205 .eps
= (USBDescEndpoint
[]) {
207 .bEndpointAddress
= USB_DIR_IN
| EP_DATA_IN
,
208 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
209 .wMaxPacketSize
= 64,
211 .bEndpointAddress
= USB_DIR_OUT
| EP_DATA_OUT
,
212 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
213 .wMaxPacketSize
= 64,
215 .bEndpointAddress
= USB_DIR_IN
| EP_EVENT
,
216 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
217 .wMaxPacketSize
= 64,
223 static const USBDescDevice desc_device_full
= {
225 .bMaxPacketSize0
= 8,
226 .bNumConfigurations
= 1,
227 .confs
= (USBDescConfig
[]) {
230 .bConfigurationValue
= 1,
231 .iConfiguration
= STR_CONFIG_FULL
,
232 .bmAttributes
= USB_CFG_ATT_ONE
| USB_CFG_ATT_WAKEUP
,
235 .ifs
= &desc_iface_full
,
240 static const USBDescIface desc_iface_high
= {
241 .bInterfaceNumber
= 0,
243 .bInterfaceClass
= USB_CLASS_STILL_IMAGE
,
244 .bInterfaceSubClass
= 0x01,
245 .bInterfaceProtocol
= 0x01,
246 .iInterface
= STR_MTP
,
247 .eps
= (USBDescEndpoint
[]) {
249 .bEndpointAddress
= USB_DIR_IN
| EP_DATA_IN
,
250 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
251 .wMaxPacketSize
= 512,
253 .bEndpointAddress
= USB_DIR_OUT
| EP_DATA_OUT
,
254 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
255 .wMaxPacketSize
= 512,
257 .bEndpointAddress
= USB_DIR_IN
| EP_EVENT
,
258 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
259 .wMaxPacketSize
= 64,
265 static const USBDescDevice desc_device_high
= {
267 .bMaxPacketSize0
= 64,
268 .bNumConfigurations
= 1,
269 .confs
= (USBDescConfig
[]) {
272 .bConfigurationValue
= 1,
273 .iConfiguration
= STR_CONFIG_HIGH
,
274 .bmAttributes
= USB_CFG_ATT_ONE
| USB_CFG_ATT_WAKEUP
,
277 .ifs
= &desc_iface_high
,
282 static const USBDescMSOS desc_msos
= {
283 .CompatibleID
= "MTP",
284 .SelectiveSuspendEnabled
= true,
287 static const USBDesc desc
= {
289 .idVendor
= 0x46f4, /* CRC16() of "QEMU" */
292 .iManufacturer
= STR_MANUFACTURER
,
293 .iProduct
= STR_PRODUCT
,
294 .iSerialNumber
= STR_SERIALNUMBER
,
296 .full
= &desc_device_full
,
297 .high
= &desc_device_high
,
302 /* ----------------------------------------------------------------------- */
304 static MTPObject
*usb_mtp_object_alloc(MTPState
*s
, uint32_t handle
,
305 MTPObject
*parent
, char *name
)
307 MTPObject
*o
= g_new0(MTPObject
, 1);
309 if (name
[0] == '.') {
315 o
->name
= g_strdup(name
);
316 if (parent
== NULL
) {
317 o
->path
= g_strdup(name
);
319 o
->path
= g_strdup_printf("%s/%s", parent
->path
, name
);
322 if (lstat(o
->path
, &o
->stat
) != 0) {
325 if (S_ISREG(o
->stat
.st_mode
)) {
326 o
->format
= FMT_UNDEFINED_OBJECT
;
327 } else if (S_ISDIR(o
->stat
.st_mode
)) {
328 o
->format
= FMT_ASSOCIATION
;
333 if (access(o
->path
, R_OK
) != 0) {
337 trace_usb_mtp_object_alloc(s
->dev
.addr
, o
->handle
, o
->path
);
339 QTAILQ_INSERT_TAIL(&s
->objects
, o
, next
);
349 static void usb_mtp_object_free(MTPState
*s
, MTPObject
*o
)
357 trace_usb_mtp_object_free(s
->dev
.addr
, o
->handle
, o
->path
);
359 QTAILQ_REMOVE(&s
->objects
, o
, next
);
361 QLIST_REMOVE(o
, list
);
362 o
->parent
->nchildren
--;
365 while (!QLIST_EMPTY(&o
->children
)) {
366 iter
= QLIST_FIRST(&o
->children
);
367 usb_mtp_object_free(s
, iter
);
374 static MTPObject
*usb_mtp_object_lookup(MTPState
*s
, uint32_t handle
)
378 QTAILQ_FOREACH(o
, &s
->objects
, next
) {
379 if (o
->handle
== handle
) {
386 static MTPObject
*usb_mtp_add_child(MTPState
*s
, MTPObject
*o
,
390 usb_mtp_object_alloc(s
, s
->next_handle
++, o
, name
);
393 trace_usb_mtp_add_child(s
->dev
.addr
, child
->handle
, child
->path
);
394 QLIST_INSERT_HEAD(&o
->children
, child
, list
);
397 if (child
->format
== FMT_ASSOCIATION
) {
398 QLIST_INIT(&child
->children
);
406 static MTPObject
*usb_mtp_object_lookup_name(MTPObject
*parent
,
411 QLIST_FOREACH(iter
, &parent
->children
, list
) {
412 if (strncmp(iter
->name
, name
, len
) == 0) {
420 static MTPObject
*usb_mtp_object_lookup_wd(MTPState
*s
, int wd
)
424 QTAILQ_FOREACH(iter
, &s
->objects
, next
) {
425 if (iter
->watchfd
== wd
) {
433 static void inotify_watchfn(void *arg
)
437 /* From the man page: atleast one event can be read */
438 int len
= sizeof(struct inotify_event
) + NAME_MAX
+ 1;
443 bytes
= read(s
->inotifyfd
, buf
, len
);
447 /* Better luck next time */
452 * TODO: Ignore initiator initiated events.
453 * For now we are good because the store is RO
457 struct inotify_event
*event
= (struct inotify_event
*)p
;
459 uint32_t mask
= event
->mask
& (IN_CREATE
| IN_DELETE
|
460 IN_MODIFY
| IN_IGNORED
);
461 MTPObject
*parent
= usb_mtp_object_lookup_wd(s
, event
->wd
);
462 MTPMonEntry
*entry
= NULL
;
465 pos
= pos
+ sizeof(struct inotify_event
) + event
->len
;
474 if (usb_mtp_object_lookup_name
475 (parent
, event
->name
, event
->len
)) {
476 /* Duplicate create event */
479 entry
= g_new0(MTPMonEntry
, 1);
480 entry
->handle
= s
->next_handle
;
481 entry
->event
= EVT_OBJ_ADDED
;
482 o
= usb_mtp_add_child(s
, parent
, event
->name
);
487 o
->watchfd
= watchfd
;
488 trace_usb_mtp_inotify_event(s
->dev
.addr
, event
->name
,
489 event
->mask
, "Obj Added");
494 * The kernel issues a IN_IGNORED event
495 * when a dir containing a watchpoint is
496 * deleted, so we don't have to delete the
499 o
= usb_mtp_object_lookup_name(parent
, event
->name
, event
->len
);
503 entry
= g_new0(MTPMonEntry
, 1);
504 entry
->handle
= o
->handle
;
505 entry
->event
= EVT_OBJ_REMOVED
;
506 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
507 event
->mask
, "Obj Deleted");
508 usb_mtp_object_free(s
, o
);
512 o
= usb_mtp_object_lookup_name(parent
, event
->name
, event
->len
);
516 entry
= g_new0(MTPMonEntry
, 1);
517 entry
->handle
= o
->handle
;
518 entry
->event
= EVT_OBJ_INFO_CHANGED
;
519 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
520 event
->mask
, "Obj Modified");
524 o
= usb_mtp_object_lookup_name(parent
, event
->name
, event
->len
);
525 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
526 event
->mask
, "Obj ignored");
530 fprintf(stderr
, "usb-mtp: failed to parse inotify event\n");
535 QTAILQ_INSERT_HEAD(&s
->events
, entry
, next
);
541 static int usb_mtp_inotify_init(MTPState
*s
)
545 fd
= inotify_init1(IN_NONBLOCK
);
550 QTAILQ_INIT(&s
->events
);
553 qemu_set_fd_handler(fd
, inotify_watchfn
, NULL
, s
);
558 static void usb_mtp_inotify_cleanup(MTPState
*s
)
566 qemu_set_fd_handler(s
->inotifyfd
, NULL
, NULL
, s
);
569 QTAILQ_FOREACH_SAFE(e
, &s
->events
, next
, p
) {
570 QTAILQ_REMOVE(&s
->events
, e
, next
);
575 static int usb_mtp_add_watch(int inotifyfd
, char *path
)
577 uint32_t mask
= IN_CREATE
| IN_DELETE
| IN_MODIFY
|
580 return inotify_add_watch(inotifyfd
, path
, mask
);
584 static void usb_mtp_object_readdir(MTPState
*s
, MTPObject
*o
)
586 struct dirent
*entry
;
589 if (o
->have_children
) {
592 o
->have_children
= true;
594 dir
= opendir(o
->path
);
599 int watchfd
= usb_mtp_add_watch(s
->inotifyfd
, o
->path
);
601 fprintf(stderr
, "usb-mtp: failed to add watch for %s\n", o
->path
);
603 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
605 o
->watchfd
= watchfd
;
608 while ((entry
= readdir(dir
)) != NULL
) {
609 usb_mtp_add_child(s
, o
, entry
->d_name
);
614 /* ----------------------------------------------------------------------- */
616 static MTPData
*usb_mtp_data_alloc(MTPControl
*c
)
618 MTPData
*data
= g_new0(MTPData
, 1);
620 data
->code
= c
->code
;
621 data
->trans
= c
->trans
;
627 static void usb_mtp_data_free(MTPData
*data
)
632 if (data
->fd
!= -1) {
639 static void usb_mtp_realloc(MTPData
*data
, uint32_t bytes
)
641 if (data
->length
+ bytes
<= data
->alloc
) {
644 data
->alloc
= (data
->length
+ bytes
+ 0xff) & ~0xff;
645 data
->data
= g_realloc(data
->data
, data
->alloc
);
648 static void usb_mtp_add_u8(MTPData
*data
, uint8_t val
)
650 usb_mtp_realloc(data
, 1);
651 data
->data
[data
->length
++] = val
;
654 static void usb_mtp_add_u16(MTPData
*data
, uint16_t val
)
656 usb_mtp_realloc(data
, 2);
657 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
658 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
661 static void usb_mtp_add_u32(MTPData
*data
, uint32_t val
)
663 usb_mtp_realloc(data
, 4);
664 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
665 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
666 data
->data
[data
->length
++] = (val
>> 16) & 0xff;
667 data
->data
[data
->length
++] = (val
>> 24) & 0xff;
670 static void usb_mtp_add_u64(MTPData
*data
, uint64_t val
)
672 usb_mtp_realloc(data
, 8);
673 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
674 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
675 data
->data
[data
->length
++] = (val
>> 16) & 0xff;
676 data
->data
[data
->length
++] = (val
>> 24) & 0xff;
677 data
->data
[data
->length
++] = (val
>> 32) & 0xff;
678 data
->data
[data
->length
++] = (val
>> 40) & 0xff;
679 data
->data
[data
->length
++] = (val
>> 48) & 0xff;
680 data
->data
[data
->length
++] = (val
>> 56) & 0xff;
683 static void usb_mtp_add_u16_array(MTPData
*data
, uint32_t len
,
684 const uint16_t *vals
)
688 usb_mtp_add_u32(data
, len
);
689 for (i
= 0; i
< len
; i
++) {
690 usb_mtp_add_u16(data
, vals
[i
]);
694 static void usb_mtp_add_u32_array(MTPData
*data
, uint32_t len
,
695 const uint32_t *vals
)
699 usb_mtp_add_u32(data
, len
);
700 for (i
= 0; i
< len
; i
++) {
701 usb_mtp_add_u32(data
, vals
[i
]);
705 static void usb_mtp_add_wstr(MTPData
*data
, const wchar_t *str
)
707 uint32_t len
= wcslen(str
);
711 len
++; /* include terminating L'\0' */
714 usb_mtp_add_u8(data
, len
);
715 for (i
= 0; i
< len
; i
++) {
716 usb_mtp_add_u16(data
, str
[i
]);
720 static void usb_mtp_add_str(MTPData
*data
, const char *str
)
722 uint32_t len
= strlen(str
)+1;
726 ret
= mbstowcs(wstr
, str
, len
);
728 usb_mtp_add_wstr(data
, L
"Oops");
730 usb_mtp_add_wstr(data
, wstr
);
734 static void usb_mtp_add_time(MTPData
*data
, time_t time
)
739 gmtime_r(&time
, &tm
);
740 strftime(buf
, sizeof(buf
), "%Y%m%dT%H%M%S", &tm
);
741 usb_mtp_add_str(data
, buf
);
744 /* ----------------------------------------------------------------------- */
746 static void usb_mtp_queue_result(MTPState
*s
, uint16_t code
, uint32_t trans
,
747 int argc
, uint32_t arg0
, uint32_t arg1
)
749 MTPControl
*c
= g_new0(MTPControl
, 1);
761 assert(s
->result
== NULL
);
765 /* ----------------------------------------------------------------------- */
767 static MTPData
*usb_mtp_get_device_info(MTPState
*s
, MTPControl
*c
)
769 static const uint16_t ops
[] = {
774 CMD_GET_STORAGE_INFO
,
776 CMD_GET_OBJECT_HANDLES
,
779 CMD_GET_PARTIAL_OBJECT
,
781 static const uint16_t fmt
[] = {
782 FMT_UNDEFINED_OBJECT
,
785 MTPData
*d
= usb_mtp_data_alloc(c
);
787 trace_usb_mtp_op_get_device_info(s
->dev
.addr
);
789 usb_mtp_add_u16(d
, 100);
790 usb_mtp_add_u32(d
, 0xffffffff);
791 usb_mtp_add_u16(d
, 0x0101);
792 usb_mtp_add_wstr(d
, L
"");
793 usb_mtp_add_u16(d
, 0x0000);
795 usb_mtp_add_u16_array(d
, ARRAY_SIZE(ops
), ops
);
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
, 0, NULL
);
799 usb_mtp_add_u16_array(d
, ARRAY_SIZE(fmt
), fmt
);
801 usb_mtp_add_wstr(d
, L
"" MTP_MANUFACTURER
);
802 usb_mtp_add_wstr(d
, L
"" MTP_PRODUCT
);
803 usb_mtp_add_wstr(d
, L
"0.1");
804 usb_mtp_add_wstr(d
, L
"0123456789abcdef0123456789abcdef");
809 static MTPData
*usb_mtp_get_storage_ids(MTPState
*s
, MTPControl
*c
)
811 static const uint32_t ids
[] = {
814 MTPData
*d
= usb_mtp_data_alloc(c
);
816 trace_usb_mtp_op_get_storage_ids(s
->dev
.addr
);
818 usb_mtp_add_u32_array(d
, ARRAY_SIZE(ids
), ids
);
823 static MTPData
*usb_mtp_get_storage_info(MTPState
*s
, MTPControl
*c
)
825 MTPData
*d
= usb_mtp_data_alloc(c
);
829 trace_usb_mtp_op_get_storage_info(s
->dev
.addr
);
831 if (FLAG_SET(s
, MTP_FLAG_WRITABLE
)) {
832 usb_mtp_add_u16(d
, 0x0003);
833 usb_mtp_add_u16(d
, 0x0002);
834 usb_mtp_add_u16(d
, 0x0000);
836 usb_mtp_add_u16(d
, 0x0001);
837 usb_mtp_add_u16(d
, 0x0002);
838 usb_mtp_add_u16(d
, 0x0001);
841 rc
= statvfs(s
->root
, &buf
);
843 usb_mtp_add_u64(d
, (uint64_t)buf
.f_frsize
* buf
.f_blocks
);
844 usb_mtp_add_u64(d
, (uint64_t)buf
.f_bavail
* buf
.f_blocks
);
845 usb_mtp_add_u32(d
, buf
.f_ffree
);
847 usb_mtp_add_u64(d
, 0xffffffff);
848 usb_mtp_add_u64(d
, 0xffffffff);
849 usb_mtp_add_u32(d
, 0xffffffff);
852 usb_mtp_add_str(d
, s
->desc
);
853 usb_mtp_add_wstr(d
, L
"123456789abcdef");
857 static MTPData
*usb_mtp_get_object_handles(MTPState
*s
, MTPControl
*c
,
860 MTPData
*d
= usb_mtp_data_alloc(c
);
861 uint32_t i
= 0, handles
[o
->nchildren
];
864 trace_usb_mtp_op_get_object_handles(s
->dev
.addr
, o
->handle
, o
->path
);
866 QLIST_FOREACH(iter
, &o
->children
, list
) {
867 handles
[i
++] = iter
->handle
;
869 assert(i
== o
->nchildren
);
870 usb_mtp_add_u32_array(d
, o
->nchildren
, handles
);
875 static MTPData
*usb_mtp_get_object_info(MTPState
*s
, MTPControl
*c
,
878 MTPData
*d
= usb_mtp_data_alloc(c
);
880 trace_usb_mtp_op_get_object_info(s
->dev
.addr
, o
->handle
, o
->path
);
882 usb_mtp_add_u32(d
, QEMU_STORAGE_ID
);
883 usb_mtp_add_u16(d
, o
->format
);
884 usb_mtp_add_u16(d
, 0);
885 usb_mtp_add_u32(d
, o
->stat
.st_size
);
887 usb_mtp_add_u16(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);
893 usb_mtp_add_u32(d
, 0);
896 usb_mtp_add_u32(d
, o
->parent
->handle
);
898 usb_mtp_add_u32(d
, 0);
900 if (o
->format
== FMT_ASSOCIATION
) {
901 usb_mtp_add_u16(d
, 0x0001);
902 usb_mtp_add_u32(d
, 0x00000001);
903 usb_mtp_add_u32(d
, 0);
905 usb_mtp_add_u16(d
, 0);
906 usb_mtp_add_u32(d
, 0);
907 usb_mtp_add_u32(d
, 0);
910 usb_mtp_add_str(d
, o
->name
);
911 usb_mtp_add_time(d
, o
->stat
.st_ctime
);
912 usb_mtp_add_time(d
, o
->stat
.st_mtime
);
913 usb_mtp_add_wstr(d
, L
"");
918 static MTPData
*usb_mtp_get_object(MTPState
*s
, MTPControl
*c
,
921 MTPData
*d
= usb_mtp_data_alloc(c
);
923 trace_usb_mtp_op_get_object(s
->dev
.addr
, o
->handle
, o
->path
);
925 d
->fd
= open(o
->path
, O_RDONLY
);
927 usb_mtp_data_free(d
);
930 d
->length
= o
->stat
.st_size
;
932 d
->data
= g_malloc(d
->alloc
);
936 static MTPData
*usb_mtp_get_partial_object(MTPState
*s
, MTPControl
*c
,
939 MTPData
*d
= usb_mtp_data_alloc(c
);
942 trace_usb_mtp_op_get_partial_object(s
->dev
.addr
, o
->handle
, o
->path
,
943 c
->argv
[1], c
->argv
[2]);
945 d
->fd
= open(o
->path
, O_RDONLY
);
947 usb_mtp_data_free(d
);
952 if (offset
> o
->stat
.st_size
) {
953 offset
= o
->stat
.st_size
;
955 if (lseek(d
->fd
, offset
, SEEK_SET
) < 0) {
956 usb_mtp_data_free(d
);
960 d
->length
= c
->argv
[2];
961 if (d
->length
> o
->stat
.st_size
- offset
) {
962 d
->length
= o
->stat
.st_size
- offset
;
968 static void usb_mtp_command(MTPState
*s
, MTPControl
*c
)
970 MTPData
*data_in
= NULL
;
972 uint32_t nres
= 0, res0
= 0;
975 if (c
->code
>= CMD_CLOSE_SESSION
&& s
->session
== 0) {
976 usb_mtp_queue_result(s
, RES_SESSION_NOT_OPEN
,
981 /* process commands */
983 case CMD_GET_DEVICE_INFO
:
984 data_in
= usb_mtp_get_device_info(s
, c
);
986 case CMD_OPEN_SESSION
:
988 usb_mtp_queue_result(s
, RES_SESSION_ALREADY_OPEN
,
989 c
->trans
, 1, s
->session
, 0);
992 if (c
->argv
[0] == 0) {
993 usb_mtp_queue_result(s
, RES_INVALID_PARAMETER
,
997 trace_usb_mtp_op_open_session(s
->dev
.addr
);
998 s
->session
= c
->argv
[0];
999 usb_mtp_object_alloc(s
, s
->next_handle
++, NULL
, s
->root
);
1001 if (usb_mtp_inotify_init(s
)) {
1002 fprintf(stderr
, "usb-mtp: file monitoring init failed\n");
1006 case CMD_CLOSE_SESSION
:
1007 trace_usb_mtp_op_close_session(s
->dev
.addr
);
1011 usb_mtp_inotify_cleanup(s
);
1013 usb_mtp_object_free(s
, QTAILQ_FIRST(&s
->objects
));
1014 assert(QTAILQ_EMPTY(&s
->objects
));
1016 case CMD_GET_STORAGE_IDS
:
1017 data_in
= usb_mtp_get_storage_ids(s
, c
);
1019 case CMD_GET_STORAGE_INFO
:
1020 if (c
->argv
[0] != QEMU_STORAGE_ID
&&
1021 c
->argv
[0] != 0xffffffff) {
1022 usb_mtp_queue_result(s
, RES_INVALID_STORAGE_ID
,
1026 data_in
= usb_mtp_get_storage_info(s
, c
);
1028 case CMD_GET_NUM_OBJECTS
:
1029 case CMD_GET_OBJECT_HANDLES
:
1030 if (c
->argv
[0] != QEMU_STORAGE_ID
&&
1031 c
->argv
[0] != 0xffffffff) {
1032 usb_mtp_queue_result(s
, RES_INVALID_STORAGE_ID
,
1036 if (c
->argv
[1] != 0x00000000) {
1037 usb_mtp_queue_result(s
, RES_SPEC_BY_FORMAT_UNSUPPORTED
,
1041 if (c
->argv
[2] == 0x00000000 ||
1042 c
->argv
[2] == 0xffffffff) {
1043 o
= QTAILQ_FIRST(&s
->objects
);
1045 o
= usb_mtp_object_lookup(s
, c
->argv
[2]);
1048 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1052 if (o
->format
!= FMT_ASSOCIATION
) {
1053 usb_mtp_queue_result(s
, RES_INVALID_PARENT_OBJECT
,
1057 usb_mtp_object_readdir(s
, o
);
1058 if (c
->code
== CMD_GET_NUM_OBJECTS
) {
1059 trace_usb_mtp_op_get_num_objects(s
->dev
.addr
, o
->handle
, o
->path
);
1061 res0
= o
->nchildren
;
1063 data_in
= usb_mtp_get_object_handles(s
, c
, o
);
1066 case CMD_GET_OBJECT_INFO
:
1067 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1069 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1073 data_in
= usb_mtp_get_object_info(s
, c
, o
);
1075 case CMD_GET_OBJECT
:
1076 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1078 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1082 if (o
->format
== FMT_ASSOCIATION
) {
1083 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1087 data_in
= usb_mtp_get_object(s
, c
, o
);
1088 if (data_in
== NULL
) {
1089 usb_mtp_queue_result(s
, RES_GENERAL_ERROR
,
1094 case CMD_GET_PARTIAL_OBJECT
:
1095 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1097 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1101 if (o
->format
== FMT_ASSOCIATION
) {
1102 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1106 data_in
= usb_mtp_get_partial_object(s
, c
, o
);
1107 if (data_in
== NULL
) {
1108 usb_mtp_queue_result(s
, RES_GENERAL_ERROR
,
1113 res0
= data_in
->length
;
1116 trace_usb_mtp_op_unknown(s
->dev
.addr
, c
->code
);
1117 usb_mtp_queue_result(s
, RES_OPERATION_NOT_SUPPORTED
,
1122 /* return results on success */
1124 assert(s
->data_in
== NULL
);
1125 s
->data_in
= data_in
;
1127 usb_mtp_queue_result(s
, RES_OK
, c
->trans
, nres
, res0
, 0);
1130 /* ----------------------------------------------------------------------- */
1132 static void usb_mtp_handle_reset(USBDevice
*dev
)
1134 MTPState
*s
= USB_MTP(dev
);
1136 trace_usb_mtp_reset(s
->dev
.addr
);
1139 usb_mtp_inotify_cleanup(s
);
1141 usb_mtp_object_free(s
, QTAILQ_FIRST(&s
->objects
));
1143 usb_mtp_data_free(s
->data_in
);
1145 usb_mtp_data_free(s
->data_out
);
1151 static void usb_mtp_handle_control(USBDevice
*dev
, USBPacket
*p
,
1152 int request
, int value
, int index
,
1153 int length
, uint8_t *data
)
1157 ret
= usb_desc_handle_control(dev
, p
, request
, value
, index
, length
, data
);
1162 trace_usb_mtp_stall(dev
->addr
, "unknown control request");
1163 p
->status
= USB_RET_STALL
;
1166 static void usb_mtp_cancel_packet(USBDevice
*dev
, USBPacket
*p
)
1168 /* we don't use async packets, so this should never be called */
1169 fprintf(stderr
, "%s\n", __func__
);
1172 static void usb_mtp_handle_data(USBDevice
*dev
, USBPacket
*p
)
1174 MTPState
*s
= USB_MTP(dev
);
1176 mtp_container container
;
1180 switch (p
->ep
->nr
) {
1182 if (s
->data_out
!= NULL
) {
1184 trace_usb_mtp_stall(s
->dev
.addr
, "awaiting data-out");
1185 p
->status
= USB_RET_STALL
;
1188 if (p
->iov
.size
< sizeof(container
)) {
1189 trace_usb_mtp_stall(s
->dev
.addr
, "packet too small");
1190 p
->status
= USB_RET_STALL
;
1193 if (s
->data_in
!= NULL
) {
1194 MTPData
*d
= s
->data_in
;
1195 int dlen
= d
->length
- d
->offset
;
1197 trace_usb_mtp_data_in(s
->dev
.addr
, d
->trans
, d
->length
);
1198 container
.length
= cpu_to_le32(d
->length
+ sizeof(container
));
1199 container
.type
= cpu_to_le16(TYPE_DATA
);
1200 container
.code
= cpu_to_le16(d
->code
);
1201 container
.trans
= cpu_to_le32(d
->trans
);
1202 usb_packet_copy(p
, &container
, sizeof(container
));
1204 if (dlen
> p
->iov
.size
- sizeof(container
)) {
1205 dlen
= p
->iov
.size
- sizeof(container
);
1208 if (dlen
> p
->iov
.size
) {
1213 usb_packet_copy(p
, d
->data
+ d
->offset
, dlen
);
1215 if (d
->alloc
< p
->iov
.size
) {
1216 d
->alloc
= p
->iov
.size
;
1217 d
->data
= g_realloc(d
->data
, d
->alloc
);
1219 rc
= read(d
->fd
, d
->data
, dlen
);
1221 memset(d
->data
, 0, dlen
);
1222 s
->result
->code
= RES_INCOMPLETE_TRANSFER
;
1224 usb_packet_copy(p
, d
->data
, dlen
);
1227 if (d
->offset
== d
->length
) {
1228 usb_mtp_data_free(s
->data_in
);
1231 } else if (s
->result
!= NULL
) {
1232 MTPControl
*r
= s
->result
;
1233 int length
= sizeof(container
) + r
->argc
* sizeof(uint32_t);
1234 if (r
->code
== RES_OK
) {
1235 trace_usb_mtp_success(s
->dev
.addr
, r
->trans
,
1236 (r
->argc
> 0) ? r
->argv
[0] : 0,
1237 (r
->argc
> 1) ? r
->argv
[1] : 0);
1239 trace_usb_mtp_error(s
->dev
.addr
, r
->code
, r
->trans
,
1240 (r
->argc
> 0) ? r
->argv
[0] : 0,
1241 (r
->argc
> 1) ? r
->argv
[1] : 0);
1243 container
.length
= cpu_to_le32(length
);
1244 container
.type
= cpu_to_le16(TYPE_RESPONSE
);
1245 container
.code
= cpu_to_le16(r
->code
);
1246 container
.trans
= cpu_to_le32(r
->trans
);
1247 for (i
= 0; i
< r
->argc
; i
++) {
1248 params
[i
] = cpu_to_le32(r
->argv
[i
]);
1250 usb_packet_copy(p
, &container
, sizeof(container
));
1251 usb_packet_copy(p
, ¶ms
, length
- sizeof(container
));
1257 if (p
->iov
.size
< sizeof(container
)) {
1258 trace_usb_mtp_stall(s
->dev
.addr
, "packet too small");
1259 p
->status
= USB_RET_STALL
;
1262 usb_packet_copy(p
, &container
, sizeof(container
));
1263 switch (le16_to_cpu(container
.type
)) {
1265 if (s
->data_in
|| s
->data_out
|| s
->result
) {
1266 trace_usb_mtp_stall(s
->dev
.addr
, "transaction inflight");
1267 p
->status
= USB_RET_STALL
;
1270 cmd
.code
= le16_to_cpu(container
.code
);
1271 cmd
.argc
= (le32_to_cpu(container
.length
) - sizeof(container
))
1273 cmd
.trans
= le32_to_cpu(container
.trans
);
1274 if (cmd
.argc
> ARRAY_SIZE(cmd
.argv
)) {
1275 cmd
.argc
= ARRAY_SIZE(cmd
.argv
);
1277 if (p
->iov
.size
< sizeof(container
) + cmd
.argc
* sizeof(uint32_t)) {
1278 trace_usb_mtp_stall(s
->dev
.addr
, "packet too small");
1279 p
->status
= USB_RET_STALL
;
1282 usb_packet_copy(p
, ¶ms
, cmd
.argc
* sizeof(uint32_t));
1283 for (i
= 0; i
< cmd
.argc
; i
++) {
1284 cmd
.argv
[i
] = le32_to_cpu(params
[i
]);
1286 trace_usb_mtp_command(s
->dev
.addr
, cmd
.code
, cmd
.trans
,
1287 (cmd
.argc
> 0) ? cmd
.argv
[0] : 0,
1288 (cmd
.argc
> 1) ? cmd
.argv
[1] : 0,
1289 (cmd
.argc
> 2) ? cmd
.argv
[2] : 0,
1290 (cmd
.argc
> 3) ? cmd
.argv
[3] : 0,
1291 (cmd
.argc
> 4) ? cmd
.argv
[4] : 0);
1292 usb_mtp_command(s
, &cmd
);
1295 /* not needed as long as the mtp device is read-only */
1296 p
->status
= USB_RET_STALL
;
1302 if (!QTAILQ_EMPTY(&s
->events
)) {
1303 struct MTPMonEntry
*e
= QTAILQ_LAST(&s
->events
, events
);
1305 int len
= sizeof(container
) + sizeof(uint32_t);
1307 if (p
->iov
.size
< len
) {
1308 trace_usb_mtp_stall(s
->dev
.addr
,
1309 "packet too small to send event");
1310 p
->status
= USB_RET_STALL
;
1314 QTAILQ_REMOVE(&s
->events
, e
, next
);
1315 container
.length
= cpu_to_le32(len
);
1316 container
.type
= cpu_to_le32(TYPE_EVENT
);
1317 container
.code
= cpu_to_le16(e
->event
);
1318 container
.trans
= 0; /* no trans specific events */
1319 handle
= cpu_to_le32(e
->handle
);
1320 usb_packet_copy(p
, &container
, sizeof(container
));
1321 usb_packet_copy(p
, &handle
, sizeof(uint32_t));
1326 p
->status
= USB_RET_NAK
;
1329 trace_usb_mtp_stall(s
->dev
.addr
, "invalid endpoint");
1330 p
->status
= USB_RET_STALL
;
1334 if (p
->actual_length
== 0) {
1335 trace_usb_mtp_nak(s
->dev
.addr
, p
->ep
->nr
);
1336 p
->status
= USB_RET_NAK
;
1339 trace_usb_mtp_xfer(s
->dev
.addr
, p
->ep
->nr
, p
->actual_length
,
1345 static void usb_mtp_realize(USBDevice
*dev
, Error
**errp
)
1347 MTPState
*s
= USB_MTP(dev
);
1349 usb_desc_create_serial(dev
);
1351 QTAILQ_INIT(&s
->objects
);
1352 if (s
->desc
== NULL
) {
1353 if (s
->root
== NULL
) {
1354 error_setg(errp
, "usb-mtp: x-root property must be configured");
1357 s
->desc
= strrchr(s
->root
, '/');
1358 if (s
->desc
&& s
->desc
[0]) {
1359 s
->desc
= g_strdup(s
->desc
+ 1);
1361 s
->desc
= g_strdup("none");
1366 static const VMStateDescription vmstate_usb_mtp
= {
1370 .minimum_version_id
= 1,
1371 .fields
= (VMStateField
[]) {
1372 VMSTATE_USB_DEVICE(dev
, MTPState
),
1373 VMSTATE_END_OF_LIST()
1377 static Property mtp_properties
[] = {
1378 DEFINE_PROP_STRING("x-root", MTPState
, root
),
1379 DEFINE_PROP_STRING("desc", MTPState
, desc
),
1380 DEFINE_PROP_END_OF_LIST(),
1383 static void usb_mtp_class_initfn(ObjectClass
*klass
, void *data
)
1385 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1386 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
1388 uc
->realize
= usb_mtp_realize
;
1389 uc
->product_desc
= "QEMU USB MTP";
1390 uc
->usb_desc
= &desc
;
1391 uc
->cancel_packet
= usb_mtp_cancel_packet
;
1392 uc
->handle_attach
= usb_desc_attach
;
1393 uc
->handle_reset
= usb_mtp_handle_reset
;
1394 uc
->handle_control
= usb_mtp_handle_control
;
1395 uc
->handle_data
= usb_mtp_handle_data
;
1396 dc
->fw_name
= "mtp";
1397 dc
->vmsd
= &vmstate_usb_mtp
;
1398 dc
->props
= mtp_properties
;
1401 static TypeInfo mtp_info
= {
1402 .name
= TYPE_USB_MTP
,
1403 .parent
= TYPE_USB_DEVICE
,
1404 .instance_size
= sizeof(MTPState
),
1405 .class_init
= usb_mtp_class_initfn
,
1408 static void usb_mtp_register_types(void)
1410 type_register_static(&mtp_info
);
1413 type_init(usb_mtp_register_types
)