From patchwork Mon Mar 7 15:10:44 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jan Glauber X-Patchwork-Id: 593002 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id A02F01400A0 for ; Tue, 8 Mar 2016 02:14:46 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753171AbcCGPOp (ORCPT ); Mon, 7 Mar 2016 10:14:45 -0500 Received: from mail-wm0-f66.google.com ([74.125.82.66]:33992 "EHLO mail-wm0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752568AbcCGPLQ (ORCPT ); Mon, 7 Mar 2016 10:11:16 -0500 Received: by mail-wm0-f66.google.com with SMTP id p65so11291496wmp.1; Mon, 07 Mar 2016 07:11:15 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:in-reply-to:references; bh=toZ8hzvJVskf+TjXfw65Lfqsq2SWeuqJrkI8NQ4atQY=; b=AaMg0RoPIJbuub1bEgnvDpirEyQG0VpZHFuqu4A+aW2cw/TszW2EtAkH1WwQu1nP6s p2Onbpk8Nx2qbhnLhKW+cBlclUXGKJog1vYIsH1dgd2M5hp716wGAvtHyGN2AwnCyrLT RcFP4bREX2GOpi0wskcqphKfTGpcHpnD+1UhazcLELrd0OWsf3V+coF+bEoCXKfnXF53 k6IngE3r6fAtBfwmTrD53zAy4TPJ4QjxB0rd5AKdGMA2vweD8I8ncwG2TOMRjcR75hgC VM1GqqiZDGveWPSDS/40G1h2BWmUYY48GvD7YoZz5O15Q0kQYKCCHX16ZY88Z4vx39o2 BI9g== X-Gm-Message-State: AD7BkJIKmOtct3aajUJV/xBa5FgjlzdfpLcFhTg0jOBuZsRd0qKDySZhsBAvyOpa4qu6jQ== X-Received: by 10.28.91.142 with SMTP id p136mr14052046wmb.76.1457363474805; Mon, 07 Mar 2016 07:11:14 -0800 (PST) Received: from localhost.localdomain (dslb-088-066-101-161.088.066.pools.vodafone-ip.de. [88.66.101.161]) by smtp.gmail.com with ESMTPSA id m63sm14243982wmc.3.2016.03.07.07.11.13 (version=TLSv1/SSLv3 cipher=OTHER); Mon, 07 Mar 2016 07:11:14 -0800 (PST) From: Jan Glauber To: Wolfram Sang Cc: linux-kernel@vger.kernel.org, linux-i2c@vger.kernel.org, David Daney , Jan Glauber Subject: [PATCH v3 01/14] i2c-octeon: Cleanup kerneldoc comments Date: Mon, 7 Mar 2016 16:10:44 +0100 Message-Id: <57cc6122a97b3c33c5a96e83bffa7d074908bfda.1457362545.git.jglauber@cavium.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: References: In-Reply-To: References: Sender: linux-i2c-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org Remove point after parameter description and replace kerneldoc by a comment if it has no additional no value. Signed-off-by: Jan Glauber --- drivers/i2c/busses/i2c-octeon.c | 89 ++++++++++++++++++----------------------- 1 file changed, 39 insertions(+), 50 deletions(-) diff --git a/drivers/i2c/busses/i2c-octeon.c b/drivers/i2c/busses/i2c-octeon.c index 32914ab..4a08418 100644 --- a/drivers/i2c/busses/i2c-octeon.c +++ b/drivers/i2c/busses/i2c-octeon.c @@ -73,10 +73,10 @@ struct octeon_i2c { }; /** - * octeon_i2c_write_sw - write an I2C core register. - * @i2c: The struct octeon_i2c. - * @eop_reg: Register selector. - * @data: Value to be written. + * octeon_i2c_write_sw - write an I2C core register + * @i2c: The struct octeon_i2c + * @eop_reg: Register selector + * @data: Value to be written * * The I2C core registers are accessed indirectly via the SW_TWSI CSR. */ @@ -93,9 +93,9 @@ static void octeon_i2c_write_sw(struct octeon_i2c *i2c, } /** - * octeon_i2c_read_sw - write an I2C core register. - * @i2c: The struct octeon_i2c. - * @eop_reg: Register selector. + * octeon_i2c_read_sw - write an I2C core register + * @i2c: The struct octeon_i2c + * @eop_reg: Register selector * * Returns the data. * @@ -115,8 +115,8 @@ static u8 octeon_i2c_read_sw(struct octeon_i2c *i2c, u64 eop_reg) /** * octeon_i2c_write_int - write the TWSI_INT register - * @i2c: The struct octeon_i2c. - * @data: Value to be written. + * @i2c: The struct octeon_i2c + * @data: Value to be written */ static void octeon_i2c_write_int(struct octeon_i2c *i2c, u64 data) { @@ -125,8 +125,8 @@ static void octeon_i2c_write_int(struct octeon_i2c *i2c, u64 data) } /** - * octeon_i2c_int_enable - enable the TS interrupt. - * @i2c: The struct octeon_i2c. + * octeon_i2c_int_enable - enable the CORE interrupt + * @i2c: The struct octeon_i2c * * The interrupt will be asserted when there is non-STAT_IDLE state in * the SW_TWSI_EOP_TWSI_STAT register. @@ -136,22 +136,18 @@ static void octeon_i2c_int_enable(struct octeon_i2c *i2c) octeon_i2c_write_int(i2c, 0x40); } -/** - * octeon_i2c_int_disable - disable the TS interrupt. - * @i2c: The struct octeon_i2c. - */ +/* disable the CORE interrupt */ static void octeon_i2c_int_disable(struct octeon_i2c *i2c) { octeon_i2c_write_int(i2c, 0); } /** - * octeon_i2c_unblock - unblock the bus. - * @i2c: The struct octeon_i2c. + * octeon_i2c_unblock - unblock the bus + * @i2c: The struct octeon_i2c * - * If there was a reset while a device was driving 0 to bus, - * bus is blocked. We toggle it free manually by some clock - * cycles and send a stop. + * If there was a reset while a device was driving 0 to bus, bus is blocked. + * We toggle it free manually by some clock cycles and send a stop. */ static void octeon_i2c_unblock(struct octeon_i2c *i2c) { @@ -171,11 +167,7 @@ static void octeon_i2c_unblock(struct octeon_i2c *i2c) octeon_i2c_write_int(i2c, 0x0); } -/** - * octeon_i2c_isr - the interrupt service routine. - * @int: The irq, unused. - * @dev_id: Our struct octeon_i2c. - */ +/* interrupt service routine */ static irqreturn_t octeon_i2c_isr(int irq, void *dev_id) { struct octeon_i2c *i2c = dev_id; @@ -193,8 +185,8 @@ static int octeon_i2c_test_iflg(struct octeon_i2c *i2c) } /** - * octeon_i2c_wait - wait for the IFLG to be set. - * @i2c: The struct octeon_i2c. + * octeon_i2c_wait - wait for the IFLG to be set + * @i2c: The struct octeon_i2c * * Returns 0 on success, otherwise a negative errno. */ @@ -219,8 +211,8 @@ static int octeon_i2c_wait(struct octeon_i2c *i2c) } /** - * octeon_i2c_start - send START to the bus. - * @i2c: The struct octeon_i2c. + * octeon_i2c_start - send START to the bus + * @i2c: The struct octeon_i2c * * Returns 0 on success, otherwise a negative errno. */ @@ -260,8 +252,8 @@ static int octeon_i2c_start(struct octeon_i2c *i2c) } /** - * octeon_i2c_stop - send STOP to the bus. - * @i2c: The struct octeon_i2c. + * octeon_i2c_stop - send STOP to the bus + * @i2c: The struct octeon_i2c * * Returns 0 on success, otherwise a negative errno. */ @@ -282,11 +274,11 @@ static int octeon_i2c_stop(struct octeon_i2c *i2c) } /** - * octeon_i2c_write - send data to the bus. - * @i2c: The struct octeon_i2c. - * @target: Target address. - * @data: Pointer to the data to be sent. - * @length: Length of the data. + * octeon_i2c_write - send data to the bus via low-level controller + * @i2c: The struct octeon_i2c + * @target: Target address + * @data: Pointer to the data to be sent + * @length: Length of the data * * The address is sent over the bus, then the data. * @@ -330,11 +322,11 @@ static int octeon_i2c_write(struct octeon_i2c *i2c, int target, } /** - * octeon_i2c_read - receive data from the bus. - * @i2c: The struct octeon_i2c. - * @target: Target address. - * @data: Pointer to the location to store the datae . - * @length: Length of the data. + * octeon_i2c_read - receive data from the bus via low-level controller + * @i2c: The struct octeon_i2c + * @target: Target address + * @data: Pointer to the location to store the data + * @length: Length of the data * * The address is sent over the bus, then the data is read. * @@ -386,13 +378,12 @@ static int octeon_i2c_read(struct octeon_i2c *i2c, int target, } /** - * octeon_i2c_xfer - The driver's master_xfer function. - * @adap: Pointer to the i2c_adapter structure. - * @msgs: Pointer to the messages to be processed. - * @num: Length of the MSGS array. + * octeon_i2c_xfer - The driver's master_xfer function + * @adap: Pointer to the i2c_adapter structure + * @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. */ static int octeon_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs, @@ -438,9 +429,7 @@ static struct i2c_adapter octeon_i2c_ops = { .timeout = HZ / 50, }; -/** - * octeon_i2c_setclock - Calculate and set clock divisors. - */ +/* calculate and set clock divisors */ static int octeon_i2c_setclock(struct octeon_i2c *i2c) { int tclk, thp_base, inc, thp_idx, mdiv_idx, ndiv_idx, foscl, diff;