Skip to content

Commit 363656e

Browse files
jacob-kellerJeff Kirsher
authored andcommitted
fm10k: fix function doxygen comments
Several function header comments had incorrect function parameter definitions. Recent versions of the upstream kernel have started to warn about these issues. Fix up the comments which do not match in order to resolve these new warnings. While fixing these, update the copyright year also. Signed-off-by: Jacob Keller <[email protected]> Tested-by: Krishneil Singh <[email protected]> Signed-off-by: Jeff Kirsher <[email protected]>
1 parent fb66cb0 commit 363656e

File tree

5 files changed

+20
-17
lines changed

5 files changed

+20
-17
lines changed

drivers/net/ethernet/intel/fm10k/fm10k_common.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* Intel(R) Ethernet Switch Host Interface Driver
2-
* Copyright(c) 2013 - 2017 Intel Corporation.
2+
* Copyright(c) 2013 - 2018 Intel Corporation.
33
*
44
* This program is free software; you can redistribute it and/or modify it
55
* under the terms and conditions of the GNU General Public License,
@@ -262,6 +262,7 @@ s32 fm10k_stop_hw_generic(struct fm10k_hw *hw)
262262
* fm10k_read_hw_stats_32b - Reads value of 32-bit registers
263263
* @hw: pointer to the hardware structure
264264
* @addr: address of register containing a 32-bit value
265+
* @stat: pointer to structure holding hw stat information
265266
*
266267
* Function reads the content of the register and returns the delta
267268
* between the base and the current value.
@@ -281,6 +282,7 @@ u32 fm10k_read_hw_stats_32b(struct fm10k_hw *hw, u32 addr,
281282
* fm10k_read_hw_stats_48b - Reads value of 48-bit registers
282283
* @hw: pointer to the hardware structure
283284
* @addr: address of register containing the lower 32-bit value
285+
* @stat: pointer to structure holding hw stat information
284286
*
285287
* Function reads the content of 2 registers, combined to represent a 48-bit
286288
* statistical value. Extra processing is required to handle overflowing.
@@ -461,7 +463,6 @@ void fm10k_update_hw_stats_q(struct fm10k_hw *hw, struct fm10k_hw_stats_q *q,
461463

462464
/**
463465
* fm10k_unbind_hw_stats_q - Unbind the queue counters from their queues
464-
* @hw: pointer to the hardware structure
465466
* @q: pointer to the ring of hardware statistics queue
466467
* @idx: index pointing to the start of the ring iteration
467468
* @count: number of queues to iterate over

drivers/net/ethernet/intel/fm10k/fm10k_netdev.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* Intel(R) Ethernet Switch Host Interface Driver
2-
* Copyright(c) 2013 - 2017 Intel Corporation.
2+
* Copyright(c) 2013 - 2018 Intel Corporation.
33
*
44
* This program is free software; you can redistribute it and/or modify it
55
* under the terms and conditions of the GNU General Public License,
@@ -486,7 +486,7 @@ static void fm10k_insert_tunnel_port(struct list_head *ports,
486486

487487
/**
488488
* fm10k_udp_tunnel_add
489-
* @netdev: network interface device structure
489+
* @dev: network interface device structure
490490
* @ti: Tunnel endpoint information
491491
*
492492
* This function is called when a new UDP tunnel port has been added.
@@ -518,8 +518,8 @@ static void fm10k_udp_tunnel_add(struct net_device *dev,
518518

519519
/**
520520
* fm10k_udp_tunnel_del
521-
* @netdev: network interface device structure
522-
* @ti: Tunnel endpoint information
521+
* @dev: network interface device structure
522+
* @ti: Tunnel end point information
523523
*
524524
* This function is called when a new UDP tunnel port is deleted. The freed
525525
* port will be removed from the list, then we reprogram the offloaded port
@@ -803,7 +803,7 @@ int fm10k_queue_vlan_request(struct fm10k_intfc *interface,
803803
* @glort: the target glort for this update
804804
* @addr: the address to update
805805
* @vid: the vid to update
806-
* @sync: whether to add or remove
806+
* @set: whether to add or remove
807807
*
808808
* This function queues up a MAC request for sending to the switch manager.
809809
* A separate thread monitors the queue and sends updates to the switch

drivers/net/ethernet/intel/fm10k/fm10k_pci.c

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* Intel(R) Ethernet Switch Host Interface Driver
2-
* Copyright(c) 2013 - 2017 Intel Corporation.
2+
* Copyright(c) 2013 - 2018 Intel Corporation.
33
*
44
* This program is free software; you can redistribute it and/or modify it
55
* under the terms and conditions of the GNU General Public License,
@@ -211,7 +211,7 @@ static void fm10k_start_service_event(struct fm10k_intfc *interface)
211211

212212
/**
213213
* fm10k_service_timer - Timer Call-back
214-
* @data: pointer to interface cast into an unsigned long
214+
* @t: pointer to timer data
215215
**/
216216
static void fm10k_service_timer(struct timer_list *t)
217217
{
@@ -649,7 +649,7 @@ void fm10k_update_stats(struct fm10k_intfc *interface)
649649

650650
/**
651651
* fm10k_watchdog_flush_tx - flush queues on host not ready
652-
* @interface - pointer to the device interface structure
652+
* @interface: pointer to the device interface structure
653653
**/
654654
static void fm10k_watchdog_flush_tx(struct fm10k_intfc *interface)
655655
{
@@ -679,7 +679,7 @@ static void fm10k_watchdog_flush_tx(struct fm10k_intfc *interface)
679679

680680
/**
681681
* fm10k_watchdog_subtask - check and bring link up
682-
* @interface - pointer to the device interface structure
682+
* @interface: pointer to the device interface structure
683683
**/
684684
static void fm10k_watchdog_subtask(struct fm10k_intfc *interface)
685685
{
@@ -703,7 +703,7 @@ static void fm10k_watchdog_subtask(struct fm10k_intfc *interface)
703703

704704
/**
705705
* fm10k_check_hang_subtask - check for hung queues and dropped interrupts
706-
* @interface - pointer to the device interface structure
706+
* @interface: pointer to the device interface structure
707707
*
708708
* This function serves two purposes. First it strobes the interrupt lines
709709
* in order to make certain interrupts are occurring. Secondly it sets the
@@ -1995,6 +1995,7 @@ void fm10k_down(struct fm10k_intfc *interface)
19951995
/**
19961996
* fm10k_sw_init - Initialize general software structures
19971997
* @interface: host interface private structure to initialize
1998+
* @ent: PCI device ID entry
19981999
*
19992000
* fm10k_sw_init initializes the interface private data structure.
20002001
* Fields are initialized based on PCI device information and

drivers/net/ethernet/intel/fm10k/fm10k_pf.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* Intel(R) Ethernet Switch Host Interface Driver
2-
* Copyright(c) 2013 - 2017 Intel Corporation.
2+
* Copyright(c) 2013 - 2018 Intel Corporation.
33
*
44
* This program is free software; you can redistribute it and/or modify it
55
* under the terms and conditions of the GNU General Public License,
@@ -1180,7 +1180,7 @@ s32 fm10k_iov_msg_msix_pf(struct fm10k_hw *hw, u32 **results,
11801180

11811181
/**
11821182
* fm10k_iov_select_vid - Select correct default VLAN ID
1183-
* @hw: Pointer to hardware structure
1183+
* @vf_info: pointer to VF information structure
11841184
* @vid: VLAN ID to correct
11851185
*
11861186
* Will report an error if the VLAN ID is out of range. For VID = 0, it will

drivers/net/ethernet/intel/fm10k/fm10k_tlv.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* Intel(R) Ethernet Switch Host Interface Driver
2-
* Copyright(c) 2013 - 2016 Intel Corporation.
2+
* Copyright(c) 2013 - 2018 Intel Corporation.
33
*
44
* This program is free software; you can redistribute it and/or modify it
55
* under the terms and conditions of the GNU General Public License,
@@ -120,6 +120,7 @@ static s32 fm10k_tlv_attr_get_null_string(u32 *attr, unsigned char *string)
120120
* @msg: Pointer to message block
121121
* @attr_id: Attribute ID
122122
* @mac_addr: MAC address to be stored
123+
* @vlan: VLAN to be stored
123124
*
124125
* This function will reorder a MAC address to be CPU endian and store it
125126
* in the attribute buffer. It will return success if provided with a
@@ -155,8 +156,8 @@ s32 fm10k_tlv_attr_put_mac_vlan(u32 *msg, u16 attr_id,
155156
/**
156157
* fm10k_tlv_attr_get_mac_vlan - Get MAC/VLAN stored in attribute
157158
* @attr: Pointer to attribute
158-
* @attr_id: Attribute ID
159159
* @mac_addr: location of buffer to store MAC address
160+
* @vlan: location of buffer to store VLAN
160161
*
161162
* This function pulls the MAC address back out of the attribute and will
162163
* place it in the array pointed by by mac_addr. It will return success
@@ -549,7 +550,7 @@ static s32 fm10k_tlv_attr_parse(u32 *attr, u32 **results,
549550
* @hw: Pointer to hardware structure
550551
* @msg: Pointer to message
551552
* @mbx: Pointer to mailbox information structure
552-
* @func: Function array containing list of message handling functions
553+
* @data: Pointer to message handler data structure
553554
*
554555
* This function should be the first function called upon receiving a
555556
* message. The handler will identify the message type and call the correct

0 commit comments

Comments
 (0)