From patchwork Tue Mar 11 02:34:32 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aryan Srivastava X-Patchwork-Id: 874047 Received: from gate2.alliedtelesis.co.nz (gate2.alliedtelesis.co.nz [202.36.163.20]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CE4B3EEBA for ; Tue, 11 Mar 2025 02:34:45 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=202.36.163.20 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741660488; cv=none; b=prIWSNS7G+XMZox/hqfo+LsdQYmJMznqCikKC+Jh2allMujLXW1h8g6ywWvYTVUwCgvN+OG2EanvAYAsH3q67c3IWSVtIt9rJFkGJA2G/MwrkBZlDLmCD8+j05ZT/+lWVBX3N2vQLvPJvfqEXyTyk1DEjTg5wVmS5GNmeD8aFL8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741660488; c=relaxed/simple; bh=8tSpg3imDga5tWwzzlp4L8Ce/B9GkfltKPs1gFJ1iSM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=MqvOV3tgTgSQQiV6ED6BSw1jc9ykBMR85ybaqyYRdPCuQt04KASCz41esm69K/fQD+3p5/Vc3DB2Vi9mXwBTb9FWBL93x4B8kCS3fWiq4Ua+ZOsLi5XkoPVBaWzC8b6BqsJ1xJOuj3Mt9HIEIMGPNK4BXZv5NG9ORrKZ+XF86OE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=alliedtelesis.co.nz; spf=pass smtp.mailfrom=alliedtelesis.co.nz; dkim=pass (2048-bit key) header.d=alliedtelesis.co.nz header.i=@alliedtelesis.co.nz header.b=sixPjee/; arc=none smtp.client-ip=202.36.163.20 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=alliedtelesis.co.nz Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=alliedtelesis.co.nz Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=alliedtelesis.co.nz header.i=@alliedtelesis.co.nz header.b="sixPjee/" Received: from svr-chch-seg1.atlnz.lc (mmarshal3.atlnz.lc [10.32.18.43]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by gate2.alliedtelesis.co.nz (Postfix) with ESMTPS id 842192C0658; Tue, 11 Mar 2025 15:34:38 +1300 (NZDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=alliedtelesis.co.nz; s=mail181024; t=1741660478; bh=rk12yIwRFfsZFO22IbTM3cGgVoF4j8t2R27zQgv6PRs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=sixPjee/to6mjgoJrydqcU8hS7WoVlVtnEY9NMW5T+VAado02JbUl7hwQkCL5xFWw KUdf9QPREEmaxErhKL+5S+2qfzcwU5yTt0nZDRqcU8JGyGMKlfY5OwxmVeXgWYxYVX YF5FNI/WFvcZ9aCW4WUXv1YQdyKMzi77oYyKqQtzYiu3NCFq1W8tB93LXOKN5ZL0ZK K42F0adYfpS3PUsC/rs3wvvwBj6mAjHcuii/26GpHm4yHPJRwm7Cqt6Y3mkRmOTaAm 0rO1aMtTe0SugWZTcchgyOR5UNaiv0TaeVCHsir2+8I9IBRuxDDrQnCHD2X9x2Whbh OBIwMxyifxDGQ== Received: from pat.atlnz.lc (Not Verified[10.32.16.33]) by svr-chch-seg1.atlnz.lc with Trustwave SEG (v8,2,6,11305) id ; Tue, 11 Mar 2025 15:34:38 +1300 Received: from aryans-dl.ws.atlnz.lc (aryans-dl.ws.atlnz.lc [10.33.22.38]) by pat.atlnz.lc (Postfix) with ESMTP id 6A02213ED8D; Tue, 11 Mar 2025 15:34:38 +1300 (NZDT) Received: by aryans-dl.ws.atlnz.lc (Postfix, from userid 1844) id 6770A2A1692; Tue, 11 Mar 2025 15:34:38 +1300 (NZDT) From: Aryan Srivastava To: Andi Shyti , Andy Shevchenko , Markus Elfring Cc: linux-i2c@vger.kernel.org, linux-kernel@vger.kernel.org, Aryan Srivastava , Robert Richter Subject: [PATCH v12 1/3] i2c: octeon: fix return commenting Date: Tue, 11 Mar 2025 15:34:32 +1300 Message-ID: <20250311023435.3962466-2-aryan.srivastava@alliedtelesis.co.nz> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20250311023435.3962466-1-aryan.srivastava@alliedtelesis.co.nz> References: <20250311023435.3962466-1-aryan.srivastava@alliedtelesis.co.nz> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-SEG-SpamProfiler-Analysis: v=2.4 cv=ccpxrWDM c=1 sm=1 tr=0 ts=67cfa13e a=KLBiSEs5mFS1a/PbTCJxuA==:117 a=Vs1iUdzkB0EA:10 a=HCePzOn4azgfXwQElH0A:9 a=3ZKOabzyN94A:10 X-SEG-SpamProfiler-Score: 0 x-atlnz-ls: pat Kernel-docs require a ':' to signify the return behaviour of a function with within the comment. Many functions in this file were missing ':' after the "Returns" line, resulting in kernel-doc warnings. Add the ':' to satisfy kernel-doc requirements. Signed-off-by: Aryan Srivastava --- drivers/i2c/busses/i2c-octeon-core.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/drivers/i2c/busses/i2c-octeon-core.c b/drivers/i2c/busses/i2c-octeon-core.c index 3fbc828508ab..0094fe5f7460 100644 --- a/drivers/i2c/busses/i2c-octeon-core.c +++ b/drivers/i2c/busses/i2c-octeon-core.c @@ -45,7 +45,7 @@ static bool octeon_i2c_test_iflg(struct octeon_i2c *i2c) * octeon_i2c_wait - wait for the IFLG to be set * @i2c: The struct octeon_i2c * - * Returns 0 on success, otherwise a negative errno. + * Returns: 0 on success, otherwise a negative errno. */ static int octeon_i2c_wait(struct octeon_i2c *i2c) { @@ -139,7 +139,7 @@ static void octeon_i2c_hlc_disable(struct octeon_i2c *i2c) * octeon_i2c_hlc_wait - wait for an HLC operation to complete * @i2c: The struct octeon_i2c * - * Returns 0 on success, otherwise -ETIMEDOUT. + * Returns: 0 on success, otherwise -ETIMEDOUT. */ static int octeon_i2c_hlc_wait(struct octeon_i2c *i2c) { @@ -273,7 +273,7 @@ static int octeon_i2c_recovery(struct octeon_i2c *i2c) * octeon_i2c_start - send START to the bus * @i2c: The struct octeon_i2c * - * Returns 0 on success, otherwise a negative errno. + * Returns: 0 on success, otherwise a negative errno. */ static int octeon_i2c_start(struct octeon_i2c *i2c) { @@ -314,7 +314,7 @@ static void octeon_i2c_stop(struct octeon_i2c *i2c) * * The address is sent over the bus, then the data is read. * - * Returns 0 on success, otherwise a negative errno. + * Returns: 0 on success, otherwise a negative errno. */ static int octeon_i2c_read(struct octeon_i2c *i2c, int target, u8 *data, u16 *rlength, bool recv_len) @@ -382,7 +382,7 @@ static int octeon_i2c_read(struct octeon_i2c *i2c, int target, * * The address is sent over the bus, then the data. * - * Returns 0 on success, otherwise a negative errno. + * Returns: 0 on success, otherwise a negative errno. */ static int octeon_i2c_write(struct octeon_i2c *i2c, int target, const u8 *data, int length) @@ -625,7 +625,7 @@ static int octeon_i2c_hlc_comp_write(struct octeon_i2c *i2c, struct i2c_msg *msg * @msgs: Pointer to the messages to be processed * @num: Length of the MSGS array * - * Returns the number of messages processed, or a negative errno on failure. + * Returns: the number of messages processed, or a negative errno on failure. */ int octeon_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num) {