From patchwork Wed Oct 26 19:46:00 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Miller X-Patchwork-Id: 119167 X-Patchwork-Delegate: maxime.coquelin@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1EE07A04FD; Wed, 26 Oct 2022 21:46:34 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BE667400D5; Wed, 26 Oct 2022 21:46:33 +0200 (CEST) Received: from mail-io1-f42.google.com (mail-io1-f42.google.com [209.85.166.42]) by mails.dpdk.org (Postfix) with ESMTP id 84E2440041 for ; Wed, 26 Oct 2022 21:46:32 +0200 (CEST) Received: by mail-io1-f42.google.com with SMTP id 63so4853042iov.8 for ; Wed, 26 Oct 2022 12:46:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=atomicrules-com.20210112.gappssmtp.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=tgosoLbJ5FHY97DELnVD+/lSJixU9RRd4JIZjT3D4oU=; b=50azMB476BeSJ+GRV3Cs7S3eez63IFytPEVR++h+3rld/WGaCTb8vVxq5DpWReCskc aqO04ys4OZiB9o8/x8vZihPzsY6oTLvHt2m+6zUhSVACQI4J9bzuflCz8RSRtKS/tTEJ i07cL2aXUGg4sp5YHhvRNhBfxbFrKkVEoRxEA7r792RKp/GiZI0VAxH+1tACoQLCSbK2 1+dGxVL2VgnHPl5hPGsVkRdy52tMC1k7lROst+zMSHJpeR4wK3Et1xr6PlHVzPAiaBDa ASax0h3XU1zVOoTmt8v5lVLTEaetPlS9tq2KPkR0tMPXVtOwZzCsgjw/cJ09GpJ1fHC8 aq6g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=tgosoLbJ5FHY97DELnVD+/lSJixU9RRd4JIZjT3D4oU=; b=n22YAszbJUnJ5ueC1685rNCDKgj2NAw8BXkjxgAmWhJTpHB51w+cPzM7GP28Zg0U0y F5JHFPjlYIFot6foxR7uNl/q9XcKfUc+ICJJiwoi4kVjey2bbPELHKJ+NJ050QnoDIgS 9erV+ArxeJmE0Uy7hRKnCsq/Eq37o1NmlKmyocSsNj7MHN35oxZmwleEaJuup9yjnAHI MzER9yV1hfJgVXxpgF1M/2kR5GvLZcKDffdRUZ2fqsoGXxcQoa2z6gYVCPwERzuCxEkl rTr8VF8duapH6POZVb0KVlj8gXa44TO3Gn+HTMJRizIh2eWOw2arq4blJ6UCgTJhV8Ou U4tA== X-Gm-Message-State: ACrzQf19q2n+6lCxv9hgxCRtlUi4kRxzO5O5SBZolYEJ85V/7w/ClJkA Fg9JYoBX9VVB4Cikur3Vmrl0jA== X-Google-Smtp-Source: AMsMyM7UyBCwnEz6GSkPU5lTAFc/UW5oEduN/Gnh04M9VRHP6O3GvaGUhvnpMzTHa/SZPy/vbBqaiw== X-Received: by 2002:a02:a40d:0:b0:375:2ef:c7b3 with SMTP id c13-20020a02a40d000000b0037502efc7b3mr6795331jal.281.1666813591815; Wed, 26 Oct 2022 12:46:31 -0700 (PDT) Received: from john-System-Product-Name.tds (h64-35-205-155.cntcnh.broadband.dynamic.tds.net. [64.35.205.155]) by smtp.googlemail.com with ESMTPSA id m1-20020a056e020de100b002faecf63c48sm2336169ilj.79.2022.10.26.12.46.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 26 Oct 2022 12:46:31 -0700 (PDT) From: John Miller To: nicolas.chautru@intel.com Cc: dev@dpdk.org, ed.czeck@atomicrules.com, shepard.siegel@atomicrules.com, John Miller Subject: [PATCH 01/14] doc/guides/bbdevs: add ark baseband device documentation Date: Wed, 26 Oct 2022 15:46:00 -0400 Message-Id: <20221026194613.1008232-1-john.miller@atomicrules.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 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 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. 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 +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()`. + + +============= + Limitations +============= + +* MBufs for the output data from the operation must be sized exactly + to hold the result based on DATAROOM sizes. +* Side-band or meta data accompaning packet data is limited to 20 Bytes.