]> git.kernelconcepts.de Git - karo-tx-uboot.git/commitdiff
usb:g_dnl:f_thor: USB download function to support TIZEN's THOR protocol
authorLukasz Majewski <l.majewski@samsung.com>
Tue, 8 Oct 2013 12:30:42 +0000 (14:30 +0200)
committerMarek Vasut <marex@denx.de>
Sun, 20 Oct 2013 21:42:41 +0000 (23:42 +0200)
Implementation of USB download function which supports THOR protocol.

Signed-off-by: Lukasz Majewski <l.majewski@samsung.com>
Cc: Marek Vasut <marex@denx.de>
drivers/usb/gadget/Makefile
drivers/usb/gadget/f_thor.c [new file with mode: 0644]
drivers/usb/gadget/f_thor.h [new file with mode: 0644]
include/thor.h [new file with mode: 0644]

index 1590c4a7508f0976adac0dc5ece2f2a1ca616fb0..afaf5ce872f1c4bc73fda97d619e65cc0293fc43 100644 (file)
@@ -21,6 +21,7 @@ ifdef CONFIG_USB_GADGET
 COBJS-$(CONFIG_USB_GADGET_ATMEL_USBA) += atmel_usba_udc.o
 COBJS-$(CONFIG_USB_GADGET_S3C_UDC_OTG) += s3c_udc_otg.o
 COBJS-$(CONFIG_USB_GADGET_FOTG210) += fotg210.o
+COBJS-$(CONFIG_THOR_FUNCTION) += f_thor.o
 COBJS-$(CONFIG_USBDOWNLOAD_GADGET) += g_dnl.o
 COBJS-$(CONFIG_DFU_FUNCTION) += f_dfu.o
 COBJS-$(CONFIG_USB_GADGET_MASS_STORAGE) += f_mass_storage.o
