From patchwork Thu Jun 8 20:45:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Badhri Jagan Sridharan X-Patchwork-Id: 105133 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp541015vqr; Thu, 8 Jun 2023 14:05:41 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ7wFjh1d/5DbgJzB1NHGK6qnogP62h3kbEK9+RwfO/6/BkifyEhVrGWrzIxYlspwhpl4QX5 X-Received: by 2002:a05:6359:6385:b0:127:de76:9ad7 with SMTP id sg5-20020a056359638500b00127de769ad7mr3228350rwb.1.1686258340939; Thu, 08 Jun 2023 14:05:40 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1686258340; cv=none; d=google.com; s=arc-20160816; b=rcr6top1EdrMc/NTpsLuR/pBgqEKL5EBvDNmWGCyFDBL+ryV42AuqXA7RQVN/uC6Uz 9LBoydJsY3WwLIskPUAjec/BBhtk+TRWf5oFUi+nNLBejCFgaYa9GJyYUV/P4HJB4oVg SJ/Z57OOTcejv1scPez9JMglow+dKhttRT+7zbMBIHC6N7GMVHLm3HXyMxTCpIgQWz4i 2ud17vB23EmoA9DL7CXVt/6QYpZE5KPrV0RhEqcgFK18/myn3FbpcoQeKDQAipF7D/4r +X6lfi39kAjlB7r1KZJUGSlNhffLxK8jJOVkRb9ZVj2tAoz0cK2nXFkH6m9tKH/+Cbo3 BpJg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:from:subject:message-id:mime-version:date :dkim-signature; bh=vnoG17X4SR0Yr68DnHAZRjmH2ycNdwkX85eHutCEXPA=; b=Z7vzauvyoNmANYmL6oO40oLSho5tNWhTX0wgQzfs3rvn+8PfyRYqsdDebqwM9wKTZk Io2lBbgMI+IBvAWWdYnflC6kRCCSNRp0BdYGw/P6VgABPp/OcQvTBD/og2JUUQIbnhMw LzgmLDiAHFhCFHCutALshn8nfk4uql0RiGrPM6CjiaZ/+TmZ/PtVVr1I+aJRYOsEanTE 96tNdYO6upBTh2CFYmS83rXk/4lr/WokPDN+JPYIYaEW4/WO2bZNKn6qcQUp3R6OAIsI rESz3YJ3HOXdAAwgAQ20yxivInfOIwNBzGYt9rl9VD5e6U24LbiCxYGOJt8q9YA4EaU1 AIMw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20221208 header.b="UN/Iuh6A"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id h187-20020a636cc4000000b0054033bf35easi1510378pgc.269.2023.06.08.14.05.25; Thu, 08 Jun 2023 14:05:40 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20221208 header.b="UN/Iuh6A"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235531AbjFHUpZ (ORCPT + 99 others); Thu, 8 Jun 2023 16:45:25 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46870 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229539AbjFHUpX (ORCPT ); Thu, 8 Jun 2023 16:45:23 -0400 Received: from mail-yw1-x1149.google.com (mail-yw1-x1149.google.com [IPv6:2607:f8b0:4864:20::1149]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AC37A1FDA for ; Thu, 8 Jun 2023 13:45:21 -0700 (PDT) Received: by mail-yw1-x1149.google.com with SMTP id 00721157ae682-564fb1018bcso14192497b3.0 for ; Thu, 08 Jun 2023 13:45:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20221208; t=1686257121; x=1688849121; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=vnoG17X4SR0Yr68DnHAZRjmH2ycNdwkX85eHutCEXPA=; b=UN/Iuh6A4ZSn2Srw/iO2/QubYI3z1NBUEPCiOwH2gXvKtbxgDMkJwJQ3fcr7lYMaS6 LRgUsrWvSHO13NXiH9E6FCY713p0mH4UD6phKd3HXqJm2EK1H6v4xP2sMNG0LkiHtk+i qdc2rvtqxhBrZt/vAZwTWMBKfQ/RLOzYINvXt795GjADbOfcB3Ly37ZVYeuBZDz4R7qO LENlFPhFhtZtw1uGFcNraCjatKtaQ8LVu81LBVrP9XK2PoiMxOQU+D62A1+LG842jH7D JCOU50sAWOiqTrv+RhqLhyXFYi2p3ZHBLG+b+Xb9fGNURYbw3afAIrJdf9EOkkyc3b6t 13yg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686257121; x=1688849121; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=vnoG17X4SR0Yr68DnHAZRjmH2ycNdwkX85eHutCEXPA=; b=FXg4rPJZN5kZNASq2uU99VLDugAS2bn3tCIZWVyrXobieDVK4sxhaLM4DiQenZtv4V 8ag747dJK6yKYsHvmGJOWhj4ITsP6xHA0e50yaQlXEKIh7xWdvl35CCPdFdheMkTrXfQ R4cFCyDq/rYSEM4Wpba5bJwC5Oefgt01iqpwUmQpm6rgfUAYtGgQJOAXFr8gP+HYHxpU /2QO/xSrHEoVDO4VF8ZGiwiXFqKPVzqNXyDKkOF8l4Sx30PBcpEUas4xss4i4HCT1AQQ 3h5kzT73DPNDEmscn7AtISLb7tXVdwRgdeFbc/DThMdI2W1HvuGGaeahsSHrfWW7d5dZ RShQ== X-Gm-Message-State: AC+VfDz+J+43/iBs07KElPbmtPRd0RSDAI1uUr8+W5O5RSo/EbBTGUoK jJ2mhJabPQ81R5PsYv8j9JYVOIcyoy4= X-Received: from badhri.c.googlers.com ([fda3:e722:ac3:cc00:7f:e700:c0a8:6442]) (user=badhri job=sendgmr) by 2002:a81:a7c9:0:b0:569:8603:577 with SMTP id e192-20020a81a7c9000000b0056986030577mr505740ywh.4.1686257120940; Thu, 08 Jun 2023 13:45:20 -0700 (PDT) Date: Thu, 8 Jun 2023 20:45:15 +0000 Mime-Version: 1.0 X-Mailer: git-send-email 2.41.0.162.gfafddb0af9-goog Message-ID: <20230608204517.105396-1-badhri@google.com> Subject: [PATCH v7 1/2] usb: gadget: udc: core: Offload usb_udc_vbus_handler processing From: Badhri Jagan Sridharan To: gregkh@linuxfoundation.org, stern@rowland.harvard.edu, colin.i.king@gmail.com, xuetao09@huawei.com, quic_eserrao@quicinc.com, water.zhangjiantao@huawei.com, peter.chen@freescale.com, balbi@ti.com, francesco@dolcini.it, alistair@alistair23.me, stephan@gerhold.net, bagasdotme@gmail.com, luca@z3ntu.xyz Cc: linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, stable@vger.kernel.org, Badhri Jagan Sridharan X-Spam-Status: No, score=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE,USER_IN_DEF_DKIM_WL autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1768170026412473621?= X-GMAIL-MSGID: =?utf-8?q?1768170026412473621?= usb_udc_vbus_handler() can be invoked from interrupt context by irq handlers of the gadget drivers, however, usb_udc_connect_control() has to run in non-atomic context due to the following: a. Some of the gadget driver implementations expect the ->pullup callback to be invoked in non-atomic context. b. usb_gadget_disconnect() acquires udc_lock which is a mutex. Hence offload invocation of usb_udc_connect_control() to workqueue. UDC should not be pulled up unless gadget driver is bound. The new flag "allow_connect" is now set by gadget_bind_driver() and cleared by gadget_unbind_driver(). This prevents work item to pull up the gadget even if queued when the gadget driver is already unbound. Cc: stable@vger.kernel.org Fixes: 1016fc0c096c ("USB: gadget: Fix obscure lockdep violation for udc_mutex") Signed-off-by: Badhri Jagan Sridharan Reviewed-by: Alan Stern --- Changes since v1: - Address Alan Stern's comment on usb_udc_vbus_handler invocation from atomic context: * vbus_events_lock is now a spinlock and allocations in * usb_udc_vbus_handler are atomic now. Changes since v2: - Addressing Alan Stern's comments: ** connect_lock is now held by callers of * usb_gadget_pullup_update_locked() and gadget_(un)bind_driver() does * notdirectly hold the lock. ** Both usb_gadget_(dis)connect() and usb_udc_vbus_handler() would * set/clear udc->vbus and invoke usb_gadget_pullup_update_locked. ** Add "unbinding" to prevent new connections after the gadget is being * unbound. Changes since v3: ** Made a minor cleanup which I missed to do in v3 in * usb_udc_vbus_handler(). Changes since v4: - Addressing Alan Stern's comments: ** usb_udc_vbus_handler() now offloads invocation of usb_udc_connect_control() * from workqueue. ** Dropped vbus_events list as this was redundant. Updating to the * latest value is suffice Changes since v5: - Addressing Alan Stern's comments: ** Squashed allow_connect logic to this patch. ** Fixed comment length to wrap at 76 ** Cancelling vbus_work in del_gadget() Changes since v6: - Added reviewed by tag --- drivers/usb/gadget/udc/core.c | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) base-commit: d37537a1f7cf09e304fe7993cb5e732534a0fb22 diff --git a/drivers/usb/gadget/udc/core.c b/drivers/usb/gadget/udc/core.c index 52e6d2e84e35..d2e4f78c53e3 100644 --- a/drivers/usb/gadget/udc/core.c +++ b/drivers/usb/gadget/udc/core.c @@ -37,6 +37,9 @@ static const struct bus_type gadget_bus_type; * @vbus: for udcs who care about vbus status, this value is real vbus status; * for udcs who do not care about vbus status, this value is always true * @started: the UDC's started state. True if the UDC had started. + * @allow_connect: Indicates whether UDC is allowed to be pulled up. + * Set/cleared by gadget_(un)bind_driver() after gadget driver is bound or + * unbound. * * This represents the internal data structure which is used by the UDC-class * to hold information about udc driver and gadget together. @@ -48,6 +51,8 @@ struct usb_udc { struct list_head list; bool vbus; bool started; + bool allow_connect; + struct work_struct vbus_work; }; static struct class *udc_class; @@ -706,7 +711,7 @@ int usb_gadget_connect(struct usb_gadget *gadget) goto out; } - if (gadget->deactivated) { + if (gadget->deactivated || !gadget->udc->allow_connect) { /* * If gadget is deactivated we only save new state. * Gadget will be connected automatically after activation. @@ -1086,6 +1091,13 @@ static void usb_udc_connect_control(struct usb_udc *udc) usb_gadget_disconnect(udc->gadget); } +static void vbus_event_work(struct work_struct *work) +{ + struct usb_udc *udc = container_of(work, struct usb_udc, vbus_work); + + usb_udc_connect_control(udc); +} + /** * usb_udc_vbus_handler - updates the udc core vbus status, and try to * connect or disconnect gadget @@ -1094,6 +1106,14 @@ static void usb_udc_connect_control(struct usb_udc *udc) * * The udc driver calls it when it wants to connect or disconnect gadget * according to vbus status. + * + * This function can be invoked from interrupt context by irq handlers of + * the gadget drivers, however, usb_udc_connect_control() has to run in + * non-atomic context due to the following: + * a. Some of the gadget driver implementations expect the ->pullup + * callback to be invoked in non-atomic context. + * b. usb_gadget_disconnect() acquires udc_lock which is a mutex. + * Hence offload invocation of usb_udc_connect_control() to workqueue. */ void usb_udc_vbus_handler(struct usb_gadget *gadget, bool status) { @@ -1101,7 +1121,7 @@ void usb_udc_vbus_handler(struct usb_gadget *gadget, bool status) if (udc) { udc->vbus = status; - usb_udc_connect_control(udc); + schedule_work(&udc->vbus_work); } } EXPORT_SYMBOL_GPL(usb_udc_vbus_handler); @@ -1328,6 +1348,7 @@ int usb_add_gadget(struct usb_gadget *gadget) mutex_lock(&udc_lock); list_add_tail(&udc->list, &udc_list); mutex_unlock(&udc_lock); + INIT_WORK(&udc->vbus_work, vbus_event_work); ret = device_add(&udc->dev); if (ret) @@ -1459,6 +1480,7 @@ void usb_del_gadget(struct usb_gadget *gadget) flush_work(&gadget->work); device_del(&gadget->dev); ida_free(&gadget_id_numbers, gadget->id_number); + cancel_work_sync(&udc->vbus_work); device_unregister(&udc->dev); } EXPORT_SYMBOL_GPL(usb_del_gadget); @@ -1527,6 +1549,7 @@ static int gadget_bind_driver(struct device *dev) if (ret) goto err_start; usb_gadget_enable_async_callbacks(udc); + udc->allow_connect = true; usb_udc_connect_control(udc); kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE); @@ -1558,6 +1581,8 @@ static void gadget_unbind_driver(struct device *dev) kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE); + udc->allow_connect = false; + cancel_work_sync(&udc->vbus_work); usb_gadget_disconnect(gadget); usb_gadget_disable_async_callbacks(udc); if (gadget->irq) From patchwork Thu Jun 8 20:45:16 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Badhri Jagan Sridharan X-Patchwork-Id: 105134 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp541403vqr; Thu, 8 Jun 2023 14:06:26 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ5BihIK6THTr2gKOXhMUfhUYrinxkxpcaS9qqm/74VOk0kLwFaY6kDpV4EAwwtIdHDR7xPH X-Received: by 2002:a05:6a00:1250:b0:659:7d45:a52c with SMTP id u16-20020a056a00125000b006597d45a52cmr11248133pfi.30.1686258386240; Thu, 08 Jun 2023 14:06:26 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1686258386; cv=none; d=google.com; s=arc-20160816; b=azxmXkw9LMbR1BL0tltXTwvH4iRFUGRpX2XKTpHarGM9eSSXsf8Pi801eg4vrjXR96 /6BsmHINrtLewoo4Gkq9AOrvJU22HRSUAoZQ/pc7tFdFQ8WynP+MYBqM8utILjgB5VdW 2TOR1oCfoPOq2bk/mN/6foXDUURcwnknHbc8hxc7sssrCkW5VwPFSAD6JldC9Wkz8hVY Azh5L5MwUdmq5uwB1qcrzPZt4vUhZykUxx4RLFguv3A+ZcBOoJEjiEvD+kWVsYzcIcNM uuP4zZAxxZ27VYB8IBCR1e8sGwOU8ujModHS4xF8/sbBTDiqCZwd8hrUOv69LgsZRh/2 kemw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:from:subject:message-id:references :mime-version:in-reply-to:date:dkim-signature; bh=9En/nA5czqY9XvtbArZPF0a5d5bx2uzrlb5JXAauKEk=; b=zJCb2gypuNSPXM4Op380PQjQFV/XZPts+Dcz3KnRmsJ4wvgsl/rgbYarHtka2N8ams SVgez6Q8DJ4wTwRVFlvYEOVHNH7l6Ha5G5yrX5CMxPBJXAzEPsu0HoeRIqKqrSeVqVjW 3hX7f8kA6Az3mFSFPvKH6uRYTLsI9+joxsrrOgkTDU1ZemaOS5IhzfN/oHuQ0HPVgBB2 57e+mJq3LdPCsfSe8rGecc9CM5D23PpMQKs7y5wQZ/gTU7iuE4lXwwq6c9oVHJibj3Qi PQieY78i6pA+xi6QKJalcSYOEjz5XW/nsu4vvXEsJTV32+IIJfoTSZOo2FS65XFUnghV tF+Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20221208 header.b=LcZUFeGL; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id t71-20020a63814a000000b0051ae6c4084dsi1487040pgd.512.2023.06.08.14.06.08; Thu, 08 Jun 2023 14:06:26 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20221208 header.b=LcZUFeGL; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236399AbjFHUpc (ORCPT + 99 others); Thu, 8 Jun 2023 16:45:32 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46894 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236525AbjFHUp0 (ORCPT ); Thu, 8 Jun 2023 16:45:26 -0400 Received: from mail-pg1-x549.google.com (mail-pg1-x549.google.com [IPv6:2607:f8b0:4864:20::549]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B44942D7B for ; Thu, 8 Jun 2023 13:45:23 -0700 (PDT) Received: by mail-pg1-x549.google.com with SMTP id 41be03b00d2f7-5428d1915acso45029a12.0 for ; Thu, 08 Jun 2023 13:45:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20221208; t=1686257123; x=1688849123; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=9En/nA5czqY9XvtbArZPF0a5d5bx2uzrlb5JXAauKEk=; b=LcZUFeGLOqh8MsfZjy7K8UJmsHg7DfXznBT8pgXg5TLU8u+JfUaAlaVJJngJ82Isgj fUqBOStw4LzgA3u/GDqushb3hKz7EOPXyaOyuxgCILe2i97ybRjZ3+8LzjTNZf6QBfxG sdc6ABcuaE/A9VDeL733eu4QZGdOGn3KPgjfLpk2uv5WlaoWba2hNf934LfljlGzg78J JWCbdombtt3ka9BRe9IoXvrx6tXKw0OcrEiWlPz8kahkOu5+loLmjazWuOECM23o+8SB L1zToRLAF7T/vbuCzWiFOEW4by1Jv1Z67S9eZbq+dAnZYvph0fIWHpY4s03JfOpF4BAK CcdA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686257123; x=1688849123; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=9En/nA5czqY9XvtbArZPF0a5d5bx2uzrlb5JXAauKEk=; b=TGtVTBI30v2tecZ8WqlMDMv++d3hWKTSGkJ09rK+eo/vbnx78n3LJr8F7MiO6y2exj J4A+v75u7gndvTEia3jLYIqUw8y23Y/WX+EMS7q5D3g/T/I0XPE3oyNKIemIITjqaKBf YShbeGwx8Aj8NMpNmMX1T36hW3l2ezXSPvcECHv5eqXUK1QNDIKixOAWjU4VHrJwCrzE gejoxcEHhQH7vWEVE8CLWTVLkBaeytbZ7hPJYMub7Ngk2Mk/p4y/+MAbzCybPHxM4/zP tktYSB9jz9rjIfxMWTTjloGEvUzO3xFX86AE5W2Ix/RpW3geNkd8oQyVA8IhdyKK3eXX pHsQ== X-Gm-Message-State: AC+VfDzLum3peVRETu/y+GIXiZ4KFensr9QOJTg6m7lTJYiz7uU43w4O uxP25pJSWbNZLgDBLub9+ChGVDgEbQU= X-Received: from badhri.c.googlers.com ([fda3:e722:ac3:cc00:7f:e700:c0a8:6442]) (user=badhri job=sendgmr) by 2002:a63:1e64:0:b0:520:77f8:a145 with SMTP id p36-20020a631e64000000b0052077f8a145mr132138pgm.5.1686257123114; Thu, 08 Jun 2023 13:45:23 -0700 (PDT) Date: Thu, 8 Jun 2023 20:45:16 +0000 In-Reply-To: <20230608204517.105396-1-badhri@google.com> Mime-Version: 1.0 References: <20230608204517.105396-1-badhri@google.com> X-Mailer: git-send-email 2.41.0.162.gfafddb0af9-goog Message-ID: <20230608204517.105396-2-badhri@google.com> Subject: [PATCH v7 2/2] usb: gadget: udc: core: Prevent soft_connect_store() race From: Badhri Jagan Sridharan To: gregkh@linuxfoundation.org, stern@rowland.harvard.edu, colin.i.king@gmail.com, xuetao09@huawei.com, quic_eserrao@quicinc.com, water.zhangjiantao@huawei.com, peter.chen@freescale.com, balbi@ti.com, francesco@dolcini.it, alistair@alistair23.me, stephan@gerhold.net, bagasdotme@gmail.com, luca@z3ntu.xyz Cc: linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, stable@vger.kernel.org, Badhri Jagan Sridharan X-Spam-Status: No, score=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1768170073517236648?= X-GMAIL-MSGID: =?utf-8?q?1768170073517236648?= usb_udc_connect_control(), soft_connect_store() and usb_gadget_deactivate() can potentially race against each other to invoke usb_gadget_connect()/usb_gadget_disconnect(). To prevent this, guard udc->started, gadget->allow_connect, gadget->deactivate and gadget->connect with connect_lock so that ->pullup() is only invoked when the gadget is bound, started and not deactivated. The routines usb_gadget_connect_locked(), usb_gadget_disconnect_locked(), usb_udc_connect_control_locked(), usb_gadget_udc_start_locked(), usb_gadget_udc_stop_locked() are called with this lock held. An earlier version of this commit was reverted due to the crash reported in https://lore.kernel.org/all/ZF4BvgsOyoKxdPFF@francesco-nb.int.toradex.com/. commit 16737e78d190 ("usb: gadget: udc: core: Offload usb_udc_vbus_handler processing") addresses the crash reported. Cc: stable@vger.kernel.org Fixes: 628ef0d273a6 ("usb: udc: add usb_udc_vbus_handler") Signed-off-by: Badhri Jagan Sridharan --- v5 is the first version in this series. Changes since v5: ** Fixed up commit message ** Wrapped comments at 76. Changes since v6: ** Address Alan comments around style/presentation. ** Fixed code to acquire ->connect_lock before testing gadget->deactivated. --- drivers/usb/gadget/udc/core.c | 153 +++++++++++++++++++++++----------- 1 file changed, 106 insertions(+), 47 deletions(-) diff --git a/drivers/usb/gadget/udc/core.c b/drivers/usb/gadget/udc/core.c index d2e4f78c53e3..2549717c1446 100644 --- a/drivers/usb/gadget/udc/core.c +++ b/drivers/usb/gadget/udc/core.c @@ -40,6 +40,11 @@ static const struct bus_type gadget_bus_type; * @allow_connect: Indicates whether UDC is allowed to be pulled up. * Set/cleared by gadget_(un)bind_driver() after gadget driver is bound or * unbound. + * @connect_lock: protects udc->started, gadget->connect, + * gadget->allow_connect and gadget->deactivate. The routines + * usb_gadget_connect_locked(), usb_gadget_disconnect_locked(), + * usb_udc_connect_control_locked(), usb_gadget_udc_start_locked() and + * usb_gadget_udc_stop_locked() are called with this lock held. * * This represents the internal data structure which is used by the UDC-class * to hold information about udc driver and gadget together. @@ -53,6 +58,7 @@ struct usb_udc { bool started; bool allow_connect; struct work_struct vbus_work; + struct mutex connect_lock; }; static struct class *udc_class; @@ -692,17 +698,8 @@ int usb_gadget_vbus_disconnect(struct usb_gadget *gadget) } EXPORT_SYMBOL_GPL(usb_gadget_vbus_disconnect); -/** - * usb_gadget_connect - software-controlled connect to USB host - * @gadget:the peripheral being connected - * - * Enables the D+ (or potentially D-) pullup. The host will start - * enumerating this gadget when the pullup is active and a VBUS session - * is active (the link is powered). - * - * Returns zero on success, else negative errno. - */ -int usb_gadget_connect(struct usb_gadget *gadget) +static int usb_gadget_connect_locked(struct usb_gadget *gadget) + __must_hold(&gadget->udc->connect_lock) { int ret = 0; @@ -711,10 +708,12 @@ int usb_gadget_connect(struct usb_gadget *gadget) goto out; } - if (gadget->deactivated || !gadget->udc->allow_connect) { + if (gadget->deactivated || !gadget->udc->allow_connect || !gadget->udc->started) { /* - * If gadget is deactivated we only save new state. - * Gadget will be connected automatically after activation. + * If the gadget isn't usable (because it is deactivated, + * unbound, or not yet started), we only save the new state. + * The gadget will be connected automatically when it is + * activated/bound/started. */ gadget->connected = true; goto out; @@ -729,22 +728,31 @@ int usb_gadget_connect(struct usb_gadget *gadget) return ret; } -EXPORT_SYMBOL_GPL(usb_gadget_connect); /** - * usb_gadget_disconnect - software-controlled disconnect from USB host - * @gadget:the peripheral being disconnected - * - * Disables the D+ (or potentially D-) pullup, which the host may see - * as a disconnect (when a VBUS session is active). Not all systems - * support software pullup controls. + * usb_gadget_connect - software-controlled connect to USB host + * @gadget:the peripheral being connected * - * Following a successful disconnect, invoke the ->disconnect() callback - * for the current gadget driver so that UDC drivers don't need to. + * Enables the D+ (or potentially D-) pullup. The host will start + * enumerating this gadget when the pullup is active and a VBUS session + * is active (the link is powered). * * Returns zero on success, else negative errno. */ -int usb_gadget_disconnect(struct usb_gadget *gadget) +int usb_gadget_connect(struct usb_gadget *gadget) +{ + int ret; + + mutex_lock(&gadget->udc->connect_lock); + ret = usb_gadget_connect_locked(gadget); + mutex_unlock(&gadget->udc->connect_lock); + + return ret; +} +EXPORT_SYMBOL_GPL(usb_gadget_connect); + +static int usb_gadget_disconnect_locked(struct usb_gadget *gadget) + __must_hold(&gadget->udc->connect_lock) { int ret = 0; @@ -756,7 +764,7 @@ int usb_gadget_disconnect(struct usb_gadget *gadget) if (!gadget->connected) goto out; - if (gadget->deactivated) { + if (gadget->deactivated || !gadget->udc->started) { /* * If gadget is deactivated we only save new state. * Gadget will stay disconnected after activation. @@ -779,6 +787,30 @@ int usb_gadget_disconnect(struct usb_gadget *gadget) return ret; } + +/** + * usb_gadget_disconnect - software-controlled disconnect from USB host + * @gadget:the peripheral being disconnected + * + * Disables the D+ (or potentially D-) pullup, which the host may see + * as a disconnect (when a VBUS session is active). Not all systems + * support software pullup controls. + * + * Following a successful disconnect, invoke the ->disconnect() callback + * for the current gadget driver so that UDC drivers don't need to. + * + * Returns zero on success, else negative errno. + */ +int usb_gadget_disconnect(struct usb_gadget *gadget) +{ + int ret; + + mutex_lock(&gadget->udc->connect_lock); + ret = usb_gadget_disconnect_locked(gadget); + mutex_unlock(&gadget->udc->connect_lock); + + return ret; +} EXPORT_SYMBOL_GPL(usb_gadget_disconnect); /** @@ -796,13 +828,14 @@ int usb_gadget_deactivate(struct usb_gadget *gadget) { int ret = 0; + mutex_lock(&gadget->udc->connect_lock); if (gadget->deactivated) - goto out; + goto unlock; if (gadget->connected) { - ret = usb_gadget_disconnect(gadget); + ret = usb_gadget_disconnect_locked(gadget); if (ret) - goto out; + goto unlock; /* * If gadget was being connected before deactivation, we want @@ -812,6 +845,8 @@ int usb_gadget_deactivate(struct usb_gadget *gadget) } gadget->deactivated = true; +unlock: + mutex_unlock(&gadget->udc->connect_lock); out: trace_usb_gadget_deactivate(gadget, ret); @@ -832,8 +867,9 @@ int usb_gadget_activate(struct usb_gadget *gadget) { int ret = 0; + mutex_lock(&gadget->udc->connect_lock); if (!gadget->deactivated) - goto out; + goto unlock; gadget->deactivated = false; @@ -842,8 +878,11 @@ int usb_gadget_activate(struct usb_gadget *gadget) * while it was being deactivated, we call usb_gadget_connect(). */ if (gadget->connected) - ret = usb_gadget_connect(gadget); + ret = usb_gadget_connect_locked(gadget); + mutex_unlock(&gadget->udc->connect_lock); +unlock: + mutex_unlock(&gadget->udc->connect_lock); out: trace_usb_gadget_activate(gadget, ret); @@ -1083,19 +1122,22 @@ EXPORT_SYMBOL_GPL(usb_gadget_set_state); /* ------------------------------------------------------------------------- */ -static void usb_udc_connect_control(struct usb_udc *udc) +/* Acquire connect_lock before calling this function. */ +static void usb_udc_connect_control_locked(struct usb_udc *udc) __must_hold(&udc->connect_lock) { if (udc->vbus) - usb_gadget_connect(udc->gadget); + usb_gadget_connect_locked(udc->gadget); else - usb_gadget_disconnect(udc->gadget); + usb_gadget_disconnect_locked(udc->gadget); } static void vbus_event_work(struct work_struct *work) { struct usb_udc *udc = container_of(work, struct usb_udc, vbus_work); - usb_udc_connect_control(udc); + mutex_lock(&udc->connect_lock); + usb_udc_connect_control_locked(udc); + mutex_unlock(&udc->connect_lock); } /** @@ -1144,7 +1186,7 @@ void usb_gadget_udc_reset(struct usb_gadget *gadget, EXPORT_SYMBOL_GPL(usb_gadget_udc_reset); /** - * usb_gadget_udc_start - tells usb device controller to start up + * usb_gadget_udc_start_locked - tells usb device controller to start up * @udc: The UDC to be started * * This call is issued by the UDC Class driver when it's about @@ -1155,8 +1197,11 @@ EXPORT_SYMBOL_GPL(usb_gadget_udc_reset); * necessary to have it powered on. * * Returns zero on success, else negative errno. + * + * Caller should acquire connect_lock before invoking this function. */ -static inline int usb_gadget_udc_start(struct usb_udc *udc) +static inline int usb_gadget_udc_start_locked(struct usb_udc *udc) + __must_hold(&udc->connect_lock) { int ret; @@ -1173,7 +1218,7 @@ static inline int usb_gadget_udc_start(struct usb_udc *udc) } /** - * usb_gadget_udc_stop - tells usb device controller we don't need it anymore + * usb_gadget_udc_stop_locked - tells usb device controller we don't need it anymore * @udc: The UDC to be stopped * * This call is issued by the UDC Class driver after calling @@ -1182,8 +1227,11 @@ static inline int usb_gadget_udc_start(struct usb_udc *udc) * The details are implementation specific, but it can go as * far as powering off UDC completely and disable its data * line pullups. + * + * Caller should acquire connect lock before invoking this function. */ -static inline void usb_gadget_udc_stop(struct usb_udc *udc) +static inline void usb_gadget_udc_stop_locked(struct usb_udc *udc) + __must_hold(&udc->connect_lock) { if (!udc->started) { dev_err(&udc->dev, "UDC had already stopped\n"); @@ -1342,6 +1390,7 @@ int usb_add_gadget(struct usb_gadget *gadget) udc->gadget = gadget; gadget->udc = udc; + mutex_init(&udc->connect_lock); udc->started = false; @@ -1545,12 +1594,16 @@ static int gadget_bind_driver(struct device *dev) if (ret) goto err_bind; - ret = usb_gadget_udc_start(udc); - if (ret) + mutex_lock(&udc->connect_lock); + ret = usb_gadget_udc_start_locked(udc); + if (ret) { + mutex_unlock(&udc->connect_lock); goto err_start; + } usb_gadget_enable_async_callbacks(udc); udc->allow_connect = true; - usb_udc_connect_control(udc); + usb_udc_connect_control_locked(udc); + mutex_unlock(&udc->connect_lock); kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE); return 0; @@ -1583,12 +1636,14 @@ static void gadget_unbind_driver(struct device *dev) udc->allow_connect = false; cancel_work_sync(&udc->vbus_work); - usb_gadget_disconnect(gadget); + mutex_lock(&udc->connect_lock); + usb_gadget_disconnect_locked(gadget); usb_gadget_disable_async_callbacks(udc); if (gadget->irq) synchronize_irq(gadget->irq); udc->driver->unbind(gadget); - usb_gadget_udc_stop(udc); + usb_gadget_udc_stop_locked(udc); + mutex_unlock(&udc->connect_lock); mutex_lock(&udc_lock); driver->is_bound = false; @@ -1674,11 +1729,15 @@ static ssize_t soft_connect_store(struct device *dev, } if (sysfs_streq(buf, "connect")) { - usb_gadget_udc_start(udc); - usb_gadget_connect(udc->gadget); + mutex_lock(&udc->connect_lock); + usb_gadget_udc_start_locked(udc); + usb_gadget_connect_locked(udc->gadget); + mutex_unlock(&udc->connect_lock); } else if (sysfs_streq(buf, "disconnect")) { - usb_gadget_disconnect(udc->gadget); - usb_gadget_udc_stop(udc); + mutex_lock(&udc->connect_lock); + usb_gadget_disconnect_locked(udc->gadget); + usb_gadget_udc_stop_locked(udc); + mutex_unlock(&udc->connect_lock); } else { dev_err(dev, "unsupported command '%s'\n", buf); ret = -EINVAL;