From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.2 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 28D33C2BB1D for ; Fri, 13 Mar 2020 11:05:20 +0000 (UTC) Received: from dpdk.org (dpdk.org [92.243.14.124]) by mail.kernel.org (Postfix) with ESMTP id C004220724 for ; Fri, 13 Mar 2020 11:05:19 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=accelercomm-com.20150623.gappssmtp.com header.i=@accelercomm-com.20150623.gappssmtp.com header.b="Q6XZel1u" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org C004220724 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=accelercomm.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=dev-bounces@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 131711BFFE; Fri, 13 Mar 2020 12:05:19 +0100 (CET) Received: from mail-wr1-f67.google.com (mail-wr1-f67.google.com [209.85.221.67]) by dpdk.org (Postfix) with ESMTP id 437581C01F for ; Fri, 13 Mar 2020 12:05:18 +0100 (CET) Received: by mail-wr1-f67.google.com with SMTP id v11so11532215wrm.9 for ; Fri, 13 Mar 2020 04:05:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=accelercomm-com.20150623.gappssmtp.com; s=20150623; h=subject:to:references:from:message-id:date:user-agent:mime-version :in-reply-to:content-transfer-encoding:content-language; bh=PM3Q9LBDzwhhPAR/G3JteNhieXNALTjtjK0+lvOe4r4=; b=Q6XZel1uDB5MuFOURrrH3aH9z+ELaTvwszuKFXG80mGGmvdfURh6fYk/KVeYUE4rw6 0ZC6rT3aJl9zlKsXqcpMJeAAJi7zVLkCCnYLSzwOSRwbv8duSWEVUQoqXO6BzHj19D5y bJfC5NQjZ2Xj3QyoqeCgamFOd6M17o/ovo8lQzYt33KaTI9HhyA/lNjolVzRWfD5mGOM 9oJQkwZk/t9aWlJVuY4BkCNhP3jHUNMUkWptYJtPLRtpmrvOKI2WPG9GN8RcdgQOInkW jCd8BCPS2sbXy7TXdR1g1DL+JbMQKSYRSapB+oC8Uo9O87/234i1vLeJiQp0T/7wQpDd R8iw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-transfer-encoding :content-language; bh=PM3Q9LBDzwhhPAR/G3JteNhieXNALTjtjK0+lvOe4r4=; b=V000muXKbgfhVRZsEHQMniAaxyESQSV3w8EV5MB65toMEt2D/NF7PsUPOrz0/i1lqU Q5pMZ3EGMjreJr+n2/T+s9apMYaKjjtIwtiTAtB0VXMIQeJq4IpdwmROn6T0i61weNxg ofdQ7HJLehPekk2Q4P1gtIN0jttNOvGSIsz4D16oVXHgjGejtvXZ6UT6WbdFdwv9t5Hn w3t92ybpq+u2F+MM4q8yk1z9C7PMAvKfel/vm9W4aOTeZocN7S2p1q8QjuhNQd1qUzTu Vzsz+48ehkkS1eEB3SILIO13j82XRwqG6PUQgzmRRYmDx4DGWjC6ws/SlFYEYrV2pcdC mHew== X-Gm-Message-State: ANhLgQ09Tavl7HLfvH6vYoUg3NiLksgatFo5n6DfqJSUObTfK33I3ZUC 7rIBpKr0oJrFvLbaYDt6sSZFsihZ118= X-Google-Smtp-Source: ADFU+vunKX9MzXNGpU1q4uIOW8liY04iHZ3TP7+q81nsvQDc7afW6YbL+Ln5QkSkq/TuBd+0mTo9xA== X-Received: by 2002:a5d:5089:: with SMTP id a9mr17503116wrt.187.1584097517653; Fri, 13 Mar 2020 04:05:17 -0700 (PDT) Received: from [192.168.1.189] ([89.21.231.54]) by smtp.gmail.com with ESMTPSA id v14sm43014906wrr.34.2020.03.13.04.05.17 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 13 Mar 2020 04:05:17 -0700 (PDT) To: dev@dpdk.org References: <1582778348-113547-15-git-send-email-nicolas.chautru@intel.com> <1583348102-13253-1-git-send-email-nicolas.chautru@intel.com> <1583348102-13253-15-git-send-email-nicolas.chautru@intel.com> From: Dave Burley Message-ID: <40ae824b-a2e5-8bd0-c834-48b76aef6aa2@accelercomm.com> Date: Fri, 13 Mar 2020 11:05:16 +0000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.5.0 MIME-Version: 1.0 In-Reply-To: <1583348102-13253-15-git-send-email-nicolas.chautru@intel.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US Subject: Re: [dpdk-dev] [PATCH v3 14/14] doc: add feature matrix table for bbdev devices X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Acked-by: Dave Burley On 04/03/2020 18:55, Nicolas Chautru wrote: > From: Nic Chautru > > Adding missing overview page in documentation with > comparison of feature set by PMD implementation. > > Signed-off-by: Nic Chautru > --- > .gitignore | 1 + > doc/guides/bbdevs/features/default.ini | 16 ++++++++++++++++ > doc/guides/bbdevs/features/fpga_5gnr_fec.ini | 11 +++++++++++ > doc/guides/bbdevs/features/fpga_lte_fec.ini | 10 ++++++++++ > doc/guides/bbdevs/features/mbc.ini | 14 ++++++++++++++ > doc/guides/bbdevs/features/null.ini | 7 +++++++ > doc/guides/bbdevs/features/turbo_sw.ini | 11 +++++++++++ > doc/guides/bbdevs/index.rst | 1 + > doc/guides/bbdevs/overview.rst | 15 +++++++++++++++ > doc/guides/conf.py | 5 +++++ > 10 files changed, 91 insertions(+) > create mode 100644 doc/guides/bbdevs/features/default.ini > create mode 100644 doc/guides/bbdevs/features/fpga_5gnr_fec.ini > create mode 100644 doc/guides/bbdevs/features/fpga_lte_fec.ini > create mode 100644 doc/guides/bbdevs/features/mbc.ini > create mode 100644 doc/guides/bbdevs/features/null.ini > create mode 100644 doc/guides/bbdevs/features/turbo_sw.ini > create mode 100644 doc/guides/bbdevs/overview.rst > > diff --git a/.gitignore b/.gitignore > index 2acb459..f2f8892 100644 > --- a/.gitignore > +++ b/.gitignore > @@ -10,6 +10,7 @@ doc/guides/cryptodevs/overview_aead_table.txt > doc/guides/cryptodevs/overview_asym_table.txt > doc/guides/compressdevs/overview_feature_table.txt > doc/guides/vdpadevs/overview_feature_table.txt > +doc/guides/bbdevs/overview_feature_table.txt > > # ignore generated ctags/cscope files > cscope.out.po > diff --git a/doc/guides/bbdevs/features/default.ini b/doc/guides/bbdevs/features/default.ini > new file mode 100644 > index 0000000..5fe267a > --- /dev/null > +++ b/doc/guides/bbdevs/features/default.ini > @@ -0,0 +1,16 @@ > +; > +; Features of a default bbdev driver. > +; > +; This file defines the features that are valid for inclusion in > +; the other driver files and also the order that they appear in > +; the features table in the documentation. > +; > +[Features] > +Turbo Decoder (4G) = > +Turbo Encoder (4G) = > +LDPC Decoder (5G) = > +LDPC Encoder (5G) = > +LLR/HARQ Compression = > +External DDR Access = > +HW Accelerated = > +BBDEV API = > diff --git a/doc/guides/bbdevs/features/fpga_5gnr_fec.ini b/doc/guides/bbdevs/features/fpga_5gnr_fec.ini > new file mode 100644 > index 0000000..7a0b8d4 > --- /dev/null > +++ b/doc/guides/bbdevs/features/fpga_5gnr_fec.ini > @@ -0,0 +1,11 @@ > +; > +; Supported features of the 'fpga_5ngr_fec' bbdev driver. > +; > +; Refer to default.ini for the full list of available PMD features. > +; > +[Features] > +LDPC Decoder (5G) = Y > +LDPC Encoder (5G) = Y > +External DDR Access = Y > +HW Accelerated = Y > +BBDEV API = Y > diff --git a/doc/guides/bbdevs/features/fpga_lte_fec.ini b/doc/guides/bbdevs/features/fpga_lte_fec.ini > new file mode 100644 > index 0000000..f1cfb92 > --- /dev/null > +++ b/doc/guides/bbdevs/features/fpga_lte_fec.ini > @@ -0,0 +1,10 @@ > +; > +; Supported features of the 'fpga_lte_fec' bbdev driver. > +; > +; Refer to default.ini for the full list of available PMD features. > +; > +[Features] > +Turbo Decoder (4G) = Y > +Turbo Encoder (4G) = Y > +HW Accelerated = Y > +BBDEV API = Y > diff --git a/doc/guides/bbdevs/features/mbc.ini b/doc/guides/bbdevs/features/mbc.ini > new file mode 100644 > index 0000000..78a7b95 > --- /dev/null > +++ b/doc/guides/bbdevs/features/mbc.ini > @@ -0,0 +1,14 @@ > +; > +; Supported features of the 'mbc' bbdev driver. > +; > +; Refer to default.ini for the full list of available PMD features. > +; > +[Features] > +Turbo Decoder (4G) = Y > +Turbo Encoder (4G) = Y > +LDPC Decoder (5G) = Y > +LDPC Encoder (5G) = Y > +LLR/HARQ Compression = Y > +External DDR Access = Y > +HW Accelerated = Y > +BBDEV API = Y > diff --git a/doc/guides/bbdevs/features/null.ini b/doc/guides/bbdevs/features/null.ini > new file mode 100644 > index 0000000..d9bbda9 > --- /dev/null > +++ b/doc/guides/bbdevs/features/null.ini > @@ -0,0 +1,7 @@ > +; > +; Supported features of the 'null' bbdev driver. > +; > +; Refer to default.ini for the full list of available PMD features. > +; > +[Features] > +BBDEV API = Y > diff --git a/doc/guides/bbdevs/features/turbo_sw.ini b/doc/guides/bbdevs/features/turbo_sw.ini > new file mode 100644 > index 0000000..2c7075e > --- /dev/null > +++ b/doc/guides/bbdevs/features/turbo_sw.ini > @@ -0,0 +1,11 @@ > +; > +; Supported features of the 'turbo_sw' bbdev driver. > +; > +; Refer to default.ini for the full list of available PMD features. > +; > +[Features] > +Turbo Decoder (4G) = Y > +Turbo Encoder (4G) = Y > +LDPC Decoder (5G) = Y > +LDPC Encoder (5G) = Y > +BBDEV API = Y > diff --git a/doc/guides/bbdevs/index.rst b/doc/guides/bbdevs/index.rst > index 1a79343..a8092dd 100644 > --- a/doc/guides/bbdevs/index.rst > +++ b/doc/guides/bbdevs/index.rst > @@ -8,6 +8,7 @@ Baseband Device Drivers > :maxdepth: 2 > :numbered: > > + overview > null > turbo_sw > fpga_lte_fec > diff --git a/doc/guides/bbdevs/overview.rst b/doc/guides/bbdevs/overview.rst > new file mode 100644 > index 0000000..ace4e67 > --- /dev/null > +++ b/doc/guides/bbdevs/overview.rst > @@ -0,0 +1,15 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2020 Intel Corporation. > + > +Baseband Device Supported Functionality Matrices > +============================================== > + > +Supported Feature Flags > +----------------------- > + > +.. _table_bbdev_pmd_features: > + > +.. include:: overview_feature_table.txt > + > + > + > diff --git a/doc/guides/conf.py b/doc/guides/conf.py > index c368fa5..d52b584 100644 > --- a/doc/guides/conf.py > +++ b/doc/guides/conf.py > @@ -406,6 +406,11 @@ def setup(app): > 'Features', > 'Features availability in vDPA drivers', > 'Feature') > + table_file = dirname(__file__) + '/bbdevs/overview_feature_table.txt' > + generate_overview_table(table_file, 1, > + 'Features', > + 'Features availability in bbdev drivers', > + 'Feature') > > if LooseVersion(sphinx_version) < LooseVersion('1.3.1'): > print('Upgrade sphinx to version >= 1.3.1 for '