diff --git a/drivers/usb/gadget/f_thor.c b/drivers/usb/gadget/f_thor.c
new file mode 100644 (file)
index 0000000..c4c9909
--- /dev/null
@@ -0,0 +1,1003 @@
+/*
+ * f_thor.c -- USB TIZEN THOR Downloader gadget function
+ *
+ * Copyright (C) 2013 Samsung Electronics
+ * Lukasz Majewski <l.majewski@samsung.com>
+ *
+ * Based on code from:
+ * git://review.tizen.org/kernel/u-boot
+ *
+ * Developed by:
+ * Copyright (C) 2009 Samsung Electronics
+ * Minkyu Kang <mk7.kang@samsung.com>
+ * Sanghee Kim <sh0130.kim@samsung.com>
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#include <errno.h>
+#include <common.h>
+#include <malloc.h>
+#include <version.h>
+#include <linux/usb/ch9.h>
+#include <linux/usb/gadget.h>
+#include <linux/usb/composite.h>
+#include <linux/usb/cdc.h>
+#include <g_dnl.h>
+#include <dfu.h>
+
+#include "f_thor.h"
+
+static void thor_tx_data(unsigned char *data, int len);
+static void thor_set_dma(void *addr, int len);
+static int thor_rx_data(void);
+
+static struct f_thor *thor_func;
+static inline struct f_thor *func_to_thor(struct usb_function *f)
+{
+       return container_of(f, struct f_thor, usb_function);
+}
+
+DEFINE_CACHE_ALIGN_BUFFER(unsigned char, thor_tx_data_buf,
+                         sizeof(struct rsp_box));
+DEFINE_CACHE_ALIGN_BUFFER(unsigned char, thor_rx_data_buf,
+                         sizeof(struct rqt_box));
+
+/* ********************************************************** */
+/*         THOR protocol - transmission handling             */
+/* ********************************************************** */
+DEFINE_CACHE_ALIGN_BUFFER(char, f_name, F_NAME_BUF_SIZE);
+static unsigned long long int thor_file_size;
+static int alt_setting_num;
+
+static void send_rsp(const struct rsp_box *rsp)
+{
+       memcpy(thor_tx_data_buf, rsp, sizeof(struct rsp_box));
+       thor_tx_data(thor_tx_data_buf, sizeof(struct rsp_box));
+
+       debug("-RSP: %d, %d\n", rsp->rsp, rsp->rsp_data);
+}
+
+static void send_data_rsp(s32 ack, s32 count)
+{
+       ALLOC_CACHE_ALIGN_BUFFER(struct data_rsp_box, rsp,
+                                sizeof(struct data_rsp_box));
+
+       rsp->ack = ack;
+       rsp->count = count;
+
+       memcpy(thor_tx_data_buf, rsp, sizeof(struct data_rsp_box));
+       thor_tx_data(thor_tx_data_buf, sizeof(struct data_rsp_box));
+
+       debug("-DATA RSP: %d, %d\n", ack, count);
+}
+
+static int process_rqt_info(const struct rqt_box *rqt)
+{
+       ALLOC_CACHE_ALIGN_BUFFER(struct rsp_box, rsp, sizeof(struct rsp_box));
+       memset(rsp, 0, sizeof(struct rsp_box));
+
+       rsp->rsp = rqt->rqt;
+       rsp->rsp_data = rqt->rqt_data;
+
+       switch (rqt->rqt_data) {
+       case RQT_INFO_VER_PROTOCOL:
+               rsp->int_data[0] = VER_PROTOCOL_MAJOR;
+               rsp->int_data[1] = VER_PROTOCOL_MINOR;
+               break;
+       case RQT_INIT_VER_HW:
+               snprintf(rsp->str_data[0], sizeof(rsp->str_data[0]),
+                        "%x", checkboard());
+               break;
+       case RQT_INIT_VER_BOOT:
+               sprintf(rsp->str_data[0], "%s", U_BOOT_VERSION);
+               break;
+       case RQT_INIT_VER_KERNEL:
+               sprintf(rsp->str_data[0], "%s", "k unknown");
+               break;
+       case RQT_INIT_VER_PLATFORM:
+               sprintf(rsp->str_data[0], "%s", "p unknown");
+               break;
+       case RQT_INIT_VER_CSC:
+               sprintf(rsp->str_data[0], "%s", "c unknown");
+               break;
+       default:
+               return -EINVAL;
+       }
+
+       send_rsp(rsp);
+       return true;
+}
+
+static int process_rqt_cmd(const struct rqt_box *rqt)
+{
+       ALLOC_CACHE_ALIGN_BUFFER(struct rsp_box, rsp, sizeof(struct rsp_box));
+       memset(rsp, 0, sizeof(struct rsp_box));
+
+       rsp->rsp = rqt->rqt;
+       rsp->rsp_data = rqt->rqt_data;
+
+       switch (rqt->rqt_data) {
+       case RQT_CMD_REBOOT:
+               debug("TARGET RESET\n");
+               send_rsp(rsp);
+               g_dnl_unregister();
+               dfu_free_entities();
+               run_command("reset", 0);
+               break;
+       case RQT_CMD_POWEROFF:
+       case RQT_CMD_EFSCLEAR:
+               send_rsp(rsp);
+       default:
+               printf("Command not supported -> cmd: %d\n", rqt->rqt_data);
+               return -EINVAL;
+       }
+
+       return true;
+}
+
+static long long int download_head(unsigned long long total,
+                                  unsigned int packet_size,
+                                  long long int *left,
+                                  int *cnt)
+{
+       long long int rcv_cnt = 0, left_to_rcv, ret_rcv;
+       void *transfer_buffer = dfu_get_buf();
+       void *buf = transfer_buffer;
+       int usb_pkt_cnt = 0, ret;
+
+       /*
+        * Files smaller than THOR_STORE_UNIT_SIZE (now 32 MiB) are stored on
+        * the medium.
+        * The packet response is sent on the purpose after successful data
+        * chunk write. There is a room for improvement when asynchronous write
+        * is performed.
+        */
+       while (total - rcv_cnt >= packet_size) {
+               thor_set_dma(buf, packet_size);
+               buf += packet_size;
+               ret_rcv = thor_rx_data();
+               if (ret_rcv < 0)
+                       return ret_rcv;
+               rcv_cnt += ret_rcv;
+               debug("%d: RCV data count: %llu cnt: %d\n", usb_pkt_cnt,
+                     rcv_cnt, *cnt);
+
+               if ((rcv_cnt % THOR_STORE_UNIT_SIZE) == 0) {
+                       ret = dfu_write(dfu_get_entity(alt_setting_num),
+                                       transfer_buffer, THOR_STORE_UNIT_SIZE,
+                                       (*cnt)++);
+                       if (ret) {
+                               error("DFU write failed [%d] cnt: %d",
+                                     ret, *cnt);
+                               return ret;
+                       }
+                       buf = transfer_buffer;
+               }
+               send_data_rsp(0, ++usb_pkt_cnt);
+       }
+
+       /* Calculate the amount of data to arrive from PC (in bytes) */
+       left_to_rcv = total - rcv_cnt;
+
+       /*
+        * Calculate number of data already received. but not yet stored
+        * on the medium (they are smaller than THOR_STORE_UNIT_SIZE)
+        */
+       *left = left_to_rcv + buf - transfer_buffer;
+       debug("%s: left: %llu left_to_rcv: %llu buf: 0x%p\n", __func__,
+             *left, left_to_rcv, buf);
+
+       if (left_to_rcv) {
+               thor_set_dma(buf, packet_size);
+               ret_rcv = thor_rx_data();
+               if (ret_rcv < 0)
+                       return ret_rcv;
+               rcv_cnt += ret_rcv;
+               send_data_rsp(0, ++usb_pkt_cnt);
+       }
+
+       debug("%s: %llu total: %llu cnt: %d\n", __func__, rcv_cnt, total, *cnt);
+
+       return rcv_cnt;
+}
+
+static int download_tail(long long int left, int cnt)
+{
+       void *transfer_buffer = dfu_get_buf();
+       int ret;
+
+       debug("%s: left: %llu cnt: %d\n", __func__, left, cnt);
+
+       if (left) {
+               ret = dfu_write(dfu_get_entity(alt_setting_num),
+                               transfer_buffer, left, cnt++);
+               if (ret) {
+                       error("DFU write failed [%d]: left: %llu", ret, left);
+                       return ret;
+               }
+       }
+
+       /*
+        * To store last "packet" DFU storage backend requires dfu_write with
+        * size parameter equal to 0
+        *
+        * This also frees memory malloc'ed by dfu_get_buf(), so no explicit
+        * need fo call dfu_free_buf() is needed.
+        */
+       ret = dfu_write(dfu_get_entity(alt_setting_num),
+                       transfer_buffer, 0, cnt);
+       if (ret)
+               error("DFU write failed [%d] cnt: %d", ret, cnt);
+
+       return ret;
+}
+
+static long long int process_rqt_download(const struct rqt_box *rqt)
+{
+       ALLOC_CACHE_ALIGN_BUFFER(struct rsp_box, rsp, sizeof(struct rsp_box));
+       static long long int left, ret_head;
+       int file_type, ret = 0;
+       static int cnt;
+
+       memset(rsp, 0, sizeof(struct rsp_box));
+       rsp->rsp = rqt->rqt;
+       rsp->rsp_data = rqt->rqt_data;
+
+       switch (rqt->rqt_data) {
+       case RQT_DL_INIT:
+               thor_file_size = rqt->int_data[0];
+               debug("INIT: total %d bytes\n", rqt->int_data[0]);
+               break;
+       case RQT_DL_FILE_INFO:
+               file_type = rqt->int_data[0];
+               if (file_type == FILE_TYPE_PIT) {
+                       puts("PIT table file - not supported\n");
+                       rsp->ack = -ENOTSUPP;
+                       ret = rsp->ack;
+                       break;
+               }
+
+               thor_file_size = rqt->int_data[1];
+               memcpy(f_name, rqt->str_data[0], F_NAME_BUF_SIZE);
+
+               debug("INFO: name(%s, %d), size(%llu), type(%d)\n",
+                     f_name, 0, thor_file_size, file_type);
+
+               rsp->int_data[0] = THOR_PACKET_SIZE;
+
+               alt_setting_num = dfu_get_alt(f_name);
+               if (alt_setting_num < 0) {
+                       error("Alt setting [%d] to write not found!",
+                             alt_setting_num);
+                       rsp->ack = -ENODEV;
+                       ret = rsp->ack;
+               }
+               break;
+       case RQT_DL_FILE_START:
+               send_rsp(rsp);
+               ret_head = download_head(thor_file_size, THOR_PACKET_SIZE,
+                                        &left, &cnt);
+               if (ret_head < 0) {
+                       left = 0;
+                       cnt = 0;
+               }
+               return ret_head;
+       case RQT_DL_FILE_END:
+               debug("DL FILE_END\n");
+               rsp->ack = download_tail(left, cnt);
+               ret = rsp->ack;
+               left = 0;
+               cnt = 0;
+               break;
+       case RQT_DL_EXIT:
+               debug("DL EXIT\n");
+               break;
+       default:
+               error("Operation not supported: %d", rqt->rqt_data);
+               ret = -ENOTSUPP;
+       }
+
+       send_rsp(rsp);
+       return ret;
+}
+
+static int process_data(void)
+{
+       ALLOC_CACHE_ALIGN_BUFFER(struct rqt_box, rqt, sizeof(struct rqt_box));
+       int ret = -EINVAL;
+
+       memset(rqt, 0, sizeof(rqt));
+       memcpy(rqt, thor_rx_data_buf, sizeof(struct rqt_box));
+
+       debug("+RQT: %d, %d\n", rqt->rqt, rqt->rqt_data);
+
+       switch (rqt->rqt) {
+       case RQT_INFO:
+               ret = process_rqt_info(rqt);
+               break;
+       case RQT_CMD:
+               ret = process_rqt_cmd(rqt);
+               break;
+       case RQT_DL:
+               ret = (int) process_rqt_download(rqt);
+               break;
+       case RQT_UL:
+               puts("RQT: UPLOAD not supported!\n");
+               break;
+       default:
+               error("unknown request (%d)", rqt->rqt);
+       }
+
+       return ret;
+}
+
+/* ********************************************************** */
+/*         THOR USB Function                                 */
+/* ********************************************************** */
+
+static inline struct usb_endpoint_descriptor *
+ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *hs,
+       struct usb_endpoint_descriptor *fs)
+{
+       if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
+               return hs;
+       return fs;
+}
+
+static struct usb_interface_descriptor thor_downloader_intf_data = {
+       .bLength =              sizeof(thor_downloader_intf_data),
+       .bDescriptorType =      USB_DT_INTERFACE,
+
+       .bNumEndpoints =        2,
+       .bInterfaceClass =      USB_CLASS_CDC_DATA,
+};
+
+static struct usb_endpoint_descriptor fs_in_desc = {
+       .bLength =              USB_DT_ENDPOINT_SIZE,
+       .bDescriptorType =      USB_DT_ENDPOINT,
+
+       .bEndpointAddress =     USB_DIR_IN,
+       .bmAttributes = USB_ENDPOINT_XFER_BULK,
+};
+
+static struct usb_endpoint_descriptor fs_out_desc = {
+       .bLength =              USB_DT_ENDPOINT_SIZE,
+       .bDescriptorType =      USB_DT_ENDPOINT,
+
+       .bEndpointAddress =     USB_DIR_OUT,
+       .bmAttributes = USB_ENDPOINT_XFER_BULK,
+};
+
+/* CDC configuration */
+static struct usb_interface_descriptor thor_downloader_intf_int = {
+       .bLength =              sizeof(thor_downloader_intf_int),
+       .bDescriptorType =      USB_DT_INTERFACE,
+
+       .bNumEndpoints =        1,
+       .bInterfaceClass =      USB_CLASS_COMM,
+        /* 0x02 Abstract Line Control Model */
+       .bInterfaceSubClass =   USB_CDC_SUBCLASS_ACM,
+       /* 0x01 Common AT commands */
+       .bInterfaceProtocol =   USB_CDC_ACM_PROTO_AT_V25TER,
+};
+
+static struct usb_cdc_header_desc thor_downloader_cdc_header = {
+       .bLength         =    sizeof(thor_downloader_cdc_header),
+       .bDescriptorType =    0x24, /* CS_INTERFACE */
+       .bDescriptorSubType = 0x00,
+       .bcdCDC =             0x0110,
+};
+
+static struct usb_cdc_call_mgmt_descriptor thor_downloader_cdc_call = {
+       .bLength         =    sizeof(thor_downloader_cdc_call),
+       .bDescriptorType =    0x24, /* CS_INTERFACE */
+       .bDescriptorSubType = 0x01,
+       .bmCapabilities =     0x00,
+       .bDataInterface =     0x01,
+};
+
+static struct usb_cdc_acm_descriptor thor_downloader_cdc_abstract = {
+       .bLength         =    sizeof(thor_downloader_cdc_abstract),
+       .bDescriptorType =    0x24, /* CS_INTERFACE */
+       .bDescriptorSubType = 0x02,
+       .bmCapabilities =     0x00,
+};
+
+static struct usb_cdc_union_desc thor_downloader_cdc_union = {
+       .bLength         =     sizeof(thor_downloader_cdc_union),
+       .bDescriptorType =     0x24, /* CS_INTERFACE */
+       .bDescriptorSubType =  USB_CDC_UNION_TYPE,
+};
+
+static struct usb_endpoint_descriptor fs_int_desc = {
+       .bLength = USB_DT_ENDPOINT_SIZE,
+       .bDescriptorType = USB_DT_ENDPOINT,
+
+       .bEndpointAddress = 3 | USB_DIR_IN,
+       .bmAttributes = USB_ENDPOINT_XFER_INT,
+       .wMaxPacketSize = __constant_cpu_to_le16(16),
+
+       .bInterval = 0x9,
+};
+
+static struct usb_interface_assoc_descriptor
+thor_iad_descriptor = {
+       .bLength =              sizeof(thor_iad_descriptor),
+       .bDescriptorType =      USB_DT_INTERFACE_ASSOCIATION,
+
+       .bFirstInterface =      0,
+       .bInterfaceCount =      2,      /* control + data */
+       .bFunctionClass =       USB_CLASS_COMM,
+       .bFunctionSubClass =    USB_CDC_SUBCLASS_ACM,
+       .bFunctionProtocol =    USB_CDC_PROTO_NONE,
+};
+
+static struct usb_endpoint_descriptor hs_in_desc = {
+       .bLength =              USB_DT_ENDPOINT_SIZE,
+       .bDescriptorType =      USB_DT_ENDPOINT,
+
+       .bmAttributes = USB_ENDPOINT_XFER_BULK,
+       .wMaxPacketSize =       __constant_cpu_to_le16(512),
+};
+
+static struct usb_endpoint_descriptor hs_out_desc = {
+       .bLength =              USB_DT_ENDPOINT_SIZE,
+       .bDescriptorType =      USB_DT_ENDPOINT,
+
+       .bmAttributes = USB_ENDPOINT_XFER_BULK,
+       .wMaxPacketSize =       __constant_cpu_to_le16(512),
+};
+
+static struct usb_endpoint_descriptor hs_int_desc = {
+       .bLength = USB_DT_ENDPOINT_SIZE,
+       .bDescriptorType = USB_DT_ENDPOINT,
+
+       .bmAttributes = USB_ENDPOINT_XFER_INT,
+       .wMaxPacketSize = __constant_cpu_to_le16(16),
+
+       .bInterval = 0x9,
+};
+
+static struct usb_qualifier_descriptor dev_qualifier = {
+       .bLength =              sizeof(dev_qualifier),
+       .bDescriptorType =      USB_DT_DEVICE_QUALIFIER,
+
+       .bcdUSB =               __constant_cpu_to_le16(0x0200),
+       .bDeviceClass = USB_CLASS_VENDOR_SPEC,
+
+       .bNumConfigurations =   2,
+};
+
+/*
+ * This attribute vendor descriptor is necessary for correct operation with
+ * Windows version of THOR download program
+ *
+ * It prevents windows driver from sending zero lenght packet (ZLP) after
+ * each THOR_PACKET_SIZE. This assures consistent behaviour with libusb
+ */
+static struct usb_cdc_attribute_vendor_descriptor thor_downloader_cdc_av = {
+       .bLength =              sizeof(thor_downloader_cdc_av),
+       .bDescriptorType =      0x24,
+       .bDescriptorSubType =   0x80,
+       .DAUType =              0x0002,
+       .DAULength =            0x0001,
+       .DAUValue =             0x00,
+};
+
+static const struct usb_descriptor_header *hs_thor_downloader_function[] = {
+       (struct usb_descriptor_header *)&thor_iad_descriptor,
+
+       (struct usb_descriptor_header *)&thor_downloader_intf_int,
+       (struct usb_descriptor_header *)&thor_downloader_cdc_header,
+       (struct usb_descriptor_header *)&thor_downloader_cdc_call,
+       (struct usb_descriptor_header *)&thor_downloader_cdc_abstract,
+       (struct usb_descriptor_header *)&thor_downloader_cdc_union,
+       (struct usb_descriptor_header *)&hs_int_desc,
+
+       (struct usb_descriptor_header *)&thor_downloader_intf_data,
+       (struct usb_descriptor_header *)&thor_downloader_cdc_av,
+       (struct usb_descriptor_header *)&hs_in_desc,
+       (struct usb_descriptor_header *)&hs_out_desc,
+       NULL,
+};
+
+/*-------------------------------------------------------------------------*/
+static struct usb_request *alloc_ep_req(struct usb_ep *ep, unsigned length)
+{
+       struct usb_request *req;
+
+       req = usb_ep_alloc_request(ep, 0);
+       if (!req)
+               return req;
+
+       req->length = length;
+       req->buf = memalign(CONFIG_SYS_CACHELINE_SIZE, length);
+       if (!req->buf) {
+               usb_ep_free_request(ep, req);
+               req = NULL;
+       }
+
+       return req;
+}
+
+static int thor_rx_data(void)
+{
+       struct thor_dev *dev = thor_func->dev;
+       int data_to_rx, tmp, status;
+
+       data_to_rx = dev->out_req->length;
+       tmp = data_to_rx;
+       do {
+               dev->out_req->length = data_to_rx;
+               debug("dev->out_req->length:%d dev->rxdata:%d\n",
+                     dev->out_req->length, dev->rxdata);
+
+               status = usb_ep_queue(dev->out_ep, dev->out_req, 0);
+               if (status) {
+                       error("kill %s:  resubmit %d bytes --> %d",
+                             dev->out_ep->name, dev->out_req->length, status);
+                       usb_ep_set_halt(dev->out_ep);
+                       return -EAGAIN;
+               }
+
+               while (!dev->rxdata) {
+                       usb_gadget_handle_interrupts();
+                       if (ctrlc())
+                               return -1;
+               }
+               dev->rxdata = 0;
+               data_to_rx -= dev->out_req->actual;
+       } while (data_to_rx);
+
+       return tmp;
+}
+
+static void thor_tx_data(unsigned char *data, int len)
+{
+       struct thor_dev *dev = thor_func->dev;
+       unsigned char *ptr = dev->in_req->buf;
+       int status;
+
+       memset(ptr, 0, len);
+       memcpy(ptr, data, len);
+
+       dev->in_req->length = len;
+
+       debug("%s: dev->in_req->length:%d to_cpy:%d\n", __func__,
+             dev->in_req->length, sizeof(data));
+
+       status = usb_ep_queue(dev->in_ep, dev->in_req, 0);
+       if (status) {
+               error("kill %s:  resubmit %d bytes --> %d",
+                     dev->in_ep->name, dev->in_req->length, status);
+               usb_ep_set_halt(dev->in_ep);
+       }
+
+       /* Wait until tx interrupt received */
+       while (!dev->txdata)
+               usb_gadget_handle_interrupts();
+
+       dev->txdata = 0;
+}
+
+static void thor_rx_tx_complete(struct usb_ep *ep, struct usb_request *req)
+{
+       struct thor_dev *dev = thor_func->dev;
+       int status = req->status;
+
+       debug("%s: ep_ptr:%p, req_ptr:%p\n", __func__, ep, req);
+       switch (status) {
+       case 0:
+               if (ep == dev->out_ep)
+                       dev->rxdata = 1;
+               else
+                       dev->txdata = 1;
+
+               break;
+
+       /* this endpoint is normally active while we're configured */
+       case -ECONNABORTED:             /* hardware forced ep reset */
+       case -ECONNRESET:               /* request dequeued */
+       case -ESHUTDOWN:                /* disconnect from host */
+       case -EREMOTEIO:                /* short read */
+       case -EOVERFLOW:
+               error("ERROR:%d", status);
+               break;
+       }
+
+       debug("%s complete --> %d, %d/%d\n", ep->name,
+             status, req->actual, req->length);
+}
+
+static struct usb_request *thor_start_ep(struct usb_ep *ep)
+{
+       struct usb_request *req;
+
+       req = alloc_ep_req(ep, ep->maxpacket);
+       debug("%s: ep:%p req:%p\n", __func__, ep, req);
+
+       if (!req)
+               return NULL;
+
+       memset(req->buf, 0, req->length);
+       req->complete = thor_rx_tx_complete;
+
+       memset(req->buf, 0x55, req->length);
+
+       return req;
+}
+
+static void thor_setup_complete(struct usb_ep *ep, struct usb_request *req)
+{
+       if (req->status || req->actual != req->length)
+               debug("setup complete --> %d, %d/%d\n",
+                     req->status, req->actual, req->length);
+}
+
+static int
+thor_func_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl)
+{
+       struct thor_dev *dev = thor_func->dev;
+       struct usb_request *req = dev->req;
+       struct usb_gadget *gadget = dev->gadget;
+       int value = 0;
+
+       u16 len = le16_to_cpu(ctrl->wLength);
+
+       debug("Req_Type: 0x%x Req: 0x%x wValue: 0x%x wIndex: 0x%x wLen: 0x%x\n",
+             ctrl->bRequestType, ctrl->bRequest, ctrl->wValue, ctrl->wIndex,
+             ctrl->wLength);
+
+       switch (ctrl->bRequest) {
+       case USB_CDC_REQ_SET_CONTROL_LINE_STATE:
+               value = 0;
+               break;
+       case USB_CDC_REQ_SET_LINE_CODING:
+               value = len;
+               /* Line Coding set done = configuration done */
+               thor_func->dev->configuration_done = 1;
+               break;
+
+       default:
+               error("thor_setup: unknown request: %d", ctrl->bRequest);
+       }
+
+       if (value >= 0) {
+               req->length = value;
+               req->zero = value < len;
+               value = usb_ep_queue(gadget->ep0, req, 0);
+               if (value < 0) {
+                       debug("%s: ep_queue: %d\n", __func__, value);
+                       req->status = 0;
+               }
+       }
+
+       return value;
+}
+
+/* Specific to the THOR protocol */
+static void thor_set_dma(void *addr, int len)
+{
+       struct thor_dev *dev = thor_func->dev;
+
+       debug("in_req:%p, out_req:%p\n", dev->in_req, dev->out_req);
+       debug("addr:%p, len:%d\n", addr, len);
+
+       dev->out_req->buf = addr;
+       dev->out_req->length = len;
+}
+
+int thor_init(void)
+{
+       struct thor_dev *dev = thor_func->dev;
+
+       /* Wait for a device enumeration and configuration settings */
+       debug("THOR enumeration/configuration setting....\n");
+       while (!dev->configuration_done)
+               usb_gadget_handle_interrupts();
+
+       thor_set_dma(thor_rx_data_buf, strlen("THOR"));
+       /* detect the download request from Host PC */
+       if (thor_rx_data() < 0) {
+               printf("%s: Data not received!\n", __func__);
+               return -1;
+       }
+
+       if (!strncmp((char *)thor_rx_data_buf, "THOR", strlen("THOR"))) {
+               puts("Download request from the Host PC\n");
+               udelay(30 * 1000); /* 30 ms */
+
+               strcpy((char *)thor_tx_data_buf, "ROHT");
+               thor_tx_data(thor_tx_data_buf, strlen("ROHT"));
+       } else {
+               puts("Wrong reply information\n");
+               return -1;
+       }
+
+       return 0;
+}
+
+int thor_handle(void)
+{
+       int ret;
+
+       /* receive the data from Host PC */
+       while (1) {
+               thor_set_dma(thor_rx_data_buf, sizeof(struct rqt_box));
+               ret = thor_rx_data();
+
+               if (ret > 0) {
+                       ret = process_data();
+                       if (ret < 0)
+                               return ret;
+               } else {
+                       printf("%s: No data received!\n", __func__);
+                       break;
+               }
+       }
+
+       return 0;
+}
+
+static int thor_func_bind(struct usb_configuration *c, struct usb_function *f)
+{
+       struct usb_gadget *gadget = c->cdev->gadget;
+       struct f_thor *f_thor = func_to_thor(f);
+       struct thor_dev *dev;
+       struct usb_ep *ep;
+       int status;
+
+       thor_func = f_thor;
+       dev = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*dev));
+       if (!dev)
+               return -ENOMEM;
+
+       memset(dev, 0, sizeof(*dev));
+       dev->gadget = gadget;
+       f_thor->dev = dev;
+
+       debug("%s: usb_configuration: 0x%p usb_function: 0x%p\n",
+             __func__, c, f);
+       debug("f_thor: 0x%p thor: 0x%p\n", f_thor, dev);
+
+       /* EP0  */
+       /* preallocate control response and buffer */
+       dev->req = usb_ep_alloc_request(gadget->ep0, 0);
+       if (!dev->req) {
+               status = -ENOMEM;
+               goto fail;
+       }
+       dev->req->buf = memalign(CONFIG_SYS_CACHELINE_SIZE,
+                                gadget->ep0->maxpacket);
+       if (!dev->req->buf) {
+               status = -ENOMEM;
+               goto fail;
+       }
+
+       dev->req->complete = thor_setup_complete;
+
+       /* DYNAMIC interface numbers assignments */
+       status = usb_interface_id(c, f);
+
+       if (status < 0)
+               goto fail;
+
+       thor_downloader_intf_int.bInterfaceNumber = status;
+       thor_downloader_cdc_union.bMasterInterface0 = status;
+
+       status = usb_interface_id(c, f);
+
+       if (status < 0)
+               goto fail;
+
+       thor_downloader_intf_data.bInterfaceNumber = status;
+       thor_downloader_cdc_union.bSlaveInterface0 = status;
+
+       /* allocate instance-specific endpoints */
+       ep = usb_ep_autoconfig(gadget, &fs_in_desc);
+       if (!ep) {
+               status = -ENODEV;
+               goto fail;
+       }
+
+       if (gadget_is_dualspeed(gadget)) {
+               hs_in_desc.bEndpointAddress =
+                               fs_in_desc.bEndpointAddress;
+       }
+
+       dev->in_ep = ep; /* Store IN EP for enabling @ setup */
+
+       ep = usb_ep_autoconfig(gadget, &fs_out_desc);
+       if (!ep) {
+               status = -ENODEV;
+               goto fail;
+       }
+
+       if (gadget_is_dualspeed(gadget))
+               hs_out_desc.bEndpointAddress =
+                               fs_out_desc.bEndpointAddress;
+
+       dev->out_ep = ep; /* Store OUT EP for enabling @ setup */
+
+       ep = usb_ep_autoconfig(gadget, &fs_int_desc);
+       if (!ep) {
+               status = -ENODEV;
+               goto fail;
+       }
+
+       dev->int_ep = ep;
+
+       if (gadget_is_dualspeed(gadget)) {
+               hs_int_desc.bEndpointAddress =
+                               fs_int_desc.bEndpointAddress;
+
+               f->hs_descriptors = (struct usb_descriptor_header **)
+                       &hs_thor_downloader_function;
+
+               if (!f->hs_descriptors)
+                       goto fail;
+       }
+
+       debug("%s: out_ep:%p out_req:%p\n", __func__,
+             dev->out_ep, dev->out_req);
+
+       return 0;
+
+ fail:
+       free(dev);
+       return status;
+}
+
+static void free_ep_req(struct usb_ep *ep, struct usb_request *req)
+{
+       free(req->buf);
+       usb_ep_free_request(ep, req);
+}
+
+static void thor_unbind(struct usb_configuration *c, struct usb_function *f)
+{
+       struct f_thor *f_thor = func_to_thor(f);
+       struct thor_dev *dev = f_thor->dev;
+
+       free(dev);
+       memset(thor_func, 0, sizeof(*thor_func));
+       thor_func = NULL;
+}
+
+static void thor_func_disable(struct usb_function *f)
+{
+       struct f_thor *f_thor = func_to_thor(f);
+       struct thor_dev *dev = f_thor->dev;
+
+       debug("%s:\n", __func__);
+
+       /* Avoid freeing memory when ep is still claimed */
+       if (dev->in_ep->driver_data) {
+               free_ep_req(dev->in_ep, dev->in_req);
+               usb_ep_disable(dev->in_ep);
+               dev->in_ep->driver_data = NULL;
+       }
+
+       if (dev->out_ep->driver_data) {
+               dev->out_req->buf = NULL;
+               usb_ep_free_request(dev->out_ep, dev->out_req);
+               usb_ep_disable(dev->out_ep);
+               dev->out_ep->driver_data = NULL;
+       }
+
+       if (dev->int_ep->driver_data) {
+               usb_ep_disable(dev->int_ep);
+               dev->int_ep->driver_data = NULL;
+       }
+}
+
+static int thor_eps_setup(struct usb_function *f)
+{
+       struct usb_composite_dev *cdev = f->config->cdev;
+       struct usb_gadget *gadget = cdev->gadget;
+       struct thor_dev *dev = thor_func->dev;
+       struct usb_endpoint_descriptor *d;
+       struct usb_request *req;
+       struct usb_ep *ep;
+       int result;
+
+       ep = dev->in_ep;
+       d = ep_desc(gadget, &hs_in_desc, &fs_in_desc);
+       debug("(d)bEndpointAddress: 0x%x\n", d->bEndpointAddress);
+
+       result = usb_ep_enable(ep, d);
+       if (result)
+               goto exit;
+
+       ep->driver_data = cdev; /* claim */
+       req = thor_start_ep(ep);
+       if (!req) {
+               usb_ep_disable(ep);
+               result = -EIO;
+               goto exit;
+       }
+
+       dev->in_req = req;
+       ep = dev->out_ep;
+       d = ep_desc(gadget, &hs_out_desc, &fs_out_desc);
+       debug("(d)bEndpointAddress: 0x%x\n", d->bEndpointAddress);
+
+       result = usb_ep_enable(ep, d);
+       if (result)
+               goto exit;
+
+       ep->driver_data = cdev; /* claim */
+       req = thor_start_ep(ep);
+       if (!req) {
+               usb_ep_disable(ep);
+               result = -EIO;
+               goto exit;
+       }
+
+       dev->out_req = req;
+       /* ACM control EP */
+       ep = dev->int_ep;
+       ep->driver_data = cdev; /* claim */
+
+ exit:
+       return result;
+}
+
+static int thor_func_set_alt(struct usb_function *f,
+                            unsigned intf, unsigned alt)
+{
+       struct thor_dev *dev = thor_func->dev;
+       int result;
+
+       debug("%s: func: %s intf: %d alt: %d\n",
+             __func__, f->name, intf, alt);
+
+       switch (intf) {
+       case 0:
+               debug("ACM INTR interface\n");
+               break;
+       case 1:
+               debug("Communication Data interface\n");
+               result = thor_eps_setup(f);
+               if (result)
+                       error("%s: EPs setup failed!", __func__);
+               dev->configuration_done = 1;
+               break;
+       }
+
+       return 0;
+}
+
+static int thor_func_init(struct usb_configuration *c)
+{
+       struct f_thor *f_thor;
+       int status;
+
+       debug("%s: cdev: 0x%p\n", __func__, c->cdev);
+
+       f_thor = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*f_thor));
+       if (!f_thor)
+               return -ENOMEM;
+
+       memset(f_thor, 0, sizeof(*f_thor));
+
+       f_thor->usb_function.name = "f_thor";
+       f_thor->usb_function.bind = thor_func_bind;
+       f_thor->usb_function.unbind = thor_unbind;
+       f_thor->usb_function.setup = thor_func_setup;
+       f_thor->usb_function.set_alt = thor_func_set_alt;
+       f_thor->usb_function.disable = thor_func_disable;
+
+       status = usb_add_function(c, &f_thor->usb_function);
+       if (status)
+               free(f_thor);
+
+       return status;
+}
+
+int thor_add(struct usb_configuration *c)
+{
+       debug("%s:\n", __func__);
+       return thor_func_init(c);
+}
diff --git a/drivers/usb/gadget/f_thor.h b/drivers/usb/gadget/f_thor.h
new file mode 100644 (file)
index 0000000..04ee9a2
--- /dev/null
@@ -0,0 +1,124 @@
+/*
+ * f_thor.h - USB TIZEN THOR - internal gadget definitions
+ *
+ * Copyright (C) 2013 Samsung Electronics
+ * Lukasz Majewski  <l.majewski@samsung.com>
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#ifndef _USB_THOR_H_
+#define _USB_THOR_H_
+
+#include <linux/compiler.h>
+#include <asm/sizes.h>
+
+/* THOR Composite Gadget */
+#define STRING_MANUFACTURER_IDX        0
+#define STRING_PRODUCT_IDX             1
+#define STRING_SERIAL_IDX              2
+
+/* ********************************************************** */
+/*                   THOR protocol definitions               */
+/* ********************************************************** */
+
+/*
+ * Attribute Vendor descriptor - necessary to prevent ZLP transmission
+ * from Windows XP HOST PC
+ */
+struct usb_cdc_attribute_vendor_descriptor {
+       __u8 bLength;
+       __u8 bDescriptorType;
+       __u8 bDescriptorSubType;
+       __u16 DAUType;
+       __u16 DAULength;
+       __u8 DAUValue;
+} __packed;
+
+#define VER_PROTOCOL_MAJOR     4
+#define VER_PROTOCOL_MINOR     0
+
+enum rqt {
+       RQT_INFO = 200,
+       RQT_CMD,
+       RQT_DL,
+       RQT_UL,
+};
+
+enum rqt_data {
+       /* RQT_INFO */
+       RQT_INFO_VER_PROTOCOL = 1,
+       RQT_INIT_VER_HW,
+       RQT_INIT_VER_BOOT,
+       RQT_INIT_VER_KERNEL,
+       RQT_INIT_VER_PLATFORM,
+       RQT_INIT_VER_CSC,
+
+       /* RQT_CMD */
+       RQT_CMD_REBOOT = 1,
+       RQT_CMD_POWEROFF,
+       RQT_CMD_EFSCLEAR,
+
+       /* RQT_DL */
+       RQT_DL_INIT = 1,
+       RQT_DL_FILE_INFO,
+       RQT_DL_FILE_START,
+       RQT_DL_FILE_END,
+       RQT_DL_EXIT,
+
+       /* RQT_UL */
+       RQT_UL_INIT = 1,
+       RQT_UL_START,
+       RQT_UL_END,
+       RQT_UL_EXIT,
+};
+
+struct rqt_box {               /* total: 256B */
+       s32 rqt;                /* request id */
+       s32 rqt_data;           /* request data id */
+       s32 int_data[14];       /* int data */
+       char str_data[5][32];   /* string data */
+       char md5[32];           /* md5 checksum */
+} __packed;
+
+struct rsp_box {               /* total: 128B */
+       s32 rsp;                /* response id (= request id) */
+       s32 rsp_data;           /* response data id */
+       s32 ack;                /* ack */
+       s32 int_data[5];        /* int data */
+       char str_data[3][32];   /* string data */
+} __packed;
+
+struct data_rsp_box {          /* total: 8B */
+       s32 ack;                /* response id (= request id) */
+       s32 count;              /* response data id */
+} __packed;
+
+enum {
+       FILE_TYPE_NORMAL,
+       FILE_TYPE_PIT,
+};
+
+struct thor_dev {
+       struct usb_gadget *gadget;
+       struct usb_request *req; /* EP0 -> control responses */
+
+       /* IN/OUT EP's and correspoinding requests */
+       struct usb_ep *in_ep, *out_ep, *int_ep;
+       struct usb_request *in_req, *out_req;
+
+       /* Control flow variables */
+       unsigned char configuration_done;
+       unsigned char rxdata;
+       unsigned char txdata;
+};
+
+struct f_thor {
+       struct usb_function usb_function;
+       struct thor_dev *dev;
+};
+
+#define F_NAME_BUF_SIZE 32
+#define THOR_PACKET_SIZE SZ_1M      /* 1 MiB */
+#define THOR_STORE_UNIT_SIZE SZ_32M /* 32 MiB */
+#endif /* _USB_THOR_H_ */
diff --git a/include/thor.h b/include/thor.h
new file mode 100644 (file)
index 0000000..afeade4
--- /dev/null
@@ -0,0 +1,27 @@
+/*
+ * thor.h -- USB THOR Downloader protocol
+ *
+ * Copyright (C) 2013 Samsung Electronics
+ * Lukasz Majewski  <l.majewski@samsung.com>
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ *
+ */
+
+#ifndef __THOR_H_
+#define __THOR_H_
+
+#include <linux/usb/composite.h>
+
+int thor_handle(void);
+int thor_init(void);
+
+#ifdef CONFIG_THOR_FUNCTION
+int thor_add(struct usb_configuration *c);
+#else
+int thor_add(struct usb_configuration *c)
+{
+       return 0;
+}
+#endif
+#endif /* __THOR_H_ */