]> git.ipfire.org Git - people/ms/u-boot.git/blame - drivers/usb/gadget/f_fastboot.c
usb: gadget: fastboot: Add fastboot erase
[people/ms/u-boot.git] / drivers / usb / gadget / f_fastboot.c
CommitLineData
3aab70af
SS
1/*
2 * (C) Copyright 2008 - 2009
3 * Windriver, <www.windriver.com>
4 * Tom Rix <Tom.Rix@windriver.com>
5 *
6 * Copyright 2011 Sebastian Andrzej Siewior <bigeasy@linutronix.de>
7 *
8 * Copyright 2014 Linaro, Ltd.
9 * Rob Herring <robh@kernel.org>
10 *
11 * SPDX-License-Identifier: GPL-2.0+
12 */
593cbd93 13#include <config.h>
3aab70af
SS
14#include <common.h>
15#include <errno.h>
16#include <malloc.h>
17#include <linux/usb/ch9.h>
18#include <linux/usb/gadget.h>
19#include <linux/usb/composite.h>
20#include <linux/compiler.h>
21#include <version.h>
22#include <g_dnl.h>
d1b5ed07
SR
23#ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
24#include <fb_mmc.h>
25#endif
3aab70af
SS
26
27#define FASTBOOT_VERSION "0.4"
28
29#define FASTBOOT_INTERFACE_CLASS 0xff
30#define FASTBOOT_INTERFACE_SUB_CLASS 0x42
31#define FASTBOOT_INTERFACE_PROTOCOL 0x03
32
33#define RX_ENDPOINT_MAXIMUM_PACKET_SIZE_2_0 (0x0200)
34#define RX_ENDPOINT_MAXIMUM_PACKET_SIZE_1_1 (0x0040)
35#define TX_ENDPOINT_MAXIMUM_PACKET_SIZE (0x0040)
36
37/* The 64 defined bytes plus \0 */
38#define RESPONSE_LEN (64 + 1)
39
40#define EP_BUFFER_SIZE 4096
41
42struct f_fastboot {
43 struct usb_function usb_function;
44
593cbd93 45 /* IN/OUT EP's and corresponding requests */
3aab70af
SS
46 struct usb_ep *in_ep, *out_ep;
47 struct usb_request *in_req, *out_req;
48};
49
50static inline struct f_fastboot *func_to_fastboot(struct usb_function *f)
51{
52 return container_of(f, struct f_fastboot, usb_function);
53}
54
55static struct f_fastboot *fastboot_func;
56static unsigned int download_size;
57static unsigned int download_bytes;
58
59static struct usb_endpoint_descriptor fs_ep_in = {
60 .bLength = USB_DT_ENDPOINT_SIZE,
61 .bDescriptorType = USB_DT_ENDPOINT,
62 .bEndpointAddress = USB_DIR_IN,
63 .bmAttributes = USB_ENDPOINT_XFER_BULK,
64 .wMaxPacketSize = TX_ENDPOINT_MAXIMUM_PACKET_SIZE,
65 .bInterval = 0x00,
66};
67
68static struct usb_endpoint_descriptor fs_ep_out = {
69 .bLength = USB_DT_ENDPOINT_SIZE,
70 .bDescriptorType = USB_DT_ENDPOINT,
71 .bEndpointAddress = USB_DIR_OUT,
72 .bmAttributes = USB_ENDPOINT_XFER_BULK,
73 .wMaxPacketSize = RX_ENDPOINT_MAXIMUM_PACKET_SIZE_1_1,
74 .bInterval = 0x00,
75};
76
77static struct usb_endpoint_descriptor hs_ep_out = {
78 .bLength = USB_DT_ENDPOINT_SIZE,
79 .bDescriptorType = USB_DT_ENDPOINT,
80 .bEndpointAddress = USB_DIR_OUT,
81 .bmAttributes = USB_ENDPOINT_XFER_BULK,
82 .wMaxPacketSize = RX_ENDPOINT_MAXIMUM_PACKET_SIZE_2_0,
83 .bInterval = 0x00,
84};
85
86static struct usb_interface_descriptor interface_desc = {
87 .bLength = USB_DT_INTERFACE_SIZE,
88 .bDescriptorType = USB_DT_INTERFACE,
89 .bInterfaceNumber = 0x00,
90 .bAlternateSetting = 0x00,
91 .bNumEndpoints = 0x02,
92 .bInterfaceClass = FASTBOOT_INTERFACE_CLASS,
93 .bInterfaceSubClass = FASTBOOT_INTERFACE_SUB_CLASS,
94 .bInterfaceProtocol = FASTBOOT_INTERFACE_PROTOCOL,
95};
96
97static struct usb_descriptor_header *fb_runtime_descs[] = {
98 (struct usb_descriptor_header *)&interface_desc,
99 (struct usb_descriptor_header *)&fs_ep_in,
100 (struct usb_descriptor_header *)&hs_ep_out,
101 NULL,
102};
103
104/*
105 * static strings, in UTF-8
106 */
107static const char fastboot_name[] = "Android Fastboot";
108
109static struct usb_string fastboot_string_defs[] = {
110 [0].s = fastboot_name,
111 { } /* end of list */
112};
113
114static struct usb_gadget_strings stringtab_fastboot = {
115 .language = 0x0409, /* en-us */
116 .strings = fastboot_string_defs,
117};
118
119static struct usb_gadget_strings *fastboot_strings[] = {
120 &stringtab_fastboot,
121 NULL,
122};
123
124static void rx_handler_command(struct usb_ep *ep, struct usb_request *req);
125
126static void fastboot_complete(struct usb_ep *ep, struct usb_request *req)
127{
128 int status = req->status;
129 if (!status)
130 return;
131 printf("status: %d ep '%s' trans: %d\n", status, ep->name, req->actual);
132}
133
134static int fastboot_bind(struct usb_configuration *c, struct usb_function *f)
135{
136 int id;
137 struct usb_gadget *gadget = c->cdev->gadget;
138 struct f_fastboot *f_fb = func_to_fastboot(f);
139
140 /* DYNAMIC interface numbers assignments */
141 id = usb_interface_id(c, f);
142 if (id < 0)
143 return id;
144 interface_desc.bInterfaceNumber = id;
145
146 id = usb_string_id(c->cdev);
147 if (id < 0)
148 return id;
149 fastboot_string_defs[0].id = id;
150 interface_desc.iInterface = id;
151
152 f_fb->in_ep = usb_ep_autoconfig(gadget, &fs_ep_in);
153 if (!f_fb->in_ep)
154 return -ENODEV;
155 f_fb->in_ep->driver_data = c->cdev;
156
157 f_fb->out_ep = usb_ep_autoconfig(gadget, &fs_ep_out);
158 if (!f_fb->out_ep)
159 return -ENODEV;
160 f_fb->out_ep->driver_data = c->cdev;
161
162 hs_ep_out.bEndpointAddress = fs_ep_out.bEndpointAddress;
163
164 return 0;
165}
166
167static void fastboot_unbind(struct usb_configuration *c, struct usb_function *f)
168{
169 memset(fastboot_func, 0, sizeof(*fastboot_func));
170}
171
172static void fastboot_disable(struct usb_function *f)
173{
174 struct f_fastboot *f_fb = func_to_fastboot(f);
175
176 usb_ep_disable(f_fb->out_ep);
177 usb_ep_disable(f_fb->in_ep);
178
179 if (f_fb->out_req) {
180 free(f_fb->out_req->buf);
181 usb_ep_free_request(f_fb->out_ep, f_fb->out_req);
182 f_fb->out_req = NULL;
183 }
184 if (f_fb->in_req) {
185 free(f_fb->in_req->buf);
186 usb_ep_free_request(f_fb->in_ep, f_fb->in_req);
187 f_fb->in_req = NULL;
188 }
189}
190
191static struct usb_request *fastboot_start_ep(struct usb_ep *ep)
192{
193 struct usb_request *req;
194
195 req = usb_ep_alloc_request(ep, 0);
196 if (!req)
197 return NULL;
198
199 req->length = EP_BUFFER_SIZE;
200 req->buf = memalign(CONFIG_SYS_CACHELINE_SIZE, EP_BUFFER_SIZE);
201 if (!req->buf) {
202 usb_ep_free_request(ep, req);
203 return NULL;
204 }
205
206 memset(req->buf, 0, req->length);
207 return req;
208}
209
210static int fastboot_set_alt(struct usb_function *f,
211 unsigned interface, unsigned alt)
212{
213 int ret;
214 struct usb_composite_dev *cdev = f->config->cdev;
215 struct usb_gadget *gadget = cdev->gadget;
216 struct f_fastboot *f_fb = func_to_fastboot(f);
217
218 debug("%s: func: %s intf: %d alt: %d\n",
219 __func__, f->name, interface, alt);
220
221 /* make sure we don't enable the ep twice */
222 if (gadget->speed == USB_SPEED_HIGH)
223 ret = usb_ep_enable(f_fb->out_ep, &hs_ep_out);
224 else
225 ret = usb_ep_enable(f_fb->out_ep, &fs_ep_out);
226 if (ret) {
227 puts("failed to enable out ep\n");
228 return ret;
229 }
230
231 f_fb->out_req = fastboot_start_ep(f_fb->out_ep);
232 if (!f_fb->out_req) {
233 puts("failed to alloc out req\n");
234 ret = -EINVAL;
235 goto err;
236 }
237 f_fb->out_req->complete = rx_handler_command;
238
239 ret = usb_ep_enable(f_fb->in_ep, &fs_ep_in);
240 if (ret) {
241 puts("failed to enable in ep\n");
242 goto err;
243 }
244
245 f_fb->in_req = fastboot_start_ep(f_fb->in_ep);
246 if (!f_fb->in_req) {
247 puts("failed alloc req in\n");
248 ret = -EINVAL;
249 goto err;
250 }
251 f_fb->in_req->complete = fastboot_complete;
252
253 ret = usb_ep_queue(f_fb->out_ep, f_fb->out_req, 0);
254 if (ret)
255 goto err;
256
257 return 0;
258err:
259 fastboot_disable(f);
260 return ret;
261}
262
263static int fastboot_add(struct usb_configuration *c)
264{
265 struct f_fastboot *f_fb = fastboot_func;
266 int status;
267
268 debug("%s: cdev: 0x%p\n", __func__, c->cdev);
269
270 if (!f_fb) {
271 f_fb = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*f_fb));
272 if (!f_fb)
273 return -ENOMEM;
274
275 fastboot_func = f_fb;
276 memset(f_fb, 0, sizeof(*f_fb));
277 }
278
279 f_fb->usb_function.name = "f_fastboot";
280 f_fb->usb_function.hs_descriptors = fb_runtime_descs;
281 f_fb->usb_function.bind = fastboot_bind;
282 f_fb->usb_function.unbind = fastboot_unbind;
283 f_fb->usb_function.set_alt = fastboot_set_alt;
284 f_fb->usb_function.disable = fastboot_disable;
285 f_fb->usb_function.strings = fastboot_strings;
286
287 status = usb_add_function(c, &f_fb->usb_function);
288 if (status) {
289 free(f_fb);
290 fastboot_func = f_fb;
291 }
292
293 return status;
294}
295DECLARE_GADGET_BIND_CALLBACK(usb_dnl_fastboot, fastboot_add);
296
593cbd93 297static int fastboot_tx_write(const char *buffer, unsigned int buffer_size)
3aab70af
SS
298{
299 struct usb_request *in_req = fastboot_func->in_req;
300 int ret;
301
302 memcpy(in_req->buf, buffer, buffer_size);
303 in_req->length = buffer_size;
304 ret = usb_ep_queue(fastboot_func->in_ep, in_req, 0);
305 if (ret)
306 printf("Error %d on queue\n", ret);
307 return 0;
308}
309
310static int fastboot_tx_write_str(const char *buffer)
311{
312 return fastboot_tx_write(buffer, strlen(buffer));
313}
314
315static void compl_do_reset(struct usb_ep *ep, struct usb_request *req)
316{
317 do_reset(NULL, 0, 0, NULL);
318}
319
320static void cb_reboot(struct usb_ep *ep, struct usb_request *req)
321{
322 fastboot_func->in_req->complete = compl_do_reset;
323 fastboot_tx_write_str("OKAY");
324}
325
326static int strcmp_l1(const char *s1, const char *s2)
327{
328 if (!s1 || !s2)
329 return -1;
330 return strncmp(s1, s2, strlen(s1));
331}
332
333static void cb_getvar(struct usb_ep *ep, struct usb_request *req)
334{
335 char *cmd = req->buf;
336 char response[RESPONSE_LEN];
337 const char *s;
29425be4 338 size_t chars_left;
3aab70af
SS
339
340 strcpy(response, "OKAY");
29425be4
JH
341 chars_left = sizeof(response) - strlen(response) - 1;
342
3aab70af
SS
343 strsep(&cmd, ":");
344 if (!cmd) {
593cbd93 345 error("missing variable\n");
3aab70af
SS
346 fastboot_tx_write_str("FAILmissing var");
347 return;
348 }
349
350 if (!strcmp_l1("version", cmd)) {
29425be4 351 strncat(response, FASTBOOT_VERSION, chars_left);
3aab70af 352 } else if (!strcmp_l1("bootloader-version", cmd)) {
29425be4 353 strncat(response, U_BOOT_VERSION, chars_left);
c674a666
EN
354 } else if (!strcmp_l1("downloadsize", cmd) ||
355 !strcmp_l1("max-download-size", cmd)) {
3aab70af
SS
356 char str_num[12];
357
84c24f66 358 sprintf(str_num, "0x%08x", CONFIG_USB_FASTBOOT_BUF_SIZE);
29425be4 359 strncat(response, str_num, chars_left);
3aab70af
SS
360 } else if (!strcmp_l1("serialno", cmd)) {
361 s = getenv("serial#");
362 if (s)
29425be4 363 strncat(response, s, chars_left);
3aab70af
SS
364 else
365 strcpy(response, "FAILValue not set");
366 } else {
593cbd93 367 error("unknown variable: %s\n", cmd);
3aab70af
SS
368 strcpy(response, "FAILVariable not implemented");
369 }
370 fastboot_tx_write_str(response);
371}
372
373static unsigned int rx_bytes_expected(void)
374{
375 int rx_remain = download_size - download_bytes;
376 if (rx_remain < 0)
377 return 0;
378 if (rx_remain > EP_BUFFER_SIZE)
379 return EP_BUFFER_SIZE;
380 return rx_remain;
381}
382
383#define BYTES_PER_DOT 0x20000
384static void rx_handler_dl_image(struct usb_ep *ep, struct usb_request *req)
385{
386 char response[RESPONSE_LEN];
387 unsigned int transfer_size = download_size - download_bytes;
388 const unsigned char *buffer = req->buf;
389 unsigned int buffer_size = req->actual;
23d1d10c 390 unsigned int pre_dot_num, now_dot_num;
3aab70af
SS
391
392 if (req->status != 0) {
393 printf("Bad status: %d\n", req->status);
394 return;
395 }
396
397 if (buffer_size < transfer_size)
398 transfer_size = buffer_size;
399
400 memcpy((void *)CONFIG_USB_FASTBOOT_BUF_ADDR + download_bytes,
401 buffer, transfer_size);
402
23d1d10c 403 pre_dot_num = download_bytes / BYTES_PER_DOT;
3aab70af 404 download_bytes += transfer_size;
23d1d10c
BS
405 now_dot_num = download_bytes / BYTES_PER_DOT;
406
407 if (pre_dot_num != now_dot_num) {
408 putc('.');
409 if (!(now_dot_num % 74))
410 putc('\n');
411 }
3aab70af
SS
412
413 /* Check if transfer is done */
414 if (download_bytes >= download_size) {
415 /*
416 * Reset global transfer variable, keep download_bytes because
417 * it will be used in the next possible flashing command
418 */
419 download_size = 0;
420 req->complete = rx_handler_command;
421 req->length = EP_BUFFER_SIZE;
422
423 sprintf(response, "OKAY");
424 fastboot_tx_write_str(response);
425
426 printf("\ndownloading of %d bytes finished\n", download_bytes);
427 } else {
428 req->length = rx_bytes_expected();
429 if (req->length < ep->maxpacket)
430 req->length = ep->maxpacket;
431 }
432
3aab70af
SS
433 req->actual = 0;
434 usb_ep_queue(ep, req, 0);
435}
436
437static void cb_download(struct usb_ep *ep, struct usb_request *req)
438{
439 char *cmd = req->buf;
440 char response[RESPONSE_LEN];
441
442 strsep(&cmd, ":");
443 download_size = simple_strtoul(cmd, NULL, 16);
444 download_bytes = 0;
445
446 printf("Starting download of %d bytes\n", download_size);
447
448 if (0 == download_size) {
449 sprintf(response, "FAILdata invalid size");
450 } else if (download_size > CONFIG_USB_FASTBOOT_BUF_SIZE) {
451 download_size = 0;
452 sprintf(response, "FAILdata too large");
453 } else {
454 sprintf(response, "DATA%08x", download_size);
455 req->complete = rx_handler_dl_image;
456 req->length = rx_bytes_expected();
457 if (req->length < ep->maxpacket)
458 req->length = ep->maxpacket;
459 }
460 fastboot_tx_write_str(response);
461}
462
463static void do_bootm_on_complete(struct usb_ep *ep, struct usb_request *req)
464{
465 char boot_addr_start[12];
466 char *bootm_args[] = { "bootm", boot_addr_start, NULL };
467
468 puts("Booting kernel..\n");
469
470 sprintf(boot_addr_start, "0x%lx", load_addr);
471 do_bootm(NULL, 0, 2, bootm_args);
472
473 /* This only happens if image is somehow faulty so we start over */
474 do_reset(NULL, 0, 0, NULL);
475}
476
477static void cb_boot(struct usb_ep *ep, struct usb_request *req)
478{
479 fastboot_func->in_req->complete = do_bootm_on_complete;
480 fastboot_tx_write_str("OKAY");
481}
482
267abc62
RH
483static void do_exit_on_complete(struct usb_ep *ep, struct usb_request *req)
484{
485 g_dnl_trigger_detach();
486}
487
488static void cb_continue(struct usb_ep *ep, struct usb_request *req)
489{
490 fastboot_func->in_req->complete = do_exit_on_complete;
491 fastboot_tx_write_str("OKAY");
492}
493
d1b5ed07
SR
494#ifdef CONFIG_FASTBOOT_FLASH
495static void cb_flash(struct usb_ep *ep, struct usb_request *req)
496{
497 char *cmd = req->buf;
498 char response[RESPONSE_LEN];
499
500 strsep(&cmd, ":");
501 if (!cmd) {
593cbd93 502 error("missing partition name\n");
d1b5ed07
SR
503 fastboot_tx_write_str("FAILmissing partition name");
504 return;
505 }
506
507 strcpy(response, "FAILno flash device defined");
508#ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
509 fb_mmc_flash_write(cmd, (void *)CONFIG_USB_FASTBOOT_BUF_ADDR,
510 download_bytes, response);
511#endif
512 fastboot_tx_write_str(response);
513}
514#endif
515
de195620
MS
516static void cb_oem(struct usb_ep *ep, struct usb_request *req)
517{
518 char *cmd = req->buf;
372d7dec
RH
519#ifdef CONFIG_FASTBOOT_FLASH
520 if (strncmp("format", cmd + 4, 6) == 0) {
521 char cmdbuf[32];
522 sprintf(cmdbuf, "gpt write mmc %x $partitions",
523 CONFIG_FASTBOOT_FLASH_MMC_DEV);
524 if (run_command(cmdbuf, 0))
525 fastboot_tx_write_str("FAIL");
526 else
527 fastboot_tx_write_str("OKAY");
528 } else
529#endif
de195620
MS
530 if (strncmp("unlock", cmd + 4, 8) == 0) {
531 fastboot_tx_write_str("FAILnot implemented");
532 }
533 else {
534 fastboot_tx_write_str("FAILunknown oem command");
535 }
536}
537
89792381
DK
538#ifdef CONFIG_FASTBOOT_FLASH
539static void cb_erase(struct usb_ep *ep, struct usb_request *req)
540{
541 char *cmd = req->buf;
542 char response[RESPONSE_LEN];
543
544 strsep(&cmd, ":");
545 if (!cmd) {
546 error("missing partition name");
547 fastboot_tx_write_str("FAILmissing partition name");
548 return;
549 }
550
551 strcpy(response, "FAILno flash device defined");
552
553#ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
554 fb_mmc_erase(cmd, response);
555#endif
556 fastboot_tx_write_str(response);
557}
558#endif
559
3aab70af
SS
560struct cmd_dispatch_info {
561 char *cmd;
562 void (*cb)(struct usb_ep *ep, struct usb_request *req);
563};
564
565static const struct cmd_dispatch_info cmd_dispatch_info[] = {
566 {
567 .cmd = "reboot",
568 .cb = cb_reboot,
569 }, {
570 .cmd = "getvar:",
571 .cb = cb_getvar,
572 }, {
573 .cmd = "download:",
574 .cb = cb_download,
575 }, {
576 .cmd = "boot",
577 .cb = cb_boot,
267abc62
RH
578 }, {
579 .cmd = "continue",
580 .cb = cb_continue,
3aab70af 581 },
d1b5ed07
SR
582#ifdef CONFIG_FASTBOOT_FLASH
583 {
584 .cmd = "flash",
585 .cb = cb_flash,
89792381
DK
586 }, {
587 .cmd = "erase",
588 .cb = cb_erase,
d1b5ed07
SR
589 },
590#endif
de195620
MS
591 {
592 .cmd = "oem",
593 .cb = cb_oem,
594 },
3aab70af
SS
595};
596
597static void rx_handler_command(struct usb_ep *ep, struct usb_request *req)
598{
599 char *cmdbuf = req->buf;
600 void (*func_cb)(struct usb_ep *ep, struct usb_request *req) = NULL;
601 int i;
602
603 for (i = 0; i < ARRAY_SIZE(cmd_dispatch_info); i++) {
604 if (!strcmp_l1(cmd_dispatch_info[i].cmd, cmdbuf)) {
605 func_cb = cmd_dispatch_info[i].cb;
606 break;
607 }
608 }
609
593cbd93
SR
610 if (!func_cb) {
611 error("unknown command: %s\n", cmdbuf);
3aab70af 612 fastboot_tx_write_str("FAILunknown command");
593cbd93 613 } else {
e2140588
EN
614 if (req->actual < req->length) {
615 u8 *buf = (u8 *)req->buf;
616 buf[req->actual] = 0;
617 func_cb(ep, req);
618 } else {
619 error("buffer overflow\n");
620 fastboot_tx_write_str("FAILbuffer overflow");
621 }
593cbd93 622 }
3aab70af
SS
623
624 if (req->status == 0) {
625 *cmdbuf = '\0';
626 req->actual = 0;
627 usb_ep_queue(ep, req, 0);
628 }
629}