Skip to content

Commit

Permalink
mlx5: Update DEVX man pages to describe the EREMOTEIO return code
Browse files Browse the repository at this point in the history
When a DEVX command is executed by FW and failed, EREMOTEIO is returned
to indicate the caller that the command status and syndrome are
available in the outbox.

Add this info to the DEVX man pages.

Signed-off-by: Aharon Landau <aharonl@nvidia.com>
Reviewed-by: Avihai Horon <avihaih@nvidia.com>
Signed-off-by: Yishai Hadas <yishaih@nvidia.com>
  • Loading branch information
aharonl-nvidia authored and Yishai Hadas committed Mar 31, 2022
1 parent ee7b8e7 commit c1333e7
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions providers/mlx5/man/mlx5dv_devx_create_eq.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ On error NULL will be returned and errno will be set.

Upon success *mlx5dv_devx_destroy_eq* will return 0, on error errno will be returned.

If the error value is EREMOTEIO, outbox.status and outbox.syndrome will contain the command failure details.

# SEE ALSO

*mlx5dv_devx_alloc_msi_vector(3)*, *mlx5dv_devx_query_eqn(3)*
Expand Down
2 changes: 2 additions & 0 deletions providers/mlx5/man/mlx5dv_devx_obj_create.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ mlx5dv_devx_obj* on error NULL will be returned and errno will be set.
Upon success query, modify, destroy, general commands, 0 is returned or the value of errno on a failure.
If the error value is EREMOTEIO, outbox.status and outbox.syndrome will contain the command failure details.
# SEE ALSO
**mlx5dv_open_device**, **mlx5dv_devx_create_cmd_comp**, **mlx5dv_devx_get_async_cmd_comp**
Expand Down
2 changes: 2 additions & 0 deletions providers/mlx5/man/mlx5dv_devx_qp_modify.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ object via DEVX (e.g. mlx5dv_devx_qp_modify).
Upon success 0 is returned or the value of errno on a failure.
If the error value is EREMOTEIO, outbox.status outbox.syndrome will contain the command failure details.
# SEE ALSO
**mlx5dv_open_device**, **mlx5dv_devx_obj_create**
Expand Down

0 comments on commit c1333e7

Please sign in to comment.