Merge branch '2020-05-08-assorted-fixes'
[oweals/u-boot.git] / drivers / usb / gadget / f_fastboot.c
index ca01a018b5d13578a3fa36d1681f6818a30bb2b8..fc27dbe8de4996e6488adf0b436cf2d036317cc1 100644 (file)
@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2008 - 2009
  * Windriver, <www.windriver.com>
@@ -7,24 +8,18 @@
  *
  * Copyright 2014 Linaro, Ltd.
  * Rob Herring <robh@kernel.org>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 #include <config.h>
 #include <common.h>
+#include <env.h>
 #include <errno.h>
+#include <fastboot.h>
 #include <malloc.h>
 #include <linux/usb/ch9.h>
 #include <linux/usb/gadget.h>
 #include <linux/usb/composite.h>
 #include <linux/compiler.h>
-#include <version.h>
 #include <g_dnl.h>
-#ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
-#include <fb_mmc.h>
-#endif
-
-#define FASTBOOT_VERSION               "0.4"
 
 #define FASTBOOT_INTERFACE_CLASS       0xff
 #define FASTBOOT_INTERFACE_SUB_CLASS   0x42
 #define RX_ENDPOINT_MAXIMUM_PACKET_SIZE_1_1  (0x0040)
 #define TX_ENDPOINT_MAXIMUM_PACKET_SIZE      (0x0040)
 
-/* The 64 defined bytes plus \0 */
-#define RESPONSE_LEN   (64 + 1)
-
 #define EP_BUFFER_SIZE                 4096
+/*
+ * EP_BUFFER_SIZE must always be an integral multiple of maxpacket size
+ * (64 or 512 or 1024), else we break on certain controllers like DWC3
+ * that expect bulk OUT requests to be divisible by maxpacket size.
+ */
 
 struct f_fastboot {
        struct usb_function usb_function;
@@ -53,17 +50,13 @@ static inline struct f_fastboot *func_to_fastboot(struct usb_function *f)
 }
 
 static struct f_fastboot *fastboot_func;
