xref: /dpdk/doc/guides/compressdevs/nitrox.rst (revision b4ce35947b163435c50f8fe2a7d47ace09078e1e)
1*b4ce3594SNagadheeraj Rottela..  SPDX-License-Identifier: BSD-3-Clause
2*b4ce3594SNagadheeraj Rottela    Copyright(c) 2024 Marvell.
3*b4ce3594SNagadheeraj Rottela
4*b4ce3594SNagadheeraj RottelaMarvell NITROX Compression Poll Mode Driver
5*b4ce3594SNagadheeraj Rottela===========================================
6*b4ce3594SNagadheeraj Rottela
7*b4ce3594SNagadheeraj RottelaThe Nitrox compression poll mode driver provides support for offloading
8*b4ce3594SNagadheeraj Rottelacompression and decompression operations to the NITROX V processor.
9*b4ce3594SNagadheeraj RottelaDetailed information about the NITROX V processor can be obtained here:
10*b4ce3594SNagadheeraj Rottela
11*b4ce3594SNagadheeraj Rottela* https://www.marvell.com/security-solutions/nitrox-security-processors/nitrox-v/
12*b4ce3594SNagadheeraj Rottela
13*b4ce3594SNagadheeraj RottelaFeatures
14*b4ce3594SNagadheeraj Rottela--------
15*b4ce3594SNagadheeraj Rottela
16*b4ce3594SNagadheeraj RottelaNITROX V compression PMD has support for:
17*b4ce3594SNagadheeraj Rottela
18*b4ce3594SNagadheeraj RottelaCompression/Decompression algorithm:
19*b4ce3594SNagadheeraj Rottela
20*b4ce3594SNagadheeraj Rottela* DEFLATE
21*b4ce3594SNagadheeraj Rottela
22*b4ce3594SNagadheeraj RottelaHuffman code type:
23*b4ce3594SNagadheeraj Rottela
24*b4ce3594SNagadheeraj Rottela* FIXED
25*b4ce3594SNagadheeraj Rottela* DYNAMIC
26*b4ce3594SNagadheeraj Rottela
27*b4ce3594SNagadheeraj RottelaWindow size support:
28*b4ce3594SNagadheeraj Rottela
29*b4ce3594SNagadheeraj Rottela* Min - 2 bytes
30*b4ce3594SNagadheeraj Rottela* Max - 32KB
31*b4ce3594SNagadheeraj Rottela
32*b4ce3594SNagadheeraj RottelaChecksum generation:
33*b4ce3594SNagadheeraj Rottela
34*b4ce3594SNagadheeraj Rottela* CRC32, Adler
35*b4ce3594SNagadheeraj Rottela
36*b4ce3594SNagadheeraj RottelaLimitations
37*b4ce3594SNagadheeraj Rottela-----------
38*b4ce3594SNagadheeraj Rottela
39*b4ce3594SNagadheeraj Rottela* Compressdev level 0, no compression, is not supported.
40*b4ce3594SNagadheeraj Rottela
41*b4ce3594SNagadheeraj RottelaInitialization
42*b4ce3594SNagadheeraj Rottela--------------
43*b4ce3594SNagadheeraj Rottela
44*b4ce3594SNagadheeraj RottelaNitrox compression PMD depends on Nitrox kernel PF driver being installed on the platform.
45*b4ce3594SNagadheeraj RottelaNitrox PF driver is required to create VF devices which will be used by the PMD.
46*b4ce3594SNagadheeraj RottelaEach VF device can enable one compressdev PMD.
47*b4ce3594SNagadheeraj Rottela
48*b4ce3594SNagadheeraj RottelaNitrox kernel PF driver is available as part of CNN55XX-Driver SDK.
49*b4ce3594SNagadheeraj RottelaThe SDK and its installation instructions can be obtained from:
50*b4ce3594SNagadheeraj Rottela`Marvell Customer Portal <https://www.marvell.com/support/extranets.html>`_.
51