DPDK patches and discussions
 help / color / mirror / Atom feed
From: Anatoly Burakov <anatoly.burakov@intel.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net, ferruh.yigit@intel.com
Subject: [dpdk-dev] [PATCH DPDK-KMODS] igb_uio: add compile instructions
Date: Fri, 20 Nov 2020 16:54:53 +0000
Message-ID: <6ba21a558bc1d6049a77d09ed52d12627055db8a.1605891269.git.anatoly.burakov@intel.com> (raw)

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 <anatoly.burakov@intel.com>
---
 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

             reply	other threads:[~2020-11-20 16:55 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-20 16:54 Anatoly Burakov [this message]
2020-11-23 17:08 ` Ferruh Yigit
2020-11-24 13:26 ` [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: " Anatoly Burakov
2020-11-24 14:27   ` Ajit Khaparde

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6ba21a558bc1d6049a77d09ed52d12627055db8a.1605891269.git.anatoly.burakov@intel.com \
    --to=anatoly.burakov@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git