Commit 03e2dbbb authored by Lee Jones's avatar Lee Jones Committed by Jason Gunthorpe

RDMA/hw/i40iw/i40iw_cm: Fix a bunch of function documentation issues

Fixes the following W=1 kernel build warning(s):

 drivers/infiniband/hw/i40iw/i40iw_cm.c:76: warning: Function parameter or member 'bufp' not described in 'i40iw_free_sqbuf'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:76: warning: Excess function parameter 'buf' description in 'i40iw_free_sqbuf'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:737: warning: Function parameter or member 'start_addr' not described in 'i40iw_build_mpa_v1'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:1059: warning: Function parameter or member 'cm_node' not described in 'i40iw_schedule_cm_timer'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:1211: warning: Function parameter or member 't' not described in 'i40iw_cm_timer_tick'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:1211: warning: Excess function parameter 'pass' description in 'i40iw_cm_timer_tick'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:1475: warning: Function parameter or member 'vlan_id' not described in 'i40iw_find_listener'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:1527: warning: Function parameter or member 'port' not described in 'i40iw_find_port'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:1527: warning: Excess function parameter 'accelerated_list' description in 'i40iw_find_port'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:1843: warning: Function parameter or member 'listener' not described in 'i40iw_dec_refcnt_listen'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:2037: warning: Function parameter or member 'src_addr' not described in 'i40iw_get_dst_ipv6'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:2037: warning: Function parameter or member 'dst_addr' not described in 'i40iw_get_dst_ipv6'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:2061: warning: Function parameter or member 'src' not described in 'i40iw_addr_resolve_neigh_ipv6'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:2061: warning: Function parameter or member 'dest' not described in 'i40iw_addr_resolve_neigh_ipv6'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:2061: warning: Excess function parameter 'dst_ip' description in 'i40iw_addr_resolve_neigh_ipv6'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:3011: warning: Function parameter or member 'pdata' not described in 'i40iw_cm_reject'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:3011: warning: Excess function parameter 'pdate' description in 'i40iw_cm_reject'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:4312: warning: Function parameter or member 'nfo' not described in 'i40iw_cm_teardown_connections'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:4312: warning: Excess function parameter 'ipv4' description in 'i40iw_cm_teardown_connections'
 drivers/infiniband/hw/i40iw/i40iw_cm.c:4367: warning: Function parameter or member 'netdev' not described in 'i40iw_if_notify'

