From patchwork Fri Aug 5 07:05:06 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Suniel Mahesh X-Patchwork-Id: 2294 Return-Path: X-Original-To: linux-amarula@patchwork.amarulasolutions.com Delivered-To: linux-amarula@patchwork.amarulasolutions.com Received: from mail-pg1-f200.google.com (mail-pg1-f200.google.com [209.85.215.200]) by ganimede.amarulasolutions.com (Postfix) with ESMTPS id 041073F047 for ; Fri, 5 Aug 2022 09:05:28 +0200 (CEST) Received: by mail-pg1-f200.google.com with SMTP id 196-20020a6301cd000000b0041b0f053fd1sf964589pgb.6 for ; Fri, 05 Aug 2022 00:05:27 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1659683126; cv=pass; d=google.com; s=arc-20160816; b=SmPIRNb0T35FBbWJsXda6i67OkSY5nWkXPd2Kc2wdLSi9N98yeay2u4xcBvy/lAIlN 5Sw7hIkeC2s9DKh+CKSbKD51Z4eHIM/TGzgHLXs5+WFhFKWeEVtiQkdtedaT74uUfYOG Ab5B1XEpxeaTUKmOo+Km93NP8TluwFxhi6sTFu12V/A0uhcsCr+fu7vKW5DDK6a7Tkj8 EERNp86fG7PRzPjUvQnVJlhHSMfuoPt+w1JF+vL3uP31V0B2oO/KcDjGK7/7RlQg0keh Se974KOxJxpcO8mBPoM+5QNdcoOhLgKgTOpQQgZ8dsX80/ypFMQ1dPLtnPolln5sWqov FMHQ== 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=YBWp+Lt7fxMXzaloPh7x1Jvap9qQPdIJjewSyqivLPM=; b=K3jErRuqOGTbfA8KNbNJEnMT2f/DwecwEyyGKqQakQCkTh2qux+5/Oe4l+b905XmHX cwiSH1KmYIgvEGcP6Bt712m1TjD9MBZLxCZRVZ21M8/Y/PnXHGpYvJ/IlErAR1byTwIZ SgMi7EmkdbpnUP1xJk3VwF7Nail5WzxjUhjZ65MIKscO39AC6wz9flWPrEhcfwi58S9I ff0bpxwPxaQr7FHutDGHQMeRHdRGYD2TpjxLUndh+kq4m+8cGPN7ctty0SpUgg/y05o8 uQVUMquvOS1ioQ96iuPykSmskeMoVnIxIIOA7N8vt8kli47bn0rL1JtW9arBvsL6tHp4 O1pQ== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@amarulasolutions.com header.s=google header.b=DO5ElMz+; 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=list-unsubscribe:list-archive:list-help:list-post:list-id :mailing-list:precedence:x-original-authentication-results :x-original-sender:mime-version:references:in-reply-to:message-id :date:subject:cc:to:from:from:to:cc; bh=YBWp+Lt7fxMXzaloPh7x1Jvap9qQPdIJjewSyqivLPM=; b=PhqcCwleUS/m3rNVD/k6hSuDQG0F9wLBgtGsgp3NJ+9968PEKvacMDzOQX/UuYEAyz H+YCGXd5K5TW8p+iGm+g2gzR9bQET6Ez4GppcHB27N0wKUQeWzISPNSRJA1Sd+gbiunr fJ0ZXsEW/kAW0jjP9bFLlEEvhIoAU7fXvePi0= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=list-unsubscribe:list-archive:list-help:list-post :x-spam-checked-in-group:list-id:mailing-list:precedence :x-original-authentication-results:x-original-sender:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :x-gm-message-state:from:to:cc; bh=YBWp+Lt7fxMXzaloPh7x1Jvap9qQPdIJjewSyqivLPM=; b=GwNsdgYhTS+nKOy5Rk4DXPUVNAOth30Ycj+H0sk67yqC2fssKFexmT59xakqi3AIxb QtkWvQb1iRgPkq0pta1nl0Gohh0WsnJC9VVtEJPBjRNGDaXsSmgTz8F/67pwCJms6Agq fPHFnyssXOEXacb7cTeLOkheBnESqJ2c7CY7OoTFkwO34AkO7XX3EGl9TMgpHZ2CQC6r MWvZRnNpOy2ZhT7aviIZsoSHSSkusDSPkgYt/DIR9jlZu4dAu9oaaPjxVeu/tluiG1U7 THE8ce3NHqb7LU5D2Pk0gSaE55tCkZ3187ziDECk+ZrhVxvuWxOUBKUMi3whgyAWapQB ZqBg== X-Gm-Message-State: ACgBeo3SSowLGMvtQOgESfTJNUxHYkax/RgEcXH0G/JqRoAa0FJbbadG E0BZPyyoAowLb0c8jsSh5eoKeiNG X-Google-Smtp-Source: AA6agR6Flir3mVxTiCcwptoy8rSKmtT8dGYM2jr5KyTExRYcxLLk/W/LH3tqQHWYF0JsA5Uq6RtoBw== X-Received: by 2002:a17:903:234e:b0:16e:e279:913c with SMTP id c14-20020a170903234e00b0016ee279913cmr5447845plh.47.1659683126722; Fri, 05 Aug 2022 00:05:26 -0700 (PDT) X-BeenThere: linux-amarula@amarulasolutions.com Received: by 2002:a17:90a:bd0:b0:1f2:da63:2f68 with SMTP id x16-20020a17090a0bd000b001f2da632f68ls2984690pjd.3.-pod-prod-gmail; Fri, 05 Aug 2022 00:05:26 -0700 (PDT) X-Received: by 2002:a17:90b:343:b0:1ef:b65d:f4d8 with SMTP id fh3-20020a17090b034300b001efb65df4d8mr14271286pjb.187.1659683125812; Fri, 05 Aug 2022 00:05:25 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1659683125; cv=none; d=google.com; s=arc-20160816; b=yk8EsccoTS+4xMtDFYAQzRZCJkeKQfyIP822p0JNA+/QDboSW07+PMFvFPY+r0t682 kL3o89UBhcDyPNeZs6apmly7HQohs7nRNkkPPnEme63wG+IqGPD4FHglFMuJdh53a8iZ zTxJ0lnKxQ0lZF1eS/IQM3RzyVh4QqhZVQ1+S0mnfHYqKoQg62zK2LIvQ+JaNlhxE1Y8 2kEqwVuL84gl7oAjEvcbh+s1aEAYbZhqo7isg6RY7IDVBslMzTmoX1qMM9AE8j08PSNW vicJSRe2UjwfJOwzH1dBuI4volkA9L3pL6ozMagxMQRasmPmDd4dj21JoY0gXm54socV EXWQ== 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=FbD+ePPAVBn4pMAel7WvjhZICIU9MuaisaPmR6+tYD4=; b=LvlkvfZOS7uYYY+JGmFtn9LjP0GV/jpxpmzT85G1wvXrRt/FPIKVEUWmBjNDYxSUYd Ob+OcOpqvgH3sExhXmw8YCe1RcluXGNmZf+eqBbY2AyhR2DNjk/lrHFODSxW0zndcC4+ nN6G37ulcmNn/elebG/lf4us9CtFRu40+rPZEq+treZgd25p/zFwxULWLX5SxzIjHQOE sbeiReshBwshCwxh2SUag28wLUiaSC3vaz1bi0pEftvDYIYN22MfrKEDdj8XdWuT6qhv m2DgjwnZ1vjSG5qwnzE5TQzufNFxwkje4Ny97ENNm9KB4offxGJSJ2Opogi4UnHtgMmW uvwg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@amarulasolutions.com header.s=google header.b=DO5ElMz+; 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 k4-20020a170902c40400b0016c483d7c3asor1662267plk.39.2022.08.05.00.05.25 for (Google Transport Security); Fri, 05 Aug 2022 00:05: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:903:404d:b0:16f:86fd:cf5c with SMTP id n13-20020a170903404d00b0016f86fdcf5cmr4588496pla.26.1659683125442; Fri, 05 Aug 2022 00:05:25 -0700 (PDT) Received: from localhost.localdomain ([183.83.136.224]) by smtp.gmail.com with ESMTPSA id e60-20020a17090a6fc200b001f262f6f717sm4877484pjk.3.2022.08.05.00.05.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 05 Aug 2022 00:05:25 -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 v3 1/2] usb: gadget: f_hid: Extend functionality for GET_REPORT mode Date: Fri, 5 Aug 2022 12:35:06 +0530 Message-Id: <20220805070507.123151-2-sunil@amarulasolutions.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220805070507.123151-1-sunil@amarulasolutions.com> References: <20220805070507.123151-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=DO5ElMz+; 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 v3: - correct report type mapping. 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..61c85dbd5833 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_INPUT_REPORT; + case 2: + return UHID_OUTPUT_REPORT; + case 3: + return UHID_FEATURE_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 */