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