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 314C7A0093; Thu, 21 Apr 2022 17:19:17 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1658540042; Thu, 21 Apr 2022 17:19:17 +0200 (CEST) Received: from mail-pj1-f47.google.com (mail-pj1-f47.google.com [209.85.216.47]) by mails.dpdk.org (Postfix) with ESMTP id 89DD540040 for ; Thu, 21 Apr 2022 17:19:15 +0200 (CEST) Received: by mail-pj1-f47.google.com with SMTP id iq10so1480381pjb.0 for ; Thu, 21 Apr 2022 08:19:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=atomicrules-com.20210112.gappssmtp.com; s=20210112; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=tOfWBoGYQViA5qxmeXcQf35nZjidBxeHHHKv2CM0q4o=; b=Yx+6/HbvvLCjs1gt4rVZn9VwfMRdC0/PzRmz1uhXufTs0Nvd8JOMteKg6dO4BnTPSC bpVqOPwDiwO4K2feN/5GFoqlIvGo5Pz1kqMPGKTSxNHgDxaKdgXrwk3mU7nnmNFXPx2z jkz8uLJIt6mE8BkW2bYDXXDSHaRUsmKzHN/ZxlpoOyD8uDsJoXyh13EoY5xpGjU1UOnj ZmNE83/HLGkIFLUZeHOYChen7PY00iDsnmFEWOlafbnlWVh8VF5A3F6JJWzbmF/BvBDT hflCqMzODRZn/CsftyaP35Cv2BZ9npqF8YSRBRjoudobrACM1szDfVZhPz5NqXz2i0BS sMjg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=tOfWBoGYQViA5qxmeXcQf35nZjidBxeHHHKv2CM0q4o=; b=sr7rJvGnC96VjKOfgXyDDLNhHGzTKfrXKhF69APuI9ciDh8iPfhORdCZYYXLPk8eKg el28GNe34xEg7stmuZvLbB1q4DumBVtzyjUJBJkPyqVYv0JVb27hjcKMoK+IdnqOrSay EFdw8LyUlowJPj83Tbsy3wxeJ6XHGczGi+rTzy8Mc0AHOrKUHsZsuI337n+o0CzR7hJT atjBBUQXJogO4fg0BKDJxzVefKZfkJ7FpnBSV8P3Kp6h1S3TponOgazWzdnDjdUAGtqQ q+4aNnkSrK9nKHfYFyGWoKK87t+x+9ShoUg6GBJzOL2RvuuqkvB3YS78WCLaTE2FIw15 dwPw== X-Gm-Message-State: AOAM531VDPgtAqaZsiYm3VXi/kUhDsoV/ijoqGbOV8JL8BI2gjHbaiqk voJwCIDOPjxcw4A+UOAEgomLNV8E9U5oqA== X-Google-Smtp-Source: ABdhPJwN6Gqee1dAfGRZYVo6HCb9Z6le/jGzEuvZ8wm6GUpHCDMHsXrPk5XK9v6WulA0r+eK3VzkOA== X-Received: by 2002:a17:902:aa4b:b0:15a:44e6:4efb with SMTP id c11-20020a170902aa4b00b0015a44e64efbmr59046plr.64.1650554354500; Thu, 21 Apr 2022 08:19:14 -0700 (PDT) Received: from john-All-Series.tds (h75-100-85-216.cntcnh.broadband.dynamic.tds.net. [75.100.85.216]) by smtp.gmail.com with ESMTPSA id q5-20020a056a00084500b0050ace4a699dsm6463465pfk.95.2022.04.21.08.19.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Apr 2022 08:19:14 -0700 (PDT) From: John Miller To: dev@dpdk.org Cc: ferruh.yigit@xilinx.com, ed.czeck@atomicrules.com, John Miller Subject: [PATCH 01/10] doc/guides/bbdevs: add ark baseband device documentation Date: Thu, 21 Apr 2022 10:18:51 -0500 Message-Id: <20220421151900.703467-1-john.miller@atomicrules.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 | 54 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 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..3bbe885e75 --- /dev/null +++ b/doc/guides/bbdevs/ark.rst @@ -0,0 +1,54 @@ +/* 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 upto 32K bytes for improved performance. +* Support for upto 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. -- 2.25.1