Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH misc] misc: Add Renesas Synchronization Management Unit
 (SMU) support
To:     Greg KH <gregkh@linuxfoundation.org>,
        Min Li <min.li.xe@renesas.com>
Cc:     "derek.kiernan@xilinx.com" <derek.kiernan@xilinx.com>,
        "dragan.cvetic@xilinx.com" <dragan.cvetic@xilinx.com>,
        "arnd@arndb.de" <arnd@arndb.de>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
References: <1630608353-7606-1-git-send-email-min.li.xe@renesas.com>
 <YUBmIWU6HwIjjeXa@kroah.com>
 <OS3PR01MB6593057EA6257006C7228542BADA9@OS3PR01MB6593.jpnprd01.prod.outlook.com>
 <YUGG8iPWMLx5vJ1f@kroah.com>
From:   Randy Dunlap <rdunlap@infradead.org>
Message-ID: <b78ebf7b-ea01-757b-39c4-0dc36e126af0@infradead.org>
Date:   Tue, 14 Sep 2021 22:54:29 -0700
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.13.0
MIME-Version: 1.0
In-Reply-To: <YUGG8iPWMLx5vJ1f@kroah.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 9/14/21 10:38 PM, Greg KH wrote:
> On Tue, Sep 14, 2021 at 08:43:44PM +0000, Min Li wrote:
>> Hi Greg
>>
>> Thanks for the review
>>
>>>>   drivers/misc/Kconfig      |   9 ++
>>>>   drivers/misc/Makefile     |   2 +
>>>>   drivers/misc/rsmu_cdev.c  | 239
>>>> ++++++++++++++++++++++++++++++++++++++++++++++
>>>>   drivers/misc/rsmu_cdev.h  |  77 +++++++++++++++
>>>>   drivers/misc/rsmu_cm.c    | 164 +++++++++++++++++++++++++++++++
>>>>   drivers/misc/rsmu_sabre.c | 133 ++++++++++++++++++++++++++
>>>
>>> If you make this all one .c file, the .h file can go away and it will be much
>>> simpler in the end.  And will get rid of the global symbols.
>>>
>>

> 
>>>> +
>>>> +/**
>>>> + * @Description
>>>
>>> What is this format?  It is not kernel-doc :(
>>>
>>>> + * ioctl to set SMU combo mode.Combo mode provides physical layer
>>>> + frequency
>>>> + * support from the Ethernet Equipment Clock to the PTP clock
>>>> + *
>>>> + * @Parameters
>>>
>>> Same here and elsewhere in this file.
>>
>> I was copying the format from xilinx_sdfec.h
>>
>> Is there a place that tells me how to properly document ioctl or can you give me an code example?
> 
> The kerneldoc format should be described in Documentation/ somewhere...

See Documentation/doc-guide/kernel-doc.rst.

-- 
~Randy