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 download_size;
63 static unsigned int download_bytes;
65 static struct usb_endpoint_descriptor fs_ep_in = {
66 .bLength = USB_DT_ENDPOINT_SIZE,
67 .bDescriptorType = USB_DT_ENDPOINT,
68 .bEndpointAddress = USB_DIR_IN,
69 .bmAttributes = USB_ENDPOINT_XFER_BULK,
70 .wMaxPacketSize = cpu_to_le16(64),
73 static struct usb_endpoint_descriptor fs_ep_out = {
74 .bLength = USB_DT_ENDPOINT_SIZE,
75 .bDescriptorType = USB_DT_ENDPOINT,
76 .bEndpointAddress = USB_DIR_OUT,
77 .bmAttributes = USB_ENDPOINT_XFER_BULK,
78 .wMaxPacketSize = cpu_to_le16(64),
81 static struct usb_endpoint_descriptor hs_ep_in = {
82 .bLength = USB_DT_ENDPOINT_SIZE,
83 .bDescriptorType = USB_DT_ENDPOINT,
84 .bEndpointAddress = USB_DIR_IN,
85 .bmAttributes = USB_ENDPOINT_XFER_BULK,
86 .wMaxPacketSize = cpu_to_le16(512),
89 static struct usb_endpoint_descriptor hs_ep_out = {
90 .bLength = USB_DT_ENDPOINT_SIZE,
91 .bDescriptorType = USB_DT_ENDPOINT,
92 .bEndpointAddress = USB_DIR_OUT,
93 .bmAttributes = USB_ENDPOINT_XFER_BULK,
94 .wMaxPacketSize = cpu_to_le16(512),
97 static struct usb_interface_descriptor interface_desc = {
98 .bLength = USB_DT_INTERFACE_SIZE,
99 .bDescriptorType = USB_DT_INTERFACE,
100 .bInterfaceNumber = 0x00,
101 .bAlternateSetting = 0x00,
102 .bNumEndpoints = 0x02,
103 .bInterfaceClass = FASTBOOT_INTERFACE_CLASS,
104 .bInterfaceSubClass = FASTBOOT_INTERFACE_SUB_CLASS,
105 .bInterfaceProtocol = FASTBOOT_INTERFACE_PROTOCOL,
108 static struct usb_descriptor_header *fb_fs_function[] = {
109 (struct usb_descriptor_header *)&interface_desc,
110 (struct usb_descriptor_header *)&fs_ep_in,
111 (struct usb_descriptor_header *)&fs_ep_out,
114 static struct usb_descriptor_header *fb_hs_function[] = {
115 (struct usb_descriptor_header *)&interface_desc,
116 (struct usb_descriptor_header *)&hs_ep_in,
117 (struct usb_descriptor_header *)&hs_ep_out,
121 static struct usb_endpoint_descriptor *
122 fb_ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *fs,
123 struct usb_endpoint_descriptor *hs)
125 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
131 * static strings, in UTF-8
133 static const char fastboot_name[] = "Android Fastboot";
135 static struct usb_string fastboot_string_defs[] = {
136 [0].s = fastboot_name,
137 { } /* end of list */
140 static struct usb_gadget_strings stringtab_fastboot = {
141 .language = 0x0409, /* en-us */
142 .strings = fastboot_string_defs,
145 static struct usb_gadget_strings *fastboot_strings[] = {
150 static void rx_handler_command(struct usb_ep *ep, struct usb_request *req);
151 static int strcmp_l1(const char *s1, const char *s2);
154 void fastboot_fail(char *response, const char *reason)
156 strncpy(response, "FAIL\0", 5);
157 strncat(response, reason, FASTBOOT_RESPONSE_LEN - 4 - 1);
160 void fastboot_okay(char *response, const char *reason)
162 strncpy(response, "OKAY\0", 5);
163 strncat(response, reason, FASTBOOT_RESPONSE_LEN - 4 - 1);
166 static void fastboot_complete(struct usb_ep *ep, struct usb_request *req)
168 int status = req->status;
171 printf("status: %d ep '%s' trans: %d\n", status, ep->name, req->actual);
174 static int fastboot_bind(struct usb_configuration *c, struct usb_function *f)
177 struct usb_gadget *gadget = c->cdev->gadget;
178 struct f_fastboot *f_fb = func_to_fastboot(f);
181 /* DYNAMIC interface numbers assignments */
182 id = usb_interface_id(c, f);
185 interface_desc.bInterfaceNumber = id;
187 id = usb_string_id(c->cdev);
190 fastboot_string_defs[0].id = id;
191 interface_desc.iInterface = id;
193 f_fb->in_ep = usb_ep_autoconfig(gadget, &fs_ep_in);
196 f_fb->in_ep->driver_data = c->cdev;
198 f_fb->out_ep = usb_ep_autoconfig(gadget, &fs_ep_out);
201 f_fb->out_ep->driver_data = c->cdev;
203 f->descriptors = fb_fs_function;
205 if (gadget_is_dualspeed(gadget)) {
206 /* Assume endpoint addresses are the same for both speeds */
207 hs_ep_in.bEndpointAddress = fs_ep_in.bEndpointAddress;
208 hs_ep_out.bEndpointAddress = fs_ep_out.bEndpointAddress;
209 /* copy HS descriptors */
210 f->hs_descriptors = fb_hs_function;
213 s = getenv("serial#");
215 g_dnl_set_serialnumber((char *)s);
220 static void fastboot_unbind(struct usb_configuration *c, struct usb_function *f)
222 memset(fastboot_func, 0, sizeof(*fastboot_func));
225 static void fastboot_disable(struct usb_function *f)
227 struct f_fastboot *f_fb = func_to_fastboot(f);
229 usb_ep_disable(f_fb->out_ep);
230 usb_ep_disable(f_fb->in_ep);
233 free(f_fb->out_req->buf);
234 usb_ep_free_request(f_fb->out_ep, f_fb->out_req);
235 f_fb->out_req = NULL;
238 free(f_fb->in_req->buf);
239 usb_ep_free_request(f_fb->in_ep, f_fb->in_req);
244 static struct usb_request *fastboot_start_ep(struct usb_ep *ep)
246 struct usb_request *req;
248 req = usb_ep_alloc_request(ep, 0);
252 req->length = EP_BUFFER_SIZE;
253 req->buf = memalign(CONFIG_SYS_CACHELINE_SIZE, EP_BUFFER_SIZE);
255 usb_ep_free_request(ep, req);
259 memset(req->buf, 0, req->length);
263 static int fastboot_set_alt(struct usb_function *f,
264 unsigned interface, unsigned alt)
267 struct usb_composite_dev *cdev = f->config->cdev;
268 struct usb_gadget *gadget = cdev->gadget;
269 struct f_fastboot *f_fb = func_to_fastboot(f);
270 const struct usb_endpoint_descriptor *d;
272 debug("%s: func: %s intf: %d alt: %d\n",
273 __func__, f->name, interface, alt);
275 d = fb_ep_desc(gadget, &fs_ep_out, &hs_ep_out);
276 ret = usb_ep_enable(f_fb->out_ep, d);
278 puts("failed to enable out ep\n");
282 f_fb->out_req = fastboot_start_ep(f_fb->out_ep);
283 if (!f_fb->out_req) {
284 puts("failed to alloc out req\n");
288 f_fb->out_req->complete = rx_handler_command;
290 d = fb_ep_desc(gadget, &fs_ep_in, &hs_ep_in);
291 ret = usb_ep_enable(f_fb->in_ep, d);
293 puts("failed to enable in ep\n");
297 f_fb->in_req = fastboot_start_ep(f_fb->in_ep);
299 puts("failed alloc req in\n");
303 f_fb->in_req->complete = fastboot_complete;
305 ret = usb_ep_queue(f_fb->out_ep, f_fb->out_req, 0);
315 static int fastboot_add(struct usb_configuration *c)
317 struct f_fastboot *f_fb = fastboot_func;
320 debug("%s: cdev: 0x%p\n", __func__, c->cdev);
323 f_fb = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*f_fb));
327 fastboot_func = f_fb;
328 memset(f_fb, 0, sizeof(*f_fb));
331 f_fb->usb_function.name = "f_fastboot";
332 f_fb->usb_function.bind = fastboot_bind;
333 f_fb->usb_function.unbind = fastboot_unbind;
334 f_fb->usb_function.set_alt = fastboot_set_alt;
335 f_fb->usb_function.disable = fastboot_disable;
336 f_fb->usb_function.strings = fastboot_strings;
338 status = usb_add_function(c, &f_fb->usb_function);
341 fastboot_func = f_fb;
346 DECLARE_GADGET_BIND_CALLBACK(usb_dnl_fastboot, fastboot_add);
348 static int fastboot_tx_write(const char *buffer, unsigned int buffer_size)
350 struct usb_request *in_req = fastboot_func->in_req;
353 memcpy(in_req->buf, buffer, buffer_size);
354 in_req->length = buffer_size;
356 usb_ep_dequeue(fastboot_func->in_ep, in_req);
358 ret = usb_ep_queue(fastboot_func->in_ep, in_req, 0);
360 printf("Error %d on queue\n", ret);
364 static int fastboot_tx_write_str(const char *buffer)
366 return fastboot_tx_write(buffer, strlen(buffer));
369 static void compl_do_reset(struct usb_ep *ep, struct usb_request *req)
371 do_reset(NULL, 0, 0, NULL);
374 int __weak fb_set_reboot_flag(void)
379 static void cb_reboot(struct usb_ep *ep, struct usb_request *req)
381 char *cmd = req->buf;
382 if (!strcmp_l1("reboot-bootloader", cmd)) {
383 if (fb_set_reboot_flag()) {
384 fastboot_tx_write_str("FAILCannot set reboot flag");
388 fastboot_func->in_req->complete = compl_do_reset;
389 fastboot_tx_write_str("OKAY");
392 static int strcmp_l1(const char *s1, const char *s2)
396 return strncmp(s1, s2, strlen(s1));
399 static void cb_getvar(struct usb_ep *ep, struct usb_request *req)
401 char *cmd = req->buf;
402 char response[FASTBOOT_RESPONSE_LEN];
406 strcpy(response, "OKAY");
407 chars_left = sizeof(response) - strlen(response) - 1;
411 error("missing variable");
412 fastboot_tx_write_str("FAILmissing var");
416 if (!strcmp_l1("version", cmd)) {
417 strncat(response, FASTBOOT_VERSION, chars_left);
418 } else if (!strcmp_l1("bootloader-version", cmd)) {
419 strncat(response, U_BOOT_VERSION, chars_left);
420 } else if (!strcmp_l1("downloadsize", cmd) ||
421 !strcmp_l1("max-download-size", cmd)) {
424 sprintf(str_num, "0x%08x", CONFIG_FASTBOOT_BUF_SIZE);
425 strncat(response, str_num, chars_left);
426 } else if (!strcmp_l1("serialno", cmd)) {
427 s = getenv("serial#");
429 strncat(response, s, chars_left);
431 strcpy(response, "FAILValue not set");
435 snprintf(envstr, sizeof(envstr) - 1, "fastboot.%s", cmd);
438 strncat(response, s, chars_left);
440 printf("WARNING: unknown variable: %s\n", cmd);
441 strcpy(response, "FAILVariable not implemented");
444 fastboot_tx_write_str(response);
447 static unsigned int rx_bytes_expected(struct usb_ep *ep)
449 int rx_remain = download_size - download_bytes;
451 unsigned int maxpacket = ep->maxpacket;
455 else if (rx_remain > EP_BUFFER_SIZE)
456 return EP_BUFFER_SIZE;
459 * Some controllers e.g. DWC3 don't like OUT transfers to be
460 * not ending in maxpacket boundary. So just make them happy by
461 * always requesting for integral multiple of maxpackets.
462 * This shouldn't bother controllers that don't care about it.
464 rem = rx_remain % maxpacket;
466 rx_remain = rx_remain + (maxpacket - rem);
471 #define BYTES_PER_DOT 0x20000
472 static void rx_handler_dl_image(struct usb_ep *ep, struct usb_request *req)
474 char response[FASTBOOT_RESPONSE_LEN];
475 unsigned int transfer_size = download_size - download_bytes;
476 const unsigned char *buffer = req->buf;
477 unsigned int buffer_size = req->actual;
478 unsigned int pre_dot_num, now_dot_num;
480 if (req->status != 0) {
481 printf("Bad status: %d\n", req->status);
485 if (buffer_size < transfer_size)
486 transfer_size = buffer_size;
488 memcpy((void *)CONFIG_FASTBOOT_BUF_ADDR + download_bytes,
489 buffer, transfer_size);
491 pre_dot_num = download_bytes / BYTES_PER_DOT;
492 download_bytes += transfer_size;
493 now_dot_num = download_bytes / BYTES_PER_DOT;
495 if (pre_dot_num != now_dot_num) {
497 if (!(now_dot_num % 74))
501 /* Check if transfer is done */
502 if (download_bytes >= download_size) {
504 * Reset global transfer variable, keep download_bytes because
505 * it will be used in the next possible flashing command
508 req->complete = rx_handler_command;
509 req->length = EP_BUFFER_SIZE;
511 strcpy(response, "OKAY");
512 fastboot_tx_write_str(response);
514 printf("\ndownloading of %d bytes finished\n", download_bytes);
516 req->length = rx_bytes_expected(ep);
520 usb_ep_queue(ep, req, 0);
523 static void cb_download(struct usb_ep *ep, struct usb_request *req)
525 char *cmd = req->buf;
526 char response[FASTBOOT_RESPONSE_LEN];
529 download_size = simple_strtoul(cmd, NULL, 16);
532 printf("Starting download of %d bytes\n", download_size);
534 if (0 == download_size) {
535 strcpy(response, "FAILdata invalid size");
536 } else if (download_size > CONFIG_FASTBOOT_BUF_SIZE) {
538 strcpy(response, "FAILdata too large");
540 sprintf(response, "DATA%08x", download_size);
541 req->complete = rx_handler_dl_image;
542 req->length = rx_bytes_expected(ep);
544 fastboot_tx_write_str(response);
547 static void do_bootm_on_complete(struct usb_ep *ep, struct usb_request *req)
549 char boot_addr_start[12];
550 char *bootm_args[] = { "bootm", boot_addr_start, NULL };
552 puts("Booting kernel..\n");
554 sprintf(boot_addr_start, "0x%lx", load_addr);
555 do_bootm(NULL, 0, 2, bootm_args);
557 /* This only happens if image is somehow faulty so we start over */
558 do_reset(NULL, 0, 0, NULL);
561 static void cb_boot(struct usb_ep *ep, struct usb_request *req)
563 fastboot_func->in_req->complete = do_bootm_on_complete;
564 fastboot_tx_write_str("OKAY");
567 static void do_exit_on_complete(struct usb_ep *ep, struct usb_request *req)
569 g_dnl_trigger_detach();
572 static void cb_continue(struct usb_ep *ep, struct usb_request *req)
574 fastboot_func->in_req->complete = do_exit_on_complete;
575 fastboot_tx_write_str("OKAY");
578 #ifdef CONFIG_FASTBOOT_FLASH
579 static void cb_flash(struct usb_ep *ep, struct usb_request *req)
581 char *cmd = req->buf;
582 char response[FASTBOOT_RESPONSE_LEN];
586 error("missing partition name");
587 fastboot_tx_write_str("FAILmissing partition name");
591 strcpy(response, "FAILno flash device defined");
592 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
593 fb_mmc_flash_write(cmd, (void *)CONFIG_FASTBOOT_BUF_ADDR,
594 download_bytes, response);
596 #ifdef CONFIG_FASTBOOT_FLASH_NAND_DEV
597 fb_nand_flash_write(cmd,
598 (void *)CONFIG_FASTBOOT_BUF_ADDR,
599 download_bytes, response);
601 fastboot_tx_write_str(response);
605 static void cb_oem(struct usb_ep *ep, struct usb_request *req)
607 char *cmd = req->buf;
608 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
609 if (strncmp("format", cmd + 4, 6) == 0) {
611 sprintf(cmdbuf, "gpt write mmc %x $partitions",
612 CONFIG_FASTBOOT_FLASH_MMC_DEV);
613 if (run_command(cmdbuf, 0))
614 fastboot_tx_write_str("FAIL");
616 fastboot_tx_write_str("OKAY");
619 if (strncmp("unlock", cmd + 4, 8) == 0) {
620 fastboot_tx_write_str("FAILnot implemented");
623 fastboot_tx_write_str("FAILunknown oem command");
627 #ifdef CONFIG_FASTBOOT_FLASH
628 static void cb_erase(struct usb_ep *ep, struct usb_request *req)
630 char *cmd = req->buf;
631 char response[FASTBOOT_RESPONSE_LEN];
635 error("missing partition name");
636 fastboot_tx_write_str("FAILmissing partition name");
640 strcpy(response, "FAILno flash device defined");
642 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
643 fb_mmc_erase(cmd, response);
645 #ifdef CONFIG_FASTBOOT_FLASH_NAND_DEV
646 fb_nand_erase(cmd, response);
648 fastboot_tx_write_str(response);
652 struct cmd_dispatch_info {
654 void (*cb)(struct usb_ep *ep, struct usb_request *req);
657 static const struct cmd_dispatch_info cmd_dispatch_info[] = {
674 #ifdef CONFIG_FASTBOOT_FLASH
689 static void rx_handler_command(struct usb_ep *ep, struct usb_request *req)
691 char *cmdbuf = req->buf;
692 void (*func_cb)(struct usb_ep *ep, struct usb_request *req) = NULL;
695 if (req->status != 0 || req->length == 0)
698 for (i = 0; i < ARRAY_SIZE(cmd_dispatch_info); i++) {
699 if (!strcmp_l1(cmd_dispatch_info[i].cmd, cmdbuf)) {
700 func_cb = cmd_dispatch_info[i].cb;
706 error("unknown command: %s", cmdbuf);
707 fastboot_tx_write_str("FAILunknown command");
709 if (req->actual < req->length) {
710 u8 *buf = (u8 *)req->buf;
711 buf[req->actual] = 0;
714 error("buffer overflow");
715 fastboot_tx_write_str("FAILbuffer overflow");
721 usb_ep_queue(ep, req, 0);