From patchwork Mon Aug 1 12:30:09 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Suniel Mahesh X-Patchwork-Id: 2288 Return-Path: X-Original-To: linux-amarula@patchwork.amarulasolutions.com Delivered-To: linux-amarula@patchwork.amarulasolutions.com Received: from mail-pj1-f72.google.com (mail-pj1-f72.google.com [209.85.216.72]) by ganimede.amarulasolutions.com (Postfix) with ESMTPS id 549B83F3A4 for ; Mon, 1 Aug 2022 14:30:28 +0200 (CEST) Received: by mail-pj1-f72.google.com with SMTP id i12-20020a17090a4b8c00b001f20db22239sf6165031pjh.3 for ; Mon, 01 Aug 2022 05:30:28 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1659357027; cv=pass; d=google.com; s=arc-20160816; b=zb2XOTc7A9A8UY00w/Yt6xvP1jVEqy1OJLpmFuRtSJYE9JP+YXFrsEom7IJWPUWo2N +iMQ/JGLkzdGAgXRVMYZJZ70ssMi+6tZ/kZflhC4j63tqWRvGLLmXgPaZSWMyOmz6Be4 CW8rijMNgL6H2R1Qj0Nvbu6wedRjM/lxa63x8tQIVKu6Mwu3vzsI5g8PEhDss5LPSbPE i8npn4U9y8tTrHTqgVnRPh9WHKWP/cvhHLbTGPQFXYI1RUOFhhYazcx/9U8G15CzreKQ 96qXhCtxxb6Mn6SgxMinx9HCaqmozMOIs1K+YsuvB8q0KxlaWVFTNLMgNIL7l+9ODZjC +UZQ== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-archive:list-help:list-post:list-id :mailing-list:precedence:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:dkim-signature; bh=+2eLENZE3abrwYaSO4MSAKdevHpe0DopHolLK3zBrB0=; b=x6ZnxQdQbUlp6jZxhVkFQU0vK3QaldHmK3JKKAzVTkJt7FlE+bfPZn9acAeErFPAde nqjG8E1GecZPZnBjs4WQFr3qvklS5qoU1sarnIxBmm7HZT9VRoWdzc3OvE/b6ypdNMfh EssjP7WRFc2976XH7b6r8bMDOx1rTNfntMdQxV2CUKeFXO9QEuZ/gzq4Uts1Ovt4uEkb 6xfDsYbGcVonmiuvO/tT35QCALa9W8LtVIXB4EmkQHUEbcY6bc7tThSZUY9nVvdh9Opl CY2gjXSwrzZOzqZYm10WkH+0i4guh3vo0hd+McMHPkKzPZxnbYDwr6ZfhTG2VuwCHUFQ LTOw== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@amarulasolutions.com header.s=google header.b=GgGkvY84; spf=pass (google.com: domain of sunil@amarulasolutions.com designates 209.85.220.41 as permitted sender) smtp.mailfrom=sunil@amarulasolutions.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=amarulasolutions.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amarulasolutions.com; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:x-original-sender:x-original-authentication-results :precedence:mailing-list:list-id:list-post:list-help:list-archive :list-unsubscribe; bh=+2eLENZE3abrwYaSO4MSAKdevHpe0DopHolLK3zBrB0=; b=DzXv6/XwsL/O+rgp14lE7sR3rqhTjnPr0dTj1UWfXYDq8ktzajTspMU/ycSN8O++Qz pf1D7JQUOqDnX8i92RdSZiapSw4h5ByibfEcqWoYMZSBVonIS0S9FkMGgN8+JFZCFPSL rpj2Hwu48wW9FRjPadTxKVOhcfugHDdpO84zE= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:x-original-sender :x-original-authentication-results:precedence:mailing-list:list-id :x-spam-checked-in-group:list-post:list-help:list-archive :list-unsubscribe; bh=+2eLENZE3abrwYaSO4MSAKdevHpe0DopHolLK3zBrB0=; b=QKUVG4iTb0Y4zkQoE/IDT6xjKT2kfoOV17gjxvjMLGiWu4dB11z89INSyIusJB7RUN XgQG5ztc0umFguak++J20O2GrHvKdv3CNqkuY961I6ZztFznG54z64dbraANgZW30vbq Nkhzo6Mhj4HHUkE6IZh55uysqJHpyFrAYrEV3NOXyZq7wFT09sW3nsYPec/ukOeWkt7g KOTfN1tbIPkFu7vYArKgXdousyhC7J2ULiNv9ckfQbKYVL7twPqAt7BWL+OkNOm/4rCb V1Om1fsP7Baj30L5vV8P6EFpTm5hKLYt/fj8XbBcBOPOAEPg362qFMHN7OiVev9SXjfF nuEg== X-Gm-Message-State: ACgBeo1YUYdCqSD1/TSbYkUrrrFAq4E8/CVZJovmWpq863m1b7gBV7Cn kVgV1kVKXOEiltyzmaJUeXEv3sRX X-Google-Smtp-Source: AA6agR661Mzz6ZQfVt8ceUWHGe/NbAYKfUZvBIDwjxDiF8CLKuWZU6vtgNKO7bU+O1jOjFizKrSRZg== X-Received: by 2002:a17:903:1209:b0:16b:81f6:e952 with SMTP id l9-20020a170903120900b0016b81f6e952mr16980655plh.48.1659357026938; Mon, 01 Aug 2022 05:30:26 -0700 (PDT) X-BeenThere: linux-amarula@amarulasolutions.com Received: by 2002:a62:54c7:0:b0:52c:e9ef:c7b8 with SMTP id i190-20020a6254c7000000b0052ce9efc7b8ls3035617pfb.11.-pod-prod-gmail; Mon, 01 Aug 2022 05:30:26 -0700 (PDT) X-Received: by 2002:a63:8749:0:b0:41b:a3b9:78ae with SMTP id i70-20020a638749000000b0041ba3b978aemr11290302pge.252.1659357025947; Mon, 01 Aug 2022 05:30:25 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1659357025; cv=none; d=google.com; s=arc-20160816; b=ltiqm3CEsorYvhBrm8B9ybpZ3GYvIpezPZjXGnpNd5UmseRMRisQjo3ASlHMI0BM89 ePC+2ut95cT1zUzBnQhOlKvd9xRXMUQEKlnEuDfgNTuFEMUonrHtweWp7dR2S1/V+10q s0wU/L2eSPzAhkp270+wKl4QBPygXGFPaKD5pJcycYGYcKIhD5Nz8MjToGX/Sni7B42i tShD66Ubmn3NbLFzKenVU7+JTWMmGLte7FaoLgAC1lM3pFjHdCxdUcDSVQAleny09teO fj2Jv/guSJERzMrGT/DTT6xcEx0//lMq+z19GjP/Gr8YONhQdYDPr+326siI/qpGuZ+9 dNJA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:dkim-signature; bh=7o91HERS/4hsq8FU5w5VEekCf+JsdrZ+o3ocEJkypqs=; b=zSSMlKO2C3FpW7tM00Xnto50pH0V/KlYMWRWAhIQJOgLSctzIhXn8QptXh24DBC3SA 2lbmLbpry1/5B1nMGNyFJFNrU6A3mLi2i2q6mY5DD2rzhCVMb4P46/riRSy3ZsGY62IS 3i696S3sbBcMJY7gvMI70lf3msg74B4fwGmOCk7e/o4GCAce6vNH/IrJSbxg1rGDlH9f SeEl+/iaf0I+I9pYuIWRrSo/j2+eD4Sn9U4Jd66uJ9qQCzPWh28mLJKhfbpUWZ2qA8OZ RxcmPVpsuTpu+vt2W74AzLaX/6x5AnY+/KkZaSOPzSuWXOPTU3HzRt8VJ/HNc9MA0EsN 7Lfw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@amarulasolutions.com header.s=google header.b=GgGkvY84; spf=pass (google.com: domain of sunil@amarulasolutions.com designates 209.85.220.41 as permitted sender) smtp.mailfrom=sunil@amarulasolutions.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=amarulasolutions.com Received: from mail-sor-f41.google.com (mail-sor-f41.google.com. [209.85.220.41]) by mx.google.com with SMTPS id iz9-20020a170902ef8900b0016c433f7c0fsor4623008plb.160.2022.08.01.05.30.25 for (Google Transport Security); Mon, 01 Aug 2022 05:30:25 -0700 (PDT) Received-SPF: pass (google.com: domain of sunil@amarulasolutions.com designates 209.85.220.41 as permitted sender) client-ip=209.85.220.41; X-Received: by 2002:a17:90b:3c1:b0:1f3:17bd:2e5b with SMTP id go1-20020a17090b03c100b001f317bd2e5bmr19069861pjb.107.1659357025540; Mon, 01 Aug 2022 05:30:25 -0700 (PDT) Received: from localhost.localdomain ([183.83.136.224]) by smtp.gmail.com with ESMTPSA id a14-20020a1709027e4e00b0015e8d4eb219sm3473230pln.99.2022.08.01.05.30.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Aug 2022 05:30:25 -0700 (PDT) From: Suniel Mahesh To: Felipe Balbi , Greg Kroah-Hartman , Michael Trimarchi , Jagan Teki Cc: linux-kernel@vger.kernel.org, linux-amarula@amarulasolutions.com, USB list Subject: [RFC 1/2] usb: gadget: f_hid: Extend functionality for GET_REPORT mode Date: Mon, 1 Aug 2022 18:00:09 +0530 Message-Id: <20220801123010.2984864-2-sunil@amarulasolutions.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220801123010.2984864-1-sunil@amarulasolutions.com> References: <20220801123010.2984864-1-sunil@amarulasolutions.com> MIME-Version: 1.0 X-Original-Sender: sunil@amarulasolutions.com X-Original-Authentication-Results: mx.google.com; dkim=pass header.i=@amarulasolutions.com header.s=google header.b=GgGkvY84; spf=pass (google.com: domain of sunil@amarulasolutions.com designates 209.85.220.41 as permitted sender) smtp.mailfrom=sunil@amarulasolutions.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=amarulasolutions.com Content-Type: text/plain; charset="UTF-8" Precedence: list Mailing-list: list linux-amarula@amarulasolutions.com; contact linux-amarula+owners@amarulasolutions.com List-ID: X-Spam-Checked-In-Group: linux-amarula@amarulasolutions.com X-Google-Group-Id: 476853432473 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , 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. Signed-off-by: Suniel Mahesh Signed-off-by: Michael Trimarchi --- drivers/usb/gadget/function/f_hid.c | 166 ++++++++++++++++++++++++++- include/{ => uapi}/linux/usb/g_hid.h | 10 ++ 2 files changed, 174 insertions(+), 2 deletions(-) rename include/{ => uapi}/linux/usb/g_hid.h (72%) diff --git a/drivers/usb/gadget/function/f_hid.c b/drivers/usb/gadget/function/f_hid.c index ca0a7d9eaa34..70787c73caf9 100644 --- a/drivers/usb/gadget/function/f_hid.c +++ b/drivers/usb/gadget/function/f_hid.c @@ -16,6 +16,7 @@ #include #include #include +#include #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,136 @@ static int f_hidg_open(struct inode *inode, struct file *fd) return 0; } +static bool f_hidg_param_valid(struct report_entry *entry) +{ + + if (entry->report_data.size > UHID_DATA_MAX) + return false; + + switch (entry->report_data.rtype) { + 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 +774,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 +791,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 +1051,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 +1156,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); diff --git a/include/linux/usb/g_hid.h b/include/uapi/linux/usb/g_hid.h similarity index 72% rename from include/linux/usb/g_hid.h rename to include/uapi/linux/usb/g_hid.h index 7581e488c237..ba3e47f076bb 100644 --- a/include/linux/usb/g_hid.h +++ b/include/uapi/linux/usb/g_hid.h @@ -22,6 +22,8 @@ #ifndef __LINUX_USB_G_HID_H #define __LINUX_USB_G_HID_H +#include + 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 */