Commit bd7784c2 authored by Jan Glauber's avatar Jan Glauber Committed by Wolfram Sang

i2c: octeon: Cleanup kerneldoc comments

Remove point after parameter description and replace kerneldoc
by a comment if it has no additional no value.
Signed-off-by: default avatarJan Glauber <jglauber@cavium.com>
Signed-off-by: default avatarWolfram Sang <wsa@the-dreams.de>
parent 95026658
...@@ -73,10 +73,10 @@ struct octeon_i2c { ...@@ -73,10 +73,10 @@ struct octeon_i2c {
}; };
/** /**
* octeon_i2c_write_sw - write an I2C core register. * octeon_i2c_write_sw - write an I2C core register
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* @eop_reg: Register selector. * @eop_reg: Register selector
* @data: Value to be written. * @data: Value to be written
* *
* The I2C core registers are accessed indirectly via the SW_TWSI CSR. * 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, ...@@ -93,9 +93,9 @@ static void octeon_i2c_write_sw(struct octeon_i2c *i2c,
} }
/** /**
* octeon_i2c_read_sw - write an I2C core register. * octeon_i2c_read_sw - write an I2C core register
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* @eop_reg: Register selector. * @eop_reg: Register selector
* *
* Returns the data. * Returns the data.
* *
...@@ -115,8 +115,8 @@ static u8 octeon_i2c_read_sw(struct octeon_i2c *i2c, u64 eop_reg) ...@@ -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 * octeon_i2c_write_int - write the TWSI_INT register
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* @data: Value to be written. * @data: Value to be written
*/ */
static void octeon_i2c_write_int(struct octeon_i2c *i2c, u64 data) 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) ...@@ -125,8 +125,8 @@ static void octeon_i2c_write_int(struct octeon_i2c *i2c, u64 data)
} }
/** /**
* octeon_i2c_int_enable - enable the TS interrupt. * octeon_i2c_int_enable - enable the CORE interrupt
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* *
* The interrupt will be asserted when there is non-STAT_IDLE state in * The interrupt will be asserted when there is non-STAT_IDLE state in
* the SW_TWSI_EOP_TWSI_STAT register. * the SW_TWSI_EOP_TWSI_STAT register.
...@@ -136,22 +136,18 @@ static void octeon_i2c_int_enable(struct octeon_i2c *i2c) ...@@ -136,22 +136,18 @@ static void octeon_i2c_int_enable(struct octeon_i2c *i2c)
octeon_i2c_write_int(i2c, 0x40); octeon_i2c_write_int(i2c, 0x40);
} }
/** /* disable the CORE interrupt */
* octeon_i2c_int_disable - disable the TS interrupt.
* @i2c: The struct octeon_i2c.
*/
static void octeon_i2c_int_disable(struct octeon_i2c *i2c) static void octeon_i2c_int_disable(struct octeon_i2c *i2c)
{ {
octeon_i2c_write_int(i2c, 0); octeon_i2c_write_int(i2c, 0);
} }
/** /**
* octeon_i2c_unblock - unblock the bus. * octeon_i2c_unblock - unblock the bus
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* *
* If there was a reset while a device was driving 0 to bus, * If there was a reset while a device was driving 0 to bus, bus is blocked.
* bus is blocked. We toggle it free manually by some clock * We toggle it free manually by some clock cycles and send a stop.
* cycles and send a stop.
*/ */
static void octeon_i2c_unblock(struct octeon_i2c *i2c) static void octeon_i2c_unblock(struct octeon_i2c *i2c)
{ {
...@@ -171,11 +167,7 @@ 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_write_int(i2c, 0x0);
} }
/** /* interrupt service routine */
* octeon_i2c_isr - the interrupt service routine.
* @int: The irq, unused.
* @dev_id: Our struct octeon_i2c.
*/
static irqreturn_t octeon_i2c_isr(int irq, void *dev_id) static irqreturn_t octeon_i2c_isr(int irq, void *dev_id)
{ {
struct octeon_i2c *i2c = dev_id; struct octeon_i2c *i2c = dev_id;
...@@ -193,8 +185,8 @@ static int octeon_i2c_test_iflg(struct octeon_i2c *i2c) ...@@ -193,8 +185,8 @@ static int octeon_i2c_test_iflg(struct octeon_i2c *i2c)
} }
/** /**
* octeon_i2c_wait - wait for the IFLG to be set. * octeon_i2c_wait - wait for the IFLG to be set
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* *
* Returns 0 on success, otherwise a negative errno. * Returns 0 on success, otherwise a negative errno.
*/ */
...@@ -219,8 +211,8 @@ static int octeon_i2c_wait(struct octeon_i2c *i2c) ...@@ -219,8 +211,8 @@ static int octeon_i2c_wait(struct octeon_i2c *i2c)
} }
/** /**
* octeon_i2c_start - send START to the bus. * octeon_i2c_start - send START to the bus
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* *
* Returns 0 on success, otherwise a negative errno. * Returns 0 on success, otherwise a negative errno.
*/ */
...@@ -260,8 +252,8 @@ static int octeon_i2c_start(struct octeon_i2c *i2c) ...@@ -260,8 +252,8 @@ static int octeon_i2c_start(struct octeon_i2c *i2c)
} }
/** /**
* octeon_i2c_stop - send STOP to the bus. * octeon_i2c_stop - send STOP to the bus
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* *
* Returns 0 on success, otherwise a negative errno. * Returns 0 on success, otherwise a negative errno.
*/ */
...@@ -282,11 +274,11 @@ static int octeon_i2c_stop(struct octeon_i2c *i2c) ...@@ -282,11 +274,11 @@ static int octeon_i2c_stop(struct octeon_i2c *i2c)
} }
/** /**
* octeon_i2c_write - send data to the bus. * octeon_i2c_write - send data to the bus via low-level controller
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* @target: Target address. * @target: Target address
* @data: Pointer to the data to be sent. * @data: Pointer to the data to be sent
* @length: Length of the data. * @length: Length of the data
* *
* The address is sent over the bus, then 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, ...@@ -330,11 +322,11 @@ static int octeon_i2c_write(struct octeon_i2c *i2c, int target,
} }
/** /**
* octeon_i2c_read - receive data from the bus. * octeon_i2c_read - receive data from the bus via low-level controller
* @i2c: The struct octeon_i2c. * @i2c: The struct octeon_i2c
* @target: Target address. * @target: Target address
* @data: Pointer to the location to store the datae . * @data: Pointer to the location to store the data
* @length: Length of the data. * @length: Length of the data
* *
* The address is sent over the bus, then the data is read. * 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, ...@@ -386,13 +378,12 @@ static int octeon_i2c_read(struct octeon_i2c *i2c, int target,
} }
/** /**
* octeon_i2c_xfer - The driver's master_xfer function. * octeon_i2c_xfer - The driver's master_xfer function
* @adap: Pointer to the i2c_adapter structure. * @adap: Pointer to the i2c_adapter structure
* @msgs: Pointer to the messages to be processed. * @msgs: Pointer to the messages to be processed
* @num: Length of the MSGS array. * @num: Length of the MSGS array
* *
* Returns the number of messages processed, or a negative errno on * Returns the number of messages processed, or a negative errno on failure.
* failure.
*/ */
static int octeon_i2c_xfer(struct i2c_adapter *adap, static int octeon_i2c_xfer(struct i2c_adapter *adap,
struct i2c_msg *msgs, struct i2c_msg *msgs,
...@@ -438,9 +429,7 @@ static struct i2c_adapter octeon_i2c_ops = { ...@@ -438,9 +429,7 @@ static struct i2c_adapter octeon_i2c_ops = {
.timeout = HZ / 50, .timeout = HZ / 50,
}; };
/** /* calculate and set clock divisors */
* octeon_i2c_setclock - Calculate and set clock divisors.
*/
static int octeon_i2c_setclock(struct octeon_i2c *i2c) static int octeon_i2c_setclock(struct octeon_i2c *i2c)
{ {
int tclk, thp_base, inc, thp_idx, mdiv_idx, ndiv_idx, foscl, diff; int tclk, thp_base, inc, thp_idx, mdiv_idx, ndiv_idx, foscl, diff;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment