Lines Matching +full:out +full:- +full:of +full:- +full:reset

1 .\" SPDX-License-Identifier: BSD-2-Clause
3 .\" Copyright (c) 2015-2024 Amazon.com, Inc. or its affiliates.
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
14 .\"    notice, this list of conditions and the following disclaimer in
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 .\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 .Bd -ragged -offset indent
47 .Bd -literal -offset indent
51 The ENA is a networking interface designed to make good use of modern CPU
55 minimal set of memory mapped registers and extendable command set
58 The driver supports a range of ENA devices, is link-speed independent
62 Some ENA devices support SR-IOV.
63 This driver is used for both the SR-IOV Physical Function (PF) and Virtual
68 is advertised by the device via the Admin Queue), a dedicated MSI-X
74 The order of those bindings is based on the RSS bucket mapping.
77 Receive-side scaling (RSS) is supported for multi-core scaling.
86 Some of the ENA devices support a working mode called Low-latency
100 .Bl -bullet -compact
102 1d0f:0ec2 - ENA PF
104 1d0f:1ec2 - ENA PF with LLQ support
106 1d0f:ec20 - ENA VF
108 1d0f:ec21 - ENA VF with LLQ support
113 driver's behavior can be changed using run-time or boot-time sysctl
115 The boot-time arguments can be set at the
119 The run-time arguments can be set using the
123 Boot-time tunables:
124 .Bl -tag -width indent
134 This can further lead to OS instability, together with ENA driver reset and NVMe
143 In some cases, the packet header can be bigger than this (for example -
151 Increasing LLQ header size reduces the size of the Tx queue by half, so it may
152 affect the number of dropped Tx packets.
155 Run-time tunables:
156 .Bl -tag -width indent
158 Controls extra logging verbosity of the driver.
160 The higher the logging level, the more logs will be printed out. 0 means all
161 extra logs are disabled and only error logs will be printed out.
167 .Bl -bullet -compact
169 0 - ENA_ERR  - Enable driver error messages and ena_com error logs.
171 1 - ENA_WARN - Enable logs for non-critical errors.
173 2 - ENA_INFO - Make the driver more verbose about its actions.
175 3 - ENA_DBG  - Enable debug logs.
183 .Bd -literal -offset indent
187 Number of the currently allocated and used IO queues.
189 Controls the number of IO queue pairs (Tx/Rx). As this call has to reallocate
190 the queues, it will reset the interface and restart all the queues - this means
196 In that situation, the driver will try to revert the previous number of the IO
198 If this also fails, the device reset will be triggered.
203 .Bd -literal -offset indent
207 Size of the Rx queue.
209 Controls the number of IO descriptors for each Rx queue.
210 The user may want to increase the Rx queue size if they observe a high number of
212 For performance reasons, the Rx queue size must be a power of 2.
216 In that situation, the driver will try to revert to the previous number of the
218 If this also fails, the device reset will be triggered.
223 .Bd -literal -offset indent
227 Size of the Tx buffer ring (drbr).
229 Input must be a power of 2.
230 Controls the number of mbufs that can be held in the Tx buffer ring.
231 The drbr is used as a multiple-producer, single-consumer lockless ring for
234 Increasing the size of the buffer ring may reduce the number of Tx packets being
235 dropped in case of a big Tx burst, which cannot be handled by the IO queue
243 In that situation, the driver will try to revert to the previous number of the
244 drbr and trigger the device reset.
249 .Bd -literal -offset indent
270 .Bd -literal -offset indent
276 Returns the number of entries in the RSS indirection table.
280 .Bd -literal -offset indent
285 The default is x:y key-pairs of indir_table_size length.
286 Updates selected indices of the RSS indirection table.
288 The entry string consists of one or more x:y keypairs, where x stands for
298 .Bd -literal -offset indent
322 .Bd -literal -offset indent
328 .Bl -diag
331 Error occurred during initialization of the mmio register read request.
332 .It ena%d: Can not reset device
334 Device could not be reset.
336 Device may not be responding or is already during reset.
339 Version of the controller is too old and it is not supported by the driver.
347 Initialization of the Admin Queue failed.
349 Device may not be responding or there was a problem with initialization of
353 Failed to get attributes of the device from the controller.
359 .Bl -diag
365 .It ena%d: Error, MSI-X is already enabled
367 .It ena%d: Not enough number of MSI-X allocated: %d
368 .It ena%d: Error with MSI-X enablement
387 Error occurred during configuration of the Admin Queue interrupts.
388 .It ena%d: Enable MSI-X failed
390 Configuration of the MSI-X for Admin Queue failed.
392 There could be lack of resources or interrupts could not have been configured.
410 Error occurred during initialization of one of RSS resources.
418 Error occurred during Low-latency Queue mode setup.
426 Release of the interrupts failed.
429 .Bl -diag
439 Device stopped responding and will be reset.
444 It may be caused by hang of the IO queue.
445 .It ena%d: The number of lost tx completion is above the threshold (%d > %d). Reset the device
447 If too many Tx weren't completed on time the device is going to be reset.
450 .It ena%d: Trigger reset is on
452 Device will be reset.
454 Reset is triggered either by watchdog or if too many TX packets were not
456 .It ena%d: device reset scheduled but trigger_reset is off
458 Reset task has been triggered, but the driver did not request it.
460 Device reset will not be performed.
461 .It ena%d: Device reset failed
463 Error occurred while trying to reset the device.
467 .It ena%d: Validation of device parameters failed
468 .It ena%d: Enable MSI-X failed
470 .It ena%d: Reset attempt failed. Can not reset the device
472 Error occurred while trying to restore the device after reset.
473 .It ena%d: Device reset completed successfully, Driver info: %s
475 Device has been correctly restored after reset and is ready to use.
491 Initialization of the LRO for the RX ring failed.
496 Allocation of resources used on RX path failed.
498 If happened during initialization of the IO queue, the interface will not be