15fd54aceSGreg Kroah-Hartman // SPDX-License-Identifier: GPL-2.0+
28443f2d2SAndrzej Pietrasiewicz /*
38443f2d2SAndrzej Pietrasiewicz * ncm.c -- NCM gadget driver
48443f2d2SAndrzej Pietrasiewicz *
58443f2d2SAndrzej Pietrasiewicz * Copyright (C) 2010 Nokia Corporation
68443f2d2SAndrzej Pietrasiewicz * Contact: Yauheni Kaliuta <yauheni.kaliuta@nokia.com>
78443f2d2SAndrzej Pietrasiewicz *
88443f2d2SAndrzej Pietrasiewicz * The driver borrows from ether.c which is:
98443f2d2SAndrzej Pietrasiewicz *
108443f2d2SAndrzej Pietrasiewicz * Copyright (C) 2003-2005,2008 David Brownell
118443f2d2SAndrzej Pietrasiewicz * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
128443f2d2SAndrzej Pietrasiewicz * Copyright (C) 2008 Nokia Corporation
138443f2d2SAndrzej Pietrasiewicz */
148443f2d2SAndrzej Pietrasiewicz
158443f2d2SAndrzej Pietrasiewicz /* #define DEBUG */
168443f2d2SAndrzej Pietrasiewicz /* #define VERBOSE_DEBUG */
178443f2d2SAndrzej Pietrasiewicz
188443f2d2SAndrzej Pietrasiewicz #include <linux/kernel.h>
198443f2d2SAndrzej Pietrasiewicz #include <linux/module.h>
208443f2d2SAndrzej Pietrasiewicz #include <linux/usb/composite.h>
218443f2d2SAndrzej Pietrasiewicz
228443f2d2SAndrzej Pietrasiewicz #include "u_ether.h"
238443f2d2SAndrzej Pietrasiewicz #include "u_ncm.h"
248443f2d2SAndrzej Pietrasiewicz
258443f2d2SAndrzej Pietrasiewicz #define DRIVER_DESC "NCM Gadget"
268443f2d2SAndrzej Pietrasiewicz
278443f2d2SAndrzej Pietrasiewicz /*-------------------------------------------------------------------------*/
288443f2d2SAndrzej Pietrasiewicz
298443f2d2SAndrzej Pietrasiewicz /* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
308443f2d2SAndrzej Pietrasiewicz * Instead: allocate your own, using normal USB-IF procedures.
318443f2d2SAndrzej Pietrasiewicz */
328443f2d2SAndrzej Pietrasiewicz
338443f2d2SAndrzej Pietrasiewicz /* Thanks to NetChip Technologies for donating this product ID.
348443f2d2SAndrzej Pietrasiewicz * It's for devices with only CDC Ethernet configurations.
358443f2d2SAndrzej Pietrasiewicz */
368443f2d2SAndrzej Pietrasiewicz #define CDC_VENDOR_NUM 0x0525 /* NetChip */
378443f2d2SAndrzej Pietrasiewicz #define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
388443f2d2SAndrzej Pietrasiewicz
398443f2d2SAndrzej Pietrasiewicz /*-------------------------------------------------------------------------*/
408443f2d2SAndrzej Pietrasiewicz USB_GADGET_COMPOSITE_OPTIONS();
418443f2d2SAndrzej Pietrasiewicz
428443f2d2SAndrzej Pietrasiewicz USB_ETHERNET_MODULE_PARAMETERS();
438443f2d2SAndrzej Pietrasiewicz
448443f2d2SAndrzej Pietrasiewicz static struct usb_device_descriptor device_desc = {
458443f2d2SAndrzej Pietrasiewicz .bLength = sizeof device_desc,
468443f2d2SAndrzej Pietrasiewicz .bDescriptorType = USB_DT_DEVICE,
478443f2d2SAndrzej Pietrasiewicz
480aecfc1bSIgor Kotrasinski /* .bcdUSB = DYNAMIC */
498443f2d2SAndrzej Pietrasiewicz
508443f2d2SAndrzej Pietrasiewicz .bDeviceClass = USB_CLASS_COMM,
518443f2d2SAndrzej Pietrasiewicz .bDeviceSubClass = 0,
528443f2d2SAndrzej Pietrasiewicz .bDeviceProtocol = 0,
538443f2d2SAndrzej Pietrasiewicz /* .bMaxPacketSize0 = f(hardware) */
548443f2d2SAndrzej Pietrasiewicz
558443f2d2SAndrzej Pietrasiewicz /* Vendor and product id defaults change according to what configs
568443f2d2SAndrzej Pietrasiewicz * we support. (As does bNumConfigurations.) These values can
578443f2d2SAndrzej Pietrasiewicz * also be overridden by module parameters.
588443f2d2SAndrzej Pietrasiewicz */
598443f2d2SAndrzej Pietrasiewicz .idVendor = cpu_to_le16 (CDC_VENDOR_NUM),
608443f2d2SAndrzej Pietrasiewicz .idProduct = cpu_to_le16 (CDC_PRODUCT_NUM),
618443f2d2SAndrzej Pietrasiewicz /* .bcdDevice = f(hardware) */
628443f2d2SAndrzej Pietrasiewicz /* .iManufacturer = DYNAMIC */
638443f2d2SAndrzej Pietrasiewicz /* .iProduct = DYNAMIC */
648443f2d2SAndrzej Pietrasiewicz /* NO SERIAL NUMBER */
658443f2d2SAndrzej Pietrasiewicz .bNumConfigurations = 1,
668443f2d2SAndrzej Pietrasiewicz };
678443f2d2SAndrzej Pietrasiewicz
681156e91dSLi Jun static const struct usb_descriptor_header *otg_desc[2];
698443f2d2SAndrzej Pietrasiewicz
708443f2d2SAndrzej Pietrasiewicz /* string IDs are assigned dynamically */
718443f2d2SAndrzej Pietrasiewicz static struct usb_string strings_dev[] = {
728443f2d2SAndrzej Pietrasiewicz [USB_GADGET_MANUFACTURER_IDX].s = "",
738443f2d2SAndrzej Pietrasiewicz [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
748443f2d2SAndrzej Pietrasiewicz [USB_GADGET_SERIAL_IDX].s = "",
758443f2d2SAndrzej Pietrasiewicz { } /* end of list */
768443f2d2SAndrzej Pietrasiewicz };
778443f2d2SAndrzej Pietrasiewicz
788443f2d2SAndrzej Pietrasiewicz static struct usb_gadget_strings stringtab_dev = {
798443f2d2SAndrzej Pietrasiewicz .language = 0x0409, /* en-us */
808443f2d2SAndrzej Pietrasiewicz .strings = strings_dev,
818443f2d2SAndrzej Pietrasiewicz };
828443f2d2SAndrzej Pietrasiewicz
838443f2d2SAndrzej Pietrasiewicz static struct usb_gadget_strings *dev_strings[] = {
848443f2d2SAndrzej Pietrasiewicz &stringtab_dev,
858443f2d2SAndrzej Pietrasiewicz NULL,
868443f2d2SAndrzej Pietrasiewicz };
878443f2d2SAndrzej Pietrasiewicz
888443f2d2SAndrzej Pietrasiewicz static struct usb_function_instance *f_ncm_inst;
898443f2d2SAndrzej Pietrasiewicz static struct usb_function *f_ncm;
908443f2d2SAndrzej Pietrasiewicz
918443f2d2SAndrzej Pietrasiewicz /*-------------------------------------------------------------------------*/
928443f2d2SAndrzej Pietrasiewicz
ncm_do_config(struct usb_configuration * c)93c94e289fSArnd Bergmann static int ncm_do_config(struct usb_configuration *c)
948443f2d2SAndrzej Pietrasiewicz {
958443f2d2SAndrzej Pietrasiewicz int status;
968443f2d2SAndrzej Pietrasiewicz
978443f2d2SAndrzej Pietrasiewicz /* FIXME alloc iConfiguration string, set it in c->strings */
988443f2d2SAndrzej Pietrasiewicz
998443f2d2SAndrzej Pietrasiewicz if (gadget_is_otg(c->cdev->gadget)) {
1008443f2d2SAndrzej Pietrasiewicz c->descriptors = otg_desc;
1018443f2d2SAndrzej Pietrasiewicz c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1028443f2d2SAndrzej Pietrasiewicz }
1038443f2d2SAndrzej Pietrasiewicz
1048443f2d2SAndrzej Pietrasiewicz f_ncm = usb_get_function(f_ncm_inst);
1050cb5818aSGustavo A. R. Silva if (IS_ERR(f_ncm))
1060cb5818aSGustavo A. R. Silva return PTR_ERR(f_ncm);
1078443f2d2SAndrzej Pietrasiewicz
1088443f2d2SAndrzej Pietrasiewicz status = usb_add_function(c, f_ncm);
1098443f2d2SAndrzej Pietrasiewicz if (status < 0) {
1108443f2d2SAndrzej Pietrasiewicz usb_put_function(f_ncm);
1118443f2d2SAndrzej Pietrasiewicz return status;
1128443f2d2SAndrzej Pietrasiewicz }
1138443f2d2SAndrzej Pietrasiewicz
1148443f2d2SAndrzej Pietrasiewicz return 0;
1158443f2d2SAndrzej Pietrasiewicz }
1168443f2d2SAndrzej Pietrasiewicz
1178443f2d2SAndrzej Pietrasiewicz static struct usb_configuration ncm_config_driver = {
1188443f2d2SAndrzej Pietrasiewicz /* .label = f(hardware) */
1198443f2d2SAndrzej Pietrasiewicz .label = "CDC Ethernet (NCM)",
1208443f2d2SAndrzej Pietrasiewicz .bConfigurationValue = 1,
1218443f2d2SAndrzej Pietrasiewicz /* .iConfiguration = DYNAMIC */
1228443f2d2SAndrzej Pietrasiewicz .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
1238443f2d2SAndrzej Pietrasiewicz };
1248443f2d2SAndrzej Pietrasiewicz
1258443f2d2SAndrzej Pietrasiewicz /*-------------------------------------------------------------------------*/
1268443f2d2SAndrzej Pietrasiewicz
gncm_bind(struct usb_composite_dev * cdev)127c94e289fSArnd Bergmann static int gncm_bind(struct usb_composite_dev *cdev)
1288443f2d2SAndrzej Pietrasiewicz {
1298443f2d2SAndrzej Pietrasiewicz struct usb_gadget *gadget = cdev->gadget;
1308443f2d2SAndrzej Pietrasiewicz struct f_ncm_opts *ncm_opts;
1318443f2d2SAndrzej Pietrasiewicz int status;
1328443f2d2SAndrzej Pietrasiewicz
1338443f2d2SAndrzej Pietrasiewicz f_ncm_inst = usb_get_function_instance("ncm");
1348443f2d2SAndrzej Pietrasiewicz if (IS_ERR(f_ncm_inst))
1358443f2d2SAndrzej Pietrasiewicz return PTR_ERR(f_ncm_inst);
1368443f2d2SAndrzej Pietrasiewicz
1378443f2d2SAndrzej Pietrasiewicz ncm_opts = container_of(f_ncm_inst, struct f_ncm_opts, func_inst);
1388443f2d2SAndrzej Pietrasiewicz
1398443f2d2SAndrzej Pietrasiewicz gether_set_qmult(ncm_opts->net, qmult);
1408443f2d2SAndrzej Pietrasiewicz if (!gether_set_host_addr(ncm_opts->net, host_addr))
1418443f2d2SAndrzej Pietrasiewicz pr_info("using host ethernet address: %s", host_addr);
1428443f2d2SAndrzej Pietrasiewicz if (!gether_set_dev_addr(ncm_opts->net, dev_addr))
1438443f2d2SAndrzej Pietrasiewicz pr_info("using self ethernet address: %s", dev_addr);
1448443f2d2SAndrzej Pietrasiewicz
1458443f2d2SAndrzej Pietrasiewicz /* Allocate string descriptor numbers ... note that string
1468443f2d2SAndrzej Pietrasiewicz * contents can be overridden by the composite_dev glue.
1478443f2d2SAndrzej Pietrasiewicz */
1488443f2d2SAndrzej Pietrasiewicz
1498443f2d2SAndrzej Pietrasiewicz status = usb_string_ids_tab(cdev, strings_dev);
1508443f2d2SAndrzej Pietrasiewicz if (status < 0)
1518443f2d2SAndrzej Pietrasiewicz goto fail;
1528443f2d2SAndrzej Pietrasiewicz device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
1538443f2d2SAndrzej Pietrasiewicz device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
1548443f2d2SAndrzej Pietrasiewicz
1551156e91dSLi Jun if (gadget_is_otg(gadget) && !otg_desc[0]) {
1561156e91dSLi Jun struct usb_descriptor_header *usb_desc;
1571156e91dSLi Jun
1581156e91dSLi Jun usb_desc = usb_otg_descriptor_alloc(gadget);
159*e27d4b30SWei Yongjun if (!usb_desc) {
160*e27d4b30SWei Yongjun status = -ENOMEM;
1611156e91dSLi Jun goto fail;
162*e27d4b30SWei Yongjun }
1631156e91dSLi Jun usb_otg_descriptor_init(gadget, usb_desc);
1641156e91dSLi Jun otg_desc[0] = usb_desc;
1651156e91dSLi Jun otg_desc[1] = NULL;
1661156e91dSLi Jun }
1671156e91dSLi Jun
1688443f2d2SAndrzej Pietrasiewicz status = usb_add_config(cdev, &ncm_config_driver,
1698443f2d2SAndrzej Pietrasiewicz ncm_do_config);
1708443f2d2SAndrzej Pietrasiewicz if (status < 0)
1711156e91dSLi Jun goto fail1;
1728443f2d2SAndrzej Pietrasiewicz
1738443f2d2SAndrzej Pietrasiewicz usb_composite_overwrite_options(cdev, &coverwrite);
1748443f2d2SAndrzej Pietrasiewicz dev_info(&gadget->dev, "%s\n", DRIVER_DESC);
1758443f2d2SAndrzej Pietrasiewicz
1768443f2d2SAndrzej Pietrasiewicz return 0;
1778443f2d2SAndrzej Pietrasiewicz
1781156e91dSLi Jun fail1:
1791156e91dSLi Jun kfree(otg_desc[0]);
1801156e91dSLi Jun otg_desc[0] = NULL;
1818443f2d2SAndrzej Pietrasiewicz fail:
1828443f2d2SAndrzej Pietrasiewicz usb_put_function_instance(f_ncm_inst);
1838443f2d2SAndrzej Pietrasiewicz return status;
1848443f2d2SAndrzej Pietrasiewicz }
1858443f2d2SAndrzej Pietrasiewicz
gncm_unbind(struct usb_composite_dev * cdev)186c94e289fSArnd Bergmann static int gncm_unbind(struct usb_composite_dev *cdev)
1878443f2d2SAndrzej Pietrasiewicz {
1888443f2d2SAndrzej Pietrasiewicz if (!IS_ERR_OR_NULL(f_ncm))
1898443f2d2SAndrzej Pietrasiewicz usb_put_function(f_ncm);
1908443f2d2SAndrzej Pietrasiewicz if (!IS_ERR_OR_NULL(f_ncm_inst))
1918443f2d2SAndrzej Pietrasiewicz usb_put_function_instance(f_ncm_inst);
1921156e91dSLi Jun kfree(otg_desc[0]);
1931156e91dSLi Jun otg_desc[0] = NULL;
1941156e91dSLi Jun
1958443f2d2SAndrzej Pietrasiewicz return 0;
1968443f2d2SAndrzej Pietrasiewicz }
1978443f2d2SAndrzej Pietrasiewicz
198c94e289fSArnd Bergmann static struct usb_composite_driver ncm_driver = {
1998443f2d2SAndrzej Pietrasiewicz .name = "g_ncm",
2008443f2d2SAndrzej Pietrasiewicz .dev = &device_desc,
2018443f2d2SAndrzej Pietrasiewicz .strings = dev_strings,
202463f67aeSRoger Quadros .max_speed = USB_SPEED_SUPER,
2038443f2d2SAndrzej Pietrasiewicz .bind = gncm_bind,
204c94e289fSArnd Bergmann .unbind = gncm_unbind,
2058443f2d2SAndrzej Pietrasiewicz };
2068443f2d2SAndrzej Pietrasiewicz
2078443f2d2SAndrzej Pietrasiewicz module_usb_composite_driver(ncm_driver);
2088443f2d2SAndrzej Pietrasiewicz
2098443f2d2SAndrzej Pietrasiewicz MODULE_DESCRIPTION(DRIVER_DESC);
2108443f2d2SAndrzej Pietrasiewicz MODULE_AUTHOR("Yauheni Kaliuta");
2118443f2d2SAndrzej Pietrasiewicz MODULE_LICENSE("GPL");
212