doc/guides/compressdevs/mlx5.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 Mellanox Technologies, Ltd
   3
   4 .. include:: <isonum.txt>
   5
   6 MLX5 compress driver
   7 ====================
   8
   9 The MLX5 compress driver library
  10 (**librte_compress_mlx5**) provides support for **Mellanox BlueField 2**
  11 families of 25/50/100/200 Gb/s adapters.
  12
  13 Design
  14 ------
  15
  16 This PMD is configuring the compress, decompress amd DMA engines.
  17
  18 GGAs (Generic Global Accelerators) are offload engines that can be used
  19 to do memory to memory tasks on data.
  20 These engines are part of the ARM complex of the BlueField chip, and as
  21 such they do not use NIC related resources (e.g. RX/TX bandwidth).
  22 They do share the same PCI and memory bandwidth.
  23
  24 So, using the BlueField device (starting from BlueField 2), the compress
  25 class operations can be supported in parallel to the net, vDPA and
  26 RegEx class operations.
  27
  28 For security reasons and robustness, this driver only deals with virtual
  29 memory addresses. The way resources allocations are handled by the kernel,
  30 combined with hardware specifications that allow to handle virtual memory
  31 addresses directly, ensure that DPDK applications cannot access random
  32 physical memory (or memory that does not belong to the current process).
  33
  34 The PMD uses libibverbs and libmlx5 to access the device firmware
  35 or directly the hardware components.
  36 There are different levels of objects and bypassing abilities
  37 to get the best performances:
  38
  39 - Verbs is a complete high-level generic API.
  40 - Direct Verbs is a device-specific API.
  41 - DevX allows to access firmware objects.
  42
  43 Enabling librte_compress_mlx5 causes DPDK applications to be linked against
  44 libibverbs.
  45
  46 Mellanox mlx5 PCI device can be probed by number of different PCI devices,
  47 for example net / vDPA / RegEx. To select the compress PMD ``class=compress``
  48 should be specified as device parameter. The compress device can be probed and
  49 used with other Mellanox classes, by adding more options in the class.
  50 For example: ``class=net:compress`` will probe both the net PMD and the compress
  51 PMD.
  52
  53 Features
  54 --------
  55
  56 Compress mlx5 PMD has support for:
  57
  58 Compression/Decompression algorithm:
  59
  60 * DEFLATE.
  61
  62 NULL algorithm for DMA operations.
  63
  64 Huffman code type:
  65
  66 * FIXED.
  67 * DYNAMIC.
  68
  69 Window size support:
  70
  71 1KB, 2KB, 4KB, 8KB, 16KB and 32KB.
  72
  73 Shareable transformation.
  74
  75 Checksum generation:
  76
  77 * CRC32, Adler32 and combined checksum.
  78
  79 Limitations
  80 -----------
  81
  82 * Scatter-Gather, SHA and Stateful are not supported.
  83 * Non-compressed block is not supported in compress (supported in decompress).
  84
  85 Supported NICs
  86 --------------
  87
  88 * Mellanox\ |reg| BlueField 2 SmartNIC
  89
  90 Prerequisites
  91 -------------
  92
  93 - Mellanox OFED version: **5.2**
  94   see :doc:`../../nics/mlx5` guide for more Mellanox OFED details.