From patchwork Fri Mar 11 20:07:51 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108694 X-Patchwork-Delegate: thomas@monjalon.net 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 622B1A00C2; Fri, 11 Mar 2022 21:08:19 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 49C5F40140; Fri, 11 Mar 2022 21:08:19 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id 5BF3740042 for ; Fri, 11 Mar 2022 21:08:17 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1647029297; x=1678565297; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=onH7+FVlbIY/Xv50l+bSnMyzBg+kQnnxMirE/q7JiHA=; b=BJ1U155hc7FzsUY9A006ZT3TjVBC/kfCY3ASVrabMr9pQcBrZmVLbb3K eqxUuv8i1zJe9JemB2PfmtASj6+WFB07BsdHdWwwspPXnhg3Duq2gBDgI bTK+88bZHkzd155GOPm5/BUJoHyVz3n72LjvdUKVQ7ukvsdO6iFqITLco G9gqMrQBryiPJEZF9MVQX0Grw8YB6wD1zPGdYvoUNcCKB/mED+GNnv0QD NsG164Kzs44FHqGo0ryAWrpeTbJLzjzIgnX0MZ3KAUFGlziUrVFTxOqAu NCVZPDMhdfXiCrPXXHr7IGyk9SKUY0+WhnmWHz+oeSH+Ve8I3YepzN5o4 Q==; X-IronPort-AV: E=McAfee;i="6200,9189,10283"; a="318869223" X-IronPort-AV: E=Sophos;i="5.90,174,1643702400"; d="scan'208";a="318869223" Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 Mar 2022 12:08:16 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,174,1643702400"; d="scan'208";a="781965038" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by fmsmga006.fm.intel.com with ESMTP; 11 Mar 2022 12:08:15 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH 1/2] doc/freebsd_gsg: add driver guides to document list Date: Fri, 11 Mar 2022 20:07:51 +0000 Message-Id: <20220311200752.1020202-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 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 The document roadmap section was missing any mention of the individual drivers guides which are important for users. Add them to list. Signed-off-by: Bruce Richardson --- doc/guides/freebsd_gsg/intro.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst index b2e57909ee..09afafea56 100644 --- a/doc/guides/freebsd_gsg/intro.rst +++ b/doc/guides/freebsd_gsg/intro.rst @@ -53,3 +53,28 @@ The following is a list of DPDK documents in the suggested reading order: * **Sample Applications User Guide**: Describes a set of sample applications. Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application. + +* **Driver Reference Guides**: Provides details on each driver inside a particular category. + Separate guides exist for each of: + + * Baseband devices + + * Compression devices + + * Cryptographic accelerator devices + + * DMA devices + + * Event-based scheduling devices + + * General purpose GPU devices + + * Mempool drivers + + * Network (NIC) devices + + * "Raw" devices i.e. those not fitting into any other category + + * Regular expression devices + + * vDPA (vhost data path acceleration) devices From patchwork Fri Mar 11 20:07:52 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108695 X-Patchwork-Delegate: thomas@monjalon.net 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 2B923A00C2; Fri, 11 Mar 2022 21:08:25 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1C9A3410E3; Fri, 11 Mar 2022 21:08:25 +0100 (CET) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by mails.dpdk.org (Postfix) with ESMTP id C2EA940042 for ; Fri, 11 Mar 2022 21:08:23 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1647029304; x=1678565304; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=mbGz4s2bCE1oBVNH1V9pfBsgl7vj0OBIwQd57tunTPg=; b=aTR7ghGv38oNxV+xhMuwYrwDCda6fpo7WAjVT3iAIu0Co7kscFZturtM 7941Bo5Rsa7v5HnPPoWtg+2hOqN6/qcNK7VsZZhQhfEvAuOnk+OHwfWcp Cl679ps6o+sHPewi3Zm0hIpy6pYzDJ/21wzlc4QWrrmqe/KZRzKInsGzD RbiDxefSSAfwdNcxlj87aXLVv+v0hMvUZMTnM4x6tXzjUuqgTmPC/QkD+ 14L2QB5WZrDiicBEEPr/MlRD2edfZgv6pRjZnTEcJAYMOCn5dzDp8Eozt wM2+DY9u4GGccLvIgEJwg1tf8lFfskJJeWBLliASPMu6YLJcM+bdsR1Mf w==; X-IronPort-AV: E=McAfee;i="6200,9189,10283"; a="255379383" X-IronPort-AV: E=Sophos;i="5.90,174,1643702400"; d="scan'208";a="255379383" Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 Mar 2022 12:08:22 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,174,1643702400"; d="scan'208";a="781965051" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by fmsmga006.fm.intel.com with ESMTP; 11 Mar 2022 12:08:21 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH 2/2] doc/freebsd_gsg: update DPDK build section Date: Fri, 11 Mar 2022 20:07:52 +0000 Message-Id: <20220311200752.1020202-2-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220311200752.1020202-1-bruce.richardson@intel.com> References: <20220311200752.1020202-1-bruce.richardson@intel.com> 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 Some minor updates for the section on builing DPDK in the GSG: * update Python 3.7 package name to the 3.8 version * note that the pyelftools needs to be tied to the python version * drop reference to jansson library for legacy telemetry * replace special characters for (R) Signed-off-by: Bruce Richardson --- doc/guides/freebsd_gsg/build_dpdk.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/guides/freebsd_gsg/build_dpdk.rst b/doc/guides/freebsd_gsg/build_dpdk.rst index bed353473f..d335b97cfc 100644 --- a/doc/guides/freebsd_gsg/build_dpdk.rst +++ b/doc/guides/freebsd_gsg/build_dpdk.rst @@ -1,6 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. +.. include:: + .. _building_from_source: Compiling the DPDK Target from Source @@ -14,11 +16,16 @@ The following FreeBSD packages are required to build DPDK: * meson * ninja * pkgconf -* py37-pyelftools +* py38-pyelftools + +.. note: + + The specific package for pyelftools is dependent on the version of python in use, + Python 3.8 being the version at type of writing, hence the ``py38`` prefix. These can be installed using (as root):: - pkg install meson pkgconf py37-pyelftools + pkg install meson pkgconf py38-pyelftools To compile the required kernel modules for memory management and working with physical NIC devices, the kernel sources for FreeBSD also @@ -28,11 +35,6 @@ installed via commands like the following, for FreeBSD 12.1 on x86_64:: fetch http://ftp.freebsd.org/pub/FreeBSD/releases/amd64/12.1-RELEASE/src.txz tar -C / -xJvf src.txz -To enable the telemetry library in DPDK, the jansson library also needs to -be installed, and can be installed via:: - - pkg install jansson - Individual drivers may have additional requirements. Consult the relevant driver guide for any driver-specific requirements of interest. @@ -176,7 +178,7 @@ Binding Network Ports to the nic_uio Module ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Device ownership can be viewed using the pciconf -l command. The example below shows -four Intel® 82599 network ports under ``if_ixgbe`` module ownership. +four Intel\ |reg| 82599 network ports under ``if_ixgbe`` module ownership. .. code-block:: none