From patchwork Tue Aug 2 20:15:55 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Suniel Mahesh X-Patchwork-Id: 2291 Return-Path: X-Original-To: linux-amarula@patchwork.amarulasolutions.com Delivered-To: linux-amarula@patchwork.amarulasolutions.com Received: from mail-pj1-f71.google.com (mail-pj1-f71.google.com [209.85.216.71]) by ganimede.amarulasolutions.com (Postfix) with ESMTPS id 02E9F3F1D0 for ; Tue, 2 Aug 2022 22:16:14 +0200 (CEST) Received: by mail-pj1-f71.google.com with SMTP id co4-20020a17090afe8400b001f4df09d662sf3466299pjb.2 for ; Tue, 02 Aug 2022 13:16:13 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1659471372; cv=pass; d=google.com; s=arc-20160816; b=RHTA1lxOJfezSFhf7grkcnlKb49qd7Q05zvz5hC0ntkN8bqZTGNwViVtfBh2IZ47Ho 6+AyEg56DythPgpkxsG1QeZg+FpCbOr2zTH7nfHymGGnS6FPP9VhiRZ0TJKjQQ7vTHZu sZyeJOt2ML6wLrddCbCxLYQiEjWEH42EQQacyVuL932XGS9hMjTNWOrFWcAQuzUAR8W2 TkBDuSZZ/QuVRJnafBvve0+laZqcp6p7ZhJAOMeHMsb+5hF+ISlqIHGLyuuddAjW+Wzk noPEoY6JmxeXjaNDVYvVOBEmSFtbnpjFXXBaqmvoDonv4LSdJW5F73RPW9w/ysfALnEJ UDzA== 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=iGg6OUUnvntvb/BYdqgreZzlc1nI7pRwM5cD1HPw4IQ=; b=B7sOEF7UKslxJanRWjLajGGRyovNoWONU3/o7bXdaVx1YxAyc+3sMNB0i5XAljO+wc yB7EI+CeRm+MXBxytA2LChL7hzgJq8M6ij9yUv37mYxg1odUgD7uqSHJszl8w3+JmVTo jqvIB/mUbA1eFTb4u8qjTzax74auY6sOF0BHpVYPOQOmlYV+9wivOTf18x7NCR18yM0Q Y79yJjgDssI0wDCrSKEKYKBZ87UIb8whZuD5CuJhQBfElLR1uudIF0WurPZbp1etM9qR ojlVIzHb0uxpk3BZOTS5uxBBpUgKQaIY1sfWoE8ZUdaWa8IebAuNOeBxc2sveYrumdyr 0zlw== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@amarulasolutions.com header.s=google header.b=KYjbiOhx; 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=iGg6OUUnvntvb/BYdqgreZzlc1nI7pRwM5cD1HPw4IQ=; b=F2VL9RkN64GmRocfyAZjJ7s8v6U49M0c/WfKzEEgRN511CWYlAYGLoPyHfAC/uFzlM akuEbpb1M8IMDqW7jit+TPElV3F7XZSPC3hu6ESr/qoVgs95CGmnAdjYzZTk9XZTu9iP cAtEbLXCnl/KdmZD1APXeSo7TQ3S6OF5yipXM= 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=iGg6OUUnvntvb/BYdqgreZzlc1nI7pRwM5cD1HPw4IQ=; b=PtrneFriThKrUK6DvkPoGUYVvfhLDdbQdiwaFn8pOfPHzbJtY7Ojx8Pl2lZav9bj5J x4TIoSB3+DsEqSaFY5FB30Ajkc89dzYe9KnYn/2sQXaBA3hQb2brOebRRN5Rw+t0iyur aoaw+nA191ga4qY1hm9rufM3dS8cebMoOaKD0BlitPu1UQDjpyMiEhH7DIMGdRzI2H1r 8t7H/hX8xICW4rJFtoJv+wqWrO/wGKNsF8oa+xbIeTb6hTNsXZHNRtg1GdHWh5C8WecK i+cEFRvUDDcrVO5tXNRVEMHgln7g6EkTqZ1uS8i2kLtislwU87Oo0dUFORyvPu3B+NP0 XjpA== X-Gm-Message-State: AJIora/NUlLDfK9FSd3zUWOS30zLkJMIawlahV0PNlqSee8KfBKPn4R8 ZnZOl6++KTLyJBYPj5VDv9WKL9FK X-Google-Smtp-Source: AGRyM1t8oVkwGK3YI4CAINt3L0C1Cvyyrh9qNCXu3id36hq0vZVN99g6dCL1JogWao/17gd3NeQCkQ== X-Received: by 2002:a05:6a00:e0e:b0:522:990c:ab60 with SMTP id bq14-20020a056a000e0e00b00522990cab60mr22772755pfb.8.1659471372729; Tue, 02 Aug 2022 13:16:12 -0700 (PDT) X-BeenThere: linux-amarula@amarulasolutions.com Received: by 2002:a63:f110:0:b0:41b:203a:51a with SMTP id f16-20020a63f110000000b0041b203a051als7424952pgi.5.-pod-prod-gmail; Tue, 02 Aug 2022 13:16:12 -0700 (PDT) X-Received: by 2002:a63:2401:0:b0:41c:7576:83cd with SMTP id k1-20020a632401000000b0041c757683cdmr2663688pgk.321.1659471371885; Tue, 02 Aug 2022 13:16:11 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1659471371; cv=none; d=google.com; s=arc-20160816; b=gKXqL3zSQfTxMHUL7hmV3gN7XwtxZVU4xTi+JYI6N+rhhkWkuha3P7WI8tY2ZEkcM7 5Lpu/4Xle73trsR6UBU9Mi8mNlXO9f7hQbQewc0KTUi65t4CaiOdGhUyCNqfGJJ5jS4B VX0F8JNQUjMAvA+XByCWYFc/XNwBUypSn9D8xqg6Y+qtLG5s+zg+8QFvtSenTi/lqcfv jMBD26B+q50FFzcotQkTBFmA2lf4XQE/k+KU8YBWQxEklmNYIBlzukJVzGlV2IHD73vs Y49XC4JBIU/nTIPY26WcxIFJj5WaIjw9rf6CbFE9ai8DcgLCfD+ZOSBU8msuF6MLCbXi +GAQ== 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=nC6Hx+qiMFP0kKK+gIayIBAMJyU5NtZQrF2GRnpsTMA=; b=dhBLHERpkPS5z8BYuGdyWRKq86ErRLEKwFP4dNnDlbaoTmXqB7JRPwJNnRHv1jCJaE EY1GYo5CdCxkq8/oOeFbNQnZnxWj4h8s70MErGJLYTza19qFU3xV2ABXlrPalpmcGeuT 4qOhKJzz25JcOX1j7gkqF1S07cpPfczOejSR9/yKj68KTbPptXJabU5LjfeOtu6bASIn iTOykcXZAdOBhaqB/iiJ3+azlkH6CRD2vjodfM3Rlft92X3vR9rAcbWFrlG6LU/DWJRQ mkdsBCfOIVLiOC1RLrldS+clh+k6rW1MIKJgjI926YkLPwQ4yv484lVswg+HT9W9EsYD iEpg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@amarulasolutions.com header.s=google header.b=KYjbiOhx; 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 b2-20020a170902d50200b0016f03e00032sor117826plg.20.2022.08.02.13.16.11 for (Google Transport Security); Tue, 02 Aug 2022 13:16:11 -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:902:b08a:b0:16c:68b6:311 with SMTP id p10-20020a170902b08a00b0016c68b60311mr21685501plr.166.1659471371483; Tue, 02 Aug 2022 13:16:11 -0700 (PDT) Received: from localhost.localdomain ([183.83.136.224]) by smtp.gmail.com with ESMTPSA id w18-20020a170902a71200b0016ee26224a4sm80863plq.305.2022.08.02.13.16.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 02 Aug 2022 13:16:11 -0700 (PDT) From: Suniel Mahesh To: Felipe Balbi , Greg Kroah-Hartman , Michael Trimarchi , Jagan Teki , Zachary Holland , Daniel McLean , Rene Samson Ambrose , David Sands Cc: linux-kernel@vger.kernel.org, linux-amarula@amarulasolutions.com, USB list Subject: [RFC v2 1/2] usb: gadget: f_hid: Extend functionality for GET_REPORT mode Date: Wed, 3 Aug 2022 01:45:55 +0530 Message-Id: <20220802201556.1510069-2-sunil@amarulasolutions.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220802201556.1510069-1-sunil@amarulasolutions.com> References: <20220802201556.1510069-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=KYjbiOhx; 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 --- 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%) diff --git a/drivers/usb/gadget/function/f_hid.c b/drivers/usb/gadget/function/f_hid.c index ca0a7d9eaa34..e1da4fb10ab3 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,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); 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 */