1 // SPDX-License-Identifier: GPL-2.0+
3 * f_hid.c -- USB HID function driver
5 * Copyright (C) 2010 Fabien Chouteau <fabien.chouteau@barco.com>
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/hid.h>
11 #include <linux/idr.h>
12 #include <linux/cdev.h>
13 #include <linux/mutex.h>
14 #include <linux/poll.h>
15 #include <linux/uaccess.h>
16 #include <linux/wait.h>
17 #include <linux/sched.h>
18 #include <linux/usb/g_hid.h>
25 static int major, minors;
26 static struct class *hidg_class;
27 static DEFINE_IDA(hidg_ida);
28 static DEFINE_MUTEX(hidg_ida_lock); /* protects access to hidg_ida */
30 /*-------------------------------------------------------------------------*/
31 /* HID gadget struct */
33 struct f_hidg_req_list {
34 struct usb_request *req;
36 struct list_head list;
41 unsigned char bInterfaceSubClass;
42 unsigned char bInterfaceProtocol;
43 unsigned char protocol;
44 unsigned short report_desc_length;
46 unsigned short report_length;
49 struct list_head completed_out_req;
50 spinlock_t read_spinlock;
51 wait_queue_head_t read_queue;
55 spinlock_t write_spinlock;
57 wait_queue_head_t write_queue;
58 struct usb_request *req;
62 struct usb_function func;
65 struct usb_ep *out_ep;
68 static inline struct f_hidg *func_to_hidg(struct usb_function *f)
70 return container_of(f, struct f_hidg, func);
73 /*-------------------------------------------------------------------------*/
74 /* Static descriptors */
76 static struct usb_interface_descriptor hidg_interface_desc = {
77 .bLength = sizeof hidg_interface_desc,
78 .bDescriptorType = USB_DT_INTERFACE,
79 /* .bInterfaceNumber = DYNAMIC */
80 .bAlternateSetting = 0,
82 .bInterfaceClass = USB_CLASS_HID,
83 /* .bInterfaceSubClass = DYNAMIC */
84 /* .bInterfaceProtocol = DYNAMIC */
85 /* .iInterface = DYNAMIC */
88 static struct hid_descriptor hidg_desc = {
89 .bLength = sizeof hidg_desc,
90 .bDescriptorType = HID_DT_HID,
93 .bNumDescriptors = 0x1,
94 /*.desc[0].bDescriptorType = DYNAMIC */
95 /*.desc[0].wDescriptorLenght = DYNAMIC */
98 /* Super-Speed Support */
100 static struct usb_endpoint_descriptor hidg_ss_in_ep_desc = {
101 .bLength = USB_DT_ENDPOINT_SIZE,
102 .bDescriptorType = USB_DT_ENDPOINT,
103 .bEndpointAddress = USB_DIR_IN,
104 .bmAttributes = USB_ENDPOINT_XFER_INT,
105 /*.wMaxPacketSize = DYNAMIC */
106 .bInterval = 4, /* FIXME: Add this field in the
107 * HID gadget configuration?
108 * (struct hidg_func_descriptor)
112 static struct usb_ss_ep_comp_descriptor hidg_ss_in_comp_desc = {
113 .bLength = sizeof(hidg_ss_in_comp_desc),
114 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
116 /* .bMaxBurst = 0, */
117 /* .bmAttributes = 0, */
118 /* .wBytesPerInterval = DYNAMIC */
121 static struct usb_endpoint_descriptor hidg_ss_out_ep_desc = {
122 .bLength = USB_DT_ENDPOINT_SIZE,
123 .bDescriptorType = USB_DT_ENDPOINT,
124 .bEndpointAddress = USB_DIR_OUT,
125 .bmAttributes = USB_ENDPOINT_XFER_INT,
126 /*.wMaxPacketSize = DYNAMIC */
127 .bInterval = 4, /* FIXME: Add this field in the
128 * HID gadget configuration?
129 * (struct hidg_func_descriptor)
133 static struct usb_ss_ep_comp_descriptor hidg_ss_out_comp_desc = {
134 .bLength = sizeof(hidg_ss_out_comp_desc),
135 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
137 /* .bMaxBurst = 0, */
138 /* .bmAttributes = 0, */
139 /* .wBytesPerInterval = DYNAMIC */
142 static struct usb_descriptor_header *hidg_ss_descriptors[] = {
143 (struct usb_descriptor_header *)&hidg_interface_desc,
144 (struct usb_descriptor_header *)&hidg_desc,
145 (struct usb_descriptor_header *)&hidg_ss_in_ep_desc,
146 (struct usb_descriptor_header *)&hidg_ss_in_comp_desc,
147 (struct usb_descriptor_header *)&hidg_ss_out_ep_desc,
148 (struct usb_descriptor_header *)&hidg_ss_out_comp_desc,
152 /* High-Speed Support */
154 static struct usb_endpoint_descriptor hidg_hs_in_ep_desc = {
155 .bLength = USB_DT_ENDPOINT_SIZE,
156 .bDescriptorType = USB_DT_ENDPOINT,
157 .bEndpointAddress = USB_DIR_IN,
158 .bmAttributes = USB_ENDPOINT_XFER_INT,
159 /*.wMaxPacketSize = DYNAMIC */
160 .bInterval = 4, /* FIXME: Add this field in the
161 * HID gadget configuration?
162 * (struct hidg_func_descriptor)
166 static struct usb_endpoint_descriptor hidg_hs_out_ep_desc = {
167 .bLength = USB_DT_ENDPOINT_SIZE,
168 .bDescriptorType = USB_DT_ENDPOINT,
169 .bEndpointAddress = USB_DIR_OUT,
170 .bmAttributes = USB_ENDPOINT_XFER_INT,
171 /*.wMaxPacketSize = DYNAMIC */
172 .bInterval = 4, /* FIXME: Add this field in the
173 * HID gadget configuration?
174 * (struct hidg_func_descriptor)
178 static struct usb_descriptor_header *hidg_hs_descriptors[] = {
179 (struct usb_descriptor_header *)&hidg_interface_desc,
180 (struct usb_descriptor_header *)&hidg_desc,
181 (struct usb_descriptor_header *)&hidg_hs_in_ep_desc,
182 (struct usb_descriptor_header *)&hidg_hs_out_ep_desc,
186 /* Full-Speed Support */
188 static struct usb_endpoint_descriptor hidg_fs_in_ep_desc = {
189 .bLength = USB_DT_ENDPOINT_SIZE,
190 .bDescriptorType = USB_DT_ENDPOINT,
191 .bEndpointAddress = USB_DIR_IN,
192 .bmAttributes = USB_ENDPOINT_XFER_INT,
193 /*.wMaxPacketSize = DYNAMIC */
194 .bInterval = 10, /* FIXME: Add this field in the
195 * HID gadget configuration?
196 * (struct hidg_func_descriptor)
200 static struct usb_endpoint_descriptor hidg_fs_out_ep_desc = {
201 .bLength = USB_DT_ENDPOINT_SIZE,
202 .bDescriptorType = USB_DT_ENDPOINT,
203 .bEndpointAddress = USB_DIR_OUT,
204 .bmAttributes = USB_ENDPOINT_XFER_INT,
205 /*.wMaxPacketSize = DYNAMIC */
206 .bInterval = 10, /* FIXME: Add this field in the
207 * HID gadget configuration?
208 * (struct hidg_func_descriptor)
212 static struct usb_descriptor_header *hidg_fs_descriptors[] = {
213 (struct usb_descriptor_header *)&hidg_interface_desc,
214 (struct usb_descriptor_header *)&hidg_desc,
215 (struct usb_descriptor_header *)&hidg_fs_in_ep_desc,
216 (struct usb_descriptor_header *)&hidg_fs_out_ep_desc,
220 /*-------------------------------------------------------------------------*/
223 #define CT_FUNC_HID_IDX 0
225 static struct usb_string ct_func_string_defs[] = {
226 [CT_FUNC_HID_IDX].s = "HID Interface",
227 {}, /* end of list */
230 static struct usb_gadget_strings ct_func_string_table = {
231 .language = 0x0409, /* en-US */
232 .strings = ct_func_string_defs,
235 static struct usb_gadget_strings *ct_func_strings[] = {
236 &ct_func_string_table,
240 /*-------------------------------------------------------------------------*/
243 static ssize_t f_hidg_read(struct file *file, char __user *buffer,
244 size_t count, loff_t *ptr)
246 struct f_hidg *hidg = file->private_data;
247 struct f_hidg_req_list *list;
248 struct usb_request *req;
255 spin_lock_irqsave(&hidg->read_spinlock, flags);
257 #define READ_COND (!list_empty(&hidg->completed_out_req))
259 /* wait for at least one buffer to complete */
261 spin_unlock_irqrestore(&hidg->read_spinlock, flags);
262 if (file->f_flags & O_NONBLOCK)
265 if (wait_event_interruptible(hidg->read_queue, READ_COND))
268 spin_lock_irqsave(&hidg->read_spinlock, flags);
271 /* pick the first one */
272 list = list_first_entry(&hidg->completed_out_req,
273 struct f_hidg_req_list, list);
276 * Remove this from list to protect it from beign free()
277 * while host disables our function
279 list_del(&list->list);
282 count = min_t(unsigned int, count, req->actual - list->pos);
283 spin_unlock_irqrestore(&hidg->read_spinlock, flags);
285 /* copy to user outside spinlock */
286 count -= copy_to_user(buffer, req->buf + list->pos, count);
290 * if this request is completely handled and transfered to
291 * userspace, remove its entry from the list and requeue it
292 * again. Otherwise, we will revisit it again upon the next
293 * call, taking into account its current read position.
295 if (list->pos == req->actual) {
298 req->length = hidg->report_length;
299 ret = usb_ep_queue(hidg->out_ep, req, GFP_KERNEL);
301 free_ep_req(hidg->out_ep, req);
305 spin_lock_irqsave(&hidg->read_spinlock, flags);
306 list_add(&list->list, &hidg->completed_out_req);
307 spin_unlock_irqrestore(&hidg->read_spinlock, flags);
309 wake_up(&hidg->read_queue);
315 static void f_hidg_req_complete(struct usb_ep *ep, struct usb_request *req)
317 struct f_hidg *hidg = (struct f_hidg *)ep->driver_data;
320 if (req->status != 0) {
321 ERROR(hidg->func.config->cdev,
322 "End Point Request ERROR: %d\n", req->status);
325 spin_lock_irqsave(&hidg->write_spinlock, flags);
326 hidg->write_pending = 0;
327 spin_unlock_irqrestore(&hidg->write_spinlock, flags);
328 wake_up(&hidg->write_queue);
331 static ssize_t f_hidg_write(struct file *file, const char __user *buffer,
332 size_t count, loff_t *offp)
334 struct f_hidg *hidg = file->private_data;
335 struct usb_request *req;
337 ssize_t status = -ENOMEM;
339 spin_lock_irqsave(&hidg->write_spinlock, flags);
341 #define WRITE_COND (!hidg->write_pending)
344 while (!WRITE_COND) {
345 spin_unlock_irqrestore(&hidg->write_spinlock, flags);
346 if (file->f_flags & O_NONBLOCK)
349 if (wait_event_interruptible_exclusive(
350 hidg->write_queue, WRITE_COND))
353 spin_lock_irqsave(&hidg->write_spinlock, flags);
356 hidg->write_pending = 1;
358 count = min_t(unsigned, count, hidg->report_length);
360 spin_unlock_irqrestore(&hidg->write_spinlock, flags);
361 status = copy_from_user(req->buf, buffer, count);
364 ERROR(hidg->func.config->cdev,
365 "copy_from_user error\n");
367 goto release_write_pending;
370 spin_lock_irqsave(&hidg->write_spinlock, flags);
372 /* when our function has been disabled by host */
374 free_ep_req(hidg->in_ep, req);
377 * Should we fail with error here?
385 req->complete = f_hidg_req_complete;
388 spin_unlock_irqrestore(&hidg->write_spinlock, flags);
390 status = usb_ep_queue(hidg->in_ep, req, GFP_ATOMIC);
392 ERROR(hidg->func.config->cdev,
393 "usb_ep_queue error on int endpoint %zd\n", status);
394 goto release_write_pending;
400 release_write_pending:
401 spin_lock_irqsave(&hidg->write_spinlock, flags);
402 hidg->write_pending = 0;
403 spin_unlock_irqrestore(&hidg->write_spinlock, flags);
405 wake_up(&hidg->write_queue);
410 static __poll_t f_hidg_poll(struct file *file, poll_table *wait)
412 struct f_hidg *hidg = file->private_data;
415 poll_wait(file, &hidg->read_queue, wait);
416 poll_wait(file, &hidg->write_queue, wait);
419 ret |= EPOLLOUT | EPOLLWRNORM;
422 ret |= EPOLLIN | EPOLLRDNORM;
430 static int f_hidg_release(struct inode *inode, struct file *fd)
432 fd->private_data = NULL;
436 static int f_hidg_open(struct inode *inode, struct file *fd)
438 struct f_hidg *hidg =
439 container_of(inode->i_cdev, struct f_hidg, cdev);
441 fd->private_data = hidg;
446 /*-------------------------------------------------------------------------*/
449 static inline struct usb_request *hidg_alloc_ep_req(struct usb_ep *ep,
452 return alloc_ep_req(ep, length);
455 static void hidg_set_report_complete(struct usb_ep *ep, struct usb_request *req)
457 struct f_hidg *hidg = (struct f_hidg *) req->context;
458 struct usb_composite_dev *cdev = hidg->func.config->cdev;
459 struct f_hidg_req_list *req_list;
462 switch (req->status) {
464 req_list = kzalloc(sizeof(*req_list), GFP_ATOMIC);
466 ERROR(cdev, "Unable to allocate mem for req_list\n");
472 spin_lock_irqsave(&hidg->read_spinlock, flags);
473 list_add_tail(&req_list->list, &hidg->completed_out_req);
474 spin_unlock_irqrestore(&hidg->read_spinlock, flags);
476 wake_up(&hidg->read_queue);
479 ERROR(cdev, "Set report failed %d\n", req->status);
481 case -ECONNABORTED: /* hardware forced ep reset */
482 case -ECONNRESET: /* request dequeued */
483 case -ESHUTDOWN: /* disconnect from host */
485 free_ep_req(ep, req);
490 static int hidg_setup(struct usb_function *f,
491 const struct usb_ctrlrequest *ctrl)
493 struct f_hidg *hidg = func_to_hidg(f);
494 struct usb_composite_dev *cdev = f->config->cdev;
495 struct usb_request *req = cdev->req;
499 value = __le16_to_cpu(ctrl->wValue);
500 length = __le16_to_cpu(ctrl->wLength);
503 "%s crtl_request : bRequestType:0x%x bRequest:0x%x Value:0x%x\n",
504 __func__, ctrl->bRequestType, ctrl->bRequest, value);
506 switch ((ctrl->bRequestType << 8) | ctrl->bRequest) {
507 case ((USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8
508 | HID_REQ_GET_REPORT):
509 VDBG(cdev, "get_report\n");
511 /* send an empty report */
512 length = min_t(unsigned, length, hidg->report_length);
513 memset(req->buf, 0x0, length);
518 case ((USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8
519 | HID_REQ_GET_PROTOCOL):
520 VDBG(cdev, "get_protocol\n");
521 length = min_t(unsigned int, length, 1);
522 ((u8 *) req->buf)[0] = hidg->protocol;
526 case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8
527 | HID_REQ_SET_REPORT):
528 VDBG(cdev, "set_report | wLength=%d\n", ctrl->wLength);
532 case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8
533 | HID_REQ_SET_PROTOCOL):
534 VDBG(cdev, "set_protocol\n");
535 if (value > HID_REPORT_PROTOCOL)
539 * We assume that programs implementing the Boot protocol
540 * are also compatible with the Report Protocol
542 if (hidg->bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
543 hidg->protocol = value;
549 case ((USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_INTERFACE) << 8
550 | USB_REQ_GET_DESCRIPTOR):
551 switch (value >> 8) {
554 struct hid_descriptor hidg_desc_copy = hidg_desc;
556 VDBG(cdev, "USB_REQ_GET_DESCRIPTOR: HID\n");
557 hidg_desc_copy.desc[0].bDescriptorType = HID_DT_REPORT;
558 hidg_desc_copy.desc[0].wDescriptorLength =
559 cpu_to_le16(hidg->report_desc_length);
561 length = min_t(unsigned short, length,
562 hidg_desc_copy.bLength);
563 memcpy(req->buf, &hidg_desc_copy, length);
568 VDBG(cdev, "USB_REQ_GET_DESCRIPTOR: REPORT\n");
569 length = min_t(unsigned short, length,
570 hidg->report_desc_length);
571 memcpy(req->buf, hidg->report_desc, length);
576 VDBG(cdev, "Unknown descriptor request 0x%x\n",
584 VDBG(cdev, "Unknown request 0x%x\n",
595 req->length = length;
596 status = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
598 ERROR(cdev, "usb_ep_queue error on ep0 %d\n", value);
602 static void hidg_disable(struct usb_function *f)
604 struct f_hidg *hidg = func_to_hidg(f);
605 struct f_hidg_req_list *list, *next;
608 usb_ep_disable(hidg->in_ep);
609 usb_ep_disable(hidg->out_ep);
611 spin_lock_irqsave(&hidg->read_spinlock, flags);
612 list_for_each_entry_safe(list, next, &hidg->completed_out_req, list) {
613 free_ep_req(hidg->out_ep, list->req);
614 list_del(&list->list);
617 spin_unlock_irqrestore(&hidg->read_spinlock, flags);
619 spin_lock_irqsave(&hidg->write_spinlock, flags);
620 if (!hidg->write_pending) {
621 free_ep_req(hidg->in_ep, hidg->req);
622 hidg->write_pending = 1;
626 spin_unlock_irqrestore(&hidg->write_spinlock, flags);
629 static int hidg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
631 struct usb_composite_dev *cdev = f->config->cdev;
632 struct f_hidg *hidg = func_to_hidg(f);
633 struct usb_request *req_in = NULL;
637 VDBG(cdev, "hidg_set_alt intf:%d alt:%d\n", intf, alt);
639 if (hidg->in_ep != NULL) {
640 /* restart endpoint */
641 usb_ep_disable(hidg->in_ep);
643 status = config_ep_by_speed(f->config->cdev->gadget, f,
646 ERROR(cdev, "config_ep_by_speed FAILED!\n");
649 status = usb_ep_enable(hidg->in_ep);
651 ERROR(cdev, "Enable IN endpoint FAILED!\n");
654 hidg->in_ep->driver_data = hidg;
656 req_in = hidg_alloc_ep_req(hidg->in_ep, hidg->report_length);
664 if (hidg->out_ep != NULL) {
665 /* restart endpoint */
666 usb_ep_disable(hidg->out_ep);
668 status = config_ep_by_speed(f->config->cdev->gadget, f,
671 ERROR(cdev, "config_ep_by_speed FAILED!\n");
674 status = usb_ep_enable(hidg->out_ep);
676 ERROR(cdev, "Enable OUT endpoint FAILED!\n");
679 hidg->out_ep->driver_data = hidg;
682 * allocate a bunch of read buffers and queue them all at once.
684 for (i = 0; i < hidg->qlen && status == 0; i++) {
685 struct usb_request *req =
686 hidg_alloc_ep_req(hidg->out_ep,
687 hidg->report_length);
689 req->complete = hidg_set_report_complete;
691 status = usb_ep_queue(hidg->out_ep, req,
694 ERROR(cdev, "%s queue req --> %d\n",
695 hidg->out_ep->name, status);
696 free_ep_req(hidg->out_ep, req);
705 if (hidg->in_ep != NULL) {
706 spin_lock_irqsave(&hidg->write_spinlock, flags);
708 hidg->write_pending = 0;
709 spin_unlock_irqrestore(&hidg->write_spinlock, flags);
711 wake_up(&hidg->write_queue);
715 usb_ep_disable(hidg->out_ep);
718 free_ep_req(hidg->in_ep, req_in);
722 usb_ep_disable(hidg->in_ep);
728 static const struct file_operations f_hidg_fops = {
729 .owner = THIS_MODULE,
731 .release = f_hidg_release,
732 .write = f_hidg_write,
735 .llseek = noop_llseek,
738 static int hidg_bind(struct usb_configuration *c, struct usb_function *f)
741 struct f_hidg *hidg = func_to_hidg(f);
742 struct usb_string *us;
743 struct device *device;
747 /* maybe allocate device-global string IDs, and patch descriptors */
748 us = usb_gstrings_attach(c->cdev, ct_func_strings,
749 ARRAY_SIZE(ct_func_string_defs));
752 hidg_interface_desc.iInterface = us[CT_FUNC_HID_IDX].id;
754 /* allocate instance-specific interface IDs, and patch descriptors */
755 status = usb_interface_id(c, f);
758 hidg_interface_desc.bInterfaceNumber = status;
760 /* allocate instance-specific endpoints */
762 ep = usb_ep_autoconfig(c->cdev->gadget, &hidg_fs_in_ep_desc);
767 ep = usb_ep_autoconfig(c->cdev->gadget, &hidg_fs_out_ep_desc);
772 /* set descriptor dynamic values */
773 hidg_interface_desc.bInterfaceSubClass = hidg->bInterfaceSubClass;
774 hidg_interface_desc.bInterfaceProtocol = hidg->bInterfaceProtocol;
775 hidg->protocol = HID_REPORT_PROTOCOL;
776 hidg_ss_in_ep_desc.wMaxPacketSize = cpu_to_le16(hidg->report_length);
777 hidg_ss_in_comp_desc.wBytesPerInterval =
778 cpu_to_le16(hidg->report_length);
779 hidg_hs_in_ep_desc.wMaxPacketSize = cpu_to_le16(hidg->report_length);
780 hidg_fs_in_ep_desc.wMaxPacketSize = cpu_to_le16(hidg->report_length);
781 hidg_ss_out_ep_desc.wMaxPacketSize = cpu_to_le16(hidg->report_length);
782 hidg_ss_out_comp_desc.wBytesPerInterval =
783 cpu_to_le16(hidg->report_length);
784 hidg_hs_out_ep_desc.wMaxPacketSize = cpu_to_le16(hidg->report_length);
785 hidg_fs_out_ep_desc.wMaxPacketSize = cpu_to_le16(hidg->report_length);
787 * We can use hidg_desc struct here but we should not relay
788 * that its content won't change after returning from this function.
790 hidg_desc.desc[0].bDescriptorType = HID_DT_REPORT;
791 hidg_desc.desc[0].wDescriptorLength =
792 cpu_to_le16(hidg->report_desc_length);
794 hidg_hs_in_ep_desc.bEndpointAddress =
795 hidg_fs_in_ep_desc.bEndpointAddress;
796 hidg_hs_out_ep_desc.bEndpointAddress =
797 hidg_fs_out_ep_desc.bEndpointAddress;
799 hidg_ss_in_ep_desc.bEndpointAddress =
800 hidg_fs_in_ep_desc.bEndpointAddress;
801 hidg_ss_out_ep_desc.bEndpointAddress =
802 hidg_fs_out_ep_desc.bEndpointAddress;
804 status = usb_assign_descriptors(f, hidg_fs_descriptors,
805 hidg_hs_descriptors, hidg_ss_descriptors, NULL);
809 spin_lock_init(&hidg->write_spinlock);
810 hidg->write_pending = 1;
812 spin_lock_init(&hidg->read_spinlock);
813 init_waitqueue_head(&hidg->write_queue);
814 init_waitqueue_head(&hidg->read_queue);
815 INIT_LIST_HEAD(&hidg->completed_out_req);
817 /* create char device */
818 cdev_init(&hidg->cdev, &f_hidg_fops);
819 dev = MKDEV(major, hidg->minor);
820 status = cdev_add(&hidg->cdev, dev, 1);
822 goto fail_free_descs;
824 device = device_create(hidg_class, NULL, dev, NULL,
825 "%s%d", "hidg", hidg->minor);
826 if (IS_ERR(device)) {
827 status = PTR_ERR(device);
833 cdev_del(&hidg->cdev);
835 usb_free_all_descriptors(f);
837 ERROR(f->config->cdev, "hidg_bind FAILED\n");
838 if (hidg->req != NULL)
839 free_ep_req(hidg->in_ep, hidg->req);
844 static inline int hidg_get_minor(void)
848 ret = ida_simple_get(&hidg_ida, 0, 0, GFP_KERNEL);
849 if (ret >= HIDG_MINORS) {
850 ida_simple_remove(&hidg_ida, ret);
857 static inline struct f_hid_opts *to_f_hid_opts(struct config_item *item)
859 return container_of(to_config_group(item), struct f_hid_opts,
863 static void hid_attr_release(struct config_item *item)
865 struct f_hid_opts *opts = to_f_hid_opts(item);
867 usb_put_function_instance(&opts->func_inst);
870 static struct configfs_item_operations hidg_item_ops = {
871 .release = hid_attr_release,
874 #define F_HID_OPT(name, prec, limit) \
875 static ssize_t f_hid_opts_##name##_show(struct config_item *item, char *page)\
877 struct f_hid_opts *opts = to_f_hid_opts(item); \
880 mutex_lock(&opts->lock); \
881 result = sprintf(page, "%d\n", opts->name); \
882 mutex_unlock(&opts->lock); \
887 static ssize_t f_hid_opts_##name##_store(struct config_item *item, \
888 const char *page, size_t len) \
890 struct f_hid_opts *opts = to_f_hid_opts(item); \
894 mutex_lock(&opts->lock); \
895 if (opts->refcnt) { \
900 ret = kstrtou##prec(page, 0, &num); \
912 mutex_unlock(&opts->lock); \
916 CONFIGFS_ATTR(f_hid_opts_, name)
918 F_HID_OPT(subclass, 8, 255);
919 F_HID_OPT(protocol, 8, 255);
920 F_HID_OPT(report_length, 16, 65535);
922 static ssize_t f_hid_opts_report_desc_show(struct config_item *item, char *page)
924 struct f_hid_opts *opts = to_f_hid_opts(item);
927 mutex_lock(&opts->lock);
928 result = opts->report_desc_length;
929 memcpy(page, opts->report_desc, opts->report_desc_length);
930 mutex_unlock(&opts->lock);
935 static ssize_t f_hid_opts_report_desc_store(struct config_item *item,
936 const char *page, size_t len)
938 struct f_hid_opts *opts = to_f_hid_opts(item);
942 mutex_lock(&opts->lock);
946 if (len > PAGE_SIZE) {
950 d = kmemdup(page, len, GFP_KERNEL);
955 kfree(opts->report_desc);
956 opts->report_desc = d;
957 opts->report_desc_length = len;
958 opts->report_desc_alloc = true;
961 mutex_unlock(&opts->lock);
965 CONFIGFS_ATTR(f_hid_opts_, report_desc);
967 static ssize_t f_hid_opts_dev_show(struct config_item *item, char *page)
969 struct f_hid_opts *opts = to_f_hid_opts(item);
971 return sprintf(page, "%d:%d\n", major, opts->minor);
974 CONFIGFS_ATTR_RO(f_hid_opts_, dev);
976 static struct configfs_attribute *hid_attrs[] = {
977 &f_hid_opts_attr_subclass,
978 &f_hid_opts_attr_protocol,
979 &f_hid_opts_attr_report_length,
980 &f_hid_opts_attr_report_desc,
981 &f_hid_opts_attr_dev,
985 static const struct config_item_type hid_func_type = {
986 .ct_item_ops = &hidg_item_ops,
987 .ct_attrs = hid_attrs,
988 .ct_owner = THIS_MODULE,
991 static inline void hidg_put_minor(int minor)
993 ida_simple_remove(&hidg_ida, minor);
996 static void hidg_free_inst(struct usb_function_instance *f)
998 struct f_hid_opts *opts;
1000 opts = container_of(f, struct f_hid_opts, func_inst);
1002 mutex_lock(&hidg_ida_lock);
1004 hidg_put_minor(opts->minor);
1005 if (ida_is_empty(&hidg_ida))
1008 mutex_unlock(&hidg_ida_lock);
1010 if (opts->report_desc_alloc)
1011 kfree(opts->report_desc);
1016 static struct usb_function_instance *hidg_alloc_inst(void)
1018 struct f_hid_opts *opts;
1019 struct usb_function_instance *ret;
1022 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
1024 return ERR_PTR(-ENOMEM);
1025 mutex_init(&opts->lock);
1026 opts->func_inst.free_func_inst = hidg_free_inst;
1027 ret = &opts->func_inst;
1029 mutex_lock(&hidg_ida_lock);
1031 if (ida_is_empty(&hidg_ida)) {
1032 status = ghid_setup(NULL, HIDG_MINORS);
1034 ret = ERR_PTR(status);
1040 opts->minor = hidg_get_minor();
1041 if (opts->minor < 0) {
1042 ret = ERR_PTR(opts->minor);
1044 if (ida_is_empty(&hidg_ida))
1048 config_group_init_type_name(&opts->func_inst.group, "", &hid_func_type);
1051 mutex_unlock(&hidg_ida_lock);
1055 static void hidg_free(struct usb_function *f)
1057 struct f_hidg *hidg;
1058 struct f_hid_opts *opts;
1060 hidg = func_to_hidg(f);
1061 opts = container_of(f->fi, struct f_hid_opts, func_inst);
1062 kfree(hidg->report_desc);
1064 mutex_lock(&opts->lock);
1066 mutex_unlock(&opts->lock);
1069 static void hidg_unbind(struct usb_configuration *c, struct usb_function *f)
1071 struct f_hidg *hidg = func_to_hidg(f);
1073 device_destroy(hidg_class, MKDEV(major, hidg->minor));
1074 cdev_del(&hidg->cdev);
1076 usb_free_all_descriptors(f);
1079 static struct usb_function *hidg_alloc(struct usb_function_instance *fi)
1081 struct f_hidg *hidg;
1082 struct f_hid_opts *opts;
1084 /* allocate and initialize one new instance */
1085 hidg = kzalloc(sizeof(*hidg), GFP_KERNEL);
1087 return ERR_PTR(-ENOMEM);
1089 opts = container_of(fi, struct f_hid_opts, func_inst);
1091 mutex_lock(&opts->lock);
1094 hidg->minor = opts->minor;
1095 hidg->bInterfaceSubClass = opts->subclass;
1096 hidg->bInterfaceProtocol = opts->protocol;
1097 hidg->report_length = opts->report_length;
1098 hidg->report_desc_length = opts->report_desc_length;
1099 if (opts->report_desc) {
1100 hidg->report_desc = kmemdup(opts->report_desc,
1101 opts->report_desc_length,
1103 if (!hidg->report_desc) {
1105 mutex_unlock(&opts->lock);
1106 return ERR_PTR(-ENOMEM);
1110 mutex_unlock(&opts->lock);
1112 hidg->func.name = "hid";
1113 hidg->func.bind = hidg_bind;
1114 hidg->func.unbind = hidg_unbind;
1115 hidg->func.set_alt = hidg_set_alt;
1116 hidg->func.disable = hidg_disable;
1117 hidg->func.setup = hidg_setup;
1118 hidg->func.free_func = hidg_free;
1120 /* this could me made configurable at some point */
1126 DECLARE_USB_FUNCTION_INIT(hid, hidg_alloc_inst, hidg_alloc);
1127 MODULE_LICENSE("GPL");
1128 MODULE_AUTHOR("Fabien Chouteau");
1130 int ghid_setup(struct usb_gadget *g, int count)
1135 hidg_class = class_create(THIS_MODULE, "hidg");
1136 if (IS_ERR(hidg_class)) {
1137 status = PTR_ERR(hidg_class);
1142 status = alloc_chrdev_region(&dev, 0, count, "hidg");
1144 class_destroy(hidg_class);
1155 void ghid_cleanup(void)
1158 unregister_chrdev_region(MKDEV(major, 0), minors);
1162 class_destroy(hidg_class);