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>
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(, 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
);
672 #ifdef CONFIG_INOTIFY1
673 int watchfd
= usb_mtp_add_watch(s
->inotifyfd
, o
->path
);
675 fprintf(stderr
, "usb-mtp: failed to add watch for %s\n", o
->path
);
677 trace_usb_mtp_inotify_event(s
->dev
.addr
, o
->path
,
679 o
->watchfd
= watchfd
;
682 while ((entry
= readdir(dir
)) != NULL
) {
683 usb_mtp_add_child(s
, o
, entry
->d_name
);
688 /* ----------------------------------------------------------------------- */
690 static MTPData
*usb_mtp_data_alloc(MTPControl
*c
)
692 MTPData
*data
= g_new0(MTPData
, 1);
694 data
->code
= c
->code
;
695 data
->trans
= c
->trans
;
701 static void usb_mtp_data_free(MTPData
*data
)
706 if (data
->fd
!= -1) {
713 static void usb_mtp_realloc(MTPData
*data
, uint32_t bytes
)
715 if (data
->length
+ bytes
<= data
->alloc
) {
718 data
->alloc
= (data
->length
+ bytes
+ 0xff) & ~0xff;
719 data
->data
= g_realloc(data
->data
, data
->alloc
);
722 static void usb_mtp_add_u8(MTPData
*data
, uint8_t val
)
724 usb_mtp_realloc(data
, 1);
725 data
->data
[data
->length
++] = val
;
728 static void usb_mtp_add_u16(MTPData
*data
, uint16_t val
)
730 usb_mtp_realloc(data
, 2);
731 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
732 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
735 static void usb_mtp_add_u32(MTPData
*data
, uint32_t val
)
737 usb_mtp_realloc(data
, 4);
738 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
739 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
740 data
->data
[data
->length
++] = (val
>> 16) & 0xff;
741 data
->data
[data
->length
++] = (val
>> 24) & 0xff;
744 static void usb_mtp_add_u64(MTPData
*data
, uint64_t val
)
746 usb_mtp_realloc(data
, 8);
747 data
->data
[data
->length
++] = (val
>> 0) & 0xff;
748 data
->data
[data
->length
++] = (val
>> 8) & 0xff;
749 data
->data
[data
->length
++] = (val
>> 16) & 0xff;
750 data
->data
[data
->length
++] = (val
>> 24) & 0xff;
751 data
->data
[data
->length
++] = (val
>> 32) & 0xff;
752 data
->data
[data
->length
++] = (val
>> 40) & 0xff;
753 data
->data
[data
->length
++] = (val
>> 48) & 0xff;
754 data
->data
[data
->length
++] = (val
>> 56) & 0xff;
757 static void usb_mtp_add_u16_array(MTPData
*data
, uint32_t len
,
758 const uint16_t *vals
)
762 usb_mtp_add_u32(data
, len
);
763 for (i
= 0; i
< len
; i
++) {
764 usb_mtp_add_u16(data
, vals
[i
]);
768 static void usb_mtp_add_u32_array(MTPData
*data
, uint32_t len
,
769 const uint32_t *vals
)
773 usb_mtp_add_u32(data
, len
);
774 for (i
= 0; i
< len
; i
++) {
775 usb_mtp_add_u32(data
, vals
[i
]);
779 static void usb_mtp_add_wstr(MTPData
*data
, const wchar_t *str
)
781 uint32_t len
= wcslen(str
);
785 len
++; /* include terminating L'\0' */
788 usb_mtp_add_u8(data
, len
);
789 for (i
= 0; i
< len
; i
++) {
790 usb_mtp_add_u16(data
, str
[i
]);
794 static void usb_mtp_add_str(MTPData
*data
, const char *str
)
796 uint32_t len
= strlen(str
)+1;
797 wchar_t *wstr
= g_new(wchar_t, len
);
800 ret
= mbstowcs(wstr
, str
, len
);
802 usb_mtp_add_wstr(data
, L
"Oops");
804 usb_mtp_add_wstr(data
, wstr
);
810 static void usb_mtp_add_time(MTPData
*data
, time_t time
)
815 gmtime_r(&time
, &tm
);
816 strftime(buf
, sizeof(buf
), "%Y%m%dT%H%M%S", &tm
);
817 usb_mtp_add_str(data
, buf
);
820 /* ----------------------------------------------------------------------- */
822 static void usb_mtp_queue_result(MTPState
*s
, uint16_t code
, uint32_t trans
,
823 int argc
, uint32_t arg0
, uint32_t arg1
,
826 MTPControl
*c
= g_new0(MTPControl
, 1);
841 assert(s
->result
== NULL
);
845 /* ----------------------------------------------------------------------- */
847 static MTPData
*usb_mtp_get_device_info(MTPState
*s
, MTPControl
*c
)
849 static const uint16_t ops
[] = {
854 CMD_GET_STORAGE_INFO
,
856 CMD_GET_OBJECT_HANDLES
,
859 CMD_SEND_OBJECT_INFO
,
862 CMD_GET_PARTIAL_OBJECT
,
863 CMD_GET_OBJECT_PROPS_SUPPORTED
,
864 CMD_GET_OBJECT_PROP_DESC
,
865 CMD_GET_OBJECT_PROP_VALUE
,
867 static const uint16_t fmt
[] = {
868 FMT_UNDEFINED_OBJECT
,
871 MTPData
*d
= usb_mtp_data_alloc(c
);
873 trace_usb_mtp_op_get_device_info(s
->dev
.addr
);
875 usb_mtp_add_u16(d
, 100);
876 usb_mtp_add_u32(d
, 0x00000006);
877 usb_mtp_add_u16(d
, 0x0064);
878 usb_mtp_add_wstr(d
, L
"");
879 usb_mtp_add_u16(d
, 0x0000);
881 usb_mtp_add_u16_array(d
, ARRAY_SIZE(ops
), ops
);
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
, 0, NULL
);
885 usb_mtp_add_u16_array(d
, ARRAY_SIZE(fmt
), fmt
);
887 usb_mtp_add_wstr(d
, L
"" MTP_MANUFACTURER
);
888 usb_mtp_add_wstr(d
, L
"" MTP_PRODUCT
);
889 usb_mtp_add_wstr(d
, L
"0.1");
890 usb_mtp_add_wstr(d
, L
"0123456789abcdef0123456789abcdef");
895 static MTPData
*usb_mtp_get_storage_ids(MTPState
*s
, MTPControl
*c
)
897 static const uint32_t ids
[] = {
900 MTPData
*d
= usb_mtp_data_alloc(c
);
902 trace_usb_mtp_op_get_storage_ids(s
->dev
.addr
);
904 usb_mtp_add_u32_array(d
, ARRAY_SIZE(ids
), ids
);
909 static MTPData
*usb_mtp_get_storage_info(MTPState
*s
, MTPControl
*c
)
911 MTPData
*d
= usb_mtp_data_alloc(c
);
915 trace_usb_mtp_op_get_storage_info(s
->dev
.addr
);
917 if (FLAG_SET(s
, MTP_FLAG_WRITABLE
)) {
918 usb_mtp_add_u16(d
, 0x0003);
919 usb_mtp_add_u16(d
, 0x0002);
920 usb_mtp_add_u16(d
, 0x0000);
922 usb_mtp_add_u16(d
, 0x0001);
923 usb_mtp_add_u16(d
, 0x0002);
924 usb_mtp_add_u16(d
, 0x0001);
927 rc
= statvfs(s
->root
, &buf
);
929 usb_mtp_add_u64(d
, (uint64_t)buf
.f_frsize
* buf
.f_blocks
);
930 usb_mtp_add_u64(d
, (uint64_t)buf
.f_bavail
* buf
.f_blocks
);
931 usb_mtp_add_u32(d
, buf
.f_ffree
);
933 usb_mtp_add_u64(d
, 0xffffffff);
934 usb_mtp_add_u64(d
, 0xffffffff);
935 usb_mtp_add_u32(d
, 0xffffffff);
938 usb_mtp_add_str(d
, s
->desc
);
939 usb_mtp_add_wstr(d
, L
"123456789abcdef");
943 static MTPData
*usb_mtp_get_object_handles(MTPState
*s
, MTPControl
*c
,
946 MTPData
*d
= usb_mtp_data_alloc(c
);
947 uint32_t i
= 0, handles
[o
->nchildren
];
950 trace_usb_mtp_op_get_object_handles(s
->dev
.addr
, o
->handle
, o
->path
);
952 QLIST_FOREACH(iter
, &o
->children
, list
) {
953 handles
[i
++] = iter
->handle
;
955 assert(i
== o
->nchildren
);
956 usb_mtp_add_u32_array(d
, o
->nchildren
, handles
);
961 static MTPData
*usb_mtp_get_object_info(MTPState
*s
, MTPControl
*c
,
964 MTPData
*d
= usb_mtp_data_alloc(c
);
966 trace_usb_mtp_op_get_object_info(s
->dev
.addr
, o
->handle
, o
->path
);
968 usb_mtp_add_u32(d
, QEMU_STORAGE_ID
);
969 usb_mtp_add_u16(d
, o
->format
);
970 usb_mtp_add_u16(d
, 0);
972 if (o
->stat
.st_size
> 0xFFFFFFFF) {
973 usb_mtp_add_u32(d
, 0xFFFFFFFF);
975 usb_mtp_add_u32(d
, o
->stat
.st_size
);
978 usb_mtp_add_u16(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);
984 usb_mtp_add_u32(d
, 0);
987 usb_mtp_add_u32(d
, o
->parent
->handle
);
989 usb_mtp_add_u32(d
, 0);
991 if (o
->format
== FMT_ASSOCIATION
) {
992 usb_mtp_add_u16(d
, 0x0001);
993 usb_mtp_add_u32(d
, 0x00000001);
994 usb_mtp_add_u32(d
, 0);
996 usb_mtp_add_u16(d
, 0);
997 usb_mtp_add_u32(d
, 0);
998 usb_mtp_add_u32(d
, 0);
1001 usb_mtp_add_str(d
, o
->name
);
1002 usb_mtp_add_time(d
, o
->stat
.st_ctime
);
1003 usb_mtp_add_time(d
, o
->stat
.st_mtime
);
1004 usb_mtp_add_wstr(d
, L
"");
1009 static MTPData
*usb_mtp_get_object(MTPState
*s
, MTPControl
*c
,
1012 MTPData
*d
= usb_mtp_data_alloc(c
);
1014 trace_usb_mtp_op_get_object(s
->dev
.addr
, o
->handle
, o
->path
);
1016 d
->fd
= open(o
->path
, O_RDONLY
| O_CLOEXEC
| O_NOFOLLOW
);
1018 usb_mtp_data_free(d
);
1021 d
->length
= o
->stat
.st_size
;
1023 d
->data
= g_malloc(d
->alloc
);
1027 static MTPData
*usb_mtp_get_partial_object(MTPState
*s
, MTPControl
*c
,
1036 trace_usb_mtp_op_get_partial_object(s
->dev
.addr
, o
->handle
, o
->path
,
1037 c
->argv
[1], c
->argv
[2]);
1039 d
= usb_mtp_data_alloc(c
);
1040 d
->fd
= open(o
->path
, O_RDONLY
| O_CLOEXEC
| O_NOFOLLOW
);
1042 usb_mtp_data_free(d
);
1046 offset
= c
->argv
[1];
1047 if (offset
> o
->stat
.st_size
) {
1048 offset
= o
->stat
.st_size
;
1050 if (lseek(d
->fd
, offset
, SEEK_SET
) < 0) {
1051 usb_mtp_data_free(d
);
1055 d
->length
= c
->argv
[2];
1056 if (d
->length
> o
->stat
.st_size
- offset
) {
1057 d
->length
= o
->stat
.st_size
- offset
;
1063 static MTPData
*usb_mtp_get_object_props_supported(MTPState
*s
, MTPControl
*c
)
1065 static const uint16_t props
[] = {
1068 PROP_OBJECT_COMPRESSED_SIZE
,
1070 PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER
,
1073 MTPData
*d
= usb_mtp_data_alloc(c
);
1074 usb_mtp_add_u16_array(d
, ARRAY_SIZE(props
), props
);
1079 static MTPData
*usb_mtp_get_object_prop_desc(MTPState
*s
, MTPControl
*c
)
1081 MTPData
*d
= usb_mtp_data_alloc(c
);
1082 switch (c
->argv
[0]) {
1083 case PROP_STORAGE_ID
:
1084 usb_mtp_add_u16(d
, PROP_STORAGE_ID
);
1085 usb_mtp_add_u16(d
, DATA_TYPE_UINT32
);
1086 usb_mtp_add_u8(d
, 0x00);
1087 usb_mtp_add_u32(d
, 0x00000000);
1088 usb_mtp_add_u32(d
, 0x00000000);
1089 usb_mtp_add_u8(d
, 0x00);
1091 case PROP_OBJECT_FORMAT
:
1092 usb_mtp_add_u16(d
, PROP_OBJECT_FORMAT
);
1093 usb_mtp_add_u16(d
, DATA_TYPE_UINT16
);
1094 usb_mtp_add_u8(d
, 0x00);
1095 usb_mtp_add_u16(d
, 0x0000);
1096 usb_mtp_add_u32(d
, 0x00000000);
1097 usb_mtp_add_u8(d
, 0x00);
1099 case PROP_OBJECT_COMPRESSED_SIZE
:
1100 usb_mtp_add_u16(d
, PROP_OBJECT_COMPRESSED_SIZE
);
1101 usb_mtp_add_u16(d
, DATA_TYPE_UINT64
);
1102 usb_mtp_add_u8(d
, 0x00);
1103 usb_mtp_add_u64(d
, 0x0000000000000000);
1104 usb_mtp_add_u32(d
, 0x00000000);
1105 usb_mtp_add_u8(d
, 0x00);
1107 case PROP_PARENT_OBJECT
:
1108 usb_mtp_add_u16(d
, PROP_PARENT_OBJECT
);
1109 usb_mtp_add_u16(d
, DATA_TYPE_UINT32
);
1110 usb_mtp_add_u8(d
, 0x00);
1111 usb_mtp_add_u32(d
, 0x00000000);
1112 usb_mtp_add_u32(d
, 0x00000000);
1113 usb_mtp_add_u8(d
, 0x00);
1115 case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER
:
1116 usb_mtp_add_u16(d
, PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER
);
1117 usb_mtp_add_u16(d
, DATA_TYPE_UINT128
);
1118 usb_mtp_add_u8(d
, 0x00);
1119 usb_mtp_add_u64(d
, 0x0000000000000000);
1120 usb_mtp_add_u64(d
, 0x0000000000000000);
1121 usb_mtp_add_u32(d
, 0x00000000);
1122 usb_mtp_add_u8(d
, 0x00);
1125 usb_mtp_add_u16(d
, PROP_NAME
);
1126 usb_mtp_add_u16(d
, DATA_TYPE_STRING
);
1127 usb_mtp_add_u8(d
, 0x00);
1128 usb_mtp_add_u8(d
, 0x00);
1129 usb_mtp_add_u32(d
, 0x00000000);
1130 usb_mtp_add_u8(d
, 0x00);
1133 usb_mtp_data_free(d
);
1140 static MTPData
*usb_mtp_get_object_prop_value(MTPState
*s
, MTPControl
*c
,
1143 MTPData
*d
= usb_mtp_data_alloc(c
);
1144 switch (c
->argv
[1]) {
1145 case PROP_STORAGE_ID
:
1146 usb_mtp_add_u32(d
, QEMU_STORAGE_ID
);
1148 case PROP_OBJECT_FORMAT
:
1149 usb_mtp_add_u16(d
, o
->format
);
1151 case PROP_OBJECT_COMPRESSED_SIZE
:
1152 usb_mtp_add_u64(d
, o
->stat
.st_size
);
1154 case PROP_PARENT_OBJECT
:
1155 if (o
->parent
== NULL
) {
1156 usb_mtp_add_u32(d
, 0x00000000);
1158 usb_mtp_add_u32(d
, o
->parent
->handle
);
1161 case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER
:
1162 /* Should be persistent between sessions,
1163 * but using our objedt ID is "good enough"
1165 usb_mtp_add_u64(d
, 0x0000000000000000);
1166 usb_mtp_add_u64(d
, o
->handle
);
1169 usb_mtp_add_str(d
, o
->name
);
1172 usb_mtp_data_free(d
);
1179 /* Return correct return code for a delete event */
1186 /* Assumes that children, if any, have been already freed */
1187 static void usb_mtp_object_free_one(MTPState
*s
, MTPObject
*o
)
1189 #ifndef CONFIG_INOTIFY1
1190 assert(o
->nchildren
== 0);
1191 QTAILQ_REMOVE(&s
->objects
, o
, next
);
1198 static int usb_mtp_deletefn(MTPState
*s
, MTPObject
*o
, uint32_t trans
)
1200 MTPObject
*iter
, *iter2
;
1201 bool partial_delete
= false;
1202 bool success
= false;
1205 * TODO: Add support for Protection Status
1208 QLIST_FOREACH(iter
, &o
->children
, list
) {
1209 if (iter
->format
== FMT_ASSOCIATION
) {
1210 QLIST_FOREACH(iter2
, &iter
->children
, list
) {
1211 usb_mtp_deletefn(s
, iter2
, trans
);
1216 if (o
->format
== FMT_UNDEFINED_OBJECT
) {
1217 if (remove(o
->path
)) {
1218 partial_delete
= true;
1220 usb_mtp_object_free_one(s
, o
);
1225 if (o
->format
== FMT_ASSOCIATION
) {
1226 if (rmdir(o
->path
)) {
1227 partial_delete
= true;
1229 usb_mtp_object_free_one(s
, o
);
1234 if (success
&& partial_delete
) {
1235 return PARTIAL_DELETE
;
1237 if (!success
&& partial_delete
) {
1243 static void usb_mtp_object_delete(MTPState
*s
, uint32_t handle
,
1244 uint32_t format_code
, uint32_t trans
)
1249 /* Return error if store is read-only */
1250 if (!FLAG_SET(s
, MTP_FLAG_WRITABLE
)) {
1251 usb_mtp_queue_result(s
, RES_STORE_READ_ONLY
,
1256 if (format_code
!= 0) {
1257 usb_mtp_queue_result(s
, RES_SPEC_BY_FORMAT_UNSUPPORTED
,
1262 if (handle
== 0xFFFFFFF) {
1263 o
= QTAILQ_FIRST(&s
->objects
);
1265 o
= usb_mtp_object_lookup(s
, handle
);
1268 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1273 ret
= usb_mtp_deletefn(s
, o
, trans
);
1274 if (ret
== PARTIAL_DELETE
) {
1275 usb_mtp_queue_result(s
, RES_PARTIAL_DELETE
,
1278 } else if (ret
== READ_ONLY
) {
1279 usb_mtp_queue_result(s
, RES_STORE_READ_ONLY
, trans
,
1283 usb_mtp_queue_result(s
, RES_OK
, trans
,
1289 static void usb_mtp_command(MTPState
*s
, MTPControl
*c
)
1291 MTPData
*data_in
= NULL
;
1292 MTPObject
*o
= NULL
;
1293 uint32_t nres
= 0, res0
= 0;
1296 if (c
->code
>= CMD_CLOSE_SESSION
&& s
->session
== 0) {
1297 usb_mtp_queue_result(s
, RES_SESSION_NOT_OPEN
,
1298 c
->trans
, 0, 0, 0, 0);
1302 /* process commands */
1304 case CMD_GET_DEVICE_INFO
:
1305 data_in
= usb_mtp_get_device_info(s
, c
);
1307 case CMD_OPEN_SESSION
:
1309 usb_mtp_queue_result(s
, RES_SESSION_ALREADY_OPEN
,
1310 c
->trans
, 1, s
->session
, 0, 0);
1313 if (c
->argv
[0] == 0) {
1314 usb_mtp_queue_result(s
, RES_INVALID_PARAMETER
,
1315 c
->trans
, 0, 0, 0, 0);
1318 trace_usb_mtp_op_open_session(s
->dev
.addr
);
1319 s
->session
= c
->argv
[0];
1320 usb_mtp_object_alloc(s
, s
->next_handle
++, NULL
, s
->root
);
1321 #ifdef CONFIG_INOTIFY1
1322 if (usb_mtp_inotify_init(s
)) {
1323 fprintf(stderr
, "usb-mtp: file monitoring init failed\n");
1327 case CMD_CLOSE_SESSION
:
1328 trace_usb_mtp_op_close_session(s
->dev
.addr
);
1331 #ifdef CONFIG_INOTIFY1
1332 usb_mtp_inotify_cleanup(s
);
1334 usb_mtp_object_free(s
, QTAILQ_FIRST(&s
->objects
));
1335 assert(QTAILQ_EMPTY(&s
->objects
));
1337 case CMD_GET_STORAGE_IDS
:
1338 data_in
= usb_mtp_get_storage_ids(s
, c
);
1340 case CMD_GET_STORAGE_INFO
:
1341 if (c
->argv
[0] != QEMU_STORAGE_ID
&&
1342 c
->argv
[0] != 0xffffffff) {
1343 usb_mtp_queue_result(s
, RES_INVALID_STORAGE_ID
,
1344 c
->trans
, 0, 0, 0, 0);
1347 data_in
= usb_mtp_get_storage_info(s
, c
);
1349 case CMD_GET_NUM_OBJECTS
:
1350 case CMD_GET_OBJECT_HANDLES
:
1351 if (c
->argv
[0] != QEMU_STORAGE_ID
&&
1352 c
->argv
[0] != 0xffffffff) {
1353 usb_mtp_queue_result(s
, RES_INVALID_STORAGE_ID
,
1354 c
->trans
, 0, 0, 0, 0);
1357 if (c
->argv
[1] != 0x00000000) {
1358 usb_mtp_queue_result(s
, RES_SPEC_BY_FORMAT_UNSUPPORTED
,
1359 c
->trans
, 0, 0, 0, 0);
1362 if (c
->argv
[2] == 0x00000000 ||
1363 c
->argv
[2] == 0xffffffff) {
1364 o
= QTAILQ_FIRST(&s
->objects
);
1366 o
= usb_mtp_object_lookup(s
, c
->argv
[2]);
1369 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1370 c
->trans
, 0, 0, 0, 0);
1373 if (o
->format
!= FMT_ASSOCIATION
) {
1374 usb_mtp_queue_result(s
, RES_INVALID_PARENT_OBJECT
,
1375 c
->trans
, 0, 0, 0, 0);
1378 usb_mtp_object_readdir(s
, o
);
1379 if (c
->code
== CMD_GET_NUM_OBJECTS
) {
1380 trace_usb_mtp_op_get_num_objects(s
->dev
.addr
, o
->handle
, o
->path
);
1382 res0
= o
->nchildren
;
1384 data_in
= usb_mtp_get_object_handles(s
, c
, o
);
1387 case CMD_GET_OBJECT_INFO
:
1388 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1390 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1391 c
->trans
, 0, 0, 0, 0);
1394 data_in
= usb_mtp_get_object_info(s
, c
, o
);
1396 case CMD_GET_OBJECT
:
1397 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1399 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1400 c
->trans
, 0, 0, 0, 0);
1403 if (o
->format
== FMT_ASSOCIATION
) {
1404 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1405 c
->trans
, 0, 0, 0, 0);
1408 data_in
= usb_mtp_get_object(s
, c
, o
);
1409 if (data_in
== NULL
) {
1410 usb_mtp_queue_result(s
, RES_GENERAL_ERROR
,
1411 c
->trans
, 0, 0, 0, 0);
1415 case CMD_DELETE_OBJECT
:
1416 usb_mtp_object_delete(s
, c
->argv
[0], c
->argv
[1], c
->trans
);
1418 case CMD_GET_PARTIAL_OBJECT
:
1419 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1421 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1422 c
->trans
, 0, 0, 0, 0);
1425 if (o
->format
== FMT_ASSOCIATION
) {
1426 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1427 c
->trans
, 0, 0, 0, 0);
1430 data_in
= usb_mtp_get_partial_object(s
, c
, o
);
1431 if (data_in
== NULL
) {
1432 usb_mtp_queue_result(s
, RES_GENERAL_ERROR
,
1433 c
->trans
, 0, 0, 0, 0);
1437 res0
= data_in
->length
;
1439 case CMD_SEND_OBJECT_INFO
:
1440 /* Return error if store is read-only */
1441 if (!FLAG_SET(s
, MTP_FLAG_WRITABLE
)) {
1442 usb_mtp_queue_result(s
, RES_STORE_READ_ONLY
,
1443 c
->trans
, 0, 0, 0, 0);
1444 } else if (c
->argv
[0] && (c
->argv
[0] != QEMU_STORAGE_ID
)) {
1445 /* First parameter points to storage id or is 0 */
1446 usb_mtp_queue_result(s
, RES_STORE_NOT_AVAILABLE
, c
->trans
,
1448 } else if (c
->argv
[1] && !c
->argv
[0]) {
1449 /* If second parameter is specified, first must also be specified */
1450 usb_mtp_queue_result(s
, RES_DESTINATION_UNSUPPORTED
, c
->trans
,
1453 uint32_t handle
= c
->argv
[1];
1454 if (handle
== 0xFFFFFFFF || handle
== 0) {
1456 o
= QTAILQ_FIRST(&s
->objects
);
1458 o
= usb_mtp_object_lookup(s
, handle
);
1461 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
, c
->trans
,
1463 } else if (o
->format
!= FMT_ASSOCIATION
) {
1464 usb_mtp_queue_result(s
, RES_INVALID_PARENT_OBJECT
, c
->trans
,
1469 s
->dataset
.parent_handle
= o
->handle
;
1471 s
->data_out
= usb_mtp_data_alloc(c
);
1473 case CMD_SEND_OBJECT
:
1474 if (!FLAG_SET(s
, MTP_FLAG_WRITABLE
)) {
1475 usb_mtp_queue_result(s
, RES_STORE_READ_ONLY
,
1476 c
->trans
, 0, 0, 0, 0);
1479 if (!s
->write_pending
) {
1480 usb_mtp_queue_result(s
, RES_INVALID_OBJECTINFO
,
1481 c
->trans
, 0, 0, 0, 0);
1484 s
->data_out
= usb_mtp_data_alloc(c
);
1486 case CMD_GET_OBJECT_PROPS_SUPPORTED
:
1487 if (c
->argv
[0] != FMT_UNDEFINED_OBJECT
&&
1488 c
->argv
[0] != FMT_ASSOCIATION
) {
1489 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_FORMAT_CODE
,
1490 c
->trans
, 0, 0, 0, 0);
1493 data_in
= usb_mtp_get_object_props_supported(s
, c
);
1495 case CMD_GET_OBJECT_PROP_DESC
:
1496 if (c
->argv
[1] != FMT_UNDEFINED_OBJECT
&&
1497 c
->argv
[1] != FMT_ASSOCIATION
) {
1498 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_FORMAT_CODE
,
1499 c
->trans
, 0, 0, 0, 0);
1502 data_in
= usb_mtp_get_object_prop_desc(s
, c
);
1503 if (data_in
== NULL
) {
1504 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_PROP_CODE
,
1505 c
->trans
, 0, 0, 0, 0);
1509 case CMD_GET_OBJECT_PROP_VALUE
:
1510 o
= usb_mtp_object_lookup(s
, c
->argv
[0]);
1512 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_HANDLE
,
1513 c
->trans
, 0, 0, 0, 0);
1516 data_in
= usb_mtp_get_object_prop_value(s
, c
, o
);
1517 if (data_in
== NULL
) {
1518 usb_mtp_queue_result(s
, RES_INVALID_OBJECT_PROP_CODE
,
1519 c
->trans
, 0, 0, 0, 0);
1524 trace_usb_mtp_op_unknown(s
->dev
.addr
, c
->code
);
1525 usb_mtp_queue_result(s
, RES_OPERATION_NOT_SUPPORTED
,
1526 c
->trans
, 0, 0, 0, 0);
1530 /* return results on success */
1532 assert(s
->data_in
== NULL
);
1533 s
->data_in
= data_in
;
1535 usb_mtp_queue_result(s
, RES_OK
, c
->trans
, nres
, res0
, 0, 0);
1538 /* ----------------------------------------------------------------------- */
1540 static void usb_mtp_handle_reset(USBDevice
*dev
)
1542 MTPState
*s
= USB_MTP(dev
);
1544 trace_usb_mtp_reset(s
->dev
.addr
);
1546 #ifdef CONFIG_INOTIFY1
1547 usb_mtp_inotify_cleanup(s
);
1549 usb_mtp_object_free(s
, QTAILQ_FIRST(&s
->objects
));
1551 usb_mtp_data_free(s
->data_in
);
1553 usb_mtp_data_free(s
->data_out
);
1559 static void usb_mtp_handle_control(USBDevice
*dev
, USBPacket
*p
,
1560 int request
, int value
, int index
,
1561 int length
, uint8_t *data
)
1564 MTPState
*s
= USB_MTP(dev
);
1565 uint16_t *event
= (uint16_t *)data
;
1568 case ClassInterfaceOutRequest
| 0x64:
1569 if (*event
== EVT_CANCEL_TRANSACTION
) {
1572 usb_mtp_data_free(s
->data_in
);
1574 if (s
->write_pending
) {
1575 g_free(s
->dataset
.filename
);
1576 s
->write_pending
= false;
1577 s
->dataset
.size
= 0;
1579 usb_mtp_data_free(s
->data_out
);
1582 p
->status
= USB_RET_STALL
;
1586 ret
= usb_desc_handle_control(dev
, p
, request
,
1587 value
, index
, length
, data
);
1593 trace_usb_mtp_stall(dev
->addr
, "unknown control request");
1596 static void usb_mtp_cancel_packet(USBDevice
*dev
, USBPacket
*p
)
1598 /* we don't use async packets, so this should never be called */
1599 fprintf(stderr
, "%s\n", __func__
);
1602 static char *utf16_to_str(uint8_t len
, uint16_t *arr
)
1604 wchar_t *wstr
= g_new0(wchar_t, len
+ 1);
1608 for (count
= 0; count
< len
; count
++) {
1609 /* FIXME: not working for surrogate pairs */
1610 wstr
[count
] = (wchar_t)arr
[count
];
1614 dlen
= wcstombs(NULL
, wstr
, 0) + 1;
1615 dest
= g_malloc(dlen
);
1616 wcstombs(dest
, wstr
, dlen
);
1621 /* Wrapper around write, returns 0 on failure */
1622 static uint64_t write_retry(int fd
, void *buf
, uint64_t size
)
1624 uint64_t bytes_left
= size
, ret
;
1626 while (bytes_left
> 0) {
1627 ret
= write(fd
, buf
, bytes_left
);
1628 if ((ret
== -1) && (errno
!= EINTR
|| errno
!= EAGAIN
||
1629 errno
!= EWOULDBLOCK
)) {
1636 return size
- bytes_left
;
1639 static void usb_mtp_write_data(MTPState
*s
)
1641 MTPData
*d
= s
->data_out
;
1643 usb_mtp_object_lookup(s
, s
->dataset
.parent_handle
);
1650 if (parent
== NULL
|| !s
->write_pending
) {
1651 usb_mtp_queue_result(s
, RES_INVALID_OBJECTINFO
, d
->trans
,
1656 if (s
->dataset
.filename
) {
1657 path
= g_strdup_printf("%s/%s", parent
->path
, s
->dataset
.filename
);
1658 if (s
->dataset
.format
== FMT_ASSOCIATION
) {
1659 d
->fd
= mkdir(path
, mask
);
1662 if ((s
->dataset
.size
!= 0xFFFFFFFF) && (s
->dataset
.size
< d
->length
)) {
1663 usb_mtp_queue_result(s
, RES_STORE_FULL
, d
->trans
,
1667 d
->fd
= open(path
, O_CREAT
| O_WRONLY
| O_CLOEXEC
| O_NOFOLLOW
, mask
);
1669 usb_mtp_queue_result(s
, RES_STORE_FULL
, d
->trans
,
1675 * Return success if initiator sent 0 sized data
1677 if (!s
->dataset
.size
) {
1681 rc
= write_retry(d
->fd
, d
->data
, d
->offset
);
1682 if (rc
!= d
->offset
) {
1683 usb_mtp_queue_result(s
, RES_STORE_FULL
, d
->trans
,
1687 /* Only for < 4G file sizes */
1688 if (s
->dataset
.size
!= 0xFFFFFFFF && rc
!= s
->dataset
.size
) {
1689 usb_mtp_queue_result(s
, RES_INCOMPLETE_TRANSFER
, d
->trans
,
1696 usb_mtp_queue_result(s
, RES_OK
, d
->trans
,
1701 * The write dataset is kept around and freed only
1702 * on success or if another write request comes in
1708 g_free(s
->dataset
.filename
);
1709 s
->dataset
.size
= 0;
1711 s
->write_pending
= false;
1714 static void usb_mtp_write_metadata(MTPState
*s
, uint64_t dlen
)
1716 MTPData
*d
= s
->data_out
;
1717 ObjectInfo
*dataset
= (ObjectInfo
*)d
->data
;
1720 MTPObject
*p
= usb_mtp_object_lookup(s
, s
->dataset
.parent_handle
);
1721 uint32_t next_handle
= s
->next_handle
;
1723 assert(!s
->write_pending
);
1726 filename
= utf16_to_str(MIN(dataset
->length
,
1727 dlen
- offsetof(ObjectInfo
, filename
)),
1730 if (strchr(filename
, '/')) {
1731 usb_mtp_queue_result(s
, RES_PARAMETER_NOT_SUPPORTED
, d
->trans
,
1737 o
= usb_mtp_object_lookup_name(p
, filename
, dataset
->length
);
1739 next_handle
= o
->handle
;
1742 s
->dataset
.filename
= filename
;
1743 s
->dataset
.format
= dataset
->format
;
1744 s
->dataset
.size
= dataset
->size
;
1745 s
->write_pending
= true;
1747 if (s
->dataset
.format
== FMT_ASSOCIATION
) {
1748 usb_mtp_write_data(s
);
1749 /* next_handle will be allocated to the newly created dir */
1751 usb_mtp_queue_result(s
, RES_STORE_FULL
, d
->trans
,
1758 usb_mtp_queue_result(s
, RES_OK
, d
->trans
, 3, QEMU_STORAGE_ID
,
1759 s
->dataset
.parent_handle
, next_handle
);
1762 static void usb_mtp_get_data(MTPState
*s
, mtp_container
*container
,
1765 MTPData
*d
= s
->data_out
;
1767 uint32_t data_len
= p
->iov
.size
;
1771 usb_mtp_queue_result(s
, RES_INVALID_OBJECTINFO
, 0,
1776 /* Total length of incoming data */
1777 total_len
= cpu_to_le32(container
->length
) - sizeof(mtp_container
);
1778 /* Length of data in this packet */
1779 data_len
-= sizeof(mtp_container
);
1780 usb_mtp_realloc(d
, total_len
);
1781 d
->length
+= total_len
;
1783 d
->cached_length
= total_len
;
1789 usb_mtp_realloc(d
, d
->cached_length
);
1790 d
->length
+= d
->cached_length
;
1794 if (d
->length
- d
->offset
> data_len
) {
1797 dlen
= d
->length
- d
->offset
;
1798 /* Check for cached data for large files */
1799 if ((s
->dataset
.size
== 0xFFFFFFFF) && (dlen
< p
->iov
.size
)) {
1800 usb_mtp_realloc(d
, p
->iov
.size
- dlen
);
1801 d
->length
+= p
->iov
.size
- dlen
;
1807 case CMD_SEND_OBJECT_INFO
:
1808 usb_packet_copy(p
, d
->data
+ d
->offset
, dlen
);
1810 if (d
->offset
== d
->length
) {
1811 /* The operation might have already failed */
1813 usb_mtp_write_metadata(s
, dlen
);
1815 usb_mtp_data_free(s
->data_out
);
1820 case CMD_SEND_OBJECT
:
1821 usb_packet_copy(p
, d
->data
+ d
->offset
, dlen
);
1823 if ((p
->iov
.size
% 64) || !p
->iov
.size
) {
1824 assert((s
->dataset
.size
== 0xFFFFFFFF) ||
1825 (s
->dataset
.size
== d
->length
));
1827 usb_mtp_write_data(s
);
1828 usb_mtp_data_free(s
->data_out
);
1832 if (d
->offset
== d
->length
) {
1837 p
->status
= USB_RET_STALL
;
1842 static void usb_mtp_handle_data(USBDevice
*dev
, USBPacket
*p
)
1844 MTPState
*s
= USB_MTP(dev
);
1846 mtp_container container
;
1848 uint16_t container_type
;
1851 switch (p
->ep
->nr
) {
1853 if (s
->data_out
!= NULL
) {
1855 trace_usb_mtp_stall(s
->dev
.addr
, "awaiting data-out");
1856 p
->status
= USB_RET_STALL
;
1859 if (p
->iov
.size
< sizeof(container
)) {
1860 trace_usb_mtp_stall(s
->dev
.addr
, "packet too small");
1861 p
->status
= USB_RET_STALL
;
1864 if (s
->data_in
!= NULL
) {
1865 MTPData
*d
= s
->data_in
;
1866 uint64_t dlen
= d
->length
- d
->offset
;
1868 trace_usb_mtp_data_in(s
->dev
.addr
, d
->trans
, d
->length
);
1869 if (d
->length
+ sizeof(container
) > 0xFFFFFFFF) {
1870 container
.length
= cpu_to_le32(0xFFFFFFFF);
1873 cpu_to_le32(d
->length
+ sizeof(container
));
1875 container
.type
= cpu_to_le16(TYPE_DATA
);
1876 container
.code
= cpu_to_le16(d
->code
);
1877 container
.trans
= cpu_to_le32(d
->trans
);
1878 usb_packet_copy(p
, &container
, sizeof(container
));
1880 if (dlen
> p
->iov
.size
- sizeof(container
)) {
1881 dlen
= p
->iov
.size
- sizeof(container
);
1884 if (dlen
> p
->iov
.size
) {
1889 usb_packet_copy(p
, d
->data
+ d
->offset
, dlen
);
1891 if (d
->alloc
< p
->iov
.size
) {
1892 d
->alloc
= p
->iov
.size
;
1893 d
->data
= g_realloc(d
->data
, d
->alloc
);
1895 rc
= read(d
->fd
, d
->data
, dlen
);
1897 memset(d
->data
, 0, dlen
);
1898 s
->result
->code
= RES_INCOMPLETE_TRANSFER
;
1900 usb_packet_copy(p
, d
->data
, dlen
);
1903 if (d
->offset
== d
->length
) {
1904 usb_mtp_data_free(s
->data_in
);
1907 } else if (s
->result
!= NULL
) {
1908 MTPControl
*r
= s
->result
;
1909 int length
= sizeof(container
) + r
->argc
* sizeof(uint32_t);
1910 if (r
->code
== RES_OK
) {
1911 trace_usb_mtp_success(s
->dev
.addr
, r
->trans
,
1912 (r
->argc
> 0) ? r
->argv
[0] : 0,
1913 (r
->argc
> 1) ? r
->argv
[1] : 0);
1915 trace_usb_mtp_error(s
->dev
.addr
, r
->code
, r
->trans
,
1916 (r
->argc
> 0) ? r
->argv
[0] : 0,
1917 (r
->argc
> 1) ? r
->argv
[1] : 0);
1919 container
.length
= cpu_to_le32(length
);
1920 container
.type
= cpu_to_le16(TYPE_RESPONSE
);
1921 container
.code
= cpu_to_le16(r
->code
);
1922 container
.trans
= cpu_to_le32(r
->trans
);
1923 for (i
= 0; i
< r
->argc
; i
++) {
1924 params
[i
] = cpu_to_le32(r
->argv
[i
]);
1926 usb_packet_copy(p
, &container
, sizeof(container
));
1927 usb_packet_copy(p
, ¶ms
, length
- sizeof(container
));
1933 if (p
->iov
.size
< sizeof(container
)) {
1934 trace_usb_mtp_stall(s
->dev
.addr
, "packet too small");
1935 p
->status
= USB_RET_STALL
;
1938 if ((s
->data_out
!= NULL
) && !s
->data_out
->first
) {
1939 container_type
= TYPE_DATA
;
1941 usb_packet_copy(p
, &container
, sizeof(container
));
1942 container_type
= le16_to_cpu(container
.type
);
1944 switch (container_type
) {
1946 if (s
->data_in
|| s
->data_out
|| s
->result
) {
1947 trace_usb_mtp_stall(s
->dev
.addr
, "transaction inflight");
1948 p
->status
= USB_RET_STALL
;
1951 cmd
.code
= le16_to_cpu(container
.code
);
1952 cmd
.argc
= (le32_to_cpu(container
.length
) - sizeof(container
))
1954 cmd
.trans
= le32_to_cpu(container
.trans
);
1955 if (cmd
.argc
> ARRAY_SIZE(cmd
.argv
)) {
1956 cmd
.argc
= ARRAY_SIZE(cmd
.argv
);
1958 if (p
->iov
.size
< sizeof(container
) + cmd
.argc
* sizeof(uint32_t)) {
1959 trace_usb_mtp_stall(s
->dev
.addr
, "packet too small");
1960 p
->status
= USB_RET_STALL
;
1963 usb_packet_copy(p
, ¶ms
, cmd
.argc
* sizeof(uint32_t));
1964 for (i
= 0; i
< cmd
.argc
; i
++) {
1965 cmd
.argv
[i
] = le32_to_cpu(params
[i
]);
1967 trace_usb_mtp_command(s
->dev
.addr
, cmd
.code
, cmd
.trans
,
1968 (cmd
.argc
> 0) ? cmd
.argv
[0] : 0,
1969 (cmd
.argc
> 1) ? cmd
.argv
[1] : 0,
1970 (cmd
.argc
> 2) ? cmd
.argv
[2] : 0,
1971 (cmd
.argc
> 3) ? cmd
.argv
[3] : 0,
1972 (cmd
.argc
> 4) ? cmd
.argv
[4] : 0);
1973 usb_mtp_command(s
, &cmd
);
1976 /* One of the previous transfers has already errored but the
1977 * responder is still sending data associated with it
1979 if (s
->result
!= NULL
) {
1982 usb_mtp_get_data(s
, &container
, p
);
1985 /* not needed as long as the mtp device is read-only */
1986 p
->status
= USB_RET_STALL
;
1991 #ifdef CONFIG_INOTIFY1
1992 if (!QTAILQ_EMPTY(&s
->events
)) {
1993 struct MTPMonEntry
*e
= QTAILQ_LAST(&s
->events
);
1995 int len
= sizeof(container
) + sizeof(uint32_t);
1997 if (p
->iov
.size
< len
) {
1998 trace_usb_mtp_stall(s
->dev
.addr
,
1999 "packet too small to send event");
2000 p
->status
= USB_RET_STALL
;
2004 QTAILQ_REMOVE(&s
->events
, e
, next
);
2005 container
.length
= cpu_to_le32(len
);
2006 container
.type
= cpu_to_le32(TYPE_EVENT
);
2007 container
.code
= cpu_to_le16(e
->event
);
2008 container
.trans
= 0; /* no trans specific events */
2009 handle
= cpu_to_le32(e
->handle
);
2010 usb_packet_copy(p
, &container
, sizeof(container
));
2011 usb_packet_copy(p
, &handle
, sizeof(uint32_t));
2016 p
->status
= USB_RET_NAK
;
2019 trace_usb_mtp_stall(s
->dev
.addr
, "invalid endpoint");
2020 p
->status
= USB_RET_STALL
;
2024 if (p
->actual_length
== 0) {
2025 trace_usb_mtp_nak(s
->dev
.addr
, p
->ep
->nr
);
2026 p
->status
= USB_RET_NAK
;
2029 trace_usb_mtp_xfer(s
->dev
.addr
, p
->ep
->nr
, p
->actual_length
,
2035 static void usb_mtp_realize(USBDevice
*dev
, Error
**errp
)
2037 MTPState
*s
= USB_MTP(dev
);
2039 usb_desc_create_serial(dev
);
2041 QTAILQ_INIT(&s
->objects
);
2042 if (s
->desc
== NULL
) {
2043 if (s
->root
== NULL
) {
2044 error_setg(errp
, "usb-mtp: rootdir property must be configured");
2047 s
->desc
= strrchr(s
->root
, '/');
2048 if (s
->desc
&& s
->desc
[0]) {
2049 s
->desc
= g_strdup(s
->desc
+ 1);
2051 s
->desc
= g_strdup("none");
2054 /* Mark store as RW */
2056 s
->flags
|= (1 << MTP_FLAG_WRITABLE
);
2061 static const VMStateDescription vmstate_usb_mtp
= {
2065 .minimum_version_id
= 1,
2066 .fields
= (VMStateField
[]) {
2067 VMSTATE_USB_DEVICE(dev
, MTPState
),
2068 VMSTATE_END_OF_LIST()
2072 static Property mtp_properties
[] = {
2073 DEFINE_PROP_STRING("rootdir", MTPState
, root
),
2074 DEFINE_PROP_STRING("desc", MTPState
, desc
),
2075 DEFINE_PROP_BOOL("readonly", MTPState
, readonly
, true),
2076 DEFINE_PROP_END_OF_LIST(),
2079 static void usb_mtp_class_initfn(ObjectClass
*klass
, void *data
)
2081 DeviceClass
*dc
= DEVICE_CLASS(klass
);
2082 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
2084 uc
->realize
= usb_mtp_realize
;
2085 uc
->product_desc
= "QEMU USB MTP";
2086 uc
->usb_desc
= &desc
;
2087 uc
->cancel_packet
= usb_mtp_cancel_packet
;
2088 uc
->handle_attach
= usb_desc_attach
;
2089 uc
->handle_reset
= usb_mtp_handle_reset
;
2090 uc
->handle_control
= usb_mtp_handle_control
;
2091 uc
->handle_data
= usb_mtp_handle_data
;
2092 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
2093 dc
->desc
= "USB Media Transfer Protocol device";
2094 dc
->fw_name
= "mtp";
2095 dc
->vmsd
= &vmstate_usb_mtp
;
2096 dc
->props
= mtp_properties
;
2099 static TypeInfo mtp_info
= {
2100 .name
= TYPE_USB_MTP
,
2101 .parent
= TYPE_USB_DEVICE
,
2102 .instance_size
= sizeof(MTPState
),
2103 .class_init
= usb_mtp_class_initfn
,
2106 static void usb_mtp_register_types(void)
2108 type_register_static(&mtp_info
);
2111 type_init(usb_mtp_register_types
)