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