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 "gadget_chips.h"
23 #include "composite.c"
26 * One needs to define the following:
27 * CONFIG_G_DNL_VENDOR_NUM
28 * CONFIG_G_DNL_PRODUCT_NUM
29 * CONFIG_G_DNL_MANUFACTURER
30 * at e.g. ./include/configs/<board>.h
33 #define STRING_MANUFACTURER 25
34 #define STRING_PRODUCT 2
35 /* Index of String Descriptor describing this configuration */
36 #define STRING_USBDOWN 2
37 /* Index of String serial */
38 #define STRING_SERIAL 3
39 #define MAX_STRING_SERIAL 32
40 /* Number of supported configurations */
41 #define CONFIGURATION_NUMBER 1
43 #define DRIVER_VERSION "usb_dnl 2.0"
45 static const char product[] = "USB download gadget";
46 static char g_dnl_serial[MAX_STRING_SERIAL];
47 static const char manufacturer[] = CONFIG_G_DNL_MANUFACTURER;
49 void g_dnl_set_serialnumber(char *s)
51 memset(g_dnl_serial, 0, MAX_STRING_SERIAL);
52 if (strlen(s) < MAX_STRING_SERIAL)
53 strncpy(g_dnl_serial, s, strlen(s));
56 static struct usb_device_descriptor device_desc = {
57 .bLength = sizeof device_desc,
58 .bDescriptorType = USB_DT_DEVICE,
60 .bcdUSB = __constant_cpu_to_le16(0x0200),
61 .bDeviceClass = USB_CLASS_COMM,
62 .bDeviceSubClass = 0x02, /*0x02:CDC-modem , 0x00:CDC-serial*/
64 .idVendor = __constant_cpu_to_le16(CONFIG_G_DNL_VENDOR_NUM),
65 .idProduct = __constant_cpu_to_le16(CONFIG_G_DNL_PRODUCT_NUM),
66 .iProduct = STRING_PRODUCT,
67 .iSerialNumber = STRING_SERIAL,
68 .bNumConfigurations = 1,
72 * static strings, in UTF-8
73 * IDs for those strings are assigned dynamically at g_dnl_bind()
75 static struct usb_string g_dnl_string_defs[] = {
82 static struct usb_gadget_strings g_dnl_string_tab = {
83 .language = 0x0409, /* en-us */
84 .strings = g_dnl_string_defs,
87 static struct usb_gadget_strings *g_dnl_composite_strings[] = {
92 static int g_dnl_unbind(struct usb_composite_dev *cdev)
94 struct usb_gadget *gadget = cdev->gadget;
98 debug("%s: calling usb_gadget_disconnect for "
99 "controller '%s'\n", __func__, gadget->name);
100 usb_gadget_disconnect(gadget);
105 static inline struct g_dnl_bind_callback *g_dnl_bind_callback_first(void)
107 return ll_entry_start(struct g_dnl_bind_callback,
108 g_dnl_bind_callbacks);
111 static inline struct g_dnl_bind_callback *g_dnl_bind_callback_end(void)
113 return ll_entry_end(struct g_dnl_bind_callback,
114 g_dnl_bind_callbacks);
117 static int g_dnl_do_config(struct usb_configuration *c)
119 const char *s = c->cdev->driver->name;
120 struct g_dnl_bind_callback *callback = g_dnl_bind_callback_first();
122 debug("%s: configuration: 0x%p composite dev: 0x%p\n",
123 __func__, c, c->cdev);
125 for (; callback != g_dnl_bind_callback_end(); callback++)
126 if (!strcmp(s, callback->usb_function_name))
127 return callback->fptr(c);
131 static int g_dnl_config_register(struct usb_composite_dev *cdev)
133 struct usb_configuration *config;
134 const char *name = "usb_dnload";
136 config = memalign(CONFIG_SYS_CACHELINE_SIZE, sizeof(*config));
140 memset(config, 0, sizeof(*config));
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;
148 return usb_add_config(cdev, config);
152 int board_usb_init(int index, enum usb_init_type init)
158 int board_usb_cleanup(int index, enum usb_init_type init)
164 int g_dnl_bind_fixup(struct usb_device_descriptor *dev, const char *name)
169 __weak int g_dnl_get_board_bcd_device_number(int gcnum)
174 __weak int g_dnl_board_usb_cable_connected(void)
179 static bool g_dnl_detach_request;
181 bool g_dnl_detach(void)
183 return g_dnl_detach_request;
186 void g_dnl_trigger_detach(void)
188 g_dnl_detach_request = true;
191 void g_dnl_clear_detach(void)
193 g_dnl_detach_request = false;
196 static int g_dnl_get_bcd_device_number(struct usb_composite_dev *cdev)
198 struct usb_gadget *gadget = cdev->gadget;
201 gcnum = usb_gadget_controller_number(gadget);
205 return g_dnl_get_board_bcd_device_number(gcnum);
208 static int g_dnl_bind(struct usb_composite_dev *cdev)
210 struct usb_gadget *gadget = cdev->gadget;
214 debug("%s: gadget: 0x%p cdev: 0x%p\n", __func__, gadget, cdev);
216 id = usb_string_id(cdev);
220 g_dnl_string_defs[0].id = id;
221 device_desc.iManufacturer = id;
223 id = usb_string_id(cdev);
227 g_dnl_string_defs[1].id = id;
228 device_desc.iProduct = id;
230 id = usb_string_id(cdev);
234 g_dnl_string_defs[2].id = id;
235 device_desc.iSerialNumber = id;
237 g_dnl_bind_fixup(&device_desc, cdev->driver->name);
238 ret = g_dnl_config_register(cdev);
242 gcnum = g_dnl_get_bcd_device_number(cdev);
244 device_desc.bcdDevice = cpu_to_le16(gcnum);
246 debug("%s: controller '%s' not recognized\n",
247 __func__, gadget->name);
248 device_desc.bcdDevice = __constant_cpu_to_le16(0x9999);
251 debug("%s: calling usb_gadget_connect for "
252 "controller '%s'\n", __func__, gadget->name);
253 usb_gadget_connect(gadget);
262 static struct usb_composite_driver g_dnl_driver = {
265 .strings = g_dnl_composite_strings,
268 .unbind = g_dnl_unbind,
273 * Registering via USB function name won't be necessary after rewriting
274 * g_dnl to support multiple USB functions.
276 int g_dnl_register(const char *name)
280 debug("%s: g_dnl_driver.name = %s\n", __func__, name);
281 g_dnl_driver.name = name;
283 ret = usb_composite_register(&g_dnl_driver);
285 printf("%s: failed!, error: %d\n", __func__, ret);
291 void g_dnl_unregister(void)
293 usb_composite_unregister(&g_dnl_driver);