| mlx5io.4 (331586) | mlx5io.4 (347840) |
|---|---|
| 1.\" 2.\" Copyright (c) 2018 Mellanox Technologies 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright --- 9 unchanged lines hidden (view full) --- 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" | 1.\" 2.\" Copyright (c) 2018 Mellanox Technologies 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright --- 9 unchanged lines hidden (view full) --- 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" |
| 26.\" $FreeBSD: stable/11/share/man/man4/mlx5io.4 331586 2018-03-26 20:59:26Z hselasky $ | 26.\" $FreeBSD: stable/11/share/man/man4/mlx5io.4 347840 2019-05-16 17:50:15Z hselasky $ |
| 27.\" | 27.\" |
| 28.Dd February 20, 2018 | 28.Dd May 7, 2019 |
| 29.Dt mlx5io 4 30.Os 31.Sh NAME 32.Nm mlx5io 33.Nd IOCTL interface to manage Connect-X 4/5 Mellanox network adapters 34.Sh SYNOPSIS 35.In dev/mlx5/mlx5io.h 36.Sh DESCRIPTION --- 13 unchanged lines hidden (view full) --- 50.It Dv MLX5_FWDUMP_FORCE 51Take the snapshot of the firmware registers state and store it in the 52kernel buffer. 53The buffer must be empty, in other words, no dumps should be written so 54far, or existing dump cleared with the 55.Dv MLX5_FWDUMP_RESET 56command for the specified device. 57The argument for the command should point to the | 29.Dt mlx5io 4 30.Os 31.Sh NAME 32.Nm mlx5io 33.Nd IOCTL interface to manage Connect-X 4/5 Mellanox network adapters 34.Sh SYNOPSIS 35.In dev/mlx5/mlx5io.h 36.Sh DESCRIPTION --- 13 unchanged lines hidden (view full) --- 50.It Dv MLX5_FWDUMP_FORCE 51Take the snapshot of the firmware registers state and store it in the 52kernel buffer. 53The buffer must be empty, in other words, no dumps should be written so 54far, or existing dump cleared with the 55.Dv MLX5_FWDUMP_RESET 56command for the specified device. 57The argument for the command should point to the |
| 58.Vt struct mlx5_fwdump_addr | 58.Vt struct mlx5_tool_addr |
| 59structure, containing the PCIe bus address of the device. 60.Bd -literal | 59structure, containing the PCIe bus address of the device. 60.Bd -literal |
| 61struct mlx5_fwdump_addr { | 61struct mlx5_tool_addr { |
| 62 uint32_t domain; 63 uint8_t bus; 64 uint8_t slot; 65 uint8_t func; 66}; 67.Ed 68.It Dv MLX5_FWDUMP_RESET 69Clear the stored firmware dump, preparing the kernel buffer for 70the next dump. 71The argument for the command should point to the | 62 uint32_t domain; 63 uint8_t bus; 64 uint8_t slot; 65 uint8_t func; 66}; 67.Ed 68.It Dv MLX5_FWDUMP_RESET 69Clear the stored firmware dump, preparing the kernel buffer for 70the next dump. 71The argument for the command should point to the |
| 72.Vt struct mlx5_fwdump_addr | 72.Vt struct mlx5_tool_addr |
| 73structure, containing the PCIe bus address of the device. 74.It Dv MLX5_FWDUMP_GET 75Fetch the stored firmware dump into the user memory. 76The argument to the command should point to the input/output 77.Vt struct mlx5_fwdump_get 78structure. 79Its 80.Dv devaddr 81field specifies the address of the device, the 82.Dv buf 83fields points to the array of 84.Vt struct mlx5_fwdump_reg 85of records of the registers values, the size of the array is specified 86in the 87.Dv reg_cnt 88field. 89.Bd -literal 90struct mlx5_fwdump_get { | 73structure, containing the PCIe bus address of the device. 74.It Dv MLX5_FWDUMP_GET 75Fetch the stored firmware dump into the user memory. 76The argument to the command should point to the input/output 77.Vt struct mlx5_fwdump_get 78structure. 79Its 80.Dv devaddr 81field specifies the address of the device, the 82.Dv buf 83fields points to the array of 84.Vt struct mlx5_fwdump_reg 85of records of the registers values, the size of the array is specified 86in the 87.Dv reg_cnt 88field. 89.Bd -literal 90struct mlx5_fwdump_get { |
| 91 struct mlx5_fwdump_addr devaddr; | 91 struct mlx5_tool_addr devaddr; |
| 92 struct mlx5_fwdump_reg *buf; 93 size_t reg_cnt; 94 size_t reg_filled; /* out */ 95}; 96.Ed 97.Pp 98On successfull return, the 99.Dv reg_filled --- 43 unchanged lines hidden --- | 92 struct mlx5_fwdump_reg *buf; 93 size_t reg_cnt; 94 size_t reg_filled; /* out */ 95}; 96.Ed 97.Pp 98On successfull return, the 99.Dv reg_filled --- 43 unchanged lines hidden --- |