Extend functionality for GET_REPORT
v2 cover Extend functionality for GET_REPORT
This series does the following:
patch 1/2 extends functionality for GET_REPORT.
The current kernel implementation for GET_REPORT is that the kernel sends back a zero filled report (of length == report_length), when the Host request's a particular report from the device/gadget.
This changeset extends functionality for GET_REPORT by sending a particular report based on report type and report number.
patch 2/2 adds a test application to test the extended functionality.
please review and share your thoughts.
version 1 patches:
https://lore.kernel.org/lkml/[email protected]/
Suniel Mahesh (2):
usb: gadget: f_hid: Extend functionality for GET_REPORT mode
HID: ghid: add example program for GET_REPORT
---
Changes for v2:
- patch 2/2 got changed.
drivers/usb/gadget/function/f_hid.c | 184 ++++++++++++++++++++++++++-
include/{ => uapi}/linux/usb/g_hid.h | 10 ++
samples/Kconfig | 10 ++
samples/Makefile | 1 +
samples/ghid/Makefile | 4 +
samples/ghid/test-hid.c | 134 +++++++++++++++++++
6 files changed, 341 insertions(+), 2 deletions(-)
rename include/{ => uapi}/linux/usb/g_hid.h (72%)
create mode 100644 samples/ghid/Makefile
create mode 100644 samples/ghid/test-hid.cSignature · 1 line
2.25.1
RFC v2 1/2 usb: gadget: f_hid: Extend functionality for GET_REPORT mode
The current kernel implementation for GET_REPORT is that the kernel sends back a zero filled report (of length == report_length), when the Host request's a particular report from the device/gadget.
This changeset extends functionality for GET_REPORT by sending a particular report based on report type and report number.
corresponding ioctl is also implemented.
---
Changes for v2:
- Map report type coming from userspace reports to the ones defined in kernel headers.
---
drivers/usb/gadget/function/f_hid.c | 184 ++++++++++++++++++++++++++-
include/{ => uapi}/linux/usb/g_hid.h | 10 ++
2 files changed, 192 insertions(+), 2 deletions(-)
rename include/{ => uapi}/linux/usb/g_hid.h (72%)drivers/usb/gadget/function/f_hid.c +182 -2
@@ -16,6 +16,7 @@#include <linux/wait.h> #include <linux/sched.h> #include <linux/usb/g_hid.h> +#include <linux/uhid.h> #include "u_f.h" #include "u_hid.h"
@@ -27,6 +28,11 @@ static struct class *hidg_class;static DEFINE_IDA (hidg_ida);static DEFINE_MUTEX (hidg_ida_lock);/* protects access to hidg_ida */ +struct report_entry { +struct uhid_set_report_req report_data; +struct list_head node; +}; +/*-------------------------------------------------------------------------*/ /* HID gadget struct */
@@ -71,6 +77,10 @@ struct f_hidg {wait_queue_head_t write_queue;struct usb_request *req; +/* hid report list */ +spinlock_t report_spinlock; +struct list_head report_list; +int minor;struct cdev cdev;struct usb_function func;
@@ -553,6 +563,154 @@ static int f_hidg_open(struct inode *inode, struct file *fd)return 0 ; } +static enum uhid_report_type f_hidg_from_report_to_type (__u8 r_type) +{ +switch (r_type) { +case 1 : +return UHID_FEATURE_REPORT ; +case 2 : +return UHID_OUTPUT_REPORT ; +case 3 : +return UHID_INPUT_REPORT ; +default : +break ; + } +return -EINVAL ; +} + +static bool f_hidg_param_valid (struct report_entry *entry) +{ +enum uhid_report_type report_type; + +if (entry->report_data.size >UHID_DATA_MAX ) +return false; + + report_type =f_hidg_from_report_to_type (entry->report_data.rtype); + +switch (report_type) { +case UHID_FEATURE_REPORT : +case UHID_OUTPUT_REPORT : +case UHID_INPUT_REPORT : +return true; +default : +break ; + } + +return false; +} + +static struct report_entry *f_hidg_search_for_report (struct f_hidg *hidg,u8 rnum,u8 rtype) +{ +struct list_head *ptr; +struct report_entry *entry; + +list_for_each (ptr, &hidg->report_list) { + entry = list_entry(ptr, struct report_entry, node); +if (entry->report_data.rnum == rnum && + entry->report_data.rtype == rtype) { +return entry; + } + } + +return NULL ; +} + +static long f_hidg_ioctl (struct file *file,unsigned int cmd,unsigned long arg) +{ +struct f_hidg *hidg = file->private_data; +struct report_entry *entry; +struct report_entry *ptr; +unsigned long flags; +struct uhid_get_report_req report; +u16 size; + +switch (cmd) { +case GADGET_ADD_REPORT_STATUS : + entry =kmalloc (sizeof (*entry),GFP_KERNEL ); +if (!entry) +return -ENOMEM ; + +if (copy_from_user (&entry->report_data, (struct uhid_set_report_req *)arg, +sizeof (struct uhid_set_report_req ))) { +kfree (entry); +return -EFAULT ; + } + +if (f_hidg_param_valid (entry) == false) { +kfree (entry); +return -EINVAL ; + } + +spin_lock_irqsave (&hidg->report_spinlock, flags); + ptr =f_hidg_search_for_report (hidg, entry->report_data.rnum, + entry->report_data.rtype); +if (ptr) { +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +kfree (ptr); +return -EEXIST ; + } +list_add_tail (&entry->node, &hidg->report_list); +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +break ; +case GADGET_REMOVE_REPORT_STATUS : +spin_lock_irqsave (&hidg->report_spinlock, flags); +if (list_empty (&hidg->report_list)) { +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +return -ENODATA ; + } +spin_unlock_irqrestore (&hidg->report_spinlock, flags); + +if (copy_from_user (&report, (struct uhid_get_report_req *)arg,sizeof (report))) +return -EFAULT ; + +spin_lock_irqsave (&hidg->report_spinlock, flags); + + ptr =f_hidg_search_for_report (hidg, report.rnum, report.rtype); +if (ptr) { +list_del (&ptr->node); + }else { +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +return -ENODATA ; + } +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +kfree (ptr); +break ; +case GADGET_UPDATE_REPORT_STATUS : +spin_lock_irqsave (&hidg->report_spinlock, flags); +if (list_empty (&hidg->report_list)) { +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +return -ENODATA ; + } +spin_unlock_irqrestore (&hidg->report_spinlock, flags); + +if (copy_from_user (&report, (struct uhid_get_report_req *)arg,sizeof (report))) +return -EFAULT ; + +if (copy_from_user (&size, (void __user *)(arg +sizeof (report)),sizeof (size))) +return -EFAULT ; + +if (size >UHID_DATA_MAX ) +return -EINVAL ; + +spin_lock_irqsave (&hidg->report_spinlock, flags); + + ptr =f_hidg_search_for_report (hidg, report.rnum, report.rtype); +if (!ptr) { +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +return -ENODATA ; + } + +if (copy_from_user (&ptr->report_data, (struct uhid_set_report_req *)arg, +sizeof (struct uhid_set_report_req ))) { +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +return -EFAULT ; + } +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +break ; + } +return 0 ; +} +/*-------------------------------------------------------------------------*/ /* usb_function */
@@ -634,6 +792,8 @@ static int hidg_setup(struct usb_function *f,struct f_hidg *hidg =func_to_hidg (f);struct usb_composite_dev *cdev = f->config->cdev;struct usb_request *req = cdev->req; +struct report_entry *entry; +unsigned long flags;int status =0 ;__u16 value, length;
@@ -649,9 +809,25 @@ static int hidg_setup(struct usb_function *f, | HID_REQ_GET_REPORT):VDBG (cdev,"get_report\n" ); -/* send an empty report */ length =min_t (unsigned, length, hidg->report_length); -memset (req->buf,0x0 , length); +spin_lock_irqsave (&hidg->report_spinlock, flags); +if (list_empty (&hidg->report_list)) { +spin_unlock_irqrestore (&hidg->report_spinlock, flags); +memset (req->buf,0x0 , length); + goto respond; + } + + entry =f_hidg_search_for_report (hidg, value &0xf , + value >>8 ); + +/* send a report */ +if (entry) { + length =min_t (unsigned, length, entry->report_data.size); +memcpy (req->buf, entry->report_data.data, length); + }else { +memset (req->buf,0x0 , length); + } +spin_unlock_irqrestore (&hidg->report_spinlock, flags); goto respond;break ;
@@ -893,6 +1069,7 @@ static const struct file_operations f_hidg_fops = { .owner = THIS_MODULE, .open = f_hidg_open, .release = f_hidg_release, + .unlocked_ioctl = f_hidg_ioctl, .write = f_hidg_write, .read = f_hidg_read, .poll = f_hidg_poll,
@@ -997,6 +1174,9 @@ static int hidg_bind(struct usb_configuration *c, struct usb_function *f)init_waitqueue_head (&hidg->read_queue);INIT_LIST_HEAD (&hidg->completed_out_req); +spin_lock_init (&hidg->report_spinlock); +INIT_LIST_HEAD (&hidg->report_list); +/* create char device */ cdev_init (&hidg->cdev, &f_hidg_fops); dev =MKDEV (major, hidg->minor);
include/uapi/linux/usb/g_hid.h renamed from include/linux/usb/g_hid.h +10 -0
@@ -22,6 +22,8 @@ #ifndef __LINUX_USB_G_HID_H #define __LINUX_USB_G_HID_H +#include <linux/uhid.h> + struct hidg_func_descriptor { unsigned char subclass; unsigned char protocol;
@@ -30,4 +32,12 @@ struct hidg_func_descriptor { unsigned char report_desc[]; }; +/* The 'g' code is also used by gadgetfs and printer ioctl requests. +* Don't add any colliding codes to either driver, and keep +* them in unique ranges (size 0x40 for now). +*/ +#define GADGET_ADD_REPORT_STATUS _IOWR('g', 0x41, struct uhid_set_report_req) +#define GADGET_REMOVE_REPORT_STATUS _IOWR('g', 0x42, struct uhid_get_report_req) +#define GADGET_UPDATE_REPORT_STATUS _IOWR('g', 0x43, struct uhid_set_report_req) +#endif /* __LINUX_USB_G_HID_H */
Signature · 1 line
2.25.1
RFC v2 2/2 HID: ghid: add example program for GET_REPORT
In reply to Suniel MaheshThis adds a user-space ghid sample get report program at gadget side. This program sends reports from userspace(gadget side) which are saved in the kernel in a list.
When a host requests a particular report based on report number and type, corresponding report can be send to host, instead of a zero filled in report.
This program can add, delete reports and modify an existing report.
---
Changes for v2:
- no changes
--- samples/Kconfig | 10 +++ samples/Makefile | 1 + samples/ghid/Makefile | 4 ++ samples/ghid/test-hid.c | 134 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 149 insertions(+) create mode 100644 samples/ghid/Makefile create mode 100644 samples/ghid/test-hid.c
samples/Kconfig +10 -0
@@ -86,6 +86,16 @@ config SAMPLE_FPROBE This builds a fprobe example module. This module has an option 'symbol'. You can specify a probed symbol or symbols separated with ','. +config SAMPLE_GHID_GET_REPORT + bool "GHID sample get report" + depends on CC_CAN_LINK && HEADERS_INSTALL + help + Build GHID sample get report program. This program can send reports from + userspace(gadget side) which are saved in the kernel in a linked list. + When a host requests a particular report based on report number and type, + corresponding report can be send to host, instead of a zero filled in report. + This program can add, delete reports and modify an existing report. + config SAMPLE_KFIFO tristate "Build kfifo examples -- loadable modules only" depends on m
samples/Makefile +1 -0
@@ -6,6 +6,7 @@ subdir-$(CONFIG_SAMPLE_ANDROID_BINDERFS) += binderfs obj-$(CONFIG_SAMPLE_CONFIGFS) += configfs/ obj-$(CONFIG_SAMPLE_CONNECTOR) += connector/ obj-$(CONFIG_SAMPLE_FANOTIFY_ERROR) += fanotify/ +subdir-$(SAMPLE_GHID_GET_REPORT) += ghid subdir-$(CONFIG_SAMPLE_HIDRAW) += hidraw obj-$(CONFIG_SAMPLE_HW_BREAKPOINT) += hw_breakpoint/ obj-$(CONFIG_SAMPLE_KDB) += kdb/
samples/ghid/Makefile new file +4 -0
@@ -0,0 +1,4 @@ +# SPDX-License-Identifier: GPL-2.0-only +userprogs-always-y += test-hid + +userccflags += -I usr/include
samples/ghid/test-hid.c new file +134 -0
134 lines not on this page · raw message
Signature · 1 line
2.25.1