linux-kernel - Re: [PATCH misc] misc: Add Renesas Synchronization Management Unit (SMU) support

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <b78ebf7b-ea01-757b-39c4-0dc36e126af0@infradead.org>
Date:   Tue, 14 Sep 2021 22:54:29 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Greg KH <gregkh@...uxfoundation.org>,
        Min Li <min.li.xe@...esas.com>
Cc:     "derek.kiernan@...inx.com" <derek.kiernan@...inx.com>,
        "dragan.cvetic@...inx.com" <dragan.cvetic@...inx.com>,
        "arnd@...db.de" <arnd@...db.de>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH misc] misc: Add Renesas Synchronization Management Unit
 (SMU) support

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