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+
17 #include <linux/usb/ch9.h>
18 #include <linux/usb/gadget.h>
19 #include <linux/usb/composite.h>
20 #include <linux/compiler.h>
23 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
27 #define FASTBOOT_VERSION "0.4"
29 #define FASTBOOT_INTERFACE_CLASS 0xff
30 #define FASTBOOT_INTERFACE_SUB_CLASS 0x42
31 #define FASTBOOT_INTERFACE_PROTOCOL 0x03
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)
37 /* The 64 defined bytes plus \0 */
38 #define RESPONSE_LEN (64 + 1)
40 #define EP_BUFFER_SIZE 4096
43 struct usb_function usb_function;
45 /* IN/OUT EP's and corresponding requests */
46 struct usb_ep *in_ep, *out_ep;
47 struct usb_request *in_req, *out_req;
50 static inline struct f_fastboot *func_to_fastboot(struct usb_function *f)
52 return container_of(f, struct f_fastboot, usb_function);
55 static struct f_fastboot *fastboot_func;
56 static unsigned int download_size;
57 static unsigned int download_bytes;
58 static bool is_high_speed;
60 static struct usb_endpoint_descriptor fs_ep_in = {
61 .bLength = USB_DT_ENDPOINT_SIZE,
62 .bDescriptorType = USB_DT_ENDPOINT,
63 .bEndpointAddress = USB_DIR_IN,
64 .bmAttributes = USB_ENDPOINT_XFER_BULK,
65 .wMaxPacketSize = TX_ENDPOINT_MAXIMUM_PACKET_SIZE,
69 static struct usb_endpoint_descriptor fs_ep_out = {
70 .bLength = USB_DT_ENDPOINT_SIZE,
71 .bDescriptorType = USB_DT_ENDPOINT,
72 .bEndpointAddress = USB_DIR_OUT,
73 .bmAttributes = USB_ENDPOINT_XFER_BULK,
74 .wMaxPacketSize = RX_ENDPOINT_MAXIMUM_PACKET_SIZE_1_1,
78 static struct usb_endpoint_descriptor hs_ep_out = {
79 .bLength = USB_DT_ENDPOINT_SIZE,
80 .bDescriptorType = USB_DT_ENDPOINT,
81 .bEndpointAddress = USB_DIR_OUT,
82 .bmAttributes = USB_ENDPOINT_XFER_BULK,
83 .wMaxPacketSize = RX_ENDPOINT_MAXIMUM_PACKET_SIZE_2_0,
87 static struct usb_interface_descriptor interface_desc = {
88 .bLength = USB_DT_INTERFACE_SIZE,
89 .bDescriptorType = USB_DT_INTERFACE,
90 .bInterfaceNumber = 0x00,
91 .bAlternateSetting = 0x00,
92 .bNumEndpoints = 0x02,
93 .bInterfaceClass = FASTBOOT_INTERFACE_CLASS,
94 .bInterfaceSubClass = FASTBOOT_INTERFACE_SUB_CLASS,
95 .bInterfaceProtocol = FASTBOOT_INTERFACE_PROTOCOL,
98 static struct usb_descriptor_header *fb_runtime_descs[] = {
99 (struct usb_descriptor_header *)&interface_desc,
100 (struct usb_descriptor_header *)&fs_ep_in,
101 (struct usb_descriptor_header *)&hs_ep_out,
106 * static strings, in UTF-8
108 static const char fastboot_name[] = "Android Fastboot";
110 static struct usb_string fastboot_string_defs[] = {
111 [0].s = fastboot_name,
112 { } /* end of list */
115 static struct usb_gadget_strings stringtab_fastboot = {
116 .language = 0x0409, /* en-us */
117 .strings = fastboot_string_defs,
120 static struct usb_gadget_strings *fastboot_strings[] = {
125 static void rx_handler_command(struct usb_ep *ep, struct usb_request *req);
127 static void fastboot_complete(struct usb_ep *ep, struct usb_request *req)
129 int status = req->status;
132 printf("status: %d ep '%s' trans: %d\n", status, ep->name, req->actual);
135 static int fastboot_bind(struct usb_configuration *c, struct usb_function *f)
138 struct usb_gadget *gadget = c->cdev->gadget;
139 struct f_fastboot *f_fb = func_to_fastboot(f);
141 /* DYNAMIC interface numbers assignments */
142 id = usb_interface_id(c, f);
145 interface_desc.bInterfaceNumber = id;
147 id = usb_string_id(c->cdev);
150 fastboot_string_defs[0].id = id;
151 interface_desc.iInterface = id;
153 f_fb->in_ep = usb_ep_autoconfig(gadget, &fs_ep_in);
156 f_fb->in_ep->driver_data = c->cdev;
158 f_fb->out_ep = usb_ep_autoconfig(gadget, &fs_ep_out);
161 f_fb->out_ep->driver_data = c->cdev;
163 hs_ep_out.bEndpointAddress = fs_ep_out.bEndpointAddress;
168 static void fastboot_unbind(struct usb_configuration *c, struct usb_function *f)
170 memset(fastboot_func, 0, sizeof(*fastboot_func));
173 static void fastboot_disable(struct usb_function *f)
175 struct f_fastboot *f_fb = func_to_fastboot(f);
177 usb_ep_disable(f_fb->out_ep);
178 usb_ep_disable(f_fb->in_ep);
181 free(f_fb->out_req->buf);
182 usb_ep_free_request(f_fb->out_ep, f_fb->out_req);
183 f_fb->out_req = NULL;
186 free(f_fb->in_req->buf);
187 usb_ep_free_request(f_fb->in_ep, f_fb->in_req);
192 static struct usb_request *fastboot_start_ep(struct usb_ep *ep)
194 struct usb_request *req;
196 req = usb_ep_alloc_request(ep, 0);
200 req->length = EP_BUFFER_SIZE;
201 req->buf = memalign(CONFIG_SYS_CACHELINE_SIZE, EP_BUFFER_SIZE);
203 usb_ep_free_request(ep, req);
207 memset(req->buf, 0, req->length);
211 static int fastboot_set_alt(struct usb_function *f,
212 unsigned interface, unsigned alt)
215 struct usb_composite_dev *cdev = f->config->cdev;
216 struct usb_gadget *gadget = cdev->gadget;
217 struct f_fastboot *f_fb = func_to_fastboot(f);
219 debug("%s: func: %s intf: %d alt: %d\n",
220 __func__, f->name, interface, alt);
222 /* make sure we don't enable the ep twice */
223 if (gadget->speed == USB_SPEED_HIGH) {
224 ret = usb_ep_enable(f_fb->out_ep, &hs_ep_out);
225 is_high_speed = true;
227 ret = usb_ep_enable(f_fb->out_ep, &fs_ep_out);
228 is_high_speed = false;
231 puts("failed to enable out ep\n");
235 f_fb->out_req = fastboot_start_ep(f_fb->out_ep);
236 if (!f_fb->out_req) {
237 puts("failed to alloc out req\n");
241 f_fb->out_req->complete = rx_handler_command;
243 ret = usb_ep_enable(f_fb->in_ep, &fs_ep_in);
245 puts("failed to enable in ep\n");
249 f_fb->in_req = fastboot_start_ep(f_fb->in_ep);
251 puts("failed alloc req in\n");
255 f_fb->in_req->complete = fastboot_complete;
257 ret = usb_ep_queue(f_fb->out_ep, f_fb->out_req, 0);
267 static int fastboot_add(struct usb_configuration *c)
269 struct f_fastboot *f_fb = fastboot_func;
272 debug("%s: cdev: 0x%p\n", __func__, c->cdev);
275 f_fb = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*f_fb));
279 fastboot_func = f_fb;
280 memset(f_fb, 0, sizeof(*f_fb));
283 f_fb->usb_function.name = "f_fastboot";
284 f_fb->usb_function.hs_descriptors = fb_runtime_descs;
285 f_fb->usb_function.bind = fastboot_bind;
286 f_fb->usb_function.unbind = fastboot_unbind;
287 f_fb->usb_function.set_alt = fastboot_set_alt;
288 f_fb->usb_function.disable = fastboot_disable;
289 f_fb->usb_function.strings = fastboot_strings;
291 status = usb_add_function(c, &f_fb->usb_function);
294 fastboot_func = f_fb;
299 DECLARE_GADGET_BIND_CALLBACK(usb_dnl_fastboot, fastboot_add);
301 static int fastboot_tx_write(const char *buffer, unsigned int buffer_size)
303 struct usb_request *in_req = fastboot_func->in_req;
306 memcpy(in_req->buf, buffer, buffer_size);
307 in_req->length = buffer_size;
308 ret = usb_ep_queue(fastboot_func->in_ep, in_req, 0);
310 printf("Error %d on queue\n", ret);
314 static int fastboot_tx_write_str(const char *buffer)
316 return fastboot_tx_write(buffer, strlen(buffer));
319 static void compl_do_reset(struct usb_ep *ep, struct usb_request *req)
321 do_reset(NULL, 0, 0, NULL);
324 static void cb_reboot(struct usb_ep *ep, struct usb_request *req)
326 fastboot_func->in_req->complete = compl_do_reset;
327 fastboot_tx_write_str("OKAY");
330 static int strcmp_l1(const char *s1, const char *s2)
334 return strncmp(s1, s2, strlen(s1));
337 static void cb_getvar(struct usb_ep *ep, struct usb_request *req)
339 char *cmd = req->buf;
340 char response[RESPONSE_LEN];
344 strcpy(response, "OKAY");
345 chars_left = sizeof(response) - strlen(response) - 1;
349 error("missing variable\n");
350 fastboot_tx_write_str("FAILmissing var");
354 if (!strcmp_l1("version", cmd)) {
355 strncat(response, FASTBOOT_VERSION, chars_left);
356 } else if (!strcmp_l1("bootloader-version", cmd)) {
357 strncat(response, U_BOOT_VERSION, chars_left);
358 } else if (!strcmp_l1("downloadsize", cmd) ||
359 !strcmp_l1("max-download-size", cmd)) {
362 sprintf(str_num, "0x%08x", CONFIG_USB_FASTBOOT_BUF_SIZE);
363 strncat(response, str_num, chars_left);
364 } else if (!strcmp_l1("serialno", cmd)) {
365 s = getenv("serial#");
367 strncat(response, s, chars_left);
369 strcpy(response, "FAILValue not set");
371 error("unknown variable: %s\n", cmd);
372 strcpy(response, "FAILVariable not implemented");
374 fastboot_tx_write_str(response);
377 static unsigned int rx_bytes_expected(unsigned int maxpacket)
379 int rx_remain = download_size - download_bytes;
383 if (rx_remain > EP_BUFFER_SIZE)
384 return EP_BUFFER_SIZE;
385 if (rx_remain < maxpacket) {
386 rx_remain = maxpacket;
387 } else if (rx_remain % maxpacket != 0) {
388 rem = rx_remain % maxpacket;
389 rx_remain = rx_remain + (maxpacket - rem);
394 #define BYTES_PER_DOT 0x20000
395 static void rx_handler_dl_image(struct usb_ep *ep, struct usb_request *req)
397 char response[RESPONSE_LEN];
398 unsigned int transfer_size = download_size - download_bytes;
399 const unsigned char *buffer = req->buf;
400 unsigned int buffer_size = req->actual;
401 unsigned int pre_dot_num, now_dot_num;
404 if (req->status != 0) {
405 printf("Bad status: %d\n", req->status);
409 if (buffer_size < transfer_size)
410 transfer_size = buffer_size;
412 memcpy((void *)CONFIG_USB_FASTBOOT_BUF_ADDR + download_bytes,
413 buffer, transfer_size);
415 pre_dot_num = download_bytes / BYTES_PER_DOT;
416 download_bytes += transfer_size;
417 now_dot_num = download_bytes / BYTES_PER_DOT;
419 if (pre_dot_num != now_dot_num) {
421 if (!(now_dot_num % 74))
425 /* Check if transfer is done */
426 if (download_bytes >= download_size) {
428 * Reset global transfer variable, keep download_bytes because
429 * it will be used in the next possible flashing command
432 req->complete = rx_handler_command;
433 req->length = EP_BUFFER_SIZE;
435 sprintf(response, "OKAY");
436 fastboot_tx_write_str(response);
438 printf("\ndownloading of %d bytes finished\n", download_bytes);
440 max = is_high_speed ? hs_ep_out.wMaxPacketSize :
441 fs_ep_out.wMaxPacketSize;
442 req->length = rx_bytes_expected(max);
443 if (req->length < ep->maxpacket)
444 req->length = ep->maxpacket;
448 usb_ep_queue(ep, req, 0);
451 static void cb_download(struct usb_ep *ep, struct usb_request *req)
453 char *cmd = req->buf;
454 char response[RESPONSE_LEN];
458 download_size = simple_strtoul(cmd, NULL, 16);
461 printf("Starting download of %d bytes\n", download_size);
463 if (0 == download_size) {
464 sprintf(response, "FAILdata invalid size");
465 } else if (download_size > CONFIG_USB_FASTBOOT_BUF_SIZE) {
467 sprintf(response, "FAILdata too large");
469 sprintf(response, "DATA%08x", download_size);
470 req->complete = rx_handler_dl_image;
471 max = is_high_speed ? hs_ep_out.wMaxPacketSize :
472 fs_ep_out.wMaxPacketSize;
473 req->length = rx_bytes_expected(max);
474 if (req->length < ep->maxpacket)
475 req->length = ep->maxpacket;
477 fastboot_tx_write_str(response);
480 static void do_bootm_on_complete(struct usb_ep *ep, struct usb_request *req)
482 char boot_addr_start[12];
483 char *bootm_args[] = { "bootm", boot_addr_start, NULL };
485 puts("Booting kernel..\n");
487 sprintf(boot_addr_start, "0x%lx", load_addr);
488 do_bootm(NULL, 0, 2, bootm_args);
490 /* This only happens if image is somehow faulty so we start over */
491 do_reset(NULL, 0, 0, NULL);
494 static void cb_boot(struct usb_ep *ep, struct usb_request *req)
496 fastboot_func->in_req->complete = do_bootm_on_complete;
497 fastboot_tx_write_str("OKAY");
500 static void do_exit_on_complete(struct usb_ep *ep, struct usb_request *req)
502 g_dnl_trigger_detach();
505 static void cb_continue(struct usb_ep *ep, struct usb_request *req)
507 fastboot_func->in_req->complete = do_exit_on_complete;
508 fastboot_tx_write_str("OKAY");
511 #ifdef CONFIG_FASTBOOT_FLASH
512 static void cb_flash(struct usb_ep *ep, struct usb_request *req)
514 char *cmd = req->buf;
515 char response[RESPONSE_LEN];
519 error("missing partition name\n");
520 fastboot_tx_write_str("FAILmissing partition name");
524 strcpy(response, "FAILno flash device defined");
525 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
526 fb_mmc_flash_write(cmd, (void *)CONFIG_USB_FASTBOOT_BUF_ADDR,
527 download_bytes, response);
529 fastboot_tx_write_str(response);
533 static void cb_oem(struct usb_ep *ep, struct usb_request *req)
535 char *cmd = req->buf;
536 #ifdef CONFIG_FASTBOOT_FLASH
537 if (strncmp("format", cmd + 4, 6) == 0) {
539 sprintf(cmdbuf, "gpt write mmc %x $partitions",
540 CONFIG_FASTBOOT_FLASH_MMC_DEV);
541 if (run_command(cmdbuf, 0))
542 fastboot_tx_write_str("FAIL");
544 fastboot_tx_write_str("OKAY");
547 if (strncmp("unlock", cmd + 4, 8) == 0) {
548 fastboot_tx_write_str("FAILnot implemented");
551 fastboot_tx_write_str("FAILunknown oem command");
555 #ifdef CONFIG_FASTBOOT_FLASH
556 static void cb_erase(struct usb_ep *ep, struct usb_request *req)
558 char *cmd = req->buf;
559 char response[RESPONSE_LEN];
563 error("missing partition name");
564 fastboot_tx_write_str("FAILmissing partition name");
568 strcpy(response, "FAILno flash device defined");
570 #ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
571 fb_mmc_erase(cmd, response);
573 fastboot_tx_write_str(response);
577 struct cmd_dispatch_info {
579 void (*cb)(struct usb_ep *ep, struct usb_request *req);
582 static const struct cmd_dispatch_info cmd_dispatch_info[] = {
599 #ifdef CONFIG_FASTBOOT_FLASH
614 static void rx_handler_command(struct usb_ep *ep, struct usb_request *req)
616 char *cmdbuf = req->buf;
617 void (*func_cb)(struct usb_ep *ep, struct usb_request *req) = NULL;
620 for (i = 0; i < ARRAY_SIZE(cmd_dispatch_info); i++) {
621 if (!strcmp_l1(cmd_dispatch_info[i].cmd, cmdbuf)) {
622 func_cb = cmd_dispatch_info[i].cb;
628 error("unknown command: %s\n", cmdbuf);
629 fastboot_tx_write_str("FAILunknown command");
631 if (req->actual < req->length) {
632 u8 *buf = (u8 *)req->buf;
633 buf[req->actual] = 0;
636 error("buffer overflow\n");
637 fastboot_tx_write_str("FAILbuffer overflow");
641 if (req->status == 0) {
644 usb_ep_queue(ep, req, 0);