Coverage Report

Created: 2026-10-31 08:12

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/qemu/hw/usb/dev-mtp.c
Line
Count
Source
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 "qemu/osdep.h"
13
#include "qapi/error.h"
14
#include "qemu/error-report.h"
15
#include <wchar.h>
16
#include <dirent.h>
17
#include <glib/gstdio.h>
18
#include <sys/statvfs.h>
19
20
21
#include "qemu/iov.h"
22
#include "qemu/module.h"
23
#include "qemu/filemonitor.h"
24
#include "trace.h"
25
#include "hw/core/qdev-properties.h"
26
#include "hw/usb/usb.h"
27
#include "migration/vmstate.h"
28
#include "desc.h"
29
#include "qemu/units.h"
30
#include "qom/object.h"
31
32
/* ----------------------------------------------------------------------- */
33
34
enum mtp_container_type {
35
    TYPE_COMMAND  = 1,
36
    TYPE_DATA     = 2,
37
    TYPE_RESPONSE = 3,
38
    TYPE_EVENT    = 4,
39
};
40
41
/* MTP write stage, for internal use only */
42
enum mtp_write_status {
43
    WRITE_START    = 1,
44
    WRITE_CONTINUE = 2,
45
    WRITE_END      = 3,
46
};
47
48
enum mtp_code {
49
    /* command codes */
50
    CMD_GET_DEVICE_INFO            = 0x1001,
51
    CMD_OPEN_SESSION               = 0x1002,
52
    CMD_CLOSE_SESSION              = 0x1003,
53
    CMD_GET_STORAGE_IDS            = 0x1004,
54
    CMD_GET_STORAGE_INFO           = 0x1005,
55
    CMD_GET_NUM_OBJECTS            = 0x1006,
56
    CMD_GET_OBJECT_HANDLES         = 0x1007,
57
    CMD_GET_OBJECT_INFO            = 0x1008,
58
    CMD_GET_OBJECT                 = 0x1009,
59
    CMD_DELETE_OBJECT              = 0x100b,
60
    CMD_SEND_OBJECT_INFO           = 0x100c,
61
    CMD_SEND_OBJECT                = 0x100d,
62
    CMD_GET_PARTIAL_OBJECT         = 0x101b,
63
    CMD_GET_OBJECT_PROPS_SUPPORTED = 0x9801,
64
    CMD_GET_OBJECT_PROP_DESC       = 0x9802,
65
    CMD_GET_OBJECT_PROP_VALUE      = 0x9803,
66
67
    /* response codes */
68
    RES_OK                         = 0x2001,
69
    RES_GENERAL_ERROR              = 0x2002,
70
    RES_SESSION_NOT_OPEN           = 0x2003,
71
    RES_INVALID_TRANSACTION_ID     = 0x2004,
72
    RES_OPERATION_NOT_SUPPORTED    = 0x2005,
73
    RES_PARAMETER_NOT_SUPPORTED    = 0x2006,
74
    RES_INCOMPLETE_TRANSFER        = 0x2007,
75
    RES_INVALID_STORAGE_ID         = 0x2008,
76
    RES_INVALID_OBJECT_HANDLE      = 0x2009,
77
    RES_INVALID_OBJECT_FORMAT_CODE = 0x200b,
78
    RES_STORE_FULL                 = 0x200c,
79
    RES_STORE_READ_ONLY            = 0x200e,
80
    RES_PARTIAL_DELETE             = 0x2012,
81
    RES_STORE_NOT_AVAILABLE        = 0x2013,
82
    RES_SPEC_BY_FORMAT_UNSUPPORTED = 0x2014,
83
    RES_INVALID_OBJECTINFO         = 0x2015,
84
    RES_DESTINATION_UNSUPPORTED    = 0x2020,
85
    RES_INVALID_PARENT_OBJECT      = 0x201a,
86
    RES_INVALID_PARAMETER          = 0x201d,
87
    RES_SESSION_ALREADY_OPEN       = 0x201e,
88
    RES_INVALID_OBJECT_PROP_CODE   = 0xA801,
89
90
    /* format codes */
91
    FMT_UNDEFINED_OBJECT           = 0x3000,
92
    FMT_ASSOCIATION                = 0x3001,
93
94
    /* event codes */
95
    EVT_CANCEL_TRANSACTION         = 0x4001,
96
    EVT_OBJ_ADDED                  = 0x4002,
97
    EVT_OBJ_REMOVED                = 0x4003,
98
    EVT_OBJ_INFO_CHANGED           = 0x4007,
99
100
    /* object properties */
101
    PROP_STORAGE_ID                = 0xDC01,
102
    PROP_OBJECT_FORMAT             = 0xDC02,
103
    PROP_OBJECT_COMPRESSED_SIZE    = 0xDC04,
104
    PROP_PARENT_OBJECT             = 0xDC0B,
105
    PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER = 0xDC41,
106
    PROP_NAME                      = 0xDC44,
107
};
108
109
enum mtp_data_type {
110
    DATA_TYPE_UINT16  = 0x0004,
111
    DATA_TYPE_UINT32  = 0x0006,
112
    DATA_TYPE_UINT64  = 0x0008,
113
    DATA_TYPE_UINT128 = 0x000a,
114
    DATA_TYPE_STRING  = 0xffff,
115
};
116
117
typedef struct {
118
    uint32_t length;
119
    uint16_t type;
120
    uint16_t code;
121
    uint32_t trans;
122
} QEMU_PACKED mtp_container;
123
124
/* ----------------------------------------------------------------------- */
125
126
typedef struct MTPControl MTPControl;
127
typedef struct MTPData MTPData;
128
typedef struct MTPObject MTPObject;
129
130
#define TYPE_USB_MTP "usb-mtp"
131
OBJECT_DECLARE_SIMPLE_TYPE(MTPState, USB_MTP)
132
133
enum {
134
    EP_DATA_IN = 1,
135
    EP_DATA_OUT,
136
    EP_EVENT,
137
};
138
139
typedef struct MTPMonEntry MTPMonEntry;
140
141
struct MTPMonEntry {
142
    uint32_t event;
143
    uint32_t handle;
144
145
    QTAILQ_ENTRY(MTPMonEntry) next;
146
};
147
148
struct MTPControl {
149
    uint16_t     code;
150
    uint32_t     trans;
151
    int          argc;
152
    uint32_t     argv[5];
153
};
154
155
struct MTPData {
156
    uint16_t     code;
157
    uint32_t     trans;
158
    uint64_t     offset;
159
    uint64_t     length;
160
    uint64_t     alloc;
161
    uint8_t      *data;
162
    bool         first;
163
    /* Used for >4G file sizes */
164
    bool         pending;
165
    int          fd;
166
    uint8_t      write_status;
167
    /* Internal pointer per every MTP_WRITE_BUF_SZ */
168
    uint64_t     data_offset;
169
};
170
171
struct MTPObject {
172
    uint32_t     handle;
173
    uint16_t     format;
174
    char         *name;
175
    char         *path;
176
    struct stat  stat;
177
    /* file monitor watch id */
178
    int64_t      watchid;
179
    MTPObject    *parent;
180
    uint32_t     nchildren;
181
    QLIST_HEAD(, MTPObject) children;
182
    QLIST_ENTRY(MTPObject) list;
183
    bool         have_children;
184
    QTAILQ_ENTRY(MTPObject) next;
185
};
186
187
struct MTPState {
188
    USBDevice    dev;
189
    char         *root;
190
    char         *desc;
191
    uint32_t     flags;
192
193
    MTPData      *data_in;
194
    MTPData      *data_out;
195
    MTPControl   *result;
196
    uint32_t     session;
197
    uint32_t     next_handle;
198
    bool         readonly;
199
200
    QTAILQ_HEAD(, MTPObject) objects;
201
    QFileMonitor *file_monitor;
202
    QTAILQ_HEAD(, MTPMonEntry) events;
203
    /* Responder is expecting a write operation */
204
    bool write_pending;
205
    struct {
206
        uint32_t parent_handle;
207
        uint16_t format;
208
        uint32_t size;
209
        char *filename;
210
    } dataset;
211
};
212
213
/*
214
 * ObjectInfo dataset received from initiator
215
 * Fields we don't care about are ignored
216
 */
