aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJacob Keller <jacob.e.keller@intel.com>2018-01-16 14:20:51 -0500
committerJeff Kirsher <jeffrey.t.kirsher@intel.com>2018-02-28 10:22:29 -0500
commit363656eb5e574b6dab513a10b7166f08783fa3e3 (patch)
tree3552c668803a048eea868558ec357085285e7aab
parentfb66cb0775609852b812c9bc2bd1589374317410 (diff)
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 <jacob.e.keller@intel.com> Tested-by: Krishneil Singh <krishneil.k.singh@intel.com> Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
-rw-r--r--drivers/net/ethernet/intel/fm10k/fm10k_common.c5
-rw-r--r--drivers/net/ethernet/intel/fm10k/fm10k_netdev.c10
-rw-r--r--drivers/net/ethernet/intel/fm10k/fm10k_pci.c11
-rw-r--r--drivers/net/ethernet/intel/fm10k/fm10k_pf.c4
-rw-r--r--drivers/net/ethernet/intel/fm10k/fm10k_tlv.c7
5 files changed, 20 insertions, 17 deletions
diff --git a/drivers/net/ethernet/intel/fm10k/fm10k_common.c b/drivers/net/ethernet/intel/fm10k/fm10k_common.c
index 736a9f087bc9..c58a5377a287 100644
--- a/drivers/net/ethernet/intel/fm10k/fm10k_common.c
+++ b/drivers/net/ethernet/intel/fm10k/fm10k_common.c
@@ -1,5 +1,5 @@
1/* Intel(R) Ethernet Switch Host Interface Driver 1/* Intel(R) Ethernet Switch Host Interface Driver
2 * Copyright(c) 2013 - 2017 Intel Corporation. 2 * Copyright(c) 2013 - 2018 Intel Corporation.
3 * 3 *
4 * This program is free software; you can redistribute it and/or modify it 4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License, 5 * under the terms and conditions of the GNU General Public License,
@@ -262,6 +262,7 @@ s32 fm10k_stop_hw_generic(struct fm10k_hw *hw)
262 * fm10k_read_hw_stats_32b - Reads value of 32-bit registers 262 * fm10k_read_hw_stats_32b - Reads value of 32-bit registers
263 * @hw: pointer to the hardware structure 263 * @hw: pointer to the hardware structure
264 * @addr: address of register containing a 32-bit value 264 * @addr: address of register containing a 32-bit value
265 * @stat: pointer to structure holding hw stat information
265 * 266 *
266 * Function reads the content of the register and returns the delta 267 * Function reads the content of the register and returns the delta
267 * between the base and the current value. 268 * between the base and the current value.
@@ -281,6 +282,7 @@ u32 fm10k_read_hw_stats_32b(struct fm10k_hw *hw, u32 addr,
281 * fm10k_read_hw_stats_48b - Reads value of 48-bit registers 282 * fm10k_read_hw_stats_48b - Reads value of 48-bit registers
282 * @hw: pointer to the hardware structure 283 * @hw: pointer to the hardware structure
283 * @addr: address of register containing the lower 32-bit value 284 * @addr: address of register containing the lower 32-bit value
285 * @stat: pointer to structure holding hw stat information
284 * 286 *
285 * Function reads the content of 2 registers, combined to represent a 48-bit 287 * Function reads the content of 2 registers, combined to represent a 48-bit
286 * statistical value. Extra processing is required to handle overflowing. 288 * 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,
461 463
462/** 464/**
463 * fm10k_unbind_hw_stats_q - Unbind the queue counters from their queues 465 * fm10k_unbind_hw_stats_q - Unbind the queue counters from their queues
464 * @hw: pointer to the hardware structure
465 * @q: pointer to the ring of hardware statistics queue 466 * @q: pointer to the ring of hardware statistics queue
466 * @idx: index pointing to the start of the ring iteration 467 * @idx: index pointing to the start of the ring iteration
467 * @count: number of queues to iterate over 468 * @count: number of queues to iterate over
diff --git a/drivers/net/ethernet/intel/fm10k/fm10k_netdev.c b/drivers/net/ethernet/intel/fm10k/fm10k_netdev.c
index a38ae5c54da3..75c99aed3c41 100644
--- a/drivers/net/ethernet/intel/fm10k/fm10k_netdev.c
+++ b/drivers/net/ethernet/intel/fm10k/fm10k_netdev.c
@@ -1,5 +1,5 @@
1/* Intel(R) Ethernet Switch Host Interface Driver 1/* Intel(R) Ethernet Switch Host Interface Driver
2 * Copyright(c) 2013 - 2017 Intel Corporation. 2 * Copyright(c) 2013 - 2018 Intel Corporation.
3 * 3 *
4 * This program is free software; you can redistribute it and/or modify it 4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License, 5 * 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,
486 486
487/** 487/**
488 * fm10k_udp_tunnel_add 488 * fm10k_udp_tunnel_add
489 * @netdev: network interface device structure 489 * @dev: network interface device structure
490 * @ti: Tunnel endpoint information 490 * @ti: Tunnel endpoint information
491 * 491 *
492 * This function is called when a new UDP tunnel port has been added. 492 * 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,
518 518
519/** 519/**
520 * fm10k_udp_tunnel_del 520 * fm10k_udp_tunnel_del
521 * @netdev: network interface device structure 521 * @dev: network interface device structure
522 * @ti: Tunnel endpoint information 522 * @ti: Tunnel end point information
523 * 523 *
524 * This function is called when a new UDP tunnel port is deleted. The freed 524 * This function is called when a new UDP tunnel port is deleted. The freed
525 * port will be removed from the list, then we reprogram the offloaded port 525 * 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,
803 * @glort: the target glort for this update 803 * @glort: the target glort for this update
804 * @addr: the address to update 804 * @addr: the address to update
805 * @vid: the vid to update 805 * @vid: the vid to update
806 * @sync: whether to add or remove 806 * @set: whether to add or remove
807 * 807 *
808 * This function queues up a MAC request for sending to the switch manager. 808 * This function queues up a MAC request for sending to the switch manager.
809 * A separate thread monitors the queue and sends updates to the switch 809 * A separate thread monitors the queue and sends updates to the switch
diff --git a/drivers/net/ethernet/intel/fm10k/fm10k_pci.c b/drivers/net/ethernet/intel/fm10k/fm10k_pci.c
index a434fecfdfeb..d7aad4cb73a7 100644
--- a/drivers/net/ethernet/intel/fm10k/fm10k_pci.c
+++ b/drivers/net/ethernet/intel/fm10k/fm10k_pci.c
@@ -1,5 +1,5 @@
1/* Intel(R) Ethernet Switch Host Interface Driver 1/* Intel(R) Ethernet Switch Host Interface Driver
2 * Copyright(c) 2013 - 2017 Intel Corporation. 2 * Copyright(c) 2013 - 2018 Intel Corporation.
3 * 3 *
4 * This program is free software; you can redistribute it and/or modify it 4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License, 5 * 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)
211 211
212/** 212/**
213 * fm10k_service_timer - Timer Call-back 213 * fm10k_service_timer - Timer Call-back
214 * @data: pointer to interface cast into an unsigned long 214 * @t: pointer to timer data
215 **/ 215 **/
216static void fm10k_service_timer(struct timer_list *t) 216static void fm10k_service_timer(struct timer_list *t)
217{ 217{
@@ -649,7 +649,7 @@ void fm10k_update_stats(struct fm10k_intfc *interface)
649 649
650/** 650/**
651 * fm10k_watchdog_flush_tx - flush queues on host not ready 651 * 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
653 **/ 653 **/
654static void fm10k_watchdog_flush_tx(struct fm10k_intfc *interface) 654static void fm10k_watchdog_flush_tx(struct fm10k_intfc *interface)
655{ 655{
@@ -679,7 +679,7 @@ static void fm10k_watchdog_flush_tx(struct fm10k_intfc *interface)
679 679
680/** 680/**
681 * fm10k_watchdog_subtask - check and bring link up 681 * fm10k_watchdog_subtask - check and bring link up
682 * @interface - pointer to the device interface structure 682 * @interface: pointer to the device interface structure
683 **/ 683 **/
684static void fm10k_watchdog_subtask(struct fm10k_intfc *interface) 684static void fm10k_watchdog_subtask(struct fm10k_intfc *interface)
685{ 685{
@@ -703,7 +703,7 @@ static void fm10k_watchdog_subtask(struct fm10k_intfc *interface)
703 703
704/** 704/**
705 * fm10k_check_hang_subtask - check for hung queues and dropped interrupts 705 * 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
707 * 707 *
708 * This function serves two purposes. First it strobes the interrupt lines 708 * This function serves two purposes. First it strobes the interrupt lines
709 * in order to make certain interrupts are occurring. Secondly it sets the 709 * in order to make certain interrupts are occurring. Secondly it sets the
@@ -1995,6 +1995,7 @@ skip_tx_dma_drain:
1995/** 1995/**
1996 * fm10k_sw_init - Initialize general software structures 1996 * fm10k_sw_init - Initialize general software structures
1997 * @interface: host interface private structure to initialize 1997 * @interface: host interface private structure to initialize
1998 * @ent: PCI device ID entry
1998 * 1999 *
1999 * fm10k_sw_init initializes the interface private data structure. 2000 * fm10k_sw_init initializes the interface private data structure.
2000 * Fields are initialized based on PCI device information and 2001 * Fields are initialized based on PCI device information and
diff --git a/drivers/net/ethernet/intel/fm10k/fm10k_pf.c b/drivers/net/ethernet/intel/fm10k/fm10k_pf.c
index d6406fc31ffb..bee192fe2ffb 100644
--- a/drivers/net/ethernet/intel/fm10k/fm10k_pf.c
+++ b/drivers/net/ethernet/intel/fm10k/fm10k_pf.c
@@ -1,5 +1,5 @@
1/* Intel(R) Ethernet Switch Host Interface Driver 1/* Intel(R) Ethernet Switch Host Interface Driver
2 * Copyright(c) 2013 - 2017 Intel Corporation. 2 * Copyright(c) 2013 - 2018 Intel Corporation.
3 * 3 *
4 * This program is free software; you can redistribute it and/or modify it 4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License, 5 * 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,
1180 1180
1181/** 1181/**
1182 * fm10k_iov_select_vid - Select correct default VLAN ID 1182 * fm10k_iov_select_vid - Select correct default VLAN ID
1183 * @hw: Pointer to hardware structure 1183 * @vf_info: pointer to VF information structure
1184 * @vid: VLAN ID to correct 1184 * @vid: VLAN ID to correct
1185 * 1185 *
1186 * Will report an error if the VLAN ID is out of range. For VID = 0, it will 1186 * Will report an error if the VLAN ID is out of range. For VID = 0, it will
diff --git a/drivers/net/ethernet/intel/fm10k/fm10k_tlv.c b/drivers/net/ethernet/intel/fm10k/fm10k_tlv.c
index f8e87bf086b9..9d0d31da426b 100644
--- a/drivers/net/ethernet/intel/fm10k/fm10k_tlv.c
+++ b/drivers/net/ethernet/intel/fm10k/fm10k_tlv.c
@@ -1,5 +1,5 @@
1/* Intel(R) Ethernet Switch Host Interface Driver 1/* Intel(R) Ethernet Switch Host Interface Driver
2 * Copyright(c) 2013 - 2016 Intel Corporation. 2 * Copyright(c) 2013 - 2018 Intel Corporation.
3 * 3 *
4 * This program is free software; you can redistribute it and/or modify it 4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License, 5 * 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)
120 * @msg: Pointer to message block 120 * @msg: Pointer to message block
121 * @attr_id: Attribute ID 121 * @attr_id: Attribute ID
122 * @mac_addr: MAC address to be stored 122 * @mac_addr: MAC address to be stored
123 * @vlan: VLAN to be stored
123 * 124 *
124 * This function will reorder a MAC address to be CPU endian and store it 125 * This function will reorder a MAC address to be CPU endian and store it
125 * in the attribute buffer. It will return success if provided with a 126 * 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,
155/** 156/**
156 * fm10k_tlv_attr_get_mac_vlan - Get MAC/VLAN stored in attribute 157 * fm10k_tlv_attr_get_mac_vlan - Get MAC/VLAN stored in attribute
157 * @attr: Pointer to attribute 158 * @attr: Pointer to attribute
158 * @attr_id: Attribute ID
159 * @mac_addr: location of buffer to store MAC address 159 * @mac_addr: location of buffer to store MAC address
160 * @vlan: location of buffer to store VLAN
160 * 161 *
161 * This function pulls the MAC address back out of the attribute and will 162 * This function pulls the MAC address back out of the attribute and will
162 * place it in the array pointed by by mac_addr. It will return success 163 * 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,
549 * @hw: Pointer to hardware structure 550 * @hw: Pointer to hardware structure
550 * @msg: Pointer to message 551 * @msg: Pointer to message
551 * @mbx: Pointer to mailbox information structure 552 * @mbx: Pointer to mailbox information structure
552 * @func: Function array containing list of message handling functions 553 * @data: Pointer to message handler data structure
553 * 554 *
554 * This function should be the first function called upon receiving a 555 * This function should be the first function called upon receiving a
555 * message. The handler will identify the message type and call the correct 556 * message. The handler will identify the message type and call the correct