summaryrefslogtreecommitdiffstats
path: root/utils/rk27utils/rkusbtool/rkusbtool.c
blob: a28f217e30c4bae698316b14696c1a7c593b4bcb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
/* on ubuntu compile with gcc -W rkusbtool.c -o rkusbtool -lusb-1.0 -I/usr/include/libusb-1.0/ */
#include <libusb.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>

#define VERSION "v0.1"

#define RETRY_MAX 5
#define USB_TIMEOUT 512
#define VENDORID  0x071b
#define PRODUCTID 0x3203

#define OUT_EP  0x01
#define IN_EP   0x82

#define CBW_SIGNATURE 0x43425355
#define CSW_SIGNATURE 0x53425355
#define SCSICMD_READ_12 0xa8

/* rockchip specific commands */
#define RK_CMD            0xe0
#define RK_GET_VERSION    0xffffffff
#define RK_SWITCH_ROCKUSB 0xfeffffff
#define RK_CHECK_USB      0xfdffffff
#define RK_OPEN_SYSDISK   0xfcffffff

enum {
      NONE = 0,
      INFO = 1,
      RKUSB = 2,
      SYSDISK = 4,
      CHECKUSB = 8
};

enum {
      COMMAND_PASSED = 0,
      COMMAND_FAILED = 1,
      PHASE_ERROR    = 2
};

struct CBWCB_t
{
    uint8_t  cbCode;
    uint8_t  cbLun;
    uint32_t LBA;
    uint32_t cbLen;
    uint8_t  reseved;
    uint8_t  control;
} __attribute__((__packed__));

struct CBW_t
{
    uint32_t dCBWSignature;
    uint32_t dCBWTag;
    uint32_t dCBWDataTransferLength;
    uint8_t  bmCBWFlags;
    uint8_t  bCBWLUN;
    uint8_t  bCBWCBLength;
    uint8_t  CBWCB[16];
} __attribute__((__packed__));

struct CSW_t
{
    uint32_t dCSWSignature;
    uint32_t dCSWTag;
    uint32_t dCSWDataResidue;
    uint8_t  bCSWStatus;
} __attribute__((__packed__));

static int send_msc_cmd(libusb_device_handle *hdev, struct CBWCB_t *cbwcb, uint32_t data_len, uint32_t *reftag)
{
    struct CBW_t cbw;
    int ret, repeat, transferred;
    static uint32_t tag = 0xdaefbc01;

    repeat = 0;
    memset(&cbw, 0, sizeof(cbw));
    cbw.dCBWSignature = CBW_SIGNATURE;
    cbw.dCBWTag = tag++;
    cbw.dCBWDataTransferLength = data_len;
    cbw.bmCBWFlags = 0x80; /* device to host */
    cbw.bCBWLUN = 0;
    cbw.bCBWCBLength = sizeof(struct CBWCB_t);
    memcpy(cbw.CBWCB, cbwcb, sizeof(struct CBWCB_t));

    *reftag = cbw.dCBWTag;
    do
    {
        /* transfer command to the device */
        ret = libusb_bulk_transfer(hdev, OUT_EP, (unsigned char*)&cbw, 31, &transferred, USB_TIMEOUT);
        if (ret == LIBUSB_ERROR_PIPE)
        {
            libusb_clear_halt(hdev, OUT_EP);
        }
        repeat++;
    } while ((ret == LIBUSB_ERROR_PIPE) && (repeat < RETRY_MAX));

    if (ret != LIBUSB_SUCCESS)
    {
        printf("error: command transfer error\n");
        return -1;
    }

    return 0;
}

static int get_msc_csw(libusb_device_handle *hdev, uint32_t reftag)
{
    struct CSW_t csw;
    int ret, repeat, transferred;

    /* get CSW response from device */
    repeat = 0;
    do
    {
        ret = libusb_bulk_transfer(hdev, IN_EP, (unsigned char *)&csw, 13, &transferred, USB_TIMEOUT);
        if (ret == LIBUSB_ERROR_PIPE)
        {
            libusb_clear_halt(hdev, IN_EP);
        }
        repeat++;
    } while ((ret == LIBUSB_ERROR_PIPE) && (repeat < RETRY_MAX));

    if (ret != LIBUSB_SUCCESS)
    {
        printf("error reading CSW\n");
        return -3;
    }

    if (transferred != 13)
    {
        printf("error wrong size of CSW packet\n");
        return -4;
    }

    if (csw.dCSWSignature != CSW_SIGNATURE)
    {
        printf("error: wrong CSW signature.\n");
        return -5;
    }

    if (csw.dCSWTag != reftag)
    {
        printf("error: CSW dCSWTag mismatch\n");
        return -6;
    }

    if (csw.bCSWStatus)
    {
        /* In case of CSW indicating error dump the content of the packet */
        printf ("dCSWSignature: 0x%0x\n", csw.dCSWSignature);
        printf ("dCSWTag: 0x%0x\n", csw.dCSWTag);
        printf ("dCSWDataResidue: 0x%0x\n", csw.dCSWDataResidue);
        printf ("bCSWStatus: 0x%0x\n", csw.bCSWStatus);
    }

    return csw.bCSWStatus;
}