-static unsigned int download_size;
-static unsigned int download_bytes;
-static bool is_high_speed;
 
 static struct usb_endpoint_descriptor fs_ep_in = {
        .bLength            = USB_DT_ENDPOINT_SIZE,
        .bDescriptorType    = USB_DT_ENDPOINT,
        .bEndpointAddress   = USB_DIR_IN,
        .bmAttributes       = USB_ENDPOINT_XFER_BULK,
-       .wMaxPacketSize     = TX_ENDPOINT_MAXIMUM_PACKET_SIZE,
-       .bInterval          = 0x00,
+       .wMaxPacketSize     = cpu_to_le16(64),
 };
 
 static struct usb_endpoint_descriptor fs_ep_out = {
@@ -71,8 +64,15 @@ static struct usb_endpoint_descriptor fs_ep_out = {
        .bDescriptorType        = USB_DT_ENDPOINT,
        .bEndpointAddress       = USB_DIR_OUT,
        .bmAttributes           = USB_ENDPOINT_XFER_BULK,
-       .wMaxPacketSize         = RX_ENDPOINT_MAXIMUM_PACKET_SIZE_1_1,
-       .bInterval              = 0x00,
+       .wMaxPacketSize         = cpu_to_le16(64),
+};
+
+static struct usb_endpoint_descriptor hs_ep_in = {
+       .bLength                = USB_DT_ENDPOINT_SIZE,
+       .bDescriptorType        = USB_DT_ENDPOINT,
+       .bEndpointAddress       = USB_DIR_IN,
+       .bmAttributes           = USB_ENDPOINT_XFER_BULK,
+       .wMaxPacketSize         = cpu_to_le16(512),
 };
 
 static struct usb_endpoint_descriptor hs_ep_out = {
@@ -80,8 +80,7 @@ static struct usb_endpoint_descriptor hs_ep_out = {
        .bDescriptorType        = USB_DT_ENDPOINT,
        .bEndpointAddress       = USB_DIR_OUT,
        .bmAttributes           = USB_ENDPOINT_XFER_BULK,
-       .wMaxPacketSize         = RX_ENDPOINT_MAXIMUM_PACKET_SIZE_2_0,
-       .bInterval              = 0x00,
+       .wMaxPacketSize         = cpu_to_le16(512),
 };
 
 static struct usb_interface_descriptor interface_desc = {
@@ -95,13 +94,28 @@ static struct usb_interface_descriptor interface_desc = {
        .bInterfaceProtocol     = FASTBOOT_INTERFACE_PROTOCOL,
 };
 
-static struct usb_descriptor_header *fb_runtime_descs[] = {
+static struct usb_descriptor_header *fb_fs_function[] = {
        (struct usb_descriptor_header *)&interface_desc,
        (struct usb_descriptor_header *)&fs_ep_in,
+       (struct usb_descriptor_header *)&fs_ep_out,
+};
+
+static struct usb_descriptor_header *fb_hs_function[] = {
+       (struct usb_descriptor_header *)&interface_desc,
+       (struct usb_descriptor_header *)&hs_ep_in,
        (struct usb_descriptor_header *)&hs_ep_out,
        NULL,
 };
 
+static struct usb_endpoint_descriptor *
+fb_ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *fs,
+           struct usb_endpoint_descriptor *hs)
+{
+       if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
+               return hs;
+       return fs;
+}
+
 /*
  * static strings, in UTF-8
  */
@@ -123,7 +137,6 @@ static struct usb_gadget_strings *fastboot_strings[] = {
 };
 
 static void rx_handler_command(struct usb_ep *ep, struct usb_request *req);
-static int strcmp_l1(const char *s1, const char *s2);
 
 static void fastboot_complete(struct usb_ep *ep, struct usb_request *req)
 {
@@ -162,9 +175,17 @@ static int fastboot_bind(struct usb_configuration *c, struct usb_function *f)
                return -ENODEV;
        f_fb->out_ep->driver_data = c->cdev;
 
-       hs_ep_out.bEndpointAddress = fs_ep_out.bEndpointAddress;
+       f->descriptors = fb_fs_function;
 
-       s = getenv("serial#");
+       if (gadget_is_dualspeed(gadget)) {
+               /* Assume endpoint addresses are the same for both speeds */
+               hs_ep_in.bEndpointAddress = fs_ep_in.bEndpointAddress;
+               hs_ep_out.bEndpointAddress = fs_ep_out.bEndpointAddress;
+               /* copy HS descriptors */
+               f->hs_descriptors = fb_hs_function;
+       }
+
+       s = env_get("serial#");
        if (s)
                g_dnl_set_serialnumber((char *)s);
 
@@ -221,18 +242,13 @@ static int fastboot_set_alt(struct usb_function *f,
        struct usb_composite_dev *cdev = f->config->cdev;
        struct usb_gadget *gadget = cdev->gadget;
        struct f_fastboot *f_fb = func_to_fastboot(f);
+       const struct usb_endpoint_descriptor *d;
 
        debug("%s: func: %s intf: %d alt: %d\n",
              __func__, f->name, interface, alt);
 
-       /* make sure we don't enable the ep twice */
-       if (gadget->speed == USB_SPEED_HIGH) {
-               ret = usb_ep_enable(f_fb->out_ep, &hs_ep_out);
-               is_high_speed = true;
-       } else {
-               ret = usb_ep_enable(f_fb->out_ep, &fs_ep_out);
-               is_high_speed = false;
-       }
+       d = fb_ep_desc(gadget, &fs_ep_out, &hs_ep_out);
+       ret = usb_ep_enable(f_fb->out_ep, d);
        if (ret) {
                puts("failed to enable out ep\n");
                return ret;
@@ -246,7 +262,8 @@ static int fastboot_set_alt(struct usb_function *f,
        }
        f_fb->out_req->complete = rx_handler_command;
 
-       ret = usb_ep_enable(f_fb->in_ep, &fs_ep_in);
+       d = fb_ep_desc(gadget, &fs_ep_in, &hs_ep_in);
+       ret = usb_ep_enable(f_fb->in_ep, d);
        if (ret) {
                puts("failed to enable in ep\n");
                goto err;
@@ -287,7 +304,6 @@ static int fastboot_add(struct usb_configuration *c)
        }
 
        f_fb->usb_function.name = "f_fastboot";
-       f_fb->usb_function.hs_descriptors = fb_runtime_descs;
        f_fb->usb_function.bind = fastboot_bind;
        f_fb->usb_function.unbind = fastboot_unbind;
        f_fb->usb_function.set_alt = fastboot_set_alt;
@@ -330,97 +346,36 @@ static void compl_do_reset(struct usb_ep *ep, struct usb_request *req)
        do_reset(NULL, 0, 0, NULL);
 }
 
-int __weak fb_set_reboot_flag(void)
-{
-       return -ENOSYS;
-}
-
-static void cb_reboot(struct usb_ep *ep, struct usb_request *req)
-{
-       char *cmd = req->buf;
-       if (!strcmp_l1("reboot-bootloader", cmd)) {
-               if (fb_set_reboot_flag()) {
-                       fastboot_tx_write_str("FAILCannot set reboot flag");
-                       return;
-               }
-       }
-       fastboot_func->in_req->complete = compl_do_reset;
-       fastboot_tx_write_str("OKAY");
-}
-
-static int strcmp_l1(const char *s1, const char *s2)
+static unsigned int rx_bytes_expected(struct usb_ep *ep)
 {
-       if (!s1 || !s2)
-               return -1;
-       return strncmp(s1, s2, strlen(s1));
-}
-
-static void cb_getvar(struct usb_ep *ep, struct usb_request *req)
-{
-       char *cmd = req->buf;
-       char response[RESPONSE_LEN];
-       const char *s;
-       size_t chars_left;
-
-       strcpy(response, "OKAY");
-       chars_left = sizeof(response) - strlen(response) - 1;
-
-       strsep(&cmd, ":");
-       if (!cmd) {
-               error("missing variable\n");
-               fastboot_tx_write_str("FAILmissing var");
-               return;
-       }
-
-       if (!strcmp_l1("version", cmd)) {
-               strncat(response, FASTBOOT_VERSION, chars_left);
-       } else if (!strcmp_l1("bootloader-version", cmd)) {
-               strncat(response, U_BOOT_VERSION, chars_left);
-       } else if (!strcmp_l1("downloadsize", cmd) ||
-               !strcmp_l1("max-download-size", cmd)) {
-               char str_num[12];
-
-               sprintf(str_num, "0x%08x", CONFIG_FASTBOOT_BUF_SIZE);
-               strncat(response, str_num, chars_left);
-       } else if (!strcmp_l1("serialno", cmd)) {
-               s = getenv("serial#");
-               if (s)
-                       strncat(response, s, chars_left);
-               else
-                       strcpy(response, "FAILValue not set");
-       } else {
-               error("unknown variable: %s\n", cmd);
-               strcpy(response, "FAILVariable not implemented");
-       }
-       fastboot_tx_write_str(response);
-}
+       int rx_remain = fastboot_data_remaining();
+       unsigned int rem;
+       unsigned int maxpacket = ep->maxpacket;
 
-static unsigned int rx_bytes_expected(unsigned int maxpacket)
-{
-       int rx_remain = download_size - download_bytes;
-       int rem = 0;
-       if (rx_remain < 0)
+       if (rx_remain <= 0)
                return 0;
-       if (rx_remain > EP_BUFFER_SIZE)
+       else if (rx_remain > EP_BUFFER_SIZE)
                return EP_BUFFER_SIZE;
-       if (rx_remain < maxpacket) {
-               rx_remain = maxpacket;
-       } else if (rx_remain % maxpacket != 0) {
-               rem = rx_remain % maxpacket;
+
+       /*
+        * Some controllers e.g. DWC3 don't like OUT transfers to be
+        * not ending in maxpacket boundary. So just make them happy by
+        * always requesting for integral multiple of maxpackets.
+        * This shouldn't bother controllers that don't care about it.
+        */
+       rem = rx_remain % maxpacket;
+       if (rem > 0)
                rx_remain = rx_remain + (maxpacket - rem);
-       }
+
        return rx_remain;
 }
 
-#define BYTES_PER_DOT  0x20000
 static void rx_handler_dl_image(struct usb_ep *ep, struct usb_request *req)
 {
-       char response[RESPONSE_LEN];
-       unsigned int transfer_size = download_size - download_bytes;
+       char response[FASTBOOT_RESPONSE_LEN] = {0};
+       unsigned int transfer_size = fastboot_data_remaining();
        const unsigned char *buffer = req->buf;
        unsigned int buffer_size = req->actual;
-       unsigned int pre_dot_num, now_dot_num;
-       unsigned int max;
 
        if (req->status != 0) {
                printf("Bad status: %d\n", req->status);
@@ -430,235 +385,76 @@ static void rx_handler_dl_image(struct usb_ep *ep, struct usb_request *req)
        if (buffer_size < transfer_size)
                transfer_size = buffer_size;
 
-       memcpy((void *)CONFIG_FASTBOOT_BUF_ADDR + download_bytes,
-              buffer, transfer_size);
-
-       pre_dot_num = download_bytes / BYTES_PER_DOT;
-       download_bytes += transfer_size;
-       now_dot_num = download_bytes / BYTES_PER_DOT;
-
-       if (pre_dot_num != now_dot_num) {
-               putc('.');
-               if (!(now_dot_num % 74))
-                       putc('\n');
-       }
+       fastboot_data_download(buffer, transfer_size, response);
+       if (response[0]) {
+               fastboot_tx_write_str(response);
+       } else if (!fastboot_data_remaining()) {
+               fastboot_data_complete(response);
 
-       /* Check if transfer is done */
-       if (download_bytes >= download_size) {
                /*
-                * Reset global transfer variable, keep download_bytes because
-                * it will be used in the next possible flashing command
+                * Reset global transfer variable
                 */
-               download_size = 0;
                req->complete = rx_handler_command;
                req->length = EP_BUFFER_SIZE;
 
-               sprintf(response, "OKAY");
                fastboot_tx_write_str(response);
-
-               printf("\ndownloading of %d bytes finished\n", download_bytes);
        } else {
-               max = is_high_speed ? hs_ep_out.wMaxPacketSize :
-                               fs_ep_out.wMaxPacketSize;
-               req->length = rx_bytes_expected(max);
-               if (req->length < ep->maxpacket)
-                       req->length = ep->maxpacket;
+               req->length = rx_bytes_expected(ep);
        }
 
        req->actual = 0;
        usb_ep_queue(ep, req, 0);
 }
 
-static void cb_download(struct usb_ep *ep, struct usb_request *req)
-{
-       char *cmd = req->buf;
-       char response[RESPONSE_LEN];
-       unsigned int max;
-
-       strsep(&cmd, ":");
-       download_size = simple_strtoul(cmd, NULL, 16);
-       download_bytes = 0;
-
-       printf("Starting download of %d bytes\n", download_size);
-
-       if (0 == download_size) {
-               sprintf(response, "FAILdata invalid size");
-       } else if (download_size > CONFIG_FASTBOOT_BUF_SIZE) {
-               download_size = 0;
-               sprintf(response, "FAILdata too large");
-       } else {
-               sprintf(response, "DATA%08x", download_size);
-               req->complete = rx_handler_dl_image;
-               max = is_high_speed ? hs_ep_out.wMaxPacketSize :
-                       fs_ep_out.wMaxPacketSize;
-               req->length = rx_bytes_expected(max);
-               if (req->length < ep->maxpacket)
-                       req->length = ep->maxpacket;
-       }
-       fastboot_tx_write_str(response);
-}
-
-static void do_bootm_on_complete(struct usb_ep *ep, struct usb_request *req)
-{
-       char boot_addr_start[12];
-       char *bootm_args[] = { "bootm", boot_addr_start, NULL };
-
-       puts("Booting kernel..\n");
-
-       sprintf(boot_addr_start, "0x%lx", load_addr);
-       do_bootm(NULL, 0, 2, bootm_args);
-
-       /* This only happens if image is somehow faulty so we start over */
-       do_reset(NULL, 0, 0, NULL);
-}
-
-static void cb_boot(struct usb_ep *ep, struct usb_request *req)
-{
-       fastboot_func->in_req->complete = do_bootm_on_complete;
-       fastboot_tx_write_str("OKAY");
-}
-
 static void do_exit_on_complete(struct usb_ep *ep, struct usb_request *req)
 {
        g_dnl_trigger_detach();
 }
 
-static void cb_continue(struct usb_ep *ep, struct usb_request *req)
+static void do_bootm_on_complete(struct usb_ep *ep, struct usb_request *req)
 {
-       fastboot_func->in_req->complete = do_exit_on_complete;
-       fastboot_tx_write_str("OKAY");
+       fastboot_boot();
+       do_exit_on_complete(ep, req);
 }
 
-#ifdef CONFIG_FASTBOOT_FLASH
-static void cb_flash(struct usb_ep *ep, struct usb_request *req)
+static void rx_handler_command(struct usb_ep *ep, struct usb_request *req)
 {
-       char *cmd = req->buf;
-       char response[RESPONSE_LEN];
+       char *cmdbuf = req->buf;
+       char response[FASTBOOT_RESPONSE_LEN] = {0};
+       int cmd = -1;
 
-       strsep(&cmd, ":");
-       if (!cmd) {
-               error("missing partition name\n");
-               fastboot_tx_write_str("FAILmissing partition name");
+       if (req->status != 0 || req->length == 0)
                return;
-       }
-
-       strcpy(response, "FAILno flash device defined");
-#ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
-       fb_mmc_flash_write(cmd, (void *)CONFIG_FASTBOOT_BUF_ADDR,
-                          download_bytes, response);
-#endif
-       fastboot_tx_write_str(response);
-}
-#endif
 
-static void cb_oem(struct usb_ep *ep, struct usb_request *req)
-{
-       char *cmd = req->buf;
-#ifdef CONFIG_FASTBOOT_FLASH
-       if (strncmp("format", cmd + 4, 6) == 0) {
-               char cmdbuf[32];
-                sprintf(cmdbuf, "gpt write mmc %x $partitions",
-                       CONFIG_FASTBOOT_FLASH_MMC_DEV);
-                if (run_command(cmdbuf, 0))
-                       fastboot_tx_write_str("FAIL");
-                else
-                       fastboot_tx_write_str("OKAY");
-       } else
-#endif
-       if (strncmp("unlock", cmd + 4, 8) == 0) {
-               fastboot_tx_write_str("FAILnot implemented");
-       }
-       else {
-               fastboot_tx_write_str("FAILunknown oem command");
+       if (req->actual < req->length) {
+               cmdbuf[req->actual] = '\0';
+               cmd = fastboot_handle_command(cmdbuf, response);
+       } else {
+               pr_err("buffer overflow");
+               fastboot_fail("buffer overflow", response);
        }
-}
-
-#ifdef CONFIG_FASTBOOT_FLASH
-static void cb_erase(struct usb_ep *ep, struct usb_request *req)
-{
-       char *cmd = req->buf;
-       char response[RESPONSE_LEN];
 
-       strsep(&cmd, ":");
-       if (!cmd) {
-               error("missing partition name");
-               fastboot_tx_write_str("FAILmissing partition name");
-               return;
+       if (!strncmp("DATA", response, 4)) {
+               req->complete = rx_handler_dl_image;
+               req->length = rx_bytes_expected(ep);
        }
 
-       strcpy(response, "FAILno flash device defined");
-
-#ifdef CONFIG_FASTBOOT_FLASH_MMC_DEV
-       fb_mmc_erase(cmd, response);
-#endif
        fastboot_tx_write_str(response);
-}
-#endif
-
-struct cmd_dispatch_info {
-       char *cmd;
-       void (*cb)(struct usb_ep *ep, struct usb_request *req);
-};
 
-static const struct cmd_dispatch_info cmd_dispatch_info[] = {
-       {
-               .cmd = "reboot",
-               .cb = cb_reboot,
-       }, {
-               .cmd = "getvar:",
-               .cb = cb_getvar,
-       }, {
-               .cmd = "download:",
-               .cb = cb_download,
-       }, {
-               .cmd = "boot",
-               .cb = cb_boot,
-       }, {
-               .cmd = "continue",
-               .cb = cb_continue,
-       },
-#ifdef CONFIG_FASTBOOT_FLASH
-       {
-               .cmd = "flash",
-               .cb = cb_flash,
-       }, {
-               .cmd = "erase",
-               .cb = cb_erase,
-       },
-#endif
-       {
-               .cmd = "oem",
-               .cb = cb_oem,
-       },
-};
-
-static void rx_handler_command(struct usb_ep *ep, struct usb_request *req)
-{
-       char *cmdbuf = req->buf;
-       void (*func_cb)(struct usb_ep *ep, struct usb_request *req) = NULL;
-       int i;
-
-       if (req->status != 0 || req->length == 0)
-               return;
+       if (!strncmp("OKAY", response, 4)) {
+               switch (cmd) {
+               case FASTBOOT_COMMAND_BOOT:
+                       fastboot_func->in_req->complete = do_bootm_on_complete;
+                       break;
 
-       for (i = 0; i < ARRAY_SIZE(cmd_dispatch_info); i++) {
-               if (!strcmp_l1(cmd_dispatch_info[i].cmd, cmdbuf)) {
-                       func_cb = cmd_dispatch_info[i].cb;
+               case FASTBOOT_COMMAND_CONTINUE:
+                       fastboot_func->in_req->complete = do_exit_on_complete;
                        break;
-               }
-       }
 
-       if (!func_cb) {
-               error("unknown command: %s\n", cmdbuf);
-               fastboot_tx_write_str("FAILunknown command");
-       } else {
-               if (req->actual < req->length) {
-                       u8 *buf = (u8 *)req->buf;
-                       buf[req->actual] = 0;
-                       func_cb(ep, req);
-               } else {
-                       error("buffer overflow\n");
-                       fastboot_tx_write_str("FAILbuffer overflow");
+               case FASTBOOT_COMMAND_REBOOT:
+               case FASTBOOT_COMMAND_REBOOT_BOOTLOADER:
+                       fastboot_func->in_req->complete = compl_do_reset;
+                       break;
                }
        }