Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Received-SPF: Pass (protection.outlook.com: domain of xilinx.com designates
 149.199.60.100 as permitted sender) receiver=protection.outlook.com;
 client-ip=149.199.60.100; helo=xsj-pvapsmtpgw02;
Subject: Re: [RFC PATCH] sdhci: arasan: Add runtime PM support
To:     Adrian Hunter <adrian.hunter@intel.com>,
        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>
 <c8a29949-c220-1319-02f4-c5b0b9601dc8@intel.com>
From:   Michal Simek <michal.simek@xilinx.com>
Message-ID: <98f0c8c1-3f85-8775-f6cd-9097fb254446@xilinx.com>
Date:   Tue, 10 Apr 2018 15:02:46 +0200
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101
 Thunderbird/52.7.0
MIME-Version: 1.0
In-Reply-To: <c8a29949-c220-1319-02f4-c5b0b9601dc8@intel.com>
Content-Type: text/plain; charset="utf-8"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
SpamDiagnosticOutput: 1:99
SpamDiagnosticMetadata: NSPM
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 10 Apr 2018 13:02:58.5830
 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: a3e1b951-fb66-4d62-ee36-08d59ee362a9
X-MS-Exchange-CrossTenant-Id: 657af505-d5df-48d0-8300-c31994686c5c
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=657af505-d5df-48d0-8300-c31994686c5c;Ip=[149.199.60.100];Helo=[xsj-pvapsmtpgw02]
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM2PR02MB1404
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On 10.4.2018 14:17, Adrian Hunter wrote:
> 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.
> 

Personally in general I can't see any issue with it especially for
people who has no idea how these callbacks are working but I understand
your concern here especially when there is anything specific written in
connection to this device.

Thanks,
Michal