Skip to content

Commit 4ab9be9

Browse files
peter-mitsisnashif
authored andcommitted
canbus: isotp: Fix typo in function descriptions
Fixes the return value descriptions for functions isotp_recv() and isotp_recv_net() as they mistakenly referred to ISOTP_WAIT_TIMEOUT instead of ISOTP_RECV_TIMEOUT. Signed-off-by: Peter Mitsis <[email protected]>
1 parent 480b749 commit 4ab9be9

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

include/zephyr/canbus/isotp.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ void isotp_unbind(struct isotp_recv_ctx *ctx);
228228
* @param timeout Timeout for incoming data.
229229
*
230230
* @retval Number of bytes copied on success
231-
* @retval ISOTP_WAIT_TIMEOUT when "timeout" timed out
231+
* @retval ISOTP_RECV_TIMEOUT when "timeout" timed out
232232
* @retval ISOTP_N_* on error
233233
*/
234234
int isotp_recv(struct isotp_recv_ctx *ctx, uint8_t *data, size_t len,
@@ -249,7 +249,7 @@ int isotp_recv(struct isotp_recv_ctx *ctx, uint8_t *data, size_t len,
249249
* @param timeout Timeout for incoming data.
250250
*
251251
* @retval Remaining data length for this transfer if BS > 0, 0 for BS = 0
252-
* @retval ISOTP_WAIT_TIMEOUT when "timeout" timed out
252+
* @retval ISOTP_RECV_TIMEOUT when "timeout" timed out
253253
* @retval ISOTP_N_* on error
254254
*/
255255
int isotp_recv_net(struct isotp_recv_ctx *ctx, struct net_buf **buffer,

0 commit comments

Comments
 (0)