From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 022E2A04DD; Fri, 20 Nov 2020 17:55:00 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 531C9F90; Fri, 20 Nov 2020 17:54:59 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 833A1DED for ; Fri, 20 Nov 2020 17:54:56 +0100 (CET) IronPort-SDR: 3ClV/W/pc7emzNWUsLsV24fZR1UAK030tBsXyfSq2e9hL2AU9iAAlXdrd2bWXbhFdfARMYhJbo 4ye0B3hmJZKg== X-IronPort-AV: E=McAfee;i="6000,8403,9811"; a="168933111" X-IronPort-AV: E=Sophos;i="5.78,357,1599548400"; d="scan'208";a="168933111" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Nov 2020 08:54:55 -0800 IronPort-SDR: VVMggGG6NOWhXeYxKBayWLdM8+AbAY7j6H7ksJQbOAWNzx/dunLn6azd7D+QNom6kGF/+SaUfF 0ImhD0U0oulQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.78,357,1599548400"; d="scan'208";a="545507732" Received: from silpixa00399498.ir.intel.com (HELO silpixa00399498.ger.corp.intel.com) ([10.237.222.52]) by orsmga005.jf.intel.com with ESMTP; 20 Nov 2020 08:54:54 -0800 From: Anatoly Burakov To: dev@dpdk.org Cc: thomas@monjalon.net, ferruh.yigit@intel.com Date: Fri, 20 Nov 2020 16:54:53 +0000 Message-Id: <6ba21a558bc1d6049a77d09ed52d12627055db8a.1605891269.git.anatoly.burakov@intel.com> X-Mailer: git-send-email 2.17.1 Subject: [dpdk-dev] [PATCH DPDK-KMODS] 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 --- 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..fc9c7a7 --- /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 +``linux/igb_uio`` directry: + +.. code-block:: console + + cd linux/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 -- 2.17.1