linux-kernel - Re: [PATCH 4/7] resource: Use typedef for alignf callback

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: <dc2d7189-70f2-49e2-ba78-ef2d15211e9b@infradead.org>
Date: Wed, 27 Dec 2023 13:21:05 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Ilpo Järvinen <ilpo.jarvinen@...ux.intel.com>,
 Andy Shevchenko <andriy.shevchenko@...el.com>
Cc: linux-pci@...r.kernel.org, Bjorn Helgaas <bhelgaas@...gle.com>,
 Lorenzo Pieralisi <lorenzo.pieralisi@....com>, Rob Herring
 <robh@...nel.org>, Krzysztof Wilczyński <kw@...ux.com>,
 Igor Mammedov <imammedo@...hat.com>, Lukas Wunner <lukas@...ner.de>,
 Mika Westerberg <mika.westerberg@...ux.intel.com>,
 "Rafael J . Wysocki" <rafael@...nel.org>, LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH 4/7] resource: Use typedef for alignf callback

On 12/27/23 07:54, Ilpo Järvinen wrote:
> On Fri, 22 Dec 2023, Andy Shevchenko wrote:
> 
>>> +/**
>>> + * resource_alignf - Resource alignment callback
>>> + * @data:	Private data used by the callback
>>> + * @res:	Resource candidate range (an empty resource slot)
>>> + * @size:	The minimum size of the empty slot
>>> + * @align:	Alignment from the constraints
>>> + *
>>> + * Callback allows calculating resource placement and alignment beyond min,
>>> + * max, and align fields in the struct resource_constraint.
>>> + *
>>> + * Return: Start address for the resource.
>>> + */
>>> +typedef resource_size_t (*resource_alignf)(void *data,
>>> +					   const struct resource *res,
>>> +					   resource_size_t size,
>>> +					   resource_size_t align);
>>
>> Never saw typedef kernel-doc before, so hopefully this will be rendered
>> just fine.
> 
> This was a good point. It seems that one has to prefix the name with 
> typedef like this:

That's correct.
> 
> /**
>  * typedef resource_alignf - Resource alignment callback
> 
> ...otherwise scripts/kernel-doc attempts to parse it as a function 
> kerneldoc.

ack.

Thanks.

-- 
#Randy