diff options
| author |   Alexander Lobakin <alobakin@marvell.com> | 2020-07-06 18:38:16 +0300 |
|---|---|---|
| committer |   David S. Miller <davem@davemloft.net> | 2020-07-06 13:18:55 -0700 |
| commit | 71e11a3f5e57ccc4ede64a8bdc578e99e2455c4f (patch) | |
| tree | 48e1b7d9d7e95b732199b01bb7a0c1be23546c84 /drivers/net/ethernet/qlogic/qed/qed_init_fw_funcs.c | |
| parent | net: qed: correct qed_hw_err_notify() prototype (diff) | |
| download | linux-dev-71e11a3f5e57ccc4ede64a8bdc578e99e2455c4f.tar.xz linux-dev-71e11a3f5e57ccc4ede64a8bdc578e99e2455c4f.zip | |
net: qed: address kernel-doc warnings
Get rid of the kernel-doc warnings when building with W=1+ by
rewriting the problematic doc comments according to the
recommended format and style.
Note that this only fixes problems found in C source files,
headers aren't in scope for now.
Signed-off-by: Alexander Lobakin <alobakin@marvell.com>
Signed-off-by: Igor Russkikh <irusskikh@marvell.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'drivers/net/ethernet/qlogic/qed/qed_init_fw_funcs.c')
| -rw-r--r-- | drivers/net/ethernet/qlogic/qed/qed_init_fw_funcs.c | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/drivers/net/ethernet/qlogic/qed/qed_init_fw_funcs.c b/drivers/net/ethernet/qlogic/qed/qed_init_fw_funcs.c index 1eb48ea80484..2ce1f5180231 100644 --- a/drivers/net/ethernet/qlogic/qed/qed_init_fw_funcs.c +++ b/drivers/net/ethernet/qlogic/qed/qed_init_fw_funcs.c @@ -996,14 +996,17 @@ bool qed_send_qm_stop_cmd(struct qed_hwfn *p_hwfn, } while (0) /** - * @brief qed_dmae_to_grc - is an internal function - writes from host to - * wide-bus registers (split registers are not supported yet) + * qed_dmae_to_grc() - Internal function for writing from host to + * wide-bus registers (split registers are not supported yet). * - * @param p_hwfn - HW device data - * @param p_ptt - ptt window used for writing the registers. - * @param p_data - pointer to source data. - * @param addr - Destination register address. - * @param len_in_dwords - data length in DWARDS (u32) + * @p_hwfn: HW device data. + * @p_ptt: PTT window used for writing the registers. + * @p_data: Pointer to source data. + * @addr: Destination register address. + * @len_in_dwords: Data length in dwords (u32). + * + * Return: Length of the written data in dwords (u32) or -1 on invalid + * input. */ static int qed_dmae_to_grc(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt, |