From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 469FD41BDD; Sun, 5 Feb 2023 19:24:07 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D2F6C40A7D; Sun, 5 Feb 2023 19:24:06 +0100 (CET) Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by mails.dpdk.org (Postfix) with ESMTP id B746E40041 for ; Sun, 5 Feb 2023 19:24:05 +0100 (CET) Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id 5B8855C0247; Sun, 5 Feb 2023 13:24:05 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute5.internal (MEProxy); Sun, 05 Feb 2023 13:24:05 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:cc:content-transfer-encoding:date:date:from:from:in-reply-to :in-reply-to:message-id:mime-version:references:reply-to:sender :subject:subject:to:to; s=fm3; t=1675621445; x=1675707845; bh=m1 j+6EVkPzkx3OWtB1CGlgFfZWmnQWLIOmLe4M0FGY8=; b=f0oJg7Mq2yCSCAJ1Fx Fhh2PM+ujvokLIv212tJzuCIyNb0DDj6b9fw5svuUBMZzoYfHjj8JMjJ16yA/sHn ne+w/Dxf+MQgyfFGQURf4K5ZwAaF9gvW/xsI8TP6tbKI6gyF8R3fbmyZNFsfeifw iCHNA+upGPKAR7UJxo9eTnPTKs+9vPsy46arY/5myvbdtRvNeS+/YLz80YaORcMY /+kfS1t2VscAvOVmJC9HJ89qsZMMrx2tWG6arAPiwsgS8UcSZoGarG35gojY135K 4nj42rLCDtHEYD9b4Qdw5QQP2QAfY0xKzfxaKRwd+7s8m8EjL+dPHzHGnke7AHQz cEOA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:sender:subject :subject:to:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm3; t=1675621445; x=1675707845; bh=m1j+6EVkPzkx3 OWtB1CGlgFfZWmnQWLIOmLe4M0FGY8=; b=IxVtd9ZijXF5iKz6gd5SmUI/Tig/z crlnc0klXy6zEno2nvQ2DntIcPkvs7+VkKQydQBCFtOOcajhYUSBKsGr5DJKYB+o pX2sR7AYwBZHdyF5HnrXU6bV90eAYKMMMhoFPQxg52ZvlC9159F4AtWudQUQUZDx wpjBD5Sdg+kVO1FMh16IaAhp2U0JyucrucxapHSJmEkig83jfAT3cMuY89ZZpHBY XW1+Qtmed/VhymJNdlwGUy5LGSei1Kn/ebMBv7nFqwuiVbgP/QoQeuJQ4BzHpsFd uCUBqy2ew4iiXx5jsLDyAHKHdhuVmxYxtUUDZ/XpjJrTDoD0cOu+lX1cw== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvhedrudeggedgudduvdcutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpefhvfevufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpefvhhho mhgrshcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqne cuggftrfgrthhtvghrnhepvdejhfdugeehvddtieejieegteeuudfgjeeukeeiledthfet veekhefhieelhfdtnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilh hfrhhomhepthhhohhmrghssehmohhnjhgrlhhonhdrnhgvth X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sun, 5 Feb 2023 13:24:04 -0500 (EST) From: Thomas Monjalon To: dev@dpdk.org Cc: bruce.richardson@intel.com, david.marchand@redhat.com, stephen@networkplumber.org, Anatoly Burakov , Ferruh Yigit , Ajit Khaparde Subject: [kmods PATCH v3] linux/igb_uio: add build instructions Date: Sun, 5 Feb 2023 19:23:56 +0100 Message-Id: <20230205182356.600251-1-thomas@monjalon.net> X-Mailer: git-send-email 2.39.1 In-Reply-To: <1714118.VLH7GnMWUR@thomas> References: <1714118.VLH7GnMWUR@thomas> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Anatoly Burakov Currently, compilation instructions for igb_uio are missing. Add them, as well as referring users to per-OS subdirectories. Signed-off-by: Anatoly Burakov Reviewed-by: Ferruh Yigit Reviewed-by: Ajit Khaparde Signed-off-by: Thomas Monjalon --- v3: improvements suggested one year ago No need to wait one more year, this patch is directly applied. --- README | 3 +++ linux/README.rst | 58 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 linux/README.rst diff --git a/README b/README index e71dbba..c514cf0 100644 --- a/README +++ b/README @@ -8,3 +8,6 @@ Now the preference is to contribute kernel modules to the upstream project if possible, otherwise to host kernel code in dpdk-kmods.git. The license can be BSD-3-Clause or GPL-2.0. + +For specific instructions per OS, +please refer to the README file in the respective sub-directory. diff --git a/linux/README.rst b/linux/README.rst new file mode 100644 index 0000000..6c60a3d --- /dev/null +++ b/linux/README.rst @@ -0,0 +1,58 @@ +Building Out-of-Tree Kernel Drivers for Linux +============================================= + +Prerequisites +------------- + +The system must have relevant Linux kernel headers or source code installed. + + +Build +----- + +To build ``igb_uio`` driver, simply 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 +---- + +.. note:: + + These commands are to be run as ``root`` user. + +The ``igb_uio`` driver requires the UIO driver to be loaded beforehand. +If ``uio`` is not built-in: + +.. code-block:: console + + modprobe uio + +Then the out-of-tree driver may be loaded. + +.. code-block:: console + + insmod igb_uio.ko + + +Clean +----- + +To clean the build directory, the following command can be run: + +.. code-block:: console + + make clean -- 2.39.1