aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakub Kicinski <jakub.kicinski@netronome.com>2018-02-05 18:29:27 -0500
committerDavid S. Miller <davem@davemloft.net>2018-02-06 11:43:58 -0500
commit703f578a353d0735961b7fd7e2589532dfa9bf11 (patch)
tree0ea0c4f871c8c2f01359f51dd3db0ee177a5fc68
parent67ae44e1a6238531a2f324a30b6524d228df3131 (diff)
nfp: fix kdoc warnings on nested structures
Commit 84ce5b987783 ("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: Jakub Kicinski <jakub.kicinski@netronome.com> Reviewed-by: Simon Horman <simon.horman@netronome.com> Signed-off-by: David S. Miller <davem@davemloft.net>
-rw-r--r--drivers/net/ethernet/netronome/nfp/bpf/main.h24
-rw-r--r--drivers/net/ethernet/netronome/nfp/flower/tunnel_conf.c10
-rw-r--r--drivers/net/ethernet/netronome/nfp/nfp_net.h6
-rw-r--r--drivers/net/ethernet/netronome/nfp/nfpcore/nfp_nsp.h43
-rw-r--r--drivers/net/ethernet/netronome/nfp/nfpcore/nfp_resource.c21
5 files changed, 55 insertions, 49 deletions
diff --git a/drivers/net/ethernet/netronome/nfp/bpf/main.h b/drivers/net/ethernet/netronome/nfp/bpf/main.h
index 424fe8338105..054df3dc0698 100644
--- a/drivers/net/ethernet/netronome/nfp/bpf/main.h
+++ b/drivers/net/ethernet/netronome/nfp/bpf/main.h
@@ -112,22 +112,22 @@ enum pkt_vec {
112 * @map_elems_in_use: number of elements allocated to offloaded maps 112 * @map_elems_in_use: number of elements allocated to offloaded maps
113 * 113 *
114 * @adjust_head: adjust head capability 114 * @adjust_head: adjust head capability
115 * @flags: extra flags for adjust head 115 * @adjust_head.flags: extra flags for adjust head
116 * @off_min: minimal packet offset within buffer required 116 * @adjust_head.off_min: minimal packet offset within buffer required
117 * @off_max: maximum packet offset within buffer required 117 * @adjust_head.off_max: maximum packet offset within buffer required
118 * @guaranteed_sub: amount of negative adjustment guaranteed possible 118 * @adjust_head.guaranteed_sub: negative adjustment guaranteed possible
119 * @guaranteed_add: amount of positive adjustment guaranteed possible 119 * @adjust_head.guaranteed_add: positive adjustment guaranteed possible
120 * 120 *
121 * @maps: map capability 121 * @maps: map capability
122 * @types: supported map types 122 * @maps.types: supported map types
123 * @max_maps: max number of maps supported 123 * @maps.max_maps: max number of maps supported
124 * @max_elems: max number of entries in each map 124 * @maps.max_elems: max number of entries in each map
125 * @max_key_sz: max size of map key 125 * @maps.max_key_sz: max size of map key
126 * @max_val_sz: max size of map value 126 * @maps.max_val_sz: max size of map value
127 * @max_elem_sz: max size of map entry (key + value) 127 * @maps.max_elem_sz: max size of map entry (key + value)
128 * 128 *
129 * @helpers: helper addressess for various calls 129 * @helpers: helper addressess for various calls
130 * @map_lookup: map lookup helper address 130 * @helpers.map_lookup: map lookup helper address
131 */ 131 */
132struct nfp_app_bpf { 132struct nfp_app_bpf {
133 struct nfp_app *app; 133 struct nfp_app *app;
diff --git a/drivers/net/ethernet/netronome/nfp/flower/tunnel_conf.c b/drivers/net/ethernet/netronome/nfp/flower/tunnel_conf.c
index b03f22f29612..ec524d97869d 100644
--- a/drivers/net/ethernet/netronome/nfp/flower/tunnel_conf.c
+++ b/drivers/net/ethernet/netronome/nfp/flower/tunnel_conf.c
@@ -50,9 +50,9 @@
50 * @seq: sequence number of the message 50 * @seq: sequence number of the message
51 * @count: number of tunnels report in message 51 * @count: number of tunnels report in message
52 * @flags: options part of the request 52 * @flags: options part of the request
53 * @ipv4: dest IPv4 address of active route 53 * @tun_info.ipv4: dest IPv4 address of active route
54 * @egress_port: port the encapsulated packet egressed 54 * @tun_info.egress_port: port the encapsulated packet egressed
55 * @extra: reserved for future use 55 * @tun_info.extra: reserved for future use
56 * @tun_info: tunnels that have sent traffic in reported period 56 * @tun_info: tunnels that have sent traffic in reported period
57 */ 57 */
58struct nfp_tun_active_tuns { 58struct nfp_tun_active_tuns {
@@ -132,8 +132,8 @@ struct nfp_ipv4_addr_entry {
132 * struct nfp_tun_mac_addr - configure MAC address of tunnel EP on NFP 132 * struct nfp_tun_mac_addr - configure MAC address of tunnel EP on NFP
133 * @reserved: reserved for future use 133 * @reserved: reserved for future use
134 * @count: number of MAC addresses in the message 134 * @count: number of MAC addresses in the message
135 * @index: index of MAC address in the lookup table 135 * @addresses.index: index of MAC address in the lookup table
136 * @addr: interface MAC address 136 * @addresses.addr: interface MAC address
137 * @addresses: series of MACs to offload 137 * @addresses: series of MACs to offload
138 */ 138 */
139struct nfp_tun_mac_addr { 139struct nfp_tun_mac_addr {
diff --git a/drivers/net/ethernet/netronome/nfp/nfp_net.h b/drivers/net/ethernet/netronome/nfp/nfp_net.h
index d88eda9707e6..787df47ec430 100644
--- a/drivers/net/ethernet/netronome/nfp/nfp_net.h
+++ b/drivers/net/ethernet/netronome/nfp/nfp_net.h
@@ -193,7 +193,8 @@ struct nfp_net_tx_desc {
193 193
194/** 194/**
195 * struct nfp_net_tx_buf - software TX buffer descriptor 195 * struct nfp_net_tx_buf - software TX buffer descriptor
196 * @skb: sk_buff associated with this buffer 196 * @skb: normal ring, sk_buff associated with this buffer
197 * @frag: XDP ring, page frag associated with this buffer
197 * @dma_addr: DMA mapping address of the buffer 198 * @dma_addr: DMA mapping address of the buffer
198 * @fidx: Fragment index (-1 for the head and [0..nr_frags-1] for frags) 199 * @fidx: Fragment index (-1 for the head and [0..nr_frags-1] for frags)
199 * @pkt_cnt: Number of packets to be produced out of the skb associated 200 * @pkt_cnt: Number of packets to be produced out of the skb associated
@@ -377,6 +378,9 @@ struct nfp_net_rx_ring {
377 * struct nfp_net_r_vector - Per ring interrupt vector configuration 378 * struct nfp_net_r_vector - Per ring interrupt vector configuration
378 * @nfp_net: Backpointer to nfp_net structure 379 * @nfp_net: Backpointer to nfp_net structure
379 * @napi: NAPI structure for this ring vec 380 * @napi: NAPI structure for this ring vec
381 * @tasklet: ctrl vNIC, tasklet for servicing the r_vec
382 * @queue: ctrl vNIC, send queue
383 * @lock: ctrl vNIC, r_vec lock protects @queue
380 * @tx_ring: Pointer to TX ring 384 * @tx_ring: Pointer to TX ring
381 * @rx_ring: Pointer to RX ring 385 * @rx_ring: Pointer to RX ring
382 * @xdp_ring: Pointer to an extra TX ring for XDP 386 * @xdp_ring: Pointer to an extra TX ring for XDP
diff --git a/drivers/net/ethernet/netronome/nfp/nfpcore/nfp_nsp.h b/drivers/net/ethernet/netronome/nfp/nfpcore/nfp_nsp.h
index e983c9d7f86c..f23d9e06f097 100644
--- a/drivers/net/ethernet/netronome/nfp/nfpcore/nfp_nsp.h
+++ b/drivers/net/ethernet/netronome/nfp/nfpcore/nfp_nsp.h
@@ -98,28 +98,29 @@ enum nfp_eth_fec {
98 * @max_index: max of @index fields of all @ports 98 * @max_index: max of @index fields of all @ports
99 * @ports: table of ports 99 * @ports: table of ports
100 * 100 *
101 * @eth_index: port index according to legacy ethX numbering 101 * @ports.eth_index: port index according to legacy ethX numbering
102 * @index: chip-wide first channel index 102 * @ports.index: chip-wide first channel index
103 * @nbi: NBI index 103 * @ports.nbi: NBI index
104 * @base: first channel index (within NBI) 104 * @ports.base: first channel index (within NBI)
105 * @lanes: number of channels 105 * @ports.lanes: number of channels
106 * @speed: interface speed (in Mbps) 106 * @ports.speed: interface speed (in Mbps)
107 * @interface: interface (module) plugged in 107 * @ports.interface: interface (module) plugged in
108 * @media: media type of the @interface 108 * @ports.media: media type of the @interface
109 * @fec: forward error correction mode 109 * @ports.fec: forward error correction mode
110 * @aneg: auto negotiation mode 110 * @ports.aneg: auto negotiation mode
111 * @mac_addr: interface MAC address 111 * @ports.mac_addr: interface MAC address
112 * @label_port: port id 112 * @ports.label_port: port id
113 * @label_subport: id of interface within port (for split ports) 113 * @ports.label_subport: id of interface within port (for split ports)
114 * @enabled: is enabled? 114 * @ports.enabled: is enabled?
115 * @tx_enabled: is TX enabled? 115 * @ports.tx_enabled: is TX enabled?
116 * @rx_enabled: is RX enabled? 116 * @ports.rx_enabled: is RX enabled?
117 * @override_changed: is media reconfig pending? 117 * @ports.override_changed: is media reconfig pending?
118 * 118 *
119 * @port_type: one of %PORT_* defines for ethtool 119 * @ports.port_type: one of %PORT_* defines for ethtool
120 * @port_lanes: total number of lanes on the port (sum of lanes of all subports) 120 * @ports.port_lanes: total number of lanes on the port (sum of lanes of all
121 * @is_split: is interface part of a split port 121 * subports)
122 * @fec_modes_supported: bitmap of FEC modes supported 122 * @ports.is_split: is interface part of a split port
123 * @ports.fec_modes_supported: bitmap of FEC modes supported
123 */ 124 */
124struct nfp_eth_table { 125struct nfp_eth_table {
125 unsigned int count; 126 unsigned int count;
diff --git a/drivers/net/ethernet/netronome/nfp/nfpcore/nfp_resource.c b/drivers/net/ethernet/netronome/nfp/nfpcore/nfp_resource.c
index b1dd13ff282b..7e14725055c7 100644
--- a/drivers/net/ethernet/netronome/nfp/nfpcore/nfp_resource.c
+++ b/drivers/net/ethernet/netronome/nfp/nfpcore/nfp_resource.c
@@ -56,16 +56,17 @@
56 56
57/** 57/**
58 * struct nfp_resource_entry - Resource table entry 58 * struct nfp_resource_entry - Resource table entry
59 * @owner: NFP CPP Lock, interface owner 59 * @mutex: NFP CPP Lock
60 * @key: NFP CPP Lock, posix_crc32(name, 8) 60 * @mutex.owner: NFP CPP Lock, interface owner
61 * @region: Memory region descriptor 61 * @mutex.key: NFP CPP Lock, posix_crc32(name, 8)
62 * @name: ASCII, zero padded name 62 * @region: Memory region descriptor
63 * @reserved 63 * @region.name: ASCII, zero padded name
64 * @cpp_action: CPP Action 64 * @region.reserved: padding
65 * @cpp_token: CPP Token 65 * @region.cpp_action: CPP Action
66 * @cpp_target: CPP Target ID 66 * @region.cpp_token: CPP Token
67 * @page_offset: 256-byte page offset into target's CPP address 67 * @region.cpp_target: CPP Target ID
68 * @page_size: size, in 256-byte pages 68 * @region.page_offset: 256-byte page offset into target's CPP address
69 * @region.page_size: size, in 256-byte pages
69 */ 70 */
70struct nfp_resource_entry { 71struct nfp_resource_entry {
71 struct nfp_resource_entry_mutex { 72 struct nfp_resource_entry_mutex {