217
typedef struct {
218
    uint32_t storage_id; /*unused*/
219
    uint16_t format;
220
    uint16_t protection_status; /*unused*/
221
    uint32_t size;
222
    uint16_t thumb_format; /*unused*/
223
    uint32_t thumb_comp_sz; /*unused*/
224
    uint32_t thumb_pix_width; /*unused*/
225
    uint32_t thumb_pix_height; /*unused*/
226
    uint32_t image_pix_width; /*unused*/
227
    uint32_t image_pix_height; /*unused*/
228
    uint32_t image_bit_depth; /*unused*/
229
    uint32_t parent; /*unused*/
230
    uint16_t assoc_type;
231
    uint32_t assoc_desc;
232
    uint32_t seq_no; /*unused*/
233
    uint8_t length; /*part of filename field*/
234
    uint8_t filename[0]; /* UTF-16 encoded */
235
    char date_created[0]; /*unused*/
236
    char date_modified[0]; /*unused*/
237
    char keywords[0]; /*unused*/
238
    /* string and other data follows */
239
} QEMU_PACKED ObjectInfo;
240
241
0
#define QEMU_STORAGE_ID 0x00010001
242
243
0
#define MTP_FLAG_WRITABLE 0
244
245
0
#define FLAG_SET(_mtp, _flag)  ((_mtp)->flags & (1 << (_flag)))
246
247
/* ----------------------------------------------------------------------- */
248
249
0
#define MTP_MANUFACTURER  "QEMU"
250
0
#define MTP_PRODUCT       "QEMU filesharing"
251
0
#define MTP_WRITE_BUF_SZ  (512 * KiB)
252
253
enum {
254
    STR_MANUFACTURER = 1,
255
    STR_PRODUCT,
256
    STR_SERIALNUMBER,
257
    STR_MTP,
258
    STR_CONFIG_FULL,
259
    STR_CONFIG_HIGH,
260
    STR_CONFIG_SUPER,
261
};
262
263
static const USBDescStrings desc_strings = {
264
    [STR_MANUFACTURER] = MTP_MANUFACTURER,
265
    [STR_PRODUCT]      = MTP_PRODUCT,
266
    [STR_SERIALNUMBER] = "34617",
267
    [STR_MTP]          = "MTP",
268
    [STR_CONFIG_FULL]  = "Full speed config (usb 1.1)",
269
    [STR_CONFIG_HIGH]  = "High speed config (usb 2.0)",
270
    [STR_CONFIG_SUPER] = "Super speed config (usb 3.0)",
271
};
272
273
static const USBDescIface desc_iface_full = {
274
    .bInterfaceNumber              = 0,
275
    .bNumEndpoints                 = 3,
276
    .bInterfaceClass               = USB_CLASS_STILL_IMAGE,
277
    .bInterfaceSubClass            = 0x01,
278
    .bInterfaceProtocol            = 0x01,
279
    .iInterface                    = STR_MTP,
280
    .eps = (USBDescEndpoint[]) {
281
        {
282
            .bEndpointAddress      = USB_DIR_IN | EP_DATA_IN,
283
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
284
            .wMaxPacketSize        = 64,
285
        },{
286
            .bEndpointAddress      = USB_DIR_OUT | EP_DATA_OUT,
287
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
288
            .wMaxPacketSize        = 64,
289
        },{
290
            .bEndpointAddress      = USB_DIR_IN | EP_EVENT,
291
            .bmAttributes          = USB_ENDPOINT_XFER_INT,
292
            .wMaxPacketSize        = 64,
293
            .bInterval             = 0x0a,
294
        },
295
    }
296
};
297
298
static const USBDescDevice desc_device_full = {
299
    .bcdUSB                        = 0x0200,
300
    .bMaxPacketSize0               = 8,
301
    .bNumConfigurations            = 1,
302
    .confs = (USBDescConfig[]) {
303
        {
304
            .bNumInterfaces        = 1,
305
            .bConfigurationValue   = 1,
306
            .iConfiguration        = STR_CONFIG_FULL,
307
            .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
308
            .bMaxPower             = 2,
309
            .nif = 1,
310
            .ifs = &desc_iface_full,
311
        },
312
    },
313
};
314
315
static const USBDescIface desc_iface_high = {
316
    .bInterfaceNumber              = 0,
317
    .bNumEndpoints                 = 3,
318
    .bInterfaceClass               = USB_CLASS_STILL_IMAGE,
319
    .bInterfaceSubClass            = 0x01,
320
    .bInterfaceProtocol            = 0x01,
321
    .iInterface                    = STR_MTP,
322
    .eps = (USBDescEndpoint[]) {
323
        {
324
            .bEndpointAddress      = USB_DIR_IN | EP_DATA_IN,
325
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
326
            .wMaxPacketSize        = 512,
327
        },{
328
            .bEndpointAddress      = USB_DIR_OUT | EP_DATA_OUT,
329
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
330
            .wMaxPacketSize        = 512,
331
        },{
332
            .bEndpointAddress      = USB_DIR_IN | EP_EVENT,
333
            .bmAttributes          = USB_ENDPOINT_XFER_INT,
334
            .wMaxPacketSize        = 64,
335
            .bInterval             = 0x0a,
336
        },
337
    }
338
};
339
340
static const USBDescDevice desc_device_high = {
341
    .bcdUSB                        = 0x0200,
342
    .bMaxPacketSize0               = 64,
343
    .bNumConfigurations            = 1,
344
    .confs = (USBDescConfig[]) {
345
        {
346
            .bNumInterfaces        = 1,
347
            .bConfigurationValue   = 1,
348
            .iConfiguration        = STR_CONFIG_HIGH,
349
            .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP,
350
            .bMaxPower             = 2,
351
            .nif = 1,
352
            .ifs = &desc_iface_high,
353
        },
354
    },
355
};
356
357
static const USBDescMSOS desc_msos = {
358
    .CompatibleID = "MTP",
359
    .SelectiveSuspendEnabled = true,
360
};
361
362
static const USBDesc desc = {
363
    .id = {
364
        .idVendor          = 0x46f4, /* CRC16() of "QEMU" */
365
        .idProduct         = 0x0004,
366
        .bcdDevice         = 0,
367
        .iManufacturer     = STR_MANUFACTURER,
368
        .iProduct          = STR_PRODUCT,
369
        .iSerialNumber     = STR_SERIALNUMBER,
370
    },
371
    .full  = &desc_device_full,
372
    .high  = &desc_device_high,
373
    .str   = desc_strings,
374
    .msos  = &desc_msos,
375
};
376
377
/* ----------------------------------------------------------------------- */
378
379
static MTPObject *usb_mtp_object_alloc(MTPState *s, uint32_t handle,
380
                                       MTPObject *parent, const char *name)
381
0
{
382
0
    MTPObject *o = g_new0(MTPObject, 1);
383
384
0
    if (name[0] == '.') {
385
0
        goto ignore;
386
0
    }
387
388
0
    o->watchid = -1;
389
0
    o->handle = handle;
390
0
    o->parent = parent;
391
0
    o->name = g_strdup(name);
392
0
    if (parent == NULL) {
393
0
        o->path = g_strdup(name);
394
0
    } else {
395
0
        o->path = g_strdup_printf("%s/%s", parent->path, name);
396
0
    }
397
398
0
    if (lstat(o->path, &o->stat) != 0) {
399
0
        goto ignore;
400
0
    }
401
0
    if (S_ISREG(o->stat.st_mode)) {
402
0
        o->format = FMT_UNDEFINED_OBJECT;
403
0
    } else if (S_ISDIR(o->stat.st_mode)) {
404
0
        o->format = FMT_ASSOCIATION;
405
0
    } else {
406
0
        goto ignore;
407
0
    }
408
409
0
    if (access(o->path, R_OK) != 0) {
410
0
        goto ignore;
411
0
    }
412
413
0
    trace_usb_mtp_object_alloc(s->dev.addr, o->handle, o->path);
414
415
0
    QTAILQ_INSERT_TAIL(&s->objects, o, next);
416
0
    return o;
417
418
0
ignore:
419
0
    g_free(o->name);
420
0
    g_free(o->path);
421
0
    g_free(o);
422
0
    return NULL;
423
0
}
424
425
static void usb_mtp_object_free(MTPState *s, MTPObject *o)
426
0
{
427
0
    MTPObject *iter;
428
429
0
    if (!o) {
430
0
        return;
431
0
    }
432
433
0
    trace_usb_mtp_object_free(s->dev.addr, o->handle, o->path);
434
435
0
    if (o->watchid != -1 && s->file_monitor) {
436
0
        qemu_file_monitor_remove_watch(s->file_monitor, o->path, o->watchid);
437
0
    }
438
439
0
    QTAILQ_REMOVE(&s->objects, o, next);
440
0
    if (o->parent) {
441
0
        QLIST_REMOVE(o, list);
442
0
        o->parent->nchildren--;
443
0
    }
444
445
0
    while (!QLIST_EMPTY(&o->children)) {
446
0
        iter = QLIST_FIRST(&o->children);
447
0
        usb_mtp_object_free(s, iter);
448
0
    }
449
0
    g_free(o->name);
450
0
    g_free(o->path);
451
0
    g_free(o);
452
0
}
453
454
static MTPObject *usb_mtp_object_lookup(MTPState *s, uint32_t handle)
455
0
{
456
0
    MTPObject *o;
457
458
0
    QTAILQ_FOREACH(o, &s->objects, next) {
459
0
        if (o->handle == handle) {
460
0
            return o;
461
0
        }
462
0
    }
463
0
    return NULL;
464
0
}
465
466
static MTPObject *usb_mtp_add_child(MTPState *s, MTPObject *o,
467
                                    const char *name)
468
0
{
469
0
    MTPObject *child =
470
0
        usb_mtp_object_alloc(s, s->next_handle++, o, name);
471
472
0
    if (child) {
473
0
        trace_usb_mtp_add_child(s->dev.addr, child->handle, child->path);
474
0
        QLIST_INSERT_HEAD(&o->children, child, list);
475
0
        o->nchildren++;
476
477
0
        if (child->format == FMT_ASSOCIATION) {
478
0
            QLIST_INIT(&child->children);
479
0
        }
480
0
    }
481
482
0
    return child;
483
0
}
484
485
static MTPObject *usb_mtp_object_lookup_name(MTPObject *parent,
486
                                             const char *name, int len)
487
0
{
488
0
    MTPObject *iter;
489
490
0
    if (len == -1) {
491
0
        len = strlen(name);
492
0
    }
493
494
0
    QLIST_FOREACH(iter, &parent->children, list) {
495
0
        if (strncmp(iter->name, name, len) == 0) {
496
0
            return iter;
497
0
        }
498
0
    }
499
500
0
    return NULL;
501
0
}
502
503
static MTPObject *usb_mtp_object_lookup_id(MTPState *s, int64_t id)
504
0
{
505
0
    MTPObject *iter;
506
507
0
    QTAILQ_FOREACH(iter, &s->objects, next) {
508
0
        if (iter->watchid == id) {
509
0
            return iter;
510
0
        }
511
0
    }
512
513
0
    return NULL;
514
0
}
515
516
static void file_monitor_event(int64_t id,
517
                               QFileMonitorEvent ev,
518
                               const char *name,
519
                               void *opaque)
