linux-i2c.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	Thor Thayer <thor.thayer@linux.intel.com>,
	linux-i2c@vger.kernel.org
Subject: [PATCH 04/16] i2c: busses: i2c-altera: Fix formatting issue in struct and demote unworthy kernel-doc headers
Date: Thu, 20 May 2021 20:00:53 +0100	[thread overview]
Message-ID: <20210520190105.3772683-5-lee.jones@linaro.org> (raw)
In-Reply-To: <20210520190105.3772683-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/i2c/busses/i2c-altera.c:74: warning: cannot understand function prototype: 'struct altr_i2c_dev '
 drivers/i2c/busses/i2c-altera.c:180: warning: Function parameter or member 'idev' not described in 'altr_i2c_transfer'
 drivers/i2c/busses/i2c-altera.c:180: warning: Function parameter or member 'data' not described in 'altr_i2c_transfer'
 drivers/i2c/busses/i2c-altera.c:193: warning: Function parameter or member 'idev' not described in 'altr_i2c_empty_rx_fifo'
 drivers/i2c/busses/i2c-altera.c:209: warning: Function parameter or member 'idev' not described in 'altr_i2c_fill_tx_fifo'

Cc: Thor Thayer <thor.thayer@linux.intel.com>
Cc: linux-i2c@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/i2c/busses/i2c-altera.c | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/drivers/i2c/busses/i2c-altera.c b/drivers/i2c/busses/i2c-altera.c
index 7d62cbda6e06c..354cf7e45c4a0 100644
--- a/drivers/i2c/busses/i2c-altera.c
+++ b/drivers/i2c/busses/i2c-altera.c
@@ -55,7 +55,7 @@
 #define ALTR_I2C_XFER_TIMEOUT	(msecs_to_jiffies(250))
 
 /**
- * altr_i2c_dev - I2C device context
+ * struct altr_i2c_dev - I2C device context
  * @base: pointer to register struct
  * @msg: pointer to current message
  * @msg_len: number of bytes transferred in msg
@@ -172,7 +172,7 @@ static void altr_i2c_init(struct altr_i2c_dev *idev)
 	altr_i2c_int_enable(idev, ALTR_I2C_ALL_IRQ, false);
 }
 
-/**
+/*
  * altr_i2c_transfer - On the last byte to be transmitted, send
  * a Stop bit on the last byte.
  */
@@ -185,7 +185,7 @@ static void altr_i2c_transfer(struct altr_i2c_dev *idev, u32 data)
 		writel(data, idev->base + ALTR_I2C_TFR_CMD);
 }
 
-/**
+/*
  * altr_i2c_empty_rx_fifo - Fetch data from RX FIFO until end of
  * transfer. Send a Stop bit on the last byte.
  */
@@ -201,9 +201,8 @@ static void altr_i2c_empty_rx_fifo(struct altr_i2c_dev *idev)
 	}
 }
 
-/**
+/*
  * altr_i2c_fill_tx_fifo - Fill TX FIFO from current message buffer.
- * @return: Number of bytes left to transfer.
  */
 static int altr_i2c_fill_tx_fifo(struct altr_i2c_dev *idev)
 {
-- 
2.31.1


  parent reply	other threads:[~2021-05-20 19:01 UTC|newest]

Thread overview: 52+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-20 19:00 [PATCH 00/16] Rid W=1 warnings from I2C Lee Jones
2021-05-20 19:00 ` [PATCH 01/16] i2c: busses: i2c-nomadik: Fix formatting issue pertaining to 'timeout' Lee Jones
2021-05-27  0:21   ` Linus Walleij
2021-05-27 19:28   ` Wolfram Sang
2021-05-28  7:58     ` Lee Jones
2021-05-28  8:00       ` Wolfram Sang
2021-05-28  8:17         ` Lee Jones
2021-05-20 19:00 ` [PATCH 02/16] i2c: muxes: i2c-arb-gpio-challenge: Demote non-conformant kernel-doc headers Lee Jones
2021-05-20 19:33   ` Doug Anderson
2021-05-21  6:32   ` Peter Rosin
2021-05-27 19:30   ` Wolfram Sang
2021-05-20 19:00 ` [PATCH 03/16] i2c: busses: i2c-ali1563: File headers are not good candidates for kernel-doc Lee Jones
2021-05-21 10:06   ` Jean Delvare
2021-05-27 19:30   ` Wolfram Sang
2021-05-20 19:00 ` Lee Jones [this message]
2021-06-03 20:25   ` [PATCH 04/16] i2c: busses: i2c-altera: Fix formatting issue in struct and demote unworthy kernel-doc headers Wolfram Sang
2021-05-20 19:00 ` [PATCH 05/16] i2c: busses: i2c-axxia: " Lee Jones
2021-06-03 20:27   ` Wolfram Sang
2021-06-04  8:49     ` Lee Jones
2021-05-20 19:00 ` [PATCH 06/16] i2c: busses: i2c-cadence: Fix incorrectly documented 'enum cdns_i2c_slave_mode' Lee Jones
2021-05-24  6:49   ` Michal Simek
2021-05-20 19:00 ` [PATCH 07/16] i2c: busses: i2c-designware-master: Fix misnaming of 'i2c_dw_init_master()' Lee Jones
2021-05-21  7:03   ` Jarkko Nikula
2021-05-20 19:00 ` [PATCH 08/16] i2c: busses: i2c-eg20t: Fix 'bad line' issue and provide description for 'msgs' param Lee Jones
2021-05-27 19:33   ` Wolfram Sang
2021-05-20 19:00 ` [PATCH 09/16] i2c: busses: i2c-mxs: Demote barely half complete kernel-doc header Lee Jones
2021-06-03 20:29   ` Wolfram Sang
2021-06-04  8:47     ` Lee Jones
2021-06-04  9:06       ` Wolfram Sang
2021-06-04  9:32         ` Lee Jones
2021-05-20 19:00 ` [PATCH 10/16] i2c: busses: i2c-ocores: Place the expected function names into the documentation headers Lee Jones
2021-05-20 19:12   ` Andrew Lunn
2021-05-20 20:21   ` Peter Korsgaard
2021-05-27 19:33   ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 11/16] i2c: busses: i2c-pnx: Provide descriptions for 'alg_data' data structure Lee Jones
2021-05-21  6:24   ` Vladimir Zapolskiy
2021-05-20 19:01 ` [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete ones Lee Jones
2021-05-20 21:52   ` Heiko Stübner
2021-05-21  6:56     ` Lee Jones
2021-06-19 22:07   ` Heiko Stuebner
2021-05-20 19:01 ` [PATCH 13/16] i2c: busses: i2c-st: Fix copy/paste function misnaming issues Lee Jones
2021-05-21 14:17   ` Alain Volmat
2021-05-21 14:23     ` Alain Volmat
2021-05-27 19:35   ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 14/16] i2c: busses: i2c-stm32f4: Remove incorrectly placed ' ' from function name Lee Jones
2021-05-21 14:20   ` Alain Volmat
2021-05-27 19:35   ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 15/16] i2c: busses: i2c-tegra-bpmp: Demote kernel-doc abuses Lee Jones
2021-06-01 15:04   ` Thierry Reding
2021-05-20 19:01 ` [PATCH 16/16] i2c: busses: i2c-st: trivial: Fix spelling issue 'enmpty => empty' Lee Jones
2021-05-21 14:23   ` Alain Volmat
2021-05-27 19:38     ` Wolfram Sang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210520190105.3772683-5-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=thor.thayer@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).