Debian Codegraph @

upstream/debian-trixie/man8/vdpa-dev.8

raw
1 .TH DEVLINK\-DEV 8 "5 Jan 2021" "iproute2" "Linux"
2 .SH NAME
3 vdpa-dev \- vdpa device configuration
4 .SH SYNOPSIS
5 .sp
6 .ad l
7 .in +8
8 .ti -8
9 .B vdpa
10 .B dev
11 .RI "[ " OPTIONS " ] "
12 .RI " { " COMMAND | " "
13 .BR help " }"
14 .sp
15
16 .ti -8
17 .IR OPTIONS " := { "
18 \fB\-V\fR[\fIersion\fR]
19 }
20
21 .ti -8
22 .B vdpa dev show
23 .RI "[ " DEV " ]"
24
25 .ti -8
26 .B vdpa dev help
27
28 .ti -8
29 .B vdpa dev add
30 .B name
31 .I NAME
32 .B mgmtdev
33 .I MGMTDEV
34 .RI "[ device_features " DEVICE_FEATURES " ]"
35 .RI "[ mac " MACADDR " ]"
36 .RI "[ mtu " MTU " ]"
37 .RI "[ max_vqp " MAX_VQ_PAIRS " ]"
38
39 .ti -8
40 .B vdpa dev del
41 .I DEV
42
43 .ti -8
44 .B vdpa dev config show
45 .RI "[ " DEV " ]"
46
47 .ti -8
48 .B vdpa dev vstats show
49 .I DEV
50 .B qidx
51 .I QUEUE_INDEX
52
53 .ti -8
54 .B vdpa dev set
55 .B name
56 .I NAME
57 .B mac
58 .RI "[ " MACADDR " ]"
59
60 .SH "DESCRIPTION"
61 .SS vdpa dev show - display vdpa device attributes
62
63 .PP
64 .I "DEV"
65 - specifies the vdpa device to show.
66 If this argument is omitted all devices are listed.
67
68 .in +4
69 Format is:
70 .in +2
71 VDPA_DEVICE_NAME
72
73 .SS vdpa dev add - add a new vdpa device.
74
75 .TP
76 .BI name " NAME"
77 Name of the new vdpa device to add.
78
79 .TP
80 .BI mgmtdev " MGMTDEV"
81 Name of the management device to use for device addition.
82
83 .PP
84 .BI device_features " DEVICE_FEATURES"
85 Specifies the virtio device features bit-mask that is provisioned for the new vdpa device.
86
87 The bits can be found under include/uapi/linux/virtio*h.
88
89 see macros such as VIRTIO_F_ and VIRTIO_XXX(e.g NET)_F_ for specific bit values.
90
91 This is optional.
92
93 .BI mac " MACADDR"
94 - specifies the mac address for the new vdpa device.
95 This is applicable only for the network type of vdpa device. This is optional.
96
97 .BI mtu " MTU"
98 - specifies the mtu for the new vdpa device.
99 This is applicable only for the network type of vdpa device. This is optional.
100
101 .SS vdpa dev del - Delete the vdpa device.
102
103 .PP
104 .I "DEV"
105 - specifies the vdpa device to delete.
106
107 .SS vdpa dev config show - Show configuration of specific device or all devices.
108
109 .PP
110 .I "DEV"
111 - specifies the vdpa device to show its configuration.
112 If this argument is omitted all devices configuration is listed.
113
114 .in +4
115 Format is:
116 .in +2
117 VDPA_DEVICE_NAME
118
119 .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.
120
121 .TP
122 .BI "DEV"
123 - specifies the vdpa device to query
124
125 .TP
126 .BI qidx " QUEUE_INDEX"
127 - specifies the virtqueue index to query
128
129 .SS vdpa dev set - set the configuration to the vdpa device.
130
131 .BI name " NAME"
132 -Name of the vdpa device to configure.
133
134 .BI mac " MACADDR"
135 - specifies the mac address for the vdpa device.
136 This is applicable only for the network type of vdpa device.
137
138 .SH "EXAMPLES"
139 .PP
140 vdpa dev show
141 .RS 4
142 Shows the all vdpa devices on the system.
143 .RE
144 .PP
145 vdpa dev show foo
146 .RS 4
147 Shows the specified vdpa device.
148 .RE
149 .PP
150 vdpa dev add name foo mgmtdev vdpa_sim_net
151 .RS 4
152 Add the vdpa device named foo on the management device vdpa_sim_net.
153 .RE
154 .PP
155 vdpa dev add name foo mgmtdev vdpa_sim_net device_features 0x300020000
156 .RS 4
157 Add the vdpa device named foo on the management device vdpa_sim_net with device_features of 0x300020000
158 .RE
159 .PP
160 vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55
161 .RS 4
162 Add the vdpa device named foo on the management device vdpa_sim_net with mac address of 00:11:22:33:44:55.
163 .RE
164 .PP
165 vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55 mtu 9000
166 .RS 4
167 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.
168 .RE
169 .PP
170 vdpa dev add name foo mgmtdev auxiliary/mlx5_core.sf.1 mac 00:11:22:33:44:55 max_vqp 8
171 .RS 4
172 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
173 .RE
174 .PP
175 vdpa dev del foo
176 .RS 4
177 Delete the vdpa device named foo which was previously created.
178 .RE
179 .PP
180 vdpa dev config show foo
181 .RS 4
182 Shows the vdpa device configuration of device named foo.
183 .RE
184 .PP
185 vdpa dev vstats show vdpa0 qidx 1
186 .RS 4
187 Shows vendor specific statistics information for vdpa device vdpa0 and virtqueue index 1
188 .RE
189 .PP
190 vdpa dev set name vdpa0 mac 00:11:22:33:44:55
191 .RS 4
192 Set a specific MAC address to vdpa device vdpa0
193 .RE
194
195 .SH SEE ALSO
196 .BR vdpa (8),
197 .BR vdpa-mgmtdev (8),
198 .br
199
200 .SH AUTHOR
201 Parav Pandit <[email protected]>