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 See :doc:`../../platform/mlx5` guide for more design details.
  29
  30 Features
  31 --------
  32
  33 Compress mlx5 PMD has support for:
  34
  35 Compression/Decompression algorithm:
  36
  37 * DEFLATE.
  38
  39 NULL algorithm for DMA operations.
  40
  41 Huffman code type:
  42
  43 * FIXED.
  44 * DYNAMIC.
  45
  46 Window size support:
  47
  48 1KB, 2KB, 4KB, 8KB, 16KB and 32KB.
  49
  50 Shareable transformation.
  51
  52 Checksum generation:
  53
  54 * CRC32, Adler32 and combined checksum.
  55
  56 Limitations
  57 -----------
  58
  59 * Scatter-Gather, SHA and Stateful are not supported.
  60 * Non-compressed block is not supported in compress (supported in decompress).
  61
  62 Driver options
  63 --------------
  64
  65 Please refer to :ref:`mlx5 common options <mlx5_common_driver_options>`
  66 for an additional list of options shared with other mlx5 drivers.
  67
  68 - ``log-block-size`` parameter [int]
  69
  70   Log of the Huffman block size in the Deflate algorithm.
  71   Values from [4-15]; value x means block size is 2^x.
  72   The default value is 15.
  73
  74
  75 Supported NICs
  76 --------------
  77
  78 * Mellanox\ |reg| BlueField-2 SmartNIC
  79
  80 Prerequisites
  81 -------------
  82
  83 - Mellanox OFED version: **5.2**
  84   See :ref:`mlx5 common prerequisites <mlx5_linux_prerequisites>` for more details.