Commit a646c9b2 authored by Jakub Kicinski's avatar Jakub Kicinski Committed by Daniel Borkmann
Browse files

nfp: fix old kdoc issues 



Since commit 3a025e1d ("Add optional check for bad kernel-doc
comments") when built with W=1 build will complain about kdoc errors.
Fix the kdoc issues we have.  kdoc is still confused by defines in
nfp_net_ctrl.h but those are not really errors.

Signed-off-by: default avatarJakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
parent 554b36bf

drivers/net/ethernet/netronome/nfp/nfp_net.h

+2 −0
Original line number Original line Diff line number Diff line
@@ -548,6 +548,8 @@ struct nfp_net_dp { 
 * @max_r_vecs:		Number of allocated interrupt vectors for RX/TX

 * @max_r_vecs:		Number of allocated interrupt vectors for RX/TX

 * @max_tx_rings:       Maximum number of TX rings supported by the Firmware

 * @max_tx_rings:       Maximum number of TX rings supported by the Firmware

 * @max_rx_rings:       Maximum number of RX rings supported by the Firmware

 * @max_rx_rings:       Maximum number of RX rings supported by the Firmware

 * @stride_rx:		Queue controller RX queue spacing

 * @stride_tx:		Queue controller TX queue spacing

 * @r_vecs:             Pre-allocated array of ring vectors

 * @r_vecs:             Pre-allocated array of ring vectors

 * @irq_entries:        Pre-allocated array of MSI-X entries

 * @irq_entries:        Pre-allocated array of MSI-X entries

 * @lsc_handler:        Handler for Link State Change interrupt

 * @lsc_handler:        Handler for Link State Change interrupt

drivers/net/ethernet/netronome/nfp/nfpcore/nfp_cppcore.c

+3 −6
Original line number Original line Diff line number Diff line
@@ -372,8 +372,7 @@ nfp_cpp_area_alloc(struct nfp_cpp *cpp, u32 dest, 
 * that it can be accessed directly.

 * that it can be accessed directly.

 *

 *

 * NOTE: @address and @size must be 32-bit aligned values.

 * NOTE: @address and @size must be 32-bit aligned values.

 *

 * The area must also be 'released' when the structure is freed.

 * NOTE: The area must also be 'released' when the structure is freed.

 *

 *

 * Return: NFP CPP Area handle, or NULL

 * Return: NFP CPP Area handle, or NULL

 */

 */
@@ -536,8 +535,7 @@ void nfp_cpp_area_release_free(struct nfp_cpp_area *area) 
 * Read data from indicated CPP region.

 * Read data from indicated CPP region.

 *

 *

 * NOTE: @offset and @length must be 32-bit aligned values.

 * NOTE: @offset and @length must be 32-bit aligned values.

 *

 * Area must have been locked down with an 'acquire'.

 * NOTE: Area must have been locked down with an 'acquire'.

 *

 *

 * Return: length of io, or -ERRNO

 * Return: length of io, or -ERRNO

 */

 */
@@ -558,8 +556,7 @@ int nfp_cpp_area_read(struct nfp_cpp_area *area, 
 * Write data to indicated CPP region.

 * Write data to indicated CPP region.

 *

 *

 * NOTE: @offset and @length must be 32-bit aligned values.

 * NOTE: @offset and @length must be 32-bit aligned values.

 *

 * Area must have been locked down with an 'acquire'.

 * NOTE: Area must have been locked down with an 'acquire'.

 *

 *

 * Return: length of io, or -ERRNO

 * Return: length of io, or -ERRNO

 */

 */