Received-SPF: pass (google.com: domain of linux-kernel+bounces-12272-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Message-ID: <dc2d7189-70f2-49e2-ba78-ef2d15211e9b@infradead.org>
Date: Wed, 27 Dec 2023 13:21:05 -0800
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH 4/7] resource: Use typedef for alignf callback
Content-Language: en-US
To: =?UTF-8?Q?Ilpo_J=C3=A4rvinen?= <ilpo.jarvinen@linux.intel.com>,
 Andy Shevchenko <andriy.shevchenko@intel.com>
Cc: linux-pci@vger.kernel.org, Bjorn Helgaas <bhelgaas@google.com>,
 Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>, Rob Herring
 <robh@kernel.org>, =?UTF-8?Q?Krzysztof_Wilczy=C5=84ski?= <kw@linux.com>,
 Igor Mammedov <imammedo@redhat.com>, Lukas Wunner <lukas@wunner.de>,
 Mika Westerberg <mika.westerberg@linux.intel.com>,
 "Rafael J . Wysocki" <rafael@kernel.org>, LKML <linux-kernel@vger.kernel.org>
References: <20231222122901.49538-1-ilpo.jarvinen@linux.intel.com>
 <20231222122901.49538-5-ilpo.jarvinen@linux.intel.com>
 <ZYWPaGc4rjymcm75@smile.fi.intel.com>
 <8161e59d-2122-562c-dcc7-f772ddbcbdf@linux.intel.com>
From: Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <8161e59d-2122-562c-dcc7-f772ddbcbdf@linux.intel.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit


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