static int rk_cmd(libusb_device_handle *hdev, uint32_t command, uint8_t *buf, uint8_t len)
{
    struct CBWCB_t cbwcb;
    int ret, transferred;
    uint32_t reftag;

    /* enter command */
    memset(&cbwcb, 0, sizeof(cbwcb));
    cbwcb.cbCode = SCSICMD_READ_12;
    cbwcb.cbLun = RK_CMD;
    cbwcb.LBA = command; /* RK_GET_VERSION, RK_OPEN_SYSDISK, RK_SWITCH_ROCKUSB */
    cbwcb.cbLen = len;   /* size of transfer in response to this command */

    ret = send_msc_cmd(hdev, &cbwcb, len, &reftag);

    /* get the response */
    if (len > 0)
    {
        ret = libusb_bulk_transfer(hdev, IN_EP, buf, len, &transferred, USB_TIMEOUT);
        if (ret != LIBUSB_SUCCESS || transferred != len)
        {
            printf("error: reading response data failed\n");
            return -2;
        }
    }

    return get_msc_csw(hdev, reftag);
}

static int get_sense(libusb_device_handle *hdev)
{
    struct CBWCB_t cbwcb;
    unsigned char sense[0x12];
    int size;
    uint32_t reftag;

    memset(&cbwcb, 0, sizeof(cbwcb));
    cbwcb.cbCode = 0x03;
    cbwcb.cbLun = 0;
    cbwcb.LBA = 0;
    cbwcb.cbLen = 0x12;

    send_msc_cmd(hdev, &cbwcb, 0x12, &reftag);
    libusb_bulk_transfer(hdev, IN_EP, (unsigned char*)&sense, 0x12, &size, USB_TIMEOUT);

    return get_msc_csw(hdev, reftag);
}

static void usage(void)
{
    printf("Usage: rkusbtool [options]\n");
    printf("-h|--help         This help message\n");
    printf("-i|--info         Get version string from the device\n");
    printf("-d|--dfu          Put device into DFU mode\n");
    printf("-s|--sysdisk      Open system disk\n");
    printf("-c|--checkusb     Check if dev is in System or Loader USB mode\n");
    printf("-u|--usb <p>:<v>  Override device PID and PIVD\n");
}

