i2c: cadence: Fix the kernel-doc warnings

This fixes the below warnings
drivers/i2c/busses/i2c-cadence.c:164: warning: No description found for parameter 'dev'
drivers/i2c/busses/i2c-cadence.c:826: warning: No description found for parameter 'dev'
drivers/i2c/busses/i2c-cadence.c:826: warning: Excess function parameter '_dev' description in 'cdns_i2c_runtime_suspend'
drivers/i2c/busses/i2c-cadence.c:844: warning: No description found for parameter 'dev'
drivers/i2c/busses/i2c-cadence.c:844: warning: Excess function parameter '_dev' description in 'cdns_i2c_runtime_resume'

while at it also update the cdns_i2c_clear_bus_hold
and the runtime function update.

Tested-by: Michal Simek <michal.simek@xilinx.com>
Signed-off-by: Shubhrajyoti Datta <shubhraj@xilinx.com>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
This commit is contained in:
Shubhrajyoti Datta 2016-03-07 14:58:39 +05:30 committed by Wolfram Sang
parent 3bf58bb5da
commit 30e31a1fbc

View file

@ -124,6 +124,8 @@
/** /**
* struct cdns_i2c - I2C device private data structure * struct cdns_i2c - I2C device private data structure
*
* @dev: Pointer to device structure
* @membase: Base address of the I2C device * @membase: Base address of the I2C device
* @adap: I2C adapter instance * @adap: I2C adapter instance
* @p_msg: Message pointer * @p_msg: Message pointer
@ -171,7 +173,7 @@ struct cdns_platform_data {
clk_rate_change_nb) clk_rate_change_nb)
/** /**
* cdns_i2c_clear_bus_hold() - Clear bus hold bit * cdns_i2c_clear_bus_hold - Clear bus hold bit
* @id: Pointer to driver data struct * @id: Pointer to driver data struct
* *
* Helper to clear the controller's bus hold bit. * Helper to clear the controller's bus hold bit.
@ -815,8 +817,8 @@ static int cdns_i2c_clk_notifier_cb(struct notifier_block *nb, unsigned long
} }
/** /**
* cdns_i2c_suspend - Suspend method for the driver * cdns_i2c_runtime_suspend - Runtime suspend method for the driver
* @_dev: Address of the platform_device structure * @dev: Address of the platform_device structure
* *
* Put the driver into low power mode. * Put the driver into low power mode.
* *
@ -833,10 +835,10 @@ static int __maybe_unused cdns_i2c_runtime_suspend(struct device *dev)
} }
/** /**
* cdns_i2c_resume - Resume from suspend * cdns_i2c_runtime_resume - Runtime resume
* @_dev: Address of the platform_device structure * @dev: Address of the platform_device structure
* *
* Resume operation after suspend. * Runtime resume callback.
* *
* Return: 0 on success and error value on error * Return: 0 on success and error value on error
*/ */