1 /* 2 * g_dnl.c -- USB Downloader Gadget 3 * 4 * Copyright (C) 2012 Samsung Electronics 5 * Lukasz Majewski <l.majewski@samsung.com> 6 * 7 * SPDX-License-Identifier: GPL-2.0+ 8 */ 9 10 #include <common.h> 11 #include <malloc.h> 12 13 #include <mmc.h> 14 #include <part.h> 15 16 #include <g_dnl.h> 17 #include <usb_mass_storage.h> 18 #include <dfu.h> 19 #include <thor.h> 20 21 #include "gadget_chips.h" 22 #include "composite.c" 23 24 /* 25 * One needs to define the following: 26 * CONFIG_G_DNL_VENDOR_NUM 27 * CONFIG_G_DNL_PRODUCT_NUM 28 * CONFIG_G_DNL_MANUFACTURER 29 * at e.g. ./include/configs/<board>.h 30 */ 31 32 #define STRING_MANUFACTURER 25 33 #define STRING_PRODUCT 2 34 /* Index of String Descriptor describing this configuration */ 35 #define STRING_USBDOWN 2 36 /* Index of String serial */ 37 #define STRING_SERIAL 3 38 #define MAX_STRING_SERIAL 32 39 /* Number of supported configurations */ 40 #define CONFIGURATION_NUMBER 1 41 42 #define DRIVER_VERSION "usb_dnl 2.0" 43 44 static const char product[] = "USB download gadget"; 45 static char g_dnl_serial[MAX_STRING_SERIAL]; 46 static const char manufacturer[] = CONFIG_G_DNL_MANUFACTURER; 47 48 void g_dnl_set_serialnumber(char *s) 49 { 50 memset(g_dnl_serial, 0, MAX_STRING_SERIAL); 51 if (strlen(s) < MAX_STRING_SERIAL) 52 strncpy(g_dnl_serial, s, strlen(s)); 53 } 54 55 static struct usb_device_descriptor device_desc = { 56 .bLength = sizeof device_desc, 57 .bDescriptorType = USB_DT_DEVICE, 58 59 .bcdUSB = __constant_cpu_to_le16(0x0200), 60 .bDeviceClass = USB_CLASS_COMM, 61 .bDeviceSubClass = 0x02, /*0x02:CDC-modem , 0x00:CDC-serial*/ 62 63 .idVendor = __constant_cpu_to_le16(CONFIG_G_DNL_VENDOR_NUM), 64 .idProduct = __constant_cpu_to_le16(CONFIG_G_DNL_PRODUCT_NUM), 65 .iProduct = STRING_PRODUCT, 66 .iSerialNumber = STRING_SERIAL, 67 .bNumConfigurations = 1, 68 }; 69 70 /* 71 * static strings, in UTF-8 72 * IDs for those strings are assigned dynamically at g_dnl_bind() 73 */ 74 static struct usb_string g_dnl_string_defs[] = { 75 {.s = manufacturer}, 76 {.s = product}, 77 {.s = g_dnl_serial}, 78 { } /* end of list */ 79 }; 80 81 static struct usb_gadget_strings g_dnl_string_tab = { 82 .language = 0x0409, /* en-us */ 83 .strings = g_dnl_string_defs, 84 }; 85 86 static struct usb_gadget_strings *g_dnl_composite_strings[] = { 87 &g_dnl_string_tab, 88 NULL, 89 }; 90 91 static int g_dnl_unbind(struct usb_composite_dev *cdev) 92 { 93 struct usb_gadget *gadget = cdev->gadget; 94 95 free(cdev->config); 96 cdev->config = NULL; 97 debug("%s: calling usb_gadget_disconnect for " 98 "controller '%s'\n", __func__, gadget->name); 99 usb_gadget_disconnect(gadget); 100 101 return 0; 102 } 103 104 static inline struct g_dnl_bind_callback *g_dnl_bind_callback_first(void) 105 { 106 return ll_entry_start(struct g_dnl_bind_callback, 107 g_dnl_bind_callbacks); 108 } 109 110 static inline struct g_dnl_bind_callback *g_dnl_bind_callback_end(void) 111 { 112 return ll_entry_end(struct g_dnl_bind_callback, 113 g_dnl_bind_callbacks); 114 } 115 116 static int g_dnl_do_config(struct usb_configuration *c) 117 { 118 const char *s = c->cdev->driver->name; 119 struct g_dnl_bind_callback *callback = g_dnl_bind_callback_first(); 120 121 debug("%s: configuration: 0x%p composite dev: 0x%p\n", 122 __func__, c, c->cdev); 123 124 for (; callback != g_dnl_bind_callback_end(); callback++) 125 if (!strcmp(s, callback->usb_function_name)) 126 return callback->fptr(c); 127 return -ENODEV; 128 } 129 130 static int g_dnl_config_register(struct usb_composite_dev *cdev) 131 { 132 struct usb_configuration *config; 133 const char *name = "usb_dnload"; 134 135 config = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*config)); 136 if (!config) 137 return -ENOMEM; 138 139 memset(config, 0, sizeof(*config)); 140 141 config->label = name; 142 config->bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER; 143 config->bConfigurationValue = CONFIGURATION_NUMBER; 144 config->iConfiguration = STRING_USBDOWN; 145 config->bind = g_dnl_do_config; 146 147 return usb_add_config(cdev, config); 148 } 149 150 __weak 151 int g_dnl_bind_fixup(struct usb_device_descriptor *dev, const char *name) 152 { 153 return 0; 154 } 155 156 __weak int g_dnl_get_board_bcd_device_number(int gcnum) 157 { 158 return gcnum; 159 } 160 161 __weak int g_dnl_board_usb_cable_connected(void) 162 { 163 return -EOPNOTSUPP; 164 } 165 166 static bool g_dnl_detach_request; 167 168 bool g_dnl_detach(void) 169 { 170 return g_dnl_detach_request; 171 } 172 173 void g_dnl_trigger_detach(void) 174 { 175 g_dnl_detach_request = true; 176 } 177 178 void g_dnl_clear_detach(void) 179 { 180 g_dnl_detach_request = false; 181 } 182 183 static int g_dnl_get_bcd_device_number(struct usb_composite_dev *cdev) 184 { 185 struct usb_gadget *gadget = cdev->gadget; 186 int gcnum; 187 188 gcnum = usb_gadget_controller_number(gadget); 189 if (gcnum > 0) 190 gcnum += 0x200; 191 192 return g_dnl_get_board_bcd_device_number(gcnum); 193 } 194 195 static int g_dnl_bind(struct usb_composite_dev *cdev) 196 { 197 struct usb_gadget *gadget = cdev->gadget; 198 int id, ret; 199 int gcnum; 200 201 debug("%s: gadget: 0x%p cdev: 0x%p\n", __func__, gadget, cdev); 202 203 id = usb_string_id(cdev); 204 205 if (id < 0) 206 return id; 207 g_dnl_string_defs[0].id = id; 208 device_desc.iManufacturer = id; 209 210 id = usb_string_id(cdev); 211 if (id < 0) 212 return id; 213 214 g_dnl_string_defs[1].id = id; 215 device_desc.iProduct = id; 216 217 id = usb_string_id(cdev); 218 if (id < 0) 219 return id; 220 221 g_dnl_string_defs[2].id = id; 222 device_desc.iSerialNumber = id; 223 224 g_dnl_bind_fixup(&device_desc, cdev->driver->name); 225 ret = g_dnl_config_register(cdev); 226 if (ret) 227 goto error; 228 229 gcnum = g_dnl_get_bcd_device_number(cdev); 230 if (gcnum >= 0) 231 device_desc.bcdDevice = cpu_to_le16(gcnum); 232 else { 233 debug("%s: controller '%s' not recognized\n", 234 __func__, gadget->name); 235 device_desc.bcdDevice = __constant_cpu_to_le16(0x9999); 236 } 237 238 debug("%s: calling usb_gadget_connect for " 239 "controller '%s'\n", __func__, gadget->name); 240 usb_gadget_connect(gadget); 241 242 return 0; 243 244 error: 245 g_dnl_unbind(cdev); 246 return -ENOMEM; 247 } 248 249 static struct usb_composite_driver g_dnl_driver = { 250 .name = NULL, 251 .dev = &device_desc, 252 .strings = g_dnl_composite_strings, 253 254 .bind = g_dnl_bind, 255 .unbind = g_dnl_unbind, 256 }; 257 258 /* 259 * NOTICE: 260 * Registering via USB function name won't be necessary after rewriting 261 * g_dnl to support multiple USB functions. 262 */ 263 int g_dnl_register(const char *name) 264 { 265 int ret; 266 267 debug("%s: g_dnl_driver.name = %s\n", __func__, name); 268 g_dnl_driver.name = name; 269 270 ret = usb_composite_register(&g_dnl_driver); 271 if (ret) { 272 printf("%s: failed!, error: %d\n", __func__, ret); 273 return ret; 274 } 275 return 0; 276 } 277 278 void g_dnl_unregister(void) 279 { 280 usb_composite_unregister(&g_dnl_driver); 281 } 282