Link: https://lore.kernel.org/r/20210118223929.512175-5-lee.jones@linaro.org
Cc: Faisal Latif <faisal.latif@intel.com>
Cc: Shiraz Saleem <shiraz.saleem@intel.com>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@ziepe.ca>
Cc: linux-rdma@vger.kernel.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarJason Gunthorpe <jgg@nvidia.com>
parent 14fa9fe5
...@@ -70,7 +70,7 @@ static void i40iw_disconnect_worker(struct work_struct *work); ...@@ -70,7 +70,7 @@ static void i40iw_disconnect_worker(struct work_struct *work);
/** /**
* i40iw_free_sqbuf - put back puda buffer if refcount = 0 * i40iw_free_sqbuf - put back puda buffer if refcount = 0
* @vsi: pointer to vsi structure * @vsi: pointer to vsi structure
* @buf: puda buffer to free * @bufp: puda buffer to free
*/ */
void i40iw_free_sqbuf(struct i40iw_sc_vsi *vsi, void *bufp) void i40iw_free_sqbuf(struct i40iw_sc_vsi *vsi, void *bufp)
{ {
...@@ -729,6 +729,7 @@ static int i40iw_handle_tcp_options(struct i40iw_cm_node *cm_node, ...@@ -729,6 +729,7 @@ static int i40iw_handle_tcp_options(struct i40iw_cm_node *cm_node,
/** /**
* i40iw_build_mpa_v1 - build a MPA V1 frame * i40iw_build_mpa_v1 - build a MPA V1 frame
* @cm_node: connection's node * @cm_node: connection's node
* @start_addr: MPA frame start address
* @mpa_key: to do read0 or write0 * @mpa_key: to do read0 or write0
*/ */
static void i40iw_build_mpa_v1(struct i40iw_cm_node *cm_node, static void i40iw_build_mpa_v1(struct i40iw_cm_node *cm_node,
...@@ -1040,7 +1041,7 @@ static int i40iw_parse_mpa(struct i40iw_cm_node *cm_node, u8 *buffer, u32 *type, ...@@ -1040,7 +1041,7 @@ static int i40iw_parse_mpa(struct i40iw_cm_node *cm_node, u8 *buffer, u32 *type,
/** /**
* i40iw_schedule_cm_timer * i40iw_schedule_cm_timer
* @@cm_node: connection's node * @cm_node: connection's node
* @sqbuf: buffer to send * @sqbuf: buffer to send
* @type: if it is send or close * @type: if it is send or close
* @send_retrans: if rexmits to be done * @send_retrans: if rexmits to be done
...@@ -1205,7 +1206,7 @@ static void i40iw_build_timer_list(struct list_head *timer_list, ...@@ -1205,7 +1206,7 @@ static void i40iw_build_timer_list(struct list_head *timer_list,
/** /**
* i40iw_cm_timer_tick - system's timer expired callback * i40iw_cm_timer_tick - system's timer expired callback
* @pass: Pointing to cm_core * @t: Timer instance to fetch the cm_core pointer from
*/ */
static void i40iw_cm_timer_tick(struct timer_list *t) static void i40iw_cm_timer_tick(struct timer_list *t)
{ {
...@@ -1463,6 +1464,7 @@ struct i40iw_cm_node *i40iw_find_node(struct i40iw_cm_core *cm_core, ...@@ -1463,6 +1464,7 @@ struct i40iw_cm_node *i40iw_find_node(struct i40iw_cm_core *cm_core,
* @cm_core: cm's core * @cm_core: cm's core
* @dst_port: listener tcp port num * @dst_port: listener tcp port num
* @dst_addr: listener ip addr * @dst_addr: listener ip addr
* @vlan_id: vlan id for the given address
* @listener_state: state to match with listen node's * @listener_state: state to match with listen node's
*/ */
static struct i40iw_cm_listener *i40iw_find_listener( static struct i40iw_cm_listener *i40iw_find_listener(
...@@ -1521,7 +1523,7 @@ static void i40iw_add_hte_node(struct i40iw_cm_core *cm_core, ...@@ -1521,7 +1523,7 @@ static void i40iw_add_hte_node(struct i40iw_cm_core *cm_core,
/** /**
* i40iw_find_port - find port that matches reference port * i40iw_find_port - find port that matches reference port
* @hte: ptr to accelerated or non-accelerated list * @hte: ptr to accelerated or non-accelerated list
* @accelerated_list: flag for accelerated vs non-accelerated list * @port: port number to locate
*/ */
static bool i40iw_find_port(struct list_head *hte, u16 port) static bool i40iw_find_port(struct list_head *hte, u16 port)
{ {
...@@ -1834,6 +1836,7 @@ static enum i40iw_status_code i40iw_add_mqh_4( ...@@ -1834,6 +1836,7 @@ static enum i40iw_status_code i40iw_add_mqh_4(
/** /**
* i40iw_dec_refcnt_listen - delete listener and associated cm nodes * i40iw_dec_refcnt_listen - delete listener and associated cm nodes
* @cm_core: cm's core * @cm_core: cm's core
* @listener: passive connection's listener
* @free_hanging_nodes: to free associated cm_nodes * @free_hanging_nodes: to free associated cm_nodes
* @apbvt_del: flag to delete the apbvt * @apbvt_del: flag to delete the apbvt
*/ */
...@@ -2029,7 +2032,7 @@ static int i40iw_addr_resolve_neigh(struct i40iw_device *iwdev, ...@@ -2029,7 +2032,7 @@ static int i40iw_addr_resolve_neigh(struct i40iw_device *iwdev,
return rc; return rc;
} }
/** /*
* i40iw_get_dst_ipv6 * i40iw_get_dst_ipv6
*/ */
static struct dst_entry *i40iw_get_dst_ipv6(struct sockaddr_in6 *src_addr, static struct dst_entry *i40iw_get_dst_ipv6(struct sockaddr_in6 *src_addr,
...@@ -2051,7 +2054,8 @@ static struct dst_entry *i40iw_get_dst_ipv6(struct sockaddr_in6 *src_addr, ...@@ -2051,7 +2054,8 @@ static struct dst_entry *i40iw_get_dst_ipv6(struct sockaddr_in6 *src_addr,
/** /**
* i40iw_addr_resolve_neigh_ipv6 - resolve neighbor ipv6 address * i40iw_addr_resolve_neigh_ipv6 - resolve neighbor ipv6 address
* @iwdev: iwarp device structure * @iwdev: iwarp device structure
* @dst_ip: remote ip address * @src: source ip address
* @dest: remote ip address
* @arpindex: if there is an arp entry * @arpindex: if there is an arp entry
*/ */
static int i40iw_addr_resolve_neigh_ipv6(struct i40iw_device *iwdev, static int i40iw_addr_resolve_neigh_ipv6(struct i40iw_device *iwdev,
...@@ -3004,7 +3008,7 @@ static struct i40iw_cm_node *i40iw_create_cm_node( ...@@ -3004,7 +3008,7 @@ static struct i40iw_cm_node *i40iw_create_cm_node(
/** /**
* i40iw_cm_reject - reject and teardown a connection * i40iw_cm_reject - reject and teardown a connection
* @cm_node: connection's node * @cm_node: connection's node
* @pdate: ptr to private data for reject * @pdata: ptr to private data for reject
* @plen: size of private data * @plen: size of private data
*/ */
static int i40iw_cm_reject(struct i40iw_cm_node *cm_node, const void *pdata, u8 plen) static int i40iw_cm_reject(struct i40iw_cm_node *cm_node, const void *pdata, u8 plen)
...@@ -4302,7 +4306,7 @@ static void i40iw_qhash_ctrl(struct i40iw_device *iwdev, ...@@ -4302,7 +4306,7 @@ static void i40iw_qhash_ctrl(struct i40iw_device *iwdev,
* i40iw_cm_teardown_connections - teardown QPs * i40iw_cm_teardown_connections - teardown QPs
* @iwdev: device pointer * @iwdev: device pointer
* @ipaddr: Pointer to IPv4 or IPv6 address * @ipaddr: Pointer to IPv4 or IPv6 address
* @ipv4: flag indicating IPv4 when true * @nfo: cm info node
* @disconnect_all: flag indicating disconnect all QPs * @disconnect_all: flag indicating disconnect all QPs
* teardown QPs where source or destination addr matches ip addr * teardown QPs where source or destination addr matches ip addr
*/ */
...@@ -4358,6 +4362,7 @@ void i40iw_cm_teardown_connections(struct i40iw_device *iwdev, u32 *ipaddr, ...@@ -4358,6 +4362,7 @@ void i40iw_cm_teardown_connections(struct i40iw_device *iwdev, u32 *ipaddr,
/** /**
* i40iw_ifdown_notify - process an ifdown on an interface * i40iw_ifdown_notify - process an ifdown on an interface
* @iwdev: device pointer * @iwdev: device pointer
* @netdev: network interface device structure
* @ipaddr: Pointer to IPv4 or IPv6 address * @ipaddr: Pointer to IPv4 or IPv6 address
* @ipv4: flag indicating IPv4 when true * @ipv4: flag indicating IPv4 when true
* @ifup: flag indicating interface up when true * @ifup: flag indicating interface up when true
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment