Re: [PATCH net-next v9 7/9] libeth: add Rx buffer management

[Alexander Lobakin]

From: Alexander Lobakin <aleksander.lobakin@xxxxxxxxx>
Date: Mon, 8 Apr 2024 11:11:12 +0200

> From: Jakub Kicinski <kuba@xxxxxxxxxx>
> Date: Fri, 5 Apr 2024 21:25:13 -0700
> 
>> On Thu,  4 Apr 2024 17:44:00 +0200 Alexander Lobakin wrote:
>>> +/**
>>> + * struct libeth_fq - structure representing a buffer queue
>>> + * @fp: hotpath part of the structure
>>
>> Second time this happens this week, so maybe some tooling change in 6.9
>> but apparently kdoc does not want to know about the tagged struct:
>>
>> include/net/libeth/rx.h:69: warning: Excess struct member 'fp' description in 'libeth_fq'
> 
> Oh no, maybe we should teach kdoc to parse struct_group*()?

scripts/kernel-doc apparently can handle them...

+ Kees

> 
>>
>>> + * @pp: &page_pool for buffer management
>>> + * @fqes: array of Rx buffers
>>> + * @truesize: size to allocate per buffer, w/overhead
>>> + * @count: number of descriptors/buffers the queue has
>>> + * @buf_len: HW-writeable length per each buffer
>>> + * @nid: ID of the closest NUMA node with memory
>>> + */
>>> +struct libeth_fq {
>>> +	struct_group_tagged(libeth_fq_fp, fp,
>>> +		struct page_pool	*pp;
>>> +		struct libeth_fqe	*fqes;
>>> +
>>> +		u32			truesize;
>>> +		u32			count;
>>> +	);
>>> +
>>> +	/* Cold fields */
>>> +	u32			buf_len;
>>> +	int			nid;
>>> +};

Thanks,
Olek