Commit a45ed8db authored by Randy Dunlap's avatar Randy Dunlap Committed by Jakub Kicinski
Browse files

sfc: correct kernel-doc complaints 



Fix kernel-doc warnings by adding 3 missing struct member descriptions
in struct efx_ef10_nic_data and removing preprocessor directives (which
are not handled by kernel-doc).

Fixes these 5 warnings:
Warning: drivers/net/ethernet/sfc/nic.h:158 bad line: #ifdef CONFIG_SFC_SRIOV
Warning: drivers/net/ethernet/sfc/nic.h:160 bad line: #endif
Warning: drivers/net/ethernet/sfc/nic.h:204 struct member 'port_id'
 not described in 'efx_ef10_nic_data'
Warning: drivers/net/ethernet/sfc/nic.h:204 struct member 'vf_index'
 not described in 'efx_ef10_nic_data'
Warning: drivers/net/ethernet/sfc/nic.h:204 struct member 'licensed_features'
 not described in 'efx_ef10_nic_data'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarEdward Cree <ecree.xilinx@gmail.com>
Link: https://patch.msgid.link/20260106173224.2010703-1-rdunlap@infradead.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent f56bcc04

drivers/net/ethernet/sfc/nic.h

+4 −3
Original line number Diff line number Diff line
@@ -156,9 +156,9 @@ enum { 
 * @tx_dpcpu_fw_id: Firmware ID of the TxDPCPU

 * @must_probe_vswitching: Flag: vswitching has yet to be setup after MC reboot

 * @pf_index: The number for this PF, or the parent PF if this is a VF

#ifdef CONFIG_SFC_SRIOV

 * @vf: Pointer to VF data structure

#endif

 * @port_id: Ethernet address of owning PF, used for phys_port_id

 * @vf_index: The number for this VF, or 0xFFFF if this is a VF

 * @vf: for a PF, array of VF data structures indexed by VF's @vf_index

 * @vport_mac: The MAC address on the vport, only for PFs; VFs will be zero

 * @vlan_list: List of VLANs added over the interface. Serialised by vlan_lock.

 * @vlan_lock: Lock to serialize access to vlan_list.
@@ -166,6 +166,7 @@ enum { 
 * @udp_tunnels_dirty: flag indicating a reboot occurred while pushing

 *	@udp_tunnels to hardware and thus the push must be re-done.

 * @udp_tunnels_lock: Serialises writes to @udp_tunnels and @udp_tunnels_dirty.

 * @licensed_features: Flags for licensed firmware features.

 */

struct efx_ef10_nic_data {

	struct efx_buffer mcdi_buf;