]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - share/man/man4/ena.4
Fix the driver name in ads111x.4, and hook the manpage up to the build.
[FreeBSD/FreeBSD.git] / share / man / man4 / ena.4
1 .\" Copyright (c) 2015-2017 Amazon.com, Inc. or its affiliates.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\"
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\"
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in
13 .\"    the documentation and/or other materials provided with the
14 .\"    distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 .\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 .\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD$
29 .\"
30 .Dd August 16, 2017
31 .Dt ENA 4
32 .Os
33 .Sh NAME
34 .Nm ena
35 .Nd "FreeBSD kernel driver for Elastic Network Adapter (ENA) family"
36 .Sh SYNOPSIS
37 To compile this driver into the kernel,
38 place the following line in the
39 kernel configuration file:
40 .Bd -ragged -offset indent
41 .Cd "device ena"
42 .Ed
43 .Pp
44 Alternatively, to load the driver as a
45 module at boot time, place the following line in
46 .Xr loader.conf 5 :
47 .Bd -literal -offset indent
48 if_ena_load="YES"
49 .Ed
50 .Sh DESCRIPTION
51 The ENA is a networking interface designed to make good use of modern CPU
52 features and system architectures.
53 .Pp
54 The ENA device exposes a lightweight management interface with a
55 minimal set of memory mapped registers and extendable command set
56 through an Admin Queue.
57 .Pp
58 The driver supports a range of ENA devices, is link-speed independent
59 (i.e., the same driver is used for 10GbE, 25GbE, 40GbE, etc.), and has
60 a negotiated and extendable feature set.
61 .Pp
62 Some ENA devices support SR-IOV.
63 This driver is used for both the SR-IOV Physical Function (PF) and Virtual
64 Function (VF) devices.
65 .Pp
66 The ENA devices enable high speed and low overhead network traffic
67 processing by providing multiple Tx/Rx queue pairs (the maximum number
68 is advertised by the device via the Admin Queue), a dedicated MSI-X
69 interrupt vector per Tx/Rx queue pair, and CPU cacheline optimized
70 data placement.
71 .Pp
72 The
73 .Nm
74 driver supports industry standard TCP/IP offload features such
75 as checksum offload and TCP transmit segmentation offload (TSO).
76 Receive-side scaling (RSS) is supported for multi-core scaling.
77 .Pp
78 The
79 .Nm
80 driver and its corresponding devices implement health
81 monitoring mechanisms such as watchdog, enabling the device and driver
82 to recover in a manner transparent to the application, as well as
83 debug logs.
84 .Pp
85 Some of the ENA devices support a working mode called Low-latency
86 Queue (LLQ), which saves several more microseconds.
87 This feature will be implemented for driver in future releases.
88 .Sh HARDWARE
89 Supported PCI vendor ID/device IDs:
90 .Pp
91 .Bl -bullet -compact
92 .It
93 1d0f:0ec2 - ENA PF
94 .It
95 1d0f:1ec2 - ENA PF with LLQ support
96 .It
97 1d0f:ec20 - ENA VF
98 .It
99 1d0f:ec21 - ENA VF with LLQ support
100 .El
101 .Sh DIAGNOSTICS
102 .Ss Device initialization phase:
103 .Bl -diag
104 .It ena%d: failed to init mmio read less
105 .Pp
106 Error occurred during initialization of the mmio register read request.
107 .It ena%d: Can not reset device
108 .Pp
109 Device could not be reset.
110 .br
111 Device may not be responding or is already during reset.
112 .It ena%d: device version is too low
113 .Pp
114 Version of the controller is too old and it is not supported by the driver.
115 .It ena%d: Invalid dma width value %d
116 .Pp
117 The controller is able to request dma transaction width.
118 .br
119 Device stopped responding or it demanded invalid value.
120 .It ena%d: Can not initialize ena admin queue with device
121 .Pp
122 Initialization of the Admin Queue failed.
123 .br
124 Device may not be responding or there was a problem with initialization of
125 the resources.
126 .It ena%d: Cannot get attribute for ena device rc: %d
127 .Pp
128 Failed to get attributes of the device from the controller.
129 .It ena%d: Cannot configure aenq groups rc: %d
130 .Pp
131 Errors occurred when trying to configure AENQ groups.
132 .El
133 .Ss Driver initialisation/shutdown phase:
134 .Bl -diag
135 .It ena%d: PCI resource allocation failed!
136 .It ena%d: allocating ena_dev failed
137 .It ena%d: failed to pmap registers bar
138 .It ena%d: Error while setting up bufring
139 .It ena%d: Error with initialization of IO rings
140 .It ena%d: can not allocate ifnet structure
141 .It ena%d: Error with network interface setup
142 .It ena%d: Failed to enable and set the admin interrupts
143 .It ena%d: Failed to allocate %d, vectors %d
144 .It ena%d: Failed to enable MSIX, vectors %d rc %d
145 .It ena%d: Error with MSI-X enablement
146 .It ena%d: could not allocate irq vector: %d
147 .It ena%d: Unable to allocate bus resource: registers
148 .Pp
149 Resource allocation failed when initializing the device.
150 .br
151 Driver will not be attached.
152 .It ena%d: ENA device init failed (err: %d)
153 .Pp
154 Device initialization failed.
155 .br
156 Driver will not be attached.
157 .It ena%d: could not activate irq vector: %d
158 .Pp
159 Error occurred when trying to activate interrupt vectors for Admin Queue.
160 .It ena%d: failed to register interrupt handler for irq %ju: %d
161 .Pp
162 Error occurred when trying to register Admin Queue interrupt handler.
163 .It ena%d: Cannot setup mgmnt queue intr
164 .Pp
165 Error occurred during configuration of the Admin Queue interrupts.
166 .It ena%d: Enable MSI-X failed
167 .Pp
168 Configuration of the MSI-X for Admin Queue failed.
169 .br
170 There could be lack of resources or interrupts could not have been configured.
171 .br
172 Driver will not be attached.
173 .It ena%d: VLAN is in use, detach first
174 .Pp
175 VLANs are being used when trying to detach the driver.
176 .br
177 VLANs must be detached first and then detach routine have to be called again.
178 .It ena%d: Unmapped RX DMA tag associations
179 .It ena%d: Unmapped TX DMA tag associations
180 .Pp
181 Error occurred when trying to destroy RX/TX DMA tag.
182 .It ena%d: Cannot init RSS
183 .It ena%d: Cannot fill indirect table
184 .It ena%d: Cannot fill indirect table
185 .It ena%d: Cannot fill hash function
186 .It ena%d: Cannot fill hash control
187 .It ena%d: WARNING: RSS was not properly initialized, it will affect bandwidth
188 .Pp
189 Error occurred during initialization of one of RSS resources.
190 .br
191 The device will work with reduced performance because all RX packets will be
192 passed to queue 0 and there will be no hash information.
193 .It ena%d: failed to tear down irq: %d
194 .It ena%d: dev has no parent while releasing res for irq: %d
195 Release of the interrupts failed.
196 .El
197 .Ss Additional diagnostic:
198 .Bl -diag
199 .It ena%d: Cannot get attribute for ena device
200 .Pp
201 This message appears when trying to change MTU and driver is unable to get
202 attributes from the device.
203 .It ena%d: Invalid MTU setting. new_mtu: %d
204 .Pp
205 Requested MTU value is not supported and will not be set.
206 .It ena%d: keep alive watchdog timeout
207 .Pp
208 Device stopped responding and will be reset.
209 .It ena%d: Found a Tx that wasn't completed on time, qid %d, index %d.
210 .Pp
211 Packet was pushed to the NIC but not sent within given time limit.
212 .br
213 It may be caused by hang of the IO queue.
214 .It ena%d: The number of lost tx completion is aboce the threshold (%d > %d). Reset the device
215 .Pp
216 If too many Tx wasn't completed on time the device is going to be reset.
217 .br
218 It may be caused by hanged queue or device.
219 .It ena%d: trigger reset is on
220 .Pp
221 Device will be reset.
222 .br
223 Reset is triggered either by watchdog or if too many TX packets were not
224 completed on time.
225 .It ena%d: invalid value recvd
226 .Pp
227 Link status received from the device in the AENQ handler is invalid.
228 .It ena%d: Allocation for Tx Queue %u failed
229 .It ena%d: Allocation for Rx Queue %u failed
230 .It ena%d: Unable to create Rx DMA map for buffer %d
231 .It ena%d: Failed to create io TX queue #%d rc: %d
232 .It ena%d: Failed to get TX queue handlers. TX queue num %d rc: %d
233 .It ena%d: Failed to create io RX queue[%d] rc: %d
234 .It ena%d: Failed to get RX queue handlers. RX queue num %d rc: %d
235 .It ena%d: failed to request irq
236 .It ena%d: could not allocate irq vector: %d
237 .It ena%d: failed to register interrupt handler for irq %ju: %d
238 .Pp
239 IO resources initialization failed.
240 .br
241 Interface will not be brought up.
242 .It ena%d: LRO[%d] Initialization failed!
243 .Pp
244 Initialization of the LRO for the RX ring failed.
245 .It ena%d: failed to alloc buffer for rx queue
246 .It ena%d: failed to add buffer for rx queue %d
247 .It ena%d: refilled rx queue %d with %d pages only
248 .Pp
249 Allocation of resources used on RX path failed.
250 .br
251 If happened during initialization of the IO queue, the interface will not be
252 brought up.
253 .It ena%d: ioctl promisc/allmulti
254 .Pp
255 IOCTL request for the device to work in promiscuous/allmulti mode.
256 .br
257 See
258 .Xr ifconfig 8
259 for more details.
260 .It ena%d: too many fragments. Last fragment: %d!
261 .Pp
262 Packet with unsupported number of segments was queued for sending to the
263 device.
264 .br
265 Packet will be dropped.
266 .Sh SUPPORT
267 If an issue is identified with the released source code with a supported
268 adapter, please email the specific information related to the issue to
269 .Aq Mt mk@semihalf.com
270 and
271 .Aq Mt mw@semihalf.com .
272 .Sh SEE ALSO
273 .Xr vlan 4 ,
274 .Xr ifconfig 8
275 .Sh AUTHORS
276 The
277 .Nm
278 driver was written by
279 .An Semihalf.