summaryrefslogtreecommitdiffstats
path: root/man/man8/vdpa-dev.8
blob: 9faf38387e53ec63faf688572a73eeb26bae1652 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
.TH DEVLINK\-DEV 8 "5 Jan 2021" "iproute2" "Linux"
.SH NAME
vdpa-dev \- vdpa device configuration
.SH SYNOPSIS
.sp
.ad l
.in +8
.ti -8
.B vdpa
.B dev
.RI "[ " OPTIONS " ] "
.RI  " { " COMMAND | " "
.BR help " }"
.sp

.ti -8
.IR OPTIONS " := { "
\fB\-V\fR[\fIersion\fR]
}

.ti -8
.B vdpa dev show
.RI "[ " DEV " ]"

.ti -8
.B vdpa dev help

.ti -8
.B vdpa dev add
.B name
.I NAME
.B mgmtdev
.I MGMTDEV
.RI "[ mac " MACADDR " ]"
.RI "[ mtu " MTU " ]"
.RI "[ max_vqp " MAX_VQ_PAIRS " ]"

.ti -8
.B vdpa dev del
.I DEV

.ti -8
.B vdpa dev config show
.RI "[ " DEV " ]"

.ti -8
.B vdpa dev vstats show
.I DEV
.B qidx
.I QUEUE_INDEX


.SH "DESCRIPTION"
.SS vdpa dev show - display vdpa device attributes

.PP
.I "DEV"
- specifies the vdpa device to show.
If this argument is omitted all devices are listed.

.in +4
Format is:
.in +2
VDPA_DEVICE_NAME

.SS vdpa dev add - add a new vdpa device.

.TP
.BI name " NAME"
Name of the new vdpa device to add.

.TP
.BI mgmtdev " MGMTDEV"
Name of the management device to use for device addition.

.PP
.BI mac " MACADDR"
- specifies the mac address for the new vdpa device.
This is applicable only for the network type of vdpa device. This is optional.

.BI mtu " MTU"
- specifies the mtu for the new vdpa device.
This is applicable only for the network type of vdpa device. This is optional.

.SS vdpa dev del - Delete the vdpa device.

.PP
.I "DEV"
- specifies the vdpa device to delete.

.SS vdpa dev config show - Show configuration of specific device or all devices.

.PP
.I "DEV"
- specifies the vdpa device to show its configuration.
If this argument is omitted all devices configuration is listed.

.in +4
Format is:
.in +2
VDPA_DEVICE_NAME

.SS vdpa dev vstats show - shows vendor specific statistics for the given device and virtqueue index. The information is presented as name-value pairs where name is the name of the field and value is a numeric value for it.

.TP
.BI "DEV"
- specifies the vdpa device to query

.TP
.BI qidx " QUEUE_INDEX"
- specifies the virtqueue index to query

.SH "EXAMPLES"
.PP
vdpa dev show
.RS 4
Shows the all vdpa devices on the system.
.RE
.PP
vdpa dev show foo
.RS 4
Shows the specified vdpa device.
.RE
.PP
vdpa dev add name foo mgmtdev vdpa_sim_net
.RS 4
Add the vdpa device named foo on the management device vdpa_sim_net.
.RE
.PP
vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55
.RS 4
Add the vdpa device named foo on the management device vdpa_sim_net with mac address of 00:11:22:33:44:55.
.RE
.PP
vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55 mtu 9000
.RS 4
Add the vdpa device named foo on the management device vdpa_sim_net with mac address of 00:11:22:33:44:55 and mtu of 9000 bytes.
.RE
.PP
vdpa dev add name foo mgmtdev auxiliary/mlx5_core.sf.1 mac 00:11:22:33:44:55 max_vqp 8
.RS 4
Add the vdpa device named foo on the management device auxiliary/mlx5_core.sf.1 with mac address of 00:11:22:33:44:55 and max 8 virtqueue pairs
.RE
.PP
vdpa dev del foo
.RS 4
Delete the vdpa device named foo which was previously created.
.RE
.PP
vdpa dev config show foo
.RS 4
Shows the vdpa device configuration of device named foo.
.RE
.PP
vdpa dev vstats show vdpa0 qidx 1
.RS 4
Shows vendor specific statistics information for vdpa device vdpa0 and virtqueue index 1
.RE

.SH SEE ALSO
.BR vdpa (8),
.BR vdpa-mgmtdev (8),
.br

.SH AUTHOR
Parav Pandit <parav@nvidia.com>