[DPDK-KMODS] igb_uio: add compile instructions
Checks
Commit Message
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
Comments
On 11/20/2020 4:54 PM, Anatoly Burakov wrote:
> Currently, compilation instructions for igb_uio are missing. Add them,
> as well as a top-level INSTALL file referring users to per-OS
> subdirectories.
patch title should start with 'linux/igb_uio:'
>
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Thanks for doc update.
<...>
> @@ -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:
> +
Just detail but since we are in the 'linux' folder while reading this file, I
wonder if the reference path should be ``igb_uio`` instead of ``linux/igb_uio``?
Both are OK I think.
new file mode 100644
@@ -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.
new file mode 100644
@@ -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