520
0
{
521
0
    MTPState *s = opaque;
522
0
    MTPObject *parent = usb_mtp_object_lookup_id(s, id);
523
0
    MTPMonEntry *entry = NULL;
524
0
    MTPObject *o;
525
526
0
    if (!parent) {
527
0
        return;
528
0
    }
529
530
0
    switch (ev) {
531
0
    case QFILE_MONITOR_EVENT_CREATED:
532
0
        if (usb_mtp_object_lookup_name(parent, name, -1)) {
533
            /* Duplicate create event */
534
0
            return;
535
0
        }
536
0
        entry = g_new0(MTPMonEntry, 1);
537
0
        entry->handle = s->next_handle;
538
0
        entry->event = EVT_OBJ_ADDED;
539
0
        o = usb_mtp_add_child(s, parent, name);
540
0
        if (!o) {
541
0
            g_free(entry);
542
0
            return;
543
0
        }
544
0
        trace_usb_mtp_file_monitor_event(s->dev.addr, name, "Obj Added");
545
0
        break;
546
547
0
    case QFILE_MONITOR_EVENT_DELETED:
548
        /*
549
         * The kernel issues a IN_IGNORED event
550
         * when a dir containing a watchpoint is
551
         * deleted, so we don't have to delete the
552
         * watchpoint
553
         */
554
0
        o = usb_mtp_object_lookup_name(parent, name, -1);
555
0
        if (!o) {
556
0
            return;
557
0
        }
558
0
        entry = g_new0(MTPMonEntry, 1);
559
0
        entry->handle = o->handle;
560
0
        entry->event = EVT_OBJ_REMOVED;
561
0
        trace_usb_mtp_file_monitor_event(s->dev.addr, o->path, "Obj Deleted");
562
0
        usb_mtp_object_free(s, o);
563
0
        break;
564
565
0
    case QFILE_MONITOR_EVENT_MODIFIED:
566
0
        o = usb_mtp_object_lookup_name(parent, name, -1);
567
0
        if (!o) {
568
0
            return;
569
0
        }
570
0
        entry = g_new0(MTPMonEntry, 1);
571
0
        entry->handle = o->handle;
572
0
        entry->event = EVT_OBJ_INFO_CHANGED;
573
0
        trace_usb_mtp_file_monitor_event(s->dev.addr, o->path, "Obj Modified");
574
0
        break;
575
576
0
    case QFILE_MONITOR_EVENT_IGNORED:
577
0
        trace_usb_mtp_file_monitor_event(s->dev.addr, parent->path,
578
0
                                    "Obj parent dir ignored");
579
0
        break;
580
581
0
    case QFILE_MONITOR_EVENT_ATTRIBUTES:
582
0
        break;
583
584
0
    default:
585
0
        g_assert_not_reached();
586
0
    }
587
588
0
    if (entry) {
589
0
        QTAILQ_INSERT_HEAD(&s->events, entry, next);
590
0
    }
591
0
}
592
593
static void usb_mtp_file_monitor_cleanup(MTPState *s)
594
0
{
595
0
    MTPMonEntry *e, *p;
596
597
0
    QTAILQ_FOREACH_SAFE(e, &s->events, next, p) {
598
0
        QTAILQ_REMOVE(&s->events, e, next);
599
0
        g_free(e);
600
0
    }
601
602
0
    qemu_file_monitor_free(s->file_monitor);
603
0
    s->file_monitor = NULL;
604
0
}
605
606
607
static void usb_mtp_object_readdir(MTPState *s, MTPObject *o)
608
0
{
609
0
    struct dirent *entry;
610
0
    DIR *dir;
611
0
    int fd;
612
0
    Error *err = NULL;
613
614
0
    if (o->have_children) {
615
0
        return;
616
0
    }
617
0
    o->have_children = true;
618
619
0
    fd = open(o->path, O_DIRECTORY | O_CLOEXEC | O_NOFOLLOW);
620
0
    if (fd < 0) {
621
0
        return;
622
0
    }
623
0
    dir = fdopendir(fd);
624
0
    if (!dir) {
625
0
        close(fd);
626
0
        return;
627
0
    }
628
629
0
    if (s->file_monitor) {
630
0
        int64_t id = qemu_file_monitor_add_watch(s->file_monitor, o->path, NULL,
631
0
                                                 file_monitor_event, s, &err);
632
0
        if (id == -1) {
633
0
            error_reportf_err(err,
634
0
                              "usb-mtp: failed to add watch for %s: ",
635
0
                              o->path);
636
0
        } else {
637
0
            trace_usb_mtp_file_monitor_event(s->dev.addr, o->path,
638
0
                                             "Watch Added");
639
0
            o->watchid = id;
640
0
        }
641
0
    }
642
643
0
    while ((entry = readdir(dir)) != NULL) {
644
0
        usb_mtp_add_child(s, o, entry->d_name);
645
0
    }
646
0
    closedir(dir);
647
0
}
648
649
/* ----------------------------------------------------------------------- */
650
651
static MTPData *usb_mtp_data_alloc(MTPControl *c)
652
0
{
653
0
    MTPData *data = g_new0(MTPData, 1);
654
655
0
    data->code  = c->code;
656
0
    data->trans = c->trans;
657
0
    data->fd    = -1;
658
0
    data->first = true;
659
0
    return data;
660
0
}
661
662
static void usb_mtp_data_free(MTPData *data)
663
0
{
664
0
    if (data == NULL) {
665
0
        return;
666
0
    }
667
0
    if (data->fd != -1) {
668
0
        close(data->fd);
669
0
    }
670
0
    g_free(data->data);
671
0
    g_free(data);
672
0
}
673
674
static void usb_mtp_realloc(MTPData *data, uint32_t bytes)
675
0
{
676
0
    if (data->length + bytes <= data->alloc) {
677
0
        return;
678
0
    }
679
0
    data->alloc = (data->length + bytes + 0xff) & ~0xff;
680
0
    data->data  = g_realloc(data->data, data->alloc);
681
0
}
682
683
static void usb_mtp_add_u8(MTPData *data, uint8_t val)
684
0
{
685
0
    usb_mtp_realloc(data, 1);
686
0
    data->data[data->length++] = val;
687
0
}
688
689
static void usb_mtp_add_u16(MTPData *data, uint16_t val)
690
0
{
691
0
    usb_mtp_realloc(data, 2);
692
0
    data->data[data->length++] = (val >> 0) & 0xff;
693
0
    data->data[data->length++] = (val >> 8) & 0xff;
694
0
}
695
696
static void usb_mtp_add_u32(MTPData *data, uint32_t val)
697
0
{
698
0
    usb_mtp_realloc(data, 4);
699
0
    data->data[data->length++] = (val >>  0) & 0xff;
700
0
    data->data[data->length++] = (val >>  8) & 0xff;
701
0
    data->data[data->length++] = (val >> 16) & 0xff;
702
0
    data->data[data->length++] = (val >> 24) & 0xff;
703
0
}
704
705
static void usb_mtp_add_u64(MTPData *data, uint64_t val)
706
0
{
707
0
    usb_mtp_realloc(data, 8);
708
0
    data->data[data->length++] = (val >>  0) & 0xff;
709
0
    data->data[data->length++] = (val >>  8) & 0xff;
710
0
    data->data[data->length++] = (val >> 16) & 0xff;
711
0
    data->data[data->length++] = (val >> 24) & 0xff;
712
0
    data->data[data->length++] = (val >> 32) & 0xff;
713
0
    data->data[data->length++] = (val >> 40) & 0xff;
714
0
    data->data[data->length++] = (val >> 48) & 0xff;
715
0
    data->data[data->length++] = (val >> 56) & 0xff;
716
0
}
717
718
static void usb_mtp_add_u16_array(MTPData *data, uint32_t len,
719
                                  const uint16_t *vals)
720
0
{
721
0
    int i;
722
723
0
    usb_mtp_add_u32(data, len);
724
0
    for (i = 0; i < len; i++) {
725
0
        usb_mtp_add_u16(data, vals[i]);
726
0
    }
727
0
}
728
729
static void usb_mtp_add_u32_array(MTPData *data, uint32_t len,
730
                                  const uint32_t *vals)
731
0
{
732
0
    int i;
733
734
0
    usb_mtp_add_u32(data, len);
735
0
    for (i = 0; i < len; i++) {
736
0
        usb_mtp_add_u32(data, vals[i]);
737
0
    }
738
0
}
739
740
static void usb_mtp_add_wstr(MTPData *data, const wchar_t *str)
741
0
{
742
0
    uint32_t len = wcslen(str);
743
0
    int i;
744
745
0
    if (len > 0) {
746
0
        len++; /* include terminating L'\0' */
747
0
    }
748
749
0
    usb_mtp_add_u8(data, len);
750
0
    for (i = 0; i < len; i++) {
751
0
        usb_mtp_add_u16(data, str[i]);
752
0
    }
753
0
}
754
755
static void usb_mtp_add_str(MTPData *data, const char *str)
756
0
{
757
0
    uint32_t len = strlen(str)+1;
758
0
    wchar_t *wstr = g_new(wchar_t, len);
759
0
    size_t ret;
760
761
0
    ret = mbstowcs(wstr, str, len);
762
0
    if (ret == -1) {
763
0
        usb_mtp_add_wstr(data, L"Oops");
764
0
    } else {
765
0
        usb_mtp_add_wstr(data, wstr);
766
0
    }
767
768
0
    g_free(wstr);
769
0
}
770
771
static void usb_mtp_add_time(MTPData *data, time_t time)
772
0
{
773
0
    g_autoptr(GDateTime) then = g_date_time_new_from_unix_utc(time);
774
0
    g_autofree char *thenstr = g_date_time_format(then, "%Y%m%dT%H%M%S");
775
0
    usb_mtp_add_str(data, thenstr);
776
0
}
777
778
/* ----------------------------------------------------------------------- */
779
780
static void usb_mtp_queue_result(MTPState *s, uint16_t code, uint32_t trans,
781
                                 int argc, uint32_t arg0, uint32_t arg1,
782
                                 uint32_t arg2)
783
0
{
784
0
    MTPControl *c = g_new0(MTPControl, 1);
785
786
0
    c->code  = code;
787
0
    c->trans = trans;
788
0
    c->argc  = argc;
789
0
    if (argc > 0) {
790
0
        c->argv[0] = arg0;
791
0
    }
792
0
    if (argc > 1) {
793
0
        c->argv[1] = arg1;
794
0
    }
795
0
    if (argc > 2) {
796
0
        c->argv[2] = arg2;
797
0
    }
798
799
0
    assert(s->result == NULL);
800
0
    s->result = c;
801
0
}
802
803
/* ----------------------------------------------------------------------- */
804
805
static MTPData *usb_mtp_get_device_info(MTPState *s, MTPControl *c)
806
0
{
807
0
    static const uint16_t ops[] = {
808
0
        CMD_GET_DEVICE_INFO,
809
0
        CMD_OPEN_SESSION,
810
0
        CMD_CLOSE_SESSION,
811
0
        CMD_GET_STORAGE_IDS,
812
0
        CMD_GET_STORAGE_INFO,
813
0
        CMD_GET_NUM_OBJECTS,
814
0
        CMD_GET_OBJECT_HANDLES,
815
0
        CMD_GET_OBJECT_INFO,
816
0
        CMD_DELETE_OBJECT,
817
0
        CMD_SEND_OBJECT_INFO,
818
0
        CMD_SEND_OBJECT,
819
0
        CMD_GET_OBJECT,
820
0
        CMD_GET_PARTIAL_OBJECT,
821
0
        CMD_GET_OBJECT_PROPS_SUPPORTED,
822
0
        CMD_GET_OBJECT_PROP_DESC,
823
0
        CMD_GET_OBJECT_PROP_VALUE,
824
0
    };
825
0
    static const uint16_t fmt[] = {
826
0
        FMT_UNDEFINED_OBJECT,
827
0
        FMT_ASSOCIATION,
828
0
    };
829
0
    MTPData *d = usb_mtp_data_alloc(c);
830
831
0
    trace_usb_mtp_op_get_device_info(s->dev.addr);
832
833
0
    usb_mtp_add_u16(d, 100);
834
0
    usb_mtp_add_u32(d, 0x00000006);
835
0
    usb_mtp_add_u16(d, 0x0064);
836
0
    usb_mtp_add_wstr(d, L"");
837
0
    usb_mtp_add_u16(d, 0x0000);
838
839
0
    usb_mtp_add_u16_array(d, ARRAY_SIZE(ops), ops);
840
0
    usb_mtp_add_u16_array(d, 0, NULL);
841
0
    usb_mtp_add_u16_array(d, 0, NULL);
842
0
    usb_mtp_add_u16_array(d, 0, NULL);
843
0
    usb_mtp_add_u16_array(d, ARRAY_SIZE(fmt), fmt);
844
845
0
    usb_mtp_add_wstr(d, L"" MTP_MANUFACTURER);
846
0
    usb_mtp_add_wstr(d, L"" MTP_PRODUCT);
847
0
    usb_mtp_add_wstr(d, L"0.1");
848
0
    usb_mtp_add_wstr(d, L"0123456789abcdef0123456789abcdef");
849
850
0
    return d;
851
0
}
852
853
static MTPData *usb_mtp_get_storage_ids(MTPState *s, MTPControl *c)
854
0
{
855
0
    static const uint32_t ids[] = {
856
0
        QEMU_STORAGE_ID,
857
0
    };
858
0
    MTPData *d = usb_mtp_data_alloc(c);
859
860
0
    trace_usb_mtp_op_get_storage_ids(s->dev.addr);
861
862
0
    usb_mtp_add_u32_array(d, ARRAY_SIZE(ids), ids);
863
864
0
    return d;
865
0
}
866
867
static MTPData *usb_mtp_get_storage_info(MTPState *s, MTPControl *c)
868
0
{
869
0
    MTPData *d = usb_mtp_data_alloc(c);
870
0
    struct statvfs buf;
871
0
    int rc;
872
873
0
    trace_usb_mtp_op_get_storage_info(s->dev.addr);
874
875
0
    if (FLAG_SET(s, MTP_FLAG_WRITABLE)) {
876
0
        usb_mtp_add_u16(d, 0x0003);
877
0
        usb_mtp_add_u16(d, 0x0002);
878
0
        usb_mtp_add_u16(d, 0x0000);
879
0
    } else {
880
0
        usb_mtp_add_u16(d, 0x0001);
881
0
        usb_mtp_add_u16(d, 0x0002);
882
0
        usb_mtp_add_u16(d, 0x0001);
883
0
    }
884
885
0
    rc = statvfs(s->root, &buf);
886
0
    if (rc == 0) {
887
0
        usb_mtp_add_u64(d, (uint64_t)buf.f_frsize * buf.f_blocks);
888
0
        usb_mtp_add_u64(d, (uint64_t)buf.f_frsize * buf.f_bavail);
889
0
        usb_mtp_add_u32(d, buf.f_ffree);
890
0
    } else {
891
0
        usb_mtp_add_u64(d, 0xffffffff);
892
0
        usb_mtp_add_u64(d, 0xffffffff);
893
0
        usb_mtp_add_u32(d, 0xffffffff);
894
0
    }
895
896
0
    usb_mtp_add_str(d, s->desc);
897
0
    usb_mtp_add_wstr(d, L"123456789abcdef");
898
0
    return d;
899
0
}
900
901
static MTPData *usb_mtp_get_object_handles(MTPState *s, MTPControl *c,
902
                                           MTPObject *o)
