From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 95C9945A5F; Sun, 29 Sep 2024 21:42:00 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 662F640273; Sun, 29 Sep 2024 21:42:00 +0200 (CEST) Received: from mail-pf1-f172.google.com (mail-pf1-f172.google.com [209.85.210.172]) by mails.dpdk.org (Postfix) with ESMTP id 834D3400D5 for ; Sun, 29 Sep 2024 21:41:59 +0200 (CEST) Received: by mail-pf1-f172.google.com with SMTP id d2e1a72fcca58-71b20ffd809so2565652b3a.0 for ; Sun, 29 Sep 2024 12:41:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1727638918; x=1728243718; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:subject:cc:to:from:date:from:to:cc:subject:date :message-id:reply-to; bh=30xQcXTbRRFgdZ1ANZVNolndJO0icoDDqMqqNhqVJmQ=; b=Wmo5sIeQaHQ2T48yF2Ek5fXB/mPosF9tPSZXgL2jolT52WQq7eAFMF9fPUg0YLsf5z 1797dBTDnziAjhqMCgonflCi4yrCvSxcXiQ4kfC7f4NDLYbxjlswRspAR6jjYTodgrUg IH7waXV+GHuEQCKE0YoKsARMur83I2FgE6km2liABPIu/LiFXUAGQukMWqkYgPz4s0Xb MRStDUyIFLZkuQI9BiPk0Mnfi2z3SxKN358jAvb4jEfEpi6E98RH6PYMjCcB541IRxNi l76G8ZIaQ6v5zoaT7q+MkqesE2FfIbKr+eafdrM3D22Pw0wDXLM0kfynvZ7Nb/21axat HOeg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1727638918; x=1728243718; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:subject:cc:to:from:date:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=30xQcXTbRRFgdZ1ANZVNolndJO0icoDDqMqqNhqVJmQ=; b=tjk07zrz5HCGpCq62a+sQhLVcIL5bm/akh9jwhq/QHW/0/mwPjnNO4vdlEo0zCrFq7 zii7cZPcSSTzb/upxtCej22ERJUtGoaHKAqAElhB+7Ur3FV4ayAwu3lF2Nfvu6iqPSOT 1icYkLeficWO9PR9u9oqdy1AyM7nrC5BmYgamMhOtt1uF/sqLAq0bV4tpRQ4g2tm5RSq bURFMmyt0j4eTzyt1/jktwmiOZrU8q5f/xEqlb99jTom7Cb2Ju9GWkuTBH56pjWYoUpw fZA0zH4x9Fx9UObvcCcL71hXEYjxIwU6GqZNLxVzSyoV+65F0edmpsJp0JqBIi+727X8 sOpw== X-Gm-Message-State: AOJu0YxN1n7J1PqHVZCJStHpl6PpZle3V1AOhQnS09/cIUf7B6exvACR oqQ9cQ2YDaJVjr5wiJqZghzFNStaME5r9rgEGtYA6zMswX0rHrBol0oAl/fiMrf6x+UBE5tnv7l RiKs= X-Google-Smtp-Source: AGHT+IFFTrDs7ekKgVV1iueIoqkJbu6Q9nz15MZWsJdf5l30Gcr7jixHkgnOiW41CsKjvp+1KwymMA== X-Received: by 2002:a05:6a00:be8:b0:71c:6f23:2afb with SMTP id d2e1a72fcca58-71c6f232cc9mr4787155b3a.8.1727638918299; Sun, 29 Sep 2024 12:41:58 -0700 (PDT) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-71b2649b08csm5077561b3a.11.2024.09.29.12.41.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 29 Sep 2024 12:41:57 -0700 (PDT) Date: Sun, 29 Sep 2024 12:41:55 -0700 From: Stephen Hemminger To: Hanxiao Li Cc: dev@dpdk.org, wang.yong19@zte.com.cn Subject: Re: [PATCH v8 8/8] doc/guides: add documents and release notes for two drivers Message-ID: <20240929124155.23edfd24@hermes.local> In-Reply-To: <20240929150512.845745-7-li.hanxiao@zte.com.cn> References: <20240929145842.845390-2-li.hanxiao@zte.com.cn> <20240929150512.845745-1-li.hanxiao@zte.com.cn> <20240929150512.845745-7-li.hanxiao@zte.com.cn> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Sun, 29 Sep 2024 23:05:05 +0800 Hanxiao Li wrote: > This patch adds documents and release notes > about compressdev and cryptodev. > > Signed-off-by: Hanxiao Li > --- > doc/guides/compressdevs/features/zsda.ini | 15 ++ > doc/guides/compressdevs/index.rst | 1 + > doc/guides/compressdevs/zsda.rst | 45 ++++ > doc/guides/cryptodevs/features/zsda.ini | 51 +++++ > doc/guides/cryptodevs/index.rst | 1 + > doc/guides/cryptodevs/zsda.rst | 260 ++++++++++++++++++++++ > doc/guides/rel_notes/release_24_11.rst | 8 + > 7 files changed, 381 insertions(+) > create mode 100644 doc/guides/compressdevs/features/zsda.ini > create mode 100644 doc/guides/compressdevs/zsda.rst > create mode 100644 doc/guides/cryptodevs/features/zsda.ini > create mode 100644 doc/guides/cryptodevs/zsda.rst > > diff --git a/doc/guides/compressdevs/features/zsda.ini b/doc/guides/compressdevs/features/zsda.ini > new file mode 100644 > index 0000000000..3b087ea7f9 > --- /dev/null > +++ b/doc/guides/compressdevs/features/zsda.ini > @@ -0,0 +1,15 @@ > +; > +; Refer to default.ini for the full list of available PMD features. > +; > +; Supported features of 'ZSDA' compression driver. > +; > +[Features] > +HW Accelerated = Y > +OOP SGL In SGL Out = Y > +OOP SGL In LB Out = Y > +OOP LB In SGL Out = Y > +Deflate = Y > +Adler32 = Y > +Crc32 = Y > +Fixed = Y > +Dynamic = Y > diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst > index 87ed4f72a4..bab226ffbc 100644 > --- a/doc/guides/compressdevs/index.rst > +++ b/doc/guides/compressdevs/index.rst > @@ -17,3 +17,4 @@ Compression Device Drivers > qat_comp > uadk > zlib > + zsda > diff --git a/doc/guides/compressdevs/zsda.rst b/doc/guides/compressdevs/zsda.rst > new file mode 100644 > index 0000000000..2d0737e4ba > --- /dev/null > +++ b/doc/guides/compressdevs/zsda.rst > @@ -0,0 +1,45 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2024 ZTE Corporation. > + > +ZTE Storage Data Accelerator (ZSDA) Poll Mode Driver > +======================================================= > + > +The ZSDA compression PMD provides poll mode compression & decompression driver > +support for the following hardware accelerator devices: > + > +* ``ZTE Processing accelerators 1cf2`` > + > + > +Features > +-------- > + > +ZSDA compression PMD has support for: > + > +Compression/Decompression algorithm: > + > + * DEFLATE - using Fixed and Dynamic Huffman encoding > + > +Checksum generation: > + > + * CRC32, Adler32 > + > +Huffman code type: > + > +* FIXED > +* DYNAMIC > + > + > +Limitations > +----------- > + > +* Compressdev level 0, no compression, is not supported. > +* No BSD support as BSD ZSDA kernel driver not available. > +* Stateful is not supported. > + > + > +Installation > +------------ > + > +The ZSDA compression PMD is built by default with a standard DPDK build. > + > +It depends on a ZSDA kernel driver, see :ref:`building_zsda`. > \ No newline at end of file Fix you editor settings, all files in git should end with a newline. Did you build the docs after this? Build is failing here. If you add a new feature it needs to be in default.ini as well. FAILED: doc/guides/html /usr/bin/python3 ../buildtools/call-sphinx-build.py /usr/bin/sphinx-build 24.11.0-rc0 /home/runner/work/dpdk/dpdk/doc/guides /home/runner/work/dpdk/dpdk/build/doc/guides -a -W Warning generate_overview_table(): Unknown feature 'SM4 XTS' in 'zsda.ini' Exception occurred: