From patchwork Tue Nov 24 13:26:11 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Burakov, Anatoly" X-Patchwork-Id: 84514 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 91637A04B1; Tue, 24 Nov 2020 14:26:18 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 30010C910; Tue, 24 Nov 2020 14:26:16 +0100 (CET) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id 5CE84C90C for ; Tue, 24 Nov 2020 14:26:14 +0100 (CET) IronPort-SDR: vL8RM4mXIrODGtnFxDedTPr9G95ngohMQ3TAQ/Ny38bhESVfm68mMCmp9F4l5qW/mfBH3RgaKg vxLshdky6HhQ== X-IronPort-AV: E=McAfee;i="6000,8403,9814"; a="190067316" X-IronPort-AV: E=Sophos;i="5.78,366,1599548400"; d="scan'208";a="190067316" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 24 Nov 2020 05:26:12 -0800 IronPort-SDR: Mxj2CM9mUTnF8hu5O+fIgKaAoIz0z6DZjtjsWajENgbt5o61+60Il9/K3LlIImowokCbNzqSNK ZvdGA2HksJYw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.78,366,1599548400"; d="scan'208";a="546830631" Received: from silpixa00399498.ir.intel.com (HELO silpixa00399498.ger.corp.intel.com) ([10.237.222.52]) by orsmga005.jf.intel.com with ESMTP; 24 Nov 2020 05:26:11 -0800 From: Anatoly Burakov To: dev@dpdk.org Cc: thomas@monjalon.net, ferruh.yigit@intel.com Date: Tue, 24 Nov 2020 13:26:11 +0000 Message-Id: <617638b7bdd97cf232289909fcd74bcc82d79545.1606224358.git.anatoly.burakov@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <6ba21a558bc1d6049a77d09ed52d12627055db8a.1605891269.git.anatoly.burakov@intel.com> References: <6ba21a558bc1d6049a77d09ed52d12627055db8a.1605891269.git.anatoly.burakov@intel.com> Subject: [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: add compile instructions X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Currently, compilation instructions for igb_uio are missing. Add them, as well as a top-level INSTALL file referring users to per-OS subdirectories. Signed-off-by: Anatoly Burakov Reviewed-by: Ferruh Yigit Reviewed-by: Ajit Khaparde --- INSTALL | 5 +++++ linux/README.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 INSTALL create mode 100644 linux/README.rst diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..f9ef15c --- /dev/null +++ b/INSTALL @@ -0,0 +1,5 @@ +Installing DPDK Kernel Drivers +============================== + +For instructions on how to install kernel drivers for each OS, please refer to +the respective subdirectories' ``README`` files. diff --git a/linux/README.rst b/linux/README.rst new file mode 100644 index 0000000..11dd501 --- /dev/null +++ b/linux/README.rst @@ -0,0 +1,45 @@ +Building Linux Drivers +====================== + +Prerequisites +------------- + +The system must have relevant Linux kernel headers or source code installed. + +Build +----- + +To build ``igb_uio`` driver, simple run ``make`` command inside the +``igb_uio`` directory: + +.. code-block:: console + + cd igb_uio + make + +If compiling against a specific kernel source directory is required, it is +possible to specify the kernel source directory using the ``KSRC`` variable: + +.. code-block:: console + + make KSRC=/path/to/custom/kernel/source + +Load the driver +--------------- + +The ``igb_uio`` driver requires the UIO driver to be loaded beforehand (these +commands are to be run as ``root`` user): + +.. code-block:: console + + modprobe uio + insmod igb_uio.ko + +Clean the build directory +------------------------- + +To clean the build directory, the following command can be run: + +.. code-block:: console + + make clean