From patchwork Thu May 20 19:01:01 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 12271217 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-17.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 76928C433B4 for ; Thu, 20 May 2021 19:06:54 +0000 (UTC) Received: from desiato.infradead.org (desiato.infradead.org [90.155.92.199]) (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 05BF660FD9 for ; Thu, 20 May 2021 19:06:53 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 05BF660FD9 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+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=desiato.20200630; h=Sender:Content-Transfer-Encoding :Content-Type:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-Id:Date: Subject:Cc:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=zek0lL+l7d2SNTn7U49Q4CRAkeKH0C+I74dHNf3evMA=; b=P/6qzmPTnG9POO7F0o02ayOE8F dMd7uaI8NDB/BBkFyKxBCJ1dXUXorodJWqnE/QT4EFvbXLQUzmHqZIV40/P4H4tsgolR7ReDr4f/H n9eM9GI6Uj4UEOFpJANEgTCT8pbx/qhku4xX6SATpgS4CURODs2rRdUmBG7F4RKZCld8tyzlsyxlh qttsJcMhTbHM1EjIoauH/9fwF7L5JEBvqgAAg5qYQJ0mVKeKU+Pkjrs2UK9XSD3t2aNIzxsuW/bSQ 3TodCsTjQGebVpg/eEUew/G7ZxpJBxCgv++R9j01QnpNR7D/DthzdBnwinwEVG3q36EoxHNZ23J0q wfqx7yeQ==; Received: from localhost ([::1] helo=desiato.infradead.org) by desiato.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1ljnyH-002PjX-TY; Thu, 20 May 2021 19:04:40 +0000 Received: from bombadil.infradead.org ([2607:7c80:54:e::133]) by desiato.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1ljnvE-002Ogq-MK for linux-arm-kernel@desiato.infradead.org; Thu, 20 May 2021 19:01:30 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=BZ7o0VkeJdaRCEBQCoylzsFR/PU7XD67806SChIDBfA=; b=3U1n/Q5d8p9fpPmkQIp0L/Q0jl 6wDMG/15mnhUFtk0vPqFIm28qZazjgJf8Ot9KvGNHyBZ5BZpxQgkqPk+1zc+elNhO13CdIJLhtdoH DajQ2lPDpvX8V02g+yIx0hydPZ81ywdfrD8LcomqtBGXXzHEUuFasmlUPJlog+fLxaV1lK949qDoL WQTGJWlVeV8oIkSMPmlhqC1sN3oMJXlKdWVyC0MXWb0NMmNoGL42raxK6mhpiCmH546QwWEhD9yzz TRI2WatAg8x5k5Q4ZYGG8BJpJ+9KdFJDORAXPYJvgEOVFbBuV0ZFH3l86qyXQYM+rASa3rxIipRdL CRrYHYvA==; Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]) by bombadil.infradead.org with esmtps (Exim 4.94 #2 (Red Hat Linux)) id 1ljnvB-00Gaqt-3I for linux-arm-kernel@lists.infradead.org; Thu, 20 May 2021 19:01:27 +0000 Received: by mail-wm1-x332.google.com with SMTP id z85-20020a1c7e580000b029017a76f3afbaso3306137wmc.2 for ; Thu, 20 May 2021 12:01:24 -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=BZ7o0VkeJdaRCEBQCoylzsFR/PU7XD67806SChIDBfA=; b=wbPg+IuSfX0setQllon8nmJmPS/4cMhSLYh+OMtByDo5xn7lI8FHKHdoVNbV/LGIrP ER51hBIw9kz45SxLR+H4payGvH5vH3Xe2a1B1+JjDCJmCFgUw+a+aBLOG/F4h35D9Mh+ lrLdT+ouYR2uAXXht4QXwLI0Vy1CSdH9ZXkxId5A68ASNvuRvGvO+d3PbD8Hfih/eq/1 tlFN2dojL9JyyElWP7Ks/N2j2uJe5zaBYsnOJjZGIlBLbwAKGrzlX4Zv5bUpiwLXv4Lm Zhh9rw24DY3J90i4yH04shJ2WWIroytFFauUUHB91/Ib9LM7kHT76rgqfKPHuRgV7t7j K33g== 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=BZ7o0VkeJdaRCEBQCoylzsFR/PU7XD67806SChIDBfA=; b=TYLiLmAGoAxq5wRnqZx1CdqUOWJ03zTXXgO9R/iKXOOwJhcxxyOni5a+DUWT/pn2Yn iiHE67N7BnTWyzeFzoLUdHVrGKbEqZ4cZgYXM97Ut9aDMrF3bmWamcFRU1G6DPrfTIWs R0HwUD9HkkXgIzbFZbG6sEnhUX+eB5Q5Xj+LC2PbAaLkz+C3kQW8xmcp+Rk18LyGLEQw GfKjZhUA/3lbUrhFVnQyJiE2bi2X359uRxjymaEXmyMDCn+Z5s1bevoXJ3se1/r96P9O 5IQ8T1ZHubiE11L5GeUlaN1UlaOS3X45+s0Y6gEw5F/IKJTGHwrDtdN0hSL55y/e4qK6 lNyA== X-Gm-Message-State: AOAM531vkM3ZupK9LAZlOFqU+cIVGmc61zfFoof96cDnpIV0rfwOrwPT +g0KnB5zMTiUQfjtciSfITkLbQ== X-Google-Smtp-Source: ABdhPJzCaBtFp/3KcYEZ8YBWuCPtiaGYbMJURAiEOo9oNOZ0QSrbORhEb5JrppYxCy4bVZwNMF4jzQ== X-Received: by 2002:a05:600c:2312:: with SMTP id 18mr5660601wmo.0.1621537283254; Thu, 20 May 2021 12:01:23 -0700 (PDT) Received: from dell.default ([91.110.221.215]) by smtp.gmail.com with ESMTPSA id p20sm9011899wmq.10.2021.05.20.12.01.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 May 2021 12:01:22 -0700 (PDT) From: Lee Jones To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Heiko Stuebner , Max Schwarz , linux-arm-kernel@lists.infradead.org, linux-rockchip@lists.infradead.org, linux-i2c@vger.kernel.org Subject: [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete ones Date: Thu, 20 May 2021 20:01:01 +0100 Message-Id: <20210520190105.3772683-13-lee.jones@linaro.org> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210520190105.3772683-1-lee.jones@linaro.org> References: <20210520190105.3772683-1-lee.jones@linaro.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210520_120125_146921_443657C3 X-CRM114-Status: GOOD ( 13.62 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Fixes the following W=1 kernel build warning(s): drivers/i2c/busses/i2c-rk3x.c:242: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-rk3x.c:261: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-rk3x.c:304: warning: Function parameter or member 'i2c' not described in 'rk3x_i2c_prepare_read' drivers/i2c/busses/i2c-rk3x.c:304: warning: expecting prototype for Setup a read according to i2c(). Prototype was for rk3x_i2c_prepare_read() instead drivers/i2c/busses/i2c-rk3x.c:335: warning: Function parameter or member 'i2c' not described in 'rk3x_i2c_fill_transmit_buf' drivers/i2c/busses/i2c-rk3x.c:335: warning: expecting prototype for Fill the transmit buffer with data from i2c(). Prototype was for rk3x_i2c_fill_transmit_buf() instead drivers/i2c/busses/i2c-rk3x.c:535: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-rk3x.c:552: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-rk3x.c:713: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-rk3x.c:963: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-rk3x.c:973: warning: Function parameter or member 'i2c' not described in 'rk3x_i2c_setup' Cc: Heiko Stuebner Cc: Max Schwarz Cc: linux-arm-kernel@lists.infradead.org Cc: linux-rockchip@lists.infradead.org Cc: linux-i2c@vger.kernel.org Signed-off-by: Lee Jones Acked-by: Heiko Stuebner --- drivers/i2c/busses/i2c-rk3x.c | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/drivers/i2c/busses/i2c-rk3x.c b/drivers/i2c/busses/i2c-rk3x.c index 819ab4ee517e1..1dfbd1185aefc 100644 --- a/drivers/i2c/busses/i2c-rk3x.c +++ b/drivers/i2c/busses/i2c-rk3x.c @@ -238,7 +238,7 @@ static inline void rk3x_i2c_clean_ipd(struct rk3x_i2c *i2c) i2c_writel(i2c, REG_INT_ALL, REG_IPD); } -/** +/* * Generate a START condition, which triggers a REG_INT_START interrupt. */ static void rk3x_i2c_start(struct rk3x_i2c *i2c) @@ -257,7 +257,7 @@ static void rk3x_i2c_start(struct rk3x_i2c *i2c) i2c_writel(i2c, val, REG_CON); } -/** +/* * Generate a STOP condition, which triggers a REG_INT_STOP interrupt. * * @error: Error code to return in rk3x_i2c_xfer @@ -297,7 +297,7 @@ static void rk3x_i2c_stop(struct rk3x_i2c *i2c, int error) } } -/** +/* * Setup a read according to i2c->msg */ static void rk3x_i2c_prepare_read(struct rk3x_i2c *i2c) @@ -328,7 +328,7 @@ static void rk3x_i2c_prepare_read(struct rk3x_i2c *i2c) i2c_writel(i2c, len, REG_MRXCNT); } -/** +/* * Fill the transmit buffer with data from i2c->msg */ static void rk3x_i2c_fill_transmit_buf(struct rk3x_i2c *i2c) @@ -532,7 +532,7 @@ static irqreturn_t rk3x_i2c_irq(int irqno, void *dev_id) } /** - * Get timing values of I2C specification + * rk3x_i2c_get_spec() - Get timing values of I2C specification * * @speed: Desired SCL frequency * @@ -549,7 +549,7 @@ static const struct i2c_spec_values *rk3x_i2c_get_spec(unsigned int speed) } /** - * Calculate divider values for desired SCL frequency + * rk3x_i2c_v0_calc_timings() - Calculate divider values for desired SCL frequency * * @clk_rate: I2C input clock rate * @t: Known I2C timing information @@ -710,7 +710,7 @@ static int rk3x_i2c_v0_calc_timings(unsigned long clk_rate, } /** - * Calculate timing values for desired SCL frequency + * rk3x_i2c_v1_calc_timings() - Calculate timing values for desired SCL frequency * * @clk_rate: I2C input clock rate * @t: Known I2C timing information @@ -959,8 +959,8 @@ static int rk3x_i2c_clk_notifier_cb(struct notifier_block *nb, unsigned long } } -/** - * Setup I2C registers for an I2C operation specified by msgs, num. +/* + * rk3x_i2c_setup() - Setup I2C registers for an I2C operation specified by msgs, num. * * Must be called with i2c->lock held. *