From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
        id S1752877AbeDJMSw (ORCPT <rfc822;w@1wt.eu>);
        Tue, 10 Apr 2018 08:18:52 -0400
Received: from mga17.intel.com ([192.55.52.151]:62654 "EHLO mga17.intel.com"
        rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP
        id S1752541AbeDJMSv (ORCPT <rfc822;linux-kernel@vger.kernel.org>);
        Tue, 10 Apr 2018 08:18:51 -0400
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.48,431,1517904000";
   d="scan'208";a="215468398"
Subject: Re: [RFC PATCH] sdhci: arasan: Add runtime PM support
To: Michal Simek <michal.simek@xilinx.com>, naranimanish@gmail.com,
        ulf.hansson@linaro.org, linux-mmc@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org
Cc: Manish Narani <mnarani@xilinx.com>
References: <1522302530-27550-1-git-send-email-naranimanish@gmail.com>
 <29f0aae5-3cee-8a37-f5aa-3830f466a759@intel.com>
 <b02c6970-f4f5-53af-2834-710ff3b7cbaa@xilinx.com>
From: Adrian Hunter <adrian.hunter@intel.com>
Organization: Intel Finland Oy, Registered Address: PL 281, 00181 Helsinki,
 Business Identity Code: 0357606 - 4, Domiciled in Helsinki
Message-ID: <c8a29949-c220-1319-02f4-c5b0b9601dc8@intel.com>
Date: Tue, 10 Apr 2018 15:17:50 +0300
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101
 Thunderbird/52.6.0
MIME-Version: 1.0
In-Reply-To: <b02c6970-f4f5-53af-2834-710ff3b7cbaa@xilinx.com>
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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@gmail.com wrote:
>>> From: Manish Narani <mnarani@xilinx.com>
>>>
>>> This patch adds runtime PM support in Arasan SD driver.
>>>
>>> Signed-off-by: Manish Narani <mnarani@xilinx.com>
>>
>> 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.