From patchwork Wed Jun 24 15:07:04 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11623509 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 013B3138C for ; Wed, 24 Jun 2020 15:13:49 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 779C62076E for ; Wed, 24 Jun 2020 15:13:48 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="ztd+LEv1"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="BtZw33dN" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 779C62076E Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-Id:Date: Subject:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=aqVmFAky1d5UCR+flPnxiLcUksy8478MXreHmCcojpg=; b=ztd+LEv1ktaT3U0nt3cufVIZ+ dw7Mb3X/WORNJw2ugwlNo3pOraTaAweOX9C1U2Xkk3KIEMZghQYW4E9MD8hdXuYz7oM2/UeaYuxdu CQrwOjdhJ3h8ryEpJxouYYrZBmhxCowvgJXCvo+YY1nu5dsu6C/BWfUeOW97UC2OcW9B6iOE6yabU iiUAAx2m8I0riwIymx7IFVFx0in0pE4/kHImVRtSK946AaIeFcGxIrPYGMoTd2ckSm0QZVhKtyNLF E0WCjAnXtGcTLBidMdjyrfQdoGJwRp27X+oQxMo3Fyfvf+j/AL55umJye6/P5Vx1HGJyZgMnLeQE9 WtcmnvXyg==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jo73M-0006Xd-Aa; Wed, 24 Jun 2020 15:11:08 +0000 Received: from mail-wr1-x442.google.com ([2a00:1450:4864:20::442]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jo6zn-0004FM-07 for linux-arm-kernel@lists.infradead.org; Wed, 24 Jun 2020 15:07:30 +0000 Received: by mail-wr1-x442.google.com with SMTP id v3so2661210wrc.1 for ; Wed, 24 Jun 2020 08:07:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=kSPgE+bGgsMdGhCfRjJWoo3vTL9/vYYp2AF2KnCRX7A=; b=BtZw33dNk6XR2atGnsBkwFUuIxaaSCIFGdnyixfM0UlnYDV3zzT6lb6+aa5UD58UCe tElHor7dZl5GsAKmFmBg3dY+AfhyaoGNRDv2IttT/kiYEg0K6OEVNIX2BjsVMyL6D1Vh pl74LjR7qUunaQwqNmFvpQ8M5npMEODYp/0U4aA7dzfTv0oXX9GuIPNlYKwdGJulKZNC xK911HEq5deWXhRuEJqGaat8+7llFxgHSGLbdqhi18VSQhB6s0rrfYtB0yK78ppQSKlp 1mdd1eqdW9hbgOZwIWTNEFDWEsKFNNT8+oTEHAvTj92jtOvOonh5b99Z7mXBqFc9znrQ 7Bow== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=kSPgE+bGgsMdGhCfRjJWoo3vTL9/vYYp2AF2KnCRX7A=; b=V+k6KbZnfyO9hHsW1c1B2EAHPaeza599JVkMWVYYw1QeuvAp0J041r7ASQlcSLd4Jz 8wL4p8mtaku2N2iupJ+eTYY4CvR8dk+UjjMz9X9rb8Zgk6JrtA8oY+2e51OlL1tSDrY4 HB9SugGbRjY2tODnJcXvxtO141rv1CO268juIYxE9JkB57lajlIi6l65gbgJmcRkLRuF Ah37VN7cBtiCbXw1cdz3NX01HH0tqip1zaok1mjuJ0US25CfoPtNZ2FECTolaEott286 rzY5PFIn1saiEiKYU07STvpOWCfBlukQsuEb9UwJinZyNx+p0ADqbjGVSlsjUidlX350 Kv3Q== X-Gm-Message-State: AOAM530WopeUXmBglelzW9RZbqdHVCcsmyTPquIRTDM5PNk7Wq5f3MTL 1fkXRp3vtYJKZjLsKyy8My13ww== X-Google-Smtp-Source: ABdhPJxdMcci8lbcX4ZJfwIvm45gJk47ZSdYDBO+zWr066+2R6dxBc4cWi4TqiTyAHdaGplxmjK/Kg== X-Received: by 2002:adf:ff90:: with SMTP id j16mr17817455wrr.364.1593011243632; Wed, 24 Jun 2020 08:07:23 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id h14sm11543361wrt.36.2020.06.24.08.07.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Jun 2020 08:07:23 -0700 (PDT) From: Lee Jones To: lee.jones@linaro.org Subject: [PATCH 10/10] mfd: wm831x-core: Supply description wm831x_reg_{un}lock args Date: Wed, 24 Jun 2020 16:07:04 +0100 Message-Id: <20200624150704.2729736-11-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200624150704.2729736-1-lee.jones@linaro.org> References: <20200624150704.2729736-1-lee.jones@linaro.org> MIME-Version: 1.0 X-Spam-Note: CRM114 invocation failed X-Spam-Score: -0.2 (/) X-Spam-Report: SpamAssassin version 3.4.4 on merlin.infradead.org summary: Content analysis details: (-0.2 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [2a00:1450:4864:20:0:0:0:442 listed in] [list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: stable@vger.kernel.org, Mark Brown , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, patches@opensource.cirrus.com Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org Kerneldoc syntax is used, but not complete. Descriptions required. Prevents warnings like: drivers/mfd/wm831x-core.c:119: warning: Function parameter or member 'wm831x' not described in 'wm831x_reg_lock' drivers/mfd/wm831x-core.c:145: warning: Function parameter or member 'wm831x' not described in 'wm831x_reg_unlock' Cc: Cc: Mark Brown Cc: patches@opensource.cirrus.com Signed-off-by: Lee Jones Acked-by: Charles Keepax --- drivers/mfd/wm831x-core.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/drivers/mfd/wm831x-core.c b/drivers/mfd/wm831x-core.c index 02f879b23d9f6..b0344e5353e4f 100644 --- a/drivers/mfd/wm831x-core.c +++ b/drivers/mfd/wm831x-core.c @@ -114,6 +114,8 @@ static int wm831x_reg_locked(struct wm831x *wm831x, unsigned short reg) * The WM831x has a user key preventing writes to particularly * critical registers. This function locks those registers, * allowing writes to them. + * + * @wm831x: pointer to local driver data structure */ void wm831x_reg_lock(struct wm831x *wm831x) { @@ -140,6 +142,8 @@ EXPORT_SYMBOL_GPL(wm831x_reg_lock); * The WM831x has a user key preventing writes to particularly * critical registers. This function locks those registers, * preventing spurious writes. + * + * @wm831x: pointer to local driver data structure */ int wm831x_reg_unlock(struct wm831x *wm831x) {