Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 703f578a authored by Jakub Kicinski's avatar Jakub Kicinski Committed by David S. Miller
Browse files

nfp: fix kdoc warnings on nested structures 



Commit 84ce5b98 ("scripts: kernel-doc: improve nested logic to
handle multiple identifiers") improved the handling of nested structure
definitions in scripts/kernel-doc, and changed the expected format of
documentation.  This causes new warnings to appear on W=1 builds.

Only comment changes.

Signed-off-by: default avatarJakub Kicinski <jakub.kicinski@netronome.com>
Reviewed-by: default avatarSimon Horman <simon.horman@netronome.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 67ae44e1

drivers/net/ethernet/netronome/nfp/bpf/main.h

+12 −12
Original line number Diff line number Diff line
@@ -112,22 +112,22 @@ enum pkt_vec { 
 * @map_elems_in_use:	number of elements allocated to offloaded maps

 *

 * @adjust_head:	adjust head capability

 * @flags:		extra flags for adjust head

 * @off_min:		minimal packet offset within buffer required

 * @off_max:		maximum packet offset within buffer required

 * @guaranteed_sub:	amount of negative adjustment guaranteed possible

 * @guaranteed_add:	amount of positive adjustment guaranteed possible

 * @adjust_head.flags:		extra flags for adjust head

 * @adjust_head.off_min:	minimal packet offset within buffer required

 * @adjust_head.off_max:	maximum packet offset within buffer required

 * @adjust_head.guaranteed_sub:	negative adjustment guaranteed possible

 * @adjust_head.guaranteed_add:	positive adjustment guaranteed possible

 *

 * @maps:		map capability

 * @types:		supported map types

 * @max_maps:		max number of maps supported

 * @max_elems:		max number of entries in each map

 * @max_key_sz:		max size of map key

 * @max_val_sz:		max size of map value

 * @max_elem_sz:	max size of map entry (key + value)

 * @maps.types:			supported map types

 * @maps.max_maps:		max number of maps supported

 * @maps.max_elems:		max number of entries in each map

 * @maps.max_key_sz:		max size of map key

 * @maps.max_val_sz:		max size of map value

 * @maps.max_elem_sz:		max size of map entry (key + value)

 *

 * @helpers:		helper addressess for various calls

 * @map_lookup:		map lookup helper address

 * @helpers.map_lookup:		map lookup helper address

 */

struct nfp_app_bpf {

	struct nfp_app *app;

drivers/net/ethernet/netronome/nfp/flower/tunnel_conf.c

+5 −5
Original line number Diff line number Diff line
@@ -50,9 +50,9 @@ 
 * @seq:		sequence number of the message

 * @count:		number of tunnels report in message

 * @flags:		options part of the request

 * @ipv4:		dest IPv4 address of active route

 * @egress_port:	port the encapsulated packet egressed

 * @extra:		reserved for future use

 * @tun_info.ipv4:		dest IPv4 address of active route

 * @tun_info.egress_port:	port the encapsulated packet egressed

 * @tun_info.extra:		reserved for future use

 * @tun_info:		tunnels that have sent traffic in reported period

 */

struct nfp_tun_active_tuns {
@@ -132,8 +132,8 @@ struct nfp_ipv4_addr_entry { 
 * struct nfp_tun_mac_addr - configure MAC address of tunnel EP on NFP

 * @reserved:	reserved for future use

 * @count:	number of MAC addresses in the message

 * @index:	index of MAC address in the lookup table

 * @addr:	interface MAC address

 * @addresses.index:	index of MAC address in the lookup table

 * @addresses.addr:	interface MAC address

 * @addresses:	series of MACs to offload

 */

struct nfp_tun_mac_addr {

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

+5 −1
Original line number Diff line number Diff line
@@ -193,7 +193,8 @@ struct nfp_net_tx_desc { 


/**

 * struct nfp_net_tx_buf - software TX buffer descriptor

 * @skb:	sk_buff associated with this buffer

 * @skb:	normal ring, sk_buff associated with this buffer

 * @frag:	XDP ring, page frag associated with this buffer

 * @dma_addr:	DMA mapping address of the buffer

 * @fidx:	Fragment index (-1 for the head and [0..nr_frags-1] for frags)

 * @pkt_cnt:	Number of packets to be produced out of the skb associated
@@ -377,6 +378,9 @@ struct nfp_net_rx_ring { 
 * struct nfp_net_r_vector - Per ring interrupt vector configuration

 * @nfp_net:        Backpointer to nfp_net structure

 * @napi:           NAPI structure for this ring vec

 * @tasklet:        ctrl vNIC, tasklet for servicing the r_vec

 * @queue:          ctrl vNIC, send queue

 * @lock:           ctrl vNIC, r_vec lock protects @queue

 * @tx_ring:        Pointer to TX ring

 * @rx_ring:        Pointer to RX ring

 * @xdp_ring:	    Pointer to an extra TX ring for XDP

drivers/net/ethernet/netronome/nfp/nfpcore/nfp_nsp.h

+22 −21
Original line number Diff line number Diff line
@@ -98,28 +98,29 @@ enum nfp_eth_fec { 
 * @max_index:	max of @index fields of all @ports

 * @ports:	table of ports

 *

 * @eth_index:	port index according to legacy ethX numbering

 * @index:	chip-wide first channel index

 * @nbi:	NBI index

 * @base:	first channel index (within NBI)

 * @lanes:	number of channels

 * @speed:	interface speed (in Mbps)

 * @interface:	interface (module) plugged in

 * @media:	media type of the @interface

 * @fec:	forward error correction mode

 * @aneg:	auto negotiation mode

 * @mac_addr:	interface MAC address

 * @label_port:	port id

 * @label_subport:  id of interface within port (for split ports)

 * @enabled:	is enabled?

 * @tx_enabled:	is TX enabled?

 * @rx_enabled:	is RX enabled?

 * @override_changed: is media reconfig pending?

 * @ports.eth_index:	port index according to legacy ethX numbering

 * @ports.index:	chip-wide first channel index

 * @ports.nbi:		NBI index

 * @ports.base:		first channel index (within NBI)

 * @ports.lanes:	number of channels

 * @ports.speed:	interface speed (in Mbps)

 * @ports.interface:	interface (module) plugged in

 * @ports.media:	media type of the @interface

 * @ports.fec:		forward error correction mode

 * @ports.aneg:		auto negotiation mode

 * @ports.mac_addr:	interface MAC address

 * @ports.label_port:	port id

 * @ports.label_subport:  id of interface within port (for split ports)

 * @ports.enabled:	is enabled?

 * @ports.tx_enabled:	is TX enabled?

 * @ports.rx_enabled:	is RX enabled?

 * @ports.override_changed: is media reconfig pending?

 *

 * @port_type:	one of %PORT_* defines for ethtool

 * @port_lanes:	total number of lanes on the port (sum of lanes of all subports)

 * @is_split:	is interface part of a split port

 * @fec_modes_supported:	bitmap of FEC modes supported

 * @ports.port_type:	one of %PORT_* defines for ethtool

 * @ports.port_lanes:	total number of lanes on the port (sum of lanes of all

 *			subports)

 * @ports.is_split:	is interface part of a split port

 * @ports.fec_modes_supported:	bitmap of FEC modes supported

 */

struct nfp_eth_table {

	unsigned int count;

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

+11 −10
Original line number Diff line number Diff line
@@ -56,16 +56,17 @@ 


/**

 * struct nfp_resource_entry - Resource table entry

 * @owner:		NFP CPP Lock, interface owner

 * @key:		NFP CPP Lock, posix_crc32(name, 8)

 * @mutex:	NFP CPP Lock

 * @mutex.owner:	NFP CPP Lock, interface owner

 * @mutex.key:		NFP CPP Lock, posix_crc32(name, 8)

 * @region:	Memory region descriptor

 * @name:		ASCII, zero padded name

 * @reserved

 * @cpp_action:		CPP Action

 * @cpp_token:		CPP Token

 * @cpp_target:		CPP Target ID

 * @page_offset:	256-byte page offset into target's CPP address

 * @page_size:		size, in 256-byte pages

 * @region.name:	ASCII, zero padded name

 * @region.reserved:	padding

 * @region.cpp_action:	CPP Action

 * @region.cpp_token:	CPP Token

 * @region.cpp_target:	CPP Target ID

 * @region.page_offset:	256-byte page offset into target's CPP address

 * @region.page_size:	size, in 256-byte pages

 */

struct nfp_resource_entry {

	struct nfp_resource_entry_mutex {