903
0
{
904
0
    MTPData *d = usb_mtp_data_alloc(c);
905
0
    uint32_t i = 0;
906
0
    g_autofree uint32_t *handles = g_new(uint32_t, o->nchildren);
907
0
    MTPObject *iter;
908
909
0
    trace_usb_mtp_op_get_object_handles(s->dev.addr, o->handle, o->path);
910
911
0
    QLIST_FOREACH(iter, &o->children, list) {
912
0
        handles[i++] = iter->handle;
913
0
    }
914
0
    assert(i == o->nchildren);
915
0
    usb_mtp_add_u32_array(d, o->nchildren, handles);
916
917
0
    return d;
918
0
}
919
920
static MTPData *usb_mtp_get_object_info(MTPState *s, MTPControl *c,
921
                                        MTPObject *o)
922
0
{
923
0
    MTPData *d = usb_mtp_data_alloc(c);
924
925
0
    trace_usb_mtp_op_get_object_info(s->dev.addr, o->handle, o->path);
926
927
0
    usb_mtp_add_u32(d, QEMU_STORAGE_ID);
928
0
    usb_mtp_add_u16(d, o->format);
929
0
    usb_mtp_add_u16(d, 0);
930
931
0
    if (o->stat.st_size > 0xFFFFFFFF) {
932
0
        usb_mtp_add_u32(d, 0xFFFFFFFF);
933
0
    } else {
934
0
        usb_mtp_add_u32(d, o->stat.st_size);
935
0
    }
936
937
0
    usb_mtp_add_u16(d, 0);
938
0
    usb_mtp_add_u32(d, 0);
939
0
    usb_mtp_add_u32(d, 0);
940
0
    usb_mtp_add_u32(d, 0);
941
0
    usb_mtp_add_u32(d, 0);
942
0
    usb_mtp_add_u32(d, 0);
943
0
    usb_mtp_add_u32(d, 0);
944
945
0
    if (o->parent) {
946
0
        usb_mtp_add_u32(d, o->parent->handle);
947
0
    } else {
948
0
        usb_mtp_add_u32(d, 0);
949
0
    }
950
0
    if (o->format == FMT_ASSOCIATION) {
951
0
        usb_mtp_add_u16(d, 0x0001);
952
0
        usb_mtp_add_u32(d, 0x00000001);
953
0
        usb_mtp_add_u32(d, 0);
954
0
    } else {
955
0
        usb_mtp_add_u16(d, 0);
956
0
        usb_mtp_add_u32(d, 0);
957
0
        usb_mtp_add_u32(d, 0);
958
0
    }
959
960
0
    usb_mtp_add_str(d, o->name);
961
0
    usb_mtp_add_time(d, o->stat.st_ctime);
962
0
    usb_mtp_add_time(d, o->stat.st_mtime);
963
0
    usb_mtp_add_wstr(d, L"");
964
965
0
    return d;
966
0
}
967
968
static MTPData *usb_mtp_get_object(MTPState *s, MTPControl *c,
969
                                   MTPObject *o)
970
0
{
971
0
    MTPData *d = usb_mtp_data_alloc(c);
972
973
0
    trace_usb_mtp_op_get_object(s->dev.addr, o->handle, o->path);
974
975
0
    d->fd = open(o->path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
976
0
    if (d->fd == -1) {
977
0
        usb_mtp_data_free(d);
978
0
        return NULL;
979
0
    }
980
0
    d->length = o->stat.st_size;
981
0
    d->alloc  = 512;
982
0
    d->data   = g_malloc(d->alloc);
983
0
    return d;
984
0
}
985
986
static MTPData *usb_mtp_get_partial_object(MTPState *s, MTPControl *c,
987
                                           MTPObject *o)
988
0
{
989
0
    MTPData *d;
990
0
    off_t offset;
991
992
0
    if (c->argc <= 2) {
993
0
        return NULL;
994
0
    }
995
0
    trace_usb_mtp_op_get_partial_object(s->dev.addr, o->handle, o->path,
996
0
                                        c->argv[1], c->argv[2]);
997
998
0
    d = usb_mtp_data_alloc(c);
999
0
    d->fd = open(o->path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
1000
0
    if (d->fd == -1) {
1001
0
        usb_mtp_data_free(d);
1002
0
        return NULL;
1003
0
    }
1004
1005
0
    offset = c->argv[1];
1006
0
    if (offset > o->stat.st_size) {
1007
0
        offset = o->stat.st_size;
1008
0
    }
1009
0
    if (lseek(d->fd, offset, SEEK_SET) < 0) {
1010
0
        usb_mtp_data_free(d);
1011
0
        return NULL;
1012
0
    }
1013
1014
0
    d->length = c->argv[2];
1015
0
    if (d->length > o->stat.st_size - offset) {
1016
0
        d->length = o->stat.st_size - offset;
1017
0
    }
1018
1019
0
    return d;
1020
0
}
1021
1022
static MTPData *usb_mtp_get_object_props_supported(MTPState *s, MTPControl *c)
1023
0
{
1024
0
    static const uint16_t props[] = {
1025
0
        PROP_STORAGE_ID,
1026
0
        PROP_OBJECT_FORMAT,
1027
0
        PROP_OBJECT_COMPRESSED_SIZE,
1028
0
        PROP_PARENT_OBJECT,
1029
0
        PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER,
1030
0
        PROP_NAME,
1031
0
    };
1032
0
    MTPData *d = usb_mtp_data_alloc(c);
1033
0
    usb_mtp_add_u16_array(d, ARRAY_SIZE(props), props);
1034
1035
0
    return d;
1036
0
}
1037
1038
static MTPData *usb_mtp_get_object_prop_desc(MTPState *s, MTPControl *c)
1039
0
{
1040
0
    MTPData *d = usb_mtp_data_alloc(c);
1041
0
    switch (c->argv[0]) {
1042
0
    case PROP_STORAGE_ID:
1043
0
        usb_mtp_add_u16(d, PROP_STORAGE_ID);
1044
0
        usb_mtp_add_u16(d, DATA_TYPE_UINT32);
1045
0
        usb_mtp_add_u8(d, 0x00);
1046
0
        usb_mtp_add_u32(d, 0x00000000);
1047
0
        usb_mtp_add_u32(d, 0x00000000);
1048
0
        usb_mtp_add_u8(d, 0x00);
1049
0
        break;
1050
0
    case PROP_OBJECT_FORMAT:
1051
0
        usb_mtp_add_u16(d, PROP_OBJECT_FORMAT);
1052
0
        usb_mtp_add_u16(d, DATA_TYPE_UINT16);
1053
0
        usb_mtp_add_u8(d, 0x00);
1054
0
        usb_mtp_add_u16(d, 0x0000);
1055
0
        usb_mtp_add_u32(d, 0x00000000);
1056
0
        usb_mtp_add_u8(d, 0x00);
1057
0
        break;
1058
0
    case PROP_OBJECT_COMPRESSED_SIZE:
1059
0
        usb_mtp_add_u16(d, PROP_OBJECT_COMPRESSED_SIZE);
1060
0
        usb_mtp_add_u16(d, DATA_TYPE_UINT64);
1061
0
        usb_mtp_add_u8(d, 0x00);
1062
0
        usb_mtp_add_u64(d, 0x0000000000000000);
1063
0
        usb_mtp_add_u32(d, 0x00000000);
1064
0
        usb_mtp_add_u8(d, 0x00);
1065
0
        break;
1066
0
    case PROP_PARENT_OBJECT:
1067
0
        usb_mtp_add_u16(d, PROP_PARENT_OBJECT);
1068
0
        usb_mtp_add_u16(d, DATA_TYPE_UINT32);
1069
0
        usb_mtp_add_u8(d, 0x00);
1070
0
        usb_mtp_add_u32(d, 0x00000000);
1071
0
        usb_mtp_add_u32(d, 0x00000000);
1072
0
        usb_mtp_add_u8(d, 0x00);
1073
0
        break;
1074
0
    case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER:
1075
0
        usb_mtp_add_u16(d, PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER);
1076
0
        usb_mtp_add_u16(d, DATA_TYPE_UINT128);
1077
0
        usb_mtp_add_u8(d, 0x00);
1078
0
        usb_mtp_add_u64(d, 0x0000000000000000);
1079
0
        usb_mtp_add_u64(d, 0x0000000000000000);
1080
0
        usb_mtp_add_u32(d, 0x00000000);
1081
0
        usb_mtp_add_u8(d, 0x00);
1082
0
        break;
1083
0
    case PROP_NAME:
1084
0
        usb_mtp_add_u16(d, PROP_NAME);
1085
0
        usb_mtp_add_u16(d, DATA_TYPE_STRING);
1086
0
        usb_mtp_add_u8(d, 0x00);
1087
0
        usb_mtp_add_u8(d, 0x00);
1088
0
        usb_mtp_add_u32(d, 0x00000000);
1089
0
        usb_mtp_add_u8(d, 0x00);
1090
0
        break;
1091
0
    default:
1092
0
        usb_mtp_data_free(d);
1093
0
        return NULL;
1094
0
    }
1095
1096
0
    return d;
1097
0
}
1098
1099
static MTPData *usb_mtp_get_object_prop_value(MTPState *s, MTPControl *c,
1100
                                              MTPObject *o)
1101
0
{
1102
0
    MTPData *d = usb_mtp_data_alloc(c);
1103
0
    switch (c->argv[1]) {
1104
0
    case PROP_STORAGE_ID:
1105
0
        usb_mtp_add_u32(d, QEMU_STORAGE_ID);
1106
0
        break;
1107
0
    case PROP_OBJECT_FORMAT:
1108
0
        usb_mtp_add_u16(d, o->format);
1109
0
        break;
1110
0
    case PROP_OBJECT_COMPRESSED_SIZE:
1111
0
        usb_mtp_add_u64(d, o->stat.st_size);
1112
0
        break;
1113
0
    case PROP_PARENT_OBJECT:
1114
0
        if (o->parent == NULL) {
1115
0
            usb_mtp_add_u32(d, 0x00000000);
1116
0
        } else {
1117
0
            usb_mtp_add_u32(d, o->parent->handle);
1118
0
        }
1119
0
        break;
1120
0
    case PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER:
1121
        /* Should be persistent between sessions,
1122
         * but using our objedt ID is "good enough"
1123
         * for now */
1124
0
        usb_mtp_add_u64(d, 0x0000000000000000);
1125
0
        usb_mtp_add_u64(d, o->handle);
1126
0
        break;
1127
0
    case PROP_NAME:
1128
0
        usb_mtp_add_str(d, o->name);
1129
0
        break;
1130
0
    default:
1131
0
        usb_mtp_data_free(d);
1132
0
        return NULL;
1133
0
    }
1134
1135
0
    return d;
1136
0
}
1137
1138
/*
1139
 * Return values when object @o is deleted.
1140
 * If at least one of the deletions succeeded,
1141
 * DELETE_SUCCESS is set and if at least one
1142
 * of the deletions failed, DELETE_FAILURE is
1143
 * set. Both bits being set (DELETE_PARTIAL)
1144
 * signifies a  RES_PARTIAL_DELETE being sent
1145
 * back to the initiator.
1146
 */
1147
enum {
1148
    DELETE_SUCCESS = (1 << 0),
1149
    DELETE_FAILURE = (1 << 1),
1150
    DELETE_PARTIAL = (DELETE_FAILURE | DELETE_SUCCESS),
1151
};
1152
1153
static int usb_mtp_deletefn(MTPState *s, MTPObject *o, uint32_t trans)
1154
0
{
1155
0
    MTPObject *iter, *iter2, *iter2_next;
1156
0
    int ret = 0;
1157
1158
    /*
1159
     * TODO: Add support for Protection Status
1160
     */
1161
1162
0
    QLIST_FOREACH(iter, &o->children, list) {
1163
0
        if (iter->format == FMT_ASSOCIATION) {
1164
0
            QLIST_FOREACH_SAFE(iter2, &iter->children, list, iter2_next) {
1165
0
                ret |= usb_mtp_deletefn(s, iter2, trans);
1166
0
            }
1167
0
        }
1168
0
    }
1169
1170
0
    if (o->format == FMT_UNDEFINED_OBJECT) {
1171
0
        if (remove(o->path)) {
1172
0
            ret |= DELETE_FAILURE;
1173
0
        } else {
1174
0
            usb_mtp_object_free(s, o);
1175
0
            ret |= DELETE_SUCCESS;
1176
0
        }
1177
0
    } else if (o->format == FMT_ASSOCIATION) {
1178
0
        if (rmdir(o->path)) {
1179
0
            ret |= DELETE_FAILURE;
1180
0
        } else {
1181
0
            usb_mtp_object_free(s, o);
1182
0
            ret |= DELETE_SUCCESS;
1183
0
        }
1184
0
    }
1185
1186
0
    return ret;
1187
0
}
1188
1189
static void usb_mtp_object_delete(MTPState *s, uint32_t handle,
1190
                                  uint32_t format_code, uint32_t trans)
1191
0
{
1192
0
    MTPObject *o;
1193
0
    int ret;
1194
1195
    /* Return error if store is read-only */
1196
0
    if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1197
0
        usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1198
0
                             trans, 0, 0, 0, 0);
1199
0
        return;
1200
0
    }
1201
1202
0
    if (format_code != 0) {
1203
0
        usb_mtp_queue_result(s, RES_SPEC_BY_FORMAT_UNSUPPORTED,
1204
0
                             trans, 0, 0, 0, 0);
1205
0
        return;
1206
0
    }
1207
1208
0
    if (handle == 0xFFFFFFF) {
1209
0
        o = QTAILQ_FIRST(&s->objects);
1210
0
    } else {
1211
0
        o = usb_mtp_object_lookup(s, handle);
1212
0
    }
1213
0
    if (o == NULL) {
1214
0
        usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1215
0
                             trans, 0, 0, 0, 0);
1216
0
        return;
1217
0
    }
