2 * (C) Copyright 2008 - 2009
3 * Windriver, <www.windriver.com>
4 * Tom Rix <Tom.Rix@windriver.com>
6 * Copyright 2011 Sebastian Andrzej Siewior <bigeasy@linutronix.de>
8 * Copyright 2014 Linaro, Ltd.
9 * Rob Herring <robh@kernel.org>
11 * SPDX-License-Identifier: GPL-2.0+
18 #include <linux/usb/ch9.h>
19 #include <linux/usb/gadget.h>
20 #include <linux/usb/composite.h>
21 #include <linux/compiler.h>
24 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
27 #ifdef CONFIG_FASTBOOT_FLASH_NAND_DEV
31 #define FASTBOOT_VERSION "0.4"
33 #define FASTBOOT_INTERFACE_CLASS 0xff
34 #define FASTBOOT_INTERFACE_SUB_CLASS 0x42
35 #define FASTBOOT_INTERFACE_PROTOCOL 0x03
37 #define RX_ENDPOINT_MAXIMUM_PACKET_SIZE_2_0 (0x0200)
38 #define RX_ENDPOINT_MAXIMUM_PACKET_SIZE_1_1 (0x0040)
39 #define TX_ENDPOINT_MAXIMUM_PACKET_SIZE (0x0040)
41 #define EP_BUFFER_SIZE 4096
44 struct usb_function usb_function;
46 /* IN/OUT EP's and corresponding requests */
47 struct usb_ep *in_ep, *out_ep;
48 struct usb_request *in_req, *out_req;
51 static inline struct f_fastboot *func_to_fastboot(struct usb_function *f)
53 return container_of(f, struct f_fastboot, usb_function);
56 static struct f_fastboot *fastboot_func;
57 static unsigned int fastboot_flash_session_id;
58 static unsigned int download_size;
59 static unsigned int download_bytes;
60 static bool is_high_speed;
62 static struct usb_endpoint_descriptor fs_ep_in = {
63 .bLength = USB_DT_ENDPOINT_SIZE,
64 .bDescriptorType = USB_DT_ENDPOINT,
65 .bEndpointAddress = USB_DIR_IN,
66 .bmAttributes = USB_ENDPOINT_XFER_BULK,
67 .wMaxPacketSize = cpu_to_le16(64),
70 static struct usb_endpoint_descriptor fs_ep_out = {
71 .bLength = USB_DT_ENDPOINT_SIZE,
72 .bDescriptorType = USB_DT_ENDPOINT,
73 .bEndpointAddress = USB_DIR_OUT,
74 .bmAttributes = USB_ENDPOINT_XFER_BULK,
75 .wMaxPacketSize = cpu_to_le16(64),
78 static struct usb_endpoint_descriptor hs_ep_in = {
79 .bLength = USB_DT_ENDPOINT_SIZE,
80 .bDescriptorType = USB_DT_ENDPOINT,
81 .bEndpointAddress = USB_DIR_IN,
82 .bmAttributes = USB_ENDPOINT_XFER_BULK,
83 .wMaxPacketSize = cpu_to_le16(512),
86 static struct usb_endpoint_descriptor hs_ep_out = {
87 .bLength = USB_DT_ENDPOINT_SIZE,
88 .bDescriptorType = USB_DT_ENDPOINT,
89 .bEndpointAddress = USB_DIR_OUT,
90 .bmAttributes = USB_ENDPOINT_XFER_BULK,
91 .wMaxPacketSize = cpu_to_le16(512),
94 static struct usb_interface_descriptor interface_desc = {
95 .bLength = USB_DT_INTERFACE_SIZE,
96 .bDescriptorType = USB_DT_INTERFACE,
97 .bInterfaceNumber = 0x00,
98 .bAlternateSetting = 0x00,
99 .bNumEndpoints = 0x02,
100 .bInterfaceClass = FASTBOOT_INTERFACE_CLASS,
101 .bInterfaceSubClass = FASTBOOT_INTERFACE_SUB_CLASS,
102 .bInterfaceProtocol = FASTBOOT_INTERFACE_PROTOCOL,
105 static struct usb_descriptor_header *fb_fs_function[] = {
106 (struct usb_descriptor_header *)&interface_desc,
107 (struct usb_descriptor_header *)&fs_ep_in,
108 (struct usb_descriptor_header *)&fs_ep_out,
111 static struct usb_descriptor_header *fb_hs_function[] = {
112 (struct usb_descriptor_header *)&interface_desc,
113 (struct usb_descriptor_header *)&hs_ep_in,
114 (struct usb_descriptor_header *)&hs_ep_out,
118 static struct usb_endpoint_descriptor *
119 fb_ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *fs,
120 struct usb_endpoint_descriptor *hs)
122 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
128 * static strings, in UTF-8
130 static const char fastboot_name[] = "Android Fastboot";
132 static struct usb_string fastboot_string_defs[] = {
133 [0].s = fastboot_name,
134 { } /* end of list */
137 static struct usb_gadget_strings stringtab_fastboot = {
138 .language = 0x0409, /* en-us */
139 .strings = fastboot_string_defs,
142 static struct usb_gadget_strings *fastboot_strings[] = {
147 static void rx_handler_command(struct usb_ep *ep, struct usb_request *req);
148 static int strcmp_l1(const char *s1, const char *s2);
151 void fastboot_fail(char *response, const char *reason)
153 strncpy(response, "FAIL\0", 5);
154 strncat(response, reason, FASTBOOT_RESPONSE_LEN - 4 - 1);
157 void fastboot_okay(char *response, const char *reason)
159 strncpy(response, "OKAY\0", 5);
160 strncat(response, reason, FASTBOOT_RESPONSE_LEN - 4 - 1);
163 static void fastboot_complete(struct usb_ep *ep, struct usb_request *req)
165 int status = req->status;
168 printf("status: %d ep '%s' trans: %d\n", status, ep->name, req->actual);
171 static int fastboot_bind(struct usb_configuration *c, struct usb_function *f)
174 struct usb_gadget *gadget = c->cdev->gadget;
175 struct f_fastboot *f_fb = func_to_fastboot(f);
178 /* DYNAMIC interface numbers assignments */
179 id = usb_interface_id(c, f);
182 interface_desc.bInterfaceNumber = id;
184 id = usb_string_id(c->cdev);
187 fastboot_string_defs[0].id = id;
188 interface_desc.iInterface = id;
190 f_fb->in_ep = usb_ep_autoconfig(gadget, &fs_ep_in);
193 f_fb->in_ep->driver_data = c->cdev;
195 f_fb->out_ep = usb_ep_autoconfig(gadget, &fs_ep_out);
198 f_fb->out_ep->driver_data = c->cdev;
200 f->descriptors = fb_fs_function;
202 if (gadget_is_dualspeed(gadget)) {
203 /* Assume endpoint addresses are the same for both speeds */
204 hs_ep_in.bEndpointAddress = fs_ep_in.bEndpointAddress;
205 hs_ep_out.bEndpointAddress = fs_ep_out.bEndpointAddress;
206 /* copy HS descriptors */
207 f->hs_descriptors = fb_hs_function;
210 s = getenv("serial#");
212 g_dnl_set_serialnumber((char *)s);
217 static void fastboot_unbind(struct usb_configuration *c, struct usb_function *f)
219 memset(fastboot_func, 0, sizeof(*fastboot_func));
222 static void fastboot_disable(struct usb_function *f)
224 struct f_fastboot *f_fb = func_to_fastboot(f);
226 usb_ep_disable(f_fb->out_ep);
227 usb_ep_disable(f_fb->in_ep);
230 free(f_fb->out_req->buf);
231 usb_ep_free_request(f_fb->out_ep, f_fb->out_req);
232 f_fb->out_req = NULL;
235 free(f_fb->in_req->buf);
236 usb_ep_free_request(f_fb->in_ep, f_fb->in_req);
241 static struct usb_request *fastboot_start_ep(struct usb_ep *ep)
243 struct usb_request *req;
245 req = usb_ep_alloc_request(ep, 0);
249 req->length = EP_BUFFER_SIZE;
250 req->buf = memalign(CONFIG_SYS_CACHELINE_SIZE, EP_BUFFER_SIZE);
252 usb_ep_free_request(ep, req);
256 memset(req->buf, 0, req->length);
260 static int fastboot_set_alt(struct usb_function *f,
261 unsigned interface, unsigned alt)
264 struct usb_composite_dev *cdev = f->config->cdev;
265 struct usb_gadget *gadget = cdev->gadget;
266 struct f_fastboot *f_fb = func_to_fastboot(f);
267 const struct usb_endpoint_descriptor *d;
269 debug("%s: func: %s intf: %d alt: %d\n",
270 __func__, f->name, interface, alt);
272 if (gadget->speed == USB_SPEED_HIGH)
273 is_high_speed = true;
275 is_high_speed = false;
277 d = fb_ep_desc(gadget, &fs_ep_out, &hs_ep_out);
278 ret = usb_ep_enable(f_fb->out_ep, d);
280 puts("failed to enable out ep\n");
284 f_fb->out_req = fastboot_start_ep(f_fb->out_ep);
285 if (!f_fb->out_req) {
286 puts("failed to alloc out req\n");
290 f_fb->out_req->complete = rx_handler_command;
292 d = fb_ep_desc(gadget, &fs_ep_in, &hs_ep_in);
293 ret = usb_ep_enable(f_fb->in_ep, d);
295 puts("failed to enable in ep\n");
299 f_fb->in_req = fastboot_start_ep(f_fb->in_ep);
301 puts("failed alloc req in\n");
305 f_fb->in_req->complete = fastboot_complete;
307 ret = usb_ep_queue(f_fb->out_ep, f_fb->out_req, 0);
317 static int fastboot_add(struct usb_configuration *c)
319 struct f_fastboot *f_fb = fastboot_func;
322 debug("%s: cdev: 0x%p\n", __func__, c->cdev);
325 f_fb = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*f_fb));
329 fastboot_func = f_fb;
330 memset(f_fb, 0, sizeof(*f_fb));
333 f_fb->usb_function.name = "f_fastboot";
334 f_fb->usb_function.bind = fastboot_bind;
335 f_fb->usb_function.unbind = fastboot_unbind;
336 f_fb->usb_function.set_alt = fastboot_set_alt;
337 f_fb->usb_function.disable = fastboot_disable;
338 f_fb->usb_function.strings = fastboot_strings;
340 status = usb_add_function(c, &f_fb->usb_function);
343 fastboot_func = f_fb;
348 DECLARE_GADGET_BIND_CALLBACK(usb_dnl_fastboot, fastboot_add);
350 static int fastboot_tx_write(const char *buffer, unsigned int buffer_size)
352 struct usb_request *in_req = fastboot_func->in_req;
355 memcpy(in_req->buf, buffer, buffer_size);
356 in_req->length = buffer_size;
358 usb_ep_dequeue(fastboot_func->in_ep, in_req);
360 ret = usb_ep_queue(fastboot_func->in_ep, in_req, 0);
362 printf("Error %d on queue\n", ret);
366 static int fastboot_tx_write_str(const char *buffer)
368 return fastboot_tx_write(buffer, strlen(buffer));
371 static void compl_do_reset(struct usb_ep *ep, struct usb_request *req)
373 do_reset(NULL, 0, 0, NULL);
376 int __weak fb_set_reboot_flag(void)
381 static void cb_reboot(struct usb_ep *ep, struct usb_request *req)
383 char *cmd = req->buf;
384 if (!strcmp_l1("reboot-bootloader", cmd)) {
385 if (fb_set_reboot_flag()) {
386 fastboot_tx_write_str("FAILCannot set reboot flag");
390 fastboot_func->in_req->complete = compl_do_reset;
391 fastboot_tx_write_str("OKAY");
394 static int strcmp_l1(const char *s1, const char *s2)
398 return strncmp(s1, s2, strlen(s1));
401 static void cb_getvar(struct usb_ep *ep, struct usb_request *req)
403 char *cmd = req->buf;
404 char response[FASTBOOT_RESPONSE_LEN];
408 strcpy(response, "OKAY");
409 chars_left = sizeof(response) - strlen(response) - 1;
413 error("missing variable");
414 fastboot_tx_write_str("FAILmissing var");
418 if (!strcmp_l1("version", cmd)) {
419 strncat(response, FASTBOOT_VERSION, chars_left);
420 } else if (!strcmp_l1("bootloader-version", cmd)) {
421 strncat(response, U_BOOT_VERSION, chars_left);
422 } else if (!strcmp_l1("downloadsize", cmd) ||
423 !strcmp_l1("max-download-size", cmd)) {
426 sprintf(str_num, "0x%08x", CONFIG_FASTBOOT_BUF_SIZE);
427 strncat(response, str_num, chars_left);
430 * This also indicates the start of a new flashing
431 * "session", in which we could have 1-N buffers to
432 * write to a partition.
434 * Reset our session counter.
436 fastboot_flash_session_id = 0;
437 } else if (!strcmp_l1("serialno", cmd)) {
438 s = getenv("serial#");
440 strncat(response, s, chars_left);
442 strcpy(response, "FAILValue not set");
446 snprintf(envstr, sizeof(envstr) - 1, "fastboot.%s", cmd);
449 strncat(response, s, chars_left);
451 printf("WARNING: unknown variable: %s\n", cmd);
452 strcpy(response, "FAILVariable not implemented");
455 fastboot_tx_write_str(response);
458 static unsigned int rx_bytes_expected(unsigned int maxpacket)
460 int rx_remain = download_size - download_bytes;
464 if (rx_remain > EP_BUFFER_SIZE)
465 return EP_BUFFER_SIZE;
466 if (rx_remain < maxpacket) {
467 rx_remain = maxpacket;
468 } else if (rx_remain % maxpacket != 0) {
469 rem = rx_remain % maxpacket;
470 rx_remain = rx_remain + (maxpacket - rem);
475 #define BYTES_PER_DOT 0x20000
476 static void rx_handler_dl_image(struct usb_ep *ep, struct usb_request *req)
478 char response[FASTBOOT_RESPONSE_LEN];
479 unsigned int transfer_size = download_size - download_bytes;
480 const unsigned char *buffer = req->buf;
481 unsigned int buffer_size = req->actual;
482 unsigned int pre_dot_num, now_dot_num;
485 if (req->status != 0) {
486 printf("Bad status: %d\n", req->status);
490 if (buffer_size < transfer_size)
491 transfer_size = buffer_size;
493 memcpy((void *)CONFIG_FASTBOOT_BUF_ADDR + download_bytes,
494 buffer, transfer_size);
496 pre_dot_num = download_bytes / BYTES_PER_DOT;
497 download_bytes += transfer_size;
498 now_dot_num = download_bytes / BYTES_PER_DOT;
500 if (pre_dot_num != now_dot_num) {
502 if (!(now_dot_num % 74))
506 /* Check if transfer is done */
507 if (download_bytes >= download_size) {
509 * Reset global transfer variable, keep download_bytes because
510 * it will be used in the next possible flashing command
513 req->complete = rx_handler_command;
514 req->length = EP_BUFFER_SIZE;
516 strcpy(response, "OKAY");
517 fastboot_tx_write_str(response);
519 printf("\ndownloading of %d bytes finished\n", download_bytes);
521 max = is_high_speed ? hs_ep_out.wMaxPacketSize :
522 fs_ep_out.wMaxPacketSize;
523 req->length = rx_bytes_expected(max);
524 if (req->length < ep->maxpacket)
525 req->length = ep->maxpacket;
529 usb_ep_queue(ep, req, 0);
532 static void cb_download(struct usb_ep *ep, struct usb_request *req)
534 char *cmd = req->buf;
535 char response[FASTBOOT_RESPONSE_LEN];
539 download_size = simple_strtoul(cmd, NULL, 16);
542 printf("Starting download of %d bytes\n", download_size);
544 if (0 == download_size) {
545 strcpy(response, "FAILdata invalid size");
546 } else if (download_size > CONFIG_FASTBOOT_BUF_SIZE) {
548 strcpy(response, "FAILdata too large");
550 sprintf(response, "DATA%08x", download_size);
551 req->complete = rx_handler_dl_image;
552 max = is_high_speed ? hs_ep_out.wMaxPacketSize :
553 fs_ep_out.wMaxPacketSize;
554 req->length = rx_bytes_expected(max);
555 if (req->length < ep->maxpacket)
556 req->length = ep->maxpacket;
558 fastboot_tx_write_str(response);
561 static void do_bootm_on_complete(struct usb_ep *ep, struct usb_request *req)
563 char boot_addr_start[12];
564 char *bootm_args[] = { "bootm", boot_addr_start, NULL };
566 puts("Booting kernel..\n");
568 sprintf(boot_addr_start, "0x%lx", load_addr);
569 do_bootm(NULL, 0, 2, bootm_args);
571 /* This only happens if image is somehow faulty so we start over */
572 do_reset(NULL, 0, 0, NULL);
575 static void cb_boot(struct usb_ep *ep, struct usb_request *req)
577 fastboot_func->in_req->complete = do_bootm_on_complete;
578 fastboot_tx_write_str("OKAY");
581 static void do_exit_on_complete(struct usb_ep *ep, struct usb_request *req)
583 g_dnl_trigger_detach();
586 static void cb_continue(struct usb_ep *ep, struct usb_request *req)
588 fastboot_func->in_req->complete = do_exit_on_complete;
589 fastboot_tx_write_str("OKAY");
592 #ifdef CONFIG_FASTBOOT_FLASH
593 static void cb_flash(struct usb_ep *ep, struct usb_request *req)
595 char *cmd = req->buf;
596 char response[FASTBOOT_RESPONSE_LEN];
600 error("missing partition name");
601 fastboot_tx_write_str("FAILmissing partition name");
605 strcpy(response, "FAILno flash device defined");
606 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
607 fb_mmc_flash_write(cmd, fastboot_flash_session_id,
608 (void *)CONFIG_FASTBOOT_BUF_ADDR,
609 download_bytes, response);
611 #ifdef CONFIG_FASTBOOT_FLASH_NAND_DEV
612 fb_nand_flash_write(cmd, fastboot_flash_session_id,
613 (void *)CONFIG_FASTBOOT_BUF_ADDR,
614 download_bytes, response);
616 fastboot_flash_session_id++;
617 fastboot_tx_write_str(response);
621 static void cb_oem(struct usb_ep *ep, struct usb_request *req)
623 char *cmd = req->buf;
624 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
625 if (strncmp("format", cmd + 4, 6) == 0) {
627 sprintf(cmdbuf, "gpt write mmc %x $partitions",
628 CONFIG_FASTBOOT_FLASH_MMC_DEV);
629 if (run_command(cmdbuf, 0))
630 fastboot_tx_write_str("FAIL");
632 fastboot_tx_write_str("OKAY");
635 if (strncmp("unlock", cmd + 4, 8) == 0) {
636 fastboot_tx_write_str("FAILnot implemented");
639 fastboot_tx_write_str("FAILunknown oem command");
643 #ifdef CONFIG_FASTBOOT_FLASH
644 static void cb_erase(struct usb_ep *ep, struct usb_request *req)
646 char *cmd = req->buf;
647 char response[FASTBOOT_RESPONSE_LEN];
651 error("missing partition name");
652 fastboot_tx_write_str("FAILmissing partition name");
656 strcpy(response, "FAILno flash device defined");
658 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
659 fb_mmc_erase(cmd, response);
661 #ifdef CONFIG_FASTBOOT_FLASH_NAND_DEV
662 fb_nand_erase(cmd, response);
664 fastboot_tx_write_str(response);
668 struct cmd_dispatch_info {
670 void (*cb)(struct usb_ep *ep, struct usb_request *req);
673 static const struct cmd_dispatch_info cmd_dispatch_info[] = {
690 #ifdef CONFIG_FASTBOOT_FLASH
705 static void rx_handler_command(struct usb_ep *ep, struct usb_request *req)
707 char *cmdbuf = req->buf;
708 void (*func_cb)(struct usb_ep *ep, struct usb_request *req) = NULL;
711 if (req->status != 0 || req->length == 0)
714 for (i = 0; i < ARRAY_SIZE(cmd_dispatch_info); i++) {
715 if (!strcmp_l1(cmd_dispatch_info[i].cmd, cmdbuf)) {
716 func_cb = cmd_dispatch_info[i].cb;
722 error("unknown command: %s", cmdbuf);
723 fastboot_tx_write_str("FAILunknown command");
725 if (req->actual < req->length) {
726 u8 *buf = (u8 *)req->buf;
727 buf[req->actual] = 0;
730 error("buffer overflow");
731 fastboot_tx_write_str("FAILbuffer overflow");
737 usb_ep_queue(ep, req, 0);