]> git.proxmox.com Git - mirror_qemu.git/blob - hw/usb/dev-mtp.c
projects / mirror_qemu.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
usb-mtp: free objects on a mtp reset
[mirror_qemu.git] / hw / usb / dev-mtp.c
1 /*
2 * Media Transfer Protocol implementation, backed by host filesystem.
3 *
4 * Copyright Red Hat, Inc 2014
5 *
6 * Author:
7 * Gerd Hoffmann <kraxel@redhat.com>
8 *
9 * This code is licensed under the GPL v2 or later.
10 */
11
12 #include <wchar.h>
13 #include <dirent.h>
14 #include <unistd.h>
15
16 #include <sys/stat.h>
17 #include <sys/statvfs.h>
18
19 #include "qemu-common.h"
20 #include "qemu/iov.h"
21 #include "trace.h"
22 #include "hw/usb.h"
23 #include "hw/usb/desc.h"
24
25 /* ----------------------------------------------------------------------- */
26
27 enum mtp_container_type {
28 TYPE_COMMAND = 1,
29 TYPE_DATA = 2,
30 TYPE_RESPONSE = 3,
31 TYPE_EVENT = 4,
32 };
33
34 enum mtp_code {
35 /* command codes */
36 CMD_GET_DEVICE_INFO = 0x1001,
37 CMD_OPEN_SESSION = 0x1002,
38 CMD_CLOSE_SESSION = 0x1003,
39 CMD_GET_STORAGE_IDS = 0x1004,
40 CMD_GET_STORAGE_INFO = 0x1005,
41 CMD_GET_NUM_OBJECTS = 0x1006,
42 CMD_GET_OBJECT_HANDLES = 0x1007,
43 CMD_GET_OBJECT_INFO = 0x1008,
44 CMD_GET_OBJECT = 0x1009,
45 CMD_GET_PARTIAL_OBJECT = 0x101b,
46
47 /* response codes */
48 RES_OK = 0x2001,
49 RES_GENERAL_ERROR = 0x2002,
50 RES_SESSION_NOT_OPEN = 0x2003,
51 RES_INVALID_TRANSACTION_ID = 0x2004,
52 RES_OPERATION_NOT_SUPPORTED = 0x2005,
53 RES_PARAMETER_NOT_SUPPORTED = 0x2006,
54 RES_INCOMPLETE_TRANSFER = 0x2007,
55 RES_INVALID_STORAGE_ID = 0x2008,
56 RES_INVALID_OBJECT_HANDLE = 0x2009,
57 RES_SPEC_BY_FORMAT_UNSUPPORTED = 0x2014,
58 RES_INVALID_PARENT_OBJECT = 0x201a,
59 RES_INVALID_PARAMETER = 0x201d,
60 RES_SESSION_ALREADY_OPEN = 0x201e,
61
62 /* format codes */
63 FMT_UNDEFINED_OBJECT = 0x3000,
64 FMT_ASSOCIATION = 0x3001,
65 };
66
67 typedef struct {
68 uint32_t length;
69 uint16_t type;
70 uint16_t code;
71 uint32_t trans;
72 } QEMU_PACKED mtp_container;
73
74 /* ----------------------------------------------------------------------- */
75
76 typedef struct MTPState MTPState;
77 typedef struct MTPControl MTPControl;
78 typedef struct MTPData MTPData;
79 typedef struct MTPObject MTPObject;
80
81 enum {
82 EP_DATA_IN = 1,
83 EP_DATA_OUT,
84 EP_EVENT,
85 };
86
87 struct MTPControl {
88 uint16_t code;
89 uint32_t trans;
90 int argc;
91 uint32_t argv[5];
92 };
93
94 struct MTPData {
95 uint16_t code;
96 uint32_t trans;
97 uint32_t offset;
98 uint32_t length;
99 uint32_t alloc;
100 uint8_t *data;
101 bool first;
102 int fd;
103 };
104
105 struct MTPObject {
106 uint32_t handle;
107 uint16_t format;
108 char *name;
109 char *path;
110 struct stat stat;
111 MTPObject *parent;
112 uint32_t nchildren;
113 QLIST_HEAD(, MTPObject) children;
114 QLIST_ENTRY(MTPObject) list;
115 bool have_children;
116 QTAILQ_ENTRY(MTPObject) next;
117 };
118
119 struct MTPState {
120 USBDevice dev;
121 char *root;
122 char *desc;
123 uint32_t flags;
124
125 MTPData *data_in;
126 MTPData *data_out;
127 MTPControl *result;
128 uint32_t session;
129 uint32_t next_handle;
130
131 QTAILQ_HEAD(, MTPObject) objects;
132 };
133
134 #define TYPE_USB_MTP "usb-mtp"
135 #define USB_MTP(obj) OBJECT_CHECK(MTPState, (obj), TYPE_USB_MTP)
136
137 #define QEMU_STORAGE_ID 0x00010001
138
139 #define MTP_FLAG_WRITABLE 0
140
141 #define FLAG_SET(_mtp, _flag) ((_mtp)->flags & (1 << (_flag)))
142
143 /* ----------------------------------------------------------------------- */
144
145 #define MTP_MANUFACTURER "QEMU"
146 #define MTP_PRODUCT "QEMU filesharing"
147
148 enum {
149 STR_MANUFACTURER = 1,
150 STR_PRODUCT,
151 STR_SERIALNUMBER,
152 STR_MTP,
153 STR_CONFIG_FULL,
154 STR_CONFIG_HIGH,
155 STR_CONFIG_SUPER,
156 };
157
158 static const USBDescStrings desc_strings = {
159 [STR_MANUFACTURER] = MTP_MANUFACTURER,
160 [STR_PRODUCT] = MTP_PRODUCT,
161 [STR_SERIALNUMBER] = "34617",
162 [STR_MTP] = "MTP",
163 [STR_CONFIG_FULL] = "Full speed config (usb 1.1)",
164 [STR_CONFIG_HIGH] = "High speed config (usb 2.0)",
165 [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
166 };
167
168 static const USBDescIface desc_iface_full = {
169 .bInterfaceNumber = 0,
170 .bNumEndpoints = 3,
171 .bInterfaceClass = USB_CLASS_STILL_IMAGE,
172 .bInterfaceSubClass = 0x01,
173 .bInterfaceProtocol = 0x01,
174 .iInterface = STR_MTP,
175 .eps = (USBDescEndpoint[]) {
176 {
177 .bEndpointAddress = USB_DIR_IN | EP_DATA_IN,
178 .bmAttributes = USB_ENDPOINT_XFER_BULK,
179 .wMaxPacketSize = 64,
180 },{
181 .bEndpointAddress = USB_DIR_OUT | EP_DATA_OUT,
182 .bmAttributes = USB_ENDPOINT_XFER_BULK,
183 .wMaxPacketSize = 64,
184 },{
185 .bEndpointAddress = USB_DIR_IN | EP_EVENT,
186 .bmAttributes = USB_ENDPOINT_XFER_INT,
187 .wMaxPacketSize = 8,
188 .bInterval = 0x0a,
189 },
190 }
191 };
192
193 static const USBDescDevice desc_device_full = {
194 .bcdUSB = 0x0200,
195 .bMaxPacketSize0 = 8,
196 .bNumConfigurations = 1,
197 .confs = (USBDescConfig[]) {
198 {
199 .bNumInterfaces = 1,
200 .bConfigurationValue = 1,
201 .iConfiguration = STR_CONFIG_FULL,
202 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
203 .bMaxPower = 2,
204 .nif = 1,
205 .ifs = &desc_iface_full,
206 },
207 },
208 };
209
210 static const USBDescIface desc_iface_high = {
211 .bInterfaceNumber = 0,
212 .bNumEndpoints = 3,
213 .bInterfaceClass = USB_CLASS_STILL_IMAGE,
214 .bInterfaceSubClass = 0x01,
215 .bInterfaceProtocol = 0x01,
216 .iInterface = STR_MTP,
217 .eps = (USBDescEndpoint[]) {
218 {
219 .bEndpointAddress = USB_DIR_IN | EP_DATA_IN,
220 .bmAttributes = USB_ENDPOINT_XFER_BULK,
221 .wMaxPacketSize = 512,
222 },{
223 .bEndpointAddress = USB_DIR_OUT | EP_DATA_OUT,
224 .bmAttributes = USB_ENDPOINT_XFER_BULK,
225 .wMaxPacketSize = 512,
226 },{
227 .bEndpointAddress = USB_DIR_IN | EP_EVENT,
228 .bmAttributes = USB_ENDPOINT_XFER_INT,
229 .wMaxPacketSize = 8,
230 .bInterval = 0x0a,
231 },
232 }
233 };
234
235 static const USBDescDevice desc_device_high = {
236 .bcdUSB = 0x0200,
237 .bMaxPacketSize0 = 64,
238 .bNumConfigurations = 1,
239 .confs = (USBDescConfig[]) {
240 {
241 .bNumInterfaces = 1,
242 .bConfigurationValue = 1,
243 .iConfiguration = STR_CONFIG_HIGH,
244 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
245 .bMaxPower = 2,
246 .nif = 1,
247 .ifs = &desc_iface_high,
248 },
249 },
250 };
251
252 static const USBDescMSOS desc_msos = {
253 .CompatibleID = "MTP",
254 .SelectiveSuspendEnabled = true,
255 };
256
257 static const USBDesc desc = {
258 .id = {
259 .idVendor = 0x46f4, /* CRC16() of "QEMU" */
260 .idProduct = 0x0004,
261 .bcdDevice = 0,
262 .iManufacturer = STR_MANUFACTURER,
263 .iProduct = STR_PRODUCT,
264 .iSerialNumber = STR_SERIALNUMBER,
265 },
266 .full = &desc_device_full,
267 .high = &desc_device_high,
268 .str = desc_strings,
269 .msos = &desc_msos,
270 };
271
272 /* ----------------------------------------------------------------------- */
273
274 static MTPObject *usb_mtp_object_alloc(MTPState *s, uint32_t handle,
275 MTPObject *parent, char *name)
276 {
277 MTPObject *o = g_new0(MTPObject, 1);
278
279 if (name[0] == '.') {
280 goto ignore;
281 }
282
283 o->handle = handle;
284 o->parent = parent;
285 o->name = g_strdup(name);
286 if (parent == NULL) {
287 o->path = g_strdup(name);
288 } else {
289 o->path = g_strdup_printf("%s/%s", parent->path, name);
290 }
291
292 if (lstat(o->path, &o->stat) != 0) {
293 goto ignore;
294 }
295 if (S_ISREG(o->stat.st_mode)) {
296 o->format = FMT_UNDEFINED_OBJECT;
297 } else if (S_ISDIR(o->stat.st_mode)) {
298 o->format = FMT_ASSOCIATION;
299 } else {
300 goto ignore;
301 }
302
303 if (access(o->path, R_OK) != 0) {
304 goto ignore;
305 }
306
307 trace_usb_mtp_object_alloc(s->dev.addr, o->handle, o->path);
308
309 QTAILQ_INSERT_TAIL(&s->objects, o, next);
310 return o;
311
312 ignore:
313 g_free(o->name);
314 g_free(o->path);
315 g_free(o);
316 return NULL;
317 }
318
319 static void usb_mtp_object_free(MTPState *s, MTPObject *o)
320 {
321 MTPObject *iter;
322
323 if (!o) {
324 return;
325 }
326
327 trace_usb_mtp_object_free(s->dev.addr, o->handle, o->path);
328
329 QTAILQ_REMOVE(&s->objects, o, next);
330 if (o->parent) {
331 QLIST_REMOVE(o, list);
332 o->parent->nchildren--;
333 }
334
335 while (!QLIST_EMPTY(&o->children)) {
336 iter = QLIST_FIRST(&o->children);
337 usb_mtp_object_free(s, iter);
338 }
339 g_free(o->name);
340 g_free(o->path);
341 g_free(o);
342 }
343
344 static MTPObject *usb_mtp_object_lookup(MTPState *s, uint32_t handle)
345 {
346 MTPObject *o;
347
348 QTAILQ_FOREACH(o, &s->objects, next) {
349 if (o->handle == handle) {
350 return o;
351 }
352 }
353 return NULL;
354 }
355
356 static MTPObject *usb_mtp_add_child(MTPState *s, MTPObject *o,
357 char *name)
358 {
359 MTPObject *child =
360 usb_mtp_object_alloc(s, s->next_handle++, o, name);
361
362 if (child) {
363 trace_usb_mtp_add_child(s->dev.addr, child->handle, child->path);
364 QLIST_INSERT_HEAD(&o->children, child, list);
365 o->nchildren++;
366
367 if (child->format == FMT_ASSOCIATION) {
368 QLIST_INIT(&child->children);
369 }
370 }
371
372 return child;
373 }
374
375 static void usb_mtp_object_readdir(MTPState *s, MTPObject *o)
376 {
377 struct dirent *entry;
378 DIR *dir;
379
380 if (o->have_children) {
381 return;
382 }
383 o->have_children = true;
384
385 dir = opendir(o->path);
386 if (!dir) {
387 return;
388 }
389 while ((entry = readdir(dir)) != NULL) {
390 usb_mtp_add_child(s, o, entry->d_name);
391 }
392 closedir(dir);
393 }
394
395 /* ----------------------------------------------------------------------- */
396
397 static MTPData *usb_mtp_data_alloc(MTPControl *c)
398 {
399 MTPData *data = g_new0(MTPData, 1);
400
401 data->code = c->code;
402 data->trans = c->trans;
403 data->fd = -1;
404 data->first = true;
405 return data;
406 }
407
408 static void usb_mtp_data_free(MTPData *data)
409 {
410 if (data == NULL) {
411 return;
412 }
413 if (data->fd != -1) {
414 close(data->fd);
415 }
416 g_free(data->data);
417 g_free(data);
418 }
419
420 static void usb_mtp_realloc(MTPData *data, uint32_t bytes)
421 {
422 if (data->length + bytes <= data->alloc) {
423 return;
424 }
425 data->alloc = (data->length + bytes + 0xff) & ~0xff;
426 data->data = g_realloc(data->data, data->alloc);
427 }
428
429 static void usb_mtp_add_u8(MTPData *data, uint8_t val)
430 {
431 usb_mtp_realloc(data, 1);
432 data->data[data->length++] = val;
433 }
434
435 static void usb_mtp_add_u16(MTPData *data, uint16_t val)
436 {
437 usb_mtp_realloc(data, 2);
438 data->data[data->length++] = (val >> 0) & 0xff;
439 data->data[data->length++] = (val >> 8) & 0xff;
440 }
441
442 static void usb_mtp_add_u32(MTPData *data, uint32_t val)
443 {
444 usb_mtp_realloc(data, 4);
445 data->data[data->length++] = (val >> 0) & 0xff;
446 data->data[data->length++] = (val >> 8) & 0xff;
447 data->data[data->length++] = (val >> 16) & 0xff;
448 data->data[data->length++] = (val >> 24) & 0xff;
449 }
450
451 static void usb_mtp_add_u64(MTPData *data, uint64_t val)
452 {
453 usb_mtp_realloc(data, 8);
454 data->data[data->length++] = (val >> 0) & 0xff;
455 data->data[data->length++] = (val >> 8) & 0xff;
456 data->data[data->length++] = (val >> 16) & 0xff;
457 data->data[data->length++] = (val >> 24) & 0xff;
458 data->data[data->length++] = (val >> 32) & 0xff;
459 data->data[data->length++] = (val >> 40) & 0xff;
460 data->data[data->length++] = (val >> 48) & 0xff;
461 data->data[data->length++] = (val >> 56) & 0xff;
462 }
463
464 static void usb_mtp_add_u16_array(MTPData *data, uint32_t len,
465 const uint16_t *vals)
466 {
467 int i;
468
469 usb_mtp_add_u32(data, len);
470 for (i = 0; i < len; i++) {
471 usb_mtp_add_u16(data, vals[i]);
472 }
473 }
474
475 static void usb_mtp_add_u32_array(MTPData *data, uint32_t len,
476 const uint32_t *vals)
477 {
478 int i;
479
480 usb_mtp_add_u32(data, len);
481 for (i = 0; i < len; i++) {
482 usb_mtp_add_u32(data, vals[i]);
483 }
484 }
485
486 static void usb_mtp_add_wstr(MTPData *data, const wchar_t *str)
487 {
488 uint32_t len = wcslen(str);
489 int i;
490
491 if (len > 0) {
492 len++; /* include terminating L'\0' */
493 }
494
495 usb_mtp_add_u8(data, len);
496 for (i = 0; i < len; i++) {
497 usb_mtp_add_u16(data, str[i]);
498 }
499 }
500
501 static void usb_mtp_add_str(MTPData *data, const char *str)
502 {
503 uint32_t len = strlen(str)+1;
504 wchar_t wstr[len];
505 size_t ret;
506
507 ret = mbstowcs(wstr, str, len);
508 if (ret == -1) {
509 usb_mtp_add_wstr(data, L"Oops");
510 } else {
511 usb_mtp_add_wstr(data, wstr);
512 }
513 }
514
515 static void usb_mtp_add_time(MTPData *data, time_t time)
516 {
517 char buf[16];
518 struct tm tm;
519
520 gmtime_r(&time, &tm);
521 strftime(buf, sizeof(buf), "%Y%m%dT%H%M%S", &tm);
522 usb_mtp_add_str(data, buf);
523 }
524
525 /* ----------------------------------------------------------------------- */
526
527 static void usb_mtp_queue_result(MTPState *s, uint16_t code, uint32_t trans,
528 int argc, uint32_t arg0, uint32_t arg1)
529 {
530 MTPControl *c = g_new0(MTPControl, 1);
531
532 c->code = code;
533 c->trans = trans;
534 c->argc = argc;
535 if (argc > 0) {
536 c->argv[0] = arg0;
537 }
538 if (argc > 1) {
539 c->argv[1] = arg1;
540 }
541
542 assert(s->result == NULL);
543 s->result = c;
544 }
545
546 /* ----------------------------------------------------------------------- */
547
548 static MTPData *usb_mtp_get_device_info(MTPState *s, MTPControl *c)
549 {
550 static const uint16_t ops[] = {
551 CMD_GET_DEVICE_INFO,
552 CMD_OPEN_SESSION,
553 CMD_CLOSE_SESSION,
554 CMD_GET_STORAGE_IDS,
555 CMD_GET_STORAGE_INFO,
556 CMD_GET_NUM_OBJECTS,
557 CMD_GET_OBJECT_HANDLES,
558 CMD_GET_OBJECT_INFO,
559 CMD_GET_OBJECT,
560 CMD_GET_PARTIAL_OBJECT,
561 };
562 static const uint16_t fmt[] = {
563 FMT_UNDEFINED_OBJECT,
564 FMT_ASSOCIATION,
565 };
566 MTPData *d = usb_mtp_data_alloc(c);
567
568 trace_usb_mtp_op_get_device_info(s->dev.addr);
569
570 usb_mtp_add_u16(d, 100);
571 usb_mtp_add_u32(d, 0xffffffff);
572 usb_mtp_add_u16(d, 0x0101);
573 usb_mtp_add_wstr(d, L"");
574 usb_mtp_add_u16(d, 0x0000);
575
576 usb_mtp_add_u16_array(d, ARRAY_SIZE(ops), ops);
577 usb_mtp_add_u16_array(d, 0, NULL);
578 usb_mtp_add_u16_array(d, 0, NULL);
579 usb_mtp_add_u16_array(d, 0, NULL);
580 usb_mtp_add_u16_array(d, ARRAY_SIZE(fmt), fmt);
581
582 usb_mtp_add_wstr(d, L"" MTP_MANUFACTURER);
583 usb_mtp_add_wstr(d, L"" MTP_PRODUCT);
584 usb_mtp_add_wstr(d, L"0.1");
585 usb_mtp_add_wstr(d, L"0123456789abcdef0123456789abcdef");
586
587 return d;
588 }
589
590 static MTPData *usb_mtp_get_storage_ids(MTPState *s, MTPControl *c)
591 {
592 static const uint32_t ids[] = {
593 QEMU_STORAGE_ID,
594 };
595 MTPData *d = usb_mtp_data_alloc(c);
596
597 trace_usb_mtp_op_get_storage_ids(s->dev.addr);
598
599 usb_mtp_add_u32_array(d, ARRAY_SIZE(ids), ids);
600
601 return d;
602 }
603
604 static MTPData *usb_mtp_get_storage_info(MTPState *s, MTPControl *c)
605 {
606 MTPData *d = usb_mtp_data_alloc(c);
607 struct statvfs buf;
608 int rc;
609
610 trace_usb_mtp_op_get_storage_info(s->dev.addr);
611
612 if (FLAG_SET(s, MTP_FLAG_WRITABLE)) {
613 usb_mtp_add_u16(d, 0x0003);
614 usb_mtp_add_u16(d, 0x0002);
615 usb_mtp_add_u16(d, 0x0000);
616 } else {
617 usb_mtp_add_u16(d, 0x0001);
618 usb_mtp_add_u16(d, 0x0002);
619 usb_mtp_add_u16(d, 0x0001);
620 }
621
622 rc = statvfs(s->root, &buf);
623 if (rc == 0) {
624 usb_mtp_add_u64(d, (uint64_t)buf.f_frsize * buf.f_blocks);
625 usb_mtp_add_u64(d, (uint64_t)buf.f_bavail * buf.f_blocks);
626 usb_mtp_add_u32(d, buf.f_ffree);
627 } else {
628 usb_mtp_add_u64(d, 0xffffffff);
629 usb_mtp_add_u64(d, 0xffffffff);
630 usb_mtp_add_u32(d, 0xffffffff);
631 }
632
633 usb_mtp_add_str(d, s->desc);
634 usb_mtp_add_wstr(d, L"123456789abcdef");
635 return d;
636 }
637
638 static MTPData *usb_mtp_get_object_handles(MTPState *s, MTPControl *c,
639 MTPObject *o)
640 {
641 MTPData *d = usb_mtp_data_alloc(c);
642 uint32_t i = 0, handles[o->nchildren];
643 MTPObject *iter;
644
645 trace_usb_mtp_op_get_object_handles(s->dev.addr, o->handle, o->path);
646
647 QLIST_FOREACH(iter, &o->children, list) {
648 handles[i++] = iter->handle;
649 }
650 assert(i == o->nchildren);
651 usb_mtp_add_u32_array(d, o->nchildren, handles);
652
653 return d;
654 }
655
656 static MTPData *usb_mtp_get_object_info(MTPState *s, MTPControl *c,
657 MTPObject *o)
658 {
659 MTPData *d = usb_mtp_data_alloc(c);
660
661 trace_usb_mtp_op_get_object_info(s->dev.addr, o->handle, o->path);
662
663 usb_mtp_add_u32(d, QEMU_STORAGE_ID);
664 usb_mtp_add_u16(d, o->format);
665 usb_mtp_add_u16(d, 0);
666 usb_mtp_add_u32(d, o->stat.st_size);
667
668 usb_mtp_add_u16(d, 0);
669 usb_mtp_add_u32(d, 0);
670 usb_mtp_add_u32(d, 0);
671 usb_mtp_add_u32(d, 0);
672 usb_mtp_add_u32(d, 0);
673 usb_mtp_add_u32(d, 0);
674 usb_mtp_add_u32(d, 0);
675
676 if (o->parent) {
677 usb_mtp_add_u32(d, o->parent->handle);
678 } else {
679 usb_mtp_add_u32(d, 0);
680 }
681 if (o->format == FMT_ASSOCIATION) {
682 usb_mtp_add_u16(d, 0x0001);
683 usb_mtp_add_u32(d, 0x00000001);
684 usb_mtp_add_u32(d, 0);
685 } else {
686 usb_mtp_add_u16(d, 0);
687 usb_mtp_add_u32(d, 0);
688 usb_mtp_add_u32(d, 0);
689 }
690
691 usb_mtp_add_str(d, o->name);
692 usb_mtp_add_time(d, o->stat.st_ctime);
693 usb_mtp_add_time(d, o->stat.st_mtime);
694 usb_mtp_add_wstr(d, L"");
695
696 return d;
697 }
698
699 static MTPData *usb_mtp_get_object(MTPState *s, MTPControl *c,
700 MTPObject *o)
701 {
702 MTPData *d = usb_mtp_data_alloc(c);
703
704 trace_usb_mtp_op_get_object(s->dev.addr, o->handle, o->path);
705
706 d->fd = open(o->path, O_RDONLY);
707 if (d->fd == -1) {
708 usb_mtp_data_free(d);
709 return NULL;
710 }
711 d->length = o->stat.st_size;
712 d->alloc = 512;
713 d->data = g_malloc(d->alloc);
714 return d;
715 }
716
717 static MTPData *usb_mtp_get_partial_object(MTPState *s, MTPControl *c,
718 MTPObject *o)
719 {
720 MTPData *d = usb_mtp_data_alloc(c);
721 off_t offset;
722
723 trace_usb_mtp_op_get_partial_object(s->dev.addr, o->handle, o->path,
724 c->argv[1], c->argv[2]);
725
726 d->fd = open(o->path, O_RDONLY);
727 if (d->fd == -1) {
728 usb_mtp_data_free(d);
729 return NULL;
730 }
731
732 offset = c->argv[1];
733 if (offset > o->stat.st_size) {
734 offset = o->stat.st_size;
735 }
736 if (lseek(d->fd, offset, SEEK_SET) < 0) {
737 usb_mtp_data_free(d);
738 return NULL;
739 }
740
741 d->length = c->argv[2];
742 if (d->length > o->stat.st_size - offset) {
743 d->length = o->stat.st_size - offset;
744 }
745
746 return d;
747 }
748
749 static void usb_mtp_command(MTPState *s, MTPControl *c)
750 {
751 MTPData *data_in = NULL;
752 MTPObject *o;
753 uint32_t nres = 0, res0 = 0;
754
755 /* sanity checks */
756 if (c->code >= CMD_CLOSE_SESSION && s->session == 0) {
757 usb_mtp_queue_result(s, RES_SESSION_NOT_OPEN,
758 c->trans, 0, 0, 0);
759 return;
760 }
761
762 /* process commands */
763 switch (c->code) {
764 case CMD_GET_DEVICE_INFO:
765 data_in = usb_mtp_get_device_info(s, c);
766 break;
767 case CMD_OPEN_SESSION:
768 if (s->session) {
769 usb_mtp_queue_result(s, RES_SESSION_ALREADY_OPEN,
770 c->trans, 1, s->session, 0);
771 return;
772 }
773 if (c->argv[0] == 0) {
774 usb_mtp_queue_result(s, RES_INVALID_PARAMETER,
775 c->trans, 0, 0, 0);
776 return;
777 }
778 trace_usb_mtp_op_open_session(s->dev.addr);
779 s->session = c->argv[0];
780 usb_mtp_object_alloc(s, s->next_handle++, NULL, s->root);
781 break;
782 case CMD_CLOSE_SESSION:
783 trace_usb_mtp_op_close_session(s->dev.addr);
784 s->session = 0;
785 s->next_handle = 0;
786 usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
787 assert(QTAILQ_EMPTY(&s->objects));
788 break;
789 case CMD_GET_STORAGE_IDS:
790 data_in = usb_mtp_get_storage_ids(s, c);
791 break;
792 case CMD_GET_STORAGE_INFO:
793 if (c->argv[0] != QEMU_STORAGE_ID &&
794 c->argv[0] != 0xffffffff) {
795 usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
796 c->trans, 0, 0, 0);
797 return;
798 }
799 data_in = usb_mtp_get_storage_info(s, c);
800 break;
801 case CMD_GET_NUM_OBJECTS:
802 case CMD_GET_OBJECT_HANDLES:
803 if (c->argv[0] != QEMU_STORAGE_ID &&
804 c->argv[0] != 0xffffffff) {
805 usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
806 c->trans, 0, 0, 0);
807 return;
808 }
809 if (c->argv[1] != 0x00000000) {
810 usb_mtp_queue_result(s, RES_SPEC_BY_FORMAT_UNSUPPORTED,
811 c->trans, 0, 0, 0);
812 return;
813 }
814 if (c->argv[2] == 0x00000000 ||
815 c->argv[2] == 0xffffffff) {
816 o = QTAILQ_FIRST(&s->objects);
817 } else {
818 o = usb_mtp_object_lookup(s, c->argv[2]);
819 }
820 if (o == NULL) {
821 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
822 c->trans, 0, 0, 0);
823 return;
824 }
825 if (o->format != FMT_ASSOCIATION) {
826 usb_mtp_queue_result(s, RES_INVALID_PARENT_OBJECT,
827 c->trans, 0, 0, 0);
828 return;
829 }
830 usb_mtp_object_readdir(s, o);
831 if (c->code == CMD_GET_NUM_OBJECTS) {
832 trace_usb_mtp_op_get_num_objects(s->dev.addr, o->handle, o->path);
833 nres = 1;
834 res0 = o->nchildren;
835 } else {
836 data_in = usb_mtp_get_object_handles(s, c, o);
837 }
838 break;
839 case CMD_GET_OBJECT_INFO:
840 o = usb_mtp_object_lookup(s, c->argv[0]);
841 if (o == NULL) {
842 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
843 c->trans, 0, 0, 0);
844 return;
845 }
846 data_in = usb_mtp_get_object_info(s, c, o);
847 break;
848 case CMD_GET_OBJECT:
849 o = usb_mtp_object_lookup(s, c->argv[0]);
850 if (o == NULL) {
851 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
852 c->trans, 0, 0, 0);
853 return;
854 }
855 if (o->format == FMT_ASSOCIATION) {
856 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
857 c->trans, 0, 0, 0);
858 return;
859 }
860 data_in = usb_mtp_get_object(s, c, o);
861 if (data_in == NULL) {
862 usb_mtp_queue_result(s, RES_GENERAL_ERROR,
863 c->trans, 0, 0, 0);
864 return;
865 }
866 break;
867 case CMD_GET_PARTIAL_OBJECT:
868 o = usb_mtp_object_lookup(s, c->argv[0]);
869 if (o == NULL) {
870 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
871 c->trans, 0, 0, 0);
872 return;
873 }
874 if (o->format == FMT_ASSOCIATION) {
875 usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
876 c->trans, 0, 0, 0);
877 return;
878 }
879 data_in = usb_mtp_get_partial_object(s, c, o);
880 if (data_in == NULL) {
881 usb_mtp_queue_result(s, RES_GENERAL_ERROR,
882 c->trans, 0, 0, 0);
883 return;
884 }
885 nres = 1;
886 res0 = data_in->length;
887 break;
888 default:
889 trace_usb_mtp_op_unknown(s->dev.addr, c->code);
890 usb_mtp_queue_result(s, RES_OPERATION_NOT_SUPPORTED,
891 c->trans, 0, 0, 0);
892 return;
893 }
894
895 /* return results on success */
896 if (data_in) {
897 assert(s->data_in == NULL);
898 s->data_in = data_in;
899 }
900 usb_mtp_queue_result(s, RES_OK, c->trans, nres, res0, 0);
901 }
902
903 /* ----------------------------------------------------------------------- */
904
905 static void usb_mtp_handle_reset(USBDevice *dev)
906 {
907 MTPState *s = USB_MTP(dev);
908
909 trace_usb_mtp_reset(s->dev.addr);
910
911 usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
912 s->session = 0;
913 usb_mtp_data_free(s->data_in);
914 s->data_in = NULL;
915 usb_mtp_data_free(s->data_out);
916 s->data_out = NULL;
917 g_free(s->result);
918 s->result = NULL;
919 }
920
921 static void usb_mtp_handle_control(USBDevice *dev, USBPacket *p,
922 int request, int value, int index,
923 int length, uint8_t *data)
924 {
925 int ret;
926
927 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
928 if (ret >= 0) {
929 return;
930 }
931
932 trace_usb_mtp_stall(dev->addr, "unknown control request");
933 p->status = USB_RET_STALL;
934 }
935
936 static void usb_mtp_cancel_packet(USBDevice *dev, USBPacket *p)
937 {
938 /* we don't use async packets, so this should never be called */
939 fprintf(stderr, "%s\n", __func__);
940 }
941
942 static void usb_mtp_handle_data(USBDevice *dev, USBPacket *p)
943 {
944 MTPState *s = USB_MTP(dev);
945 MTPControl cmd;
946 mtp_container container;
947 uint32_t params[5];
948 int i, rc;
949
950 switch (p->ep->nr) {
951 case EP_DATA_IN:
952 if (s->data_out != NULL) {
953 /* guest bug */
954 trace_usb_mtp_stall(s->dev.addr, "awaiting data-out");
955 p->status = USB_RET_STALL;
956 return;
957 }
958 if (p->iov.size < sizeof(container)) {
959 trace_usb_mtp_stall(s->dev.addr, "packet too small");
960 p->status = USB_RET_STALL;
961 return;
962 }
963 if (s->data_in != NULL) {
964 MTPData *d = s->data_in;
965 int dlen = d->length - d->offset;
966 if (d->first) {
967 trace_usb_mtp_data_in(s->dev.addr, d->trans, d->length);
968 container.length = cpu_to_le32(d->length + sizeof(container));
969 container.type = cpu_to_le16(TYPE_DATA);
970 container.code = cpu_to_le16(d->code);
971 container.trans = cpu_to_le32(d->trans);
972 usb_packet_copy(p, &container, sizeof(container));
973 d->first = false;
974 if (dlen > p->iov.size - sizeof(container)) {
975 dlen = p->iov.size - sizeof(container);
976 }
977 } else {
978 if (dlen > p->iov.size) {
979 dlen = p->iov.size;
980 }
981 }
982 if (d->fd == -1) {
983 usb_packet_copy(p, d->data + d->offset, dlen);
984 } else {
985 if (d->alloc < p->iov.size) {
986 d->alloc = p->iov.size;
987 d->data = g_realloc(d->data, d->alloc);
988 }
989 rc = read(d->fd, d->data, dlen);
990 if (rc != dlen) {
991 memset(d->data, 0, dlen);
992 s->result->code = RES_INCOMPLETE_TRANSFER;
993 }
994 usb_packet_copy(p, d->data, dlen);
995 }
996 d->offset += dlen;
997 if (d->offset == d->length) {
998 usb_mtp_data_free(s->data_in);
999 s->data_in = NULL;
1000 }
1001 } else if (s->result != NULL) {
1002 MTPControl *r = s->result;
1003 int length = sizeof(container) + r->argc * sizeof(uint32_t);
1004 if (r->code == RES_OK) {
1005 trace_usb_mtp_success(s->dev.addr, r->trans,
1006 (r->argc > 0) ? r->argv[0] : 0,
1007 (r->argc > 1) ? r->argv[1] : 0);
1008 } else {
1009 trace_usb_mtp_error(s->dev.addr, r->code, r->trans,
1010 (r->argc > 0) ? r->argv[0] : 0,
1011 (r->argc > 1) ? r->argv[1] : 0);
1012 }
1013 container.length = cpu_to_le32(length);
1014 container.type = cpu_to_le16(TYPE_RESPONSE);
1015 container.code = cpu_to_le16(r->code);
1016 container.trans = cpu_to_le32(r->trans);
1017 for (i = 0; i < r->argc; i++) {
1018 params[i] = cpu_to_le32(r->argv[i]);
1019 }
1020 usb_packet_copy(p, &container, sizeof(container));
1021 usb_packet_copy(p, &params, length - sizeof(container));
1022 g_free(s->result);
1023 s->result = NULL;
1024 }
1025 break;
1026 case EP_DATA_OUT:
1027 if (p->iov.size < sizeof(container)) {
1028 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1029 p->status = USB_RET_STALL;
1030 return;
1031 }
1032 usb_packet_copy(p, &container, sizeof(container));
1033 switch (le16_to_cpu(container.type)) {
1034 case TYPE_COMMAND:
1035 if (s->data_in || s->data_out || s->result) {
1036 trace_usb_mtp_stall(s->dev.addr, "transaction inflight");
1037 p->status = USB_RET_STALL;
1038 return;
1039 }
1040 cmd.code = le16_to_cpu(container.code);
1041 cmd.argc = (le32_to_cpu(container.length) - sizeof(container))
1042 / sizeof(uint32_t);
1043 cmd.trans = le32_to_cpu(container.trans);
1044 if (cmd.argc > ARRAY_SIZE(cmd.argv)) {
1045 cmd.argc = ARRAY_SIZE(cmd.argv);
1046 }
1047 if (p->iov.size < sizeof(container) + cmd.argc * sizeof(uint32_t)) {
1048 trace_usb_mtp_stall(s->dev.addr, "packet too small");
1049 p->status = USB_RET_STALL;
1050 return;
1051 }
1052 usb_packet_copy(p, &params, cmd.argc * sizeof(uint32_t));
1053 for (i = 0; i < cmd.argc; i++) {
1054 cmd.argv[i] = le32_to_cpu(params[i]);
1055 }
1056 trace_usb_mtp_command(s->dev.addr, cmd.code, cmd.trans,
1057 (cmd.argc > 0) ? cmd.argv[0] : 0,
1058 (cmd.argc > 1) ? cmd.argv[1] : 0,
1059 (cmd.argc > 2) ? cmd.argv[2] : 0,
1060 (cmd.argc > 3) ? cmd.argv[3] : 0,
1061 (cmd.argc > 4) ? cmd.argv[4] : 0);
1062 usb_mtp_command(s, &cmd);
1063 break;
1064 default:
1065 /* not needed as long as the mtp device is read-only */
1066 p->status = USB_RET_STALL;
1067 return;
1068 }
1069 break;
1070 case EP_EVENT:
1071 p->status = USB_RET_NAK;
1072 return;
1073 default:
1074 trace_usb_mtp_stall(s->dev.addr, "invalid endpoint");
1075 p->status = USB_RET_STALL;
1076 return;
1077 }
1078
1079 if (p->actual_length == 0) {
1080 trace_usb_mtp_nak(s->dev.addr, p->ep->nr);
1081 p->status = USB_RET_NAK;
1082 return;
1083 } else {
1084 trace_usb_mtp_xfer(s->dev.addr, p->ep->nr, p->actual_length,
1085 p->iov.size);
1086 return;
1087 }
1088 }
1089
1090 static void usb_mtp_realize(USBDevice *dev, Error **errp)
1091 {
1092 MTPState *s = USB_MTP(dev);
1093
1094 usb_desc_create_serial(dev);
1095 usb_desc_init(dev);
1096 QTAILQ_INIT(&s->objects);
1097 if (s->desc == NULL) {
1098 if (s->root == NULL) {
1099 error_setg(errp, "usb-mtp: x-root property must be configured");
1100 return;
1101 }
1102 s->desc = strrchr(s->root, '/');
1103 if (s->desc && s->desc[0]) {
1104 s->desc = g_strdup(s->desc + 1);
1105 } else {
1106 s->desc = g_strdup("none");
1107 }
1108 }
1109 }
1110
1111 static const VMStateDescription vmstate_usb_mtp = {
1112 .name = "usb-mtp",
1113 .unmigratable = 1,
1114 .version_id = 1,
1115 .minimum_version_id = 1,
1116 .fields = (VMStateField[]) {
1117 VMSTATE_USB_DEVICE(dev, MTPState),
1118 VMSTATE_END_OF_LIST()
1119 }
1120 };
1121
1122 static Property mtp_properties[] = {
1123 DEFINE_PROP_STRING("x-root", MTPState, root),
1124 DEFINE_PROP_STRING("desc", MTPState, desc),
1125 DEFINE_PROP_END_OF_LIST(),
1126 };
1127
1128 static void usb_mtp_class_initfn(ObjectClass *klass, void *data)
1129 {
1130 DeviceClass *dc = DEVICE_CLASS(klass);
1131 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
1132
1133 uc->realize = usb_mtp_realize;
1134 uc->product_desc = "QEMU USB MTP";
1135 uc->usb_desc = &desc;
1136 uc->cancel_packet = usb_mtp_cancel_packet;
1137 uc->handle_attach = usb_desc_attach;
1138 uc->handle_reset = usb_mtp_handle_reset;
1139 uc->handle_control = usb_mtp_handle_control;
1140 uc->handle_data = usb_mtp_handle_data;
1141 dc->fw_name = "mtp";
1142 dc->vmsd = &vmstate_usb_mtp;
1143 dc->props = mtp_properties;
1144 }
1145
1146 static TypeInfo mtp_info = {
1147 .name = TYPE_USB_MTP,
1148 .parent = TYPE_USB_DEVICE,
1149 .instance_size = sizeof(MTPState),
1150 .class_init = usb_mtp_class_initfn,
1151 };
1152
1153 static void usb_mtp_register_types(void)
1154 {
1155 type_register_static(&mtp_info);
1156 }
1157
1158 type_init(usb_mtp_register_types)
QEMU mirror