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.bura...@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