1218
1219
0
    ret = usb_mtp_deletefn(s, o, trans);
1220
0
    switch (ret) {
1221
0
    case DELETE_SUCCESS:
1222
0
        usb_mtp_queue_result(s, RES_OK, trans,
1223
0
                             0, 0, 0, 0);
1224
0
        break;
1225
0
    case DELETE_FAILURE:
1226
0
        usb_mtp_queue_result(s, RES_PARTIAL_DELETE,
1227
0
                             trans, 0, 0, 0, 0);
1228
0
        break;
1229
0
    case DELETE_PARTIAL:
1230
0
        usb_mtp_queue_result(s, RES_PARTIAL_DELETE,
1231
0
                             trans, 0, 0, 0, 0);
1232
0
        break;
1233
0
    default:
1234
0
        g_assert_not_reached();
1235
0
    }
1236
0
}
1237
1238
static void usb_mtp_command(MTPState *s, MTPControl *c)
1239
0
{
1240
0
    MTPData *data_in = NULL;
1241
0
    MTPObject *o = NULL;
1242
0
    uint32_t nres = 0, res0 = 0;
1243
0
    Error *err = NULL;
1244
1245
    /* sanity checks */
1246
0
    if (c->code >= CMD_CLOSE_SESSION && s->session == 0) {
1247
0
        usb_mtp_queue_result(s, RES_SESSION_NOT_OPEN,
1248
0
                             c->trans, 0, 0, 0, 0);
1249
0
        return;
1250
0
    }
1251
1252
    /* process commands */
1253
0
    switch (c->code) {
1254
0
    case CMD_GET_DEVICE_INFO:
1255
0
        data_in = usb_mtp_get_device_info(s, c);
1256
0
        break;
1257
0
    case CMD_OPEN_SESSION:
1258
0
        if (s->session) {
1259
0
            usb_mtp_queue_result(s, RES_SESSION_ALREADY_OPEN,
1260
0
                                 c->trans, 1, s->session, 0, 0);
1261
0
            return;
1262
0
        }
1263
0
        if (c->argv[0] == 0) {
1264
0
            usb_mtp_queue_result(s, RES_INVALID_PARAMETER,
1265
0
                                 c->trans, 0, 0, 0, 0);
1266
0
            return;
1267
0
        }
1268
0
        trace_usb_mtp_op_open_session(s->dev.addr);
1269
0
        s->session = c->argv[0];
1270
0
        usb_mtp_object_alloc(s, s->next_handle++, NULL, s->root);
1271
1272
0
        s->file_monitor = qemu_file_monitor_new(&err);
1273
0
        if (err) {
1274
0
            error_reportf_err(err,
1275
0
                              "usb-mtp: file monitoring init failed: ");
1276
0
        } else {
1277
0
            QTAILQ_INIT(&s->events);
1278
0
        }
1279
0
        break;
1280
0
    case CMD_CLOSE_SESSION:
1281
0
        trace_usb_mtp_op_close_session(s->dev.addr);
1282
0
        s->session = 0;
1283
0
        s->next_handle = 0;
1284
0
        usb_mtp_file_monitor_cleanup(s);
1285
0
        usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
1286
0
        assert(QTAILQ_EMPTY(&s->objects));
1287
0
        break;
1288
0
    case CMD_GET_STORAGE_IDS:
1289
0
        data_in = usb_mtp_get_storage_ids(s, c);
1290
0
        break;
1291
0
    case CMD_GET_STORAGE_INFO:
1292
0
        if (c->argv[0] != QEMU_STORAGE_ID &&
1293
0
            c->argv[0] != 0xffffffff) {
1294
0
            usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
1295
0
                                 c->trans, 0, 0, 0, 0);
1296
0
            return;
1297
0
        }
1298
0
        data_in = usb_mtp_get_storage_info(s, c);
1299
0
        break;
1300
0
    case CMD_GET_NUM_OBJECTS:
1301
0
    case CMD_GET_OBJECT_HANDLES:
1302
0
        if (c->argv[0] != QEMU_STORAGE_ID &&
1303
0
            c->argv[0] != 0xffffffff) {
1304
0
            usb_mtp_queue_result(s, RES_INVALID_STORAGE_ID,
1305
0
                                 c->trans, 0, 0, 0, 0);
1306
0
            return;
1307
0
        }
1308
0
        if (c->argv[1] != 0x00000000) {
1309
0
            usb_mtp_queue_result(s, RES_SPEC_BY_FORMAT_UNSUPPORTED,
1310
0
                                 c->trans, 0, 0, 0, 0);
1311
0
            return;
1312
0
        }
1313
0
        if (c->argv[2] == 0x00000000 ||
1314
0
            c->argv[2] == 0xffffffff) {
1315
0
            o = QTAILQ_FIRST(&s->objects);
1316
0
        } else {
1317
0
            o = usb_mtp_object_lookup(s, c->argv[2]);
1318
0
        }
1319
0
        if (o == NULL) {
1320
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1321
0
                                 c->trans, 0, 0, 0, 0);
1322
0
            return;
1323
0
        }
1324
0
        if (o->format != FMT_ASSOCIATION) {
1325
0
            usb_mtp_queue_result(s, RES_INVALID_PARENT_OBJECT,
1326
0
                                 c->trans, 0, 0, 0, 0);
1327
0
            return;
1328
0
        }
1329
0
        usb_mtp_object_readdir(s, o);
1330
0
        if (c->code == CMD_GET_NUM_OBJECTS) {
1331
0
            trace_usb_mtp_op_get_num_objects(s->dev.addr, o->handle, o->path);
1332
0
            nres = 1;
1333
0
            res0 = o->nchildren;
1334
0
        } else {
1335
0
            data_in = usb_mtp_get_object_handles(s, c, o);
1336
0
        }
1337
0
        break;
1338
0
    case CMD_GET_OBJECT_INFO:
1339
0
        o = usb_mtp_object_lookup(s, c->argv[0]);
1340
0
        if (o == NULL) {
1341
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1342
0
                                 c->trans, 0, 0, 0, 0);
1343
0
            return;
1344
0
        }
1345
0
        data_in = usb_mtp_get_object_info(s, c, o);
1346
0
        break;
1347
0
    case CMD_GET_OBJECT:
1348
0
        o = usb_mtp_object_lookup(s, c->argv[0]);
1349
0
        if (o == NULL) {
1350
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1351
0
                                 c->trans, 0, 0, 0, 0);
1352
0
            return;
1353
0
        }
1354
0
        if (o->format == FMT_ASSOCIATION) {
1355
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1356
0
                                 c->trans, 0, 0, 0, 0);
1357
0
            return;
1358
0
        }
1359
0
        data_in = usb_mtp_get_object(s, c, o);
1360
0
        if (data_in == NULL) {
1361
0
            usb_mtp_queue_result(s, RES_GENERAL_ERROR,
1362
0
                                 c->trans, 0, 0, 0, 0);
1363
0
            return;
1364
0
        }
1365
0
        break;