int main (int argc, char **argv)
{
    libusb_device_handle *hdev;
    int ret;
    int i = 1, action = NONE;
    uint32_t ver[3];
    uint16_t pid = PRODUCTID;
    uint16_t vid = VENDORID;

    if (argc < 2)
    {
        usage();
        return 1;
    }
    
    /* print banner */
    fprintf(stderr,"rkusbtool " VERSION "\n");
    fprintf(stderr,"(C) Marcin Bukat 2011\n");
    fprintf(stderr,"This is free software; see the source for copying conditions.  There is NO\n");
    fprintf(stderr,"warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n");

    /* arguments handling */
    while (i < argc)
    {
        if ((strcmp(argv[i],"-i")==0) || (strcmp(argv[i],"--info")==0))
        {
            action |= INFO;
        }
        else if ((strcmp(argv[i],"-d")==0) || (strcmp(argv[i],"--dfu")==0))
        {
            action |= RKUSB;
        }
        else if ((strcmp(argv[i],"-s")==0) || (strcmp(argv[i],"--sysdisk")==0))
        {
            action |= SYSDISK;
        }
        else if ((strcmp(argv[i],"-c")==0) || (strcmp(argv[i],"--checkusb")==0))
        {
            action |= CHECKUSB;
        }
        else if ((strcmp(argv[i],"-u")==0) || (strcmp(argv[i],"--usb")==0))
        {
            if (i + 1 == argc)
            {
                fprintf(stderr,"Missing argument for USB IDs\n");
                return -1;
            }
            char *svid = argv[i + 1];
            char *spid = strchr(svid, ':');
            if(svid == NULL)
            {
                fprintf(stderr,"Invalid argument for USB IDs (missing ':')\n");
                return -2;
            }
            char *end;
            vid = strtoul(svid, &end, 0);
            if(*end != ':')
            {
                fprintf(stderr,"Invalid argument for USB VID\n");
                return -3;
            }
            pid = strtoul(spid + 1, &end, 0);
            if(*end)
            {
                fprintf(stderr,"Invalid argument for USB PID\n");
                return -4;
            }
            i++;
        }
        else if((strcmp(argv[i],"-h")==0) || (strcmp(argv[i],"--help")==0))
        {
            usage();
            return 0;
        }
        else
        {
            fprintf(stderr,"Unknown argument '%s'\n", argv[i]);
            return -5;
        }
        i++;
    }

    /* initialize libusb */
    libusb_init(NULL);
    /* usb_set_debug(2); */

    hdev = libusb_open_device_with_vid_pid(NULL, vid, pid);
    if (hdev == NULL)
    {
        printf("error: can't open device\n");
        return -10;
    }

    ret = libusb_kernel_driver_active(hdev, 0);

    if (ret < 0)
    {
        printf ("error checking kernel driver active\n");
        libusb_close(hdev);
        return -3;
    }
    else
    {
        if (ret)
            libusb_detach_kernel_driver(hdev, 0);
    }

    ret = libusb_set_configuration(hdev, 1);
    if (ret < 0)
    {
        printf("error: could not select configuration (1)\n");
        libusb_close(hdev);
        return -3;
    }

    ret = libusb_claim_interface(hdev, 0);
    if (ret < 0)
    {
            printf("error: could not claim interface #0\n");
            libusb_close(hdev);
            return -11;
    }

    ret = libusb_set_interface_alt_setting(hdev, 0, 0);
    if ( ret != LIBUSB_SUCCESS)
    {
        printf("error: could not set alt setting for interface #0\n");
        libusb_close(hdev);
        return -11;
    }
    
    /* BulkOnly reset */
    //ret = libusb_control_transfer(hdev, 0x21, 0xff, 0, 0, NULL, 0, USB_TIMEOUT);

   /* BulkOnly get max lun */
   //ret = libusb_control_transfer(hdev, 0xa1, 0xfe, 0, 0, &maxlun, 1, USB_TIMEOUT);

    /* Devices that do not support multiple LUNs may STALL this command. */
   //if (ret == 0)
   //   maxlun = -1;
 
    //printf("MAXLUN: %d\n", maxlun);

    get_sense(hdev);

    if (action & INFO)
    {
        ret = rk_cmd(hdev, RK_GET_VERSION, (uint8_t *)ver, 12);

        if (ret)
        {
            printf("error sending RK_GET_VERSION command. Err 0x%0x\n", ret);
            libusb_close(hdev);
            return ret;
        }

        printf("Rockchip device info:\n");
        printf("loader ver: %x.%x\n", (ver[0]>>16)&0xff, ver[0]&0xff);
        printf("kernel ver: %x.%x\n", (ver[1]>>16)&0xff, ver[1]&0xff);
        printf("sdk ver:    %x.%x\n", (ver[2]>>16)&0xff, ver[2]&0xff);
    }

    if (action & CHECKUSB)
    {
        printf("Checking USB mode...\n");
        ret = rk_cmd(hdev, RK_CHECK_USB, (uint8_t *)ver, 1);

        //if (ret)
        //{
        //    libusb_close(hdev);
        //    return ret;
        //}

        if (*(char *)ver)
            printf("The device is in Loader USB mode\n");
        else
            printf("The device is in System USB mode\n");
    }

    if (action & SYSDISK)
    {
        printf("Opening system disk...\n");
        ret = rk_cmd(hdev, RK_OPEN_SYSDISK, NULL, 0);

        if (ret)
        {
            libusb_close(hdev);
            return ret;
        }
    }

    if (action & RKUSB)
    {
        printf("Switching into rk DFU mode...\n");
        ret = rk_cmd(hdev, RK_SWITCH_ROCKUSB, NULL, 0);

        if (ret)
        {
            libusb_close(hdev);
            return ret;
        }
    }

    libusb_close(hdev);
    libusb_exit(NULL);
    return 0;
}