From patchwork Mon Jun 29 14:04:35 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11631005 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 8D3FD912 for ; Mon, 29 Jun 2020 14:08:43 +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 664BD23D98 for ; Mon, 29 Jun 2020 14:08:43 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="ZBDPCZln"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="jOLEqH8u" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 664BD23D98 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=Js/fzi8wLId2j7Kts08hCZb/su2ahamrxAkDB5e2t80=; b=ZBDPCZlniJ4KP+0LACc+RcsQg o3MIZWCRXUgSc1MlMUJLJORf1OxgtF1p6lX3KfYoGvcZm8g2uxMvtlc3Z9I4Ml9LY3ZOcK5CshNCm 18A80iHDzIwphnAgrqHsoIpwLc77YjZpGOXlf9gLPPt/sWTBS75YTmHFCidX1oCFFGmOisTHOL7zH bacQG3D5u5zQgMtasmu1mbQa8ATBtS4mgX0gQQ5CELM/FCVMf47QsBBFsUhUF1ZChl/gcHEvr7UZ/ 5G96wuBEK89gn5jgrgORDBxVhnvRIoqYgGbnvBiqWkvLT/BT40f31jN3bDCxBTOR8XtxB0acVEwCm ZPXgG3DOg==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jpuQW-0004r1-VK; Mon, 29 Jun 2020 14:06:29 +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 1jpuP9-0004GL-5y for linux-arm-kernel@lists.infradead.org; Mon, 29 Jun 2020 14:05:06 +0000 Received: by mail-wr1-x442.google.com with SMTP id s10so16639621wrw.12 for ; Mon, 29 Jun 2020 07:05:02 -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=Mu+wXsRAPVJI2BbUnA6whI4V192flwFfYNz4LkoWH3w=; b=jOLEqH8u8fh6v6UYWj7y6Sg98lssQOe4aTyeSL0IikxGXCqZutLG6GKlQ9BXJNekwO pA0FLrP45RJazv/O776JiqFwBiM9SSicqTdF0HmAHU3jsaAj1VlHgzlj9wY/GzgB17pM ubWy6qfRPbBvZ8J3w1kxyXFv/IeI5waIMPcfmr2zcYZvZlRxT2dwWNaRuE4Puv/HfYYT nIkmrT8A+p9sCGg0k4ohno1ddfnIdqPqRPEFbj0iJclDIK6PzXYisbdjyd+W2gD3vfvk Zsevyfjt6lHQNZDymm97hSlwNKvxpXflu4E4I+3qDDPb+o+TP01B05fqRjFg7PI25dmS Rl1A== 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=Mu+wXsRAPVJI2BbUnA6whI4V192flwFfYNz4LkoWH3w=; b=DF3Q7WvDGiQoKe945ByvR479xD+iP7rOQJl7wlwYcPHY0BVKF6VVYhv0a9k4e2UjzX IJV3WWFg3l6HzhOo5Agm8Skg6ytUdOjVqHaICY71q6lD8FO58Y4NyjBY69bGUCajSEVW fpNl4aux5lGtI8PR3YcUPFoMHFzF4aDwg/pcQqGuNXWjCxtiAE6M/xu8qU2D5nGXMn4z EmmVr3YfC4d6Mk3JxAVFgT8TmSHLNfitJoZuLmTAHtT8LWsShXkAZRYQOthDbDj0Npn4 SIuFHzBvoL6RHj56o/0eBk+sM3cOAQtrYuUTskQflXHBpIw547iDddtz1M/c+8Izdpkf IGrQ== X-Gm-Message-State: AOAM532HuQTO/JNTekBKRHdqVww7EE05RUYVxItZcejjge7PonKrZIHh eK45A8K5NDel6Q3SDPu6okmrSg== X-Google-Smtp-Source: ABdhPJznnVAOrd15Z7Gc4f8Mk9Y3wkQjwCks7QOJqn2xOTJTvoqY/62dUv1+U/NtBEe3EVYh+Ui3rw== X-Received: by 2002:a5d:4a45:: with SMTP id v5mr17241252wrs.228.1593439501944; Mon, 29 Jun 2020 07:05:01 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id p14sm15394928wrj.14.2020.06.29.07.05.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 29 Jun 2020 07:05:00 -0700 (PDT) From: Lee Jones To: arnd@arndb.de, gregkh@linuxfoundation.org Subject: [PATCH 13/20] misc: pch_phub: Provide descriptions for 'chip' argument Date: Mon, 29 Jun 2020 15:04:35 +0100 Message-Id: <20200629140442.1043957-14-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200629140442.1043957-1-lee.jones@linaro.org> References: <20200629140442.1043957-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_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid 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: Masayuki Ohtak , Tomoya MORINAGA , Lee Jones , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org For some reason (probably copy 'n' paste) kerneldoc descriptions were missing for all instances of 'chip'. Providing them squashes the following W=1 kernel build warnings: drivers/misc/pch_phub.c:145: warning: Function parameter or member 'chip' not described in 'pch_phub_read_modify_write_reg' drivers/misc/pch_phub.c:282: warning: Function parameter or member 'chip' not described in 'pch_phub_read_serial_rom' drivers/misc/pch_phub.c:296: warning: Function parameter or member 'chip' not described in 'pch_phub_write_serial_rom' drivers/misc/pch_phub.c:334: warning: Function parameter or member 'chip' not described in 'pch_phub_read_serial_rom_val' drivers/misc/pch_phub.c:350: warning: Function parameter or member 'chip' not described in 'pch_phub_write_serial_rom_val' drivers/misc/pch_phub.c:450: warning: Function parameter or member 'chip' not described in 'pch_phub_read_gbe_mac_addr' drivers/misc/pch_phub.c:462: warning: Function parameter or member 'chip' not described in 'pch_phub_write_gbe_mac_addr' Cc: Masayuki Ohtak Cc: Tomoya MORINAGA Signed-off-by: Lee Jones --- drivers/misc/pch_phub.c | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/drivers/misc/pch_phub.c b/drivers/misc/pch_phub.c index 60828af7506a3..95ba82a8625b0 100644 --- a/drivers/misc/pch_phub.c +++ b/drivers/misc/pch_phub.c @@ -135,6 +135,7 @@ static DEFINE_MUTEX(pch_phub_mutex); /** * pch_phub_read_modify_write_reg() - Reading modifying and writing register + * @chip: Pointer to the PHUB register structure * @reg_addr_offset: Register offset address value. * @data: Writing value. * @mask: Mask value. @@ -274,6 +275,7 @@ static void pch_phub_restore_reg_conf(struct pci_dev *pdev) /** * pch_phub_read_serial_rom() - Reading Serial ROM + * @chip: Pointer to the PHUB register structure * @offset_address: Serial ROM offset address to read. * @data: Read buffer for specified Serial ROM value. */ @@ -288,6 +290,7 @@ static void pch_phub_read_serial_rom(struct pch_phub_reg *chip, /** * pch_phub_write_serial_rom() - Writing Serial ROM + * @chip: Pointer to the PHUB register structure * @offset_address: Serial ROM offset address. * @data: Serial ROM value to write. */ @@ -326,6 +329,7 @@ static int pch_phub_write_serial_rom(struct pch_phub_reg *chip, /** * pch_phub_read_serial_rom_val() - Read Serial ROM value + * @chip: Pointer to the PHUB register structure * @offset_address: Serial ROM address offset value. * @data: Serial ROM value to read. */ @@ -342,6 +346,7 @@ static void pch_phub_read_serial_rom_val(struct pch_phub_reg *chip, /** * pch_phub_write_serial_rom_val() - writing Serial ROM value + * @chip: Pointer to the PHUB register structure * @offset_address: Serial ROM address offset value. * @data: Serial ROM value. */ @@ -444,6 +449,7 @@ static int pch_phub_gbe_serial_rom_conf_mp(struct pch_phub_reg *chip) /** * pch_phub_read_gbe_mac_addr() - Read Gigabit Ethernet MAC address * @offset_address: Gigabit Ethernet MAC address offset value. + * @chip: Pointer to the PHUB register structure * @data: Buffer of the Gigabit Ethernet MAC address value. */ static void pch_phub_read_gbe_mac_addr(struct pch_phub_reg *chip, u8 *data) @@ -456,6 +462,7 @@ static void pch_phub_read_gbe_mac_addr(struct pch_phub_reg *chip, u8 *data) /** * pch_phub_write_gbe_mac_addr() - Write MAC address * @offset_address: Gigabit Ethernet MAC address offset value. + * @chip: Pointer to the PHUB register structure * @data: Gigabit Ethernet MAC address value. */ static int pch_phub_write_gbe_mac_addr(struct pch_phub_reg *chip, u8 *data)