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 4081DA0545; Thu, 15 Dec 2022 15:18:49 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D79DF40685; Thu, 15 Dec 2022 15:18:48 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id 1EADC40684 for ; Thu, 15 Dec 2022 15:18:46 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1671113926; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=4hkuh4sBksbUl4TSUmTi7l8NDrXUGp/cKXX+d1qrzG0=; b=hz0CWFwBvuo98cXj2d6ahDEoJzAl6TOEis51XACfTqZu7q6Ew7cFXvXvRtG5uc8NBTIFJT Kb8oPqgwQ+nhsuoEZrWv9Mh6BDpN7UHRd59ejtyV+pKU1w6lu9E9A1z8z6f6iSat+g57n6 sT/9vs2n0L8pRQ5Ze/yhwW3zFjT5i60= Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-226-7CAcJyuNPbKeqDHC99YUaA-1; Thu, 15 Dec 2022 09:18:43 -0500 X-MC-Unique: 7CAcJyuNPbKeqDHC99YUaA-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 2DB7938149A8; Thu, 15 Dec 2022 14:18:43 +0000 (UTC) Received: from [10.39.208.32] (unknown [10.39.208.32]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 1A4F81121314; Thu, 15 Dec 2022 14:18:41 +0000 (UTC) Message-ID: <6d8eb100-4cb6-7166-4a52-beda7ce2db41@redhat.com> Date: Thu, 15 Dec 2022 15:18:38 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.5.1 To: John Miller , nicolas.chautru@intel.com Cc: dev@dpdk.org, ed.czeck@atomicrules.com, shepard.siegel@atomicrules.com References: <20221026194613.1008232-1-john.miller@atomicrules.com> From: Maxime Coquelin Subject: Re: [PATCH 01/14] doc/guides/bbdevs: add ark baseband device documentation In-Reply-To: <20221026194613.1008232-1-john.miller@atomicrules.com> X-Scanned-By: MIMEDefang 3.1 on 10.11.54.3 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed 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 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 > --- > 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