Re: [RFC PATCH] sdhci: arasan: Add runtime PM support

[Adrian Hunter]

On 10/04/18 15:06, Michal Simek wrote:
> Hi Adrian,
> 
> On 10.4.2018 13:42, Adrian Hunter wrote:
>> On 29/03/18 08:48, naranimanish@xxxxxxxxx wrote:
>>> From: Manish Narani <mnarani@xxxxxxxxxx>
>>>
>>> This patch adds runtime PM support in Arasan SD driver.
>>>
>>> Signed-off-by: Manish Narani <mnarani@xxxxxxxxxx>
>>
>> Just a couple of comments about style.
>>
>>> ---
>>>  drivers/mmc/host/sdhci-of-arasan.c | 83 +++++++++++++++++++++++++++++++++++++-
>>>  1 file changed, 81 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/drivers/mmc/host/sdhci-of-arasan.c b/drivers/mmc/host/sdhci-of-arasan.c
>>> index c33a5f7..47196b5 100644
>>> --- a/drivers/mmc/host/sdhci-of-arasan.c
>>> +++ b/drivers/mmc/host/sdhci-of-arasan.c
>>> @@ -23,6 +23,7 @@
>>>  #include <linux/mfd/syscon.h>
>>>  #include <linux/module.h>
>>>  #include <linux/of_device.h>
>>> +#include <linux/pm_runtime.h>
>>>  #include <linux/phy/phy.h>
>>>  #include <linux/regmap.h>
>>>  #include <linux/of.h>
>>> @@ -349,6 +350,75 @@ static const struct sdhci_pltfm_data sdhci_arasan_cqe_pdata = {
>>>  			SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN,
>>>  };
>>>  
>>> +#ifdef CONFIG_PM
>>> +/**
>>> + * sdhci_arasan_runtime_suspend - Suspend method for the driver
>>> + * @dev:	Address of the device structure
>>> + * Returns 0 on success and error value on error
>>> + *
>>> + * Put the device in a low power state.
>>> + */
>>
>> Kernel style is not to put kerneldoc on callback functions.
> 
> I have never read that there are some sort of list of functions which
> shouldn't be covered by kernel-doc.
> What's the problem with using kerneldoc format here? Maybe I am not
> getting your comments.

It is not a list of functions.  It is any implementation of a well-known
callback. i.e. we already know what ->runtime_suspend() is for, so we don't
need untold numbers of drivers describing it in comments.