Skip to content

Commit c6c0052

Browse files
committed
RDMA/bnxt_re: Fix kernel doc errors
Fix set of the following errors due to use of wrong kernel doc format to describe function parameters: drivers/infiniband/hw/bnxt_re/qplib_rcfw.c:68: warning: Function parameter or member 'rcfw' not described in '__wait_for_resp' Reported-by: kernel test robot <[email protected]> Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Link: https://lore.kernel.org/r/4b22c385f1b68590ace8f82f2985d14b20999432.1692539554.git.leon@kernel.org Signed-off-by: Leon Romanovsky <[email protected]>
1 parent bb6d73d commit c6c0052

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

drivers/infiniband/hw/bnxt_re/qplib_rcfw.c

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ static void bnxt_qplib_service_creq(struct tasklet_struct *t);
5555

5656
/**
5757
* bnxt_qplib_map_rc - map return type based on opcode
58-
* @opcode - roce slow path opcode
58+
* @opcode: roce slow path opcode
5959
*
6060
* case #1
6161
* Firmware initiated error recovery is a safe state machine and
@@ -98,8 +98,8 @@ static int bnxt_qplib_map_rc(u8 opcode)
9898

9999
/**
100100
* bnxt_re_is_fw_stalled - Check firmware health
101-
* @rcfw - rcfw channel instance of rdev
102-
* @cookie - cookie to track the command
101+
* @rcfw: rcfw channel instance of rdev
102+
* @cookie: cookie to track the command
103103
*
104104
* If firmware has not responded any rcfw command within
105105
* rcfw->max_timeout, consider firmware as stalled.
@@ -133,8 +133,8 @@ static int bnxt_re_is_fw_stalled(struct bnxt_qplib_rcfw *rcfw,
133133

134134
/**
135135
* __wait_for_resp - Don't hold the cpu context and wait for response
136-
* @rcfw - rcfw channel instance of rdev
137-
* @cookie - cookie to track the command
136+
* @rcfw: rcfw channel instance of rdev
137+
* @cookie: cookie to track the command
138138
*
139139
* Wait for command completion in sleepable context.
140140
*
@@ -179,8 +179,8 @@ static int __wait_for_resp(struct bnxt_qplib_rcfw *rcfw, u16 cookie)
179179

180180
/**
181181
* __block_for_resp - hold the cpu context and wait for response
182-
* @rcfw - rcfw channel instance of rdev
183-
* @cookie - cookie to track the command
182+
* @rcfw: rcfw channel instance of rdev
183+
* @cookie: cookie to track the command
184184
*
185185
* This function will hold the cpu (non-sleepable context) and
186186
* wait for command completion. Maximum holding interval is 8 second.
@@ -216,8 +216,8 @@ static int __block_for_resp(struct bnxt_qplib_rcfw *rcfw, u16 cookie)
216216
};
217217

218218
/* __send_message_no_waiter - get cookie and post the message.
219-
* @rcfw - rcfw channel instance of rdev
220-
* @msg - qplib message internal
219+
* @rcfw: rcfw channel instance of rdev
220+
* @msg: qplib message internal
221221
*
222222
* This function will just post and don't bother about completion.
223223
* Current design of this function is -
@@ -374,8 +374,8 @@ static int __send_message(struct bnxt_qplib_rcfw *rcfw,
374374

375375
/**
376376
* __poll_for_resp - self poll completion for rcfw command
377-
* @rcfw - rcfw channel instance of rdev
378-
* @cookie - cookie to track the command
377+
* @rcfw: rcfw channel instance of rdev
378+
* @cookie: cookie to track the command
379379
*
380380
* It works same as __wait_for_resp except this function will
381381
* do self polling in sort interval since interrupt is disabled.
@@ -471,8 +471,8 @@ static void __destroy_timedout_ah(struct bnxt_qplib_rcfw *rcfw,
471471
/**
472472
* __bnxt_qplib_rcfw_send_message - qplib interface to send
473473
* and complete rcfw command.
474-
* @rcfw - rcfw channel instance of rdev
475-
* @msg - qplib message internal
474+
* @rcfw: rcfw channel instance of rdev
475+
* @msg: qplib message internal
476476
*
477477
* This function does not account shadow queue depth. It will send
478478
* all the command unconditionally as long as send queue is not full.
@@ -534,8 +534,8 @@ static int __bnxt_qplib_rcfw_send_message(struct bnxt_qplib_rcfw *rcfw,
534534
/**
535535
* bnxt_qplib_rcfw_send_message - qplib interface to send
536536
* and complete rcfw command.
537-
* @rcfw - rcfw channel instance of rdev
538-
* @msg - qplib message internal
537+
* @rcfw: rcfw channel instance of rdev
538+
* @msg: qplib message internal
539539
*
540540
* Driver interact with Firmware through rcfw channel/slow path in two ways.
541541
* a. Blocking rcfw command send. In this path, driver cannot hold

0 commit comments

Comments
 (0)