1366
0
    case CMD_DELETE_OBJECT:
1367
0
        usb_mtp_object_delete(s, c->argv[0], c->argv[1], c->trans);
1368
0
        return;
1369
0
    case CMD_GET_PARTIAL_OBJECT:
1370
0
        o = usb_mtp_object_lookup(s, c->argv[0]);
1371
0
        if (o == NULL) {
1372
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1373
0
                                 c->trans, 0, 0, 0, 0);
1374
0
            return;
1375
0
        }
1376
0
        if (o->format == FMT_ASSOCIATION) {
1377
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1378
0
                                 c->trans, 0, 0, 0, 0);
1379
0
            return;
1380
0
        }
1381
0
        data_in = usb_mtp_get_partial_object(s, c, o);
1382
0
        if (data_in == NULL) {
1383
0
            usb_mtp_queue_result(s, RES_GENERAL_ERROR,
1384
0
                                 c->trans, 0, 0, 0, 0);
1385
0
            return;
1386
0
        }
1387
0
        nres = 1;
1388
0
        res0 = data_in->length;
1389
0
        break;
1390
0
    case CMD_SEND_OBJECT_INFO:
1391
        /* Return error if store is read-only */
1392
0
        if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1393
0
            usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1394
0
                                 c->trans, 0, 0, 0, 0);
1395
0
        } else if (c->argv[0] && (c->argv[0] != QEMU_STORAGE_ID)) {
1396
            /* First parameter points to storage id or is 0 */
1397
0
            usb_mtp_queue_result(s, RES_STORE_NOT_AVAILABLE, c->trans,
1398
0
                                 0, 0, 0, 0);
1399
0
        } else if (c->argv[1] && !c->argv[0]) {
1400
            /* If second parameter is specified, first must also be specified */
1401
0
            usb_mtp_queue_result(s, RES_DESTINATION_UNSUPPORTED, c->trans,
1402
0
                                 0, 0, 0, 0);
1403
0
        } else {
1404
0
            uint32_t handle = c->argv[1];
1405
0
            if (handle == 0xFFFFFFFF || handle == 0) {
1406
                /* root object */
1407
0
                o = QTAILQ_FIRST(&s->objects);
1408
0
            } else {
1409
0
                o = usb_mtp_object_lookup(s, handle);
1410
0
            }
1411
0
            if (o == NULL) {
1412
0
                usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE, c->trans,
1413
0
                                     0, 0, 0, 0);
1414
0
            } else if (o->format != FMT_ASSOCIATION) {
1415
0
                usb_mtp_queue_result(s, RES_INVALID_PARENT_OBJECT, c->trans,
1416
0
                                     0, 0, 0, 0);
1417
0
            }
1418
0
        }
1419
0
        if (o) {
1420
0
            s->dataset.parent_handle = o->handle;
1421
0
        }
1422
0
        s->data_out = usb_mtp_data_alloc(c);
1423
0
        return;
1424
0
    case CMD_SEND_OBJECT:
1425
0
        if (!FLAG_SET(s, MTP_FLAG_WRITABLE)) {
1426
0
            usb_mtp_queue_result(s, RES_STORE_READ_ONLY,
1427
0
                                 c->trans, 0, 0, 0, 0);
1428
0
            return;
1429
0
        }
1430
0
        if (!s->write_pending) {
1431
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO,
1432
0
                                 c->trans, 0, 0, 0, 0);
1433
0
            return;
1434
0
        }
1435
0
        s->data_out = usb_mtp_data_alloc(c);
1436
0
        return;
1437
0
    case CMD_GET_OBJECT_PROPS_SUPPORTED:
1438
0
        if (c->argv[0] != FMT_UNDEFINED_OBJECT &&
1439
0
            c->argv[0] != FMT_ASSOCIATION) {
1440
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_FORMAT_CODE,
1441
0
                                 c->trans, 0, 0, 0, 0);
1442
0
            return;
1443
0
        }
1444
0
        data_in = usb_mtp_get_object_props_supported(s, c);
1445
0
        break;
1446
0
    case CMD_GET_OBJECT_PROP_DESC:
1447
0
        if (c->argv[1] != FMT_UNDEFINED_OBJECT &&
1448
0
            c->argv[1] != FMT_ASSOCIATION) {
1449
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_FORMAT_CODE,
1450
0
                                 c->trans, 0, 0, 0, 0);
1451
0
            return;
1452
0
        }
1453
0
        data_in = usb_mtp_get_object_prop_desc(s, c);
1454
0
        if (data_in == NULL) {
1455
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_PROP_CODE,
1456
0
                                 c->trans, 0, 0, 0, 0);
1457
0
            return;
1458
0
        }
1459
0
        break;
1460
0
    case CMD_GET_OBJECT_PROP_VALUE:
1461
0
        o = usb_mtp_object_lookup(s, c->argv[0]);
1462
0
        if (o == NULL) {
1463
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_HANDLE,
1464
0
                                 c->trans, 0, 0, 0, 0);
1465
0
            return;
1466
0
        }
1467
0
        data_in = usb_mtp_get_object_prop_value(s, c, o);
1468
0
        if (data_in == NULL) {
1469
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECT_PROP_CODE,
1470
0
                                 c->trans, 0, 0, 0, 0);
1471
0
            return;
1472
0
        }
1473
0
        break;
1474
0
    default:
1475
0
        trace_usb_mtp_op_unknown(s->dev.addr, c->code);
1476
0
        usb_mtp_queue_result(s, RES_OPERATION_NOT_SUPPORTED,
1477
0
                             c->trans, 0, 0, 0, 0);
1478
0
        return;
1479
0
    }
1480
1481
    /* return results on success */
1482
0
    if (data_in) {
1483
0
        assert(s->data_in == NULL);
1484
0
        s->data_in = data_in;
1485
0
    }
1486
0
    usb_mtp_queue_result(s, RES_OK, c->trans, nres, res0, 0, 0);
1487
0
}
1488
1489
/* ----------------------------------------------------------------------- */
1490
1491
static void usb_mtp_handle_reset(USBDevice *dev)
1492
0
{
1493
0
    MTPState *s = USB_MTP(dev);
1494
1495
0
    trace_usb_mtp_reset(s->dev.addr);
1496
1497
0
    usb_mtp_file_monitor_cleanup(s);
1498
0
    usb_mtp_object_free(s, QTAILQ_FIRST(&s->objects));
1499
0
    s->session = 0;
1500
0
    usb_mtp_data_free(s->data_in);
1501
0
    s->data_in = NULL;
1502
0
    usb_mtp_data_free(s->data_out);
1503
0
    s->data_out = NULL;
1504
0
    g_free(s->result);
1505
0
    s->result = NULL;
1506
0
}
1507
1508
static void usb_mtp_handle_control(USBDevice *dev, USBPacket *p,
1509
                                   int request, int value, int index,
1510
                                   int length, uint8_t *data)
1511
0
{
1512
0
    int ret;
1513
0
    MTPState *s = USB_MTP(dev);
1514
0
    uint16_t *event = (uint16_t *)data;
1515
1516
0
    switch (request) {
1517
0
    case ClassInterfaceOutRequest | 0x64:
1518
0
        if (*event == EVT_CANCEL_TRANSACTION) {
1519
0
            g_free(s->result);
1520
0
            s->result = NULL;
1521
0
            usb_mtp_data_free(s->data_in);
1522
0
            s->data_in = NULL;
1523
0
            if (s->write_pending) {
1524
0
                g_free(s->dataset.filename);
1525
0
                s->write_pending = false;
1526
0
                s->dataset.size = 0;
1527
0
            }
1528
0
            usb_mtp_data_free(s->data_out);
1529
0
            s->data_out = NULL;
1530
0
        } else {
1531
0
            p->status = USB_RET_STALL;
1532
0
        }
1533
0
        break;
1534
0
    default:
1535
0
        ret = usb_desc_handle_control(dev, p, request,
1536
0
                                      value, index, length, data);
1537
0
        if (ret >= 0) {
1538
0
            return;
1539
0
        }
1540
0
    }
1541
1542
0
    trace_usb_mtp_stall(dev->addr, "unknown control request");
1543
0
}
1544
1545
static void usb_mtp_cancel_packet(USBDevice *dev, USBPacket *p)
1546
0
{
1547
    /* we don't use async packets, so this should never be called */
1548
0
    fprintf(stderr, "%s\n", __func__);
1549
0
}
1550
1551
static char *utf16_to_str(uint8_t len, uint8_t *str16)
1552
0
{
1553
0
    wchar_t *wstr = g_new0(wchar_t, len + 1);
1554
0
    int count, dlen;
1555
0
    char *dest;
1556
1557
0
    for (count = 0; count < len; count++) {
1558
        /* FIXME: not working for surrogate pairs */
1559
0
        wstr[count] = lduw_le_p(str16 + (count * 2));
1560
0
    }
1561
0
    wstr[count] = 0;
1562
1563
0
    dlen = wcstombs(NULL, wstr, 0) + 1;
1564
0
    dest = g_malloc(dlen);
1565
0
    wcstombs(dest, wstr, dlen);
1566
0
    g_free(wstr);
1567
0
    return dest;
1568
0
}
1569
1570
/* Wrapper around write, returns 0 on failure */
1571
static uint64_t write_retry(int fd, void *buf, uint64_t size, off_t offset)
1572
0
{
1573
0
        uint64_t ret = 0;
1574
1575
0
        if (lseek(fd, offset, SEEK_SET) < 0) {
1576
0
            goto done;
1577
0
        }
1578
1579
0
        ret = qemu_write_full(fd, buf, size);
1580
1581
0
done:
1582
0
        return ret;
1583
0
}
1584
1585
static int usb_mtp_update_object(MTPObject *parent, char *name)
1586
0
{
1587
0
    int ret = 0;
1588
1589
0
    MTPObject *o =
1590
0
        usb_mtp_object_lookup_name(parent, name, strlen(name));
1591
1592
0
    if (o) {
1593
0
        ret = lstat(o->path, &o->stat);
1594
0
    }
1595
1596
0
    return ret;
1597
0
}
1598
1599
static void usb_mtp_write_data(MTPState *s, uint32_t handle)
1600
0
{
1601
0
    MTPData *d = s->data_out;
1602
0
    MTPObject *parent =
1603
0
        usb_mtp_object_lookup(s, s->dataset.parent_handle);
1604
0
    char *path = NULL;
1605
0
    uint64_t rc;
1606
0
    mode_t mask = 0755;
1607
0
    int ret = 0;
1608
1609
0
    assert(d != NULL);
1610
1611
0
    switch (d->write_status) {
1612
0
    case WRITE_START:
1613
0
        if (!parent || !s->write_pending) {
1614
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO, d->trans,
1615
0
                0, 0, 0, 0);
1616
0
            return;
1617
0
        }
1618
1619
0
        if (s->dataset.filename) {
1620
0
            path = g_strdup_printf("%s/%s", parent->path, s->dataset.filename);
1621
0
            if (s->dataset.format == FMT_ASSOCIATION) {
1622
0
                ret = g_mkdir(path, mask);
1623
0
                if (!ret) {
1624
0
                    usb_mtp_queue_result(s, RES_OK, d->trans, 3,
1625
0
                                         QEMU_STORAGE_ID,
1626
0
                                         s->dataset.parent_handle,
1627
0
                                         handle);
1628
0
                    goto close;
1629
0
                }
1630
0
                goto done;
1631
0
            }
1632
1633
0
            d->fd = open(path, O_CREAT | O_WRONLY |
1634
0
                         O_CLOEXEC | O_NOFOLLOW, mask & 0666);
1635
0
            if (d->fd == -1) {
1636
0
                ret = 1;
1637
0
                goto done;
1638
0
            }
1639
1640
            /* Return success if initiator sent 0 sized data */
1641
0
            if (!s->dataset.size) {
1642
0
                goto done;
1643
0
            }
1644
0
            if (d->length != MTP_WRITE_BUF_SZ && !d->pending) {
1645
0
                d->write_status = WRITE_END;
1646
0
            }
1647
0
        }
1648
        /* fall through */
1649
0
    case WRITE_CONTINUE:
1650
0
    case WRITE_END:
1651
0
        rc = write_retry(d->fd, d->data, d->data_offset,
1652
0
                         d->offset - d->data_offset);
1653
0
        if (rc != d->data_offset) {
1654
0
            ret = 1;
1655
0
            goto done;
1656
0
        }
1657
0
        if (d->write_status != WRITE_END) {
1658
0
            g_free(path);
1659
0
            return;
1660
0
        } else {
1661
            /*
1662
             * Return an incomplete transfer if file size doesn't match
1663
             * for < 4G file or if lstat fails which will result in an incorrect
1664
             * file size
1665
             */
1666
0
            if ((s->dataset.size != 0xFFFFFFFF &&
1667
0
                 d->offset != s->dataset.size) ||
1668
0
                usb_mtp_update_object(parent, s->dataset.filename)) {
1669
0
                usb_mtp_queue_result(s, RES_INCOMPLETE_TRANSFER, d->trans,
1670
0
                                     0, 0, 0, 0);
1671
0
                goto close;
1672
0
            }
1673
0
        }
1674
0
    }
