Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b05664e0 authored by Randy Dunlap's avatar Randy Dunlap Committed by Greg Kroah-Hartman
Browse files

i2c: rk3x: fix a bunch of kernel-doc warnings 



[ Upstream commit 0582d984793d30442da88fe458674502bad1ad29 ]

Fix multiple W=1 kernel-doc warnings in i2c-rk3x.c:

drivers/i2c/busses/i2c-rk3x.c:83: warning: missing initial short description on line:
 * struct i2c_spec_values:
drivers/i2c/busses/i2c-rk3x.c:139: warning: missing initial short description on line:
 * struct rk3x_i2c_calced_timings:
drivers/i2c/busses/i2c-rk3x.c:162: warning: missing initial short description on line:
 * struct rk3x_i2c_soc_data:
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
 * Generate a START condition, which triggers a REG_INT_START interrupt.
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
 * Generate a STOP condition, which triggers a REG_INT_STOP interrupt.
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: 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
 * Get timing values of I2C specification
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
 * Calculate divider values for desired SCL frequency
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
 * Calculate timing values for desired SCL frequency
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
 * Setup I2C registers for an I2C operation specified by msgs, num.

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarWolfram Sang <wsa@kernel.org>
Signed-off-by: default avatarSasha Levin <sashal@kernel.org>
parent d4d765f4

drivers/i2c/busses/i2c-rk3x.c

+22 −22
Original line number Diff line number Diff line
@@ -79,7 +79,7 @@ enum { 
#define DEFAULT_SCL_RATE  (100 * 1000) /* Hz */



/**

 * struct i2c_spec_values:

 * struct i2c_spec_values - I2C specification values for various modes

 * @min_hold_start_ns: min hold time (repeated) START condition

 * @min_low_ns: min LOW period of the SCL clock

 * @min_high_ns: min HIGH period of the SCL cloc
@@ -135,7 +135,7 @@ static const struct i2c_spec_values fast_mode_plus_spec = { 
};



/**

 * struct rk3x_i2c_calced_timings:

 * struct rk3x_i2c_calced_timings - calculated V1 timings

 * @div_low: Divider output for low

 * @div_high: Divider output for high

 * @tuning: Used to adjust setup/hold data time,
@@ -158,7 +158,7 @@ enum rk3x_i2c_state { 
};



/**

 * struct rk3x_i2c_soc_data:

 * struct rk3x_i2c_soc_data - SOC-specific data

 * @grf_offset: offset inside the grf regmap for setting the i2c type

 * @calc_timings: Callback function for i2c timing information calculated

 */
@@ -238,7 +238,8 @@ static inline void rk3x_i2c_clean_ipd(struct rk3x_i2c *i2c) 
}



/**

 * Generate a START condition, which triggers a REG_INT_START interrupt.

 * rk3x_i2c_start - Generate a START condition, which triggers a REG_INT_START interrupt.

 * @i2c: target controller data

 */

static void rk3x_i2c_start(struct rk3x_i2c *i2c)

{
@@ -257,8 +258,8 @@ static void rk3x_i2c_start(struct rk3x_i2c *i2c) 
}



/**

 * Generate a STOP condition, which triggers a REG_INT_STOP interrupt.

 *

 * rk3x_i2c_stop - Generate a STOP condition, which triggers a REG_INT_STOP interrupt.

 * @i2c: target controller data

 * @error: Error code to return in rk3x_i2c_xfer

 */

static void rk3x_i2c_stop(struct rk3x_i2c *i2c, int error)
@@ -297,7 +298,8 @@ static void rk3x_i2c_stop(struct rk3x_i2c *i2c, int error) 
}



/**

 * Setup a read according to i2c->msg

 * rk3x_i2c_prepare_read - Setup a read according to i2c->msg

 * @i2c: target controller data

 */

static void rk3x_i2c_prepare_read(struct rk3x_i2c *i2c)

{
@@ -328,7 +330,8 @@ static void rk3x_i2c_prepare_read(struct rk3x_i2c *i2c) 
}



/**

 * Fill the transmit buffer with data from i2c->msg

 * rk3x_i2c_fill_transmit_buf - Fill the transmit buffer with data from i2c->msg

 * @i2c: target controller data

 */

static void rk3x_i2c_fill_transmit_buf(struct rk3x_i2c *i2c)

{
@@ -531,11 +534,10 @@ 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

 *

 * Returns: Matched i2c spec values.

 * Return: Matched i2c_spec_values.

 */

static const struct i2c_spec_values *rk3x_i2c_get_spec(unsigned int speed)

{
@@ -548,13 +550,12 @@ 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

 * @t_calc: Caculated rk3x private timings that would be written into regs

 *

 * Returns: 0 on success, -EINVAL if the goal SCL rate is too slow. In that case

 * Return: %0 on success, -%EINVAL if the goal SCL rate is too slow. In that case

 * a best-effort divider value is returned in divs. If the target rate is

 * too high, we silently use the highest possible rate.

 */
@@ -709,13 +710,12 @@ 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

 * @t_calc: Caculated rk3x private timings that would be written into regs

 *

 * Returns: 0 on success, -EINVAL if the goal SCL rate is too slow. In that case

 * Return: %0 on success, -%EINVAL if the goal SCL rate is too slow. In that case

 * a best-effort divider value is returned in divs. If the target rate is

 * too high, we silently use the highest possible rate.

 * The following formulas are v1's method to calculate timings.
@@ -959,14 +959,14 @@ static int rk3x_i2c_clk_notifier_cb(struct notifier_block *nb, unsigned long 
}



/**

 * Setup I2C registers for an I2C operation specified by msgs, num.

 *

 * Must be called with i2c->lock held.

 *

 * rk3x_i2c_setup - Setup I2C registers for an I2C operation specified by msgs, num.

 * @i2c: target controller data

 * @msgs: I2C msgs to process

 * @num: Number of msgs

 *

 * returns: Number of I2C msgs processed or negative in case of error

 * Must be called with i2c->lock held.

 *

 * Return: Number of I2C msgs processed or negative in case of error

 */

static int rk3x_i2c_setup(struct rk3x_i2c *i2c, struct i2c_msg *msgs, int num)

{