mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-30 06:10:56 +00:00
RDMA: Fix kernel-doc warnings about wrong comment
Compilation with W=1 produces warnings similar to the below. drivers/infiniband/ulp/ipoib/ipoib_main.c:320: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst All such occurrences were found with the following one line git grep -A 1 "\/\*\*" drivers/infiniband/ Link: https://lore.kernel.org/r/e57d5f4ddd08b7a19934635b44d6d632841b9ba7.1623823612.git.leonro@nvidia.com Reviewed-by: Jack Wang <jinpu.wang@ionos.com> #rtrs Reviewed-by: Dennis Dalessandro <dennis.dalessandro@cornelisnetworks.com> Signed-off-by: Leon Romanovsky <leonro@nvidia.com> Signed-off-by: Jason Gunthorpe <jgg@nvidia.com>
This commit is contained in:
Leon Romanovsky
Jason Gunthorpe
parent
da43b7bebc
commit
bf194997c7
16 changed files with 31 additions and 28 deletions
|
|
@ -183,7 +183,7 @@ u32 iwpm_check_registration(u8 nl_client, u32 reg);
|
|||
void iwpm_set_registration(u8 nl_client, u32 reg);
|
||||
|
||||
/**
|
||||
* iwpm_get_registration
|
||||
* iwpm_get_registration - Get the client registration
|
||||
* @nl_client: The index of the netlink client
|
||||
*
|
||||
* Returns the client registration type
|
||||
|
|
|
|||
|
|
@ -186,12 +186,13 @@ is_eth_port_inactive_slave_filter(struct ib_device *ib_dev, u32 port,
|
|||
return res;
|
||||
}
|
||||
|
||||
/** is_ndev_for_default_gid_filter - Check if a given netdevice
|
||||
/**
|
||||
* is_ndev_for_default_gid_filter - Check if a given netdevice
|
||||
* can be considered for default GIDs or not.
|
||||
* @ib_dev: IB device to check
|
||||
* @port: Port to consider for adding default GID
|
||||
* @rdma_ndev: rdma netdevice pointer
|
||||
* @cookie_ndev: Netdevice to consider to form a default GID
|
||||
* @cookie: Netdevice to consider to form a default GID
|
||||
*
|
||||
* is_ndev_for_default_gid_filter() returns true if a given netdevice can be
|
||||
* considered for deriving default RoCE GID, returns false otherwise.
|
||||
|
|
|
|||
|
|
@ -14186,7 +14186,7 @@ static void init_kdeth_qp(struct hfi1_devdata *dd)
|
|||
}
|
||||
|
||||
/**
|
||||
* hfi1_get_qp_map
|
||||
* hfi1_get_qp_map - get qp map
|
||||
* @dd: device data
|
||||
* @idx: index to read
|
||||
*/
|
||||
|
|
@ -14199,7 +14199,7 @@ u8 hfi1_get_qp_map(struct hfi1_devdata *dd, u8 idx)
|
|||
}
|
||||
|
||||
/**
|
||||
* init_qpmap_table
|
||||
* init_qpmap_table - init qp map
|
||||
* @dd: device data
|
||||
* @first_ctxt: first context
|
||||
* @last_ctxt: first context
|
||||
|
|
|
|||
|
|
@ -736,7 +736,7 @@ static u64 kvirt_to_phys(void *addr)
|
|||
}
|
||||
|
||||
/**
|
||||
* complete_subctxt
|
||||
* complete_subctxt - complete sub-context info
|
||||
* @fd: valid filedata pointer
|
||||
*
|
||||
* Sub-context info can only be set up after the base context
|
||||
|
|
@ -841,7 +841,7 @@ static int assign_ctxt(struct hfi1_filedata *fd, unsigned long arg, u32 len)
|
|||
}
|
||||
|
||||
/**
|
||||
* match_ctxt
|
||||
* match_ctxt - match context
|
||||
* @fd: valid filedata pointer
|
||||
* @uinfo: user info to compare base context with
|
||||
* @uctxt: context to compare uinfo to.
|
||||
|
|
@ -898,7 +898,7 @@ static int match_ctxt(struct hfi1_filedata *fd,
|
|||
}
|
||||
|
||||
/**
|
||||
* find_sub_ctxt
|
||||
* find_sub_ctxt - fund sub-context
|
||||
* @fd: valid filedata pointer
|
||||
* @uinfo: matching info to use to find a possible context to share.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1760,7 +1760,7 @@ static inline void pause_for_credit_return(struct hfi1_devdata *dd)
|
|||
}
|
||||
|
||||
/**
|
||||
* sc_to_vlt() reverse lookup sc to vl
|
||||
* sc_to_vlt() - reverse lookup sc to vl
|
||||
* @dd - devdata
|
||||
* @sc5 - 5 bit sc
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -312,7 +312,7 @@ struct hfi1_ctxtdata *hfi1_rcd_get_by_index_safe(struct hfi1_devdata *dd,
|
|||
}
|
||||
|
||||
/**
|
||||
* hfi1_rcd_get_by_index
|
||||
* hfi1_rcd_get_by_index - get by index
|
||||
* @dd: pointer to a valid devdata structure
|
||||
* @ctxt: the index of an possilbe rcd
|
||||
*
|
||||
|
|
@ -499,7 +499,7 @@ int hfi1_create_ctxtdata(struct hfi1_pportdata *ppd, int numa,
|
|||
}
|
||||
|
||||
/**
|
||||
* hfi1_free_ctxt
|
||||
* hfi1_free_ctxt - free context
|
||||
* @rcd: pointer to an initialized rcd data structure
|
||||
*
|
||||
* This wrapper is the free function that matches hfi1_create_ctxtdata().
|
||||
|
|
|
|||
|
|
@ -993,7 +993,7 @@ static bool is_sc_halted(struct hfi1_devdata *dd, u32 hw_context)
|
|||
}
|
||||
|
||||
/**
|
||||
* sc_wait_for_packet_egress
|
||||
* sc_wait_for_packet_egress - wait for packet
|
||||
* @sc: valid send context
|
||||
* @pause: wait for credit return
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1082,7 +1082,7 @@ static bool hem_list_is_bottom_bt(int hopnum, int bt_level)
|
|||
return bt_level >= (hopnum ? hopnum - 1 : hopnum);
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* calc base address entries num
|
||||
* @hopnum: num of mutihop addressing
|
||||
* @bt_level: base address table level
|
||||
|
|
@ -1115,7 +1115,7 @@ static u32 hem_list_calc_ba_range(int hopnum, int bt_level, int unit)
|
|||
return step;
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* calc the root ba entries which could cover all regions
|
||||
* @regions: buf region array
|
||||
* @region_cnt: array size of @regions
|
||||
|
|
|
|||
|
|
@ -101,8 +101,8 @@ int rvt_driver_mr_init(struct rvt_dev_info *rdi)
|
|||
}
|
||||
|
||||
/**
|
||||
*rvt_mr_exit: clean up MR
|
||||
*@rdi: rvt dev structure
|
||||
* rvt_mr_exit - clean up MR
|
||||
* @rdi: rvt dev structure
|
||||
*
|
||||
* called when drivers have unregistered or perhaps failed to register with us
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -984,7 +984,8 @@ static void rvt_reset_qp(struct rvt_dev_info *rdi, struct rvt_qp *qp,
|
|||
spin_unlock_irq(&qp->r_lock);
|
||||
}
|
||||
|
||||
/** rvt_free_qpn - Free a qpn from the bit map
|
||||
/**
|
||||
* rvt_free_qpn - Free a qpn from the bit map
|
||||
* @qpt: QP table
|
||||
* @qpn: queue pair number to free
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -144,7 +144,7 @@ static int rvt_modify_device(struct ib_device *device,
|
|||
}
|
||||
|
||||
/**
|
||||
* rvt_query_port: Passes the query port call to the driver
|
||||
* rvt_query_port - Passes the query port call to the driver
|
||||
* @ibdev: Verbs IB dev
|
||||
* @port_num: port number, 1 based from ib core
|
||||
* @props: structure to hold returned properties
|
||||
|
|
@ -175,7 +175,7 @@ static int rvt_query_port(struct ib_device *ibdev, u32 port_num,
|
|||
}
|
||||
|
||||
/**
|
||||
* rvt_modify_port
|
||||
* rvt_modify_port - modify port
|
||||
* @ibdev: Verbs IB dev
|
||||
* @port_num: Port number, 1 based from ib core
|
||||
* @port_modify_mask: How to change the port
|
||||
|
|
|
|||
|
|
@ -316,7 +316,7 @@ static bool ipoib_is_dev_match_addr_rcu(const struct sockaddr *addr,
|
|||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* Find the master net_device on top of the given net_device.
|
||||
* @dev: base IPoIB net_device
|
||||
*
|
||||
|
|
@ -361,8 +361,9 @@ static int ipoib_upper_walk(struct net_device *upper,
|
|||
}
|
||||
|
||||
/**
|
||||
* Find a net_device matching the given address, which is an upper device of
|
||||
* the given net_device.
|
||||
* ipoib_get_net_dev_match_addr - Find a net_device matching
|
||||
* the given address, which is an upper device of the given net_device.
|
||||
*
|
||||
* @addr: IP address to look for.
|
||||
* @dev: base IPoIB net_device
|
||||
*
|
||||
|
|
|
|||
|
|
@ -761,7 +761,7 @@ void iser_conn_init(struct iser_conn *iser_conn)
|
|||
ib_conn->reg_cqe.done = iser_reg_comp;
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* starts the process of connecting to the target
|
||||
* sleeps until the connection is established or rejected
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -2397,10 +2397,10 @@ isert_accept_np(struct iscsi_np *np, struct iscsi_conn *conn)
|
|||
spin_unlock_bh(&np->np_thread_lock);
|
||||
isert_dbg("np_thread_state %d\n",
|
||||
np->np_thread_state);
|
||||
/**
|
||||
/*
|
||||
* No point in stalling here when np_thread
|
||||
* is in state RESET/SHUTDOWN/EXIT - bail
|
||||
**/
|
||||
*/
|
||||
return -ENODEV;
|
||||
}
|
||||
spin_unlock_bh(&np->np_thread_lock);
|
||||
|
|
|
|||
|
|
@ -915,7 +915,7 @@ static inline void path_it_deinit(struct path_it *it)
|
|||
}
|
||||
|
||||
/**
|
||||
* rtrs_clt_init_req() Initialize an rtrs_clt_io_req holding information
|
||||
* rtrs_clt_init_req() - Initialize an rtrs_clt_io_req holding information
|
||||
* about an inflight IO.
|
||||
* The user buffer holding user control message (not data) is copied into
|
||||
* the corresponding buffer of rtrs_iu (req->iu->buf), which later on will
|
||||
|
|
@ -1221,7 +1221,7 @@ static int rtrs_clt_read_req(struct rtrs_clt_io_req *req)
|
|||
}
|
||||
|
||||
/**
|
||||
* rtrs_clt_failover_req() Try to find an active path for a failed request
|
||||
* rtrs_clt_failover_req() - Try to find an active path for a failed request
|
||||
* @clt: clt context
|
||||
* @fail_req: a failed io request.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1308,7 +1308,7 @@ int rtrs_srv_get_sess_name(struct rtrs_srv *srv, char *sessname, size_t len)
|
|||
EXPORT_SYMBOL(rtrs_srv_get_sess_name);
|
||||
|
||||
/**
|
||||
* rtrs_srv_get_sess_qdepth() - Get rtrs_srv qdepth.
|
||||
* rtrs_srv_get_queue_depth() - Get rtrs_srv qdepth.
|
||||
* @srv: Session
|
||||
*/
|
||||
int rtrs_srv_get_queue_depth(struct rtrs_srv *srv)
|
||||
|
|
|
|||
Loading…
Reference in a new issue