1675
1676
0
done:
1677
0
    if (ret) {
1678
0
        usb_mtp_queue_result(s, RES_STORE_FULL, d->trans,
1679
0
                             0, 0, 0, 0);
1680
0
    } else {
1681
0
        usb_mtp_queue_result(s, RES_OK, d->trans,
1682
0
                             0, 0, 0, 0);
1683
0
    }
1684
0
close:
1685
    /*
1686
     * The write dataset is kept around and freed only
1687
     * on success or if another write request comes in
1688
     */
1689
0
    if (d->fd != -1) {
1690
0
        close(d->fd);
1691
0
        d->fd = -1;
1692
0
    }
1693
0
    g_free(s->dataset.filename);
1694
0
    s->dataset.size = 0;
1695
0
    g_free(path);
1696
0
    s->write_pending = false;
1697
0
}
1698
1699
static void usb_mtp_write_metadata(MTPState *s)
1700
0
{
1701
0
    MTPData *d = s->data_out;
1702
0
    ObjectInfo *dataset = (ObjectInfo *)d->data;
1703
0
    char *filename;
1704
0
    MTPObject *o;
1705
0
    MTPObject *p = usb_mtp_object_lookup(s, s->dataset.parent_handle);
1706
0
    uint32_t next_handle = s->next_handle;
1707
0
    size_t filename_chars;
1708
1709
0
    if (d->length <= offsetof(ObjectInfo, filename)) {
1710
0
        usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO, d->trans,
1711
0
                             0, 0, 0, 0);
1712
0
        return;
1713
0
    }
1714
1715
0
    filename_chars = d->length - offsetof(ObjectInfo, filename);
1716
1717
    /*
1718
     * filename is utf-16. We're intentionally doing
1719
     * integer division to truncate if malicious guest
1720
     * sent an odd number of bytes.
1721
     */
1722
0
    filename_chars /= 2;
1723
1724
0
    assert(!s->write_pending);
1725
0
    assert(p != NULL);
1726
1727
0
    filename = utf16_to_str(MIN(dataset->length, filename_chars),
1728
0
                            dataset->filename);
1729
1730
0
    if (strchr(filename, '/')) {
1731
0
        usb_mtp_queue_result(s, RES_PARAMETER_NOT_SUPPORTED, d->trans,
1732
0
                             0, 0, 0, 0);
1733
0
        g_free(filename);
1734
0
        return;
1735
0
    }
1736
1737
0
    o = usb_mtp_object_lookup_name(p, filename, -1);
1738
0
    if (o != NULL) {
1739
0
        next_handle = o->handle;
1740
0
    }
1741
1742
0
    s->dataset.filename = filename;
1743
0
    s->dataset.format = dataset->format;
1744
0
    s->dataset.size = dataset->size;
1745
0
    s->write_pending = true;
1746
1747
0
    if (s->dataset.format == FMT_ASSOCIATION) {
1748
0
        usb_mtp_write_data(s, next_handle);
1749
0
    } else {
1750
0
        usb_mtp_queue_result(s, RES_OK, d->trans, 3, QEMU_STORAGE_ID,
1751
0
                             s->dataset.parent_handle, next_handle);
1752
0
    }
1753
0
}
1754
1755
static void usb_mtp_get_data(MTPState *s, mtp_container *container,
1756
                             USBPacket *p)
