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
43 * EP_BUFFER_SIZE must always be an integral multiple of maxpacket size
44 * (64 or 512 or 1024), else we break on certain controllers like DWC3
45 * that expect bulk OUT requests to be divisible by maxpacket size.
49 struct usb_function usb_function;
51 /* IN/OUT EP's and corresponding requests */
52 struct usb_ep *in_ep, *out_ep;
53 struct usb_request *in_req, *out_req;
56 static inline struct f_fastboot *func_to_fastboot(struct usb_function *f)
58 return container_of(f, struct f_fastboot, usb_function);
61 static struct f_fastboot *fastboot_func;
62 static unsigned int fastboot_flash_session_id;
63 static unsigned int download_size;
64 static unsigned int download_bytes;
66 static struct usb_endpoint_descriptor fs_ep_in = {
67 .bLength = USB_DT_ENDPOINT_SIZE,
68 .bDescriptorType = USB_DT_ENDPOINT,
69 .bEndpointAddress = USB_DIR_IN,
70 .bmAttributes = USB_ENDPOINT_XFER_BULK,
71 .wMaxPacketSize = cpu_to_le16(64),
74 static struct usb_endpoint_descriptor fs_ep_out = {
75 .bLength = USB_DT_ENDPOINT_SIZE,
76 .bDescriptorType = USB_DT_ENDPOINT,
77 .bEndpointAddress = USB_DIR_OUT,
78 .bmAttributes = USB_ENDPOINT_XFER_BULK,
79 .wMaxPacketSize = cpu_to_le16(64),
82 static struct usb_endpoint_descriptor hs_ep_in = {
83 .bLength = USB_DT_ENDPOINT_SIZE,
84 .bDescriptorType = USB_DT_ENDPOINT,
85 .bEndpointAddress = USB_DIR_IN,
86 .bmAttributes = USB_ENDPOINT_XFER_BULK,
87 .wMaxPacketSize = cpu_to_le16(512),
90 static struct usb_endpoint_descriptor hs_ep_out = {
91 .bLength = USB_DT_ENDPOINT_SIZE,
92 .bDescriptorType = USB_DT_ENDPOINT,
93 .bEndpointAddress = USB_DIR_OUT,
94 .bmAttributes = USB_ENDPOINT_XFER_BULK,
95 .wMaxPacketSize = cpu_to_le16(512),
98 static struct usb_interface_descriptor interface_desc = {
99 .bLength = USB_DT_INTERFACE_SIZE,
100 .bDescriptorType = USB_DT_INTERFACE,
101 .bInterfaceNumber = 0x00,
102 .bAlternateSetting = 0x00,
103 .bNumEndpoints = 0x02,
104 .bInterfaceClass = FASTBOOT_INTERFACE_CLASS,
105 .bInterfaceSubClass = FASTBOOT_INTERFACE_SUB_CLASS,
106 .bInterfaceProtocol = FASTBOOT_INTERFACE_PROTOCOL,
109 static struct usb_descriptor_header *fb_fs_function[] = {
110 (struct usb_descriptor_header *)&interface_desc,
111 (struct usb_descriptor_header *)&fs_ep_in,
112 (struct usb_descriptor_header *)&fs_ep_out,
115 static struct usb_descriptor_header *fb_hs_function[] = {
116 (struct usb_descriptor_header *)&interface_desc,
117 (struct usb_descriptor_header *)&hs_ep_in,
118 (struct usb_descriptor_header *)&hs_ep_out,
122 static struct usb_endpoint_descriptor *
123 fb_ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *fs,
124 struct usb_endpoint_descriptor *hs)
126 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
132 * static strings, in UTF-8
134 static const char fastboot_name[] = "Android Fastboot";
136 static struct usb_string fastboot_string_defs[] = {
137 [0].s = fastboot_name,
138 { } /* end of list */
141 static struct usb_gadget_strings stringtab_fastboot = {
142 .language = 0x0409, /* en-us */
143 .strings = fastboot_string_defs,
146 static struct usb_gadget_strings *fastboot_strings[] = {
151 static void rx_handler_command(struct usb_ep *ep, struct usb_request *req);
152 static int strcmp_l1(const char *s1, const char *s2);
155 void fastboot_fail(char *response, const char *reason)
157 strncpy(response, "FAIL\0", 5);
158 strncat(response, reason, FASTBOOT_RESPONSE_LEN - 4 - 1);
161 void fastboot_okay(char *response, const char *reason)
163 strncpy(response, "OKAY\0", 5);
164 strncat(response, reason, FASTBOOT_RESPONSE_LEN - 4 - 1);
167 static void fastboot_complete(struct usb_ep *ep, struct usb_request *req)
169 int status = req->status;
172 printf("status: %d ep '%s' trans: %d\n", status, ep->name, req->actual);
175 static int fastboot_bind(struct usb_configuration *c, struct usb_function *f)
178 struct usb_gadget *gadget = c->cdev->gadget;
179 struct f_fastboot *f_fb = func_to_fastboot(f);
182 /* DYNAMIC interface numbers assignments */
183 id = usb_interface_id(c, f);
186 interface_desc.bInterfaceNumber = id;
188 id = usb_string_id(c->cdev);
191 fastboot_string_defs[0].id = id;
192 interface_desc.iInterface = id;
194 f_fb->in_ep = usb_ep_autoconfig(gadget, &fs_ep_in);
197 f_fb->in_ep->driver_data = c->cdev;
199 f_fb->out_ep = usb_ep_autoconfig(gadget, &fs_ep_out);
202 f_fb->out_ep->driver_data = c->cdev;
204 f->descriptors = fb_fs_function;
206 if (gadget_is_dualspeed(gadget)) {
207 /* Assume endpoint addresses are the same for both speeds */
208 hs_ep_in.bEndpointAddress = fs_ep_in.bEndpointAddress;
209 hs_ep_out.bEndpointAddress = fs_ep_out.bEndpointAddress;
210 /* copy HS descriptors */
211 f->hs_descriptors = fb_hs_function;
214 s = getenv("serial#");
216 g_dnl_set_serialnumber((char *)s);
221 static void fastboot_unbind(struct usb_configuration *c, struct usb_function *f)
223 memset(fastboot_func, 0, sizeof(*fastboot_func));
226 static void fastboot_disable(struct usb_function *f)
228 struct f_fastboot *f_fb = func_to_fastboot(f);
230 usb_ep_disable(f_fb->out_ep);
231 usb_ep_disable(f_fb->in_ep);
234 free(f_fb->out_req->buf);
235 usb_ep_free_request(f_fb->out_ep, f_fb->out_req);
236 f_fb->out_req = NULL;
239 free(f_fb->in_req->buf);
240 usb_ep_free_request(f_fb->in_ep, f_fb->in_req);
245 static struct usb_request *fastboot_start_ep(struct usb_ep *ep)
247 struct usb_request *req;
249 req = usb_ep_alloc_request(ep, 0);
253 req->length = EP_BUFFER_SIZE;
254 req->buf = memalign(CONFIG_SYS_CACHELINE_SIZE, EP_BUFFER_SIZE);
256 usb_ep_free_request(ep, req);
260 memset(req->buf, 0, req->length);
264 static int fastboot_set_alt(struct usb_function *f,
265 unsigned interface, unsigned alt)
268 struct usb_composite_dev *cdev = f->config->cdev;
269 struct usb_gadget *gadget = cdev->gadget;
270 struct f_fastboot *f_fb = func_to_fastboot(f);
271 const struct usb_endpoint_descriptor *d;
273 debug("%s: func: %s intf: %d alt: %d\n",
274 __func__, f->name, interface, alt);
276 d = fb_ep_desc(gadget, &fs_ep_out, &hs_ep_out);
277 ret = usb_ep_enable(f_fb->out_ep, d);
279 puts("failed to enable out ep\n");
283 f_fb->out_req = fastboot_start_ep(f_fb->out_ep);
284 if (!f_fb->out_req) {
285 puts("failed to alloc out req\n");
289 f_fb->out_req->complete = rx_handler_command;
291 d = fb_ep_desc(gadget, &fs_ep_in, &hs_ep_in);
292 ret = usb_ep_enable(f_fb->in_ep, d);
294 puts("failed to enable in ep\n");
298 f_fb->in_req = fastboot_start_ep(f_fb->in_ep);
300 puts("failed alloc req in\n");
304 f_fb->in_req->complete = fastboot_complete;
306 ret = usb_ep_queue(f_fb->out_ep, f_fb->out_req, 0);
316 static int fastboot_add(struct usb_configuration *c)
318 struct f_fastboot *f_fb = fastboot_func;
321 debug("%s: cdev: 0x%p\n", __func__, c->cdev);
324 f_fb = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*f_fb));
328 fastboot_func = f_fb;
329 memset(f_fb, 0, sizeof(*f_fb));
332 f_fb->usb_function.name = "f_fastboot";
333 f_fb->usb_function.bind = fastboot_bind;
334 f_fb->usb_function.unbind = fastboot_unbind;
335 f_fb->usb_function.set_alt = fastboot_set_alt;
336 f_fb->usb_function.disable = fastboot_disable;
337 f_fb->usb_function.strings = fastboot_strings;
339 status = usb_add_function(c, &f_fb->usb_function);
342 fastboot_func = f_fb;
347 DECLARE_GADGET_BIND_CALLBACK(usb_dnl_fastboot, fastboot_add);
349 static int fastboot_tx_write(const char *buffer, unsigned int buffer_size)
351 struct usb_request *in_req = fastboot_func->in_req;
354 memcpy(in_req->buf, buffer, buffer_size);
355 in_req->length = buffer_size;
357 usb_ep_dequeue(fastboot_func->in_ep, in_req);
359 ret = usb_ep_queue(fastboot_func->in_ep, in_req, 0);
361 printf("Error %d on queue\n", ret);
365 static int fastboot_tx_write_str(const char *buffer)
367 return fastboot_tx_write(buffer, strlen(buffer));
370 static void compl_do_reset(struct usb_ep *ep, struct usb_request *req)
372 do_reset(NULL, 0, 0, NULL);
375 int __weak fb_set_reboot_flag(void)
380 static void cb_reboot(struct usb_ep *ep, struct usb_request *req)
382 char *cmd = req->buf;
383 if (!strcmp_l1("reboot-bootloader", cmd)) {
384 if (fb_set_reboot_flag()) {
385 fastboot_tx_write_str("FAILCannot set reboot flag");
389 fastboot_func->in_req->complete = compl_do_reset;
390 fastboot_tx_write_str("OKAY");
393 static int strcmp_l1(const char *s1, const char *s2)
397 return strncmp(s1, s2, strlen(s1));
400 static void cb_getvar(struct usb_ep *ep, struct usb_request *req)
402 char *cmd = req->buf;
403 char response[FASTBOOT_RESPONSE_LEN];
407 strcpy(response, "OKAY");
408 chars_left = sizeof(response) - strlen(response) - 1;
412 error("missing variable");
413 fastboot_tx_write_str("FAILmissing var");
417 if (!strcmp_l1("version", cmd)) {
418 strncat(response, FASTBOOT_VERSION, chars_left);
419 } else if (!strcmp_l1("bootloader-version", cmd)) {
420 strncat(response, U_BOOT_VERSION, chars_left);
421 } else if (!strcmp_l1("downloadsize", cmd) ||
422 !strcmp_l1("max-download-size", cmd)) {
425 sprintf(str_num, "0x%08x", CONFIG_FASTBOOT_BUF_SIZE);
426 strncat(response, str_num, chars_left);
429 * This also indicates the start of a new flashing
430 * "session", in which we could have 1-N buffers to
431 * write to a partition.
433 * Reset our session counter.
435 fastboot_flash_session_id = 0;
436 } else if (!strcmp_l1("serialno", cmd)) {
437 s = getenv("serial#");
439 strncat(response, s, chars_left);
441 strcpy(response, "FAILValue not set");
445 snprintf(envstr, sizeof(envstr) - 1, "fastboot.%s", cmd);
448 strncat(response, s, chars_left);
450 printf("WARNING: unknown variable: %s\n", cmd);
451 strcpy(response, "FAILVariable not implemented");
454 fastboot_tx_write_str(response);
457 static unsigned int rx_bytes_expected(struct usb_ep *ep)
459 int rx_remain = download_size - download_bytes;
461 unsigned int maxpacket = ep->maxpacket;
465 else if (rx_remain > EP_BUFFER_SIZE)
466 return EP_BUFFER_SIZE;
469 * Some controllers e.g. DWC3 don't like OUT transfers to be
470 * not ending in maxpacket boundary. So just make them happy by
471 * always requesting for integral multiple of maxpackets.
472 * This shouldn't bother controllers that don't care about it.
474 rem = rx_remain % maxpacket;
476 rx_remain = rx_remain + (maxpacket - rem);
481 #define BYTES_PER_DOT 0x20000
482 static void rx_handler_dl_image(struct usb_ep *ep, struct usb_request *req)
484 char response[FASTBOOT_RESPONSE_LEN];
485 unsigned int transfer_size = download_size - download_bytes;
486 const unsigned char *buffer = req->buf;
487 unsigned int buffer_size = req->actual;
488 unsigned int pre_dot_num, now_dot_num;
490 if (req->status != 0) {
491 printf("Bad status: %d\n", req->status);
495 if (buffer_size < transfer_size)
496 transfer_size = buffer_size;
498 memcpy((void *)CONFIG_FASTBOOT_BUF_ADDR + download_bytes,
499 buffer, transfer_size);
501 pre_dot_num = download_bytes / BYTES_PER_DOT;
502 download_bytes += transfer_size;
503 now_dot_num = download_bytes / BYTES_PER_DOT;
505 if (pre_dot_num != now_dot_num) {
507 if (!(now_dot_num % 74))
511 /* Check if transfer is done */
512 if (download_bytes >= download_size) {
514 * Reset global transfer variable, keep download_bytes because
515 * it will be used in the next possible flashing command
518 req->complete = rx_handler_command;
519 req->length = EP_BUFFER_SIZE;
521 strcpy(response, "OKAY");
522 fastboot_tx_write_str(response);
524 printf("\ndownloading of %d bytes finished\n", download_bytes);
526 req->length = rx_bytes_expected(ep);
530 usb_ep_queue(ep, req, 0);
533 static void cb_download(struct usb_ep *ep, struct usb_request *req)
535 char *cmd = req->buf;
536 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 req->length = rx_bytes_expected(ep);
554 fastboot_tx_write_str(response);
557 static void do_bootm_on_complete(struct usb_ep *ep, struct usb_request *req)
559 char boot_addr_start[12];
560 char *bootm_args[] = { "bootm", boot_addr_start, NULL };
562 puts("Booting kernel..\n");
564 sprintf(boot_addr_start, "0x%lx", load_addr);
565 do_bootm(NULL, 0, 2, bootm_args);
567 /* This only happens if image is somehow faulty so we start over */
568 do_reset(NULL, 0, 0, NULL);
571 static void cb_boot(struct usb_ep *ep, struct usb_request *req)
573 fastboot_func->in_req->complete = do_bootm_on_complete;
574 fastboot_tx_write_str("OKAY");
577 static void do_exit_on_complete(struct usb_ep *ep, struct usb_request *req)
579 g_dnl_trigger_detach();
582 static void cb_continue(struct usb_ep *ep, struct usb_request *req)
584 fastboot_func->in_req->complete = do_exit_on_complete;
585 fastboot_tx_write_str("OKAY");
588 #ifdef CONFIG_FASTBOOT_FLASH
589 static void cb_flash(struct usb_ep *ep, struct usb_request *req)
591 char *cmd = req->buf;
592 char response[FASTBOOT_RESPONSE_LEN];
596 error("missing partition name");
597 fastboot_tx_write_str("FAILmissing partition name");
601 strcpy(response, "FAILno flash device defined");
602 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
603 fb_mmc_flash_write(cmd, fastboot_flash_session_id,
604 (void *)CONFIG_FASTBOOT_BUF_ADDR,
605 download_bytes, response);
607 #ifdef CONFIG_FASTBOOT_FLASH_NAND_DEV
608 fb_nand_flash_write(cmd, fastboot_flash_session_id,
609 (void *)CONFIG_FASTBOOT_BUF_ADDR,
610 download_bytes, response);
612 fastboot_flash_session_id++;
613 fastboot_tx_write_str(response);
617 static void cb_oem(struct usb_ep *ep, struct usb_request *req)
619 char *cmd = req->buf;
620 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
621 if (strncmp("format", cmd + 4, 6) == 0) {
623 sprintf(cmdbuf, "gpt write mmc %x $partitions",
624 CONFIG_FASTBOOT_FLASH_MMC_DEV);
625 if (run_command(cmdbuf, 0))
626 fastboot_tx_write_str("FAIL");
628 fastboot_tx_write_str("OKAY");
631 if (strncmp("unlock", cmd + 4, 8) == 0) {
632 fastboot_tx_write_str("FAILnot implemented");
635 fastboot_tx_write_str("FAILunknown oem command");
639 #ifdef CONFIG_FASTBOOT_FLASH
640 static void cb_erase(struct usb_ep *ep, struct usb_request *req)
642 char *cmd = req->buf;
643 char response[FASTBOOT_RESPONSE_LEN];
647 error("missing partition name");
648 fastboot_tx_write_str("FAILmissing partition name");
652 strcpy(response, "FAILno flash device defined");
654 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
655 fb_mmc_erase(cmd, response);
657 #ifdef CONFIG_FASTBOOT_FLASH_NAND_DEV
658 fb_nand_erase(cmd, response);
660 fastboot_tx_write_str(response);
664 struct cmd_dispatch_info {
666 void (*cb)(struct usb_ep *ep, struct usb_request *req);
669 static const struct cmd_dispatch_info cmd_dispatch_info[] = {
686 #ifdef CONFIG_FASTBOOT_FLASH
701 static void rx_handler_command(struct usb_ep *ep, struct usb_request *req)
703 char *cmdbuf = req->buf;
704 void (*func_cb)(struct usb_ep *ep, struct usb_request *req) = NULL;
707 if (req->status != 0 || req->length == 0)
710 for (i = 0; i < ARRAY_SIZE(cmd_dispatch_info); i++) {
711 if (!strcmp_l1(cmd_dispatch_info[i].cmd, cmdbuf)) {
712 func_cb = cmd_dispatch_info[i].cb;
718 error("unknown command: %s", cmdbuf);
719 fastboot_tx_write_str("FAILunknown command");
721 if (req->actual < req->length) {
722 u8 *buf = (u8 *)req->buf;
723 buf[req->actual] = 0;
726 error("buffer overflow");
727 fastboot_tx_write_str("FAILbuffer overflow");
733 usb_ep_queue(ep, req, 0);