Re: [PATCH net-next 08/11] bnxt_en: Add functions to copy host context memory

[Jakub Kicinski <kuba@kernel.org>]

On Tue, 12 Nov 2024 21:36:46 -0800 Michael Chan wrote:
> Host context memory is used by the newer chips to store context
> information for various L2 and RoCE states and FW logs.  This
> information will be useful for debugging.  This patch adds the
> functions to copy all pages of a context memory type to a contiguous
> buffer.  The next patches will include the context memory dump
> during ethtool -w coredump.
> 
> Reviewed-by: Pavan Chebbi <pavan.chebbi@broadcom.com>
> Reviewed-by: Hongguang Gao <hongguang.gao@broadcom.com>
> Signed-off-by: Shruti Parab <shruti.parab@broadcom.com>
> Signed-off-by: Sreekanth Reddy <sreekanth.reddy@broadcom.com

Truncated signoff tag.

nit: I don't know who Shruti is but my guess is that she co-authored 
the code, in which case a Co-developed tag would be appropriated.

> Signed-off-by: Michael Chan <michael.chan@broadcom.com>

> +/**
> + * __bnxt_copy_ctx_mem - copy host context memory
> + * @bp: The driver context
> + * @ctxm: The pointer to the context memory type
> + * @buf: The destination buffer
> + * @offset: The buffer offset to copy the data to
> + * @head: The head offset of context memory to copy from
> + * @tail: The tail offset (last byte + 1) of context memory to end the copy
> + *
> + * This function is called for debugging purposes to dump the host context
> + * used by the chip.
> + */

return values must now be documented, per ./scripts/kernel-doc -Wall
-- 
pw-bot: cr