1757
0
{
1758
0
    MTPData *d = s->data_out;
1759
0
    uint64_t dlen;
1760
0
    uint32_t data_len = p->iov.size;
1761
0
    uint64_t total_len;
1762
1763
0
    if (!d) {
1764
0
            usb_mtp_queue_result(s, RES_INVALID_OBJECTINFO, 0,
1765
0
                                 0, 0, 0, 0);
1766
0
            return;
1767
0
    }
1768
0
    if (d->first) {
1769
        /* Total length of incoming data */
1770
0
        total_len = cpu_to_le32(container->length) - sizeof(mtp_container);
1771
        /* Length of data in this packet */
1772
0
        data_len -= sizeof(mtp_container);
1773
0
        if (total_len < MTP_WRITE_BUF_SZ) {
1774
0
                usb_mtp_realloc(d, total_len);
1775
0
                d->length += total_len;
1776
0
        } else {
1777
0
                usb_mtp_realloc(d, MTP_WRITE_BUF_SZ - sizeof(mtp_container));
1778
0
                d->length += MTP_WRITE_BUF_SZ - sizeof(mtp_container);
1779
0
        }
1780
0
        d->offset = 0;
1781
0
        d->first = false;
1782
0
        d->pending = false;
1783
0
        d->data_offset = 0;
1784
0
        d->write_status = WRITE_START;
1785
0
    }
1786
1787
0
    if (d->pending) {
1788
0
        memset(d->data, 0, d->length);
1789
0
        if (d->length != MTP_WRITE_BUF_SZ) {
1790
0
            usb_mtp_realloc(d, MTP_WRITE_BUF_SZ - d->length);
1791
0
            d->length += (MTP_WRITE_BUF_SZ - d->length);
1792
0
        }
1793
0
        d->pending = false;
1794
0
        d->write_status = WRITE_CONTINUE;
1795
0
        d->data_offset = 0;
1796
0
    }
1797
1798
0
    if (d->length - d->data_offset > data_len) {
1799
0
        dlen = data_len;
1800
0
    } else {
1801
0
        dlen = d->length - d->data_offset;
1802
0
    }
1803
1804
0
    switch (d->code) {
1805
0
    case CMD_SEND_OBJECT_INFO:
1806
0
        usb_packet_copy(p, d->data + d->data_offset, dlen);
1807
0
        d->offset += dlen;
1808
0
        d->data_offset += dlen;
1809
0
        if (d->data_offset == d->length) {
1810
            /* The operation might have already failed */
1811
0
            if (!s->result) {
1812
0
                usb_mtp_write_metadata(s);
1813
0
            }
1814
0
            usb_mtp_data_free(s->data_out);
1815
0
            s->data_out = NULL;
1816
0
            return;
1817
0
        }
1818
0
        break;
1819
0
    case CMD_SEND_OBJECT:
1820
0
        usb_packet_copy(p, d->data + d->data_offset, dlen);
1821
0
        d->offset += dlen;
1822
0
        d->data_offset += dlen;
1823
0
        if ((p->iov.size % 64) || !p->iov.size) {
1824
0
            if (d->length == MTP_WRITE_BUF_SZ) {
1825
0
                d->write_status = WRITE_END;
1826
0
            } else {
1827
0
                d->write_status = WRITE_START;
1828
0
            }
1829
0
            usb_mtp_write_data(s, 0);
1830
0
            usb_mtp_data_free(s->data_out);
1831
0
            s->data_out = NULL;
1832
0
            return;
1833
0
        }
1834
0
        if (d->data_offset == d->length) {
1835
0
            d->pending = true;
1836
0
            usb_mtp_write_data(s, 0);
1837
0
        }
1838
0
        break;
1839
0
    default:
1840
0
        p->status = USB_RET_STALL;
1841
0
        return;
1842
0
    }
1843
0
}
1844
1845
static void usb_mtp_handle_data(USBDevice *dev, USBPacket *p)
1846
0
{
1847
0
    MTPState *s = USB_MTP(dev);
1848
0
    MTPControl cmd;
1849
0
    mtp_container container;
1850
0
    uint32_t params[5];
1851
0
    uint16_t container_type;
1852
0
    int i, rc;
1853
1854
0
    switch (p->ep->nr) {
1855
0
    case EP_DATA_IN:
1856
0
        if (s->data_out != NULL) {
1857
            /* guest bug */
1858
0
            trace_usb_mtp_stall(s->dev.addr, "awaiting data-out");
1859
0
            p->status = USB_RET_STALL;
1860
0
            return;
1861
0
        }
1862
0
        if (p->iov.size < sizeof(container)) {
1863
0
            trace_usb_mtp_stall(s->dev.addr, "packet too small");
1864
0
            p->status = USB_RET_STALL;
1865
0
            return;
1866
0
        }
1867
0
        if (s->data_in !=  NULL) {
1868
0
            MTPData *d = s->data_in;
1869
0
            uint64_t dlen = d->length - d->offset;
1870
0
            if (d->first) {
1871
0
                trace_usb_mtp_data_in(s->dev.addr, d->trans, d->length);
1872
0
                if (d->length + sizeof(container) > 0xFFFFFFFF) {
1873
0
                    container.length = cpu_to_le32(0xFFFFFFFF);
1874
0
                } else {
1875
0
                    container.length =
1876
0
                        cpu_to_le32(d->length + sizeof(container));
1877
0
                }
1878
0
                container.type   = cpu_to_le16(TYPE_DATA);
1879
0
                container.code   = cpu_to_le16(d->code);
1880
0
                container.trans  = cpu_to_le32(d->trans);
1881
0
                usb_packet_copy(p, &container, sizeof(container));
1882
0
                d->first = false;
1883
0
                if (dlen > p->iov.size - sizeof(container)) {
1884
0
                    dlen = p->iov.size - sizeof(container);
1885
0
                }
1886
0
            } else {
1887
0
                if (dlen > p->iov.size) {
1888
0
                    dlen = p->iov.size;
1889
0
                }
1890
0
            }
1891
0
            if (d->fd == -1) {
1892
0
                usb_packet_copy(p, d->data + d->offset, dlen);
1893
0
            } else {
1894
0
                if (d->alloc < p->iov.size) {
1895
0
                    d->alloc = p->iov.size;
1896
0
                    d->data = g_realloc(d->data, d->alloc);
1897
0
                }
1898
0
                rc = read(d->fd, d->data, dlen);
1899
0
                if (rc != dlen) {
1900
0
                    memset(d->data, 0, dlen);
1901
0
                    s->result->code = RES_INCOMPLETE_TRANSFER;
1902
0
                }
1903
0
                usb_packet_copy(p, d->data, dlen);
1904
0
            }
1905
0
            d->offset += dlen;
1906
0
            if (d->offset == d->length) {
1907
0
                usb_mtp_data_free(s->data_in);
1908
0
                s->data_in = NULL;
1909
0
            }
1910
0
        } else if (s->result != NULL) {
1911
0
            MTPControl *r = s->result;
1912
0
            int length = sizeof(container) + r->argc * sizeof(uint32_t);
1913
1914
0
            if (p->iov.size < length) {
1915
0
                trace_usb_mtp_stall(s->dev.addr,
1916
0
                                    "packet too small to send response");
1917
0
                p->status = USB_RET_STALL;
1918
0
                return;
1919
0
            }
1920
0
            if (r->code == RES_OK) {
1921
0
                trace_usb_mtp_success(s->dev.addr, r->trans,
1922
0
                                      (r->argc > 0) ? r->argv[0] : 0,
1923
0
                                      (r->argc > 1) ? r->argv[1] : 0);
1924
0
            } else {
1925
0
                trace_usb_mtp_error(s->dev.addr, r->code, r->trans,
1926
0
                                    (r->argc > 0) ? r->argv[0] : 0,
1927
0
                                    (r->argc > 1) ? r->argv[1] : 0);
1928
0
            }
1929
0
            container.length = cpu_to_le32(length);
1930
0
            container.type   = cpu_to_le16(TYPE_RESPONSE);
1931
0
            container.code   = cpu_to_le16(r->code);
1932
0
            container.trans  = cpu_to_le32(r->trans);
1933
0
            for (i = 0; i < r->argc; i++) {
1934
0
                params[i] = cpu_to_le32(r->argv[i]);
1935
0
            }
1936
0
            usb_packet_copy(p, &container, sizeof(container));
1937
0
            usb_packet_copy(p, &params, length - sizeof(container));
1938
0
            g_free(s->result);
1939
0
            s->result = NULL;
1940
0
        }
1941
0
        break;
1942
0
    case EP_DATA_OUT:
1943
0
        if (p->iov.size < sizeof(container)) {
1944
0
            trace_usb_mtp_stall(s->dev.addr, "packet too small");
1945
0
            p->status = USB_RET_STALL;
1946
0
            return;
1947
0
        }
1948
0
        if ((s->data_out != NULL) && !s->data_out->first) {
1949
0
            container_type = TYPE_DATA;
1950
0
        } else {
1951
0
            usb_packet_copy(p, &container, sizeof(container));
1952
0
            container_type = le16_to_cpu(container.type);
1953
0
        }
1954
0
        switch (container_type) {
1955
0
        case TYPE_COMMAND:
1956
0
            if (s->data_in || s->data_out || s->result) {
1957
0
                trace_usb_mtp_stall(s->dev.addr, "transaction inflight");
1958
0
                p->status = USB_RET_STALL;
1959
0
                return;
1960
0
            }
1961
0
            cmd.code = le16_to_cpu(container.code);
1962
0
            cmd.argc = (le32_to_cpu(container.length) - sizeof(container))
1963
0
                / sizeof(uint32_t);
1964
0
            cmd.trans = le32_to_cpu(container.trans);
1965
0
            if (cmd.argc > ARRAY_SIZE(cmd.argv)) {
1966
0
                cmd.argc = ARRAY_SIZE(cmd.argv);
1967
0
            }
1968
0
            if (p->iov.size < sizeof(container) + cmd.argc * sizeof(uint32_t)) {
1969
0
                trace_usb_mtp_stall(s->dev.addr, "packet too small");
1970
0
                p->status = USB_RET_STALL;
1971
0
                return;
1972
0
            }
1973
0
            usb_packet_copy(p, &params, cmd.argc * sizeof(uint32_t));
1974
0
            for (i = 0; i < cmd.argc; i++) {
1975
0
                cmd.argv[i] = le32_to_cpu(params[i]);
1976
0
            }
1977
0
            trace_usb_mtp_command(s->dev.addr, cmd.code, cmd.trans,
1978
0
                                  (cmd.argc > 0) ? cmd.argv[0] : 0,
1979
0
                                  (cmd.argc > 1) ? cmd.argv[1] : 0,
1980
0
                                  (cmd.argc > 2) ? cmd.argv[2] : 0,
1981
0
                                  (cmd.argc > 3) ? cmd.argv[3] : 0,
1982
0
                                  (cmd.argc > 4) ? cmd.argv[4] : 0);
1983
0
            usb_mtp_command(s, &cmd);
1984
0
            break;
1985
0
        case TYPE_DATA:
1986
            /* One of the previous transfers has already errored but the
1987
             * responder is still sending data associated with it
1988
             */
1989
0
            if (s->result != NULL) {
1990
0
                return;
1991
0
            }
1992
0
            usb_mtp_get_data(s, &container, p);
1993
0
            break;
1994
0
        default:
1995
            /* not needed as long as the mtp device is read-only */
1996
0
            p->status = USB_RET_STALL;
1997
0
            return;
1998
0
        }
1999
0
        break;
2000
0
    case EP_EVENT:
2001
0
        if (!QTAILQ_EMPTY(&s->events)) {
2002
0
            struct MTPMonEntry *e = QTAILQ_LAST(&s->events);
2003
0
            uint32_t handle;
2004
0
            int len = sizeof(container) + sizeof(uint32_t);
2005
2006
0
            if (p->iov.size < len) {
2007
0
                trace_usb_mtp_stall(s->dev.addr,
2008
0
                                    "packet too small to send event");
2009
0
                p->status = USB_RET_STALL;
2010
0
                return;
2011
0
            }
2012
2013
0
            QTAILQ_REMOVE(&s->events, e, next);
2014
0
            container.length = cpu_to_le32(len);
2015
0
            container.type = cpu_to_le32(TYPE_EVENT);
2016
0
            container.code = cpu_to_le16(e->event);
2017
0
            container.trans = 0; /* no trans specific events */
2018
0
            handle = cpu_to_le32(e->handle);
2019
0
            usb_packet_copy(p, &container, sizeof(container));
2020
0
            usb_packet_copy(p, &handle, sizeof(uint32_t));
2021
0
            g_free(e);
2022
0
            return;
2023
0
        }
2024
0
        p->status = USB_RET_NAK;
2025
0
        return;
2026
0
    default:
2027
0
        trace_usb_mtp_stall(s->dev.addr, "invalid endpoint");
2028
0
        p->status = USB_RET_STALL;
2029
0
        return;
2030
0
    }
2031
2032
0
    if (p->actual_length == 0) {
2033
0
        trace_usb_mtp_nak(s->dev.addr, p->ep->nr);
2034
0
        p->status = USB_RET_NAK;
2035
0
        return;
2036
0
    } else {
2037
0
        trace_usb_mtp_xfer(s->dev.addr, p->ep->nr, p->actual_length,
2038
0
                           p->iov.size);
2039
0
        return;
2040
0
    }
2041
0
}
2042
2043
static void usb_mtp_realize(USBDevice *dev, Error **errp)
2044
0
{
2045
0
    MTPState *s = USB_MTP(dev);
2046
2047
0
    if ((s->root == NULL) || !g_path_is_absolute(s->root)) {
2048
0
        error_setg(errp, "usb-mtp: rootdir must be configured and be an absolute path");
2049
0
        return;
2050
0
    }
2051
2052
0
    if (access(s->root, R_OK) != 0) {
2053
0
        error_setg(errp, "usb-mtp: rootdir does not exist/not readable");
2054
0
        return;
2055
0
    } else if (!s->readonly && access(s->root, W_OK) != 0) {
2056
0
        error_setg(errp, "usb-mtp: rootdir does not have write permissions");
2057
0
        return;
2058
0
    }
2059
2060
    /* Mark store as RW */
2061
0
    if (!s->readonly) {
2062
0
        s->flags |= (1 << MTP_FLAG_WRITABLE);
2063
0
    }
2064
2065
0
    if (s->desc == NULL) {
2066
        /*
2067
         * This does not check if path exists
2068
         * but we have the checks above
2069
         */
2070
0
        s->desc = g_path_get_basename(s->root);
2071
0
    }
2072
2073
0
    usb_desc_create_serial(dev);
2074
0
    usb_desc_init(dev);
2075
0
    QTAILQ_INIT(&s->objects);
2076
2077
0
}
2078
2079
static const VMStateDescription vmstate_usb_mtp = {
2080
    .name = "usb-mtp",
2081
    .unmigratable = 1,
2082
    .version_id = 1,
2083
    .minimum_version_id = 1,
2084
    .fields = (const VMStateField[]) {
2085
        VMSTATE_USB_DEVICE(dev, MTPState),
2086
        VMSTATE_END_OF_LIST()
2087
    }
2088
};
2089
2090
static const Property mtp_properties[] = {
2091
    DEFINE_PROP_STRING("rootdir", MTPState, root),
2092
    DEFINE_PROP_STRING("desc", MTPState, desc),
2093
    DEFINE_PROP_BOOL("readonly", MTPState, readonly, true),
2094
};
2095
2096
static void usb_mtp_class_initfn(ObjectClass *klass, const void *data)
2097
61
{
2098
61
    DeviceClass *dc = DEVICE_CLASS(klass);
2099
61
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
2100
2101
61
    uc->realize        = usb_mtp_realize;
2102
61
    uc->product_desc   = "QEMU USB MTP";
2103
61
    uc->usb_desc       = &desc;
2104
61
    uc->cancel_packet  = usb_mtp_cancel_packet;
2105
61
    uc->handle_attach  = usb_desc_attach;
2106
61
    uc->handle_reset   = usb_mtp_handle_reset;
2107
61
    uc->handle_control = usb_mtp_handle_control;
2108
61
    uc->handle_data    = usb_mtp_handle_data;
2109
61
    set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
2110
61
    dc->desc = "USB Media Transfer Protocol device";
2111
61
    dc->fw_name = "mtp";
2112
61
    dc->vmsd = &vmstate_usb_mtp;
2113
61
    device_class_set_props(dc, mtp_properties);
2114
61
}
2115
2116
static const TypeInfo mtp_info = {
2117
    .name          = TYPE_USB_MTP,
2118
    .parent        = TYPE_USB_DEVICE,
2119
    .instance_size = sizeof(MTPState),
2120
    .class_init    = usb_mtp_class_initfn,
2121
};
2122
2123
static void usb_mtp_register_types(void)
2124
61
{
2125
61
    type_register_static(&mtp_info);
2126
61
}
2127
2128
type_init(usb_mtp_register_types)