From patchwork Thu Aug 24 22:13:18 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 110959 Delivered-To: patch@linaro.org Received: by 10.140.95.78 with SMTP id h72csp76615qge; Thu, 24 Aug 2017 15:13:24 -0700 (PDT) X-Received: by 10.84.211.136 with SMTP id c8mr8303026pli.92.1503612803979; Thu, 24 Aug 2017 15:13:23 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1503612803; cv=none; d=google.com; s=arc-20160816; b=Lb59nJDgKWEA1mIJHRX0xz1bjaxl6pZAdHWvoAthT+R/i95VfBnWzHhKq7NZw8CkqA g9kdbqmlUZyfbDmqJtkef2X7Gikyy1CyHT9SAmPeX/7hv3EAXPS8KEM2isqj/n2i77z2 lJr7+hlPhH+bdE4D/EUuUJFid4VK0h8YxqA8nCj0+Y8KfmS4GUpzchLn7C/xSwkRW9uO Huk9qLnIuRmOZveTLoJ7uvFGkbtxDXiDZ+t7mLK3tjMjmmlu0QOJkdCoDPXqfE2Gsy9C lf37HuCWEKfONxKQqTIFE574KrZVUkMFhYYTrONC8dCn2gQ1ask1E7lvnssFbyQBYSaU 5Emg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :organization:message-id:subject:cc:to:from:date :arc-authentication-results; bh=tnL8WOnJXZVo48Is2pUkPs6x8YTDLwlo0u4ar0lZAS0=; b=Hiq6IWNnLaXDYmZvvP5tZpRUjmOVnlWdV9JfLyvSE1jaonzgQRJmvSRZJCUoaqATTQ kZdq5btEBJYIumAtQYp/82jgTJNk8+1FiE894XPyNFImggU09tJZJNmBPC4WF4DXfQuK o1QR/Dy4tbR0jaOOecbn8Ihi+Q1n88IXNNT8QgMDyAV7u+yrxHaDncAq6eGidcPeLYPp 1Dk1RWvZpcwcqRcMNl0QOymHIObK3UGxjG51j7UP8NMSPbcegt47v2rlIkIEszaHXI9C 7VSYRHrPfD5Mw8+CGbgyoNIDPiNUS9+Yfmkd1wWEYpYgzqYnae6iDbhcAjEiVjlRDk2R KqDA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-usb-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-usb-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id o64si3500051pfk.249.2017.08.24.15.13.23; Thu, 24 Aug 2017 15:13:23 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-usb-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-usb-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-usb-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754014AbdHXWNV (ORCPT + 4 others); Thu, 24 Aug 2017 18:13:21 -0400 Received: from ms.lwn.net ([45.79.88.28]:48098 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753977AbdHXWNU (ORCPT ); Thu, 24 Aug 2017 18:13:20 -0400 Received: from lwn.net (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 4906031D; Thu, 24 Aug 2017 22:13:19 +0000 (UTC) Date: Thu, 24 Aug 2017 16:13:18 -0600 From: Jonathan Corbet To: Felipe Balbi Cc: linux-usb@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH] usb: gadget: Add kerneldoc for some neglected structure fields Message-ID: <20170824161318.7915f73d@lwn.net> Organization: LWN.net MIME-Version: 1.0 Sender: linux-usb-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-usb@vger.kernel.org A couple of structures in have incomplete kerneldoc comments, leading to these warnings in the docs build: ./include/linux/usb/gadget.h:230: warning: No description found for parameter 'claimed' ./include/linux/usb/gadget.h:230: warning: No description found for parameter 'enabled' ./include/linux/usb/gadget.h:412: warning: No description found for parameter 'quirk_altset_not_supp' ./include/linux/usb/gadget.h:412: warning: No description found for parameter 'quirk_stall_not_supp' ./include/linux/usb/gadget.h:412: warning: No description found for parameter 'quirk_zlp_not_supp' Document those fields to make the warnings go away. Signed-off-by: Jonathan Corbet --- include/linux/usb/gadget.h | 5 +++++ 1 file changed, 5 insertions(+) -- 2.13.4 -- To unsubscribe from this list: send the line "unsubscribe linux-usb" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html diff --git a/include/linux/usb/gadget.h b/include/linux/usb/gadget.h index 1a4a4bacfae6..49d8e2b7ae4a 100644 --- a/include/linux/usb/gadget.h +++ b/include/linux/usb/gadget.h @@ -186,6 +186,8 @@ struct usb_ep_caps { * @ops: Function pointers used to access hardware-specific operations. * @ep_list:the gadget's ep_list holds all of its endpoints * @caps:The structure describing types and directions supported by endoint. + * @enabled: The current endpoint enabled/disabled state. + * @claimed: True if this endpoint is claimed by a function. * @maxpacket:The maximum packet size used on this endpoint. The initial * value can sometimes be reduced (hardware allowing), according to * the endpoint descriptor used to configure the endpoint. @@ -347,6 +349,9 @@ struct usb_gadget_ops { * or B-Peripheral wants to take host role. * @quirk_ep_out_aligned_size: epout requires buffer size to be aligned to * MaxPacketSize. + * @quirk_altset_not_supp: UDC controller doesn't support alt settings. + * @quirk_stall_not_supp: UDC controller doesn't support stalling. + * @quirk_zlp_not_supp: UDC controller doesn't support ZLP. * @quirk_avoids_skb_reserve: udc/platform wants to avoid skb_reserve() in * u_ether.c to improve performance. * @is_selfpowered: if the gadget is self-powered.