From: Maxime Coquelin <maxime.coquelin@redhat.com>
To: John Miller <john.miller@atomicrules.com>, nicolas.chautru@intel.com
Cc: dev@dpdk.org, ed.czeck@atomicrules.com, shepard.siegel@atomicrules.com
Subject: Re: [PATCH 01/14] doc/guides/bbdevs: add ark baseband device documentation
Date: Thu, 15 Dec 2022 15:18:38 +0100 [thread overview]
Message-ID: <6d8eb100-4cb6-7166-4a52-beda7ce2db41@redhat.com> (raw)
In-Reply-To: <20221026194613.1008232-1-john.miller@atomicrules.com>
Hi John,
On 10/26/22 21:46, John Miller wrote:
> Add new ark baseband device documentation.
>
> This is the first patch in the series that introduces
> the Arkville baseband PMD.
>
> First we create a common/ark directory and move common files
> from net/ark to share with the new baseband/ark device.
>
> Next we create baseband/ark and introduce the Arkville baseband PMD,
> including documentation.
>
> Finally we modify the build system to support the changes.
>
For next revision, please add cover letter. Above information should be
part of it. For this patch, the commit message should mention it is
about the documentation.
> Signed-off-by: John Miller <john.miller@atomicrules.com>
> ---
> doc/guides/bbdevs/ark.rst | 52 +++++++++++++++++++++++++++++++++++++++
> 1 file changed, 52 insertions(+)
> create mode 100644 doc/guides/bbdevs/ark.rst
>
> diff --git a/doc/guides/bbdevs/ark.rst b/doc/guides/bbdevs/ark.rst
> new file mode 100644
> index 0000000000..09afcb0f31
> --- /dev/null
> +++ b/doc/guides/bbdevs/ark.rst
> @@ -0,0 +1,52 @@
> +.. SPDX-License-Identifier: BSD-3-Clause
> + Copyright (c) 2015-2022 Atomic Rules LLC
> +
> +=============================================
> + Atomic Rules LLC, Baseband Poll Mode Driver
> +=============================================
> +
> +The Atomic Rules, Arkville Baseband poll model driver supports the data
s/model/mode/
> +movement portion of a baseband device implemented within an FPGA.
> +The specifics of the encode or decode functions within the FPGA are
> +outside the scope of Arkville's data movement. Hence this PMD requires and
> +provides for the customization needed to advertise its
> +features and support for out-of-band (or meta data) to accompany packet
> +data between the FPGA device and the host software.
> +
> +
> +==========
> + Features
> +==========
> +
> +* Support for LDPC encode and decode operations.
> +* Support for Turbo encode and decode operations.
> +* Support for scatter/gather.
> +* Support Mbuf data room sizes up to 32K bytes for improved performance.
> +* Support for up to 64 queues
> +* Support for runtime switching of Mbuf size, per queue, for improved perormance.
> +* Support for PCIe Gen3x16, Gen4x16, and Gen5x8 endpoints.
> +
> +
> +=================================
> + Required Customization Functions
> +=================================
> +
> +The following customization functions are required:
> + * Set the capabilities structure for the device `ark_bbdev_info_get()`
> + * An optional device start function `rte_pmd_ark_bbdev_start()`
> + * An optional device stop function `rte_pmd_ark_bbdev_stop()`
> + * Functions for defining meta data format shared between
> + the host and FPGA.
> + `rte_pmd_ark_bbdev_enqueue_ldpc_dec()`,
> + `rte_pmd_ark_bbdev_dequeue_ldpc_dec()`,
> + `rte_pmd_ark_bbdev_enqueue_ldpc_enc()`,
> + `rte_pmd_ark_bbdev_dequeue_ldpc_enc()`.
We tend to avoid driver-specific APIs, as it means applications can no
more be generic.
> +
> +
> +=============
> + Limitations
> +=============
> +
> +* MBufs for the output data from the operation must be sized exactly
> + to hold the result based on DATAROOM sizes.
Is that enforced by the driver?
> +* Side-band or meta data accompaning packet data is limited to 20 Bytes.
s/accompaning/accompanying/
Thanks,
Maxime
prev parent reply other threads:[~2022-12-15 14:18 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-26 19:46 John Miller
2022-10-26 19:46 ` [PATCH 02/14] common/ark: create common subdirectory for baseband support John Miller
2022-10-26 19:46 ` [PATCH 03/14] common/ark: move common files to common subdirectory John Miller
2022-10-26 19:46 ` [PATCH 04/14] common/meson.build: John Miller
2022-10-26 19:46 ` [PATCH 05/14] net/ark: remove build files moved to common John Miller
2022-10-26 19:46 ` [PATCH 06/14] common/ark: update version map file John Miller
2022-10-26 19:46 ` [PATCH 07/14] common/ark: avoid exporting internal functions John Miller
2022-10-26 19:46 ` [PATCH 08/14] net/ark: add ark PMD log interface John Miller
2022-10-26 19:46 ` [PATCH 09/14] common/ark: add VF support to caps record John Miller
2022-10-26 19:46 ` [PATCH 10/14] baseband/ark: introduce ark baseband driver John Miller
2022-10-26 23:11 ` Chautru, Nicolas
2022-10-31 17:33 ` John Miller
2022-10-31 21:15 ` Chautru, Nicolas
2022-10-26 19:46 ` [PATCH 11/14] baseband/ark: introduce ark baseband driver custom functions John Miller
2022-10-26 23:22 ` Chautru, Nicolas
2022-11-04 11:35 ` John Miller
2022-10-26 19:46 ` [PATCH 12/14] baseband/ark: introduce ark baseband driver common functions John Miller
2022-10-26 19:46 ` [PATCH 13/14] baseband/ark: introduce ark baseband build files John Miller
2022-10-26 19:46 ` [PATCH 14/14] baseband/meson.build: John Miller
2022-12-15 14:18 ` Maxime Coquelin [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6d8eb100-4cb6-7166-4a52-beda7ce2db41@redhat.com \
--to=maxime.coquelin@redhat.com \
--cc=dev@dpdk.org \
--cc=ed.czeck@atomicrules.com \
--cc=john.miller@atomicrules.com \
--cc=nicolas.chautru@intel.com \
--cc=shepard.siegel@atomicrules.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).