1 // SPDX-License-Identifier: GPL-2.0+
3 * hid.c -- HID Composite driver
7 * Copyright (C) 2010 Fabien Chouteau <fabien.chouteau@barco.com>
11 #include <linux/kernel.h>
12 #include <linux/platform_device.h>
13 #include <linux/list.h>
14 #include <linux/module.h>
15 #include <linux/usb/composite.h>
16 #include <linux/usb/g_hid.h>
18 #define DRIVER_DESC "HID Gadget"
19 #define DRIVER_VERSION "2010/03/16"
23 /*-------------------------------------------------------------------------*/
25 #define HIDG_VENDOR_NUM 0x0525 /* XXX NetChip */
26 #define HIDG_PRODUCT_NUM 0xa4ac /* Linux-USB HID gadget */
28 /*-------------------------------------------------------------------------*/
30 struct hidg_func_node {
31 struct usb_function_instance *fi;
32 struct usb_function *f;
33 struct list_head node;
34 struct hidg_func_descriptor *func;
37 static LIST_HEAD(hidg_func_list);
39 /*-------------------------------------------------------------------------*/
40 USB_GADGET_COMPOSITE_OPTIONS();
42 static struct usb_device_descriptor device_desc = {
43 .bLength = sizeof device_desc,
44 .bDescriptorType = USB_DT_DEVICE,
46 /* .bcdUSB = DYNAMIC */
48 /* .bDeviceClass = USB_CLASS_COMM, */
49 /* .bDeviceSubClass = 0, */
50 /* .bDeviceProtocol = 0, */
51 .bDeviceClass = USB_CLASS_PER_INTERFACE,
54 /* .bMaxPacketSize0 = f(hardware) */
56 /* Vendor and product id can be overridden by module parameters. */
57 .idVendor = cpu_to_le16(HIDG_VENDOR_NUM),
58 .idProduct = cpu_to_le16(HIDG_PRODUCT_NUM),
59 /* .bcdDevice = f(hardware) */
60 /* .iManufacturer = DYNAMIC */
61 /* .iProduct = DYNAMIC */
62 /* NO SERIAL NUMBER */
63 .bNumConfigurations = 1,
66 static const struct usb_descriptor_header *otg_desc[2];
68 /* string IDs are assigned dynamically */
69 static struct usb_string strings_dev[] = {
70 [USB_GADGET_MANUFACTURER_IDX].s = "",
71 [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
72 [USB_GADGET_SERIAL_IDX].s = "",
76 static struct usb_gadget_strings stringtab_dev = {
77 .language = 0x0409, /* en-us */
78 .strings = strings_dev,
81 static struct usb_gadget_strings *dev_strings[] = {
88 /****************************** Configurations ******************************/
90 static int do_config(struct usb_configuration *c)
92 struct hidg_func_node *e, *n;
95 if (gadget_is_otg(c->cdev->gadget)) {
96 c->descriptors = otg_desc;
97 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
100 list_for_each_entry(e, &hidg_func_list, node) {
101 e->f = usb_get_function(e->fi);
103 status = PTR_ERR(e->f);
106 status = usb_add_function(c, e->f);
108 usb_put_function(e->f);
115 list_for_each_entry(n, &hidg_func_list, node) {
118 usb_remove_function(c, n->f);
119 usb_put_function(n->f);
124 static struct usb_configuration config_driver = {
125 .label = "HID Gadget",
126 .bConfigurationValue = 1,
127 /* .iConfiguration = DYNAMIC */
128 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
131 /****************************** Gadget Bind ******************************/
133 static int hid_bind(struct usb_composite_dev *cdev)
135 struct usb_gadget *gadget = cdev->gadget;
136 struct list_head *tmp;
137 struct hidg_func_node *n, *m;
138 struct f_hid_opts *hid_opts;
139 int status, funcs = 0;
141 list_for_each(tmp, &hidg_func_list)
147 list_for_each_entry(n, &hidg_func_list, node) {
148 n->fi = usb_get_function_instance("hid");
150 status = PTR_ERR(n->fi);
153 hid_opts = container_of(n->fi, struct f_hid_opts, func_inst);
154 hid_opts->subclass = n->func->subclass;
155 hid_opts->protocol = n->func->protocol;
156 hid_opts->report_length = n->func->report_length;
157 hid_opts->report_desc_length = n->func->report_desc_length;
158 hid_opts->report_desc = n->func->report_desc;
162 /* Allocate string descriptor numbers ... note that string
163 * contents can be overridden by the composite_dev glue.
166 status = usb_string_ids_tab(cdev, strings_dev);
169 device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
170 device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
172 if (gadget_is_otg(gadget) && !otg_desc[0]) {
173 struct usb_descriptor_header *usb_desc;
175 usb_desc = usb_otg_descriptor_alloc(gadget);
180 usb_otg_descriptor_init(gadget, usb_desc);
181 otg_desc[0] = usb_desc;
185 /* register our configuration */
186 status = usb_add_config(cdev, &config_driver, do_config);
190 usb_composite_overwrite_options(cdev, &coverwrite);
191 dev_info(&gadget->dev, DRIVER_DESC ", version: " DRIVER_VERSION "\n");
199 list_for_each_entry(m, &hidg_func_list, node) {
202 usb_put_function_instance(m->fi);
207 static int hid_unbind(struct usb_composite_dev *cdev)
209 struct hidg_func_node *n;
211 list_for_each_entry(n, &hidg_func_list, node) {
212 usb_put_function(n->f);
213 usb_put_function_instance(n->fi);
222 static int hidg_plat_driver_probe(struct platform_device *pdev)
224 struct hidg_func_descriptor *func = dev_get_platdata(&pdev->dev);
225 struct hidg_func_node *entry;
228 dev_err(&pdev->dev, "Platform data missing\n");
232 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
237 list_add_tail(&entry->node, &hidg_func_list);
242 static int hidg_plat_driver_remove(struct platform_device *pdev)
244 struct hidg_func_node *e, *n;
246 list_for_each_entry_safe(e, n, &hidg_func_list, node) {
255 /****************************** Some noise ******************************/
258 static struct usb_composite_driver hidg_driver = {
261 .strings = dev_strings,
262 .max_speed = USB_SPEED_HIGH,
264 .unbind = hid_unbind,
267 static struct platform_driver hidg_plat_driver = {
268 .remove = hidg_plat_driver_remove,
275 MODULE_DESCRIPTION(DRIVER_DESC);
276 MODULE_AUTHOR("Fabien Chouteau, Peter Korsgaard");
277 MODULE_LICENSE("GPL");
279 static int __init hidg_init(void)
283 status = platform_driver_probe(&hidg_plat_driver,
284 hidg_plat_driver_probe);
288 status = usb_composite_probe(&hidg_driver);
290 platform_driver_unregister(&hidg_plat_driver);
294 module_init(hidg_init);
296 static void __exit hidg_cleanup(void)
298 usb_composite_unregister(&hidg_driver);
299 platform_driver_unregister(&hidg_plat_driver);
301 module_exit(hidg_cleanup);