2 * g_dnl.c -- USB Downloader Gadget
4 * Copyright (C) 2012 Samsung Electronics
5 * Lukasz Majewski <l.majewski@samsung.com>
7 * SPDX-License-Identifier: GPL-2.0+
18 #include <usb_mass_storage.h>
22 #include <env_callback.h>
24 #include "gadget_chips.h"
25 #include "composite.c"
28 * One needs to define the following:
29 * CONFIG_G_DNL_VENDOR_NUM
30 * CONFIG_G_DNL_PRODUCT_NUM
31 * CONFIG_G_DNL_MANUFACTURER
32 * at e.g. ./configs/<board>_defconfig
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
45 #define DRIVER_VERSION "usb_dnl 2.0"
47 static const char product[] = "USB download gadget";
48 static char g_dnl_serial[MAX_STRING_SERIAL];
49 static const char manufacturer[] = CONFIG_G_DNL_MANUFACTURER;
51 void g_dnl_set_serialnumber(char *s)
53 memset(g_dnl_serial, 0, MAX_STRING_SERIAL);
54 strncpy(g_dnl_serial, s, MAX_STRING_SERIAL - 1);
57 static struct usb_device_descriptor device_desc = {
58 .bLength = sizeof device_desc,
59 .bDescriptorType = USB_DT_DEVICE,
61 .bcdUSB = __constant_cpu_to_le16(0x0200),
62 .bDeviceClass = USB_CLASS_PER_INTERFACE,
63 .bDeviceSubClass = 0, /*0x02:CDC-modem , 0x00:CDC-serial*/
65 .idVendor = __constant_cpu_to_le16(CONFIG_G_DNL_VENDOR_NUM),
66 .idProduct = __constant_cpu_to_le16(CONFIG_G_DNL_PRODUCT_NUM),
67 /* .iProduct = DYNAMIC */
68 /* .iSerialNumber = DYNAMIC */
69 .bNumConfigurations = 1,
73 * static strings, in UTF-8
74 * IDs for those strings are assigned dynamically at g_dnl_bind()
76 static struct usb_string g_dnl_string_defs[] = {
83 static struct usb_gadget_strings g_dnl_string_tab = {
84 .language = 0x0409, /* en-us */
85 .strings = g_dnl_string_defs,
88 static struct usb_gadget_strings *g_dnl_composite_strings[] = {
93 static int g_dnl_unbind(struct usb_composite_dev *cdev)
95 struct usb_gadget *gadget = cdev->gadget;
97 debug("%s: calling usb_gadget_disconnect for "
98 "controller '%s'\n", __func__, gadget->name);
99 usb_gadget_disconnect(gadget);
104 static inline struct g_dnl_bind_callback *g_dnl_bind_callback_first(void)
106 return ll_entry_start(struct g_dnl_bind_callback,
107 g_dnl_bind_callbacks);
110 static inline struct g_dnl_bind_callback *g_dnl_bind_callback_end(void)
112 return ll_entry_end(struct g_dnl_bind_callback,
113 g_dnl_bind_callbacks);
116 static int g_dnl_do_config(struct usb_configuration *c)
118 const char *s = c->cdev->driver->name;
119 struct g_dnl_bind_callback *callback = g_dnl_bind_callback_first();
121 debug("%s: configuration: 0x%p composite dev: 0x%p\n",
122 __func__, c, c->cdev);
124 for (; callback != g_dnl_bind_callback_end(); callback++)
125 if (!strcmp(s, callback->usb_function_name))
126 return callback->fptr(c);
130 static int g_dnl_config_register(struct usb_composite_dev *cdev)
132 struct usb_configuration *config;
133 const char *name = "usb_dnload";
135 config = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*config));
139 memset(config, 0, sizeof(*config));
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;
147 return usb_add_config(cdev, config);
151 int board_usb_init(int index, enum usb_init_type init)
157 int board_usb_cleanup(int index, enum usb_init_type init)
163 int g_dnl_bind_fixup(struct usb_device_descriptor *dev, const char *name)
168 __weak int g_dnl_get_board_bcd_device_number(int gcnum)
173 __weak int g_dnl_board_usb_cable_connected(void)
178 static bool g_dnl_detach_request;
180 bool g_dnl_detach(void)
182 return g_dnl_detach_request;
185 void g_dnl_trigger_detach(void)
187 g_dnl_detach_request = true;
190 void g_dnl_clear_detach(void)
192 g_dnl_detach_request = false;
195 static int g_dnl_get_bcd_device_number(struct usb_composite_dev *cdev)
197 struct usb_gadget *gadget = cdev->gadget;
200 gcnum = usb_gadget_controller_number(gadget);
204 return g_dnl_get_board_bcd_device_number(gcnum);
208 * Update internal serial number variable when the "serial#" env var changes.
210 * Handle all cases, even when flags == H_PROGRAMMATIC or op == env_op_delete.
212 static int on_serialno(const char *name, const char *value, enum env_op op,
215 g_dnl_set_serialnumber((char *)value);
218 U_BOOT_ENV_CALLBACK(serialno, on_serialno);
220 static int g_dnl_bind(struct usb_composite_dev *cdev)
222 struct usb_gadget *gadget = cdev->gadget;
226 debug("%s: gadget: 0x%p cdev: 0x%p\n", __func__, gadget, cdev);
228 id = usb_string_id(cdev);
232 g_dnl_string_defs[0].id = id;
233 device_desc.iManufacturer = id;
235 id = usb_string_id(cdev);
239 g_dnl_string_defs[1].id = id;
240 device_desc.iProduct = id;
242 g_dnl_bind_fixup(&device_desc, cdev->driver->name);
244 if (strlen(g_dnl_serial)) {
245 id = usb_string_id(cdev);
249 g_dnl_string_defs[2].id = id;
250 device_desc.iSerialNumber = id;
253 ret = g_dnl_config_register(cdev);
257 gcnum = g_dnl_get_bcd_device_number(cdev);
259 device_desc.bcdDevice = cpu_to_le16(gcnum);
261 debug("%s: controller '%s' not recognized\n",
262 __func__, gadget->name);
263 device_desc.bcdDevice = __constant_cpu_to_le16(0x9999);
266 debug("%s: calling usb_gadget_connect for "
267 "controller '%s'\n", __func__, gadget->name);
268 usb_gadget_connect(gadget);
277 static struct usb_composite_driver g_dnl_driver = {
280 .strings = g_dnl_composite_strings,
283 .unbind = g_dnl_unbind,
288 * Registering via USB function name won't be necessary after rewriting
289 * g_dnl to support multiple USB functions.
291 int g_dnl_register(const char *name)
295 debug("%s: g_dnl_driver.name = %s\n", __func__, name);
296 g_dnl_driver.name = name;
298 ret = usb_composite_register(&g_dnl_driver);
300 printf("%s: failed!, error: %d\n", __func__, ret);
306 void g_dnl_unregister(void)
308 usb_composite_unregister(&g_dnl_driver);